commit-msg-url-shortener 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
+lib/commit-msg-url-shortener/services/leetspeak.rb

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daniele Molteni
+
+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,60 @@
+# commit-msg-url-shortener
+
+Shortens the urls that may appear in your commit message (and more fun stuff)
+
+## Install it
+
+    $ gem install commit-msg-url-shortener
+
+## Use it
+
+Move to a git-controlled folder and type the command commit-msg-url-shortener to show the help page.
+Available commands are:
+
+       $ commit-msg-url-shortener use [service]
+       $ commit-msg-url-shortener remove
+       $ commit-msg-url-shortener status
+
+Example:
+
+       $ commit-msg-url-shortener use tinyurl.com
+       > Using "tinyurl.com".
+       $ git commit -m "fixes a security flow, see http://railspikes.com/2008/9/22/is-your-rails-application-safe-from-mass-assignment"
+       > [master d0adf01] fixes a security flow, see http://tinyurl.com/2g9mqh
+         1 files changed, 10 insertions(+), 9 deletions(-)
+
+## Hack it
+
+Fork it, and add support for new url-shortener sites. You can also create your own service that pre-process commit messages!
+For example you can create a must-have service that automatically translate your commit message into leetspeak:
+
+1. Create a new file called leetspeak.rb in the services folder
+2. Fill the leetspeak.rb file with the following code:
+
+          CommitMsgUrlShortener::Service.define do |commit_message|
+            translation = {:a=>4,:b=>8,:e=>3,:i=>'!',
+                           :k=>:X,:l=>1,:o=>0,:s=>7,:t=>7,:z=>2}
+            new_message = ''
+            commit_message.each_char do |c|
+              t = translation[c.downcase.to_sym]
+              new_message += t ? t.to_s : c
+            end
+            new_message
+          end
+
+3. Rebuild/reinstall the gem:
+
+          $ bundle exec rake install
+
+4. Now you can use your brand new service! Move to your super-secret-git-versioned-project and type:
+
+          $ commit-msg-url-shortener use leetspeak
+          > Using "leetspeak".
+          $ git commit -am "initial commit!"
+          > [master d0adf00] !n!7!41 c0mm!7!
+            1 files changed, 4 insertions(+), 4 deletions(-)
+
+
+
+
+          

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/commit-msg-url-shortener

@@ -0,0 +1,78 @@
+#!/usr/bin/env ruby
+if ENV and ENV['ENV'] == 'development'
+  fullpath = File.expand_path 'lib/commit-msg-url-shortener.rb' 
+  $LOAD_PATH.push File.dirname fullpath
+  require fullpath
+elsif
+  require 'commit-msg-url-shortener'
+end
+
+def usage
+  bin_name      =  File.basename __FILE__
+  services_list =  CommitMsgUrlShortener::SERVICES.map{|s| s.name}.join ', '
+  puts <<-TEXT
+  Usage:  
+   #{bin_name} use [service] # Apply the service to your commits' messages.
+   #{bin_name} remove        # Stop using any service.
+   #{bin_name} status        # Outputs the status.
+  Services: 
+   #{services_list}
+  TEXT
+  exit
+end
+
+def parse_argv
+  modes = [:use, :remove, :status, :apply]
+  usage if ARGV.empty?
+  mode = ARGV.first.to_sym
+  usage unless modes.include? mode
+  [mode, ARGV[1], ARGV[2]]
+end
+
+def quit msg=''
+  puts msg if msg and msg.size > 0
+  exit
+end
+
+def get_hook_script git_path
+  hook_script = CommitMsgUrlShortener::HookScript.new git_path
+  if hook_script.exist?
+    quit "The language used in your #{hook_script.name} hook is not supported yet." if hook_script.interpreter.nil?
+  else
+    hook_script.create
+  end
+  hook_script
+end
+
+def get_hook_code interpreter
+  hook_code = CommitMsgUrlShortener::HOOK_CODES.select{|hook_code| hook_code.interpreter == interpreter}.first
+  if hook_code.nil? or hook_code.to_s.size == 0
+    quit "Cannot find a suitable hook for the #{interpreter} interpreter."
+  end
+  hook_code
+end
+
+mode, service_name, commit_msg_filepath = parse_argv
+git_path = CommitMsgUrlShortener::Git.toplevel
+quit "Not in a git repository." unless git_path
+hook_script = get_hook_script git_path
+hook_code = get_hook_code hook_script.interpreter
+service_name ||= CommitMsgUrlShortener::DEFAULT_SERVICE
+service = CommitMsgUrlShortener::SERVICES.select{|s| s.name == service_name}.first
+
+if mode == :use
+  quit "Missing service #{service_name.inspect}." unless service
+  hook_script.append_code hook_code.code.gsub(CommitMsgUrlShortener::HOOK_CODE_SRV_TOKEN, service.name)
+  quit "Using #{service_name.inspect}."
+elsif mode == :status
+  used_service = hook_script.get_used_service
+  quit "No service in use." unless used_service
+  quit "#{used_service.name.inspect} is in use."
+elsif mode == :remove
+  removed_lines = hook_script.remove_code
+  quit "No service in use." if removed_lines.empty?
+  quit "Removed."
+elsif mode == :apply
+  commit_msg_filepath = File.expand_path commit_msg_filepath
+  service.apply commit_msg_filepath
+end

data/commit-msg-url-shortener.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/commit-msg-url-shortener/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Daniele Molteni"]
+  gem.email         = ["dani.m.mobile@gmail.com"]
+  gem.description   = %q{Shortens the url that may appear in your commit message.}
+  gem.summary       = %q{Shortens the url that may appear in your commit message.}
+  gem.homepage      = ""
+  gem.platform      = Gem::Platform::RUBY
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   << CommitMsgUrlShortener::BIN_NAME
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = CommitMsgUrlShortener::GEM_NAME
+  gem.require_paths = ["lib"]
+  gem.version       = CommitMsgUrlShortener::VERSION
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+end

data/lib/commit-msg-url-shortener.rb

@@ -0,0 +1,22 @@
+gem_name = File.basename(__FILE__).gsub File.extname(__FILE__), ''
+require "#{gem_name}/version"
+require "#{gem_name}/hook_script"
+require "#{gem_name}/hook_code"
+require "#{gem_name}/git"
+require "#{gem_name}/service"
+require "#{gem_name}/service_helper"
+
+module CommitMsgUrlShortener
+  DEFAULT_SERVICE     = 'goo.gl'
+  HOOK_CODE_SRV_TOKEN = 'SERVICE'
+  ROOT_PATH           =  File.dirname File.expand_path(__FILE__)
+  HOOK_CODES          =  Dir[File.join ROOT_PATH, "#{GEM_NAME}/hook_codes/*.*"].map do |path|
+                          hook_code = HookCode.fabricate path
+                          path = hook_code
+                         end
+  SERVICES            =  Dir[File.join ROOT_PATH, "#{GEM_NAME}/services/*.rb"].map do |path| 
+                           service = Service.fabricate path
+                           path = service if service
+                         end.compact
+  INTERPRETERS        =  HOOK_CODES.map {|hook_code| hook_code = hook_code.interpreter}                 
+end

data/lib/commit-msg-url-shortener/git.rb

@@ -0,0 +1,10 @@
+module CommitMsgUrlShortener
+  module Git
+    extend self
+    def toplevel
+      git_path = %x[git rev-parse --show-toplevel] rescue ''
+      git_path.strip!
+      git_path if File.directory? git_path 
+    end
+  end
+end

data/lib/commit-msg-url-shortener/hook_code.rb

@@ -0,0 +1,15 @@
+module CommitMsgUrlShortener
+  class HookCode
+    attr_reader :interpreter, :code
+    def initialize interpreter, code
+      @interpreter = interpreter
+      @code = code
+    end
+
+    def self.fabricate path
+      interpreter = File.basename(path).gsub(File.extname(path), '').downcase
+      code = File.read(path).strip
+      HookCode.new interpreter, code
+    end
+  end
+end

data/lib/commit-msg-url-shortener/hook_codes/ruby.rb

@@ -0,0 +1 @@
+system "commit-msg-url-shortener apply \"SERVICE\" \"#{ARGV[0]}\""

data/lib/commit-msg-url-shortener/hook_codes/sh.sh

@@ -0,0 +1 @@
+commit-msg-url-shortener apply "SERVICE" "$1"

data/lib/commit-msg-url-shortener/hook_script.rb

@@ -0,0 +1,86 @@
+module CommitMsgUrlShortener
+  class HookScript
+    attr_reader :name
+
+    def initialize git_path
+      @name = 'commit-msg'
+      @hook_path = File.expand_path File.join(git_path, ".git/hooks/#{@name}")
+    end
+
+    def append_code code
+      remove_code
+      open('a+b') {|file| file.puts "#{code}"}
+    end
+
+    def interpreter
+      @interpreter ||= begin
+        return unless exist?
+        interpreter  = nil
+        open('rb') do |file|
+          shebang_line = ''
+          file.each_line{|line| shebang_line = line if line.index '#!'}
+          INTERPRETERS.each{|name| interpreter = name if shebang_line.downcase.index name}
+        end
+        interpreter
+      end
+    end
+    
+    def remove_code
+      new_lines = []
+      removed_lines = []
+      return removed_lines unless exist?
+      open('rb') do |file|
+        file.each_line do |line| 
+          unless line.downcase.index BIN_NAME.downcase
+            new_lines << line
+          else
+            removed_lines << line
+          end
+        end
+      end
+      open('wb') do |file|
+        new_lines.each{|line| file.puts line}
+      end
+      removed_lines
+    end
+
+    def get_used_service
+      lines_call_the_gem = []
+      service = nil
+      return service unless exist?
+      open('rb') do |file|
+        file.each_line {|line| lines_call_the_gem << line if line.downcase.index(BIN_NAME.downcase)}
+        if lines_call_the_gem.size > 1
+          raise "It appears that there are multiple calls to #{BIN_NAME} in your #{name} hook."
+        end
+        unless lines_call_the_gem.empty?
+          service = SERVICES.select{|s| lines_call_the_gem.first.include? s.name}.first
+          raise "It appears that your are using an unknow service." unless service
+        end
+      end
+      service
+    end
+
+    def exist?
+      File.exist? @hook_path
+    end
+
+    def create
+      open('wb') {|file| file.puts "#!/bin/sh"}
+      @interpreter = 'sh'
+      make_executable
+    end
+
+    private
+
+    def make_executable
+      command = 'chmod ug+x "'+@hook_path+'" >/dev/null 2>&1'
+      system_result = system(command) rescue false
+      raise "I was unable to make the file #{@hook_path} executable." unless system_result
+    end
+
+    def open mode, &block
+      File.send :open, @hook_path, mode, &block
+    end
+  end
+end

data/lib/commit-msg-url-shortener/service.rb

@@ -0,0 +1,43 @@
+module CommitMsgUrlShortener
+  class Service
+    attr_reader :name
+    def initialize name, &block
+      @name  = name
+      @block = block
+    end
+
+    def apply commit_msg_filepath
+      raise "Cannot find temporary commit message file #{commit_msg_filepath.inspect}" unless File.exist? commit_msg_filepath
+      commit_message = File.read(commit_msg_filepath).strip
+      transformed_message = ServiceHelper.module_exec(commit_message, &@block) || ''
+      transformed_message.strip!
+      if transformed_message != commit_message and transformed_message.size > 0
+        File.open(commit_msg_filepath, 'wb') {|file| file.write transformed_message}
+        transformed_message
+      else
+        nil
+      end
+    end
+
+    def self.define &block
+      if @@expected.nil? or @@expected.kind_of?(Service)
+        raise "You must load the service script using the Service#fabricate method."
+      end
+      @@expected = Service.new @@expected, &block
+    end
+
+    def self.fabricate path
+      @@expected = name_of path
+      require path
+      unless @@expected.kind_of? Service
+        puts "Warning! Service #{@@expected.inspect} should call the Service#define method."
+      else
+        @@expected
+      end
+    end
+
+    def self.name_of path
+      File.basename(path).gsub(File.extname(path), '').downcase.strip
+    end
+  end
+end

data/lib/commit-msg-url-shortener/service_helper.rb

@@ -0,0 +1,38 @@
+module CommitMsgUrlShortener
+  module ServiceHelper
+    extend self
+    require 'net/http'
+    require 'net/https'
+    require 'json'
+
+    def extract_urls text
+      regex = /(http[s]?\:\/\/[a-zA-Z0-9\-\.]+\.[\S+]+)/
+      text.scan(regex).flatten
+    end
+
+    def error_safe_request &block
+      connection_error_message = "#{CommitMsgUrlShortener::GEM_NAME} connection error! Maybe you're offline?\n"+
+                                 "In this case you should disable #{CommitMsgUrlShortener::GEM_NAME}."
+      yield
+    rescue Timeout::Error => e
+      puts connection_error_message
+    rescue SocketError => e
+      puts connection_error_message
+    end
+
+    def each_long_url text, &block
+      urls = extract_urls text
+      return text if urls.empty?
+      new_text = text
+      urls.each do |url|
+        short_url = yield(url)
+        unless short_url
+          new_text = nil
+          break
+        end
+        new_text = new_text.gsub(url, short_url)
+      end
+      new_text
+    end
+  end
+end

data/lib/commit-msg-url-shortener/services/goo.gl.rb

@@ -0,0 +1,16 @@
+CommitMsgUrlShortener::Service.define do |commit_message|
+  def call_googl_api long_url
+    error_safe_request do
+      uri = URI 'https://www.googleapis.com/urlshortener/v1/url'
+      http = Net::HTTP.new uri.host, 443
+      http.use_ssl = true
+      http.read_timeout = 3
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      resp = http.post uri.path, "{'longUrl': '#{long_url}'}", {"content-type" => "application/json"}
+      json = JSON.parse resp.body
+      json['id']
+    end
+  end
+  
+  each_long_url(commit_message) {|url| call_googl_api url}
+end

data/lib/commit-msg-url-shortener/services/is.gd.rb

@@ -0,0 +1,10 @@
+CommitMsgUrlShortener::Service.define do |commit_message|
+  def call_isgd_api long_url
+    error_safe_request do
+      uri = URI "http://is.gd/create.php?format=simple&url=#{long_url}"
+      Net::HTTP.get uri
+    end
+  end
+
+  each_long_url(commit_message) {|url| call_isgd_api url}
+end

data/lib/commit-msg-url-shortener/services/tinyurl.com.rb

@@ -0,0 +1,10 @@
+CommitMsgUrlShortener::Service.define do |commit_message|
+  def call_tinyurl_api long_url
+    error_safe_request do
+      uri = URI "http://tinyurl.com/api-create.php?url=#{long_url}"
+      Net::HTTP.get uri
+    end
+  end
+
+  each_long_url(commit_message) {|url| call_tinyurl_api url}
+end

data/lib/commit-msg-url-shortener/version.rb

@@ -0,0 +1,5 @@
+module CommitMsgUrlShortener
+  VERSION  = "0.0.1"
+  BIN_NAME = 'commit-msg-url-shortener'
+  GEM_NAME = 'commit-msg-url-shortener'
+end

data/spec/fill_me

@@ -0,0 +1 @@
+do it

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: commit-msg-url-shortener
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daniele Molteni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: 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: Shortens the url that may appear in your commit message.
+email:
+- dani.m.mobile@gmail.com
+executables:
+- commit-msg-url-shortener
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/commit-msg-url-shortener
+- commit-msg-url-shortener.gemspec
+- lib/commit-msg-url-shortener.rb
+- lib/commit-msg-url-shortener/git.rb
+- lib/commit-msg-url-shortener/hook_code.rb
+- lib/commit-msg-url-shortener/hook_codes/ruby.rb
+- lib/commit-msg-url-shortener/hook_codes/sh.sh
+- lib/commit-msg-url-shortener/hook_script.rb
+- lib/commit-msg-url-shortener/service.rb
+- lib/commit-msg-url-shortener/service_helper.rb
+- lib/commit-msg-url-shortener/services/goo.gl.rb
+- lib/commit-msg-url-shortener/services/is.gd.rb
+- lib/commit-msg-url-shortener/services/tinyurl.com.rb
+- lib/commit-msg-url-shortener/version.rb
+- spec/fill_me
+homepage: ''
+licenses: []
+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: -1375090855405394249
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1375090855405394249
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Shortens the url that may appear in your commit message.
+test_files:
+- spec/fill_me