skeptic 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c134d0e254360008e27fa9cb86c40c93db1927f4
-  data.tar.gz: 4740e1bf1ad5a49988947f4271cc02670c02e8ec
+  metadata.gz: b186a1164cdf3aec83412da18189eea9b5f009af
+  data.tar.gz: 3a9179e3fcca3ecbecf2ebc0614e2d81819d82c8
 SHA512:
-  metadata.gz: 15a38c21b6827006b04201c4cb85df642e9d23d222df9ae576e6de2bd7fa22f25c65eeb263e648a75e5c47d2fb3f65ead2d0209c6cb7435f2c097468b61372b0
-  data.tar.gz: 18a09be7c9be915270ec24fea66cfe12d705083147afc6ab8984fc4749d43daf4ca7cbbefa6cf45a93702b333214fc6f7bd180a7cd61c3102f074b36173aca62
+  metadata.gz: 3bbc4449f25c944c6071b4f59f6c73d741b36159e08ab05c6300973d9f33a2da381cc471bc09a4908cf576516b452a1e49efc4c7d792b6c3fc1bb0c55dada27e
+  data.tar.gz: 67df5abdf016869af57e345edf652237854ef5f6512ac78ee5bce6805a3850b2a4563c70115e337e1a7edda532f1eccde4a91fa819d43567b34fa9e24934f953

data/.rvmrc

@@ -1 +1 @@
-rvm --create 1.9.3@skeptic
+rvm --create 2.1.2@skeptic

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+## 0.0.8 (2014-10-12)
+
+Features:
+  - Add a rule for max method arity (thanks to [milanov](https://github.com/milanov))
+  - Add support for checking recursively whole directories
+
+Bugfixes:
+  - Fix detection of unary operators
+  - Add installation instructions in the readme (thanks to [mitio](https://github.com/mitio))
+  - Fix handling of case statements without a testable in max nesting depth rule
+
+## 0.0.7 (2013-12-15)
+
+Bugfixes:
+  - Fix crashing in naming conventions rule
+  - Stop detecting unary - in space around operators rule
+  - Improve space around operators detection using ast context info
+
+## 0.0.6 (2013-12-14)
+
+Bugfixes:
+  - Refine bad naming detection
+
+
 ## 0.0.5 (2013-11-15)
 
 Features:

data/Gemfile

@@ -9,7 +9,7 @@ gem 'trollop', '>= 1.16.2'
 gem "ffi-aspell"
 
 group :development do
-  gem "rspec"
+  gem "rspec", "2.14.1"
   gem "cucumber"
   gem "aruba"
   gem "bundler"

data/README.markdown

@@ -2,9 +2,21 @@
 
 _Skeptic_ is a *very* experimental static code analyzer for Ruby 1.9. It points out annoying things in your Ruby code.
 
-I am using it for a [Ruby course in the University of Sofia](http://fmi.ruby.bg/). All the assignments the students hand it should adhere to specific style, that is automatically checked with Skeptic. Assignments that fail to meet the critera are rejected outright. The main assumption is the "theory" of constraints - when one operates under constraints, one is more creative and ends up learning more.
+I am using it for a [Ruby course in the University of Sofia](http://fmi.ruby.bg/). All the assignments the students hand it should adhere to specific style, that is automatically checked with Skeptic. Assignments that fail to meet the criteria are rejected outright. The main assumption is the "theory" of constraints - when one operates under constraints, one is more creative and ends up learning more.
 
-You should probably not use it for anythin.
+You should probably not use it for anything.
+
+## Installation
+
+Skeptic can be installed as a Ruby gem, either via `gem install skeptic`, or better yet via Bundler.
+
+Make sure that you have the `aspell` package installed in your system, along with its shared libraries (`libaspell`). If you're on OS X, you can use [Homebrew](http://brew.sh/) to do that:
+
+    brew install aspell
+
+On other Linux/Unix distributions, you are free to use a package manager or another installation method of choice.
+
+For Windows systems, check out [GNU Aspell for Win32](http://aspell.net/win32/). Install Aspell using the "Full Installer" linked in that page, then locate `aspell-15.dll` in the installation and copy it somewhere in your `PATH` as `aspell.dll`.
 
 ## Rules
 
@@ -13,7 +25,7 @@ Skeptic checks if the code complies to a number of rules and reports the violati
 * **Valid syntax** - skeptic can check if your syntax is valid.
 * **Line length** - line length does not exceed a certain number.
 * **Lines per method** - methods are at most N lines long. Ignores empty lines and lines with `end`
-* **Max nesting depth** - at most N levels of nesting. blocks, conditions and loops are considered a level of nesting.
+* **Max nesting depth** - at most N levels of nesting. Blocks, conditions and loops are considered a level of nesting.
 * **No semicolons** - stops you from using semicolons as expression delimiters.
 * **No trailing whitespace** - points out if your lines end on whitespace.
 

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/bin/skeptic

@@ -7,36 +7,60 @@ parser = Trollop::Parser.new do
   banner <<BANNER
 Points out annoying things in your Ruby code. Just run with:
 
-  skeptic [options] <path_to_file>
+  skeptic [options] <path>
 
-where [options] are:
+where
+<path> is a path to a file or a directory\
+(which would be checked recursively) and
+[options] are:
 BANNER
   Skeptic::Rules.table.each_rule do |klass, slug, option_type, description|
     opt slug, description, type: option_type
   end
-  opt :file, 'Path to file to analyze', type: :string
+  opt :path, 'Path to file/directory to analyze', type: :string
 end
 
 opts = Trollop::with_standard_exception_handling parser do
   parsed = parser.parse ARGV
-  parsed[:file] ||= ARGV.shift unless parsed[:file_given]
-  raise Trollop::HelpNeeded unless parsed[:file]
+  parsed[:path] ||= ARGV.shift unless parsed[:path_given]
+  raise Trollop::HelpNeeded unless parsed[:path]
   raise Trollop::CommandlineError, "excessive arguments: #{ARGV.join(' ')}" unless ARGV.empty?
-  raise Trollop::CommandlineError, "file does not exist: #{parsed[:file]}" unless File.exist? parsed[:file]
+  raise Trollop::CommandlineError, "resource does not exist: #{parsed[:path]}" unless File.exist? parsed[:path]
   parsed
 end
 
-code = File.read opts[:file]
-critic = Skeptic::Critic.new opts.select { |key, value| Skeptic::Rules.table.slugs.include? key }
-critic.criticize code
+CRITIC_OPTS = opts.select { |key, value| Skeptic::Rules.table.slugs.include? key }
 
-if critic.criticism.empty?
-  puts 'OK'
-  exit(0)
-else
-  messages = Hash.new { |hash, key| hash[key] = [] }
+def criticize_file(path)
+  code = File.read path
+  critic = Skeptic::Critic.new CRITIC_OPTS
+  critic.criticize code
+  critic.criticism
+end
 
-  critic.criticism.each do |message, type|
+def criticize_directory(path)
+  Dir["#{path}/**/*.rb"].map do |file|
+    [file, criticize_file(file)]
+  end
+end
+
+def display_directory_criticism(criticism)
+  has_errors = false
+  criticism.each do |filename, file_criticism|
+    unless file_criticism.empty?
+      puts "#{filename} :\n\n"
+      display_file_criticism file_criticism
+      has_errors = true
+    end
+  end
+
+  puts "#{criticism.count} files checked"
+  has_errors
+end
+
+def display_file_criticism(criticism)
+  messages = Hash.new { |hash, key| hash[key] = [] }
+  criticism.each do |message, type|
     messages[type] << message
   end
 
@@ -47,6 +71,21 @@ else
     end
     puts ""
   end
+  !criticism.empty?
+end
+
+has_errors = if Dir.exist? opts[:path]
+  display_directory_criticism criticize_directory opts[:path]
+else
+  display_file_criticism criticize_file opts[:path]
+end
 
-  exit(1)
+if has_errors
+  puts 'Errors found'
+  exit 1
+else
+  puts 'OK'
+  exit 0
 end
+
+

data/lib/skeptic/rules/max_method_arity.rb

@@ -0,0 +1,83 @@
+module Skeptic
+  module Rules
+    class MaxMethodArity
+      DESCRIPTION = 'Limit the arguments count per method'
+      MAX_METHOD_ARITY = 3
+
+      include SexpVisitor
+
+      def initialize(limit = nil)
+        @violations = []
+        @limit  = limit || MAX_METHOD_ARITY
+      end
+
+      def apply_to(code, tokens, sexp)
+        visit sexp
+        self
+      end
+
+      def violations
+        @violations.map do |method, arity|
+          "#{method} has #{arity} arguments (maximum method arity: #{@limit})"
+        end
+      end
+
+      def name
+        "Maximum method arity (#@limit)"
+      end
+
+      private
+
+      on :class do |name, parents, body|
+        env.push :module => qualified_class_name(name)
+        visit body
+
+        env.pop
+      end
+
+      on :module do |name, body|
+        env.push :module => qualified_class_name(name)
+        visit body
+
+        env.pop
+      end
+
+      on :def do |name, params, _|
+        qualified_method_name = env[:module] + '#' + extract_name(name)
+        env.push :method => qualified_method_name
+
+        visit params
+
+        env.pop
+      end
+
+      on :defs do |target, separator, name, params, body|
+        method_name = extract_name(name)
+        class_name  = extract_name(target)
+        class_name  = env[:module] if class_name == 'self'
+
+        qualified_method_name = class_name + '.' + method_name
+        env.push :method => qualified_method_name
+
+        visit params
+
+        env.pop
+      end
+
+      on :params do |*params|
+        check_max_arity(params) if params
+      end
+
+      def check_max_arity(params)
+        arguments_count = extract_param_idents(params).size
+        if arguments_count > @limit
+          @violations << [env[:method], arguments_count]
+        end
+      end
+
+      def qualified_class_name(name)
+        [env[:module], extract_name(name)].compact.join('::')
+      end
+    end
+  end
+end

data/lib/skeptic/rules/max_nesting_depth.rb

@@ -106,7 +106,7 @@ module Skeptic
       end
 
       on :case do |testable, alternatives|
-        visit testable
+        visit testable unless testable.nil?
 
         with scope.push(:case) do
           visit alternatives

data/lib/skeptic/rules/spaces_around_operators.rb

@@ -6,7 +6,7 @@ module Skeptic
       include SexpVisitor
 
       OPERATORS_WITHOUT_SPACES_AROUND_THEM = ['**', '::', '...', '..']
-      IGNORED_TOKEN_TYPES = [:on_sp, :on_ignored_nl, :on_nl, :on_lparen, :on_symbeg]
+      IGNORED_TOKEN_TYPES = [:on_sp, :on_ignored_nl, :on_nl, :on_lparen, :on_symbeg, :on_lbracket, :on_lbrace]
 
       def initialize(data)
         @violations = []
@@ -94,7 +94,7 @@ module Skeptic
       end
 
       on :block_var do |params|
-        normal_params = params[1]
+        normal_params = params[1] || []
         unless normal_params.empty?
           right_param = normal_params.last
           right_location = [right_param.last[0],

data/lib/skeptic/rules.rb

@@ -15,5 +15,6 @@ module Skeptic
     table.register NoGlobalVariables, :boolean
     table.register NoTrailingWhitespace, :boolean
     table.register SpacesAroundOperators, :boolean
+    table.register MaxMethodArity, :int
   end
 end

data/lib/skeptic/sexp_visitor.rb

@@ -86,6 +86,8 @@ module Skeptic
             [tree]
           when Symbol
             []
+          when nil
+            []
           else
             tree.compact.map { |node| extract_param_idents node }.reduce [], :+
         end

data/lib/skeptic.rb

@@ -15,6 +15,7 @@ require 'skeptic/rules/english_words_for_names'
 require 'skeptic/rules/naming_conventions'
 require 'skeptic/rules/no_global_variables'
 require 'skeptic/rules/spaces_around_operators'
+require 'skeptic/rules/max_method_arity'
 
 require 'skeptic/rule_table'
 require 'skeptic/rules'

data/skeptic.gemspec

@@ -2,15 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: skeptic 0.0.7 ruby lib
+# stub: skeptic 0.0.8 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "skeptic"
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
   s.authors = ["Stefan Kanev"]
-  s.date = "2013-12-14"
+  s.date = "2014-10-12"
   s.description = "An experimental, half-assed, bug-ridden and highly opinionated code analyzer."
   s.email = "stefan.kanev@gmail.com"
   s.executables = ["skeptic"]
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/skeptic/rules/english_words_for_names.rb",
     "lib/skeptic/rules/line_length.rb",
     "lib/skeptic/rules/lines_per_method.rb",
+    "lib/skeptic/rules/max_method_arity.rb",
     "lib/skeptic/rules/max_nesting_depth.rb",
     "lib/skeptic/rules/methods_per_class.rb",
     "lib/skeptic/rules/naming_conventions.rb",
@@ -52,8 +54,7 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "http://github.com/skanev/skeptic"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "2.1.5"
+  s.rubygems_version = "2.2.2"
   s.summary = "Skeptic points out annoying things in your code"
 
   if s.respond_to? :specification_version then
@@ -62,7 +63,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<trollop>, [">= 1.16.2"])
       s.add_runtime_dependency(%q<ffi-aspell>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["= 2.14.1"])
       s.add_development_dependency(%q<cucumber>, [">= 0"])
       s.add_development_dependency(%q<aruba>, [">= 0"])
       s.add_development_dependency(%q<bundler>, [">= 0"])
@@ -71,7 +72,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<trollop>, [">= 1.16.2"])
       s.add_dependency(%q<ffi-aspell>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["= 2.14.1"])
       s.add_dependency(%q<cucumber>, [">= 0"])
       s.add_dependency(%q<aruba>, [">= 0"])
       s.add_dependency(%q<bundler>, [">= 0"])
@@ -81,7 +82,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<trollop>, [">= 1.16.2"])
     s.add_dependency(%q<ffi-aspell>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["= 2.14.1"])
     s.add_dependency(%q<cucumber>, [">= 0"])
     s.add_dependency(%q<aruba>, [">= 0"])
     s.add_dependency(%q<bundler>, [">= 0"])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skeptic
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Stefan Kanev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-14 00:00:00.000000000 Z
+date: 2014-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -42,16 +42,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.14.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -151,6 +151,7 @@ files:
 - lib/skeptic/rules/english_words_for_names.rb
 - lib/skeptic/rules/line_length.rb
 - lib/skeptic/rules/lines_per_method.rb
+- lib/skeptic/rules/max_method_arity.rb
 - lib/skeptic/rules/max_nesting_depth.rb
 - lib/skeptic/rules/methods_per_class.rb
 - lib/skeptic/rules/naming_conventions.rb
@@ -181,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Skeptic points out annoying things in your code