skeptic 0.0.3 → 0.0.4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+## 0.0.4 (2013-11-14)
+
+Features:
+
+  - Add a rule for whitespace around operators
+  - Add a rule for naming conventions (snake case, camel case, screaming snake case)
+  - Add a rule that allows only definitions of names containing valid English words
+  - Add a rule that detects the use of global variables
+
+Bugfixes:
+
+  - Fix counting class methods in `--methods-per-class` rule

data/Gemfile

@@ -14,4 +14,6 @@ group :development do
   gem "bundler"
   gem "jeweler"
   gem "simplecov"
+  gem "ffi-aspell"
 end
+

data/README.markdown

@@ -0,0 +1,22 @@
+# skeptic
+
+_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.
+
+You should probably not use it for anythin.
+
+## Rules
+
+Skeptic checks if the code complies to a number of rules and reports the violations. Here is a list of the rules:
+
+* **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.
+* **No semicolons** - stops you from using semicolons as expression delimiters.
+* **No trailing whitespace** - points out if your lines end on whitespace.
+
+## Copyright
+
+Copyright (c) 2011 Stefan Kanev. See LICENSE.txt for further details.

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/skeptic/rules/english_words_for_names.rb

@@ -0,0 +1,99 @@
+require 'ffi/aspell'
+require 'set'
+
+module Skeptic
+  module Rules
+    class EnglishWordsForNames
+      DESCRIPTION = 'Detect if names contain non-English words'
+
+      include SexpVisitor
+
+      PERMANENT_WORD_WHITELIST = Set.new ['args', 'kwargs']
+
+      def initialize(whitelist = '')
+        @word_whitelist = PERMANENT_WORD_WHITELIST.merge whitelist.split
+        @violations = []
+        @aspell_speller = FFI::Aspell::Speller.new 'en_US'
+      end
+
+      def apply_to(code, tokens, sexp)
+        visit sexp
+        self
+      end
+
+      def violations
+        @violations.map do |name, line|
+          "#{name} on line #{line} is not in english"
+        end
+      end
+
+      def name
+        'English words for names'
+      end
+
+      private
+
+      on :class, :module do |name, *, body|
+        check_ident name
+        visit body
+      end
+
+      on :def, :defs do |*, name, params, body|
+        check_ident name
+        visit params
+        visit body
+      end
+
+      on :lambda do |params, body|
+        visit params if params
+        visit body
+      end
+
+      on :do_block, :brace_block do |(_, params, _), body|
+        visit params if params
+        visit body
+      end
+
+      on :assign do |target, value|
+        check_ident target
+        visit value
+      end
+
+      on :params do |*params|
+        extract_param_idents(params).each do |param_ident|
+          check_ident param_ident
+        end
+      end
+
+      def check_ident(ident)
+        check_name(extract_name(ident), extract_line_number(ident))
+      end
+
+      def check_name(name, line_number)
+        words = split_name_to_words(name)
+
+        unless words.all? { |word| english_word? word }
+          @violations << [name, line_number]
+        end
+      end
+
+      def split_name_to_words(text)
+        if text.include? '_'
+          text.split '_'
+        else
+          text.scan(/((\A[^A-Z]+)|[A-Z][^A-Z]*)/).map &:first
+        end.map do |word|
+          strip_word_punctuation(word)
+        end.map(&:downcase).reject(&:empty?)
+      end
+
+      def strip_word_punctuation(word)
+        word.gsub(/[^[^[:ascii:]]a-zA-Z0-9_]/, '')
+      end
+
+      def english_word?(word)
+        @word_whitelist.include? word or @aspell_speller.correct? word
+      end
+    end
+  end
+end

data/lib/skeptic/rules/methods_per_class.rb

@@ -46,6 +46,18 @@ module Skeptic
         visit body
       end
 
+      on :defs do |target, _, name, params, body|
+        target_name = extract_name(target)
+        method_name = extract_name(name)
+        class_name  = env[:class]
+
+        target_name = class_name if target_name == "self"
+        @methods[target_name] << method_name
+
+        visit params
+        visit body
+      end
+
       on :class do |name, parents, body|
         env.push :class => qualified_class_name(name)
 

data/lib/skeptic/rules/naming_conventions.rb

@@ -0,0 +1,110 @@
+module Skeptic
+  module Rules
+    class NamingConventions
+      DESCRIPTION = 'Check if the names of variables/methods/classes follow the convention'
+
+      include SexpVisitor
+
+      EXPECTED_CONVENTIONS = {
+        class:     :camel_case,
+        module:    :camel_case,
+        def:       :snake_case,
+        defs:      :snake_case,
+        symbol:    :snake_case,
+        :@ident => :snake_case,
+        :@ivar  => :snake_case,
+        :@cvar  => :snake_case,
+        :@const => :screaming_snake_case
+      }
+
+      CONVENTION_EXAMPLES = {
+        camel_case:            'CamelCase',
+        snake_case:            'snake_case',
+        screaming_snake_case:  'SCREAMING_SNAKE_CASE',
+      }
+
+      CONVENTION_REGEXES = {
+        snake_case:            /\A[a-z_][a-z_0-9]*\z/,
+        camel_case:            /\A[A-Z][a-zA-Z0-9]*\z/,
+        screaming_snake_case:  /\A[A-Z][A-Z_0-9]*\z/
+      }
+
+      NODE_NAMES = {
+        class:          'class',
+        module:         'module',
+        symbol:         'symbol',
+        def:            'method',
+        defs:           'method',
+        :@ident      => 'local variable',
+        :@ivar       => 'instance variable',
+        :@cvar       => 'class variable',
+        :@const      => 'constant'
+      }
+
+      def initialize(data)
+        @violations = []
+      end
+
+      def apply_to(code, tokens, sexp)
+        visit sexp
+        self
+      end
+
+      def violations
+        @violations.map do |type, name, line_number|
+          "#{NODE_NAMES[type]} named #{name} on line #{line_number}" +
+          " is not #{CONVENTION_EXAMPLES[EXPECTED_CONVENTIONS[type]]}"
+        end
+      end
+
+      def name
+        'Detect bad naming'
+      end
+
+      private
+
+      on :class, :module, :def do |name, *args, body|
+        extracted_name = strip_name_suffix(extract_name(name))
+        check_name sexp_type, extracted_name, extract_line_number(name)
+        visit args.first if args.first
+        visit body
+      end
+
+      on :defs do |target, _, name, params, body|
+        if [target, name].any? do |ident|
+            bad_name? :defs, strip_name_suffix(extract_name(ident))
+          end
+          @violations << [:defs, "#{target}.#{name}", extract_line_number(name)]
+        end
+        visit params
+        visit body
+      end
+
+      on :symbol do |type, text, location|
+        check_name :symbol, text, location.first
+      end
+
+      on :@ident, :@ivar, :@cvar, :@const do |text, location|
+        check_name sexp_type, strip_name_prefix(text), location.first
+      end
+
+      def check_name(type, name, line)
+        if bad_name? type, name
+          @violations << [type, name, line]
+        end
+      end
+
+      def bad_name?(type, name)
+        !CONVENTION_REGEXES[EXPECTED_CONVENTIONS[type]].match(name)
+      end
+
+      def strip_name_suffix(name)
+        name.sub(/[!?]\z/, '')
+      end
+
+      def strip_name_prefix(name)
+        name.sub(/\A@{1,2}/, '')
+      end
+    end
+  end
+end

data/lib/skeptic/rules/no_global_variables.rb

@@ -0,0 +1,35 @@
+module Skeptic
+  module Rules
+    class NoGlobalVariables
+      DESCRIPTION = 'Do not allow the use of global variables'
+
+      include SexpVisitor
+
+      def initialize(enabled = false)
+        @enabled = enabled
+        @violations = []
+      end
+
+      def apply_to(code, tokens, sexp)
+        visit sexp
+        self
+      end
+
+      def violations
+        @violations.map do |variable, line|
+          "You have a global variable #{variable} on line #{line}"
+        end
+      end
+
+      def name
+        'No global variables'
+      end
+
+      private
+
+      on :@gvar do |variable, location|
+        @violations << [variable, location.first]
+      end
+    end
+  end
+end

data/lib/skeptic/rules/spaces_around_operators.rb

@@ -0,0 +1,46 @@
+module Skeptic
+  module Rules
+    class SpacesAroundOperators
+      DESCRIPTION = 'Check for spaces around operators'
+
+      OPERATORS_WITHOUT_SPACES_AROUND_THEM = ['**']
+
+      def initialize(data)
+        @violations = []
+      end
+
+      def apply_to(code, tokens, sexp)
+        @violations = tokens.each_cons(3).select do |_, token, _|
+          operator_expecting_spaces? token
+        end.select do |left, operator, right|
+          no_spaces_between?(operator, left) or
+          no_spaces_between?(operator, right)
+        end.map do |_, operator, _|
+          [operator.last, operator.first[0]]
+        end
+        self
+      end
+
+      def violations
+        @violations.map do |value, line_number|
+          "no spaces around #{value} on line #{line_number}"
+        end
+      end
+
+      def name
+        'Spaces around operators'
+      end
+
+      private
+
+      def operator_expecting_spaces?(token)
+        token[1] == :on_op and
+          not OPERATORS_WITHOUT_SPACES_AROUND_THEM.include? token.last
+      end
+
+      def no_spaces_between?(operator, neighbour)
+        neighbour.first[0] == operator.first[0] and neighbour[1] != :on_sp
+      end
+    end
+  end
+end

data/lib/skeptic/rules.rb

@@ -5,11 +5,15 @@ module Skeptic
     end
 
     table.register CheckSyntax, :boolean
+    table.register EnglishWordsForNames, :string
     table.register LineLength, :int
     table.register LinesPerMethod, :int
     table.register MaxNestingDepth, :int
     table.register MethodsPerClass, :int
+    table.register NamingConventions, :boolean
     table.register NoSemicolons, :boolean
+    table.register NoGlobalVariables, :boolean
     table.register NoTrailingWhitespace, :boolean
+    table.register SpacesAroundOperators, :boolean
   end
 end

data/lib/skeptic/sexp_visitor.rb

@@ -25,7 +25,7 @@ module Skeptic
           type, *args = *sexp
           handler = self.class.handlers[type]
 
-          with_sexp_type(type) { instance_exec(*args, &handler) }
+          with_sexp_type(type) { instance_exec *args, &handler }
         else
           range = sexp[0].kind_of?(Symbol) ? 1..-1 : 0..-1
 
@@ -52,14 +52,42 @@ module Skeptic
       def extract_name(tree)
         type, first, second = *tree
         case type
-          when :const_path_ref then "#{extract_name(first)}::#{extract_name(second)}"
-          when :const_ref then extract_name(first)
-          when :var_ref then extract_name(first)
-          when :@const then first
-          when :@ident then first
-          when :@kw then first
-          when :@op then first
-          else '<unknown>'
+          when :const_path_ref
+            "#{extract_name(first)}::#{extract_name(second)}"
+          when :const_ref, :var_ref, :var_field, :field, :aref_field, :blockarg
+            extract_name(first)
+          when :@const, :@ident, :@label, :@kw, :@op, :@ivar, :@cvar, :@gvar
+            first
+          else
+            '<unknown>'
+        end
+      end
+
+      def extract_line_number(tree)
+        type, first, second = *tree
+        case type
+          when :const_path_ref, :const_ref, :var_ref, :var_field
+            extract_line_number(first)
+          when :@const, :@op, :@ident, :@ivar, :cvar, :@gvar, :@label
+            second.first
+          else
+            0
+        end
+      end
+
+      def extract_param_idents(tree)
+        type, first, second = *tree
+        case type
+          when :params, :mlhs_add_star
+            tree[1..-1].compact.map { |node| extract_param_idents node }.reduce [], :+
+          when :mlhs_paren, :blockarg, :rest_param
+            extract_param_idents first
+          when :@ident, :@label
+            [tree]
+          when Symbol
+            []
+          else
+            tree.compact.map { |node| extract_param_idents node }.reduce [], :+
         end
       end
     end

data/lib/skeptic.rb

@@ -11,6 +11,10 @@ require 'skeptic/rules/lines_per_method'
 require 'skeptic/rules/no_semicolons'
 require 'skeptic/rules/line_length'
 require 'skeptic/rules/no_trailing_whitespace'
+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/rule_table'
 require 'skeptic/rules'

data/skeptic.gemspec

@@ -5,25 +5,26 @@
 
 Gem::Specification.new do |s|
   s.name = "skeptic"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stefan Kanev"]
-  s.date = "2012-10-25"
+  s.date = "2013-11-15"
   s.description = "An experimental, half-assed, bug-ridden and highly opinionated code analyzer."
   s.email = "stefan.kanev@gmail.com"
   s.executables = ["skeptic"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.markdown"
   ]
   s.files = [
     ".document",
     ".rspec",
     ".rvmrc",
+    "CHANGELOG.md",
     "Gemfile",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.markdown",
     "Rakefile",
     "VERSION",
     "bin/skeptic",
@@ -34,12 +35,16 @@ Gem::Specification.new do |s|
     "lib/skeptic/rule_table.rb",
     "lib/skeptic/rules.rb",
     "lib/skeptic/rules/check_syntax.rb",
+    "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_nesting_depth.rb",
     "lib/skeptic/rules/methods_per_class.rb",
+    "lib/skeptic/rules/naming_conventions.rb",
+    "lib/skeptic/rules/no_global_variables.rb",
     "lib/skeptic/rules/no_semicolons.rb",
     "lib/skeptic/rules/no_trailing_whitespace.rb",
+    "lib/skeptic/rules/spaces_around_operators.rb",
     "lib/skeptic/scope.rb",
     "lib/skeptic/sexp_visitor.rb",
     "skeptic.gemspec"
@@ -47,7 +52,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/skanev/skeptic"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.23"
   s.summary = "Skeptic points out annoying things in your code"
 
   if s.respond_to? :specification_version then
@@ -61,6 +66,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<ffi-aspell>, [">= 0"])
     else
       s.add_dependency(%q<trollop>, [">= 1.16.2"])
       s.add_dependency(%q<rspec>, [">= 0"])
@@ -69,6 +75,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<jeweler>, [">= 0"])
       s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<ffi-aspell>, [">= 0"])
     end
   else
     s.add_dependency(%q<trollop>, [">= 1.16.2"])
@@ -78,6 +85,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<ffi-aspell>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skeptic
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-25 00:00:00.000000000 Z
+date: 2013-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -123,6 +123,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ffi-aspell
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: An experimental, half-assed, bug-ridden and highly opinionated code analyzer.
 email: stefan.kanev@gmail.com
 executables:
@@ -130,14 +146,15 @@ executables:
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 files:
 - .document
 - .rspec
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - VERSION
 - bin/skeptic
@@ -148,12 +165,16 @@ files:
 - lib/skeptic/rule_table.rb
 - lib/skeptic/rules.rb
 - lib/skeptic/rules/check_syntax.rb
+- 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_nesting_depth.rb
 - lib/skeptic/rules/methods_per_class.rb
+- lib/skeptic/rules/naming_conventions.rb
+- lib/skeptic/rules/no_global_variables.rb
 - lib/skeptic/rules/no_semicolons.rb
 - lib/skeptic/rules/no_trailing_whitespace.rb
+- lib/skeptic/rules/spaces_around_operators.rb
 - lib/skeptic/scope.rb
 - lib/skeptic/sexp_visitor.rb
 - skeptic.gemspec
@@ -172,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -47347213712121151
+      hash: -3902018802479636628
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -181,7 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Skeptic points out annoying things in your code

data/README.rdoc

@@ -1,21 +0,0 @@
-= skeptic
-
-An **very** experimental static Ruby 1.9 analyzer to point out annoying things in your code. You
-should probably not use it for anything.
-
-Writing it is fun, though.
-
-== Contributing to skeptic
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
-* Fork the project
-* Start a feature/bugfix branch
-* Commit and push until you are happy with your contribution
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2011 Stefan Kanev. See LICENSE.txt for
-further details.