Class: Git::Conform::BaseChecker

Inherits:
Object
  • Object
show all
Defined in:
lib/git/conform/checkers/base_checker.rb

Direct Known Subclasses

FalseChecker, FileChecker, NoopChecker, TrueChecker

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filename) ⇒ BaseChecker

Returns a new instance of BaseChecker.



7
8
9
10
11
 
# File 'lib/git/conform/checkers/base_checker.rb', line 7

def initialize(filename)
  @filename = filename
  raise "No such file - #{@filename}" unless File.exist? @filename
  raise "Is a directory - #{@filename}" if File.directory? @filename
end

Instance Attribute Details

#filename ⇒ Object (readonly)

Returns the value of attribute filename.



5
6
7
 
# File 'lib/git/conform/checkers/base_checker.rb', line 5

def filename
  @filename
end

Instance Method Details

#check_conformity {|@filename| ... } ⇒ Object

Yields:



25
26
27
 
# File 'lib/git/conform/checkers/base_checker.rb', line 25

def check_conformity
  yield @filename unless excluded? || conforms?
end

#check_exclusion {|@filename| ... } ⇒ Object

Yields:



21
22
23
 
# File 'lib/git/conform/checkers/base_checker.rb', line 21

def check_exclusion
  yield @filename if excluded?
end

#conforms? ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/git/conform/checkers/base_checker.rb', line 17

def conforms?
  raise 'SubclassResponsibility'
end

#excluded? ⇒ Boolean

Returns:

  • (Boolean) 


13
14
15
 
# File 'lib/git/conform/checkers/base_checker.rb', line 13

def excluded?
  raise 'SubclassResponsibility'
end