method_log 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e31f34e363bbbac21719ef061d0fa0351a3fb5ea
-  data.tar.gz: 89fdf48679161e222f0ca463e6f4421479f6ba9f
+  metadata.gz: 41e9aab264b13fe45d2a9647bf235cea14ea5378
+  data.tar.gz: 15fd978c654b949dc848f1c91057d6a104f008b8
 SHA512:
-  metadata.gz: c4d4a549bc0d49b7ebce947cb1c561a43d4d187e4f19a6065cb214b6fd7dde8199f9db4f627808c254c9fcd4cae8287495b325efb9865b9adf44f79d8527c70c
-  data.tar.gz: 6391d7f9a0670ebc319c4f5a314613352b14a6110c813623247ce407c12ec66a2a6be0f94f11709e5f01721fd9d485614097638cdabfed535eb8386e49492dd5
+  metadata.gz: 6d077e6eb40d283f0f490e0420a2650f29a6eb8382e38ab36c6ab8551c6fe88fccc6f087d6eed70851ee4749f88e5c6fdb1889c98380076a02ba568daf0d05f8
+  data.tar.gz: 7dd0f4d2191b7e83b9d9b483f1452c0cde6af6f0cd5ee8e30e0395d2a88fa623a1c25c48f819a2077031657fff3bdd21bb7825983e82b4fa9343d69f13c1c83f

data/README.md

@@ -21,12 +21,14 @@ 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)
+* Investigate whether parser gem can only parse source code written using the current Ruby version
+  * It would be nice to have a better error message if parsing fails
 * 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
+* By default stop when method disappears from history
 * Find "similar" method implementations e.g. by comparing ASTs of implementations
 
 ### Credits

data/lib/method_log/api.rb

@@ -11,13 +11,16 @@ module MethodLog
     def history(method_identifier, max_count: nil)
       method_name = method_identifier.split(Regexp.union('#', '.')).last
       Enumerator.new do |yielder|
+        last_source_file = nil
         @repository.commits(max_count: max_count).each do |commit|
+          next if last_source_file && commit.contains?(last_source_file)
           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))
+          method_definition = nil
+          source_files.map { |sf| MethodFinder.new(source_file: sf) }.each do |method_finder|
+            break if method_definition = method_finder.find(method_identifier)
           end
-          yielder << MethodCommit.new(commit: commit, method_definition: method_definitions.first)
+          last_source_file = method_definition && method_definition.source_file
+          yielder << MethodCommit.new(commit: commit, method_definition: method_definition)
         end
       end
     end

data/lib/method_log/commit.rb

@@ -24,15 +24,18 @@ module MethodLog
     end
 
     def source_files
-      source_files = []
-      commit.tree.walk_blobs do |root, blob_hash|
-        name = blob_hash[:name]
-        next unless File.extname(name) == '.rb'
-        path = root.empty? ? name : File.join(root, name)
-        source = @repository.lookup(blob_hash[:oid]).text
-        source_files << SourceFile.new(path: path, source: source)
+      @source_files ||= Enumerator.new do |yielder|
+        commit.tree.walk_blobs do |root, blob_hash|
+          name = blob_hash[:name]
+          next unless File.extname(name) == '.rb'
+          path = root.empty? ? name : File.join(root, name)
+          yielder << SourceFile.new(path: path, repository: @repository, sha: blob_hash[:oid])
+        end
       end
-      source_files
+    end
+
+    def contains?(source_file)
+      source_files_by_path[source_file.path] == source_file
     end
 
     def author
@@ -60,5 +63,12 @@ module MethodLog
     def commit
       @commit ||= @repository.lookup(sha)
     end
+
+    def source_files_by_path
+      source_files.inject({}) do |hash, source_file|
+        hash[source_file.path] = source_file
+        hash
+      end
+    end
   end
 end

data/lib/method_log/method_definition.rb

@@ -1,5 +1,7 @@
 module MethodLog
   class MethodDefinition
+    attr_reader :source_file
+
     def initialize(source_file: nil, lines: nil)
       @source_file = source_file
       @lines = lines
@@ -19,7 +21,6 @@ module MethodLog
 
     protected
 
-    attr_reader :source_file
     attr_reader :lines
   end
 end

data/lib/method_log/source_file.rb

@@ -1,11 +1,17 @@
 module MethodLog
   class SourceFile
     attr_reader :path
-    attr_reader :source
+    attr_reader :sha
 
-    def initialize(path: nil, source: nil)
+    def initialize(path: nil, source: nil, repository: nil, sha: nil)
       @path = path
       @source = source
+      @repository = repository
+      @sha = sha
+    end
+
+    def source
+      @source ||= @repository.lookup(@sha).text
     end
 
     def ==(other)
@@ -13,7 +19,7 @@ module MethodLog
     end
 
     def hash
-      [path, source].hash
+      @sha || [path, source].hash
     end
 
     def snippet(range)

data/lib/method_log/version.rb

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

data/spec/api_spec.rb

@@ -67,4 +67,39 @@ end
    end
     }.strip)
   end
+
+  it 'finds method which is defined in one commit, then removed in the next commit, and defined again in the next commit' do
+    foo_with_bar = MethodLog::SourceFile.new(path: 'foo.rb', source: %{
+class Foo
+  def bar; end
+end
+    }.strip)
+
+    foo_without_bar = MethodLog::SourceFile.new(path: 'foo.rb', source: %{
+class Foo
+end
+    }.strip)
+
+    repository = MethodLog::Repository.new(path: repository_path)
+
+    commit_1 = repository.build_commit
+    commit_1.add(foo_with_bar)
+    repository.add(commit_1)
+
+    commit_2 = repository.build_commit
+    commit_2.add(foo_without_bar)
+    repository.add(commit_2)
+
+    commit_3 = repository.build_commit
+    commit_3.add(foo_with_bar)
+    repository.add(commit_3)
+
+    repository = MethodLog::Repository.new(path: repository_path)
+    api = MethodLog::API.new(repository: repository)
+    diffs = api.diffs('Foo#bar').map(&:last).map(&:to_s)
+    expect(diffs).to eq([
+      "+  def bar; end\n",
+      "-  def bar; end\n"
+    ])
+  end
 end

data/spec/commit_spec.rb

@@ -39,7 +39,7 @@ describe MethodLog::Commit do
 
       repository = MethodLog::Repository.new(path: repository_path)
       commit = repository.commits.first
-      expect(commit.source_files).to eq([source_one, source_two])
+      expect(commit.source_files.to_a).to eq([source_one, source_two])
     end
 
     it 'only includes source files with ruby file extension' do
@@ -52,7 +52,21 @@ describe MethodLog::Commit do
 
       repository = MethodLog::Repository.new(path: repository_path)
       commit = repository.commits.first
-      expect(commit.source_files).to be_empty
+      expect(commit.source_files.to_a).to be_empty
+    end
+
+    it 'indicates whether it contains a given source file' do
+      source_file = MethodLog::SourceFile.new(path: 'path/to/source.rb', source: 'source-file')
+
+      repository = MethodLog::Repository.new(path: repository_path)
+      commit = repository.build_commit
+      commit.add(source_file)
+      commit.apply
+      source_file = commit.source_files.first
+
+      repository = MethodLog::Repository.new(path: repository_path)
+      commit = repository.commits.first
+      expect(commit.contains?(source_file)).to be_true
     end
 
     it 'makes author available' do

data/spec/source_file_spec.rb

@@ -3,6 +3,10 @@ require 'spec_helper'
 require 'method_log/source_file'
 
 describe MethodLog::SourceFile do
+  let(:sha) { 'b54d38bbd989f4b54c38fd77767d89d1' }
+  let(:repository) { double(:repository) }
+  let(:blob) { double(:blob, text: 'source') }
+
   it 'is equal to another source file with same path and source' do
     file_one = MethodLog::SourceFile.new(path: 'path/to/source.rb', source: 'source-one')
     file_two = MethodLog::SourceFile.new(path: 'path/to/source.rb', source: 'source-one')
@@ -32,4 +36,10 @@ end
   end
     }.strip)
   end
+
+  it 'looks up source in repository using SHA if no source set' do
+    repository.stub(:lookup).with(sha).and_return(blob)
+    file = MethodLog::SourceFile.new(path: 'path/to/source.rb', repository: repository, sha: sha)
+    expect(file.source).to eq('source')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_log
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - James Mead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged