method_log 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e04ff3b961b6a3955ede7783834922849c7e959
-  data.tar.gz: 36bd0e165bbba5bb13cdabef4110709d80e42921
+  metadata.gz: d5660d61fbe34eb21e9a16dd770b6a3d75626377
+  data.tar.gz: 0927d7ead89d3bc2a39d6fe315898ef2568c0f8f
 SHA512:
-  metadata.gz: 54e9280555d0f24e5fc215351c81a92889b502604e314caad19f6f6a72e891e10dc029e716fbc2100e76737f7f2998540eb95dbcc99d12ec88874e7e80588c87
-  data.tar.gz: ebba91b228114666d7b69ab73eb7a4e089b03eb60b4b00503da92a6c4313fce0e7f101ad14ee4d6cbf94d9152c0407c101cd3abfdcf25101a0f9cc7cfd0ee46f
+  metadata.gz: 0e6fc68bda02985c28fd73977432feb8b5ab81c57732a4612644b42d5951d188a3df3cdf14c38518d0ce3cc1ebebfac7f2035dea433e724d280c8919ec3a7cb3
+  data.tar.gz: 5383fb07797d935f46b71f8685443ac5ac8c44e5e5d630d6c269cd24eec4d5d8308f2b2dffc873c4f891cfa997ed01a37c0e978bd9cc493872c7890ddbf94a67

data/README.md

@@ -1,8 +1,6 @@
 ## Method Log
 
-Trace the history of an individual method in a git repository.
-
-This is a work-in-progress and nowhere near production-ready.
+Trace the history of an individual method in a git repository (experimental).
 
 ### Requirements
 
@@ -17,7 +15,17 @@ This is a work-in-progress and nowhere near production-ready.
 
 ### Run
 
-    method_log <method-signature> # e.g. Foo::Bar#baz
+    $ method_log <options> <method-signature>
+    
+    # options:
+    --patch, -p:                                  Generate patch.
+    --ruby-version, -r <s>:                       Parser Ruby version (18, 19, 20, 21) (default: current)
+    --max-count, -n <i>:                          Limit the number of commits to output.
+    --stop-at-latest-introduction-of-method, -s:  Stop at lastest introduction of method.
+    --help, -h:                                   Show usage.
+    
+    # method-signature
+    Uses the Ruby Index format e.g. Foo#bar, Bar::Baz#foo, Baz.foo.
 
 ### Todo
 

data/lib/method_log/api.rb

@@ -9,6 +9,7 @@ module MethodLog
     end
 
     def history(method_identifier, options = {})
+      options = { stop_at_latest_introduction_of_method: true }.merge(options)
       Enumerator.new do |yielder|
         last_method_commit = nil
         @repository.commits(options).each do |commit|

data/lib/method_log/version.rb

@@ -1,3 +1,3 @@
 module MethodLog
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/spec/api_spec.rb

@@ -49,11 +49,10 @@ module MethodLog
       }))
     end
 
-    it 'finds method which is defined, then removed, and then defined again' do
+    it 'finds significant commits for definition of method' do
       repository = Repository.new(repository_path)
       commit_1 = repository.commit(source(path: 'foo.rb', source: %{
         class Foo
-          def bar; end
         end
       }))
       commit_2 = repository.commit(source(path: 'foo.rb', source: %{
@@ -70,21 +69,72 @@ module MethodLog
           def bar; end
         end
       }))
+      commit_5 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+          def bar
+            # implementation
+          end
+        end
+      }))
 
       method_commits, method_diffs = commits_and_diffs_for('Foo#bar')
 
+      expect(method_commits.map(&:sha)).to eq([commit_5.sha, commit_3.sha])
+    end
+
+    it 'continues past lastest introduction of method if required' do
+      repository = Repository.new(repository_path)
+      commit_1 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+          def bar; end
+        end
+      }))
+      commit_2 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+        end
+      }))
+      commit_3 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+          def bar; end
+        end
+      }))
+
+      method_commits, method_diffs = commits_and_diffs_for('Foo#bar', stop_at_latest_introduction_of_method: false)
+
       expect(method_commits.map(&:sha)).to eq([commit_3.sha, commit_2.sha])
-      expect(method_diffs.map(&:to_s)).to eq([
-        "+  def bar; end\n",
-        "-  def bar; end\n"
-      ])
+    end
+
+    it 'continues past lastest introduction of method if required even if method not defined in latest commit' do
+      repository = Repository.new(repository_path)
+      commit_1 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+          def bar; end
+        end
+      }))
+      commit_2 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+        end
+      }))
+      commit_3 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+          def bar; end
+        end
+      }))
+      commit_4 = repository.commit(source(path: 'foo.rb', source: %{
+        class Foo
+        end
+      }))
+
+      method_commits, method_diffs = commits_and_diffs_for('Foo#bar', stop_at_latest_introduction_of_method: false)
+
+      expect(method_commits.map(&:sha)).to eq([commit_4.sha, commit_3.sha, commit_2.sha])
     end
 
     private
 
-    def commits_and_diffs_for(method_identifier)
+    def commits_and_diffs_for(method_identifier, options = {})
       api = API.new(Repository.new(repository_path))
-      commits_and_diffs = api.diffs(method_identifier)
+      commits_and_diffs = api.diffs(method_identifier, options)
       method_commits = commits_and_diffs.map(&:first)
       method_diffs = commits_and_diffs.map(&:last)
       [method_commits, method_diffs]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: method_log
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - James Mead