hookify 0.0.1.6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Lance Pollard (lancejpollard@gmail.com) and David Crockett
+ 
+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.markdown

@@ -0,0 +1,54 @@
+# Hookify
+
+Git hooks for Ruby
+
+## Installation
+
+    sudo gem install hookify
+
+### Local Installation
+
+    git clone git@github.com:viatropos/hookify.git
+    cd hookify
+    rake install
+    
+## Usage
+
+    cd my-app
+    hookify pre-release
+    
+Add to `Gemfile` for Rails 3
+    
+    group :development do
+      gem 'hookify'
+      gem 'compressible' # as an example that uses it
+    end
+    
+... or to `environments/development.rb` for Rails 2
+
+    config.gem 'hookify'
+
+### Ruby Scripts
+
+Because Rake tasks are much slower than plain Ruby scripts, hookify by default runs a Ruby script when a git hook executes.
+
+The scripts are located in `config/hooks/hook_command_name.rb`.
+    
+### Rake Tasks (deprecated, adding later)
+
+Hookify will execute a Rake task for each of the different commands available.  Currently the list is:
+
+- `hookify pre-release` or `hookify pre_release`: setup hook that runs just before `git push`
+
+So you must just create a Rake task like this:
+
+    namespace :hookify do
+      desc "cache assets before push"
+      task :pre_release do
+        Compressible.compress("config/static_assets.yml")
+      end
+    end
+
+### Notes
+
+There are _client side_ hooks, and _server side_ hooks.  Server side include `pre-release` and `post-release`.

data/Rakefile

@@ -0,0 +1,74 @@
+require 'rake'
+require "rake/rdoctask"
+require 'rake/gempackagetask'
+
+# http://docs.rubygems.org/read/chapter/20
+spec = Gem::Specification.new do |s|
+  s.name              = "hookify"
+  s.authors           = ["Lance Pollard", "David Crockett"]
+  s.version           = "0.0.1.6"
+  s.summary           = "Hookify: Git Hooks for Ruby"
+  s.homepage          = "http://github.com/viatropos/hookify"
+  s.email             = "lancejpollard@gmail.com"
+  s.description       = "Git Hooks for Ruby"
+  s.has_rdoc          = false
+  s.executables       = ["hookify"]
+  s.rubyforge_project = "hookify"
+  s.platform          = Gem::Platform::RUBY
+  s.files             = %w(README.markdown Rakefile init.rb MIT-LICENSE) + Dir["{lib,hooks,rails,test,bin}/**/*"] - Dir["test/tmp"]
+  s.require_path      = "lib"
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec    = spec
+  pkg.package_dir = "pkg"
+end
+
+desc 'run unit tests'
+task :test do
+  exec "mkdir -p test/tmp ; ruby test/test_hookify.rb"
+end
+
+desc "Create .gemspec file (useful for github)"
+task :gemspec do
+  File.open("pkg/#{spec.name}.gemspec", "w") do |f|
+    f.puts spec.to_ruby
+  end
+end
+
+desc "Build the gem into the current directory"
+task :gem => :gemspec do
+  `gem build pkg/#{spec.name}.gemspec`
+end
+
+desc "Publish gem to rubygems"
+task :publish => [:package] do
+  %x[gem push pkg/#{spec.name}-#{spec.version}.gem]
+end
+
+desc "Print a list of the files to be put into the gem"
+task :manifest do
+  File.open("Manifest", "w") do |f|
+    spec.files.each do |file|
+      f.puts file
+    end
+  end
+end
+
+desc "Install the gem locally"
+task :install => [:package] do
+  File.mkdir("pkg") unless File.exists?("pkg")
+  sh %{sudo gem install pkg/#{spec.name}-#{spec.version} --no-ri --no-rdoc}
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.markdown", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.markdown"
+  rdoc.title = spec.summary
+end
+
+task :yank do
+  `gem yank #{spec.name} -v #{spec.version}`
+end

data/bin/hookify

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '../lib/hookify')
+
+args = ARGV.dup
+ARGV.clear
+command = args.shift.strip rescue 'help'
+
+Hookify::Command.run(command, args)

data/hooks/pre-commit

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+hook = "config/hooks/pre_commit.rb"
+puts "Running hook at '#{hook}'"
+system("ruby #{hook}") if File.exists?(hook)

data/hooks/pre-release

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# system("rake hookify:pre_release")
+
+hook = "config/hooks/pre_release.rb"
+puts "Running hook at '#{hook}'"
+system("ruby #{hook}") if File.exists?(hook)

data/init.rb

@@ -0,0 +1 @@
+File.dirname(__FILE__) + "/rails/init.rb"

data/lib/hookify.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+gem "activesupport", "= 2.3.5"
+require 'active_support'
+require 'fileutils'
+
+this = File.dirname(__FILE__)
+library = "#{this}/hookify"
+
+module Hookify
+  class << self
+    attr_accessor :root
+  end
+end
+
+Hookify.root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+
+require "#{library}/helpers"
+Dir["#{library}/commands/*"].each { |c| require c }
+require "#{library}/command"

data/lib/hookify/command.rb

@@ -0,0 +1,52 @@
+# http://progit.org/book/ch7-3.html
+module Hookify::Command
+
+  class InvalidCommand < RuntimeError; end
+  class CommandFailed  < RuntimeError; end
+  
+  extend Hookify::Helpers
+  
+  class << self
+    
+    def run(command, args)
+      begin
+        run_command(command, args.dup)
+      rescue InvalidCommand
+        error "Unknown command '#{command.to_s}'. Run 'hookify help' for usage information."
+      rescue CommandFailed => e
+        error e.message
+      rescue Interrupt => e
+        error "\n[canceled]"
+      end
+    end
+    
+    def run_command(command, args)
+      klass, method = parse(command)
+      runner = klass.new(args)
+      raise InvalidCommand unless runner.respond_to?(method)
+      runner.send(method)
+    end
+    
+    def parse(command)
+      parts = command.split(':').collect {|i| i.gsub("-", "_")}
+      case parts.size
+        when 1
+          begin
+            return "Hookify::Command::#{parts[0].camelize}".constantize, :create
+          rescue NameError, NoMethodError
+            return Hookify::Command::Base, parts[0]
+          end
+        when 2
+          begin
+            return "Hookify::Command::#{parts[0].camelize}".constantize, parts[1]
+          rescue NameError
+            raise InvalidCommand
+          end
+        else
+          raise InvalidCommand
+      end
+    end
+    
+  end
+  
+end

data/lib/hookify/commands/base.rb

@@ -0,0 +1,71 @@
+module Hookify::Command
+  class Base
+    include Hookify::Helpers
+    
+    def initialize(args)
+      
+    end
+    
+    def command_name
+      self.class.to_s.split("::").last.underscore
+    end
+    
+    def file_name
+      command_name.gsub("_", "-")
+    end
+    
+    def file_path
+      File.join(hooks_directory, file_name)
+    end
+    
+    def ruby_script_path
+      "config/hooks/#{command_name}.rb"
+    end
+    
+    def run
+      
+    end
+    
+    def remove_file
+      File.delete(file_path) if File.exists?(file_path)
+    end
+    
+    def write_file
+      script         = IO.read(File.join(Hookify.root, "hooks/#{file_name}"))
+      remove_file # temporary until I get symlinks working
+      already_exists = File.exists?(file_path)
+      
+      # make the pre-x file, only if you haven't manually created one yourself
+      unless already_exists
+        FileUtils.mkdir_p(hooks_directory)
+        File.new(file_path, "w")
+      end
+      
+      FileUtils.mkdir_p(File.dirname(ruby_script_path))
+      File.new(ruby_script_path, "w") unless File.exists?(ruby_script_path)
+      
+      display("Creating #{file_path}...\n")
+      
+      File.open(file_path, "r+") do |file|
+        content = ""
+        # if we want something like this, it needs to be more advanced
+        #if already_exists
+        #  content = file.read
+        #  content << "\n"
+        #end
+        content << script
+        file.pos = 0
+        file.print content
+        file.truncate(file.pos)
+      end
+      
+      executable(file_path)
+      
+      display("Add a rake task named 'hookify:#{command_name}'")
+    end
+    
+    class << self
+    end
+    
+  end
+end

data/lib/hookify/commands/pre_commit.rb

@@ -0,0 +1,15 @@
+module Hookify::Command
+  class PreCommit < Base
+    
+    def create
+      write_file
+      display("This runs before every 'git commit'\n")
+      true
+    end
+    
+    def destroy
+      remove_file
+    end
+    
+  end
+end

data/lib/hookify/commands/pre_release.rb

@@ -0,0 +1,15 @@
+module Hookify::Command
+  class PreRelease < Base
+    
+    def create
+      write_file
+      display("This runs before every 'git commit'\n")
+      true
+    end
+    
+    def destroy
+      remove_file
+    end
+    
+  end
+end

data/lib/hookify/helpers.rb

@@ -0,0 +1,45 @@
+module Hookify
+  module Helpers
+    def hooks_directory
+      ".git/hooks"
+    end
+    
+    def home_directory
+      running_on_windows? ? ENV['USERPROFILE'] : ENV['HOME']
+    end
+
+    def running_on_windows?
+      RUBY_PLATFORM =~ /mswin32|mingw32/
+    end
+
+    def running_on_a_mac?
+      RUBY_PLATFORM =~ /-darwin\d/
+    end
+    
+    def executable(path)
+      FileUtils.chmod(0755, path)
+    end
+
+    def display(msg, newline=true)
+      if newline
+        puts(msg)
+      else
+        print(msg)
+        STDOUT.flush
+      end
+    end
+
+    def error(msg)
+      STDERR.puts(msg)
+      # exit 1
+    end
+  end
+end
+
+unless String.method_defined?(:shellescape)
+  class String
+    def shellescape
+      empty? ? "''" : gsub(/([^A-Za-z0-9_\-.,:\/@\n])/n, '\\\\\\1').gsub(/\n/, "'\n'")
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "hookify"

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "test/unit"
+require "rubygems"
+require "ruby-debug"
+gem "activesupport", "= 2.3.5"
+require 'active_support'
+require 'shoulda'
+
+require File.join(File.dirname(__FILE__), '../lib/hookify') unless defined?(Hookify)

data/test/test_hookify.rb

@@ -0,0 +1,67 @@
+require 'fileutils'
+require File.join(File.dirname(__FILE__), 'test_helper.rb')
+
+class HookifyTest < Test::Unit::TestCase
+  
+  # helper method
+  def create_command(name)
+    @args = name.split(/\s+/) # mimic ARGV (should I stub?)
+    @command = @args[1].strip
+  end
+  
+  context "hookify processing commands" do
+    
+    setup do
+      @this = File.expand_path(Dir.pwd)
+      Dir.chdir "test/tmp"
+      system("git init")
+      Dir.chdir @this
+    end
+    
+    context "run pre-release command" do
+      
+      setup { Dir.chdir "test/tmp" }
+      
+      should "not raise an error with a valid command" do
+        create_command("hookify pre-release")
+        assert Hookify::Command.run(@command, @args)
+        assert File.exists?(".git/hooks/pre-release")
+      end
+      
+      should "be able to parse a destroy command" do
+        create_command("hookify pre-release:destroy")
+        parts = Hookify::Command.parse(@command)
+        assert_equal [Hookify::Command::PreRelease, "destroy"], parts
+      end
+      
+      should "be able to run destroy command" do
+        create_command("hookify pre-release:destroy")
+        Hookify::Command.run(@command, @args)
+        assert_equal false, File.exists?(".git/hooks/pre-release")
+      end
+      
+      teardown { Dir.chdir @this }
+      
+    end
+    
+    context "run pre-commit command" do
+
+      setup { Dir.chdir "test/tmp" }
+      
+      should "not raise an error with a valid command" do
+        create_command("hookify pre-commit")
+        assert Hookify::Command.run(@command, @args)
+        assert File.exists?(".git/hooks/pre-commit")
+      end
+
+      teardown { Dir.chdir @this }
+      
+    end
+    
+    teardown do
+      FileUtils.rm_rf("tmp/.git")
+    end
+    
+  end
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: hookify
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  - 6
+  version: 0.0.1.6
+platform: ruby
+authors: 
+- Lance Pollard
+- David Crockett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Git Hooks for Ruby
+email: lancejpollard@gmail.com
+executables: 
+- hookify
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- init.rb
+- MIT-LICENSE
+- lib/hookify/command.rb
+- lib/hookify/commands/base.rb
+- lib/hookify/commands/pre_commit.rb
+- lib/hookify/commands/pre_release.rb
+- lib/hookify/helpers.rb
+- lib/hookify.rb
+- hooks/pre-commit
+- hooks/pre-release
+- rails/init.rb
+- test/test_helper.rb
+- test/test_hookify.rb
+- bin/hookify
+has_rdoc: true
+homepage: http://github.com/viatropos/hookify
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: hookify
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: "Hookify: Git Hooks for Ruby"
+test_files: []
+