raincoat 0.1.1 → 0.2.0

data/README.markdown

@@ -28,8 +28,8 @@ root directory of your project.
 
     raincoat install
 
-At this time existing git-hooks that you have may be wiped out so be
-sure to back up any hooks that you want to save.
+Make sure to back up any existing git hooks you have first as raincoat
+will be writing its own hooks at this point.
 
 Raincoat works by looking in your script directory for the directory
 with the same name as the hook being executed, and then it runs each
@@ -38,13 +38,8 @@ executed it will look in `<script_dir>/pre-commit` and run each script
 in there.
 
 By default the script directory is set to `script` but a different
-script directory can be specified by passing it to the
-install command:
-
-    raincoat install hooks
-
-This would create a hooks directory where all of the hook scripts
-could be placed.
+script directory can be specified by defining it in the configuration
+file (see below).
 
 ## Anatomy of a Raincoat Script
 
@@ -65,6 +60,24 @@ If the `call` method returns `false` then the operation will be
 unsuccessful and git will not proceed. If it returns `true` the hook
 will have a `0` exit status so git can continue.
 
+## Configuring Raincoat
+
+Raincoat is configured through a YAML file. By default raincoat checks
+the root directory of the project for `raincoat.yml`, but a different
+configuration file can be specified when installing raincoat into the
+project by passing it to the install command
+
+    raincoat install my-config.yml
+
+Will install raincoat to read the my-config.yml configuration file.
+
+Raincoat can understand the following values in the configuration
+file.
+
+* `script_dir`: the base directory for raincoat scripts. The actual
+  scripts will be in something like `<script_dir>/precommit`
+
 ## TODO
 
 * Add support for additional git-hooks
+* Change diff passed to hooks from raw string to real object

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 
 spec = Gem::Specification.new do |s|
   s.name = 'raincoat'
-  s.version = '0.1.1'
+  s.version = '0.2.0'
   s.platform = Gem::Platform::RUBY
   s.summary = 'Easily define git-hooks that can be passed with your project'
   s.description = s.summary

data/bin/raincoat

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(raincoat_dir) unless $LOAD_PATH.include?(raincoat_dir)
 require 'raincoat'
 
 unless ARGV[0] == 'install'
-  $stderr.puts "raincoat only supports installation. Try `raincoat install <script_dir>`"
+  $stderr.puts "raincoat only supports installation. Try `raincoat install <config_file>`"
   exit 1
 end
 
-script_dir = ARGV[1] || "script"
-Raincoat::Installer.new(script_dir).install
+script_dir = ARGV[1]
+Raincoat::Installer.new.install

data/lib/raincoat/hook.rb

@@ -8,12 +8,19 @@ module Raincoat
     attr_reader :script_dir
 
     # Create a new hook object that will execute the scripts located in
-    # script_dir
+    # specified directory.
     #
-    # @param [String] script_dir the path of the directory of scripts that
-    #                 this hook executes
-    def initialize(script_dir)
-      @script_dir = script_dir
+    # @param [String] config_file the location of the file for the configuration
+    # @param [String] hook_dir the directory within the main script dir for this
+    #                 specific hook
+    def initialize(config_file, hook_dir)
+      if File.exists?(config_file)
+        config = YAML::load_file(config_file)
+      else
+        config = default_config
+      end
+      dir = config['script_dir'] || default_config['script_dir']
+      @script_dir = File.join(dir, hook_dir)
     end
 
     # This is called when the hook is executed by git's callbacks. It loads
@@ -63,5 +70,11 @@ module Raincoat
     def class_name_for(file_name)
       file_name.split(/\//).last.sub(/\.rb$/, '').split(/_/).map{ |s| s.capitalize }.join('')
     end
+
+    def default_config
+      {
+        'script_dir' => 'script'
+      }
+    end
   end
 end

data/lib/raincoat/installer.rb

@@ -7,23 +7,19 @@ module Raincoat
     # The list of currently supported hooks
     HOOKS = [ "pre-commit", "post-commit" ]
 
-    # Create an installer that watches scripts contained within script_dir
+    # Create an installer that can install hooks to read the specified config
+    # file.
     #
-    # @param [String] script_dir the path to the directory where the various
-    #                 scripts that raincoat will run are put.
-    def initialize(script_dir)
-      @script_dir = script_dir
+    # @param [String] config_file the path to the raincoat configuration file
+    def initialize(config_file = nil)
+      @config_file = config_file
     end
     
     # Install raincoat hooks in the current project for each of the supported
     # git-hook types. This will create the corresponding script directory if
     # it doesn't exist
     def install
-      unless File.directory?(@script_dir)
-        FileUtils.mkdir_p(@script_dir)
-      end
-
-      writer = ScriptWriter.new(@script_dir)
+      writer = ScriptWriter.new(@config_file)
       HOOKS.each do |hook|
         writer.write(hook)
       end

data/lib/raincoat/script_writer.rb

@@ -10,13 +10,15 @@ module Raincoat
     # The directory where git stores it's hooks
     GIT_HOOK_DIR = File.join(".git","hooks")
 
-    # Create a new ScriptWriter that creates hooks that executes the scripts
-    # in script_dir
+    # The raincoat configuration file
+    attr_writer :config_file
+
+    # Create a new ScriptWriter that creates hooks for the specified config_file
+    # If no config file is specified it will use the default of 'raincoat.yml'
     #
-    # @param [String] script_dir the path to the directory where the various
-    #                 scripts exist
-    def initialize(script_dir)
-      @script_dir = script_dir
+    # @param [String] config_file the location of the configuration file
+    def initialize(config_file = nil)
+      @config_file = config_file || 'raincoat.yml'
     end
 
     # Write a new hook to the git directory called hook_name. Also, if there
@@ -25,7 +27,6 @@ module Raincoat
     #
     # @param [String] hook_name the name of the git-hook to write this file for
     def write(hook_name)
-      init_script_directory(File.join(@script_dir, hook_name))
       path = File.join(GIT_HOOK_DIR, hook_name)
       
       if File.exists?(path)
@@ -44,18 +45,9 @@ module Raincoat
     # @param [String] hook_name the name of the git-hook to build a script for
     def build_script(hook_name)
       hook_type = hook_name.sub(/-/, '')
-      script_dir = File.join(@script_dir, hook_name)
       ERB.new(DEFAULT_TEMPLATE).result(binding)
     end
 
-    private
-
-    def init_script_directory(dir)
-      unless File.directory? dir
-        FileUtils.mkdir_p dir
-      end
-    end
-
     DEFAULT_TEMPLATE = <<TEMPLATE
 #!/usr/bin/env ruby
 require 'rubygems'
@@ -67,7 +59,7 @@ class ActiveHook < Raincoat::Hook
   end
 end
 
-exit(ActiveHook.new("<%= script_dir %>").run)
+exit(ActiveHook.new("<%= @config_file %>", "<%= hook_type %>").run)
 
 TEMPLATE
   end

data/lib/raincoat.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 require 'raincoat/hook'
 require 'raincoat/script_writer'
 require 'raincoat/installer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: raincoat
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Ryan Burrows
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 -08:00
+date: 2010-01-26 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -27,9 +27,9 @@ files:
 - Rakefile
 - bin/raincoat
 - lib/raincoat/diff_utils.rb
-- lib/raincoat/script_writer.rb
-- lib/raincoat/installer.rb
 - lib/raincoat/hook.rb
+- lib/raincoat/installer.rb
+- lib/raincoat/script_writer.rb
 - lib/raincoat.rb
 has_rdoc: true
 homepage: http://github.com/rhburrows/raincoat