capnotify-commit_log 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Spike Grobstein
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,40 @@
+# Capnotify::CommitLog
+
+This adds a commit log to your capnotify emails.
+
+This will list commits that are new to this deploy (compared to the previous deploy).
+Currently it only supports git and uses the `git log --oneline` command internaly.
+
+A future version should support other SCMs if you're into that kind of thing. Anyone with
+repositories on other SCMs is encouraged to send me a pull request implementing that.
+
+NOTE: This is very much a work in progress and is NOT production ready. This is the first
+plugin for Capnotify and it's being used to work out aspects of the extension API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capnotify-commit_log'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capnotify-commit_log
+
+## Usage
+
+All you need to do is include the following code after requiring `capnotify`:
+
+    require 'capnotify/commit_log'
+
+## 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 @@
+require "bundler/gem_tasks"

data/capnotify-commit_log.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capnotify-commit_log/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capnotify-commit_log"
+  spec.version       = Capnotify::CommitLog::VERSION
+  spec.authors       = ["Spike Grobstein"]
+  spec.email         = ["me@spike.cx"]
+  spec.description   = %q{Add a detailed Git commit log to your Capnotify deloyment notification emails}
+  spec.summary       = %q{Git commit log for Capnotify emails}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "capnotify", '~> 0.2'
+  spec.add_dependency "git", "~> 1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+end

data/lib/capnotify-commit_log/version.rb

@@ -0,0 +1,5 @@
+module Capnotify
+  module CommitLog
+    VERSION = "0.0.1"
+  end
+end

data/lib/capnotify-commit_log.rb

@@ -0,0 +1,161 @@
+require 'git'
+require "capnotify"
+require "capnotify-commit_log/version"
+require 'pry'
+
+module Capnotify
+  module CommitLog
+
+    PLUGIN_NAME = :capnotify_commit_log
+
+    DEFAULT_COMMIT_LOG_ENTRY = {
+        :author  => 'n/a',
+        :date    =>  nil,
+        :email   => 'n/a',
+        :sha     => 'n/a',
+        :message => 'Log output not available.'
+      }
+
+    def self.load_into(config)
+      config.load do
+        on(:load) do
+          capnotify.load_plugin(Capnotify::CommitLog)
+        end
+      end
+    end
+
+    def init
+      capnotify.components << Capnotify::Component.new(:capnotify_commit_log) do |c|
+        c.header = 'Log'
+
+        c.css_class = 'commit-log'
+        c.custom_css = <<-CSS
+          ul.commit_log {
+            list-style: none;
+            margin: 0;
+            padding: 0;
+            clear: both;
+          }
+
+          ul.commit_log li {
+            clear: both;
+            display: block;
+            white-space: nowrap;
+          }
+
+          ul.commit_log h4.sha {
+            font-family: monospace;
+            background-color: #eee;
+            color: #666;
+            float: left;
+            padding: 2px 0px;
+            margin: 0;
+            margin-right: 5px;
+            width: 70px;
+            text-align: center;
+          }
+
+          ul.commit_log .commit_body {
+            <!-- float: left; -->
+            white-space: normal;
+
+            margin-left: 75px;
+          }
+
+          ul.commit_log .commit_body h4 {
+            padding: 2px 0px;
+            font-weight: bold;
+            margin: 0;
+          }
+
+          ul.commit_log .commit_body .commit_message {
+            white-space: pre-wrap;
+            font-family: monospace;
+          }
+
+          ul.commit_log a {
+            font-weight: bold;
+            text-decoration: none;
+          }
+
+          ul.commit_log a:hover {
+            text-decoration: underline;
+          }
+        CSS
+
+        c.template_path = File.join( File.dirname(__FILE__), 'templates' )
+
+        c.render_for :html => '_commit_log.html.erb', :txt => '_commit_log.txt.erb'
+
+        c.content = commit_log(fetch(:previous_revision, nil), fetch(:real_revision, nil))
+      end
+    end
+
+    def unload
+      capnotify.delete_component :capnotify_commit_log
+    end
+
+    # locate the git repository for the project
+    # starting with the local_git_repository_path
+    # or current working directory (or path, if specified),
+    # traverse the filesystem going up until we hit a git repository.
+    # returns nil if one is not found. otherwise returns a Git object
+    def find_git_repo(path=nil)
+      # use local_git_repository_path or Dir.pwd if path is not specified
+      path = fetch(:local_git_repository_path, Dir.pwd) if path.nil?
+
+      # expand the path
+      path = File.expand_path(path)
+
+      return nil if path == '/'
+
+      # try to open the current path
+      # if fail, go up a directory
+      begin
+        ::Git.open(path)
+      rescue ArgumentError
+        find_git_repo(File.join(path, '..'))
+      end
+    end
+
+    # git log between +first_ref+ to +last_ref+
+    # memoizes the output so this function can be called multiple times without re-running
+    # FIXME: memoization does not account for arguments
+    # FIXME: this should probably use the git gem
+    # FIXME: this only supports git.
+    #
+    # returns an array of 2-element arrays in the form of
+    # [ ref, log_text ]
+    def commit_log(first_ref, last_ref)
+      puts "running commit log"
+      return @commit_log unless @commit_log.nil?
+
+      git = find_git_repo
+
+      begin
+        raise "Ref missing" if first_ref.nil? || last_ref.nil? # jump to rescue block.
+
+        log_results = git.log.between(first_ref, last_ref)
+
+        @commit_log = log_results.map do |log|
+          {
+            :author  => log.author.name,
+            :date    => log.date,
+            :email   => log.author.email,
+            :sha     => log.sha,
+            :message => log.message
+          }
+        end
+
+      rescue
+        [ DEFAULT_COMMIT_LOG_ENTRY ]
+      end
+    end
+
+  end
+end
+
+if Capistrano::Configuration.instance
+  Capnotify::CommitLog.load_into(Capistrano::Configuration.instance)
+end
+

data/lib/templates/_commit_log.html.erb

@@ -0,0 +1,34 @@
+<ul class="commit_log">
+  <% @content.each do |commit| %>
+  <li>
+    <h4 class="sha">
+      <% if config.fetch(:github_url, nil) && commit[:sha].length >= 7 %>
+        <a href="<%= config.github_url %>/commit/<%= commit[:sha] %>"><%= commit[:sha][0,7] %></a>
+      <% else %>
+        <%= commit[:sha][0,7] %>
+      <% end %>
+    </h4>
+
+    <div class="commit_body">
+      <h4>
+        <span class="commit_author">
+          <% if commit[:email].match /@/ %>
+            <%# include the author's name with a link to their email if it's there %>
+            <a href="mailto:<%= commit[:email] %>"><%= commit[:author] %></a>
+          <% else %>
+            <%= commit[:author] %>
+          <% end %>
+        </span>
+        @
+        <span class="commit_date">
+          <%= commit[:date] ? commit[:date].strftime('%Y-%m-%d') : 'n/a' %>
+      </span>
+      </h4>
+
+      <p class="commit_message"><%= commit[:message] %></p>
+    </div>
+  </li>
+  <% end %>
+</ul>
+<div style="float:none; clear:both;"><!-- float-fix --></div>
+

data/lib/templates/_commit_log.txt.erb

@@ -0,0 +1,7 @@
+<% @content.each do |commit| %>
+<%= commit[:sha][0,7] %> <%= commit[:author] %> <<%= commit[:email] %>> @ <%= commit[:date].strftime('%Y-%m-%d') %>
+
+<%= commit[:message].gsub(/^/, '        ').gsub(/\t/, '  ') %>
+
+
+<% end %>

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: capnotify-commit_log
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Spike Grobstein
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capnotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Add a detailed Git commit log to your Capnotify deloyment notification
+  emails
+email:
+- me@spike.cx
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- capnotify-commit_log.gemspec
+- lib/capnotify-commit_log.rb
+- lib/capnotify-commit_log/version.rb
+- lib/templates/_commit_log.html.erb
+- lib/templates/_commit_log.txt.erb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1094105692905918392
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1094105692905918392
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Git commit log for Capnotify emails
+test_files: []