blackwinter-hen 0.1.5

data/ChangeLog

@@ -0,0 +1,59 @@
+= Revision history for hen
+
+== 0.1.2 [2008-08-12]
+
+* Added task to update/create gemspec file (e.g., for github)
+
+== 0.1.1 [2008-07-29]
+
+* Added task to run specs with RCov
+* Added option to specify spec_helper which will be loaded first
+
+== 0.1.0 [2008-05-21]
+
+* Adjust for API change in Rubyforge 1.0.0
+
+== 0.0.9 [2008-02-29]
+
+* Handle author vs. authors in Gem hen
+
+== 0.0.8 [2008-02-15]
+
+* Fixed Gem spec (include whole example sub-tree)
+
+== 0.0.7 [2008-02-01]
+
+* Search HENPATH for available hens, allowing to easily add custom hens
+* Added sample custom hen file ('example/hens/sample.rake')
+* Refined 'gem' and 'rdoc' hens
+* Added 'hen version' command
+
+== 0.0.6 [2008-01-09]
+
+* Added basic sample project tree (skeleton for 'hen create')
+* Lazily find and load .henrc
+* Some polishing and fixes
+
+== 0.0.5 [2008-01-08]
+
+* Replaced 'hen' executable stub with something actually useful
+* Added Hen::CLI helper module
+
+== 0.0.4 [2008-01-07]
+
+* Added Test::Unit and RSpec hens (tasks 'test' and 'spec')
+* Removed HenError stuff
+
+== 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

@@ -0,0 +1,42 @@
+= hen - Just a Rake helper
+
+== VERSION
+
+This documentation refers to hen version 0.1.5
+
+
+== DESCRIPTION
+
+TODO: well, the description... ;-)
+
+
+== LINKS
+
+<b></b>
+Documentation::     <http://prometheus.rubyforge.org/hen>
+Source code (old):: <http://prometheus.rubyforge.org/svn/scratch/hen>
+Source code::       <http://github.com/blackwinter/hen>
+Rubyforge project:: <http://rubyforge.org/projects/prometheus>
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@uni-koeln.de>
+
+
+== LICENSE AND COPYRIGHT
+
+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
+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/>.

data/Rakefile

@@ -0,0 +1,18 @@
+$:.unshift('lib')
+
+require 'hen'
+
+Hen.lay! {{
+  :rubyforge => {
+    :package => 'hen'
+  },
+
+  :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.3.3']]
+  }
+}}

data/bin/hen

@@ -0,0 +1,151 @@
+#! /usr/bin/ruby
+
+#--
+###############################################################################
+#                                                                             #
+# hen -- Just a Rake helper                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 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/>.                       #
+#                                                                             #
+###############################################################################
+#++
+
+# TODO: Implement 'list' action -- List available hens with their tasks (?)
+
+require 'rubygems'
+require 'nuggets/enumerable/minmax'
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'hen'
+require 'hen/cli'
+
+include Hen::CLI
+
+ACTIONS = {
+  'config'  => 'Create a fresh .henrc file',
+  'create'  => [
+    'Create a new project directory tree',
+    'Arguments: path [sample-skeleton]'
+  ],
+  'list'    => 'List available hens with their tasks',
+  'version' => 'Display version number'
+}
+
+USAGE = <<EOT
+Usage: #{$0} {#{ACTIONS.keys.sort.join('|')}} [action-arguments]
+       #{$0} [-h|--help]
+EOT
+
+abort USAGE if ARGV.empty?
+
+EXAMPLE = File.join(File.dirname(__FILE__), '..', 'example')
+
+case action = ARGV.shift
+  when '-h', '--help'
+    puts USAGE
+    puts
+    puts 'Actions:'
+
+    max = ACTIONS.keys.max(:length)
+
+    ACTIONS.sort.each { |act, desc|
+      desc = [*desc]
+      puts "  %-#{max}s - %s" % [act, desc.shift]
+
+      desc.each { |extra|
+        puts "  %#{max}s   + %s" % [' ', extra]
+      }
+    }
+  when 'version', '--version'
+    puts "hen v#{Hen::VERSION}"
+  when 'config'
+    render(File.join(EXAMPLE, '.henrc'), henrc = Hen.henrc(true))
+
+    puts
+    puts "Your .henrc has been created: #{henrc}. Now modify it to your needs."
+  when 'create'
+    path = File.expand_path(ARGV.shift)
+    abort 'Path argument missing!' unless path
+
+    skel = ARGV.shift || File.join(EXAMPLE, 'project')
+    abort "Sample project tree not found: #{skel}" unless File.directory?(skel)
+
+    if File.directory?(path)
+      abort "Target directory already exists: #{path}. Won't touch."
+    else
+      Dir.mkdir(path)
+    end
+
+    # Parts to be replaced by the user
+    replace = {}
+
+    begin
+      # Keep track of what's been created
+      created = [path]
+
+      # We need the name here so ask for it already. Additionally, it's
+      # a good opportunity to make sure the user's .henrc is available.
+      progname = ask!("Program's name", true)
+
+      Dir.chdir(skel) {
+        Dir['**/*'].each { |sample|
+          target = File.join(path, sample.gsub(/__progname__/, progname))
+          created << target
+
+          if File.directory?(sample)
+            Dir.mkdir(target)
+          else
+            replace[target] = render(sample, target).scan(/### .* ###/)
+          end
+        }
+      }
+
+      # If we got here, everything went fine...
+      created.clear
+    ensure
+      # In case of an exception or premature program exit: Clean up!
+      created.reverse.each { |p|
+        (File.directory?(p) ? Dir : File).unlink(p) if File.readable?(p)
+      }
+    end
+
+    puts
+    puts "Your new project directory has been created: #{path}. Have fun!"
+
+    replace.each { |target, details|
+      next if details.empty?
+
+      puts
+      puts "#{target}:"
+
+      details.each { |detail|
+        puts "  #{detail}"
+      }
+    }
+  when 'list'
+    # How to achieve? Has to list *all* hens and tasks made available therein,
+    # *regardless* of any missing prerequisites (preferably indicating whether
+    # a particular hen/task is currently available).
+    abort 'Sorry, not yet available...'
+  else
+    abort "Illegal action: #{action}\n#{USAGE}"
+end

data/example/.henrc

@@ -0,0 +1,30 @@
+---
+
+:rubyforge:
+  :username:          <%= ask 'Rubyforge user name (Leave empty for none)' %>
+  :rdoc_dir:          :package
+
+:rdoc:
+  :rdoc_dir:          doc
+  :rdoc_files:        [README, COPYING, ChangeLog, lib/**/*.rb]
+  :main:              README
+  :line_numbers:      true
+  :inline_source:     true
+  :all:               true
+  :charset:           UTF-8
+
+:gem:
+  :author:            <%= ask 'Full name' %>
+  :email:             <%= ask 'E-mail address' %>
+  :has_rdoc:          true
+  :append_svnversion: true
+  :require_path:      lib
+
+:test:
+  :pattern:           test/**/*_test.rb
+
+:spec:
+  :pattern:           spec/**/*_spec.rb
+  :options:           spec.opts
+
+# vim: syntax=yaml

data/example/hens/sample.rake

@@ -0,0 +1,31 @@
+# Add File.dirname(__FILE__) to your HENPATH environment variable -- et voilà.
+
+# Meet your 'sample' hen
+Hen :sample do
+
+  # Access options set in your .henrc or project Rakefile
+  sample_options = config[:sample]
+
+  # Define your tasks
+  desc "Like some tea?"
+  task :make_tea do
+    puts <<'TEA'
+             (  )   (   )  )
+              ) (   )  (  (
+              ( )  (    ) )
+              _____________
+             <_____________> ___
+             |             |/ _ \
+             |               | | |
+             |               |_| |
+          ___|             |\___/
+         /    \___________/    \
+         \_____________________/
+
+<http://www.afn.org/~afn39695/potier.htm>
+TEA
+  end
+
+  # and so on...
+
+end

data/example/project/COPYING

@@ -0,0 +1,3 @@
+= License for <%= ask! "Program's name" %>
+
+### PLACE YOUR LICENSE TEXT HERE ###

data/example/project/ChangeLog

@@ -0,0 +1,5 @@
+= Revision history for <%= ask! "Program's name" %>
+
+== 0.0.1 [<%= Time.now.strftime('%Y-%m-%d') %>]
+
+* Birthday :-)

data/example/project/README

@@ -0,0 +1,20 @@
+= <%= ask! "Program's name" %> - <%= ask "Program's description summary" %>
+
+== VERSION
+
+This documentation refers to <%= ask! "Program's name" %> version 0.0.1
+
+
+== DESCRIPTION
+
+### PLACE YOUR DESCRIPTION HERE ###
+
+
+== AUTHORS
+
+* <%= ask "Full name", 'gem/author' %> <mailto:<%= ask "E-mail address", 'gem/email' %>>
+
+
+== LICENSE AND COPYRIGHT
+
+### PLACE YOUR COPYRIGHT NOTICE HERE ###

data/example/project/Rakefile

@@ -0,0 +1,24 @@
+require %q{lib/<%= ask! "Program's name" %>/version}
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    :rubyforge => {
+      :project => %q{<%= ask "Rubyforge project's name (Leave empty for none)" %>},
+      :package => %q{<%= ask! "Program's name" %>}
+    },
+
+    :gem => {
+      :version      => <%= ask! "Module's/Class' name" %>::VERSION,
+      :summary      => %q{<%= ask "Program's description summary" %>},
+      :files        => FileList['lib/**/*.rb'].to_a,
+      :extra_files  => FileList['[A-Z]*'].to_a,
+      :dependencies => %w[]
+    }
+  }}
+rescue LoadError
+  abort "Please install the 'hen' gem first."
+end
+
+### Place your custom Rake tasks here.

data/example/project/lib/__progname__/version.rb

@@ -0,0 +1,27 @@
+class <%= ask! "Module's/Class' name" %>
+
+  module Version
+
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end

data/example/project/lib/__progname__.rb

@@ -0,0 +1,2 @@
+class <%= ask! "Module's/Class' name" %>
+end

data/lib/hen/cli.rb

@@ -0,0 +1,85 @@
+#--
+###############################################################################
+#                                                                             #
+# hen -- Just a Rake helper                                                   #
+#                                                                             #
+# Copyright (C) 2007-2008 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/>.                       #
+#                                                                             #
+###############################################################################
+#++
+
+require 'erb'
+
+require 'rubygems'
+require 'highline/import'
+
+module Hen::CLI
+
+  # Collect user's answers by key, so we don't have to ask again.
+  @@values = {}
+
+  alias_method :original_ask, :ask
+
+  # Ask the user to enter an appropriate value for +key+. Uses
+  # already stored answer if present, unless +cached+ is false.
+  def ask(key, config_key = nil, cached = true)
+    @@values[key] = nil unless cached
+
+    @@values[key] ||= config_key && Hen.config(config_key) ||
+      original_ask("Please enter your #{key}: ")
+  rescue Interrupt
+    abort ''
+  end
+
+  # Same as #ask, but requires a non-empty value to be entered.
+  def ask!(key, config_key = nil)
+    msg = "#{key} is required! Please enter a non-empty value."
+    max = 3
+
+    max.times { |i|
+      value = ask(key, config_key, i.zero?)
+      return value unless value.empty?
+
+      puts msg
+    }
+
+    abort "You had #{max} tries -- now be gone!"
+  end
+
+  # Renders the contents of +sample+ as an ERb template,
+  # storing the result in +target+. Returns the content.
+  def render(sample, target)
+    abort "Sample file not found: #{sample}" unless File.readable?(sample)
+
+    if File.readable?(target)
+      abort unless agree("Target file already exists: #{target}. Overwrite? ")
+    end
+
+    content = ERB.new(File.read(sample)).result(binding)
+
+    File.open(target, 'w') { |f|
+      f.puts content unless content.empty?
+    }
+
+    content
+  end
+
+end

data/lib/hen/dsl.rb

@@ -0,0 +1,121 @@
+#--
+###############################################################################
+#                                                                             #
+# A component of hen, the Rake helper.                                        #
+#                                                                             #
+# Copyright (C) 2007-2008 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/>.                       #
+#                                                                             #
+###############################################################################
+#++
+
+require 'nuggets/file/which'
+
+class Hen
+
+  # Some helper methods for use inside of a Hen definition.
+  module DSL
+
+    extend self
+
+    # The Hen configuration.
+    def config
+      config = Hen.config
+
+      # always return a duplicate for a value, hence making the
+      # configuration immutable
+      def config.[](key)
+        fetch(key).dup
+      rescue IndexError
+        {}
+      end
+
+      config
+    end
+
+    # Define task +t+, but overwrite any existing task of that name!
+    # (Rake usually just adds them up)
+    def task!(t, &block)
+      Rake.application.instance_variable_get(:@tasks).delete(t.to_s)
+      task(t, &block)
+    end
+
+    # Find a command that is executable and run it. Intended for
+    # platform-dependent alternatives (Command A is not available?
+    # Then try B instead).
+    def execute(*commands)
+      if command = File.which_command(commands)
+        sh(command) { |ok, res|
+          warn "Error while executing command: #{command} " <<
+               "(return code #{res.exitstatus})" unless ok
+        }
+      else
+        warn "Command not found: #{commands.join('; ')}"
+      end
+    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.configure
+      rf.login if login
+
+      rf
+    end
+
+    # Encapsulates tasks targeting at Rubyforge, skipping those if no
+    # Rubyforge project is defined. Yields the Rubyforge configuration
+    # hash and, optionally, a proc to obtain RubyForge objects from (via
+    # +call+; reaching out to init_rubyforge).
+    def rubyforge(&block)
+      rf_config  = config[:rubyforge]
+      rf_project = rf_config[:project]
+
+      raise 'Skipping Rubyforge tasks' if rf_project.nil? || rf_project.empty?
+
+      require_rubyforge
+
+      raise LocalJumpError, 'no block given' unless block
+
+      block_args = [rf_config]
+      block_args << lambda { |*args|
+        init_rubyforge(args.empty? || args.first)
+      } if block.arity > 1
+
+      block[*block_args]
+    end
+
+    private
+
+    # Loads the Rubyforge library, giving a
+    # nicer error message if it's not found.
+    def require_rubyforge
+      begin
+        require 'rubyforge'
+      rescue LoadError
+        raise "Please install the 'rubyforge' gem first."
+      end
+    end
+
+  end
+
+end

data/lib/hen/version.rb

@@ -0,0 +1,27 @@
+class Hen
+
+  module Version
+
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 5
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end