rubycritic 1.1.1 → 1.2.0

data/.travis.yml

@@ -5,6 +5,6 @@ rvm:
   - 2.0.0
   - 2.1
   - jruby
-  - rbx-2.2.10
+  - rbx-2
 
 script: "bundle exec rake"

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# 1.2.0 / 2014-12-27
+
+* [FEATURE] Add CI mode that only analyses the last commit
+* [FEATURE] Add partial support for Mercurial
+* [FEATURE] Allow using Rubycritic programatically
+* [CHANGE] Update to Reek 1.6.0 (from 1.3.8)
+
 # 1.1.1 / 2014-07-29
 
 * [BUGFIX] Analyse only the files whose paths are specified in the CLI

data/CONTRIBUTING.md

@@ -26,28 +26,30 @@ If you want to squash a bug or add a new feature, please:
 Make exactly as many commits as you need.
 Each commit should do one thing and one thing only. For example, all whitespace fixes should be relegated to a single commit.
 
-7. Write descriptive commit messages, in accordance with [these guidelines][1].
+7. Write [descriptive commit messages].
 
-8. [Hide the sausage making][3]. Squash, split and reorder commits if necessary (`git rebase -i`).
-For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history][4].
+8. Push the branch to GitHub (`git push origin my-new-feature`).
 
-9. Push the branch to GitHub (`git push origin my-new-feature`).
+9. [Create a Pull Request] and send it to be merged with the master branch.
 
-10. Create a new [Pull Request][5] and send it to be merged with the master branch.
+10. After your code is reviewed, [hide the sausage making]. Squash, split and reorder commits if necessary (`git rebase -i`).
+For a more in-depth look at interactive rebasing, be sure to check [how to rewrite history].
 
 Improving the Documentation
 ---------------------------
 
-You are welcome to clarify how something works or simply fix a typo. Please include `[ci skip]` on a new line in each of your commit messages. This will signal [Travis][2] that running the test suite is not necessary for these changes.
+You are welcome to clarify how something works or simply fix a typo. Please include `[ci skip]` on a new line in each of your commit messages. This will signal [Travis] that running the test suite is not necessary for these changes.
 
 Reporting a Bug
 ---------------
 
 If you are experiencing unexpected behavior and, after having read Rubycritic's documentation, are convinced this behavior is a bug, please:
 
-1. Search the [issues tracker][6] to see if it was already reported / fixed.
+1. Search the [issues tracker] to see if it was already reported / fixed.
 
-2. Include the Ruby and RubyCritic versions in your report. Here's a little table to help you out:
+2. [Create a new issue].
+
+3. Include the Ruby and RubyCritic versions in your report. Here's a little table to help you out:
 
   ```
   |            | Version |
@@ -58,11 +60,11 @@ If you are experiencing unexpected behavior and, after having read Rubycritic's
 
   The more information you provide, the easier it will be to track down the issue and fix it.
 
-3. Create a new issue.
 
-[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
-[2]: https://travis-ci.org
-[3]: http://sethrobertson.github.io/GitBestPractices/#sausage
-[4]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
-[5]: https://help.github.com/articles/creating-a-pull-request
-[6]: https://github.com/whitesmith/rubycritic/search?type=Issues
+[descriptive commit messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Create a pull request]: https://help.github.com/articles/creating-a-pull-request
+[hide the sausage making]: http://sethrobertson.github.io/GitBestPractices/#sausage
+[how to rewrite history]: http://git-scm.com/book/en/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages
+[Travis]: https://travis-ci.org
+[issues tracker]: https://github.com/whitesmith/rubycritic/search?type=Issues
+[Create a new issue]: https://github.com/whitesmith/rubycritic/issues/new

data/README.md

@@ -86,10 +86,11 @@ For a full list of the command-line options run:
 $ rubycritic --help
 ```
 
-| Command flag             | Description                             |
-|--------------------------|-----------------------------------------|
-| `-v/--version`           | Displays the current version and exits. |
-| `-p/--path`              | Customizes the output directory.        |
+| Command flag             | Description                                           |
+|--------------------------|-------------------------------------------------------|
+| `-v/--version`           | Displays the current version and exits                |
+| `-p/--path`              | Sets the output directory (tmp/rubycritic by default) |
+| `-m/--mode-ci`           | Uses CI mode (faster, but only analyses last commit)  |
 
 Alternative Usage Methods
 -------------------------
@@ -109,6 +110,13 @@ Similarly, Pull Requests that improve the look and feel of the gem, that tweak t
 
 See RubyCritic's [contributing guidelines](CONTRIBUTING.md) about how to proceed.
 
+Credits
+-------
+
+![Whitesmith](http://i.imgur.com/Si2l3kd.png)
+
+RubyCritic is maintained and funded by [Whitesmith][9]. Tweet your questions or suggestions to [@glitchdout][10] or [@Whitesmithco][11].
+
 [1]: https://github.com/troessner/reek
 [2]: https://github.com/seattlerb/flay
 [3]: https://github.com/seattlerb/flog
@@ -117,3 +125,6 @@ See RubyCritic's [contributing guidelines](CONTRIBUTING.md) about how to proceed
 [6]: https://github.com/whitesmith/rubycritic/wiki/Building-your-own-Code-Climate
 [7]: https://github.com/charliesome/better_errors
 [8]: https://github.com/charliesome/better_errors/pull/22
+[9]: http://www.whitesmith.co/
+[10]: https://twitter.com/glitchdout
+[11]: https://twitter.com/Whitesmithco

data/Rakefile

@@ -1,10 +1,13 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rubocop/rake_task"
 
-task :default => :test
-
-Rake::TestTask.new do |t|
-  t.libs.push "lib"
-  t.libs.push "test"
-  t.pattern = "test/**/*_test.rb"
+Rake::TestTask.new do |task|
+  task.libs.push "lib"
+  task.libs.push "test"
+  task.pattern = "test/**/*_test.rb"
 end
+
+RuboCop::RakeTask.new
+
+task :default => [:test, :rubocop]

data/bin/rubycritic

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "rubycritic/cli"
+require "rubycritic/cli/application"
 
-exit Rubycritic::Cli.new(ARGV).execute
+exit Rubycritic::Cli::Application.new(ARGV).execute

data/lib/rubycritic.rb

@@ -1,2 +1,22 @@
 require "rubycritic/configuration"
-require "rubycritic/orchestrator"
+
+module Rubycritic
+  def self.create(options = {})
+    options_hash = options.to_h
+    Config.set(options_hash)
+    case Config.mode
+    when :version
+      require "rubycritic/commands/version"
+      Command::Version.new
+    when :help
+      require "rubycritic/commands/help"
+      Command::Help.new(options)
+    when :ci
+      require "rubycritic/commands/ci"
+      Command::Ci.new(options_hash)
+    else
+      require "rubycritic/commands/default"
+      Command::Default.new(options_hash)
+    end
+  end
+end

data/lib/rubycritic/analysers/churn.rb

@@ -2,9 +2,11 @@ module Rubycritic
   module Analyser
 
     class Churn
-      def initialize(analysed_modules, source_control_system)
+      attr_writer :source_control_system
+
+      def initialize(analysed_modules)
         @analysed_modules = analysed_modules
-        @source_control_system = source_control_system
+        @source_control_system = Config.source_control_system
       end
 
       def run

data/lib/rubycritic/analysers/helpers/ast_node.rb

@@ -23,9 +23,9 @@ module Parser
       def get_module_names
         children_modules = children
           .select { |child| child.is_a?(Parser::AST::Node) }
-          .flat_map { |child| child.get_module_names }
+          .flat_map(&:get_module_names)
 
-        if MODULE_TYPES.include?(self.type)
+        if MODULE_TYPES.include?(type)
           if children_modules.empty?
             [module_name]
           else
@@ -33,8 +33,6 @@ module Parser
               "#{module_name}::#{children_module}"
             end
           end
-        elsif children_modules.empty?
-          []
         else
           children_modules
         end
@@ -45,22 +43,20 @@ module Parser
       def module_name
         name_segments = []
         current_node = children[0]
-        while(current_node) do
+        while current_node
           name_segments.unshift(current_node.children[1])
           current_node = current_node.children[0]
         end
         name_segments.join("::")
       end
     end
-
   end
 end
 
 module Rubycritic
   module AST
-
     class EmptyNode
-      def count_nodes_of_type(*types)
+      def count_nodes_of_type(*)
         0
       end
 

data/lib/rubycritic/analysers/helpers/methods_counter.rb

@@ -1,5 +1,4 @@
-require "parser/current"
-require "rubycritic/analysers/helpers/ast_node"
+require "rubycritic/analysers/helpers/parser"
 
 module Rubycritic
 
@@ -15,9 +14,7 @@ module Rubycritic
     private
 
     def node
-      Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
-    rescue Parser::SyntaxError => error
-      AST::EmptyNode.new
+      Parser.parse(content)
     end
 
     def content

data/lib/rubycritic/analysers/helpers/modules_locator.rb

@@ -1,5 +1,4 @@
-require "parser/current"
-require "rubycritic/analysers/helpers/ast_node"
+require "rubycritic/analysers/helpers/parser"
 
 module Rubycritic
 
@@ -25,9 +24,7 @@ module Rubycritic
     private
 
     def node
-      Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
-    rescue Parser::SyntaxError => error
-      AST::EmptyNode.new
+      Parser.parse(content)
     end
 
     def content

data/lib/rubycritic/analysers/helpers/parser.rb

@@ -0,0 +1,12 @@
+require "parser/current"
+require "rubycritic/analysers/helpers/ast_node"
+
+module Rubycritic
+  module Parser
+    def self.parse(content)
+      ::Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
+    rescue ::Parser::SyntaxError
+      AST::EmptyNode.new
+    end
+  end
+end

data/lib/rubycritic/analysers/helpers/reek.rb

@@ -1,12 +1,16 @@
 require "reek"
+require "reek/configuration/app_configuration"
+require "ostruct"
 
 module Rubycritic
 
   class Reek < ::Reek::Examiner
-    DEFAULT_CONFIG_FILES = [File.expand_path("../config.reek", __FILE__)]
+    DEFAULT_CONFIG_FILE = File.expand_path("../config.reek", __FILE__)
 
     def initialize(paths)
-      super(Array(paths), DEFAULT_CONFIG_FILES)
+      config = OpenStruct.new(:options => OpenStruct.new(:config_file => DEFAULT_CONFIG_FILE))
+      ::Reek::Configuration::AppConfiguration.initialize_with(config)
+      super(Array(paths))
     end
   end
 

data/lib/rubycritic/analysers/smells/reek.rb

@@ -28,7 +28,7 @@ module Rubycritic
           :locations => smell_locations(smell.source, smell.lines),
           :context   => smell.context,
           :message   => smell.message,
-          :type      => smell.subclass,
+          :type      => smell.smell_type,
           :cost      => 0
         )
       end

data/lib/rubycritic/analysers_runner.rb

@@ -1,3 +1,5 @@
+require "rubycritic/source_locator"
+require "rubycritic/core/analysed_module"
 require "rubycritic/analysers/smells/flay"
 require "rubycritic/analysers/smells/flog"
 require "rubycritic/analysers/smells/reek"
@@ -13,19 +15,23 @@ module Rubycritic
       Analyser::FlogSmells,
       Analyser::ReekSmells,
       Analyser::Complexity,
-      Analyser::Attributes
+      Analyser::Attributes,
+      Analyser::Churn
     ]
 
-    def initialize(analysed_modules, source_control_system)
-      @analysed_modules = analysed_modules
-      @source_control_system = source_control_system
+    def initialize(paths)
+      @paths = paths
     end
 
     def run
-      ANALYSERS.each do |analyser|
-        analyser.new(@analysed_modules).run
+      ANALYSERS.each { |analyser| analyser.new(analysed_modules).run }
+      analysed_modules
+    end
+
+    def analysed_modules
+      @analysed_modules ||= SourceLocator.new(@paths).pathnames.map do |pathname|
+        AnalysedModule.new(:pathname => pathname)
       end
-      Analyser::Churn.new(@analysed_modules, @source_control_system).run
     end
   end
 

data/lib/rubycritic/cli/application.rb

@@ -0,0 +1,24 @@
+require "rubycritic"
+require "rubycritic/cli/options"
+
+module Rubycritic
+  module Cli
+    class Application
+      STATUS_SUCCESS = 0
+      STATUS_ERROR   = 1
+
+      def initialize(argv)
+        @options = Options.new(argv)
+      end
+
+      def execute
+        parsed_options = @options.parse
+        ::Rubycritic.create(parsed_options).execute
+        STATUS_SUCCESS
+      rescue OptionParser::InvalidOption => error
+        $stderr.puts "Error: #{error}"
+        STATUS_ERROR
+      end
+    end
+  end
+end

data/lib/rubycritic/cli/options.rb

@@ -0,0 +1,57 @@
+require "optparse"
+
+module Rubycritic
+  module Cli
+    class Options
+      def initialize(argv)
+        @argv = argv
+        @parser = OptionParser.new
+      end
+
+      def parse
+        @parser.new do |opts|
+          opts.banner = "Usage: rubycritic [options] [paths]"
+
+          opts.on("-p", "--path [PATH]", "Set path where report will be saved (tmp/rubycritic by default)") do |path|
+            @root = path
+          end
+
+          opts.on("-m", "--mode-ci", "Use CI mode (faster, but only analyses last commit)") do
+            @mode = :ci
+          end
+
+          opts.on_tail("-v", "--version", "Show gem's version") do
+            @mode = :version
+          end
+
+          opts.on_tail("-h", "--help", "Show this message") do
+            @mode = :help
+          end
+        end.parse!(@argv)
+        self
+      end
+
+      def help_text
+        @parser.help
+      end
+
+      def to_h
+        {
+          :mode => @mode,
+          :root => @root,
+          :paths => paths
+        }
+      end
+
+      private
+
+      def paths
+        if @argv.empty?
+          ["."]
+        else
+          @argv
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/commands/ci.rb

@@ -0,0 +1,28 @@
+require "rubycritic/source_control_systems/base"
+require "rubycritic/analysers_runner"
+require "rubycritic/reporters/main"
+
+module Rubycritic
+  module Command
+    class Ci
+      def initialize(options)
+        @paths = options[:paths]
+        Config.source_control_system = SourceControlSystem::Base.create
+      end
+
+      def execute
+        critique(@paths)
+        report
+      end
+
+      def critique(paths)
+        @analysed_modules = AnalysersRunner.new(paths).run
+      end
+
+      def report
+        report_location = Reporter::Main.new(@analysed_modules).generate_report
+        puts "New critique at #{report_location}"
+      end
+    end
+  end
+end