Class: ArchUnit::Files::FluentApi::FileConditionBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/archunit/files/fluentapi/file_condition_builder.rb

Overview

Immutable scope builder selecting the files to which a rule will apply.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(project_locator: nil, filters: []) ⇒ FileConditionBuilder

Returns a new instance of FileConditionBuilder.



13
14
15
16
17
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 13

def initialize(project_locator: nil, filters: [])
  @project_locator = immutable_project_locator(project_locator)
  @filters = immutable_filters(filters)
  freeze
end

Instance Attribute Details

#filters ⇒ Object (readonly)

Returns the value of attribute filters.



11
12
13
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 11

def filters
  @filters
end

#project_locator ⇒ Object (readonly)

Returns the value of attribute project_locator.



11
12
13
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 11

def project_locator
  @project_locator
end

Instance Method Details

#in_file(file_path, except: nil) ⇒ FileConditionBuilder

Selects one exact project-relative file.

Returns:



39
40
41
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 39

def in_file(file_path, except: nil)
  with_filter(Common::RegexFactory.exact_file_matcher(file_path, except:))
end

#in_folder(pattern, except: nil) ⇒ FileConditionBuilder

Selects files by project-relative containing folder.

Returns:



27
28
29
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 27

def in_folder(pattern, except: nil)
  with_filter(Common::RegexFactory.folder_matcher(pattern, except:))
end

#in_path(pattern, except: nil) ⇒ FileConditionBuilder

Selects files by complete project-relative path.

Returns:



33
34
35
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 33

def in_path(pattern, except: nil)
  with_filter(Common::RegexFactory.path_matcher(pattern, except:))
end

#should ⇒ PositiveMatchPatternFileConditionBuilder

Enters the positive rule mood.

Returns:



45
46
47
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 45

def should
  PositiveMatchPatternFileConditionBuilder.new(self)
end

#should_not ⇒ NegatedMatchPatternFileConditionBuilder

Enters the negated rule mood.

Returns:



51
52
53
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 51

def should_not
  NegatedMatchPatternFileConditionBuilder.new(self)
end

#with_name(pattern, except: nil) ⇒ FileConditionBuilder

Selects files by basename.

Returns:



21
22
23
 
# File 'lib/archunit/files/fluentapi/file_condition_builder.rb', line 21

def with_name(pattern, except: nil)
  with_filter(Common::RegexFactory.filename_matcher(pattern, except:))
end