inch 0.3.4.rc1 → 0.4.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bee5d78b05fdeb0f445662eb4249e8faaa17111e
-  data.tar.gz: 3b2fc21a47176e5dcf8585bd535586d16f6df72f
+  metadata.gz: fe163966450ed56ad958a140312d1ead4e620f2d
+  data.tar.gz: 146138dacb4710aa3a44311c78fd1f8d797cecd3
 SHA512:
-  metadata.gz: 04a14a7a0cae1fc250381a3da92626e0149f32dd1ab2f614db0ac522f0e1b4a26ac39af5bbb3acb403c29f7b90c95a6941f3bee8a517d97e0b5ab69ee754c142
-  data.tar.gz: 6a8a0ec1621b7ea8ec9543514520ab8dabfae9ded1c483aa845a13aa78224c3ba4edebf266ec442075b721a629dfb421ced96169a580ecfbde8698ba47983455
+  metadata.gz: b58ec383478a3441018594906615bcf63423593239c877b02106b6eb6200b7d5243bfbe105a629fbc2c6f47534d73527a3d6e9d67e46d826fbcef56a7d84f285
+  data.tar.gz: 654bbd9012cefe46b37d51ffc1651003e7947c98328d67239227af875ebb5b41d75a2c533cad0fa168399567e867bf6c52df4257bce68047ef84f46d0d2807b2

data/lib/inch/api.rb

@@ -27,8 +27,10 @@ require_relative 'api/options/base'
 require_relative 'api/options/filter'
 require_relative 'api/options/suggest'
 
+require_relative 'api/compare'
 require_relative 'api/filter'
 require_relative 'api/get'
 require_relative 'api/list'
 require_relative 'api/suggest'
 require_relative 'api/stats'
+require_relative 'api/diff'

data/lib/inch/api/compare.rb

@@ -0,0 +1,2 @@
+require_relative 'compare/code_objects'
+require_relative 'compare/codebases'

data/lib/inch/api/compare/code_objects.rb

@@ -0,0 +1,57 @@
+module Inch
+  module API
+    module Compare
+      class CodeObjects
+        attr_reader :before, :after
+        
+        def initialize(object1, object2)
+          @before, @after = object1, object2
+          if @before.object_id == @after.object_id
+            raise "@before and @after are identical ruby objects. this is bad."
+          end
+        end
+
+        def changed?
+          present? && !unchanged?
+        end
+
+        def fullname
+          (@before || @after).fullname
+        end
+
+        def grade
+          @after.grade
+        end
+
+
+        def added?
+          @before.nil? && !@after.nil?
+        end
+
+        def degraded?
+          changed? && @before.score.to_i > @after.score.to_i
+        end
+
+        def improved?
+          changed? && @before.score.to_i < @after.score.to_i
+        end
+
+        def present?
+          @before && @after
+        end
+
+        def removed?
+          !@before.nil? && @after.nil?
+        end
+
+        def unchanged?
+          present? && @before.score.to_i == @after.score.to_i
+        end
+
+        def scores
+          [@before.score.to_i, @after.score.to_i]
+        end
+      end
+    end
+  end
+end

data/lib/inch/api/compare/codebases.rb

@@ -0,0 +1,49 @@
+module Inch
+  module API
+    module Compare
+      class Codebases
+        def initialize(codebase1, codebase2)
+          @a, @b = codebase1, codebase2
+        end
+
+        def added_objects
+          comparisons.select(&:added?)
+        end
+
+        def improved_objects
+          comparisons.select(&:improved?)
+        end
+
+        def degraded_objects
+          comparisons.select(&:degraded?)
+        end
+
+        def removed_objects
+          comparisons.select(&:removed?)
+        end
+
+        def comparisons
+          __objects_names.map do |fullname|
+            object1 = @a.objects.find(fullname)
+            object2 = @b.objects.find(fullname)
+            Compare::CodeObjects.new(object1, object2)
+          end
+        end
+
+        def find(fullname)
+          comparisons.detect do |comparison|
+            comparison.fullname == fullname
+          end
+        end
+
+        private
+
+        def __objects_names
+          fullnames = @a.objects.all.map(&:fullname) +
+                    @b.objects.all.map(&:fullname)
+          fullnames.uniq
+        end
+      end
+    end
+  end
+end

data/lib/inch/api/diff.rb

@@ -0,0 +1,71 @@
+require 'inch/utils/shell_helper'
+
+module Inch
+  module API
+    # Returns a Compare::Codebases object for two revisions of the same
+    # codebase
+    class Diff
+      include Utils::ShellHelper
+
+      attr_reader :codebase_old
+      attr_reader :codebase_new
+      attr_reader :comparer
+      attr_reader :work_dir
+
+      # @param dir [String] the working directory of the codebase
+      # @param before_rev [String] the 'before' revision
+      # @param after_rev [String,nil] the 'after' revision that the 'before'
+      #   one is compared against
+      def initialize(dir, before_rev, after_rev = nil)
+        @work_dir = dir
+        @codebase_old = codebase_for(before_rev)
+        @codebase_new = if after_rev.nil?
+            Codebase.parse(work_dir)
+          else
+            codebase_for(after_rev)
+          end
+        @comparer = API::Compare::Codebases.new(@codebase_old, @codebase_new)
+      end
+
+      private
+
+      def codebase_for(revision)
+        if cached = codebase_from_cache(revision)
+          cached
+        else
+          codebase = codebase_from_copy(work_dir, revision)
+          filename = Codebase::Serializer.filename(revision)
+          Codebase::Serializer.save(codebase, filename)
+          codebase
+        end
+      end
+
+      def codebase_from_cache(revision)
+        filename = Codebase::Serializer.filename(revision)
+        if File.exist?(filename)
+          Codebase::Serializer.load(filename)
+        end
+      end
+
+      def codebase_from_copy(original_dir, revision)
+        codebase = nil
+        Dir.mktmpdir do |tmp_dir|
+          new_dir = copy_work_dir(original_dir, tmp_dir)
+          git_reset(new_dir, revision)
+          codebase = Codebase.parse(new_dir)
+        end
+        codebase
+      end
+
+      def copy_work_dir(original_dir, tmp_dir)
+        git tmp_dir, "clone #{original_dir} --quiet"
+        File.join(tmp_dir, File.basename(original_dir))
+      end
+
+      def git_reset(dir, revision = nil)
+        git dir, "reset --hard #{revision}"
+      end
+
+    end
+  end
+end

data/lib/inch/cli/command.rb

@@ -16,3 +16,4 @@ require_relative 'command/stats'
 require_relative 'command/suggest'
 require_relative 'command/console'
 require_relative 'command/inspect'
+require_relative 'command/diff'

data/lib/inch/cli/command/diff.rb

@@ -0,0 +1,54 @@
+require 'pry'
+require_relative 'options/diff'
+require_relative 'output/diff'
+
+module Inch
+  module CLI
+    module Command
+      class Diff < Base
+        register_command_as :diff
+
+        def description
+          'Shows a diff'
+        end
+
+        def usage
+          'Usage: inch diff [REV..[REV]] [options]'
+        end
+
+        def run(*args)
+          @options.parse(args)
+          @options.verify
+
+          before_rev, after_rev = revisions[0], revisions[1]
+          diff = API::Diff.new(work_dir, before_rev, after_rev)
+
+          Output::Diff.new(@options, diff.comparer)
+        end
+
+        private
+
+        def git(dir, command)
+          old_pwd = Dir.pwd
+          Dir.chdir dir
+          out = `git #{command}`
+          Dir.chdir old_pwd
+          out
+        end
+
+        # @return [Array<String>] the revisions passed in the command_line
+        def revisions
+          @revisions ||= @options.revisions.map do |rev|
+            if rev
+              git(work_dir, "rev-parse #{rev}").strip
+            end
+          end
+        end
+
+        def work_dir
+          Dir.pwd
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/options/base_list.rb

@@ -2,9 +2,6 @@ module Inch
   module CLI
     module Command
       module Options
-        # Abstract base class for CLI options concerning lists of objects
-        #
-        # @abstract Subclass and override #set_options
         class BaseList < Base
           include API::Options::Filter::DefaultAttributeValues
 

data/lib/inch/cli/command/options/diff.rb

@@ -0,0 +1,90 @@
+require 'inch/utils/shell_helper'
+
+module Inch
+  module CLI
+    module Command
+      module Options
+        class Diff < BaseObject
+          include Utils::ShellHelper
+
+          def initialize
+            @before_rev = "HEAD"
+            @after_rev  = nil
+          end
+
+          def descriptions
+            [
+              "",
+              "Shows changes in documentation between two revisions " \
+                "(defaults to last commit against current)",
+              "",
+              "Example: " + "$ inch diff HEAD^..HEAD".cyan,
+              "",
+              description_hint_grades,
+              description_hint_arrows
+            ]
+          end
+
+          def set_options(opts)
+            diff_options(opts)
+            common_options(opts)
+          end
+
+          # @return [Array<String>] the revisions to be diffed
+          #   nil meaning the current working dir, including untracked files
+          #   since these are later parsed via `git rev-parse`, we can support
+          #   notations like "HEAD" or "HEAD^^"
+          #
+          # @example
+          #   revisions # => ["HEAD", nil]
+          def revisions
+            if object_names.empty?
+              [@before_rev, @after_rev]
+            else
+              object_names.first.split("..")
+            end
+          end
+
+          def since_last_commit?
+            revisions == ["HEAD", nil]
+          end
+
+          def since_last_push?
+            @since_last_push == true
+          end
+
+          private
+
+          def diff_options(opts)
+            opts.separator ""
+            opts.separator "Diff options:"
+
+            opts.on("--since-last-commit", "Run diff against last commit (default)") do |count|
+              @before_rev = "HEAD"
+            end
+            opts.on("-p", "--since-last-push", "Run diff against last pushed commit") do |count|
+              @before_rev = get_pushed_rev
+              @since_last_push = true
+            end
+          end
+
+          # @return [String] the reference for the pushed revision
+          #
+          # @example
+          #   get_pushed_rev # => "origin/master"
+          def get_pushed_rev
+            "#{remote}/#{current_branch}"
+          end
+
+          def current_branch
+            git Dir.pwd, "rev-parse --abbrev-ref HEAD"
+          end
+
+          def remote
+            "origin"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/cli/command/output/diff.rb

@@ -0,0 +1,96 @@
+module Inch
+  module CLI
+    module Command
+      module Output
+        class Diff < Base
+          extend Forwardable
+
+          attr_reader :comparer
+
+          # @param options [Options::Diff]
+          # @param comparer [API::Compare::Codebases]
+          def initialize(options, comparer)
+            @options = options
+            @comparer = comparer
+
+            added    = @comparer.added_objects
+            improved = @comparer.improved_objects
+            degraded = @comparer.degraded_objects
+
+            if added.empty? && improved.empty? && degraded.empty?
+              ui.trace "No changes."
+            else
+              show(added, improved, degraded)
+            end
+          end
+
+          private
+
+          def show(added, improved, degraded)
+            if !(added.empty? && improved.empty?)
+              ui.trace
+              ui.header("Added or improved:", :green)
+              added.each do |compare|
+                puts_added compare.after
+              end
+              improved.each do |compare|
+                puts_improved compare.before, compare.after
+              end
+            end
+
+            if !degraded.empty?
+              ui.trace
+              ui.header("Degraded:", :red)
+              degraded.each do |compare|
+                puts_degraded compare.before, compare.after
+              end
+            end
+            ui.trace
+            ui.trace rev_hint
+            ui.trace
+            ui.trace "Format: grade (before -> after), priority, and name. " \
+                      "Try `--help' for options.".dark
+          end
+
+          def puts_added(o)
+            grade = colored_grade(o)
+            priority = o.priority
+            change = "  +  ".dark + grade + "  " + priority_arrow(o.priority)
+            ui.sub(" #{change}  #{o.fullname}")
+          end
+
+          def puts_improved(before, o)
+            before_grade = colored_grade(before)
+            grade = colored_grade(o)
+            change = before_grade + " -> ".dark + grade + "  " + priority_arrow(o.priority)
+            ui.sub(" #{change}  #{o.fullname}")
+          end
+          alias :puts_degraded :puts_improved
+
+          def colored_grade(o)
+            r = grade_list(o.grade.to_sym)
+            o.grade.to_s.color(r.color)
+          end
+
+          def grade_list(grade_symbol)
+            @grade_lists ||= Evaluation.new_grade_lists
+            @grade_lists.detect { |r| r.grade.to_sym == grade_symbol }
+          end
+
+          def rev_hint
+            if @options.since_last_commit?
+              "Showing changes since your last commit."
+            elsif @options.since_last_push?
+              "Showing changes since you last pushed."
+            else
+              revisions = @options.revisions
+              before_rev = revisions[0]
+              after_rev = revisions[1] || "now"
+              "Showing changes between #{before_rev} and #{after_rev}."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inch/code_object/proxy/base.rb

@@ -24,7 +24,7 @@ module Inch
         # convenient shortcuts to evalution object
         def_delegators :evaluation, :score, :roles, :priority
 
-        def initialize(attributes)
+        def initialize(attributes = {})
           @attributes = attributes
         end
 
@@ -214,6 +214,16 @@ module Inch
           self[:visibility]
         end
 
+        # Used to persist the code object
+        def marshal_dump
+          @attributes
+        end
+
+        # Used to load a persisted code object
+        def marshal_load(attributes)
+          @attributes = attributes
+        end
+
         def inspect
           "#<#{self.class.to_s}: #{fullname}>"
         end

data/lib/inch/codebase.rb

@@ -18,3 +18,5 @@ end
 require_relative 'codebase/proxy'
 require_relative 'codebase/objects'
 require_relative 'codebase/objects_filter'
+require_relative 'codebase/serializer'
+

data/lib/inch/codebase/serializer.rb

@@ -0,0 +1,25 @@
+module Inch
+  module Codebase
+    class Serializer
+      INCH_DB_DIR = File.join(".inch", "db")
+
+      def self.filename(revision)
+        File.join(INCH_DB_DIR, revision)
+      end
+
+      def self.save(codebase, filename)
+        content = Marshal.dump(codebase)
+        FileUtils.mkdir_p( File.dirname(filename) )
+        File.open(filename, 'wb') { |file| file.write(content) }
+      end
+
+      def self.load(filename)
+        codebase = Marshal.load( File.binread(filename) )
+        codebase.objects.each do |object|
+          object.object_lookup = codebase.objects
+        end
+        codebase
+      end
+    end
+  end
+end

data/lib/inch/utils/shell_helper.rb

@@ -0,0 +1,17 @@
+module Inch
+  module Utils
+    module ShellHelper
+      def git(dir, command)
+        old_pwd = Dir.pwd
+        Dir.chdir dir
+        out = sh("git #{command}")
+        Dir.chdir old_pwd
+        out
+      end
+
+      def sh(command)
+        `#{command}`
+      end
+    end
+  end
+end

data/lib/inch/version.rb

@@ -1,3 +1,3 @@
 module Inch
-  VERSION = "0.3.4.rc1"
+  VERSION = "0.4.0.rc1"
 end

data/test/fixtures/diff1/lib/diff1.rb

@@ -0,0 +1,17 @@
+class Foo
+  # A complicated method
+  def b(o, i, *args, &block)
+    # ... snip ...
+  end
+
+  # An example of a method that takes a parameter (+param1+)
+  # and does nothing.
+  #
+  # Returns nil
+  def c(param1)
+  end
+
+  def d
+    "#{self.class}_#{id}.foo"
+  end
+end

data/test/fixtures/diff2/lib/diff2.rb

@@ -0,0 +1,25 @@
+class Foo
+  # New method
+  #
+  # Returns a string.
+  def a
+  end
+
+  # A complicated method
+  #
+  # @param o [String]
+  # @param i [String]
+  # @param args [Array]
+  # @param block [Proc]
+  # @return [void]
+  def b(o, i, *args, &block)
+    # ... snip ...
+  end
+
+  # An example of a method that takes a parameter (+param1+)
+  # and does nothing.
+  #
+  # Returns nil
+  def c(param1)
+  end
+end

data/test/integration/api/compare/codebases.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../../test_helper')
+
+describe ::Inch::API::Compare::Codebases do
+  let(:described_class) { ::Inch::API::Compare::Codebases }
+
+  it "should run" do
+    codebase1 = Inch::Codebase.parse fixture_path(:diff1)
+    codebase2 = Inch::Codebase.parse fixture_path(:diff2)
+
+    compare = described_class.new(codebase1, codebase2)
+    refute compare.comparisons.empty?
+
+    # Foo#a is added in diff2
+    comparison = compare.find("Foo#a")
+    assert comparison.added?
+
+    # Foo#b is improved in diff2
+    comparison = compare.find("Foo#b")
+    assert comparison.present?
+    assert comparison.changed?
+    assert comparison.improved?
+
+    # Foo#c stayed the same
+    comparison = compare.find("Foo#c")
+    assert comparison.present?
+    assert comparison.unchanged?
+    refute comparison.changed?
+
+    # Foo#d is removed in diff2
+    comparison = compare.find("Foo#d")
+    refute comparison.present?
+    assert comparison.removed?
+  end
+end

data/test/unit/code_object/provider/yard_test.rb

@@ -8,4 +8,18 @@ describe ::Inch::CodeObject::Provider::YARD do
     assert !provider.objects.empty?
   end
 
+  it "should parse too different codebases" do
+    fullname = "Foo#b"
+
+    provider1 = described_class.parse(fixture_path(:diff1))
+    object1 = provider1.objects.detect { |o| o.fullname == fullname }
+
+    provider2 = described_class.parse(fixture_path(:diff2))
+    object2 = provider2.objects.detect { |o| o.fullname == fullname }
+
+    refute object1.nil?
+    refute object2.nil?
+    assert object1.object_id != object2.object_id
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inch
 version: !ruby/object:Gem::Version
-  version: 0.3.4.rc1
+  version: 0.4.0.rc1
 platform: ruby
 authors:
 - René Föhring
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -133,6 +133,10 @@ files:
 - inch.gemspec
 - lib/inch.rb
 - lib/inch/api.rb
+- lib/inch/api/compare.rb
+- lib/inch/api/compare/code_objects.rb
+- lib/inch/api/compare/codebases.rb
+- lib/inch/api/diff.rb
 - lib/inch/api/filter.rb
 - lib/inch/api/get.rb
 - lib/inch/api/list.rb
@@ -148,12 +152,14 @@ files:
 - lib/inch/cli/command/base_list.rb
 - lib/inch/cli/command/base_object.rb
 - lib/inch/cli/command/console.rb
+- lib/inch/cli/command/diff.rb
 - lib/inch/cli/command/inspect.rb
 - lib/inch/cli/command/list.rb
 - lib/inch/cli/command/options/base.rb
 - lib/inch/cli/command/options/base_list.rb
 - lib/inch/cli/command/options/base_object.rb
 - lib/inch/cli/command/options/console.rb
+- lib/inch/cli/command/options/diff.rb
 - lib/inch/cli/command/options/inspect.rb
 - lib/inch/cli/command/options/list.rb
 - lib/inch/cli/command/options/show.rb
@@ -161,6 +167,7 @@ files:
 - lib/inch/cli/command/options/suggest.rb
 - lib/inch/cli/command/output/base.rb
 - lib/inch/cli/command/output/console.rb
+- lib/inch/cli/command/output/diff.rb
 - lib/inch/cli/command/output/inspect.rb
 - lib/inch/cli/command/output/list.rb
 - lib/inch/cli/command/output/show.rb
@@ -201,6 +208,7 @@ files:
 - lib/inch/codebase/objects.rb
 - lib/inch/codebase/objects_filter.rb
 - lib/inch/codebase/proxy.rb
+- lib/inch/codebase/serializer.rb
 - lib/inch/config.rb
 - lib/inch/config/base.rb
 - lib/inch/config/codebase.rb
@@ -229,10 +237,13 @@ files:
 - lib/inch/rake.rb
 - lib/inch/rake/suggest.rb
 - lib/inch/utils/read_write_methods.rb
+- lib/inch/utils/shell_helper.rb
 - lib/inch/utils/ui.rb
 - lib/inch/utils/weighted_list.rb
 - lib/inch/version.rb
 - test/fixtures/code_examples/lib/foo.rb
+- test/fixtures/diff1/lib/diff1.rb
+- test/fixtures/diff2/lib/diff2.rb
 - test/fixtures/inch-yml/.inch.yml
 - test/fixtures/inch-yml/foo/bar.rb
 - test/fixtures/inch-yml/foo/vendor/base.rb
@@ -249,6 +260,7 @@ files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
+- test/integration/api/compare/codebases.rb
 - test/integration/cli/command/console_test.rb
 - test/integration/cli/command/inspect_test.rb
 - test/integration/cli/command/list_test.rb
@@ -312,6 +324,8 @@ specification_version: 4
 summary: Documentation measurement tool for Ruby
 test_files:
 - test/fixtures/code_examples/lib/foo.rb
+- test/fixtures/diff1/lib/diff1.rb
+- test/fixtures/diff2/lib/diff2.rb
 - test/fixtures/inch-yml/.inch.yml
 - test/fixtures/inch-yml/foo/bar.rb
 - test/fixtures/inch-yml/foo/vendor/base.rb
@@ -328,6 +342,7 @@ test_files:
 - test/fixtures/visibility/lib/foo.rb
 - test/fixtures/yardopts/.yardopts
 - test/fixtures/yardopts/foo/bar.rb
+- test/integration/api/compare/codebases.rb
 - test/integration/cli/command/console_test.rb
 - test/integration/cli/command/inspect_test.rb
 - test/integration/cli/command/list_test.rb