pendaxes 0.0.1 → 0.0.2

data/README.md

@@ -1,5 +1,7 @@
 # Pendaxes
 
+![sample notification using mail](https://img.skitch.com/20120925-essq4fdifg79axb2ssi2cyb2ne.png)
+
 Throw axes to pending makers!
 
 Leaving a pending long time is really bad, shouldn't be happened. They'll make a trouble.
@@ -17,11 +19,16 @@ Avoid the trouble due to pending examples :D
 
     $ pendaxes <config_file>
 
-(writing in cron is recommended)
+See `pendaxes --help` for more.
 
 ### Configuration
 
-#### Minimal
+    $ pendaxes --init # will write to .pendaxes.yml
+    $ pendaxes --init config.yml # will write to config.yml
+
+see https://github.com/cookpad/pendaxes/wiki/Configuration for detail.
+
+#### Example
 
 Clone `https://github.com/foo/bar.git` to `/path/to/be/cloned/repository`, then detect pendings using rspec detector (default).
 
@@ -30,67 +37,17 @@ 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: file
+        to: "report.html"
+        reporter:
+          use: haml
       - use: mail
         from: no-reply@example.com
+        delivery_method: sendmail
         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 (斧).

data/lib/pendaxes/command_line.rb

@@ -3,54 +3,189 @@ require_relative "./workspace"
 require_relative "./detector"
 require_relative "./reporter"
 require_relative "./notificator"
+require 'yaml'
 
 module Pendaxes
   class CommandLine
+    DEFAULT_CONFIG_FILE = ".pendaxes.yml"
+
     def initialize(*args)
       @args = args
-      @config = Config.new(YAML.load_file(args.first))
+      @config = nil
     end
 
-    def run
-      puts "=> Update repository"
-      update
+    def config
+      return @config if @config
+      return nil if @args.empty? && !File.exist?(DEFAULT_CONFIG_FILE)
 
-      puts "=> Detect pendings"
-      detect
+      @config = Config.new(YAML.load_file(@args.first || DEFAULT_CONFIG_FILE))
+    end
 
-      puts "=> Writing report"
-      report
+    def write_default_config(options={})
+      options[:to] ||= DEFAULT_CONFIG_FILE
+      workspace = (options[:path] || options[:repository])
+      open(options[:to], 'w') do |io|
+        io.puts <<-EOC
+# Pendaxes default configuration file.
+# See https://github.com/cookpad/pendaxes/wiki/Configuration for detail.
 
-      puts "=> Send notifications"
-      notify
+##
+# for automatic git-pulling. recommend to set if you run periodically.
+#
+# path:       path to working copy to use.
+#             if not exist, pendaxes will clone automatically from `repository`.
+#             PENDAXES WILL DO "git reset --hard".
+#             MAKE SURE path TO BE NOT SAME WITH working copy you use.
+#
+# repository: remote url of repository.
+#             if `path` doesn't exist, will automatically cloned from specified url.
+##
 
-      0
+#{workspace            ? '' : '# '}workspace:
+#{options[:path]       ? '' : '# '}  path: #{options[:path] || '/tmp/repository'}
+#{options[:repository] ? '' : '# '}  repository: #{options[:repository] || "git@github.com:cookpad/pendaxes.git"}
+
+##
+# Settings of notification.
+# See https://github.com/cookpad/pendaxes/wiki/Configuration for detail.
+##
+
+notifications:
+  - use: file       # write report to file.
+    to: report.html # path to write.
+    reporter:
+      use: haml
+#  - use: mail      # send mails to each committer of pending.
+#    reporter:
+#      use: haml
+#    from: no-reply@example.com
+#    delivery_method: sendmail
+#  - use: terminal # show pendings on STDOUT.
+
+##
+# Settings for pending detection
+##
+
+detector:
+  use: rspec # Use rspec detector. Currently only rspec is available.
+  pattern:   # pattern of rspec file. this will be passed right after of "git grep --".
+  - '*_spec.rb'
+#  - 'spec/**/*.rb'
+        EOC
+      end
+
+      puts "Just written default config file to #{options[:to]} !"
+      if workspace
+        puts "\nWith automatic git-pulling enabled:"
+
+        if options[:repository] && options[:path]
+          puts "  * using #{options[:repository]}"
+          puts "  * will cloned at #{options[:path]}"
+
+          if File.exist?(options[:path])
+            puts "WARNING: #{options[:path]} already exists! Pendaxes does `git reset --hard`, be careful!"
+          end
+        elsif options[:path]
+          puts "  * using working copy on #{options[:path]}"
+          puts "WARNING: #{options[:path]} doesn't exist, you have to clone." unless File.exist?(options[:path])
+        elsif options[:repository]
+        end
+      else
+        puts <<-EOM
+
+In default configuration, this will do:
+
+1. Detect pendings
+2. Write report file to "./report.html"
+
+For more about configuration, see https://github.com/cookpad/pendaxes/wiki/Configuration !
+        EOM
+
+        if File.exist?(".git")
+          puts "\nWARNING: this directory doesn't seem git working copy."
+          puts "(Pendaxes works with git working copy.)"
+        end
+      end
+    end
+
+    def init
+      write_default_config(to: @args[1], path: @args[2], repository: @args[3])
+    end
+
+    def usage
+      puts <<-USAGE
+Usage:
+  pendaxes [config]
+    config: (default = ./.pendaxes.yml)
+            Path to config file to use.
+
+  pendaxes --init [config] [path] [remote]
+
+    config: (default = ./.pendaxes.yml)
+            Where to write config file.
+    path:   (optional)
+            Path to working copy.
+    remote: (optional)
+            remote git url. if `path` doesn't exist,
+            will be cloned from this onto `path`.
+
+  pendaxes --help
+
+    Show this help.
+      USAGE
+    end
+
+    def workspace
+      @workspace ||= Workspace.new(config.workspace || {path: Dir.pwd})
     end
 
     def update
-      @workspace = Workspace.new(@config.workspace)
-      @workspace.update
+      workspace.update if config.workspace
     end
 
     def detect
-      @detector = Detector.find(@config.detection.use.to_sym).new(@workspace, {out: $stdout}.merge(@config.detection))
+      @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}"
+      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
+
+    def run
+      case @args.first
+      when "--help"
+        usage
+      when "--init"
+        init
+      else
+        unless config
+          warn "./.pendaxes.yml not exists. showing usage..."
+          usage
+          return 1
+        end
+
+        if config.workspace
+          puts "=> Update repository"
+          update
+        else
+          warn "=> Using this working copy. To use automatic fetching, please fill 'workspace' in your config file."
+          workspace # to initialize @workspace
+        end
+
+        puts "=> Detect pendings"
+        detect
+
+        puts "=> Send notifications"
+        notify
+      end
+
+      0
+    end
   end
 end

data/lib/pendaxes/config.rb

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

data/lib/pendaxes/detectors/rspec.rb

@@ -51,6 +51,7 @@ module Pendaxes
               }
 
               pending[:commit] = blame(file, line)
+              next unless pending[:commit]
               pending[:allowed] = (Time.now - pending[:commit][:at]) <= @config.allowed_for
 
               pendings << pending
@@ -70,6 +71,12 @@ module Pendaxes
           sha: blame[0].first, name: blame[1][1..-1].join(' '),
           email: blame[2][1..-1].join(' ').gsub(/^</,'').gsub(/>$/,'')
         }
+
+        if commit[:sha] == "0000000000000000000000000000000000000000" && commit[:name] == "Not Committed Yet"
+          @config.out.puts "    NOT COMMITTED YET, skipping." if @config.out
+          return nil
+        end
+
         commit[:at] = Time.parse(@workspace.git(*%w(log --pretty=%aD -n1), commit[:sha]).chomp)
         commit
       end

data/lib/pendaxes/notificators/file.rb

@@ -0,0 +1,16 @@
+require_relative '../notificator'
+
+module Pendaxes
+  class Notificator
+    class File < Notificator
+      defaults to: "report.txt", reporter: {use: :text}
+
+      def notify
+        @config.out.puts "   * writing report to #{@config.to}" if @config.out
+        open(@config.to, 'w') do |io|
+          io.puts report_for(pendings)
+        end
+      end
+    end
+  end
+end

data/lib/pendaxes/version.rb

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

data/lib/pendaxes/workspace.rb

@@ -10,6 +10,7 @@ module Pendaxes
     end
 
     def clone
+      raise RemoteUrlMissing, "Set git remote url to workspace.repository, or clone to path yourself." unless @config.repository
       FileUtils.remove_entry_secure(path) if File.exist?(path)
       git "clone", @config.repository, path
     end
@@ -19,7 +20,7 @@ module Pendaxes
 
       dive do
         git "fetch", "origin"
-        git "reset", "--hard", @config.branch || "FETCH_HEAD"
+        git "reset", "--hard", @config.branch || "origin/HEAD"
       end
     end
 
@@ -35,5 +36,7 @@ module Pendaxes
       str = IO.popen([@config.git || "git", *args], 'r', &:read)
       $?.success? ? str : nil
     end
+    
+    class RemoteUrlMissing < Exception; end
   end
 end

data/spec/workspace_spec.rb

@@ -37,7 +37,7 @@ describe Pendaxes::Workspace do
     it "fetch and reset" do
       subject.should_receive(:dive).and_yield.ordered
       subject.should_receive(:git).with("fetch", "origin").ordered
-      subject.should_receive(:git).with("reset", "--hard", "FETCH_HEAD").ordered
+      subject.should_receive(:git).with("reset", "--hard", "origin/HEAD").ordered
 
       subject.update
     end
@@ -51,7 +51,7 @@ describe Pendaxes::Workspace do
         subject.should_receive(:clone).ordered
         subject.should_receive(:dive).and_yield.ordered
         subject.should_receive(:git).with("fetch", "origin").ordered
-        subject.should_receive(:git).with("reset", "--hard", "FETCH_HEAD").ordered
+        subject.should_receive(:git).with("reset", "--hard", "origin/HEAD").ordered
 
         subject.update
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pendaxes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-25 00:00:00.000000000 Z
+date: 2012-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashr
@@ -131,6 +131,7 @@ files:
 - lib/pendaxes/detectors/rspec.rb
 - lib/pendaxes/finder.rb
 - lib/pendaxes/notificator.rb
+- lib/pendaxes/notificators/file.rb
 - lib/pendaxes/notificators/mail.rb
 - lib/pendaxes/notificators/terminal.rb
 - lib/pendaxes/pending_manager.rb
@@ -168,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 314574877471589493
+      hash: -3174069537055922012
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 314574877471589493
+      hash: -3174069537055922012
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23