Ameba::Source - ameba 1.6.4-1-dev

# class Ameba::Source

- Ameba::Source
- Reference
- Object

##
Overview

An entity that represents a Crystal source file. Has path, lines of code and issues reported by rules.

##
Included Modules

- Ameba::InlineComments
- Ameba::Reportable
- Ameba::Spec::Util

##
Defined in:

ameba/source.cr
ameba/source/corrector.cr
ameba/source/rewriter.cr
ameba/spec/support.cr

##
Constructors

- .new(code : String, path : String = "", normalize = true)
- .new(code : String, path : String = "")

  Creates a new source by `#code` and `#path`.

##
Instance Method Summary

- #ast : Crystal::ASTNode

  Returns AST nodes constructed by `Crystal::Parser`.

- #code : String

  Crystal code (content of a source file).

- #correct?

  Corrects any correctable issues and updates `#code`.

- #fullpath : String
- #lines : Array(String)

  Returns lines of code split by new line character.

- #matches_path?(filepath)

  Returns `true` if filepath matches the source's path, `false` otherwise.

- #path : String

  Path to the source file.

- #pos(location : Crystal::Location, end end_pos = false) : Int32

  Converts an AST location to a string position.

- #spec?

  Returns `true` if the source is a spec file, `false` otherwise.

### Instance methods inherited from module `Ameba::Spec::Util`

normalize_code(code, separator = '\n') normalize_code

### Instance methods inherited from module `Ameba::Reportable`

add_issue(rule, location : Crystal::Location | Nil, end_location : Crystal::Location | Nil, message : String, status : Issue::Status | Nil = nil, block : Source::Corrector -> | Nil = nil) : Issue
add_issue(rule, location : Crystal::Location | Nil, end_location : Crystal::Location | Nil, message : String, status : Issue::Status | Nil = nil, &block : Source::Corrector -> ) : Issue
add_issue(rule, token : Crystal::Token, message, status : Issue::Status | Nil = nil, block : Source::Corrector -> | Nil = nil) : Issue
add_issue(rule, location : Tuple(Int32, Int32), message, status : Issue::Status | Nil = nil, block : Source::Corrector -> | Nil = nil) : Issue
add_issue(rule, location : Tuple(Int32, Int32), end_location : Tuple(Int32, Int32), message, status : Issue::Status | Nil = nil, block : Source::Corrector -> | Nil = nil) : Issue
add_issue(rule, node : Crystal::ASTNode, message, status : Issue::Status | Nil = nil, block : Source::Corrector -> | Nil = nil, *, prefer_name_location = false) : Issue
add_issue(rule, location : Tuple(Int32, Int32), message, status : Issue::Status | Nil = nil, &block : Source::Corrector -> ) : Issue
add_issue(rule, token : Crystal::Token, message, status : Issue::Status | Nil = nil, &block : Source::Corrector -> ) : Issue
add_issue(rule, location : Tuple(Int32, Int32), end_location : Tuple(Int32, Int32), message, status : Issue::Status | Nil = nil, &block : Source::Corrector -> ) : Issue
add_issue(rule, node : Crystal::ASTNode, message, status : Issue::Status | Nil = nil, *, prefer_name_location = false, &block : Source::Corrector -> ) : Issue add_issue, issues issues, valid? valid?

### Instance methods inherited from module `Ameba::AST::Util`

abort?(node) abort?, control_exp_code(node : Crystal::ControlExpression, code_lines) control_exp_code, dynamic_literal?(node) : Bool dynamic_literal?, exit?(node) exit?, flow_command?(node, in_loop) flow_command?, flow_expression?(node, in_loop = false) flow_expression?, literal?(node) : Bool literal?, loop?(node) loop?, name_end_location(node) name_end_location, name_location(node) name_location, name_size(node) name_size, node_source(node, code_lines) node_source, path_named?(node, name) : Bool path_named?, raise?(node) raise?, source_between(loc, end_loc, code_lines) : String | Nil source_between, static_literal?(node) : Bool static_literal?

### Instance methods inherited from module `Ameba::InlineComments`

comment?(line_number : Int32) comment?, location_disabled?(location : Crystal::Location | Nil, rule) location_disabled?, parse_inline_directive(line) parse_inline_directive

##
Constructor Detail

def self.new(code : String, path : String = "", normalize = true) #
def self.new(code : String, path : String = "") #

Creates a new source by `#code` and `#path`.

For example:

    path = "./src/source.cr"
    Ameba::Source.new File.read(path), path

##
Instance Method Detail

def ast : Crystal::ASTNode #

Returns AST nodes constructed by `Crystal::Parser`.

    source = Ameba::Source.new code, path
    source.ast

def code : String #

Crystal code (content of a source file).

def correct? #

Corrects any correctable issues and updates `#code`. Returns `false` if no issues were corrected.

def fullpath : String #
def lines : Array(String) #

Returns lines of code split by new line character. Since `#code` is immutable and can't be changed, this method caches lines in an instance variable, so calling it second time will not perform a split, but will return lines instantly.

    source = Ameba::Source.new "a = 1\nb = 2", path
    source.lines # => ["a = 1", "b = 2"]

def matches_path?(filepath) #

Returns `true` if filepath matches the source's path, `false` otherwise.

def path : String #

Path to the source file.

def pos(location : Crystal::Location, end end_pos = false) : Int32 #

Converts an AST location to a string position.

def spec? #

Returns `true` if the source is a spec file, `false` otherwise.