method_log 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8416c62e1edaaecff55eca789a8480abee33ed7e
-  data.tar.gz: e1a5011e4329bf97b0115bdaf95cf56107042b00
+  metadata.gz: e31f34e363bbbac21719ef061d0fa0351a3fb5ea
+  data.tar.gz: 89fdf48679161e222f0ca463e6f4421479f6ba9f
 SHA512:
-  metadata.gz: d221a1bf23774b980ef1b54869e1beca1ec9eac6a98e5fa628235c63e122658ec5f0667beb2ab3536945fd52b0e0d97dd3c59e5288d2f2c0b777d38e3b310a60
-  data.tar.gz: 787efa546b545eb8376f515d58b98d4161a53dc57a22d17157bae60b481d74ee05c44b4014a5f1499c6685a6defa0c9855067b5f2955467abf930ebfbbedf3bf
+  metadata.gz: c4d4a549bc0d49b7ebce947cb1c561a43d4d187e4f19a6065cb214b6fd7dde8199f9db4f627808c254c9fcd4cae8287495b325efb9865b9adf44f79d8527c70c
+  data.tar.gz: 6391d7f9a0670ebc319c4f5a314613352b14a6110c813623247ce407c12ec66a2a6be0f94f11709e5f01721fd9d485614097638cdabfed535eb8386e49492dd5

data/.gitignore

@@ -1 +1,2 @@
 Gemfile.lock
+pkg

data/README.md

@@ -21,14 +21,12 @@ This is a work-in-progress and nowhere near production-ready.
 ### Todo
 
 * Support earlier versions of Ruby (it ought to be possible to support down to v1.9.3 fairly easily)
-* Support absolute namespaces e.g. `class ::Foo::Bar`
 * Support for Rspec tests
 * Default to looking for commits in current git branch
 * Maybe add as new git command or extension to existing command e.g. `git log`
 * Optimise search for method definitions:
   * Only consider commits where file that last contained method has changed
   * First look in file where method was last defined
-  * Simple text search for files containing method name to narrow files that need to be parsed
 * Find "similar" method implementations e.g. by comparing ASTs of implementations
 
 ### Credits

data/bin/method_log

@@ -4,16 +4,24 @@ require 'bundler/setup'
 require 'method_log'
 require 'method_log/repository'
 require 'method_log/api'
+require 'trollop'
+
+options = Trollop::options do
+  opt :patch, 'Generate patch.', short: 'p'
+  opt :max_count, 'Limit the number of commits to output.', type: :integer, short: 'n'
+end
 
 repository = MethodLog::Repository.new(path: Dir.pwd)
 api = MethodLog::API.new(repository: repository)
-api.diffs(ARGV[0]).each do |method_commit, method_diff|
+api.diffs(ARGV[0], max_count: options[:max_count]).each do |method_commit, method_diff|
   puts "commit #{method_commit.sha}"
   puts "Author: #{method_commit.author[:name]} <#{method_commit.author[:email]}>"
   puts "Date:   #{method_commit.author[:time].strftime('%a %b %-e %T %Y %z')}"
   puts
   puts method_commit.message
   puts
-  puts method_diff.to_s(:color)
-  puts
+  if options[:patch]
+    puts method_diff.to_s(:color)
+    puts
+  end
 end

data/lib/method_log/api.rb

@@ -8,10 +8,12 @@ module MethodLog
       @repository = repository
     end
 
-    def history(method_identifier)
+    def history(method_identifier, max_count: nil)
+      method_name = method_identifier.split(Regexp.union('#', '.')).last
       Enumerator.new do |yielder|
-        @repository.commits.each do |commit|
-          method_definitions = commit.source_files.inject([]) do |definitions, source_file|
+        @repository.commits(max_count: max_count).each do |commit|
+          source_files = commit.source_files.select { |sf| sf.source[Regexp.new(method_name)] }
+          method_definitions = source_files.inject([]) do |definitions, source_file|
             method_finder = MethodFinder.new(source_file: source_file)
             definitions += Array(method_finder.find(method_identifier))
           end
@@ -20,10 +22,10 @@ module MethodLog
       end
     end
 
-    def diffs(method_identifier)
+    def diffs(method_identifier, max_count: nil)
       Enumerator.new do |yielder|
-        history(method_identifier).each_cons(2) do |(commit, parent)|
-          diff = MethodDiff.new(commit: commit, parent: parent)
+        history(method_identifier, max_count: max_count).each_cons(2) do |(commit, parent)|
+          diff = MethodDiff.new(first_commit: parent, second_commit: commit)
           unless diff.empty?
             yielder << [commit, diff]
           end

data/lib/method_log/method_diff.rb

@@ -2,12 +2,12 @@ require 'diffy'
 
 module MethodLog
   class MethodDiff
-    def initialize(commit: nil, parent: nil)
-      @commit, @parent = commit, parent
+    def initialize(first_commit: nil, second_commit: nil)
+      @first_commit, @second_commit = first_commit, second_commit
     end
 
     def to_s(mode = :text)
-      Diffy::Diff.new(@commit.method_source, @parent.method_source).to_s(mode)
+      Diffy::Diff.new(@first_commit.method_source, @second_commit.method_source).to_s(mode)
     end
 
     def empty?

data/lib/method_log/method_finder.rb

@@ -60,7 +60,8 @@ module MethodLog
 
     def process_const(node, namespaces = [])
       scope_node, name = *node
-      namespaces.unshift(name)
+      namespace = (node.type == :cbase) ? :root : name
+      namespaces.unshift(namespace)
       if scope_node
         process_const(scope_node, namespaces)
       end

data/lib/method_log/repository.rb

@@ -4,16 +4,9 @@ require 'method_log/commit'
 
 module MethodLog
   class Repository
-    attr_reader :commits
-
     def initialize(path: nil)
       @repository = Rugged::Repository.new(path)
       @commits = []
-      if @repository.ref('refs/heads/master')
-        @repository.walk(@repository.last_commit) do |commit|
-          @commits << build_commit(sha: commit.oid)
-        end
-      end
     end
 
     def build_commit(sha: nil)
@@ -24,5 +17,16 @@ module MethodLog
       commit.apply
       @commits << commit
     end
+
+    def commits(max_count: nil)
+      Enumerator.new do |yielder|
+        if @repository.ref('refs/heads/master')
+          @repository.walk(@repository.last_commit).with_index do |commit, index|
+            break if max_count && index >= max_count - 1
+            yielder << build_commit(sha: commit.oid)
+          end
+        end
+      end
+    end
   end
 end

data/lib/method_log/scope.rb

@@ -18,6 +18,10 @@ module MethodLog
       def names
         []
       end
+
+      def root
+        self
+      end
     end
 
     attr_reader :parent
@@ -31,6 +35,10 @@ module MethodLog
 
     def for(modules)
       scope = self
+      if modules.first == :root
+        scope = root
+        modules.unshift
+      end
       modules.each do |mod|
         scope = scope.lookup(mod) || scope.define(mod)
       end
@@ -53,6 +61,10 @@ module MethodLog
       [names.join('::'), separator, name].join
     end
 
+    def root
+      parent.root
+    end
+
     protected
 
     def names

data/lib/method_log/version.rb

@@ -1,3 +1,3 @@
 module MethodLog
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/method_log.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'rugged'
   s.add_dependency 'parser'
   s.add_dependency 'diffy'
+  s.add_dependency 'trollop'
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'

data/spec/api_spec.rb

@@ -62,8 +62,8 @@ end
     method_commit, method_diff = api.diffs('Foo#bar').first
     expect(method_diff.to_s.strip).to eq(%{
    def bar
--    # implementation 2
-+    # implementation 1
+-    # implementation 1
++    # implementation 2
    end
     }.strip)
   end

data/spec/method_diff_spec.rb

@@ -1,13 +1,13 @@
 require 'method_log/method_diff'
 
 describe MethodLog::MethodDiff do
-  let(:commit) { double(:commit) }
-  let(:parent) { double(:parent) }
-  let(:diff) { MethodLog::MethodDiff.new(commit: commit, parent: parent) }
+  let(:first_commit) { double(:first_commit) }
+  let(:second_commit) { double(:second_commit) }
+  let(:diff) { MethodLog::MethodDiff.new(first_commit: first_commit, second_commit: second_commit) }
 
   it 'generates text diff of the method source for two commits' do
-    commit.stub(:method_source).and_return(%{line 1\nline 2\n})
-    parent.stub(:method_source).and_return(%{line 2\nline 3\n})
+    first_commit.stub(:method_source).and_return(%{line 1\nline 2\n})
+    second_commit.stub(:method_source).and_return(%{line 2\nline 3\n})
     expect(diff.to_s).to eq(%{-line 1\n line 2\n+line 3\n})
   end
 end

data/spec/method_finder_spec.rb

@@ -225,4 +225,27 @@ end
 
     expect(method_definition).to eq(MethodLog::MethodDefinition.new(source_file: foo, lines: 4..6))
   end
+
+  it 'finds definition of class method on ambiguous module referenced via top-level module' do
+    foo = MethodLog::SourceFile.new(path: 'foo.rb', source: %{
+module Foo
+  class Bar; end
+end
+
+module Baz
+  module Foo
+    class Bar; end
+  end
+
+  def (::Foo::Bar).foo
+    # implementation
+  end
+end
+    }.strip)
+
+    method_finder = MethodLog::MethodFinder.new(source_file: foo)
+    method_definition = method_finder.find('Foo::Bar.foo')
+
+    expect(method_definition).to eq(MethodLog::MethodDefinition.new(source_file: foo, lines: 9..11))
+  end
 end

data/spec/scope_spec.rb

@@ -75,5 +75,22 @@ describe MethodLog::Scope do
     expect(b).not_to be_nil
     expect(c).not_to be_nil
   end
+
+  it 'returns root scope' do
+    a = root.define(:A)
+    b = a.define(:B)
+    c = b.define(:C)
+    expect(c.root).to eq(root)
+  end
+
+  it 'looks up ambiguous module via top-level module' do
+    a = root.define(:A)
+    b = a.define(:B)
+    c = root.define(:C)
+    aa = c.define(:A)
+    bb = aa.define(:B)
+
+    expect(c.for([:root, :A, :B])).to eq(b)
+  end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_log
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - James Mead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-21 00:00:00.000000000 Z
+date: 2014-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement