pendaxes 0.0.1

data/lib/pendaxes/reporters/template.haml

@@ -0,0 +1,45 @@
+!!! 5
+%html
+  %head
+    %meta{charset: 'UTF-8'}
+    %title Pendaxes report - #{pendings.size} pendings are waiting to be fixed
+  %body
+    .container{style: 'font-family: sans-serif; color: #3C3C3C;'}
+      %h1 #{pendings.size} pendings are waiting to be fixed
+      - if config.report_url
+        %p
+          %strong Full Report:
+          %a{href: config.report_url}&= config.report_url
+      = config.message || ""
+      %h2 Pendings
+      - pendings.sort_by {|x| (Time.now - x[:commit][:at]) * (config.older_first ? -1 : 1) }.each do |pending|
+        %section
+          - if config.gravatar
+            .avatar{style: "float: left; width: 60px; margin-right: 12px;"}
+              %img{src: "http://www.gravatar.com/avatar/#{Digest::MD5.hexdigest(pending[:commit][:email])}.png?s=120", width: 60, height: 60}
+          .right{style: "float: left; width: 80%;"}
+            %header{style: "width: 100%; background-color: #e9e7e6; border-radius: 5px; margin-top: 0px; margin-bottom: 10px; padding-top: 5px; padding-bottom: 5px; padding-left: 10px;"}
+              %h3{style: "font-size: 1.8em; margin-top: 0px; margin-bottom: 15px;"}&= pending[:example][:message]
+              .at
+                by #{pending[:commit][:name]},
+                %span.relative{style: pending[:allowed] ? '' : 'font-weight: bold;'}&= relative_time(pending[:commit][:at])
+                = " - "
+                %time&= pending[:commit][:at]
+            .parent
+              %strong In:
+              %span.monospace{style: "font-family: 'Inconsolata', 'Monaco', monospace;", style: "font-family: 'Inconsolata', 'Monaco', monospace;"}&= pending[:example][:parent]
+            .file
+              %strong File:
+              - if config.file_url
+                %a.monospace{href: config.file_url.gsub(/%file%/, pending[:example][:file]).gsub(/%line%/, pending[:example][:line].to_s), style: "font-family: 'Inconsolata', 'Monaco', monospace;"}&= "#{pending[:example][:file]}:#{pending[:example][:line]}"
+              - else
+                %span.monospace{style: "font-family: 'Inconsolata', 'Monaco', monospace;"}&= "#{pending[:example][:file]}:#{pending[:example][:line]}"
+            .commit
+              %strong Commit:
+              - if config.commit_url
+                %a.monospace{href: config.commit_url.gsub(/%commit%/, pending[:commit][:sha])}&= pending[:commit][:sha]
+              - else
+                %span.monospace{style: "font-family: 'Inconsolata', 'Monaco', monospace;"}&= pending[:commit][:sha]
+              &= " by #{pending[:commit][:name]}"
+        .clear{style: "clear: both; height: 28px;"}
+

data/lib/pendaxes/reporters/text.rb

@@ -0,0 +1,13 @@
+require_relative '../reporter'
+
+module Pendaxes
+  class Reporter
+    class Text < Reporter
+      def report
+        pendings.sort_by{|x| x[:commit][:at] - Time.now }.map {|pending|
+          "* #{pending[:example][:file]}:#{pending[:example][:line]} - #{pending[:example][:message]} (@ #{pending[:commit][:sha]} #{pending[:commit][:at]})"
+        }.join("\n")
+      end
+    end
+  end
+end

data/lib/pendaxes/version.rb

@@ -0,0 +1,3 @@
+module Pendaxes
+  VERSION = "0.0.1"
+end

data/lib/pendaxes/workspace.rb

@@ -0,0 +1,39 @@
+require_relative 'defaults'
+require 'hashr'
+
+module Pendaxes
+  class Workspace
+    extend Defaults
+
+    def initialize(config={})
+      @config = Hashr.new(self.class.defaults.merge(config))
+    end
+
+    def clone
+      FileUtils.remove_entry_secure(path) if File.exist?(path)
+      git "clone", @config.repository, path
+    end
+
+    def update
+      clone unless File.exist?(path)
+
+      dive do
+        git "fetch", "origin"
+        git "reset", "--hard", @config.branch || "FETCH_HEAD"
+      end
+    end
+
+    def path; @config.path; end
+
+    def dive
+      Dir.chdir(path) do
+        yield
+      end
+    end
+
+    def git(*args)
+      str = IO.popen([@config.git || "git", *args], 'r', &:read)
+      $?.success? ? str : nil
+    end
+  end
+end

data/lib/pendaxes.rb

@@ -0,0 +1,10 @@
+require "pendaxes/version"
+require "pendaxes/command_line"
+
+module Pendaxes
+  class << self
+    def run(*args)
+      CommandLine.new(*args).run
+    end
+  end
+end

data/pendaxes.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pendaxes/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "pendaxes"
+  gem.version       = Pendaxes::VERSION
+  gem.authors       = ["Shota Fukumori (sora_h)"]
+  gem.email         = ["sorah@cookpad.com"]
+  gem.description   = %q{Throw axes to pending makers!}
+  gem.summary       = <<-EOS
+Throw axes to pending makers! Leaving a pending long time is really bad,
+shouldn't be happened.
+So, this gem sends notification to committer that added pending after a while from the commit.
+
+Avoid the trouble due to pending examples :D
+  EOS
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features|fixtures)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'hashr'
+  gem.add_dependency 'haml'
+  gem.add_dependency 'mail'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'simplecov'
+end

data/spec/defaults_spec.rb

@@ -0,0 +1,41 @@
+require_relative './spec_helper'
+require 'pendaxes/defaults'
+
+describe Pendaxes::Defaults do
+  subject { Class.new { extend Pendaxes::Defaults } }
+
+  describe "#defaults" do
+    context "with no argument" do
+      it "returns current defaults" do
+        subject.defaults.should == {}
+      end
+    end
+
+    context "with argument" do
+      it "sets defaults"  do
+        subject.defaults :a => :b
+        subject.defaults.should == {:a => :b}
+      end
+    end
+
+    context "with superclass" do
+      let(:superclass) { Class.new { extend Pendaxes::Defaults }.tap{|klass| klass.defaults :a => :b } }
+      subject { Class.new(superclass) { extend Pendaxes::Defaults } }
+
+      context "without argument (first time)" do
+        it "returns superclass' default" do
+          subject.defaults.should == {:a => :b}
+        end
+      end
+
+      context "with argument" do
+        it "merges into superclass' defaults" do
+          subject.defaults :b => :c
+          subject.defaults.should == {:a => :b, :b => :c}
+          subject.defaults :b => :d
+          subject.defaults.should == {:a => :b, :b => :d}
+        end
+      end
+    end
+  end
+end

data/spec/detector_spec.rb

@@ -0,0 +1,12 @@
+require_relative './spec_helper'
+require 'pendaxes/detector'
+
+describe Pendaxes::Detector do
+  it "has included Defaults" do
+    described_class.singleton_class.included_modules.include?(Pendaxes::Defaults).should be_true
+  end
+
+  it "responds to #detect" do
+    described_class.new(Pendaxes::Workspace.new).should be_respond_to(:detect)
+  end
+end

data/spec/detectors/rspec_spec.rb

@@ -0,0 +1,75 @@
+require_relative '../spec_helper'
+require 'pendaxes/detectors/rspec'
+require 'pendaxes/workspace'
+require 'time'
+
+describe Pendaxes::Detector::RSpec do
+  it "has Pendaxes::Detector as superclass" do
+    described_class.superclass.should == Pendaxes::Detector
+  end
+
+  describe "#detect" do
+    before do
+      Time.stub(now: Time.at(1348214400))
+    end
+
+    let(:repository) { File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'fixtures', 'repo')) }
+    let(:workspace) { Pendaxes::Workspace.new(repository: repository, path: repository) }
+    let(:config) { {} }
+    subject { described_class.new(workspace, config) }
+
+    it "detects pendings in all files" do
+      pendings = subject.detect
+      pendings.size.should == 3
+
+      xit = pendings.find {|pend| /xit/ === pend[:example][:message] }
+      it_a = pendings.find {|pend| /pending$/ === pend[:example][:message] && pend[:example][:file] == "spec/a_spec.rb" }
+      it_c = pendings.find {|pend| pend[:example][:file] == "spec/b/c_spec.rb" }
+      # require 'pp'; pp pendings
+
+      xit.should == {
+        example: {file: "spec/a_spec.rb", line: 9,
+                  message: 'xit "d" do', parent: 'context "c" do'},
+        commit:  {sha: '371955e233bf1ff42d0c7cca3510ec0f8d71ec8d',
+                  name: 'Shota Fukumori', email: 'sorah@cookpad.com',
+                  at: Time.parse('2012-09-21 16:44:13 +0900')},
+        allowed: true
+      }
+      it_a.should == {
+        example: {file: "spec/a_spec.rb", line: 4,
+                  message: 'pending', parent: 'it "a" do'},
+        commit:  {sha: '642caa033642700cd9d4c6f026fe73282985ed50',
+                  name: 'Shota Fukumori', email: 'sorah@cookpad.com',
+                  at: Time.parse('Thu, 7 Apr 2005 22:13:13 +0900')},
+        allowed: false
+      }
+      it_c.should == {
+        example: {file: "spec/b/c_spec.rb", line: 3,
+                  message: 'pending', parent: 'it "d" do'},
+        commit:  {sha: '49499865388dcbce14be3a8b7eca841538b29496',
+                  name: 'Shota Fukumori', email: 'sorah@cookpad.com',
+                  at: Time.parse('Fri, 21 Sep 2012 16:43:43 +0900')},
+        allowed: true
+      }
+    end
+
+    context "with config.allowed_for" do
+      let(:config) { {allowed_for: 0} }
+
+      it "marks pending as not allowed if committed after than :allowed_for" do
+        subject.detect.all? {|pending| !pending[:allowed] }.should be_true
+      end
+    end
+
+    context "with :pattern" do
+      let(:config) { {pattern: '*_test.rb'} }
+
+      it "uses that as file pattern for git-grep" do
+        pendings = subject.detect
+
+        pendings.size.should == 1
+        pendings.first[:example][:file].should match(/d_test\.rb$/)
+      end
+    end
+  end
+end

data/spec/finder_spec.rb

@@ -0,0 +1,62 @@
+require_relative './spec_helper'
+require 'pendaxes/finder'
+
+describe Pendaxes::Finder do
+  subject { Class.new { extend Pendaxes::Finder } }
+
+  describe ".find" do
+    let(:klass) { Class.new(subject) }
+
+    context "with String" do
+      it 'requires that' do
+        subject.should_receive(:require).with("foo/bar/baz")
+
+        subject.find('foo/bar/baz')
+      end
+    end
+
+    context "with Symbol" do
+      it 'requires that' do
+        subject.should_receive(:require).with("foo")
+        subject.find(:foo)
+      end
+    end
+
+    it "requires file and return included ancestor" do
+      subject.should_receive(:require).with("foo") do
+        klass; true
+      end
+      subject.find(:foo).should == klass
+    end
+
+    context "on second time" do
+      it "requires once" do
+        subject.should_receive(:require).with("foo").once do
+          klass; true
+        end
+        subject.find(:foo).should == klass
+        subject.find(:foo).should == klass
+      end
+    end
+
+    context "with not Symbol or String" do
+      it "raises ArgumentError" do
+        expect { subject.find(Object.new) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+
+  describe ".find_in" do
+    subject do
+      Class.new do
+        extend Pendaxes::Finder
+        find_in "hoge"
+      end
+    end
+
+    it 'makes Finder.find(Symbol) to use as prefix for require' do
+      subject.should_receive(:require).with("hoge/foo")
+      subject.find(:foo)
+    end
+  end
+end

data/spec/notificator_spec.rb

@@ -0,0 +1,41 @@
+require_relative './spec_helper'
+require 'pendaxes/notificator'
+require 'pendaxes/reporter'
+
+describe Pendaxes::Notificator do
+  it "has included Defaults" do
+    described_class.singleton_class.included_modules.include?(Pendaxes::Defaults).should be_true
+  end
+
+  it "has included PendingManager" do
+   described_class.included_modules.include?(Pendaxes::PendingManager).should be_true
+  end
+
+  it "responds to #notify" do
+    described_class.new.should be_respond_to(:notify)
+  end
+
+  describe "#report_for" do
+    let(:reporter) do
+      Class.new(Pendaxes::Reporter) do
+        def report
+          [@config, @pendings]
+        end
+      end
+    end
+
+    let(:fixture) do
+      [{commit: {:sha => 'a'}, example: {:file => 'a'}, allowed: true}, {commit: {:sha => 'b'}, example: {:file => 'b'}, allowed: false}]
+    end
+
+    before do
+      Pendaxes::Reporter.announce(:report_for, reporter)
+    end
+
+    subject { described_class.new(reporter: {use: :report_for, foo: :bar}) }
+
+    it "returns report using reporter specified by config" do
+      subject.report_for(fixture).should == [{use: :report_for, foo: :bar, include_allowed: true}, fixture]
+    end
+  end
+end

data/spec/notificators/mail_spec.rb

@@ -0,0 +1,184 @@
+require_relative '../spec_helper'
+require 'pendaxes/notificators/mail'
+require 'pendaxes/reporter'
+require 'mail'
+
+Mail.defaults do
+  delivery_method :test
+end
+
+class TestReporter < Pendaxes::Reporter
+  def report
+    "Test reporting: #{pendings.inspect}"
+  end
+end
+
+class TestHtmlReporter < TestReporter
+  def self.html?; true; end
+end
+
+
+describe Pendaxes::Notificator::Mail do
+  before(:all) do
+    Pendaxes::Reporter.announce :test_reporter, TestReporter
+    Pendaxes::Reporter.announce :test_html_reporter, TestHtmlReporter
+  end
+
+  let(:pendings) do
+    [{
+       example: {file: "spec/a_spec.rb", line: 9,
+                 message: 'xit "d" do', parent: 'context "c" do'},
+       commit:  {sha: '371955e233bf1ff42d0c7cca3510ec0f8d71ec8d',
+                 name: 'Shota Fukumori', email: 'sorah@cookpad.com',
+                 at: Time.parse('2012-09-21 16:44:13 +0900')},
+       allowed: true
+     },
+     {
+       example: {file: "spec/a_spec.rb", line: 4,
+                 message: 'pending', parent: 'it "a" do'},
+       commit:  {sha: '642caa033642700cd9d4c6f026fe73282985ed50',
+                 name: 'Shota Fukumori', email: 'sorah@cookpad.com',
+                 at: Time.parse('Thu, 7 Apr 2005 22:13:13 +0900')},
+       allowed: false
+     },
+     {
+       example: {file: "spec/b/c_spec.rb", line: 3,
+                 message: 'pending', parent: 'it "d" do'},
+       commit:  {sha: '49499865388dcbce14be3a8b7eca841538b29496',
+                 name: 'Shohta Fukumori', email: 'sorah+b@cookpad.com',
+                 at: Time.parse('Fri, 21 Sep 2012 16:43:43 +0900')},
+       allowed: true
+     }]
+  end
+
+  it "has Pendaxes::Notificator as superclass" do
+    described_class.superclass.should == Pendaxes::Notificator
+  end
+
+  describe "#notify" do
+    include Mail::Matchers
+    let(:config_root) { {reporter: {use: :test_reporter}, from: "sorah+from@cookpad.com", include_allowed: true} }
+    let(:config) { config_root }
+    let(:deliveries) { Mail::TestMailer.deliveries }
+    subject { described_class.new(config) }
+    before { subject.add(pendings) }
+    after { Mail::TestMailer.deliveries.clear }
+
+    it "sends mails for each committers" do
+      subject.notify
+
+      deliveries.size.should == 2
+      should have_sent_email.from('sorah+from@cookpad.com')
+      should have_sent_email.to('sorah@cookpad.com')
+      should have_sent_email.to('sorah+b@cookpad.com')
+    end
+
+    it "uses report as body of mail" do
+      subject.notify
+
+      %w(sorah@cookpad.com sorah+b@cookpad.com).each do |email|
+        delivery = deliveries.find {|deliver| deliver.to.include? email }
+        delivery.body.should == "Test reporting: #{pendings.select {|pending| pending[:commit][:email] == email}.inspect}"
+      end
+    end
+
+    context "with :delivery_method" do
+      let(:config) { config_root.merge(delivery_method: :test, delivery_options: {foo: :bar}) }
+
+      it "uses that as delivery_method" do
+        method = Mail.new.delivery_method
+        Mail::Message.any_instance.should_receive(:delivery_method).with(:test, foo: :bar).at_least(:once)
+        exception = Exception.new
+        Mail::Message.any_instance.stub(:deliver) { raise exception }
+
+        expect { subject.notify }.to raise_error(exception)
+      end
+    end
+
+    context "with :to" do
+      let(:config) { config_root.merge(to: 'sorah+c@cookpad.com') }
+
+      it "sends all mails to that" do
+        subject.notify
+
+        deliveries.size.should == 1
+        should have_sent_email.to('sorah+c@cookpad.com')
+        deliveries.first.body.should == "Test reporting: #{pendings.inspect}"
+      end
+    end
+
+    context "with :whitelist" do
+      let(:config) { config_root.merge(whitelist: ['sorah@cookpad.com']) }
+
+      it "won't send mail to addresses don't match" do
+        subject.notify
+
+        deliveries.size.should == 1
+        should_not have_sent_email.to('sorah+b@cookpad.com')
+        should have_sent_email.to('sorah@cookpad.com')
+      end
+
+      context "regex" do
+        let(:config) { config_root.merge(whitelist: ['/^sorah@/']) }
+
+        it "parses as Regexp" do
+          subject.notify
+
+          deliveries.size.should == 1
+          should_not have_sent_email.to('sorah+b@cookpad.com')
+          should have_sent_email.to('sorah@cookpad.com')
+        end
+      end
+    end
+
+    context "with :blacklist" do
+      let(:config) { config_root.merge(blacklist: ['sorah+b@cookpad.com']) }
+
+      it "won't send mail to addresses that match" do
+        subject.notify
+
+        deliveries.size.should == 1
+        should_not have_sent_email.to('sorah+b@cookpad.com')
+        should have_sent_email.to('sorah@cookpad.com')
+      end
+
+      context "regex" do
+        let(:config) { config_root.merge(blacklist: ['/^sorah\+/']) }
+
+        it "parses as Regexp" do
+          subject.notify
+
+          deliveries.size.should == 1
+          should_not have_sent_email.to('sorah+b@cookpad.com')
+          should have_sent_email.to('sorah@cookpad.com')
+        end
+      end
+    end
+
+    context "with :whitelist & :blacklist" do
+      let(:config) { config_root.merge(whitelist: [/@cookpad\.com$/], blacklist: ['sorah+b@cookpad.com']) }
+
+      it "prefers blacklist first" do
+        subject.notify
+
+        deliveries.size.should == 1
+        should_not have_sent_email.to('sorah+b@cookpad.com')
+        should have_sent_email.to('sorah@cookpad.com')
+      end
+    end
+
+    context "when reporter's html is false" do
+      it "sends mail as plain text" do
+        deliveries.all? {|delivery| delivery.content_type == nil }.should be_true
+      end
+    end
+
+    context "when reporter's html is true" do
+      let(:config) { {reporter: {use: :test_html_reporter} } }
+
+      it "sends mail as text/html" do
+        deliveries.all? {|delivery| delivery.content_type == 'text/html; charset=utf-8' }.should be_true
+      end
+    end
+  end
+end

data/spec/notificators/terminal_spec.rb

@@ -0,0 +1,67 @@
+require_relative '../spec_helper'
+require 'pendaxes/notificators/terminal'
+require 'stringio'
+
+describe Pendaxes::Notificator::Terminal do
+  it "has Pendaxes::Notificator as superclass" do
+    described_class.superclass.should == Pendaxes::Notificator
+  end
+
+  describe "#notify" do
+    let(:io) { StringIO.new }
+    let(:config) { {to: io} }
+    let(:now) { Time.now }
+    let(:fixture) do
+      [
+        {commit:  {sha: 'a', name: 'foo', email: 'foo@example.com', at: (now-86400)},
+         example: {file: 'a_spec.rb', line: 10, message: "pending 'because it fails'"}, allowed: true},
+        {commit:  {sha: 'b', name: 'foo', email: 'foo@example.com', at: (now-864000)},
+         example: {file: 'a_spec.rb', line: 15, message: "pending 'because it fails.'"}, allowed: false},
+        {commit:  {sha: 'c', name: 'bar', email: 'bar@example.com', at: (now-86400)},
+         example: {file: 'a_spec.rb', line: 20, message: "pending 'because it fails..'"}, allowed: true},
+        {commit:  {sha: 'd', name: 'bar', email: 'bar@example.com', at: (now-864000)},
+         example: {file: 'a_spec.rb', line: 25, message: "pending 'because it fails...'"}, allowed: false},
+      ]
+    end
+
+    subject { described_class.new(config) }
+
+    before do
+      subject.add(fixture)
+      subject.notify
+    end
+
+    it "notifies into terminal" do
+      out = io.string
+      out.should == <<-EOF
+foo <foo@example.com>:
+
+* a_spec.rb:15 - pending 'because it fails.' (@ b #{now-864000})
+
+bar <bar@example.com>:
+
+* a_spec.rb:25 - pending 'because it fails...' (@ d #{now-864000})
+
+      EOF
+    end
+
+    context "with :include_allowed" do
+      let(:config) { {to: io, include_allowed: true} }
+      it "notifies all into terminal" do
+        out = io.string
+        out.should == <<-EOF
+foo <foo@example.com>:
+
+* a_spec.rb:15 - pending 'because it fails.' (@ b #{now-864000})
+* a_spec.rb:10 - pending 'because it fails' (@ a #{now-86400})
+
+bar <bar@example.com>:
+
+* a_spec.rb:25 - pending 'because it fails...' (@ d #{now-864000})
+* a_spec.rb:20 - pending 'because it fails..' (@ c #{now-86400})
+
+        EOF
+      end
+    end
+  end
+end

data/spec/pendaxes_spec.rb

@@ -0,0 +1,7 @@
+require_relative './spec_helper'
+require 'pendaxes'
+
+describe Pendaxes do
+  describe ".run" do
+  end
+end