pelusa 0.2.1 → 0.2.2

data/lib/pelusa/lint.rb

@@ -7,6 +7,7 @@ require 'pelusa/lint/else_clauses'
 require 'pelusa/lint/properties'
 require 'pelusa/lint/collection_wrappers'
 require 'pelusa/lint/short_identifiers'
+require 'pelusa/lint/long_identifiers'
 require 'pelusa/lint/case_statements'
 require 'pelusa/lint/many_arguments'
 require 'pelusa/lint/eval_usage'
@@ -26,6 +27,7 @@ module Pelusa
         Properties,
         CollectionWrappers,
         ShortIdentifiers,
+        LongIdentifiers,
         ManyArguments,
         EvalUsage
       ]

data/lib/pelusa/lint/indentation_level.rb

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

data/lib/pelusa/lint/long_identifiers.rb

@@ -0,0 +1,58 @@
+module Pelusa
+  module Lint
+    class LongIdentifiers
+      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|
+          "These names are too long: #{violations.join(', ')}"
+        end
+      end
+
+      private
+
+      def name
+        "Uses names of adequate length (less than #{limit})"
+      end
+
+      def limit
+        Pelusa.configuration['LongIdentifiers'].fetch('limit', 20)
+      end
+
+      def iterate_lines!(klass)
+        iterator = Iterator.new do |node|
+          if node.respond_to?(:name)
+            name = node.name.respond_to?(:name) ? node.name.name.to_s : node.name.to_s
+            if name =~ /[a-z]/ && name.length > limit
+              next if name =~ /^[A-Z]/ # Ignore constants
+              @violations << [name, node.line]
+            end
+          end
+        end
+        Array(klass).each(&iterator)
+      end
+
+      def formatted_violations
+        grouped_violations = @violations.inject({}) do |hash, (name, line)|
+          hash[name] ||= []
+          hash[name] << line
+          hash
+        end
+
+        violations = []
+
+        grouped_violations.each_pair do |name, lines|
+          violations << "#{name} (line #{lines.join(', ')})"
+        end
+        violations
+      end
+    end
+  end
+end

data/lib/pelusa/lint/short_identifiers.rb

@@ -1,6 +1,8 @@
 module Pelusa
   module Lint
     class ShortIdentifiers
+      RESERVED_NAMES = ['p', 'pp', 'id']
+
       def initialize
         @violations = Set.new
       end
@@ -26,7 +28,7 @@ module Pelusa
         iterator = Iterator.new do |node|
           if node.respond_to?(:name)
             name = node.name.respond_to?(:name) ? node.name.name.to_s : node.name.to_s
-            if name =~ /[a-z]/ && name.length < 3 && !["p", "pp"].include?(name)
+            if name =~ /[a-z]/ && name.length < 3 && !RESERVED_NAMES.include?(name)
               next if name =~ /^[A-Z]/ # Ignore constants
               @violations << [name, node.line]
             end

data/lib/pelusa/version.rb

@@ -1,3 +1,3 @@
 module Pelusa
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/test/pelusa/lint/long_identifiers_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+module Pelusa
+  module Lint
+    describe LongIdentifiers do
+      before do
+        @lint = LongIdentifiers.new
+      end
+
+      describe '#check' do
+        describe 'when the class contains no long identifiers' do
+          it 'returns a SuccessAnalysis' do
+            klass = """
+            class Foo
+              def initialize
+                not_long_identifier = nil
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.successful?.must_equal true
+          end
+        end
+
+        describe 'when the class contains a long identifier' do
+          it 'returns a FailureAnalysis' do
+            klass = """
+            class Foo
+              def initialize
+                it_is_long_identifier = nil
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.failed?.must_equal true
+          end
+        end
+      end
+    end
+  end
+end

data/test/pelusa/lint/short_identifiers_test.rb

@@ -22,6 +22,21 @@ module Pelusa
           end
         end
 
+        describe 'when the class contains short identifier from reserved list' do
+          it 'returns a SuccessAnalysis' do
+            klass = """
+            class Foo
+              def initialize
+                id = 2
+                pp id
+              end
+            end""".to_ast
+
+            analysis = @lint.check(klass)
+            analysis.successful?.must_equal true
+          end
+        end
+
         describe 'when the class contains a short identifier' do
           it 'returns a FailureAnalysis' do
             klass = """

metadata

@@ -1,27 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: pelusa
 version: !ruby/object:Gem::Version
-  version: 0.2.1
   prerelease: 
+  version: 0.2.2
 platform: ruby
 authors:
 - Josep M. Bach
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  requirement: &7212 !ruby/object:Gem::Requirement
+  prerelease: false
+  type: :development
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  name: mocha
-  version_requirements: *7212
-  prerelease: false
-  type: :development
+    none: false
 description: Static analysis Lint-type tool to improve your OO Ruby code
 email:
 - josep.m.bach@gmail.com
@@ -54,6 +59,7 @@ files:
 - lib/pelusa/lint/indentation_level.rb
 - lib/pelusa/lint/instance_variables.rb
 - lib/pelusa/lint/line_restriction.rb
+- lib/pelusa/lint/long_identifiers.rb
 - lib/pelusa/lint/many_arguments.rb
 - lib/pelusa/lint/properties.rb
 - lib/pelusa/lint/short_identifiers.rb
@@ -79,6 +85,7 @@ files:
 - test/pelusa/lint/indentation_level_test.rb
 - test/pelusa/lint/instance_variables_test.rb
 - test/pelusa/lint/line_restriction_test.rb
+- test/pelusa/lint/long_identifiers_test.rb
 - test/pelusa/lint/many_arguments_test.rb
 - test/pelusa/lint/properties_test.rb
 - test/pelusa/lint/short_identifiers_test.rb
@@ -93,20 +100,20 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: pelusa
-rubygems_version: 1.8.12
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Static analysis Lint-type tool to improve your OO Ruby code
@@ -128,6 +135,7 @@ test_files:
 - test/pelusa/lint/indentation_level_test.rb
 - test/pelusa/lint/instance_variables_test.rb
 - test/pelusa/lint/line_restriction_test.rb
+- test/pelusa/lint/long_identifiers_test.rb
 - test/pelusa/lint/many_arguments_test.rb
 - test/pelusa/lint/properties_test.rb
 - test/pelusa/lint/short_identifiers_test.rb