method_log 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c433833678edcb6c769cc4af052d1f76789d0b1a
-  data.tar.gz: 5ca47df97661e48f31f5b109964bcf8fa4ba81cd
+SHA256:
+  metadata.gz: 125db342c6c8ad4ba938d3fac7cee3fc7dfe7330a53b4c882d051570d851791b
+  data.tar.gz: 817b5da57430c8703b8d7b00adba2de76714d03cd588ff36bdec79837615f978
 SHA512:
-  metadata.gz: b649b279915c749afd19cae699e2b1d2d93573994f52caf0c296a786b03560e4694bc73b58746ff4dada2dd379437fcea22995d300bd5dd65f4ac005591be4ba
-  data.tar.gz: 1136f3efdf3218496c00cd17e44365cdadd81add70fcbeccef303d6e40028c286e0a51f4e53a12b1d08899d0648dbc14a0f6303f1a8d7c3ed33cef577374906b
+  metadata.gz: edc71468238c1f9dc27f6698a8726a4c9768d6706091788b68f0dc2dd1e257a59e3b76a9f82713bde8403b3416cea7ba226450436c5921019699f1ec65995163
+  data.tar.gz: 82777e60269dd12aabed2842386603a89f627f5f87666c20f06680d7eade642d49afc4b491537817a3c93c4b5358c0a2eff1eae4e96037efd986f2a23fee7605

data/.travis.yml

@@ -1,6 +1,9 @@
 language: ruby
 rvm:
-  - 2.1.0
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - 2.3.8
+  - 2.2.10
+  - 2.1.10
   - 2.0.0
-  - 1.9.3
-

data/README.md

@@ -4,7 +4,7 @@ Trace the history of an individual method in a git repository (experimental).
 
 ### Requirements
 
-* Ruby >= v1.9.3 (due to requirements of the `rugged` gem)
+* Ruby >= v2.0.0 (due to requirements of the `parser` gem); although parsing of source code for Ruby >= v1.8 is possible
 * The [rugged](https://github.com/libgit2/rugged) Ruby gem (listed as dependency in gemspec)
 * The [libgit2](https://github.com/libgit2/libgit2) C library (included as part of rugged gem)
 * The [parser](https://github.com/whitequark/parser) Ruby gem (listed as dependency in gemspec)
@@ -15,21 +15,17 @@ Trace the history of an individual method in a git repository (experimental).
 
 ### Run
 
-    $ 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
-
-* Support for Rspec tests
+#### Display the commit history for a single method
+
+    $ method_log [options] <method-signature>
+
+#### Build a parallel git repository of method definitions
+
+    $ build_methods_repo [options] <source-repo-path> <target-repo-path>
+
+### To Do
+
+* Parsing support for RSpec tests
 * Default to looking for commits in current git branch
 * Check what happens with merge commits
 * Maybe add as new git command or extension to existing command e.g. `git log`

data/bin/build_methods_repo

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+
+require 'method_log'
+require 'optimist'
+
+options = Optimist::options do
+  version MethodLog::VERSION
+  banner <<-EOS
+Build a parallel git repository of method definitions.
+
+Usage:
+       build_methods_repo [options] <source-repo-path> <target-repo-path>
+
+source-repo-path: the path to the source repository from which to read
+target-repo-path: the path to the target repository to which to write
+
+[options] are:
+EOS
+  opt :ruby_version, 'Parser Ruby version (e.g. 2.5)', default: 'current'
+  opt :excluded_directories, 'Directories in source repository to exclude from analysis', type: :strings, default: []
+end
+
+Optimist.die 'No source path specified' if ARGV[0].nil?
+source_path = ARGV[0]
+Optimist.die 'Source repository does not exist' unless Dir.exist?(source_path)
+
+Optimist.die 'No target path specified' if ARGV[1].nil?
+target_path = ARGV[1]
+Optimist.die 'Target repository already exists' if Dir.exist?(target_path)
+
+case ruby_version = options[:ruby_version]
+when 'current'
+  require 'parser/current'
+when /^(\d)\.(\d)$/
+  begin
+    require "parser/ruby#{$1}#{$2}"
+    Parser::CurrentRuby = Parser.const_get("Ruby#{$1}#{$2}")
+  rescue LoadError
+    Optimist.die "Ruby version not supported: #{ruby_version}"
+  end
+else
+  Optimist.die "Ruby version not supported: #{ruby_version}"
+end
+
+require 'method_log/repository'
+require 'method_log/method_finder'
+require 'method_log/source_file'
+
+def unindent(code)
+  lines = code.split($/)
+  indent = lines.reject { |l| l.strip.length == 0 }.map { |l| l[/^ */].length }.min
+  lines.map { |l| l.sub(Regexp.new(' ' * indent), '') }.join($/)
+end
+
+new_repository_path = File.expand_path(target_path)
+Rugged::Repository.init_at(new_repository_path, :bare)
+new_repository = MethodLog::Repository.new(new_repository_path)
+
+repository_path = File.expand_path(source_path)
+repository = MethodLog::Repository.new(repository_path)
+repository.commits(sorting: Rugged::SORT_TOPO | Rugged::SORT_REVERSE).each do |commit|
+  puts commit.to_s
+  new_commit = new_repository.build_commit
+  commit.source_files.each do |source_file|
+    next if options[:excluded_directories].any? { |d| source_file.path.start_with?(d) }
+    begin
+      method_finder = MethodLog::MethodFinder.new(source_file)
+      method_finder.methods.each do |method_signature, method_definition|
+        _, namespace, name = method_signature.match(/^(.*)([#.].*)$/).to_a
+        path = namespace.split('::').push(name).join(File::SEPARATOR) + '.rb'
+        method_source = unindent(method_definition.source) + $/
+        method_source_file = MethodLog::SourceFile.new(path: path, source: method_source)
+        new_commit.add(method_source_file)
+      end
+    rescue Parser::SyntaxError => e
+      p e
+    end
+  end
+  new_commit.apply(user: commit.author, message: commit.message)
+end

data/bin/method_log

@@ -1,40 +1,51 @@
 #!/usr/bin/env ruby
 
 require 'method_log'
-require 'trollop'
+require 'optimist'
 
-options = Trollop::options do
-  opt :patch, 'Generate patch.', short: 'p'
-  opt :ruby_version, 'Parser Ruby version (18, 19, 20, 21)', default: 'current'
+options = Optimist::options do
+  version MethodLog::VERSION
+  banner <<-EOS
+Display the commit history for a single method.
+
+Usage:
+       method_log [options] <method-signature>
+
+where <method-signature> is in the Ruby Index format e.g. Foo#bar, Bar::Baz#foo, Baz.foo.
+
+and [options] are:
+EOS
+  opt :patch, 'Generate patch.'
+  opt :ruby_version, 'Parser Ruby version (e.g. 2.5)', default: 'current'
   opt :max_count, 'Limit the number of commits to output.', type: :integer, short: 'n'
   opt :stop_at_latest_introduction_of_method, 'Stop at lastest introduction of method.', default: true
+  opt :repository_path, 'Path to repository', default: Dir.pwd
 end
 
+Optimist.die 'No method signature specified' if ARGV.empty?
+method_signature = ARGV[0]
+
 case ruby_version = options[:ruby_version]
 when 'current'
   require 'parser/current'
-when '18', '19', '20', '21'
-  require 'parser/ruby18'
-  require 'parser/ruby19'
-  require 'parser/ruby20'
-  require 'parser/ruby21'
-  Parser::CurrentRuby = Parser.const_get("Ruby#{ruby_version}")
+when /^(\d)\.(\d)$/
+  begin
+    require "parser/ruby#{$1}#{$2}"
+    Parser::CurrentRuby = Parser.const_get("Ruby#{$1}#{$2}")
+  rescue LoadError
+    Optimist.die "Ruby version not supported: #{ruby_version}"
+  end
 else
-  raise "Ruby version not supported: #{ruby_version}"
+  Optimist.die "Ruby version not supported: #{ruby_version}"
 end
 
-require 'method_log'
 require 'method_log/repository'
 require 'method_log/api'
 
-repository = MethodLog::Repository.new(Dir.pwd)
+repository = MethodLog::Repository.new(options[:repository_path])
 api = MethodLog::API.new(repository)
-api.diffs(ARGV[0], options).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
+api.diffs(method_signature, options).each do |method_commit, method_diff|
+  puts method_commit.to_s
   puts
   if options[:patch]
     puts method_diff.to_s(:color)

data/lib/method_log/method_commit.rb

@@ -39,6 +39,16 @@ module MethodLog
       method_definition && method_definition.source_file
     end
 
+    def to_s
+      [
+        "commit #{sha}",
+        "Author: #{author[:name]} <#{author[:email]}>",
+        "Date:   #{author[:time].strftime('%a %b %-e %T %Y %z')}",
+        '',
+        message
+      ].join($/)
+    end
+
     protected
 
     attr_reader :commit

data/lib/method_log/method_finder.rb

@@ -7,6 +7,8 @@ require 'method_log/scope'
 
 module MethodLog
   class MethodFinder < Parser::AST::Processor
+    attr_reader :methods
+
     def initialize(source_file)
       @source_file = source_file
       @scope = Scope::Root.new

data/lib/method_log/repository.rb

@@ -25,9 +25,10 @@ module MethodLog
     end
 
     def commits(options = {})
+      options[:sorting] ||= Rugged::SORT_TOPO
       Enumerator.new do |yielder|
         if @repository.ref('refs/heads/master')
-          @repository.walk(@repository.last_commit).with_index do |commit, index|
+          @repository.walk(@repository.last_commit, options[:sorting]).with_index do |commit, index|
             break if options[:max_count] && index >= options[:max_count] - 1
             yielder << build_commit(commit.oid)
           end
@@ -35,4 +36,4 @@ module MethodLog
       end
     end
   end
-end
+end

data/lib/method_log/version.rb

@@ -1,3 +1,3 @@
 module MethodLog
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/method_log.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.0.0'
 
   s.add_dependency 'rugged'
-  s.add_dependency 'parser'
+  s.add_dependency 'parser', '~> 2.5'
   s.add_dependency 'diffy'
-  s.add_dependency 'trollop'
+  s.add_dependency 'optimist'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 3.0'
 end

data/spec/api_spec.rb

@@ -140,4 +140,4 @@ module MethodLog
       [method_commits, method_diffs]
     end
   end
-end
+end

data/spec/commit_spec.rb

@@ -66,8 +66,8 @@ module MethodLog
         repository = Repository.new(repository_path)
         commit = repository.commits.to_a.last
 
-        expect(commit.contains?(source_file)).to be_true
-        expect(commit.contains?(another_source_file)).to be_false
+        expect(commit.contains?(source_file)).to be true
+        expect(commit.contains?(another_source_file)).to be false
       end
 
       it 'makes author available' do

data/spec/method_diff_spec.rb

@@ -9,8 +9,8 @@ module MethodLog
     let(:diff) { MethodDiff.new(first_commit, second_commit) }
 
     it 'generates text diff of the method source for two commits' do
-      first_commit.stub(:method_source).and_return(%{line 1\nline 2\n})
-      second_commit.stub(:method_source).and_return(%{line 2\nline 3\n})
+      allow(first_commit).to receive(:method_source).and_return(%{line 1\nline 2\n})
+      allow(second_commit).to receive(: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

@@ -218,7 +218,7 @@ module MethodLog
       })
 
       method_finder = MethodFinder.new(foo)
-      method_definition = method_finder.find('Foo::(ivar :@foo).bar')
+      method_definition = method_finder.find('Foo::s(:ivar, :@foo).bar')
 
       expect(method_definition).to eq(MethodDefinition.new(foo, 4..6))
     end

data/spec/source_file_spec.rb

@@ -39,7 +39,7 @@ module MethodLog
     end
 
     it 'looks up source in repository using SHA if no source set' do
-      repository.stub(:lookup).with(sha).and_return(blob)
+      allow(repository).to receive(:lookup).with(sha).and_return(blob)
       file = source(path: 'path/to/source.rb', repository: repository, sha: sha)
       expect(file.source).to eq('source')
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_log
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - James Mead
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2019-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -28,16 +28,16 @@ dependencies:
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: diffy
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: trollop
+  name: optimist
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -84,20 +84,21 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 description: 
 email:
 - james@floehopper.org
 executables:
+- build_methods_repo
 - method_log
 extensions: []
 extra_rdoc_files: []
@@ -108,6 +109,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/build_methods_repo
 - bin/method_log
 - lib/method_log.rb
 - lib/method_log/api.rb
@@ -154,15 +156,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Trace the history of an individual method in a git repository.