rubycritic 1.1.1 → 1.2.0

data/lib/rubycritic/commands/default.rb

@@ -0,0 +1,30 @@
+require "rubycritic/source_control_systems/base"
+require "rubycritic/analysers_runner"
+require "rubycritic/revision_comparator"
+require "rubycritic/reporters/main"
+
+module Rubycritic
+  module Command
+    class Default
+      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
+        RevisionComparator.new(paths).set_statuses(@analysed_modules)
+      end
+
+      def report
+        report_location = Reporter::Main.new(@analysed_modules).generate_report
+        puts "New critique at #{report_location}"
+      end
+    end
+  end
+end

data/lib/rubycritic/commands/help.rb

@@ -0,0 +1,13 @@
+module Rubycritic
+  module Command
+    class Help
+      def initialize(options)
+        @options = options
+      end
+
+      def execute
+        puts @options.help_text
+      end
+    end
+  end
+end

data/lib/rubycritic/commands/version.rb

@@ -0,0 +1,11 @@
+require "rubycritic/version"
+
+module Rubycritic
+  module Command
+    class Version
+      def execute
+        puts "RubyCritic #{VERSION}"
+      end
+    end
+  end
+end

data/lib/rubycritic/configuration.rb

@@ -1,24 +1,29 @@
-require "pathname"
-
 module Rubycritic
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
   class Configuration
     attr_reader :root
+    attr_accessor :source_control_system, :mode
 
-    def initialize
-      self.root = "tmp/rubycritic"
+    def set(options)
+      self.mode = options[:mode] || :default
+      self.root = options[:root] || "tmp/rubycritic"
     end
 
     def root=(path)
-      @root =
-        if Pathname(path).relative?
-          File.expand_path(path)
-        else
-          path
-        end
+      @root = File.expand_path(path)
+    end
+  end
+
+  module Config
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.set(options = {})
+      configuration.set(options)
+    end
+
+    def self.method_missing(method, *args, &block)
+      configuration.public_send(method, *args, &block)
     end
   end
 end

data/lib/rubycritic/core/analysed_module.rb

@@ -35,7 +35,7 @@ module Rubycritic
       end
     end
 
-    def has_smells?
+    def smells?
       !smells.empty?
     end
 

data/lib/rubycritic/core/smell.rb

@@ -18,7 +18,7 @@ module Rubycritic
       locations.any? { |location| location == other_location }
     end
 
-    def has_multiple_locations?
+    def multiple_locations?
       locations.length > 1
     end
 

data/lib/rubycritic/report_generators/base.rb

@@ -38,7 +38,7 @@ module Rubycritic
       private
 
       def root_directory
-        @root_directory ||= Pathname.new(::Rubycritic.configuration.root)
+        @root_directory ||= Pathname.new(Config.root)
       end
 
       def get_binding

data/lib/rubycritic/report_generators/line.rb

@@ -12,7 +12,7 @@ module Rubycritic
 
       def initialize(file_directory, text, smells)
         @file_directory = file_directory
-        @text = CGI::escapeHTML(text.chomp)
+        @text = CGI.escapeHTML(text.chomp)
         @smells = smells
         @template =
           if @smells.empty?

data/lib/rubycritic/report_generators/smells_index.rb

@@ -9,6 +9,7 @@ module Rubycritic
       def initialize(analysed_modules)
         @smells = analysed_modules.flat_map(&:smells).uniq
         @analysed_module_names = analysed_module_names(analysed_modules)
+        @show_status = (Config.mode == :default)
       end
 
       def file_name

data/lib/rubycritic/report_generators/templates/code_file.html.erb

@@ -28,7 +28,7 @@
     </div>
   </div>
 
-  <% if @analysed_module.has_smells? %>
+  <% if @analysed_module.smells? %>
     <button id="js-toggle-smells" class="smells-toggle-button button">Toggle Smells</button>
   <% end %>
 </div>

data/lib/rubycritic/report_generators/templates/smells_index.html.erb

@@ -3,7 +3,9 @@
   <tr>
     <th class="first-cell">Smell</th>
     <th>Locations</th>
-    <th class="centered-cell last-cell" title="Code smells introduced recently are marked as new. There's still time before they are committed!">Status</th>
+    <% if @show_status %>
+      <th class="centered-cell last-cell" title="Code smells introduced recently are marked as new. There's still time before they are committed!">Status</th>
+    <% end %>
   </tr>
 </thead>
 <tbody>
@@ -15,7 +17,9 @@
           <a href="<%= smell_location_path(location) %>"><%= @analysed_module_names[location.pathname] %></a>
         <% end %>
       </td>
-      <td class="centered-cell last-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
+      <% if @show_status %>
+        <td class="centered-cell last-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
+      <% end %>
     </tr>
   <% end %>
 </tbody>

data/lib/rubycritic/report_generators/templates/smelly_line.html.erb

@@ -4,7 +4,7 @@
 <% @smells.each do |smell| %>
   <li class="smell <%= smell.status %>">
     <span class="description"><%= smell %>
-      <% if smell.has_multiple_locations? %>
+      <% if smell.multiple_locations? %>
         <% smell.locations.each_with_index do |location, index| %>
           <a href="<%= smell_location_path(location) %>" class="js-smell-location"><%= index %></a>
         <% end %>

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -14,11 +14,11 @@ module Rubycritic
     end
 
     def asset_path(file)
-      relative_path(root_directory + "assets" + file)
+      relative_path("assets/#{file}")
     end
 
     def file_path(file)
-      relative_path(root_directory + file)
+      relative_path(file)
     end
 
     def smell_location_path(location)
@@ -27,8 +27,8 @@ module Rubycritic
 
     private
 
-    def relative_path(pathname)
-      pathname.relative_path_from(file_directory)
+    def relative_path(file)
+      (root_directory + file).relative_path_from(file_directory)
     end
 
     def file_directory

data/lib/rubycritic/reporters/base.rb

@@ -16,7 +16,7 @@ module Rubycritic
       end
 
       def copy_assets_to_report_directory
-        FileUtils.cp_r(ASSETS_DIR, ::Rubycritic.configuration.root)
+        FileUtils.cp_r(ASSETS_DIR, Config.root)
       end
     end
 

data/lib/rubycritic/revision_comparator.rb

@@ -1,5 +1,4 @@
 require "rubycritic/serializer"
-require "rubycritic/modules_initializer"
 require "rubycritic/analysers_runner"
 require "rubycritic/smells_status_setter"
 require "rubycritic/version"
@@ -10,17 +9,18 @@ module Rubycritic
   class RevisionComparator
     SNAPSHOTS_DIR_NAME = "snapshots"
 
-    def initialize(analysed_modules, source_control_system, paths)
-      @analysed_modules_now = analysed_modules
-      @source_control_system = source_control_system
+    def initialize(paths)
       @paths = paths
     end
 
-    def set_statuses
-      SmellsStatusSetter.set(
-        analysed_modules_before.flat_map(&:smells),
-        @analysed_modules_now.flat_map(&:smells)
-      )
+    def set_statuses(analysed_modules_now)
+      if Config.source_control_system.revision?
+        SmellsStatusSetter.set(
+          analysed_modules_before.flat_map(&:smells),
+          analysed_modules_now.flat_map(&:smells)
+        )
+      end
+      analysed_modules_now
     end
 
     private
@@ -30,9 +30,9 @@ module Rubycritic
       if File.file?(revision_file)
         serializer.load
       else
-        analysed_modules = ModulesInitializer.init(@paths)
-        @source_control_system.travel_to_head do
-          AnalysersRunner.new(analysed_modules, @source_control_system).run
+        analysed_modules = nil
+        Config.source_control_system.travel_to_head do
+          analysed_modules = AnalysersRunner.new(@paths).run
         end
         serializer.dump(analysed_modules)
         analysed_modules
@@ -41,11 +41,11 @@ module Rubycritic
 
     def revision_file
       @revision_file ||= File.join(
-        ::Rubycritic.configuration.root,
+        Config.root,
         SNAPSHOTS_DIR_NAME,
         VERSION,
         Digest::MD5.hexdigest(Marshal.dump(@paths)),
-        @source_control_system.head_reference
+        Config.source_control_system.head_reference
       )
     end
   end

data/lib/rubycritic/source_control_systems/base.rb

@@ -10,46 +10,22 @@ module Rubycritic
         @@systems << self
       end
 
+      def self.systems
+        @@systems
+      end
+
       def self.create
-        supported_system = systems.detect(&:supported?)
+        supported_system = systems.find(&:supported?)
         if supported_system
           supported_system.new
         else
-          puts "Rubycritic requires a #{system_names} repository."
+          puts "RubyCritic can provide more feedback if you use a #{connected_system_names} repository."
           Double.new
         end
       end
 
-      def self.systems
-        @@systems
-      end
-
-      def self.system_names
-        systems.join(", ")
-      end
-
-      def self.supported?
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      def has_revision?
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      def head_reference
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      def travel_to_head
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      def revisions_count(path)
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
-      end
-
-      def date_of_last_commit(path)
-        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      def self.connected_system_names
+        "#{systems[0...-1].join(', ')} or #{systems[-1]}"
       end
     end
 
@@ -58,3 +34,4 @@ end
 
 require "rubycritic/source_control_systems/double"
 require "rubycritic/source_control_systems/git"
+require "rubycritic/source_control_systems/mercurial"

data/lib/rubycritic/source_control_systems/double.rb

@@ -1,18 +1,17 @@
 module Rubycritic
   module SourceControlSystem
-
     class Double < Base
-      def has_revision?
-        false
-      end
-
-      def revisions_count(path)
+      def revisions_count(_)
         "N/A"
       end
 
-      def date_of_last_commit(path)
+      def date_of_last_commit(_)
         nil
       end
+
+      def revision?
+        false
+      end
     end
 
   end

data/lib/rubycritic/source_control_systems/git.rb

@@ -12,7 +12,15 @@ module Rubycritic
         "Git"
       end
 
-      def has_revision?
+      def revisions_count(path)
+        `git log --follow --format=%h #{path.shellescape}`.count("\n")
+      end
+
+      def date_of_last_commit(path)
+        `git log -1 --date=iso --format=%ad #{path.shellescape}`.chomp!
+      end
+
+      def revision?
         head_reference && $?.success?
       end
 
@@ -27,31 +35,17 @@ module Rubycritic
         travel_to_original_state if stash_successful
       end
 
-      def revisions_count(path)
-        `git log --follow --format=oneline #{path.shellescape}`.count("\n")
-      end
-
-      def date_of_last_commit(path)
-        `git log -1 --date=iso --format=%ad #{path.shellescape}`.chomp!
-      end
-
       private
 
       def stash_changes
-        return false if everything_commmited?
-
         stashes_count_before = stashes_count
         `git stash`
         stashes_count_after = stashes_count
         stashes_count_after > stashes_count_before
       end
 
-      def everything_commmited?
-        `git status --porcelain`.empty?
-      end
-
       def stashes_count
-        `git stash list`.count("\n")
+        `git stash list --format=%h`.count("\n")
       end
 
       def travel_to_original_state

data/lib/rubycritic/source_control_systems/mercurial.rb

@@ -0,0 +1,29 @@
+module Rubycritic
+  module SourceControlSystem
+
+    class Mercurial < Base
+      register_system
+
+      def self.supported?
+        `hg verify 2>&1` && $?.success?
+      end
+
+      def self.to_s
+        "Mercurial"
+      end
+
+      def revisions_count(path)
+        `hg log #{path.shellescape} --template '1'`.size
+      end
+
+      def date_of_last_commit(path)
+        `hg log #{path.shellescape} --template '{date|isodate}' --limit 1`.chomp
+      end
+
+      def revision?
+        false
+      end
+    end
+
+  end
+end