hen 0.0.1.142 → 0.0.2.144

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to hen version 0.0.1
+This documentation refers to hen version 0.0.2
 
 
 == DESCRIPTION

data/Rakefile

@@ -4,7 +4,7 @@ require 'hen'
 require 'hen/version'
 
 task(:doc_spec) {{
-  :title => 'hen Application documentation',
+  :title => 'hen Application documentation'
 }}
 
 task(:gem_spec) {{
@@ -14,7 +14,8 @@ task(:gem_spec) {{
   :summary           => "Hoe or Echoe? No, thanks! Just a Rake helper " <<
                         "that fits my own personal style.",
   :files             => FileList['lib/**/*.rb', 'bin/*'].to_a,
-  :extra_files       => FileList['[A-Z]*', 'lib/hens/*.rake', 'example/*', 'example/.henrc'].to_a
+  :extra_files       => FileList['[A-Z]*', 'lib/hens/*.rake', 'example/*', 'example/.henrc'].to_a,
+  :dependencies      => %w[rubyforge]
 }}
 
-Hen.lay
+Hen.lay!

data/example/Rakefile

@@ -20,4 +20,4 @@ task(:gem_spec) {{
   :dependencies      => %w[hyper magic]
 }}
 
-Hen.lay
+Hen.lay!

data/lib/hen.rb

@@ -30,15 +30,18 @@ require 'rake'
 require 'yaml'
 
 require 'hen/dsl'
+require 'hen/errors'
 
-module Hen
+class Hen
 
-  extend self
+  # The directory (directories?) with the hen files
+  # TODO: Replace/extend with HENPATH
+  HENS = File.join(File.dirname(__FILE__), 'hens')
 
-  HENS   = File.join(File.dirname(__FILE__), 'hens')
+  # Directories to search for .henrc
   RCDIRS = ['.', ENV['HOME'], File.expand_path('~')]
 
-  HENRC = if henrc = ENV['HENRC']
+  find_henrc = if henrc = ENV['HENRC']
     if File.readable?(henrc)
       henrc
     else
@@ -52,39 +55,152 @@ module Hen
                "Please create one first ('hen config')."
   end
 
-  @@hens   = Hash.new { |h, k| h[k] = true; false }
-  @@config = YAML.load_file(HENRC)
-
-  def create(args, &block)
-    name, dependencies = resolve_args(args)
+  # The path to the user's .henrc
+  HENRC = find_henrc
+
+  # A container for all loaded hens
+  @hens = {}
+
+  # The configuration resulting from the user's .henrc
+  @config = YAML.load_file(HENRC)
+
+  # The verbosity concerning errors and warnings
+  @verbose = true
+
+  class << self
+
+    attr_reader :hens, :config, :verbose
+
+    # call-seq:
+    #   lay!
+    #   lay! :some_hen, :some_other_hen
+    #   lay! :exclude => [:some_hen, :some_other_hen]
+    #
+    # Loads the hens, causing them to lay their eggs^H^H^Htasks. Either all,
+    # if no restrictions are specified, or the given hens, or all but those
+    # given in the <tt>:exclude</tt> option.
+    def lay!(*args)
+      # Extract potential options hash
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      @verbose = options[:verbose] if options.has_key?(:verbose)
+
+      # Handle include/exclude requirements
+      exclude = *options[:exclude]
+      args, default = args.empty? ? [exclude || [], true] : [args, false]
+
+      inclexcl = Hash.new(default)
+      args.each { |arg|
+        inclexcl[arg.to_s] = !default
+      }
+
+      # Load all available hens (as far as the
+      # include/exclude conditions are met)
+      load_hens { |hen|
+        inclexcl[hen]
+      }
+
+      # Execute each hen definition
+      hens.each { |name, hen|
+        # Load any dependencies first
+        load_hens(*hen.dependencies)
+
+        begin
+          hen.lay!
+        rescue HenError => err
+          warn "#{name}: #{err}" if verbose
+        end
+      }
+    end
 
-    raise LocalJumpError, "#{name}: no block given" unless block
+    # call-seq:
+    #  add_hen(hen, overwrite = false)
+    #
+    # Adds +hen+ to the global container. Overwrites
+    # an existing hen only if +overwrite+ is true.
+    def add_hen(hen, overwrite = false)
+      if overwrite
+        @hens[hen.name]   = hen
+      else
+        @hens[hen.name] ||= hen
+      end
+    end
 
-    return if @@hens[name]
+    private
+
+    # call-seq:
+    #   load_hens(*hens)
+    #   load_hens(*hens) { |hen_name| ... }
+    #
+    # Actually loads the hen files for +hens+, or all available if none are
+    # specified. If a block is given, only those hen files are loaded for
+    # which the block evaluates to true.
+    def load_hens(*hens, &block)
+      # By default, include all
+      block ||= lambda { true }
+
+      # No hens given means get 'em all
+      if hens.empty?
+        # TODO: Search HENPATH for available hens
+        hens = Dir[File.join(HENS, '*.rake')].map { |hen|
+          File.basename(hen, '.rake')  # This is kind of awkward, but
+                                       # simplifies condition checking
+        }
+      end
+
+      hens.each { |hen|
+        # TODO: Search HENPATH for hen
+        load File.join(HENS, "#{hen}.rake") if block[hen.to_s]
+      }
+    end
 
-    dependencies.each { |hen|
-      load File.join(HENS, "#{hen}.rake")
-    }
+  end
 
-    begin
-      block[DSL.new]
-    rescue Error => err
-      warn err.to_s
+  attr_reader :name, :dependencies, :block
+
+  # call-seq:
+  #   new(args, overwrite = false) { ... }
+  #
+  # Creates a new Hen instance of a certain name and optional
+  # dependencies; see #resolve_args for details on the +args+
+  # argument. Requires a definition block; see #lay! for details.
+  #
+  # Adds itself to the global hen container via add_hen.
+  def initialize(args, overwrite = false, &block)
+    @name, @dependencies = resolve_args(args)
+
+    unless @block = block
+      raise LocalJumpError, "#{@name}: no block given" if verbose
+      return
     end
+
+    self.class.add_hen(self, overwrite)
   end
 
-  def lay
-    Dir[File.join(Hen::HENS, '*.rake')].each { |hen|
-      load hen
-    }
+  # call-seq:
+  #   hen.lay!
+  #
+  # Runs the definition block, exposing the DSL if requested.
+  def lay!
+    block.arity == 1 ? block[DSL] : block.call
   end
 
-  def config
-    @@config
+  # call-seq:
+  #   hen.verbose
+  #
+  # Just an accessor to the class attribute.
+  def verbose
+    self.class.verbose
   end
 
   private
 
+  # call-seq:
+  #   resolve_args(args) => [name, dependencies]
+  #
+  # Splits into hen name and optional dependencies: +args+ may be a single
+  # symbol (or string), or a hash with a single key pointing to a list of
+  # hens this one depends upon.
   def resolve_args(args)
     name, dependencies = case args
       when Hash
@@ -101,23 +217,20 @@ module Hen
     [name.to_sym, dependencies.map { |d| d.to_sym }]
   end
 
-  class Error < StandardError
-  end
-
-  class TaskRequired < Error
-
-    def initialize(task)
-      @task = task
-    end
-
-    def to_s
-      "Required task missing: #{@task}"
-    end
-
-  end
-
 end
 
+# call-seq:
+#   Hen(args) { ... }
+#
+# Just forwards to Hen.new.
 def Hen(args, &block)
-  Hen.create(args, &block)
+  Hen.new(args, &block)
+end
+
+# call-seq:
+#   Hen!(args) { ... }
+#
+# Same as before, but overwrites any existing hen with the same name.
+def Hen!(args, &block)
+  Hen.new(args, true, &block)
 end

data/lib/hen/dsl.rb

@@ -26,24 +26,46 @@
 ###############################################################################
 #++
 
-module Hen
+class Hen
 
-  class DSL
+  # Some helper methods for use inside of a Hen definition.
+  module DSL
 
+    extend self
+
+    # call-seq:
+    #   hen.requires(*tasks)
+    #
+    # Specify a list of +tasks+ the hen requires to be present in
+    # actual the Rakefile. In case one of those is not available,
+    # a HenError::TaskRequired error is raised.
     def requires(*tasks)
       tasks.each { |task|
-        raise TaskRequired.new(task) unless Rake::Task.task_defined?(task)
+        raise HenError::TaskRequired.new(task) \
+          unless Rake::Task.task_defined?(task)
       }
     end
 
+    # call-seq:
+    #   hen.call(task)
+    #
+    # Short-cut to call Rake task +task+.
     def call(task)
       Rake::Task[task].invoke.first.call
     end
 
+    # call-seq:
+    #   hen.config
+    #
+    # The Hen configuration.
     def config
       Hen.config
     end
 
+    # call-seq:
+    #   hen[key]
+    #
+    # Short-cut to the config.
     def [](key)
       config[key]
     end

data/lib/hen/errors.rb

@@ -0,0 +1,55 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of hen, the Rake helper.                                        #
+#                                                                             #
+# Copyright (C) 2007 University of Cologne,                                   #
+#                    Albertus-Magnus-Platz,                                   #
+#                    50932 Cologne, Germany                                   #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <jens.wille@uni-koeln.de>                                    #
+#                                                                             #
+# hen is free software; you can redistribute it and/or modify it under the    #
+# terms of the GNU General Public License as published by the Free Software   #
+# Foundation; either version 3 of the License, or (at your option) any later  #
+# version.                                                                    #
+#                                                                             #
+# hen is distributed in the hope that it will be useful, but WITHOUT ANY      #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more       #
+# details.                                                                    #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with hen. If not, see <http://www.gnu.org/licenses/>.                       #
+#                                                                             #
+###############################################################################
+#++
+
+class Hen
+
+  # Base class for Hen errors.
+  class HenError < StandardError
+
+    # Raised if a required task is missing.
+    class TaskRequired < HenError
+
+      # call-seq:
+      #   new(task)
+      #
+      def initialize(task)
+        @task = task
+      end
+
+      # call-seq:
+      #   to_s
+      #
+      def to_s
+        "Required task missing: #{@task}"
+      end
+
+    end
+
+  end
+
+end

data/lib/hen/version.rb

@@ -26,13 +26,13 @@
 ###############################################################################
 #++
 
-module Hen
+class Hen
 
   module Version
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 1
+    TINY  = 2
 
     class << self
 

data/lib/hens/gem.rake

@@ -47,8 +47,8 @@ Hen :gem => :rdoc do |hen|
       gem_spec.bindir = File.dirname(executable_files.first)
     end
 
-    gem_spec.extra_rdoc_files =
-      gem_options.delete(:extra_rdoc_files) || rdoc_files - files
+    gem_spec.extra_rdoc_files   = gem_options.delete(:extra_rdoc_files)
+    gem_spec.extra_rdoc_files ||= rdoc_files - files if rdoc_files
 
     gem_spec.files = files + extra_files
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hen
 version: !ruby/object:Gem::Version 
-  version: 0.0.1.142
+  version: 0.0.2.144
 platform: ruby
 authors: 
 - Jens Wille
@@ -9,23 +9,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2007-12-20 00:00:00 +01:00
+date: 2007-12-21 00:00:00 +01:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: 
 email: jens.wille@uni-koeln.de
 executables: 
 - hen
 extensions: []
 
-extra_rdoc_files: 
-- README
-- COPYING
-- ChangeLog
+extra_rdoc_files: []
+
 files: 
 - lib/hen/version.rb
 - lib/hen/dsl.rb
+- lib/hen/errors.rb
 - lib/hen.rb
 - bin/hen
 - COPYING
@@ -40,15 +47,15 @@ has_rdoc: true
 homepage: prometheus.rubyforge.org/hen
 post_install_message: 
 rdoc_options: 
-- --charset
-- UTF-8
+- --all
+- --line-numbers
 - --main
 - README
-- --line-numbers
+- --inline-source
 - --title
 - hen Application documentation
-- --inline-source
-- --all
+- --charset
+- UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -66,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: prometheus
-rubygems_version: 1.0.0
+rubygems_version: 1.0.1
 signing_key: 
 specification_version: 2
 summary: Hoe or Echoe? No, thanks! Just a Rake helper that fits my own personal style.