hen 0.0.2.148 → 0.0.3.149

data/ChangeLog

@@ -1,5 +1,15 @@
 = Revision history for hen
 
+== 0.0.3 [2008-01-04]
+
+* More cleanup and maturing.
+* New tasks 'release' (formerly 'upload_gem'), 'publish_docs', and 'debug_gem'
+* All in all: Pretty much inspired by Hoe ;-)
+
+== 0.0.2 [2007-12-21]
+
+* Cleanup and minor improvements
+
 == 0.0.1 [2007-12-20]
 
 * Birthday :-)

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to hen version 0.0.2
+This documentation refers to hen version 0.0.3
 
 
 == DESCRIPTION
@@ -17,7 +17,7 @@ TODO: well, the description... ;-)
 
 == LICENSE AND COPYRIGHT
 
-Copyright (C) 2007 University of Cologne,
+Copyright (C) 2007-2008 University of Cologne,
 Albertus-Magnus-Platz, 50932 Cologne, Germany
 
 hen is free software: you can redistribute it and/or modify it under the

data/Rakefile

@@ -1,21 +1,18 @@
 $:.unshift('lib')
 
 require 'hen'
-require 'hen/version'
 
-task(:doc_spec) {{
-  :title => 'hen Application documentation'
-}}
+Hen.lay! {{
+  :rubyforge => {
+    :package => 'hen'
+  },
 
-task(:gem_spec) {{
-  :name              => 'hen',
-  :version           => Hen::VERSION,
-  :rubyforge_project => 'prometheus',
-  :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,
-  :dependencies      => ['rubyforge', ['ruby-nuggets', '>= 0.0.3']]
+  :gem => {
+    :version      => Hen::VERSION,
+    :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,
+    :dependencies => ['rubyforge', ['ruby-nuggets', '>= 0.0.3']]
+  }
 }}
-
-Hen.lay!

data/example/.henrc

@@ -1,5 +1,10 @@
 ---
 
+:rubyforge:
+  :username:          your_name
+  :project:           your_project
+  :rdoc_dir:          :package
+
 :rdoc:
   :rdoc_dir:          doc
   :rdoc_files:        [README, COPYING, ChangeLog, lib/**/*.rb]

data/lib/hen.rb

@@ -3,9 +3,9 @@
 #                                                                             #
 # hen -- Just a Rake helper                                                   #
 #                                                                             #
-# Copyright (C) 2007 University of Cologne,                                   #
-#                    Albertus-Magnus-Platz,                                   #
-#                    50932 Cologne, Germany                                   #
+# Copyright (C) 2007-2008 University of Cologne,                              #
+#                         Albertus-Magnus-Platz,                              #
+#                         50932 Cologne, Germany                              #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -34,6 +34,7 @@ require 'nuggets/proc/bind'
 
 require 'hen/dsl'
 require 'hen/errors'
+require 'hen/version'
 
 class Hen
 
@@ -76,8 +77,8 @@ class Hen
 
     # call-seq:
     #   lay!
-    #   lay! :some_hen, :some_other_hen
-    #   lay! :exclude => [:some_hen, :some_other_hen]
+    #   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
@@ -88,9 +89,15 @@ class Hen
 
       @verbose = options[:verbose] if options.has_key?(:verbose)
 
+      if block_given?
+        yield.each { |key, value|
+          config[key].update(value)
+        }
+      end
+
       # Handle include/exclude requirements
-      exclude = *options[:exclude]
-      args, default = args.empty? ? [exclude || [], true] : [args, false]
+      excl = options[:exclude]
+      args, default = args.empty? ? [excl ? [*excl] : [], true] : [args, false]
 
       inclexcl = Hash.new(default)
       args.each { |arg|

data/lib/hen/dsl.rb

@@ -3,9 +3,9 @@
 #                                                                             #
 # A component of hen, the Rake helper.                                        #
 #                                                                             #
-# Copyright (C) 2007 University of Cologne,                                   #
-#                    Albertus-Magnus-Platz,                                   #
-#                    50932 Cologne, Germany                                   #
+# Copyright (C) 2007-2008 University of Cologne,                              #
+#                         Albertus-Magnus-Platz,                              #
+#                         50932 Cologne, Germany                              #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -33,15 +33,20 @@ class Hen
 
     extend self
 
-    # Call Rake task +task+. Raises HenError::TaskRequired if task is not defined.
-    def call_task(task)
-      raise HenError::TaskRequired.new(task) unless Rake::Task.task_defined?(task)
-      Rake::Task[task].invoke.first.call
-    end
-
-    # The Hen configuration.
+    # The Hen configuration. Raises HenError::ConfigRequired
+    # if a required configuration is missing.
     def config
-      Hen.config
+      config = Hen.config
+
+      # always return a duplicate for a value, hence making the
+      # configuration immutable; raise if config is missing
+      def config.[](key)
+        raise HenError::ConfigRequired.new(key) unless has_key?(key)
+
+        fetch(key).dup
+      end
+
+      config
     end
 
     # Define task +t+, but overwrite any existing task of that name!
@@ -51,6 +56,32 @@ class Hen
       task(t, &block)
     end
 
+    # Execute a series of commands until one of them succeeds. Intended for
+    # platform-dependent alternatives (Command A is not available? Then try
+    # B instead).
+    #
+    # TODO: This won't detect cases where a command is actually available,
+    # but simply fails.
+    def execute(*commands)
+      commands.each { |command|
+        ok, res = sh(command) { |ok, res| [ok, res] }
+        break if ok
+
+        warn "Error while executing command (return code #{res.exitstatus})"
+      }
+    end
+
+    # Prepare the use of Rubyforge, optionally logging in right away.
+    # Returns the RubyForge object.
+    def init_rubyforge(login = true)
+      require 'rubyforge'
+
+      rf = RubyForge.new
+      rf.login if login
+
+      rf
+    end
+
   end
 
 end

data/lib/hen/errors.rb

@@ -3,9 +3,9 @@
 #                                                                             #
 # A component of hen, the Rake helper.                                        #
 #                                                                             #
-# Copyright (C) 2007 University of Cologne,                                   #
-#                    Albertus-Magnus-Platz,                                   #
-#                    50932 Cologne, Germany                                   #
+# Copyright (C) 2007-2008 University of Cologne,                              #
+#                         Albertus-Magnus-Platz,                              #
+#                         50932 Cologne, Germany                              #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -31,21 +31,21 @@ class Hen
   # Base class for Hen errors.
   class HenError < StandardError
 
-    # Raised if a required task is missing.
-    class TaskRequired < HenError
+    # Raised if a required configuration is missing.
+    class ConfigRequired < HenError
 
       # call-seq:
-      #   new(task)
+      #   new(key)
       #
-      def initialize(task)
-        @task = task
+      def initialize(key)
+        @key = key
       end
 
       # call-seq:
       #   to_s
       #
       def to_s
-        "Required task missing: #{@task}"
+        "Required configuration missing for #{@key}"
       end
 
     end

data/lib/hen/version.rb

@@ -3,9 +3,9 @@
 #                                                                             #
 # A component of hen, the Rake helper.                                        #
 #                                                                             #
-# Copyright (C) 2007 University of Cologne,                                   #
-#                    Albertus-Magnus-Platz,                                   #
-#                    50932 Cologne, Germany                                   #
+# Copyright (C) 2007-2008 University of Cologne,                              #
+#                         Albertus-Magnus-Platz,                              #
+#                         50932 Cologne, Germany                              #
 #                                                                             #
 # Authors:                                                                    #
 #     Jens Wille <jens.wille@uni-koeln.de>                                    #
@@ -32,7 +32,7 @@ class Hen
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
 
     class << self
 

data/lib/hens/gem.rake

@@ -2,10 +2,8 @@
 Hen :gem => :rdoc do
   require 'rake/gempackagetask'
 
-  GEM_DEFAULTS = config[:gem] unless Object.const_defined?(:GEM_DEFAULTS)
-
-  # Merge defaults with user's spec
-  gem_options = GEM_DEFAULTS.merge(call_task(:gem_spec))
+  gem_options = config[:gem]
+  rubyforge   = config[:rubyforge]
 
   if Object.const_defined?(:RDOC_OPTIONS)
     gem_options[:rdoc_options] ||= RDOC_OPTIONS[:options]
@@ -14,11 +12,11 @@ Hen :gem => :rdoc do
 
   gem_spec = Gem::Specification.new { |spec|
 
-    ### dependencies
+    ### name
 
-    (gem_options.delete(:dependencies) || []).each { |dependency|
-      spec.add_dependency(*dependency)
-    }
+    gem_options[:name] ||= rubyforge[:package]
+
+    abort "Gem name missing" unless gem_options[:name]
 
     ### version
 
@@ -32,7 +30,9 @@ Hen :gem => :rdoc do
 
     gem_options[:description] ||= gem_options[:summary]
 
-    ### homepage
+    ### rubyforge project, homepage
+
+    gem_options[:rubyforge_project] ||= rubyforge[:project]
 
     if rf_project = gem_options[:rubyforge_project]
       gem_options[:homepage] ||= "#{rf_project}.rubyforge.org/#{gem_options[:name]}"
@@ -49,6 +49,12 @@ Hen :gem => :rdoc do
 
     gem_options[:executables].map! { |executable| File.basename(executable) }
 
+    ### dependencies
+
+    (gem_options.delete(:dependencies) || []).each { |dependency|
+      spec.add_dependency(*dependency)
+    }
+
     ### => set options!
 
     gem_options.each { |option, value|
@@ -67,8 +73,8 @@ Hen :gem => :rdoc do
   end
 
   desc "Package and upload the release to Rubyforge"
-  task :release => :package do
-    require 'rubyforge'
+  task :release => [:package, :publish_docs] do
+    rf = init_rubyforge
 
     files = Dir[File.join('pkg', "#{pkg_task.package_name}.*")]
     abort "Nothing to release!" if files.empty?
@@ -76,10 +82,7 @@ Hen :gem => :rdoc do
     # shorten to (at most) three digits
     version = pkg_task.version.to_s.split(/([.])/)[0..4].join
 
-    rf = RubyForge.new
-    rf.login
-
-    rf.add_release gem_spec.rubyforge_project, pkg_task.name, version, *files
+    rf.add_release rubyforge[:project], pkg_task.name, version, *files
   end
 
 end

data/lib/hens/rdoc.rake

@@ -1,28 +1,53 @@
 Hen :rdoc do
   require 'rake/rdoctask'
 
-  RDOC_DEFAULTS = config[:rdoc] unless Object.const_defined?(:RDOC_DEFAULTS)
-
-  unless Object.const_defined?(:RDOC_OPTIONS)
-    # Merge defaults with user's spec
-    opts = RDOC_DEFAULTS.merge(call_task(:doc_spec))
-
-    RDOC_OPTIONS = {
-      :rdoc_dir   => opts.delete(:rdoc_dir),
-      :rdoc_files => FileList[opts.delete(:rdoc_files)].to_a.uniq,
-      :options    => opts.map { |option, value|
-        option = '--' << option.to_s.tr('_', '-')
-        value.is_a?(String) ? [option, value] : value ? option : nil
-      }.compact.flatten
-    }
+  rdoc_options = config[:rdoc]
+  rubyforge    = config[:rubyforge]
+
+  if rf_package = rubyforge[:package]
+    rdoc_options[:title] ||= "#{rf_package} Application documentation"
   end
 
-  Rake::RDocTask.new(:doc) { |rdoc|
-    opts = RDOC_OPTIONS
+  RDOC_OPTIONS = {
+    :rdoc_dir   => rdoc_options.delete(:rdoc_dir),
+    :rdoc_files => FileList[rdoc_options.delete(:rdoc_files)].to_a.uniq,
+    :options    => rdoc_options.map { |option, value|
+      option = '--' << option.to_s.tr('_', '-')
+      value.is_a?(String) ? [option, value] : value ? option : nil
+    }.compact.flatten
+  }
 
-    rdoc.rdoc_dir   = opts[:rdoc_dir]
-    rdoc.rdoc_files = opts[:rdoc_files]
-    rdoc.options    = opts[:options]
+  rdoc_task = Rake::RDocTask.new(:doc) { |rdoc|
+    rdoc.rdoc_dir   = RDOC_OPTIONS[:rdoc_dir]
+    rdoc.rdoc_files = RDOC_OPTIONS[:rdoc_files]
+    rdoc.options    = RDOC_OPTIONS[:options]
   }
 
+  desc "Publish RDoc to Rubyforge"
+  task :publish_docs => :doc do
+    rf_project = rubyforge[:project]
+    abort "Rubyforge project name missing" unless rf_project
+
+    rf_user = rubyforge[:username]
+    abort "Rubyforge user name missing" unless rf_user
+
+    user__host = "#{rf_user}@rubyforge.org"
+
+    local_dir  = rdoc_task.rdoc_dir + '/'
+    remote_dir = "/var/www/gforge-projects/#{rf_project}/"
+
+    if rdoc_dir = rubyforge[:rdoc_dir]
+      if rf_package = rubyforge[:package]
+        rdoc_dir = rf_package if rdoc_dir == :package
+      end
+
+      remote_dir += rdoc_dir + '/'
+    end
+
+    execute(
+      "rsync -av --delete #{local_dir} #{user__host}:#{remote_dir}",
+      "scp -r #{local_dir} #{user__host}:#{remote_dir}"
+    )
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hen
 version: !ruby/object:Gem::Version 
-  version: 0.0.2.148
+  version: 0.0.3.149
 platform: ruby
 authors: 
 - Jens Wille
@@ -59,14 +59,14 @@ homepage: prometheus.rubyforge.org/hen
 post_install_message: 
 rdoc_options: 
 - --all
+- --line-numbers
+- --inline-source
+- --main
+- README
 - --charset
 - UTF-8
 - --title
 - hen Application documentation
-- --main
-- README
-- --line-numbers
-- --inline-source
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement