stylr 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ea7cc9131144761b3dc6243fd052a6aabada35b
-  data.tar.gz: c718b67f218a9408e7d0e22ef47ac09307524050
+  metadata.gz: 575d94447ae2b6e4051b366f53eb50bbc2dbcefe
+  data.tar.gz: 2f015e03ba7bfb56de7576d3bc28398bcf3df291
 SHA512:
-  metadata.gz: 9c298c4c9479c35aad274921bb7b0ab2c7d9d776a32bd8022e043f342c6c69b853f2c5576f0d4461f004fe50aae2288ccbfec03e27a9acabdafb909eef811bdb
-  data.tar.gz: 8c532755f94bdf1798c4d0a6e4477f19a24019fe23ee45d33c384d30b48ef0b486eb3867863f80ef17a56cae7bad7e5d0306199245f10d8706ef655997df00ed
+  metadata.gz: 727cfa78ce073ae0d8cffa7d45947b06693788de294735817f8ea407b805dc09998ab0b44b4980696b4bff5e89ac71cc436e13c8fc3c02ae37a2e72e94c23f50
+  data.tar.gz: bfacb8fe65abe923b37bc6ba5644a0f98f14ef0257b246e201a6a3d9fc07f4665f4f3bc61d3f0232825d133bfff21e98fb69e93b3ca77464e988c917665dd57f

data/README.md

@@ -11,26 +11,27 @@ Kind of raw still.  Currently supports checking against the following:
 * Line length (user-configurable)
 * Missing parens around method definitions with parameters (ie, "def foo bar" is disallowed)
 * Trailing whitespace of any kind
-* Use of the 'and' or 'or' operators (&& and || are preferred)
-* Use of 'then' on a multiline if/then construct
+* Use of the <code>and</code> or <code>or</code> operators (&& and || are preferred)
+* Use of <code>then</code> on a multiline <code>if</code>/<code>then</code> construct
 * Spacing around parens
 * Spacing around brackets
-* Spacing around curly braces (this is broken when you interpolate into a regex)
-* Using the keyword 'for'
+* Spacing around curly braces
+* Using the keyword <code>for</code>
 * Spacing around commas
 * Using tab characters instead of soft tabs
-* Spacing around math operators (+, *, etc)
+* Spacing around math operators (<code>+</code>, <code>*</code>, etc)
+* Use of <code>===</code> (instead of <code>is_a?</code> or <code>kind_of?</code>)
 
 Optionally checks for some metaprogramming, which you might not want in a large, enterprise codebase with varied levels of skill on your development team.  This is not a condemnation of these practices - most of them are good, idiomatic Ruby.  You might not, however, want your junior developers checking in lots of metaprogrammed code.  Pass the '--meta' flag to enable these checks.
 
-* eval
-* class_eval
-* instance_eval
-* module_eval
-* define_method
-* send
+* <code>eval</code>
+* <code>class_eval</code>
+* <code>instance_eval</code>
+* <code>module_eval</code>
+* <code>define_method</code>
+* <code>send</code>
 
-All of these things are configurable via yml.  See "stylr.yml" in the repo, and place it in "~/.stylr.yml"
+All of these things are configurable via yml.  See "stylr.yml" in the repo.  Whatever directory you run stylr from will look for stylr.yml.
 
 Checks all *.rb files in the specified directory and subdirectories, excluding _spec.rb and _test.rb
 
@@ -42,6 +43,12 @@ Checks all *.rb files in the specified directory and subdirectories, excluding _
 
 <code>stylr /path/to/directory --meta</code> also check for use of metaprogramming
 
+<code>stylr /path/to/directory --ignore=dir_to_ignore</code> optionally ignore a particular directory relative to the current directory
+
+Here's what I typically check against the stylr source itself with (launched from the stylr root dir):
+
+<code>stylr . --ignore=spec</code>
+
 <h4>Contributing</h4>
 
 Please feel free to contribute!  There are issues and unimplemented features.  I'd love any help I can get.  Thanks!

data/bin/stylr

@@ -21,14 +21,20 @@ module Stylr
       description "Display the current version"
     }
 
+    option('ignore') {
+      argument :optional
+      description "A list of directories to be ignored"
+    }
+
     def run
       if params['version'].values.first
         puts "stylr version #{Stylr::VERSION}"
       else
         directory = params['directory'].values.first
         meta = params['meta'].values.first ? true : false
+        ignores = params['ignore'].values
         dir_loader = DirLoader.new
-        dir_loader.load_dir(directory)
+        dir_loader.load_dir(directory, ignores)
 
         dir_loader.filenames.each do |filename|
           puts "Checking #{filename}..."

data/lib/stylr/dir_loader.rb

@@ -1,13 +1,21 @@
 class DirLoader
   attr_reader :filenames
 
-  def load_dir(dir)
+  def load_dir(dir, ignored_dirs = [])
     Dir.chdir(File.expand_path(dir)) do
       @filenames = Dir.glob('**/*.rb').map { |file| File.expand_path(file) }
     end
+
     @filenames.reject! do |filename|
       filename =~ /(_spec|_test).rb$/
     end
+
+    ignored_dirs.each do |ignored_dir|
+      ignored_dir = File.join(Dir.pwd, ignored_dir)
+      @filenames.reject! do |filename|
+        filename =~ /#{ignored_dir}/
+      end
+    end
   end
 end
 

data/lib/stylr/file_parser.rb

@@ -27,7 +27,6 @@ module Stylr
         display_errors if @display
         true
       else
-        display_no_error_message if @display
         false
       end
     end
@@ -51,11 +50,6 @@ module Stylr
       @file_string = @file_string.split(/#{UniqueConstant}/)
     end
 
-    def display_no_error_message
-      puts "Your file is free of errors."
-      puts
-    end
-
     def display_errors
       puts "You have the following errors:"
       @lint.errors.each do |hash|

data/lib/stylr/lint.rb

@@ -45,11 +45,11 @@ class Lint
   def remove_regex(line)
     if possible_regex = line[/\/.*\//]
       sexp = Ripper.sexp(possible_regex) || []
-      if sexp.flatten.grep(/regex/)
+      if sexp.flatten.grep(/regex/) # *looks at the ground sheepishly*
         return line.gsub(possible_regex, 'REGEX')
       end
     end
-    return line
+    line
   end
 
   private
@@ -86,6 +86,7 @@ class Lint
       /[^\s][{}]|{[^\s]/            => :brace_spacing,
       /,[^ \n]/                     => :comma_spacing,
       /\t/                          => :no_soft_tabs,
+      /===/                         => :triple_equals,
       /[^\s]\+/                     => :no_operator_spaces,
       /\+[^\s=]/                    => :no_operator_spaces,
       /[^\s]-/                      => :no_operator_spaces
@@ -128,6 +129,7 @@ class Lint
       :brace_spacing                => "No space around { or before }.",
       :comma_spacing                => "No space after a comma.",
       :no_soft_tabs                 => "Used tab characters; please use soft tabs.",
+      :triple_equals                => "Use of triple-equals.",
       :no_operator_spaces           => "Please use spaces around operators."
     }
   end

data/lib/stylr/version.rb

@@ -1,3 +1,3 @@
 module Stylr
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

data/spec/dir_loader_spec.rb

@@ -21,6 +21,13 @@ module Stylr
       d.load_dir(dir)
       d.filenames.should == []
     end
+
+    it "takes optionally a list of directories to exclude" do
+      dir = File.join(Dir.pwd, 'spec', 'rdir')
+      ignores = "spec/rdir/one"
+      d.load_dir(dir, [ignores])
+      d.filenames.sort.should == ["#{dir}/two/two.rb", "#{dir}/three/three.rb", "#{dir}/base.rb"].sort
+    end
   end
 end
 

data/spec/lint_spec.rb

@@ -217,6 +217,12 @@ module Stylr
         end
       end
 
+      context "triple equals" do
+        it "do not use triple equals" do
+          l.violation?("if x === y").should be_true
+        end
+      end
+
       context "comments" do
         it "ignores comments" do
           l.violation?("# a comment").should be_false

data/stylr.yml

@@ -19,3 +19,4 @@ used_module_eval: true
 used_instance_eval: true
 used_define_method: true
 dynamic_invocation: true
+triple_equals: true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stylr
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Mark Billie