stefon 0.0.2 → 0.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWNhNzAwM2UyYWVmNDA5NGE4MTEwZjAyMTYwODFmOGM1MWEwZjFlOQ==
-  data.tar.gz: !binary |-
-    NTJmYzhhZmE5NGQxYjllMmY0ZmQzM2U3OTMzOGM0ZTBjMGQ3MjlkNA==
+SHA1:
+  metadata.gz: 99ed35b6e8b0b48f9ba4059038361a137926a1c3
+  data.tar.gz: 3bcab6111636a36d3fd7436cf4f777f4cfc63de7
 SHA512:
-  metadata.gz: !binary |-
-    NjZmNTgyNzY0ZGZjMjRlYmJiZTA5ODk1ODAxMTk4MTI3ZmVlMWY0N2I1OTAz
-    M2Y2NDg1OTNjNDM3MTM2YjlkZDYzYTgzZWU5NzdmNmRiZjFhOTAxOWJjMjBl
-    MDc0MGY3OTNjN2FmOWNhZWE3ZGM4MzgwZmZhMzM2OThjNTFhNWE=
-  data.tar.gz: !binary |-
-    NGE4MGQ4NWU1ODA2ZTQxOTExNzZhNjIxYTM0MTY3YTI2ODAyNGNiZjQwZDk2
-    ZDY4OWNhYWNkNDJiZDY4NGQ2ZTNkYTBjMWQyNDY0MTc0MTcxZTYxYmExYmUy
-    YTJmZjJlNGZkMzA3YTQ4NmMyMWUxOTE0ZTY3MjRlNTE1NzQxOTA=
+  metadata.gz: 40eca70e12bc892bbcee99cc785d0bb15171216902e3e5d5d62e3eb04f256a8e6eb96c628fd80a1f31dd2322f4bc4a4eb08491be834b85773b314bf05bd60cde
+  data.tar.gz: 43a61da24cd1a4c433eadf84d4a1e4d17fee58527b7a888e6d5cd735fa962164c01c31eea3e443c750f2b02eabda70b75e6edc1b8689f8ed3f1c62dac1affb28

data/README.md

@@ -52,7 +52,7 @@ which is identical to `stefon -f`, to see something like:
 
 
 ## Todos / Comming improvements
-* give identity of predominant author of a file you have deleted
+* use rugged instead of grit for ruby 2 support
 * use Github API to get a list of contributors for a project (and filter suggestions)
 * loading user preferences (list of users to exclude) - maybe with dotfiles instead of yml files
 * handle errors from surveryors

data/bin/stefon

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # encoding: utf-8
 
-if RUBY_VERSION >= '1.9.2' && RUBY_VERSION < '2.0.0'
+if RUBY_VERSION >= '1.9.2'
   $LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
 
   # test for presence of sed dependency
@@ -23,12 +23,12 @@ if RUBY_VERSION >= '1.9.2' && RUBY_VERSION < '2.0.0'
     result = cli.run(opts)
   end
 
-  puts "Finished in #{time} seconds"
-  header = 'Stefon recommends that you ask for a code review from:'
+  puts "Stefon finished in #{time} seconds"
+  header = 'The hottest new people to ask for a code review from are:'
   puts header unless opts[:full_report]
   puts result
   exit(0)
 else
-  puts 'Stefon supports only Ruby versions 1.9.X where X >= 2'
+  puts 'Stefon only supports Ruby versions 1.9.2 and above'
   exit(-1)
 end

data/lib/stefon/cli.rb

@@ -13,6 +13,7 @@ module Stefon
 
   # This module holds custom behavior for dealing with the gem trollop
   module Options
+    # rubocop:disable MethodLength
     def self.get
       proc do
         version "stefon #{Stefon::VERSION} (c) 2014 Ilya Kavalerov"
@@ -20,18 +21,24 @@ module Stefon
           Stefon is a utilty that recommends who to ask for a code review.
           He lets you know whose code you are affecting the most.
 
+          Run Stefon before a commit, maybe as a pre-commit hook.
+
           Usage:
                  stefon [options]
           where [options] are:
         EOS
-
-        opt :limit, 'Limit the number of people that stephon suggests sending ' +
-          'a code review to',
-          default: 4, short: '-l'
-        opt :full_report, "Boolean for whether or not to include information " +
-          "about how you affected someone's code",
-          default: false, short: '-f'
+        opt :limit,
+            'Limit the number of people that stephon suggests ' +
+              'sending a code review to',
+            default: 4,
+            short: '-l'
+        opt :full_report,
+            'Boolean for whether or not to include ' +
+              "information about how you affected someone's code",
+            default: false,
+            short: '-f'
       end
     end
+    # rubocop:enable MethodLength
   end
 end

data/lib/stefon/surveyor/added_files.rb

@@ -18,7 +18,7 @@ module Stefon
       end
 
       def score_added_files
-        if (num_added_files = @@grit.repo.status.added.count) > 0
+        if (num_added_files = @grit.repo.status.added.count) > 0
           @scores[GitUtil.top_commiter] += num_added_files
         end
         @scores

data/lib/stefon/surveyor/added_lines.rb

@@ -21,9 +21,8 @@ module Stefon
       def score_added_lines
         # give credit to the most frequent commiter in the file
         added_lines_by_file.each_pair do |filename, numlines|
-          blame = @@grit.blame_for(filename)
-          top_author = @@grit.file_valid_top_author(blame, filename)
-          # multiplied by the number of lines that are added in the staged commit
+          blame = @grit.blame_for(filename)
+          top_author = @grit.file_valid_top_author(blame, filename)
           @scores[top_author] += numlines
         end
         @scores

data/lib/stefon/surveyor/deleted_files.rb

@@ -11,17 +11,17 @@ module Stefon
 
       def call_verbose
         array_version = score_deleted_files.to_a.map do |pair|
-          desc = "Deleted #{pair.last} #{pair.last == 1 ? 'file' : 'files' } " +
-            "written by: #{pair.first}"
+          desc = "Deleted #{pair.last} #{pair.last == 1 ? 'file' : 'files' }" +
+            " written by: #{pair.first}"
           [pair.first, [desc]]
         end
         Surveyor::SurveyorStore[array_version]
       end
 
       def score_deleted_files
-        @@grit.repo.status.deleted.keys.each do |filename|
-          blame = @@grit.blame_for(filename)
-          top_author = @@grit.file_valid_top_author(blame, filename)
+        @grit.repo.status.deleted.keys.each do |filename|
+          blame = @grit.blame_for(filename)
+          top_author = @grit.file_valid_top_author(blame, filename)
           @scores[top_author] += 1
         end
         @scores

data/lib/stefon/surveyor/deleted_lines.rb

@@ -2,6 +2,7 @@
 
 module Stefon
   module Surveyor
+    # This class gives points to authors of lines that the user deletes
     class DeletedLines < Surveyor::Base
       def call
         score_deleted_lines.weight_scores(@weight)
@@ -9,8 +10,8 @@ module Stefon
 
       def call_verbose
         array_version = score_deleted_lines.to_a.map do |pair|
-          desc = "Deleted #{pair.last} #{pair.last == 1 ? 'line' : 'lines' } " +
-            "written by: #{pair.first}"
+          desc = "Deleted #{pair.last} #{pair.last == 1 ? 'line' : 'lines' }" +
+            " written by: #{pair.first}"
           [pair.first, [desc]]
         end
         Surveyor::SurveyorStore[array_version]
@@ -18,9 +19,9 @@ module Stefon
 
       def score_deleted_lines
         deleted_lines_by_file.each_pair do |filename, lines|
-          blame = @@grit.blame_for(filename)
+          blame = @grit.blame_for(filename)
           lines.each do |deleted_line|
-            valid_author = @@grit.valid_line_author(blame, deleted_line)
+            valid_author = @grit.valid_line_author(blame, deleted_line)
             @scores[valid_author] += 1 if valid_author
           end
         end

data/lib/stefon/surveyor/editor.rb

@@ -8,7 +8,6 @@ module Stefon
     attr_reader :options, :team
     attr_accessor :errors
 
-
     def initialize(options)
       @options = options
       # currently unused

data/lib/stefon/surveyor/git_util.rb

@@ -22,7 +22,7 @@ module Stefon
         # none for all looks at a diff, optionally matches lines starting
         # with mode char, cut off first char of each line
         %x(git diff HEAD~#{GritUtil.new.num_sui_commits} -U0 |
-          #{mode ? "grep ^#{mode} | " : ""} sed 's/^.//'
+          #{mode ? "grep ^#{mode} | " : ''} sed 's/^.//'
         ).split("\n").map(&:strip)
       end
 
@@ -39,7 +39,9 @@ module Stefon
         git_diff_as_array.each_with_index do |e, i|
           line, lines_ahead = e, 1
           # if the line is a filename, we want it to point to its lines
-          while (line[0..1] == filename_marker) && (i + lines_ahead < git_diff_as_array.length) do
+          while (line[0..1] == filename_marker) &&
+            (i + lines_ahead < git_diff_as_array.length)
+
             next_line = git_diff_as_array[i + lines_ahead]
             # next_lines should not be filenames
             break if next_line[0..1] == filename_marker

data/lib/stefon/surveyor/grit_util.rb

@@ -4,27 +4,35 @@ require 'grit'
 
 module Stefon
   module Surveyor
-    # A class that abstracts dealing with the grit gem while respecting/knowing some
-    # restrictions, namely excluding authors
+    # A class that abstracts dealing with the grit gem while
+    # respecting/knowing some restrictions, namely excluding authors
     class GritUtil
-      attr_reader :repo, :num_sui_commits, :last_xenocommit
+      attr_reader :repo
+      # The number of commits by the user (sui ~ self / origin).
+      # This is important to take into account when the user makes multiple
+      # commits when working on someone else's project, to ensure that diffs
+      # do not include recent changes made by the user in her last few commits
+      attr_reader :num_sui_commits
+      # The last commit not made by the user (sui ~ self) but by another
+      # person (xeno ~ not self / not origin).
+      # This is important to take into account when the user makes multiple
+      # commits when working on someone else's project, to ensure that diffs
+      # do not include recent changes made by the user in her last few commits
+      attr_reader :last_xenocommit
 
       include Config::ExcludedAuthors
 
-      # About the attribute names
-      # num_sui_commits is important when a user makes multiple commits when
-      # working on someone else's project, to ensure that diffs do not
-      # include recent changes made by the user, the number of commits by the
-      # user (sui ~ self / origin) should be taken into account when calling
-      # a diff, so as to compare changes against the last commit not made by
-      # the user (self), but by another person (xeno ~ not self / not origin)
+      # sets num_sui_commits and last_xenocommit attributes, if the current
+      # user is the only commiter in the repo, these are set to the most
+      # recent commit, since in this case, stefon would always recommend
+      # the current user anyway. In the future, an error may be raised here
       def initialize
         @repo = Grit::Repo.new('.')
         commits = @repo.commits(GitUtil::CURRENT_BRANCH)
-        # If you are the only commiter _ever_,  then num_sui_commits would be
-        # irrelevant perhaps an error should be raised? Since in this case
-        # only yourself would be recommended
-        @num_sui_commits = commits.find_index { |c| c.author.name != @repo.config['user.name'] } || 0
+        @num_sui_commits = commits.find_index do |commit|
+          commit.author.name != @repo.config['user.name']
+        end
+        @num_sui_commits ||= 0
         @last_xeno_commit = commits[@num_sui_commits]
       end
 
@@ -33,7 +41,7 @@ module Stefon
       end
 
       def valid_line_author(blame, line)
-        matched_line = blame.lines.detect { |l| l.line.strip == line }
+        matched_line = blame.lines.find { |l| l.line.strip == line }
         author = matched_line.commit.author.name if matched_line
         author if valid?(author)
       end

data/lib/stefon/surveyor/surveyor.rb

@@ -34,8 +34,10 @@ module Stefon
       attr_reader :weight
       attr_accessor :scores
 
+      class << self; attr_accessor :grit end
+
       def initialize(weight)
-        @@grit ||= GritUtil.new
+        @grit ||= GritUtil.new
         @scores = SurveyorStore.new
         @weight = weight
       end

data/lib/stefon/version.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 
+# The outermost container for the gem, here with the version info
 module Stefon
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/config_spec.rb

@@ -21,7 +21,7 @@ describe Stefon::Config do
 
   context 'with github enabled' do
     describe 'merging configurations' do
-      it 'ensures github user configuration takes prescedence over user yml config'
+      it 'ensures user github config takes prescedence over user yml config'
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
 require 'stefon'
 require 'pry'
 

data/spec/surveyor/editor_spec.rb

@@ -3,13 +3,15 @@
 require 'spec_helper'
 
 describe 'Editor' do
-  let(:options) {{
-    limit: 4,
-    deleted_line: 2,
-    deleted_file: 4,
-    added_line: 1,
-    added_file: 1
-  }}
+  let(:options) do
+    {
+      limit: 4,
+      deleted_line: 2,
+      deleted_file: 4,
+      added_line: 1,
+      added_file: 1
+    }
+  end
 
   describe 'summarize results (integration)' do
     before(:each) do
@@ -45,8 +47,8 @@ describe 'Editor' do
       options[:full_report] = true
       editor = Stefon::Editor.new(options)
       results = editor.summarize_results
-      results.any? { |line| line == 'Deleted 4 lines by Cy Twombly' }.should be_true
-      results.any? { |line| line == 'Deleted 2 lines by Christian Boltanski' }.should be_true
+      results.should include('Deleted 4 lines by Cy Twombly')
+      results.should include('Deleted 2 lines by Christian Boltanski')
       results.each do |reported_result|
         unless reported_result =~ /The top commiter in this repo is/
           reported_result.should =~ /\d/

data/spec/surveyor/git_util_spec.rb

@@ -4,29 +4,30 @@ require 'spec_helper'
 
 describe Stefon::Surveyor::GitUtil do
   describe '#lines_by_file' do
-    let(:git_diff_as_array) {[
-      "-- a/bin/stefon",
-      "-- a/lib/stefon/surveyor/deleted_lines.rb",
-      "-- a/lib/stefon/surveyor/git_util.rb",
-      "block.call(line, next_line)",
-      "-- a/lib/stefon/surveyor/grit_util.rb",
-      "repo.blame(filename, @last_xenocommit)",
-      "-- a/spec/surveyor/git_util_spec.rb",
-      "describe Stefon::Surveyor::GitUtil do",
-      "describe '#lines_by_file' do",
-      "it 'correctly yields lines belonging to files'",
-      "end"
-    ]}
-    let(:right_structure) {{
-      "lib/stefon/surveyor/git_util.rb" => ["block.call(line, next_line)"],
-      "lib/stefon/surveyor/grit_util.rb" => ["repo.blame(filename, @last_xenocommit)"],
-      "spec/surveyor/git_util_spec.rb" => [
-        "describe Stefon::Surveyor::GitUtil do",
-        "describe '#lines_by_file' do",
-        "it 'correctly yields lines belonging to files'",
-        "end"
+    let(:git_diff_as_array) do
+      [
+        '-- a/bin/stefon',
+        '-- a/lib/stefon/surveyor/deleted_lines.rb',
+        '-- a/lib/stefon/surveyor/git_util.rb',
+        'block.call(line, next_line)',
+        '-- a/spec/surveyor/git_util_spec.rb',
+        'describe Stefon::Surveyor::GitUtil do',
+        'describe "#lines_by_file" do',
+        'it "correctly yields lines belonging to files"',
+        'end'
       ]
-    }}
+    end
+    let(:right_structure) do
+      {
+        'lib/stefon/surveyor/git_util.rb' => ['block.call(line, next_line)'],
+        'spec/surveyor/git_util_spec.rb' => [
+          'describe Stefon::Surveyor::GitUtil do',
+          'describe "#lines_by_file" do',
+          'it "correctly yields lines belonging to files"',
+          'end'
+        ]
+      }
+    end
     let(:save_structure) { Hash.new([]) }
     let(:block) { ->(filename, line) { save_structure[filename] += [line] } }
 

data/stefon.gemspec

@@ -5,26 +5,26 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'stefon/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "stefon"
+  spec.name          = 'stefon'
   spec.version       = Stefon::VERSION
   spec.platform      = Gem::Platform::RUBY
-  spec.authors       = ["Ilya Kavalerov"]
-  spec.email         = ["ilya@artsymail.com"]
+  spec.authors       = ['Ilya Kavalerov']
+  spec.email         = ['ilya@artsymail.com']
   spec.description   = <<-EOF
-    A utility that recommends who to ask for a code review.
+    A pre-commit utility that recommends who to ask for a code review.
     Stefon tells you whose code you are affecting the most.
   EOF
   spec.summary       = %q{A utility that recommends who to ask for a code review}
-  spec.homepage      = "https://github.com/ilyakava/stefon"
-  spec.license       = "MIT"
+  spec.homepage      = 'https://github.com/ilyakava/stefon'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "grit", "2.5.0"
-  spec.add_runtime_dependency "trollop", "~> 2.0"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency 'gitlab-grit', '1.0.0'
+  spec.add_runtime_dependency 'trollop', '~> 2.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency('rake', '~> 10.1')
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: stefon
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ilya Kavalerov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-27 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: grit
+  name: gitlab-grit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -56,18 +56,19 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-description: ! "    A utility that recommends who to ask for a code review.\n    Stefon
-  tells you whose code you are affecting the most.\n"
+        version: '10.1'
+description: |2
+      A pre-commit utility that recommends who to ask for a code review.
+      Stefon tells you whose code you are affecting the most.
 email:
 - ilya@artsymail.com
 executables:
@@ -111,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: A utility that recommends who to ask for a code review