pelusa 0.0.2 → 0.1.0

data/.pelusa.yml

@@ -0,0 +1 @@
+sources: lib/**/*.rb

data/.rvmrc

@@ -1 +1,2 @@
-rvm use rbx-head@pelusa
+rvm use --create rbx@pelusa
+RBXOPT="$RBXOPT -X19"

data/Readme.md

@@ -1,4 +1,5 @@
-# pelusa - a Ruby Lint to improve your OO skills [![Build Status](https://secure.travis-ci.org/codegram/pelusa.png)](http://travis-ci.org/codegram/pelusa)
+# pelusa - /pe 'lu sa/ [![Build Status](https://secure.travis-ci.org/codegram/pelusa.png)](http://travis-ci.org/codegram/pelusa) [![Dependency Status](https://gemnasium.com/codegram/pelusa.png)](https://gemnasium.com/codegram/pelusa)
+## A Ruby Lint to improve your OO skills
 
 Pelusa is a static analysis tool and framework to inspect your code style and
 notify you about possible red flags or missing best practices.
@@ -20,9 +21,9 @@ Here's a sample of pelusa linting on its own code base:
 Pelusa happens to be Spanish for the word "Lint". Yeah, I couldn't believe it
 either.
 
-## Install and usage
+## Installation and usage
 
-    rvm use rbx-head
+    rvm use rbx
     gem install pelusa
 
 To run pelusa, you must run Rubinius in 1.9 mode. To do this, export this

data/lib/pelusa.rb

@@ -2,12 +2,21 @@ module Pelusa
   # Public: Runs the runner on a set of files.
   #
   # Returns an Array of results of a given Reporter
-  def self.run(files=[], reporter=StdoutReporter, lints=Lint.all)
+  def self.run(files=[], reporter=StdoutReporter)
+    lints = configuration.enabled_lints
     runner = Runner.new(lints, reporter)
     runner.run(files)
   end
+
+  # Return configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
 end
 
+require 'yaml'
+
+require 'pelusa/configuration'
 require 'pelusa/cli'
 require 'pelusa/runner'
 require 'pelusa/analyzer'

data/lib/pelusa/cli.rb

@@ -21,7 +21,9 @@ module Pelusa
       if glob = @args.detect { |arg| arg =~ /\*/ }
         return Dir[glob]
       end
-      @args.select { |arg| arg =~ /\.rb/ }
+      _files = @args.select { |arg| arg =~ /\.rb/ }
+      _files = Dir[Pelusa.configuration.sources] if _files.empty?
+      _files
     end
   end
 end

data/lib/pelusa/configuration.rb

@@ -0,0 +1,84 @@
+module Pelusa
+  # Public: Class providing configuration for the runner and lints
+  #
+  # Examples
+  #
+  #   configuration = Pelusa::Configuration.new('my_pelusa_config.yml')
+  #   configuration.present? # => true
+  #
+  class Configuration
+    YAML_PATH = './.pelusa.yml'
+
+    # Public: Initializes a configuration instance
+    #
+    # yaml_path - optional path to the configuration file
+    def initialize(yaml_path = YAML_PATH)
+      if File.exist?(yaml_path)
+        @_configuration = YAML.load_file(yaml_path).freeze
+      end
+    end
+
+    # Public: Returns if a custom configuration is present
+    #
+    # Examples
+    #
+    #   Pelusa.configuration.present? # => true
+    #
+    def present?
+      not @_configuration.nil?
+    end
+
+    # Public: Returns custom configuration for the given lint
+    #
+    # Examples
+    #
+    #   Pelusa.configuration['LineRestriction'] # => {'limit' => 50}
+    #
+    # name - the name of the lint
+    def [](name)
+      for_lint(name)
+    end
+
+    # Public: Returns path to sources that should be analyzed
+    #
+    # Examples
+    #
+    #   Pelusa.configuration.sources # => lib/**/*.rb
+    #
+    def sources
+      @_configuration['sources']
+    end
+
+    # Public: Returns an Array of enabled lints
+    #
+    # Examples
+    #
+    #   Pelusa.configuration.enabled_lints # => [ Pelusa::Lint::DemeterLaw ]
+    #
+    def enabled_lints
+      (Lint.all - disabled_lints).uniq
+    end
+
+    #######
+    private
+    #######
+
+    # Private: Returns a Hash of configuration for lints
+    def lints
+      @_configuration.fetch('lints', {})
+    end
+
+    # Private: Returns an Array of lints disabled in the configuration
+    def disabled_lints
+      lints.select { |lint, conf| conf['enabled'] === false }.map do |lint,|
+        Lint.const_get(lint)
+      end
+    end
+
+    # Private: Public: Returns custom configuration for the given lint
+    def for_lint(name)
+      lints.fetch(name, {})
+    end
+
+  end # class Configuration
+end # module Pelusa

data/lib/pelusa/lint.rb

@@ -7,6 +7,8 @@ require 'pelusa/lint/else_clauses'
 require 'pelusa/lint/properties'
 require 'pelusa/lint/collection_wrappers'
 require 'pelusa/lint/short_identifiers'
+require 'pelusa/lint/case_statements'
+require 'pelusa/lint/many_arguments'
 
 module Pelusa
   # Public: A Lint is a quality standard, applicable on a given piece of code to
@@ -23,6 +25,7 @@ module Pelusa
         Properties,
         CollectionWrappers,
         ShortIdentifiers,
+        ManyArguments
       ]
     end
   end

data/lib/pelusa/lint/case_statements.rb

@@ -0,0 +1,35 @@
+module Pelusa
+  module Lint
+    class CaseStatements
+      def initialize
+        @violations = Set.new
+      end
+
+      def check(klass)
+        initialize
+        iterate_lines!(klass)
+
+        return SuccessfulAnalysis.new(name) if @violations.empty?
+
+        FailedAnalysis.new(name, @violations) do |violations|
+          "There are #{violations.length} case statements in lines #{violations.to_a.join(', ')}"
+        end
+      end
+
+      private
+
+      def name
+        "Doesn't use case statements"
+      end
+
+      def iterate_lines!(klass)
+        iterator = Iterator.new do |node|
+          if node.is_a?(Rubinius::AST::Case)
+            @violations << node.line
+          end
+        end
+        Array(klass).each(&iterator)
+      end
+    end
+  end
+end

data/lib/pelusa/lint/indentation_level.rb

@@ -29,7 +29,11 @@ module Pelusa
               __iterate = Iterator.new do |node|
                 if body = get_body_from_node[node]
                   if node.line != [body].flatten.first.line
-                    @violations << body.line
+                    if body.is_a?(Array)
+                      @violations.merge body.map(&:line)
+                    else
+                      @violations << body.line
+                    end
                   end
                 end
               end

data/lib/pelusa/lint/instance_variables.rb

@@ -23,7 +23,7 @@ module Pelusa
       end
 
       def limit
-        3
+        Pelusa.configuration['InstanceVariables'].fetch('limit', 3)
       end
 
       def iterate_lines!(klass)

data/lib/pelusa/lint/line_restriction.rb

@@ -23,7 +23,7 @@ module Pelusa
       end
 
       def limit
-        50
+        Pelusa.configuration['LineRestriction'].fetch('limit', 50)
       end
 
       def lines

data/lib/pelusa/lint/many_arguments.rb

@@ -0,0 +1,42 @@
+module Pelusa
+  module Lint
+    class ManyArguments
+      def initialize
+        @violations = Set.new
+      end
+
+      def check(klass)
+        initialize
+        iterate_lines!(klass)
+        return SuccessfulAnalysis.new(name) if @violations.empty?
+
+        FailedAnalysis.new(name, formatted_violations) do |violations|
+          "Methods with more than #{limit} arguments: #{violations.join(', ')}"
+        end
+      end
+
+      private
+
+      def name
+        "Methods have short argument lists"
+      end
+
+      def limit
+        Pelusa.configuration['ManyArguments'].fetch('limit', 3)
+      end
+
+      def iterate_lines!(klass)
+        iterator = Iterator.new do |node|
+          if node.is_a?(Rubinius::AST::Define) && node.arguments.total_args > limit
+            @violations << node.name
+          end
+        end
+        Array(klass).each(&iterator)
+      end
+
+      def formatted_violations
+        @violations.to_a
+      end
+    end
+  end
+end

data/lib/pelusa/version.rb

@@ -1,3 +1,3 @@
 module Pelusa
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/fixtures/sample_config_one.yml

@@ -0,0 +1,7 @@
+sources: lib/**/*.rb
+lints:
+  ElseClauses:
+    enabled: false
+  LineRestriction:
+    enabled: true
+    limit: 80

data/test/pelusa/configuration_test.rb

@@ -0,0 +1,56 @@
+require 'test_helper'
+
+module Pelusa
+  describe Configuration do
+    let(:configuration) do
+      Pelusa::Configuration.new("#{FIXTURES_PATH}/sample_config_one.yml")
+    end
+
+    describe "#present?" do
+      it "returns false when configuration doesn't file exists" do
+        configuration = Pelusa::Configuration.new("#{FIXTURES_PATH}/not_here.yml")
+        configuration.present?.must_equal(false)
+      end
+
+      it "returns false when configuration file exists" do
+        configuration.present?.must_equal(true)
+      end
+    end
+
+    describe '#sources' do
+      it 'returns path to sources' do
+        configuration.sources.must_equal 'lib/**/*.rb'
+      end
+    end
+
+    describe '#enabled_lints' do
+      let(:enabled_lints) { Lint.all - [ Pelusa::Lint::ElseClauses ] }
+
+      it 'returns all enabled lints' do
+        configuration.enabled_lints.must_equal(enabled_lints)
+      end
+    end
+
+    describe '#[]' do
+      describe 'when lint configuration exists' do
+        let(:lint_configuration) { configuration['LineRestriction'] }
+
+        it 'returns a configuration hash for the given lint' do
+          lint_configuration.must_be_instance_of(Hash)
+        end
+
+        it 'must return valid configuration' do
+          lint_configuration['limit'].must_equal(80)
+        end
+      end
+
+      describe "when lint configuration doesn't exist" do
+        let(:lint_configuration) { configuration['DemeterLaw'] }
+
+        it 'returns an empty configuration hash' do
+          lint_configuration.must_equal({})
+        end
+      end
+    end
+  end
+end

data/test/pelusa/lint/case_statements_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+module Pelusa
+  module Lint
+    describe CaseStatements do
+      before do
+        @lint = CaseStatements.new
+      end
+
+      describe '#check' do
+        describe 'when the class does not use switch statements' do
+          it 'returns a SuccessAnalysis' do
+            klass = """
+            class Foo
+              def initialize
+                return nil
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.successful?.must_equal true
+          end
+        end
+
+        describe 'when the class uses case statements' do
+          it 'returns a FailureAnalysis' do
+            klass = """
+            class Foo
+              def initialize
+                case foo
+                  when bar
+                end
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.failed?.must_equal true
+          end
+        end
+      end
+    end
+  end
+end

data/test/pelusa/lint/indentation_level_test.rb

@@ -41,6 +41,26 @@ module Pelusa
             analysis.failed?.must_equal true
           end
         end
+
+        describe "when there is method which produces nested list" do
+          it 'returns a FailureAnalysis' do
+            klass = """
+            class Foo
+              def initialize
+                if test
+                  a = [
+                    (1..3).map do |num|
+                      num
+                    end
+                  ]
+                end
+              end
+            end""".to_ast
+
+            analysis = @lint.check klass
+            analysis.failed?.must_equal true
+          end
+        end
       end
     end
   end

data/test/pelusa/lint/many_arguments_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module Pelusa
+  module Lint
+    describe ManyArguments do
+      before do
+        @lint = ManyArguments.new
+      end
+
+      describe '#check' do
+        describe 'when the class contains only method definitions with a small number of arguments' do
+          it 'returns a SuccessAnalysis' do
+            klass = """
+            class Foo
+              def bar(dog)
+                return dog
+              end
+              def baz(dog, cat)
+                return dog + cat
+              end
+              def bam(dog, cat, fish)
+                return dog + cat + fish
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.successful?.must_equal true
+          end
+        end
+
+        describe 'when the class contains a method definition with many arguments' do
+          it 'returns a FailureAnalysis' do
+            klass = """
+            class Foo
+              def bar(dog, cat, fish, lobster)
+                x = 2
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.failed?.must_equal true
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -3,3 +3,5 @@ require 'minitest/spec'
 require 'mocha'
 
 require 'pelusa'
+
+FIXTURES_PATH = File.dirname(__FILE__) + '/fixtures'

metadata

@@ -2,24 +2,24 @@
 name: pelusa
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Josep M. Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-15 00:00:00.000000000 Z
+date: 2012-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  version_requirements: &6324 !ruby/object:Gem::Requirement
+  version_requirements: &4832 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
   prerelease: false
-  requirement: *6324
+  requirement: *4832
   name: mocha
   type: :development
 description: Static analysis Lint-type tool to improve your OO Ruby code
@@ -31,6 +31,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .pelusa.yml
 - .rvmrc
 - .travis.yml
 - Gemfile
@@ -42,14 +43,17 @@ files:
 - lib/pelusa/analyzer.rb
 - lib/pelusa/class_analyzer.rb
 - lib/pelusa/cli.rb
+- lib/pelusa/configuration.rb
 - lib/pelusa/iterator.rb
 - lib/pelusa/lint.rb
+- lib/pelusa/lint/case_statements.rb
 - lib/pelusa/lint/collection_wrappers.rb
 - lib/pelusa/lint/demeter_law.rb
 - lib/pelusa/lint/else_clauses.rb
 - lib/pelusa/lint/indentation_level.rb
 - lib/pelusa/lint/instance_variables.rb
 - lib/pelusa/lint/line_restriction.rb
+- lib/pelusa/lint/many_arguments.rb
 - lib/pelusa/lint/properties.rb
 - lib/pelusa/lint/short_identifiers.rb
 - lib/pelusa/report.rb
@@ -59,16 +63,20 @@ files:
 - lib/pelusa/runner.rb
 - lib/pelusa/version.rb
 - pelusa.gemspec
+- test/fixtures/sample_config_one.yml
 - test/pelusa/analysis_test.rb
 - test/pelusa/analyzer_test.rb
 - test/pelusa/class_analyzer_test.rb
+- test/pelusa/configuration_test.rb
 - test/pelusa/iterator_test.rb
+- test/pelusa/lint/case_statements_test.rb
 - test/pelusa/lint/collection_wrappers_test.rb
 - test/pelusa/lint/demeter_law_test.rb
 - test/pelusa/lint/else_clauses_test.rb
 - test/pelusa/lint/indentation_level_test.rb
 - test/pelusa/lint/instance_variables_test.rb
 - test/pelusa/lint/line_restriction_test.rb
+- test/pelusa/lint/many_arguments_test.rb
 - test/pelusa/lint/properties_test.rb
 - test/pelusa/lint/short_identifiers_test.rb
 - test/pelusa/reporters/ruby_reporter_test.rb
@@ -105,14 +113,17 @@ test_files:
 - test/pelusa/analysis_test.rb
 - test/pelusa/analyzer_test.rb
 - test/pelusa/class_analyzer_test.rb
+- test/pelusa/configuration_test.rb
 - test/pelusa/iterator_test.rb
 - test/pelusa/runner_test.rb
+- test/pelusa/lint/case_statements_test.rb
 - test/pelusa/lint/collection_wrappers_test.rb
 - test/pelusa/lint/demeter_law_test.rb
 - test/pelusa/lint/else_clauses_test.rb
 - test/pelusa/lint/indentation_level_test.rb
 - test/pelusa/lint/instance_variables_test.rb
 - test/pelusa/lint/line_restriction_test.rb
+- test/pelusa/lint/many_arguments_test.rb
 - test/pelusa/lint/properties_test.rb
 - test/pelusa/lint/short_identifiers_test.rb
 - test/pelusa/reporters/ruby_reporter_test.rb