learn_linter 0.6.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4543fe96f9678ed27100772bab75faf1740c570c
-  data.tar.gz: 218abe2d5ccc5ca8a3e9ddda3590c30a991de97e
+  metadata.gz: ba154f1b74ddada6873a18f2ba882bbc26da90ee
+  data.tar.gz: 18111390edb6629e6c8f5333a2c09981b0da096b
 SHA512:
-  metadata.gz: b3c541f234d35652939f925e79ce130a7733b7420f9fdb308e2144764f1b33f678dd2b8d70d55def49b432620104091aeb07a67eca1d66a52587a173a0725bdb
-  data.tar.gz: 6215189618dc554410cb72150e896289872415ac5b3035f083d7e43483c27d10481f203efe3a0ae00ecca2afa15af41ea5626e345bcecf2d022bd5415e8a71a2
+  metadata.gz: 96b607d790364f6993179cc198c5d39c76354bd06f8884a0d1e4e18222560b78eb5bd1be2a31b1ddac55a3a748443dc721296505cae1b2d082f3ecbf7125872e
+  data.tar.gz: fb9d3111b2d5d3015de52532802056fbbb5c44d1142efcf1c22af08793dbf958298e4d6cad53b87cc7c5eff51bb951e5befb0273c950271005e721fb2fe01816

data/bin/learn-lint

@@ -1,21 +1,20 @@
 #!/usr/bin/env ruby
-
 require 'yaml'
 require 'optparse'
 require_relative '../lib/learn_linter.rb'
 
 if ARGV.length == 0
-  lint = LearnLinter.new.lint_directory
+  dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
+  lint = LearnLinter.new(dir).lint_directory
 elsif ARGV.length == 1 && ARGV[0] == "quiet"
   dir = File.expand_path(File.dirname(File.dirname(__FILE__)))
   lint = LearnLinter.new(dir, "quiet")
 elsif ARGV.length > 1 && ARGV[1] == "quiet"
   lint = LearnLinter.new(ARGV[0], "quiet").lint_directory
-elsif ARGV.length > 1 && ARG[1] != "quiet"
+elsif ARGV.length > 1 && ARGV[1] != "quiet"
   puts "please use 'learn-lint directory_name quiet' or 'learn-lint directory_name"
 elsif ARGV.length == 1
   lint = LearnLinter.new(ARGV[0]).lint_directory
 end
 
 
-

data/lib/learn_linter/learn_error.rb

@@ -1,7 +1,8 @@
 class LearnError < StandardError
   attr_accessor :filepath, :valid_yaml, :valid_license, 
   :present_learn, :present_license, :present_readme, :yaml_error, 
-  :readme_error, :license_error, :valid_readme, :correct_yaml_content
+  :readme_error, :license_error, :valid_readme, :correct_yaml_content, 
+  :valid_contributing, :present_contributing, :contributing_error
 
   ESCAPES = { :green  => "\033[32m",
               :yellow => "\033[33m",
@@ -13,13 +14,19 @@ class LearnError < StandardError
     @yaml_error = {present_dotlearn: false, valid_yaml: false, valid_whitespace: false, attributes: false}
     @readme_error = {present_readme: false, valid_readme: false}
     @license_error = {present_license: false, valid_license: false}
+    @contributing_error = {present_contributing: false, valid_contributing: false}
+
     @correct_yaml_content = {message: ".learn file must have 'tags', 'resources' and 'languages' keys", color: :yellow}
-    @valid_yaml = {message: "invalid yaml or missing .learn", color: :red}
+
+    @valid_yaml = {message: "invalid yaml", color: :red}
     @valid_license = {message: "invalid or missing license content", color: :yellow}
     @valid_readme = {message: "invalid code snippet. Must have three backticks to open and close all code snippets", color: :red}
+    @valid_contributing = {message: "invalid or missing contributing content", color: :yellow}
+
     @present_learn = {message: "missing .learn file", color: :red}
     @present_license = {message: "missing LICENSE.md", color: :red}
     @present_readme = {message: "missing README.md", color: :yellow}
+    @present_contributing = {message: "missing CONTRIBUTING.md", color: :yellow}
 
   end
 
@@ -36,14 +43,15 @@ class LearnError < StandardError
     {
       dot_learn: yaml_error,
       license: license_error,
-      readme: readme_error
+      readme: readme_error,
+      contributing: contributing_error
     }
     
   end
 
 
   def result_output
-    all_results = [present_learn, valid_yaml, correct_yaml_content, present_license, valid_license, present_readme, valid_readme]
+    all_results = [present_learn, valid_yaml, correct_yaml_content, present_license, valid_license, present_readme, valid_readme, valid_contributing, present_contributing]
     all_results.each do |result|
       emit(result)
     end

data/lib/learn_linter/readme_linter.rb

@@ -1,4 +1,3 @@
-require 'pry'
 class ReadmeLinter
 
   def self.parse_file(file, learn_error)
@@ -22,7 +21,7 @@ class ReadmeLinter
   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(/``` /) || chars.match(/```sql/))
+        if !(chars.match(/```ruby/) || chars.match(/```bash/) || chars.match(/```objc/) || chars.match(/```javascript/) || chars.match(/``` /))
           break
         else
           green_light(learn_error)
@@ -30,4 +29,5 @@ class ReadmeLinter
       end
     end
   end
-end
+end
+    

data/lib/learn_linter/version.rb

@@ -1,3 +1,3 @@
 class LearnLinter
-  VERSION = "0.6.0"
+  VERSION = "1.1.0"
 end

data/lib/learn_linter.rb

@@ -3,14 +3,15 @@ require_relative './learn_linter/learn_error'
 require_relative './learn_linter/license_linter'
 require_relative './learn_linter/readme_linter'
 require_relative './learn_linter/yaml_linter'
+require_relative './learn_linter/contributing_linter'
 
 class LearnLinter
 
   attr_accessor :filepath, :quiet
 
 
-  def initialize(dir=nil, quiet=nil)
-    @filepath = dir || Dir.pwd
+  def initialize(filepath, quiet=nil)
+    @filepath = filepath
     @learn_error = LearnError.new
     @quiet = quiet
   end
@@ -19,6 +20,7 @@ class LearnLinter
     self.yaml_lint
     self.license_lint
     self.readme_lint
+    self.contributing_lint
     unless quiet
       @learn_error.result_output
     end
@@ -55,4 +57,12 @@ class LearnLinter
     end
   end
 
+  def contributing_lint
+    if self.has_file?("CONTRIBUTING.md")
+      @learn_error.contributing_error[:present_contributing] = true
+      @learn_error.present_contributing = {message: "present CONTRIBUTING.md", color: :green}
+      ContributingLinter.parse_file("#{filepath}/CONTRIBUTING.md", @learn_error)
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: learn_linter
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sophie DeBenedetto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: can lint a directory for valid .learn, license files