pendaxes 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+fixtures/repo

data/.rspec

@@ -0,0 +1,2 @@
+--color
+-fd

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pendaxes.gemspec
+gemspec

data/README.md

@@ -0,0 +1,148 @@
+# Pendaxes
+
+Throw axes to pending makers!
+
+Leaving a pending long time is really bad, shouldn't be happened. They'll make a trouble.
+So, this gem sends notification to committer that added pending after a while from the commit.
+
+Avoid the trouble due to pending examples :D
+
+## Installation
+
+(1.9 required)
+
+    $ gem install pendaxes
+
+## Usage
+
+    $ pendaxes <config_file>
+
+(writing in cron is recommended)
+
+### Configuration
+
+#### Minimal
+
+Clone `https://github.com/foo/bar.git` to `/path/to/be/cloned/repository`, then detect pendings using rspec detector (default).
+
+Finally send notification to committers via email (from `no-reply@example.com`).
+
+    workspace:
+      path: /path/to/be/cloned/repository        # where to clone?
+      repository: https://github.com/foo/bar.git # where clone from?
+    report:
+      use: haml
+      to: "report.html"
+    notifications:
+      - use: mail
+        from: no-reply@example.com
+        reporter:
+          use: haml
+
+
+#### Full
+
+    detection:
+      use: rspec           # use rspec detector for pending detection. (default)
+    # pattern: '*_spec.rb' # this will be passed after `git grep ... --`. Default is "*_spec.rb".
+    # allowed_for: 604800  # (second) = 1 week. Pendings will be marked "not allowed" if it elapsed more than this value
+
+    workspace:
+      path: /path/to/be/cloned/repository            # where to clone?
+      repository: "https://github.com/user/repo.git" # where clone from?
+
+    report: # report configuration to save
+      use: haml              # what reporter to use (haml and text is bundled in the gem)
+      to: "report.html"      # where to save?
+      include_allowed: true  # include "allowed" pendings in report. (default: true)
+      # VVV haml reporter specific configuration VVV
+      commit_url: "https://github.com/user/repo/commit/%commit%"        # Used for link to commit. %commit% will be replaced to sha1. If not specified, will not be a link.
+      file_url: "https://github.com/user/repo/blob/HEAD/%file%#L%line%" # Used for link to file. %file% and %line% will be replaced to filepath and line no. If not specified, will not be a link.
+
+    notifications: # notifications. multiple values are accepted.
+      - use: terminal # use terminal notificator.
+      - use: mail # use mail notificator.
+        reporter: # reporter setting for this (mail) notification
+          use: haml
+          commit_url: "https://github.com/user/repo/commit/%commit%"
+          file_url: "https://github.com/user/repo/blob/HEAD/%file%#L%line%"
+
+        # VVV mail notificator specific configuration VVV
+        from: no-reply@example.com
+        to: foo@example.com # (optional) mail will be sent once to this mail address.
+                            # without this, mail will be sent separated for each committer.
+                            # (mails will include pendings added by its recipient only.)
+
+        delivery_method: sendmail # specify delivery_method. https://github.com/mikel/mail for more detail.
+        delivery_options:         # (optional) used as option for delivery_method.
+          :location: /usr/sbin/sendmail
+
+        whitelist:          # (optional) if whitelist set, mail won't be sent if not matched.
+          - foo@bar         #   complete match.
+          - /example\.com$/ #   used as regexp.
+        blacklist:          # (optional) mail won't be sent if matched. preferred than whitelist.
+          - black@example.com
+          - /^black/
+
+        alias:              # (optional) Aliasing emails. if mail will be sent to <value> if git commit author is <key>.
+          "foo@gmail.com": "foo@company.com"
+
+
+* Reporter: generates text or html by given pendings
+* Notificator: get text or html by reporter, and notify it (via mail, to terminal, etc...)
+
+## Axes?
+
+斧... Axe in Japanese. Recently, Japanese engineer says a review comment as axe (斧).
+
+Throwing axe means "comment my opnion."
+
+This script throws axe to committer, about his/her uncontrolled pending tests.
+
+## Requirements
+
+* Ruby 1.9+ (1.9.3 supported)
+* git
+
+we're using `git grep` and `git blame` to detect pendings, and supported test suite is currently `rspec` only.
+this gem supports git managed repository, and using rspec.
+
+Patches for other environment are welcomed. :-)
+
+## Writing notificator and reporter
+
+TBD
+
+## License
+
+MIT License:
+
+    (c) 2012 Shota Fukumori (sora_h)
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+    THE SOFTWARE.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/pendaxes

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+begin
+  require 'pendaxes'
+rescue LoadError
+  $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+  retry
+end
+
+exit Pendaxes.run(*ARGV)

data/lib/pendaxes/command_line.rb

@@ -0,0 +1,56 @@
+require_relative "./config"
+require_relative "./workspace"
+require_relative "./detector"
+require_relative "./reporter"
+require_relative "./notificator"
+
+module Pendaxes
+  class CommandLine
+    def initialize(*args)
+      @args = args
+      @config = Config.new(YAML.load_file(args.first))
+    end
+
+    def run
+      puts "=> Update repository"
+      update
+
+      puts "=> Detect pendings"
+      detect
+
+      puts "=> Writing report"
+      report
+
+      puts "=> Send notifications"
+      notify
+
+      0
+    end
+
+    def update
+      @workspace = Workspace.new(@config.workspace)
+      @workspace.update
+    end
+
+    def detect
+      @detector = Detector.find(@config.detection.use.to_sym).new(@workspace, {out: $stdout}.merge(@config.detection))
+      @pendings = @detector.detect
+    end
+
+    def report
+      @reporter = Reporter.find(@config.report.use.to_sym).new(@config.report)
+      @reporter.add @pendings
+      report = @reporter.report
+      open(@config.report.to, 'w') {|io| io.puts report }
+    end
+
+    def notify
+      @config.notifications.map{|x| Hashr.new(x) }.each do |notification|
+        puts "  * #{notification.use}"
+        notificator = Notificator.find(notification.use.to_sym).new({out: $stdout}.merge(notification))
+        notificator.add @pendings
+        notificator.notify
+      end
+    end
+  end
+end

data/lib/pendaxes/config.rb

@@ -0,0 +1,10 @@
+require 'hashr'
+
+module Pendaxes
+  class Config < Hashr
+    define detection: {use: :rspec},
+           workspace: {},
+           report: {use: :text, to: "report.txt"},
+           notifications: [{use: :terminal}]
+  end
+end

data/lib/pendaxes/defaults.rb

@@ -0,0 +1,12 @@
+module Pendaxes
+  module Defaults
+    def defaults(h=nil)
+      default_defaults = self.superclass.respond_to?(:defaults) ? self.superclass.defaults : Hashr.new
+      @defaults ||= default_defaults
+      if h
+        @defaults = default_defaults.merge(h)
+      end
+      @defaults
+    end
+  end
+end

data/lib/pendaxes/detector.rb

@@ -0,0 +1,23 @@
+require_relative 'pending_manager'
+require_relative 'defaults'
+require_relative 'finder'
+require 'hashr'
+
+module Pendaxes
+  class Detector
+    extend Defaults
+    extend Finder
+    find_in 'pendaxes/detectors'
+
+    defaults allowed_for: 604800
+
+    def initialize(workspace, config={})
+      @config = Hashr.new(self.class.defaults.merge(config))
+      @workspace = workspace
+      @pendings = []
+    end
+
+    def detect
+    end
+  end
+end

data/lib/pendaxes/detectors/rspec.rb

@@ -0,0 +1,78 @@
+# coding: utf-8
+require_relative '../detector'
+require 'time'
+require 'ripper'
+require 'ripper/lexer'
+
+module Pendaxes
+  class Detector
+    class RSpec < Detector
+      PENDERS = %w(xit xexample xspecify pending).freeze
+      GREP_CMD = ( %w(grep --name-only -e) \
+                 + PENDERS.join(' --or -e ').split(/ /) \
+                 + ['--']
+                 ).freeze
+      PARENTS = %w(context describe it example specify xexample xspecify xit).freeze
+
+      defaults pattern: '*_spec.rb'
+
+      def detect
+        @workspace.dive do
+          pattern = @config.pattern.is_a?(Array) ? @config.pattern : [@config.pattern]
+          grep = @workspace.git(*GREP_CMD, *pattern).force_encoding("UTF-8")
+          return [] unless grep
+          files = grep.split(/\r?\n/).map(&:chomp)
+
+          files.inject([]) do |pendings, file|
+            @config.out.puts "* #{file}" if @config.out
+            file_content = File.read(file).force_encoding(@config.encoding || "UTF-8")
+            lines = file_content.split(/\r?\n/)
+            tokens = Ripper.lex(file_content, file)
+            _prev = nil
+
+            tokens.each_with_index do |token, i|
+              prev = _prev
+              _prev = token[1]
+              next if prev == :on_symbeg
+              next unless token[1] == :on_ident && PENDERS.include?(token[2])
+              pending = {}
+
+              line = token[0][0]
+
+              parent = (i-1).downto(0).inject {|_, j|
+                break lines[tokens[j][0][0]-1] if tokens[j][1] == :on_ident && (j.zero? || tokens[j-1][1] != :on_symbeg) && PARENTS.include?(tokens[j][2])
+                nil
+              }
+              parent.gsub!(/^[ \t]+/, '') if parent
+
+              pending[:example] = {
+                file: file, line: line,
+                message: lines[line-1].gsub(/^[ \t]+/, ''), parent: parent
+              }
+
+              pending[:commit] = blame(file, line)
+              pending[:allowed] = (Time.now - pending[:commit][:at]) <= @config.allowed_for
+
+              pendings << pending
+            end
+
+            pendings
+          end
+        end
+      end
+
+      private
+
+      def blame(file, line)
+        @config.out.puts "  * blaming #{file}:#{line}" if @config.out
+        blame = @workspace.git('blame', '-L', "#{line},#{line}", '-l', '-w', '-p', file).force_encoding("UTF-8").split(/\r?\n/).map{|l| l.split(/ /) }
+        commit = {
+          sha: blame[0].first, name: blame[1][1..-1].join(' '),
+          email: blame[2][1..-1].join(' ').gsub(/^</,'').gsub(/>$/,'')
+        }
+        commit[:at] = Time.parse(@workspace.git(*%w(log --pretty=%aD -n1), commit[:sha]).chomp)
+        commit
+      end
+    end
+  end
+end

data/lib/pendaxes/finder.rb

@@ -0,0 +1,34 @@
+module Pendaxes
+  module Finder
+    def find(name)
+      @finder_cache ||= {}
+      path = case name
+             when String
+               name
+             when Symbol
+               "#{@finder_prefix || ""}#{name}"
+             else
+               raise ArgumentError, "name should be a kind of String or Symbol"
+             end
+      return @finder_cache[name] if @finder_cache[name]
+      require path
+      announce name, @finder_latest_inherited
+    end
+
+    def inherited(klass)
+      if klass.name
+        announce klass.name.gsub(/^.*::/,'').gsub(/.[A-Z]/){|s| s[0]+"_"+s[1] }.downcase.to_sym, klass
+      end
+      @finder_latest_inherited = klass
+    end
+
+    def announce(name, klass)
+      (@finder_cache ||= {})[name] = klass
+    end
+
+    def find_in(prefix)
+      @finder_prefix = prefix + "/"
+    end
+    private :find_in
+  end
+end

data/lib/pendaxes/notificator.rb

@@ -0,0 +1,32 @@
+require_relative 'pending_manager'
+require_relative 'defaults'
+require_relative 'finder'
+require 'hashr'
+
+module Pendaxes
+  class Notificator
+    include PendingManager
+    extend Defaults
+    extend Finder
+    find_in 'pendaxes/notificators'
+    defaults reporter: {use: :text}
+
+    def initialize(config={})
+      @config = Hashr.new(self.class.defaults.merge(config))
+      @pendings = []
+    end
+
+    def notify
+    end
+
+    def reporter
+      Reporter.find(@config.reporter.use.to_sym)
+    end
+
+    def report_for(pendings)
+      r = reporter.new({include_allowed: true}.merge(@config.reporter))
+      r.add pendings
+      r.report
+    end
+  end
+end

data/lib/pendaxes/notificators/mail.rb

@@ -0,0 +1,72 @@
+require_relative '../notificator'
+require 'mail'
+
+module Pendaxes
+  class Notificator
+    class Mail < Notificator
+      defaults reporter: {use: :text}, blacklist: []
+
+      def notify
+        if @config.to
+          deliver(pendings, @config.to)
+        else
+          pendings.group_by {|pending| pending[:commit][:email] }.each do |email, pends|
+            deliver(pends, email)
+          end
+        end
+      end
+
+      def whitelist
+        if @config.whitelist
+          @whitelist ||= process_email_filter(@config.whitelist)
+        else
+          nil
+        end
+      end
+
+      def blacklist
+        @blacklist ||= process_email_filter(@config.blacklist)
+      end
+
+      private
+
+      def deliver(pends,email)
+        real_email = (@config.alias || {})[email] || email
+        return nil if blacklist.match?(real_email) || (whitelist && !whitelist.match?(real_email))
+
+        mail = ::Mail.new
+        mail.from = @config.from
+        mail.to = real_email
+        mail.subject = "[Pendaxes] Your #{pends.size} pending tests are waiting to be fixed"
+        mail.body = report_for(pends)
+        mail.content_type = 'text/html; charset=utf-8' if reporter.html?
+
+        if @config.delivery_method
+          mail.delivery_method @config.delivery_method.to_sym, @config.delivery_options || {}
+        end
+
+        @config.out.puts mail.inspect if @config.out
+
+        mail.deliver
+      end
+
+      def process_email_filter(list)
+        filter = list.map do |email|
+          if %r{^/(.*)/$} === email
+            Regexp.new($1)
+          else
+            email
+          end
+        end
+        class << filter
+          def match?(email)
+            self.any? do |condition|
+              condition.is_a?(Regexp) ? condition === email : condition == email
+            end
+          end
+        end
+        filter
+      end
+    end
+  end
+end

data/lib/pendaxes/notificators/terminal.rb

@@ -0,0 +1,19 @@
+require_relative '../notificator'
+
+module Pendaxes
+  class Notificator
+    class Terminal < Notificator
+      defaults to: $stdout, reporter: {use: :text}
+
+      def notify
+        io = @config.to
+        pendings.group_by{|x| "#{x[:commit][:name]} <#{x[:commit][:email]}>" }.each do |name, pends|
+          io.puts "#{name}:"
+          io.puts
+          io.puts report_for(pends)
+          io.puts
+        end
+      end
+    end
+  end
+end

data/lib/pendaxes/pending_manager.rb

@@ -0,0 +1,30 @@
+require 'hashr'
+
+module Pendaxes
+  module PendingManager
+    def add(pending={})
+      case pending
+      when Array
+        @pendings.push *pending.map{|x| Hashr.new(x) }
+      when Hash
+        @pendings << Hashr.new(pending)
+      end
+    end
+
+    def pendings
+      if @config.include_allowed
+        all_pendings
+      else
+        @pendings.reject(&:allowed)
+      end
+    end
+
+    def all_pendings
+      @pendings
+    end
+
+    def reset
+      @pendings = []
+    end
+  end
+end

data/lib/pendaxes/reporter.rb

@@ -0,0 +1,27 @@
+require_relative 'pending_manager'
+require_relative 'defaults'
+require_relative 'finder'
+require 'hashr'
+
+module Pendaxes
+  class Reporter
+    include PendingManager
+    extend Defaults
+    extend Finder
+    find_in 'pendaxes/reporters'
+
+    defaults include_allowed: true
+
+    def initialize(config={})
+      @config = Hashr.new(self.class.defaults.merge(config))
+      @pendings = []
+    end
+
+    def report
+    end
+
+    def self.html?
+      false
+    end
+  end
+end

data/lib/pendaxes/reporters/haml.rb

@@ -0,0 +1,49 @@
+require_relative '../reporter'
+require 'haml'
+require 'digest/md5'
+require 'cgi'
+
+module Pendaxes
+  class Reporter
+    class Haml < Reporter
+      defaults commit_url: nil,
+               file_url: nil,
+               report_url: nil,
+               gravatar: true,
+               older_first: true,
+               template: "#{File.dirname(__FILE__)}/template.haml"
+
+      def report
+        haml = ::Haml::Engine.new(File.read(@config.template))
+        haml.render(binding, config: @config)
+      end
+
+      def self.html?; true; end
+
+      private
+
+      def relative_time(time, from = Time.now)
+        diff = from - time
+        return "in the future" if diff < 0
+        case diff
+        when 0..10
+          "Just now"
+        when 11..60
+          "in a minute"
+        when 61...3600
+          "%.1f minutes ago" % (diff/60)
+        when 3600...86400
+          "%.1f hours ago" % (diff/3600.0)
+        when 86400...604800
+          "%.1f days ago" % (diff/86400.0)
+        when 604800...2419200
+          "%.1f weeks ago" % (diff/604800.0)
+        when 2419200...31556926
+          "%.1f months ago" % (diff/2419200.0)
+        else
+          "%.1f years ago" % (diff/31556926.0)
+        end
+      end
+    end
+  end
+end