improve_your_code 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a81cdf7aa2de07a1fa7de9913869dd0d13c9d2b
-  data.tar.gz: 9e90b1d298fb90594093b3e2ed0486e99f248d15
+  metadata.gz: 310145a7aeff673ad9a5f87923798188595f745f
+  data.tar.gz: c8c74b13fdf446388cfb92fda52653288c3aa76e
 SHA512:
-  metadata.gz: d163763a9847ea7a6a3420a0dd7cb7ef23704fb98b0590706cc8987ae634a71d070f4715027163240b8830e34a9dec1093970c6214c93efaed949331cb462e2b
-  data.tar.gz: f9f073e2c4a4d112a45e4ae720cd8f6990d4110fab0b443d0ac45ed06d3cbd3ed282a39d95b4db019a2e570e003a7ecbca99174a15f28cfcb028f63eff32b93f
+  metadata.gz: 99ac7c7d43928b479665369d2c0acddd0dc7e85f2636792a5acf655be891a36212c4db91be73bc75d2ae26acdf44d21e22858e4ef286798d06080b794e5662b6
+  data.tar.gz: f8011006e1980fb6ccc570ab1000ac1a558a6585ec84db5ab9ab67cd0ef5e3107c2ae398b9e54639675246264723d126531c18396442ab792fa164da4d4dfd9d

data/README.md

@@ -0,0 +1,139 @@
+# Improve Your Code
+
+## Code smell detector for Ruby
+
+**Table of Contents**
+
+- [Quickstart](#quickstart)
+- [Example](#example)
+- [Fixing Smell Warnings](#fixing-smell-warnings)
+
+## Quickstart
+
+ImproveYourCode is a tool that examines Ruby classes, modules and methods and reports any.
+
+Install it via rubygems:
+
+```Bash
+gem install improve_your_code
+```
+
+and run it like this:
+
+```Bash
+improve_your_code
+```
+
+## Example
+
+Imagine a source file `main.rb` containing:
+
+```Ruby
+module A
+  # UncommunicativeModuleName: A has the name 'A'
+
+  class Main
+
+    # TooManyConstants: Main has 4 constants
+    # TooManyMethods: Main Your class has 8 methods. We propose to use 
+    # ExtractClass Pattern
+
+    # TooManyInstanceVariables: Main has at least 4 instance variables.
+    # We propose to use Facade Pattern
+
+    FIRST = 1
+    SECOND = 2
+    THIRD = 3
+    FOURTH = 4
+
+    # LongParameterList: initialize has 4 parameters.
+    # We propose to use Builder Pattern
+
+    def initialize(first, second, third, fourth)
+      @first = first
+      @second = second
+      @third = third
+      @fourth = fourth
+    end
+
+    def first
+      # TooManyStatements: first Your method has 6 statements.
+      # We propose to use ExtractMethod Pattern
+
+      # UncommunicativeVariableName: first has the variable name 'a'
+
+      a = 1
+      b = 2
+      c = 3
+      d = 4
+      e = 5
+      f = 6
+    end
+
+    def second
+
+    end
+
+    def third
+
+    end
+
+    def fourth
+
+    end
+
+    def fifth
+
+    end
+
+    def a(a)
+      # UnusedParameters: a has unused parameter 'a'
+
+      b = 1
+    end
+
+    private
+
+    def b
+      # UnusedPrivateMethod: Main has the unused private instance
+      # method 'b'
+
+    end
+  end
+end
+```
+
+ImproveYourCode will report the following code smells in this file:
+
+```
+$ improve_your_code
+
+W
+
+main.rb -- 17 warnings:
+  [8]:LongParameterList: initialize has 4 parameters. We propose to use Builder Pattern.
+  [2]:TooManyConstants: Main has 4 constants
+  [2]:TooManyInstanceVariables: Main has at least 4 instance variables. We propose to use Facade Pattern
+  [2]:TooManyMethods: Main Your class has 8 methods. We propose to use ExtractClass Pattern
+  [15]:TooManyStatements: first Your method has 6 statements. We propose to use ExtractMethod Pattern
+  [40]:UncommunicativeMethodName: a has the name 'a'
+  [46]:UncommunicativeMethodName: b has the name 'b'
+  [1]:UncommunicativeModuleName: A has the name 'A'
+  [41]:UncommunicativeVariableName: a has the variable name 'b'
+  [16]:UncommunicativeVariableName: first has the variable name 'a'
+  [17]:UncommunicativeVariableName: first has the variable name 'b'
+  [18]:UncommunicativeVariableName: first has the variable name 'c'
+  [19]:UncommunicativeVariableName: first has the variable name 'd'
+  [20]:UncommunicativeVariableName: first has the variable name 'e'
+  [21]:UncommunicativeVariableName: first has the variable name 'f'
+  [40]:UnusedParameters: a has unused parameter 'a'
+  [46]:UnusedPrivateMethod: Main has the unused private instance method 'b'
+17 total warnings
+
+```
+
+## Fixing Smell Warnings
+
+ImproveYourCode focuses on high-level code smells, so we can't tell you how to fix warnings in
+a generic fashion; this is and will always be completely dependent on your domain
+language and business logic.

data/improve_your_code.gemspec

@@ -7,6 +7,8 @@ Gem::Specification.new do |s|
   s.version = ImproveYourCode::Version::STRING
 
   s.authors = ['Ilya Umanets']
+  s.email = 'ilya.umanets.web@gmail.com'
+  s.homepage = 'https://github.com/IlyaUmanets/improve_your_code'
   s.default_executable = 'improve_your_code'
   s.description =
     'ImproveYourCode is a tool that examines Ruby classes, modules and methods and reports ' \

data/lib/improve_your_code/ast/node.rb

@@ -54,11 +54,7 @@ module ImproveYourCode
       def format_to_ruby
         if location
           lines = location.expression.source.split("\n").map(&:strip)
-          case lines.length
-          when 1 then lines.first
-          when 2 then lines.join('; ')
-          else [lines.first, lines.last].join(' ... ')
-          end
+          lines.first
         else
           to_s
         end

data/lib/improve_your_code/context_builder.rb

@@ -11,20 +11,14 @@ require_relative 'ast/node'
 
 module ImproveYourCode
   class ContextBuilder
-    attr_reader :context_tree
+    attr_reader :syntax_tree
 
     def initialize(syntax_tree)
-      @exp = syntax_tree
-      @current_context = Context::RootContext.new(exp)
-      @context_tree = build(exp)
+      @syntax_tree = syntax_tree
+      @current_context = Context::RootContext.new(syntax_tree)
     end
 
-    private
-
-    attr_accessor :current_context
-    attr_reader :exp
-
-    def build(exp, parent_exp = nil)
+    def build(exp = syntax_tree, parent_exp = nil)
       context_processor = "process_#{exp.type}"
 
       if context_processor_exists?(context_processor)
@@ -32,9 +26,14 @@ module ImproveYourCode
       else
         process exp
       end
+
       current_context
     end
 
+    private
+
+    attr_accessor :current_context
+
     def process(exp)
       exp.children.grep(AST::Node).each { |child| build(child, exp) }
     end

data/lib/improve_your_code/examiner.rb

@@ -40,7 +40,7 @@ module ImproveYourCode
     end
 
     def examine_tree
-      ContextBuilder.new(syntax_tree).context_tree.flat_map do |element|
+      ContextBuilder.new(syntax_tree).build.flat_map do |element|
         detector_repository.examine(element)
       end
     end

data/lib/improve_your_code/version.rb

@@ -2,6 +2,6 @@
 
 module ImproveYourCode
   module Version
-    STRING = '1.0.0'
+    STRING = '1.0.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: improve_your_code
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Ilya Umanets
@@ -46,7 +46,7 @@ dependencies:
         version: '2.0'
 description: ImproveYourCode is a tool that examines Ruby classes, modules and methods
   and reports any code smells it finds.
-email: 
+email: ilya.umanets.web@gmail.com
 executables:
 - improve_your_code
 extensions: []
@@ -115,7 +115,7 @@ files:
 - lib/improve_your_code/source/source_locator.rb
 - lib/improve_your_code/tree_dresser.rb
 - lib/improve_your_code/version.rb
-homepage: 
+homepage: https://github.com/IlyaUmanets/improve_your_code
 licenses: []
 metadata: {}
 post_install_message: