hen 0.0.4.163 → 0.0.5.164

data/ChangeLog

@@ -1,5 +1,10 @@
 = Revision history for hen
 
+== 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')

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to hen version 0.0.4
+This documentation refers to hen version 0.0.5
 
 
 == DESCRIPTION

data/bin/hen

@@ -5,9 +5,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>                                    #
@@ -28,12 +28,64 @@
 ###############################################################################
 #++
 
-abort <<EOT
-Coming...
+# TODO: Add 'list' - List available hens with their tasks (?)
 
-Will most probably provide the following functionality:
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
 
-- config: Create a fresh .henrc file
-- create: Create a new project directory tree
-- list:   List available hens with their tasks
+require 'hen'
+require 'hen/cli'
+
+include Hen::CLI
+
+ACTIONS = {
+  'config' => 'Create a fresh .henrc file',
+  'create' => 'Create a new project directory tree',
+  'list'   => 'List available hens with their tasks'
+}
+
+USAGE = <<EOT
+Usage: #{$0} {#{ACTIONS.keys.sort.join('|')}}
+       #{$0} [-h|--help]
 EOT
+
+abort USAGE if ARGV.empty?
+
+case action = ARGV.shift
+  when '-h', '--help'
+    puts USAGE
+    puts
+    puts 'Actions:'
+
+    m = ACTIONS.keys.map { |a| a.length }.max
+
+    ACTIONS.sort.each { |a, d|
+      puts "  %-#{m}s - %s" % [a, d]
+    }
+  when 'config'
+    henrc = File.join(File.dirname(__FILE__), '..', 'example', '.henrc')
+
+    # TODO: DRY up with lib/hen.rb
+    target = File.join(ENV['HOME'] || File.expand_path('~'), '.henrc')
+
+    render(henrc, target)
+
+    puts "Your .henrc has been created: #{target}. Modify to your needs."
+  when 'create'
+    path = ARGV.shift
+    abort 'Path argument missing!' unless path
+
+    abort "Target directory already exists: #{path}. Won't touch." if File.directory?(path)
+
+    rakefile = File.join(File.dirname(__FILE__), '..', 'example', 'Rakefile')
+    target   = File.join(path, 'Rakefile')
+
+    # 1. create directory
+    Dir.mkdir(path)
+
+    # 2. copy Rakefile
+    render(rakefile, target)
+  when 'list'
+    abort 'Sorry, not yet available...'
+  else
+    abort "Illegal action: #{action}\n#{USAGE}"
+end

data/example/.henrc

@@ -1,8 +1,7 @@
 ---
 
 :rubyforge:
-  :username:          your_name
-  :project:           your_project
+  :username:          <%= ask 'Rubyforge user name (Leave empty for none)' %>
   :rdoc_dir:          :package
 
 :rdoc:
@@ -15,8 +14,8 @@
   :charset:           UTF-8
 
 :gem:
-  :author:            Your Name
-  :email:             your@email.address
+  :author:            <%= ask 'Full name' %>
+  :email:             <%= ask 'E-mail address' %>
   :has_rdoc:          true
   :append_svnversion: true
   :require_path:      lib

data/example/Rakefile

@@ -4,19 +4,21 @@ rescue LoadError
   abort "Please install the 'hen' gem first."
 end
 
-require 'lib/your_prog/version'
+PROGNAME = %q{<%= ask 'Program name' %>}
+
+require File.join('lib', PROGNAME, 'version')
 
 Hen.lay! {{
   :rubyforge => {
-    :project => 'your_project',
-    :package => 'your_prog'
+    :project => %q{<%= ask 'Rubyforge project name' %>},
+    :package => PROGNAME
   },
 
   :gem => {
-    :version      => YourProg::VERSION,
-    :summary      => 'Your super duper sample prog',
-    :files        => FileList['lib/**/*.rb', 'bin/*'].to_a,
-    :extra_files  => FileList['[A-Z]*', 'example/*'].to_a,
-    :dependencies => %w[hyper magic]
+    :version      => <%= ask 'Module/Class name' %>::VERSION,
+    :summary      => %q{<%= ask 'Program description summary' %>},
+    :files        => FileList['lib/**/*.rb'].to_a,
+    :extra_files  => FileList['[A-Z]*'].to_a,
+    :dependencies => %w[]
   }
 }}

data/lib/hen.rb

@@ -26,11 +26,11 @@
 ###############################################################################
 #++
 
-require 'rake'
 require 'yaml'
 require 'forwardable'
 
 require 'rubygems'
+require 'rake'
 require 'nuggets/proc/bind'
 
 require 'hen/dsl'

data/lib/hen/cli.rb

@@ -0,0 +1,53 @@
+#--
+###############################################################################
+#                                                                             #
+# 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
+
+  alias_method :original_ask, :ask
+  def ask(key)
+    original_ask("Please enter your #{key}: ")
+  end
+
+  def render(template, target)
+    abort "Sample file not found: #{template}" unless File.readable?(template)
+
+    if File.readable?(target)
+      abort unless agree("Target file already exists: #{target}. Overwrite? ")
+    end
+
+    File.open(target, 'w') { |f|
+      f.puts ERB.new(File.read(template)).result(binding)
+    }
+  end
+
+end

data/lib/hen/dsl.rb

@@ -86,9 +86,10 @@ class Hen
     # 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_config  = config[:rubyforge]
+      rf_project = rf_config[:project]
 
-      raise 'Skipping Rubyforge tasks' unless rf_config[:project]
+      raise 'Skipping Rubyforge tasks' if rf_project.nil? || rf_project.empty?
       raise LocalJumpError, 'no block given' unless block
 
       require 'rubyforge'

data/lib/hen/version.rb

@@ -32,7 +32,7 @@ class Hen
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 4
+    TINY  = 5
 
     class << self
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hen
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.163
+  version: 0.0.5.164
 platform: ruby
 authors: 
 - Jens Wille
@@ -43,6 +43,7 @@ extra_rdoc_files:
 files: 
 - lib/hen/version.rb
 - lib/hen/dsl.rb
+- lib/hen/cli.rb
 - lib/hen.rb
 - bin/hen
 - COPYING
@@ -63,9 +64,9 @@ rdoc_options:
 - hen Application documentation
 - --all
 - --line-numbers
-- --inline-source
 - --main
 - README
+- --inline-source
 - --charset
 - UTF-8
 require_paths: