Class: ReadmeLinter

Inherits:
Object
  • Object
show all
Defined in:
lib/learn_linter/readme_linter.rb

Class Method Summary collapse

Class Method Details

.green_light(learn_error) ⇒ Object 



12
13
14
15
 
# File 'lib/learn_linter/readme_linter.rb', line 12

def self.green_light(learn_error)
  learn_error.readme_error[:valid_readme] = true
  learn_error.valid_readme = {message: "valid readme", color: :green}
end

.has_code_snippets?(file) ⇒ Boolean

Returns:

  • (Boolean) 


17
18
19
 
# File 'lib/learn_linter/readme_linter.rb', line 17

def self.has_code_snippets?(file)
  file.match(/``/)
end

.parse_file(file, learn_error) ⇒ Object 



3
4
5
6
7
8
9
10
 
# File 'lib/learn_linter/readme_linter.rb', line 3

def self.parse_file(file, learn_error)
  file_string = File.open(file).read
  if has_code_snippets?(file_string)
    validate_snippets(file_string, learn_error)
  else
    green_light(learn_error)
  end
end

.validate_snippets(file, learn_error) ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/learn_linter/readme_linter.rb', line 21

def self.validate_snippets(file, learn_error)
  file.split(" ").each do |chars|
    if chars.match(/``/)
      if !(chars.match(/```ruby/) || chars.match(/```bash/) || chars.match(/```objc/) || chars.match(/```javascript/) || chars.match(/``` /))
        break
      else
        green_light(learn_error)
      end
    end
  end
end