prigner 0.1.1 → 0.2.0

data/CHANGELOG

@@ -1,5 +1,34 @@
 = Prigner v0.1.1 (2010-10-21) - Changelog
 
+== 2010-10-27
+
+* Releasing of version 0.2.0.
+* Adding of template for Bash script.
+* Fixes in error of the emtpy directories.
+* Updates in shared templates.
+
+== 2010-10-26
+
+* Adjustments in CLI command.
+  * The 'new' command has been updated for handling of optional files. 
+  * Small fixes in CLI module.
+
+== 2010-10-25
+
+* Fixes in the parsing of optional files.
+
+== 2010-10-24
+
+* Adding of optional models.
+  * Each option can include the itself list of models. 
+  * Enhancements in library for handle the optional models.
+* More core extensions.
+
+== 2010-10-22
+
+* Fixes in the tasks for releasing of packages.
+* Checking of the tagged current version.
+
 == 2010-10-21
 
 * Releasing of version 0.1.1.

data/README.rdoc

@@ -7,14 +7,13 @@ short, a project template engine.
 
 == Features
 
-* Load and create all directories and files from templates.
+* Load and create all directories and files from template specification.
+* The template specification is parsed to command line options.
 * Default Ruby project templates.
   * Ruby Gem.
   * A simple project using setup.
-  * Script file with or without directory structure.
 * Add common tasks and libraries.
   * Tests.
-  * Deploy.
   * Code for versioning.
 
 == Installation
@@ -23,6 +22,10 @@ First, install Prigner stable through Gem:
 
   gem install prigner
 
+If you want try the developer source:
+
+  git clone http://github.com/codigorama/prigner.git
+
 == Usage
 
 Prigner create the most common Ruby projects through templates shared. To
@@ -30,55 +33,42 @@ generate new Gem project, run command using the following syntax:
 
   prign new ruby:gem foo
 
-  foo
-  |-- CHANGELOG
-  |-- COPYRIGHT
-  |-- README.mkd
-  |-- Rakefile
-  |-- bin
-  |   `-- foo
-  |-- foo.gemspec
-  |-- lib
-  |   |-- foo
+  foo/
+  |-- lib/
+  |   |-- foo/
   |   `-- foo.rb
-  `-- test
-      |-- fixtures
-      |-- foo_test.rb
-      `-- helper.rb
-
-This command will generate 'foo' Gem project structure. Or, you maybe create a
-Ruby script or a UNIX-like program.
-
-  prign new bash:script bar
-
-  bar
-  |-- bar
-  `-- barrc
+  |-- CHANGELOG
+  |-- COPYING
+  `-- README.rdoc
 
-  prign new bash:program ducklet
+This command will generate 'foo' Gem project structure. But all templates
+offers options.
 
-  ducklet
-  |-- bin
-  |   `-- ducklet
-  `-- etc
-      `-- duckletrc
+  prign new ruby:gem --test --bin
 
-== Templates
+  foo/
+  |-- bin/
+  |   `-- foo
+  |-- lib/
+  |   |-- foo/
+  |   `-- foo.rb
+  |-- test/
+  |   |-- foo_test.rb
+  |   `-- helper.rb
+  |-- CHANGELOG
+  |-- COPYING
+  `-- README.rdoc
 
-Prigner offer the following templates:
+Run <tt>prign list</tt> to view all available templates.
 
-* Ruby
-  * Default project based only library directory and common files as
-    README.rdoc, CHANGELOG
-  * Gem project that include library directory, main module, test and
-    directories for fixtures.
-  * Sinatra basic application.
+You can creates your own templates. Just save in your home directory
+<tt>~/.prigner/templates/<your-template></tt>.
 
 == Copyright
 
-Written by [Hallison Batista](http://github.com/hallison).
+Written by {Hallison Batista}[http://github.com/hallison].
 
-Prigner is Copyright (C) 2010, [Codigorama](http://codigorama.com).
+Prigner is Copyright (C) 2010, {Codigorama}[http://codigorama.com].
 
 See COPYRIGHT file for more information about license.
 

data/Rakefile

@@ -74,10 +74,9 @@ end
 # Documentation
 # =============================================================================
 
-CLOBBER << FileList["doc/*"]
+CLOBBER << FileList["doc/api/*"]
 
 file "doc/api/index.html" => FileList["lib/**/*.rb", "README.rdoc", "CHANGELOG"] do |filespec|
-  rm_rf "doc"
   rdoc "--op", "doc/api",
        "--charset", "utf8",
        "--main", "'Prigner'",
@@ -159,7 +158,10 @@ end
 CLOBBER << FileList["#{package_path.dirname}/*"]
 
 task :tagged do
-  abort "The version #{version.tag} is not tagged, yet." unless tag[1..-1] == version.tag
+  abort "The gemspec not updated to version #{version.tag} (#{spec.version})" \
+    unless spec.version.to_s == version.tag
+  abort "The version #{version.tag} is not tagged." \
+    unless tag[1..-1] == version.tag
 end
 
 file specfile => FileList["{bin,lib,test}/**", "Rakefile"] do
@@ -202,13 +204,15 @@ task :package => [package(".gem"), package(".tar.gz")]
 desc "Release gem package to repositories."
 task :release => [ :tagged, :package ] do
   sh "gem push #{package('.gem')}"
-  { :release => ".gem", :file => ".tar.gz" }.each do |file, ext|
-    sh "rubyforge add_#{file}",
-       "#{spec.rubyforge_project}",
-       "#{spec.name} #{spec.version} #{package(ext)}"
+  [%w[release .gem], %w[file .tar.gz]].each do |file, ext|
+    sh <<-endsh.gsub(/^[ ]{6}/,"")
+      rubyforge add_#{file} #{spec.rubyforge_project} #{spec.name} #{spec.version} #{package(ext)}
+    endsh
   end
   if release_notes.exist?
-    sh "rubyforge add_news 'Prigner v#{spec.version} released' '#{release_notes.read}'"
+    sh <<-endsh.gsub(/^[ ]{6}/,"")
+      rubyforge post_news #{spec.rubyforge_project} 'Prigner v#{spec.version} released' '#{release_notes.read}'
+    endsh
   end
 end
 

data/lib/prigner/builder.rb

@@ -31,15 +31,20 @@ class Prigner::Builder
     end
   end
 
-  def make_project_files #:yields: path, info
-    @template.models.inject({}) do |hash, (model, basename)|
+  def make_project_files(option = :required) #:yields: path, info
+    @template.models[option.to_sym].inject({}) do |hash, (model, basename)|
       file = basename.gsub(/\((.*?)\)/){ project.send($1) }
       path = File.join(@project.path, file)
       model.binder = Prigner::Binder.new(@project, @template.options)
       model.write(path)
       hash[no_pwd(model.file_written)] = File.stat(model.file_written)
       hash
-    end
+    end if @template.models.has_key?(option.to_sym)
+  end
+
+  def make_project_files_for_option(option)
+    @template.initialize_models_for_option(option)
+    self.make_project_files(option)
   end
 
 private

data/lib/prigner/cli/new.rb

@@ -21,17 +21,20 @@ begin
 
     end_banner
 
-    unless ARGV.empty?
-      arguments.parse!
-
+    unless ARGV.empty? or ARGV[0] =~ /^-.*?/
       name = ARGV.shift
 
-      template = Prigner::Template.load(*name.split(":"))
-
-      if template
+      if template = Prigner::Template.load(*name.split(":"))
         arguments.banner = <<-end_banner.gsub /^[ ]{10}/, ''
           #{Prigner::Version}
 
+          Template:
+            #{template.mask} v#{template.spec.version}
+
+            #{template.spec.description}
+
+            Written by #{template.spec.author} <#{template.spec.email}>.
+
           Usage:
             #{program} #{command} #{template.mask} <path> [options]
 
@@ -51,6 +54,9 @@ begin
       else
         raise RuntimeError, "unable to load template '#{name}'"
       end
+
+      arguments.parse!
+
     end
 
     path = unless ARGV.empty?
@@ -82,12 +88,28 @@ begin
 
     status.start "Creating directories" do
       builder.make_project_directories
-    end
+    end unless builder.template.directories.empty?
 
-    status.start "Writing files" do
+    status.start "Writing required files" do
       builder.make_project_files
     end
 
+    options_used = []
+    template.options.members.each do |optname|
+      option = template.options[optname]
+      if option.enabled and option.files.size > 0
+        builder.make_project_files_for_option(optname)
+        options_used << optname
+      end
+    end if template.options
+
+    for optional in options_used
+      status.start "Writing #{optional} files" do
+        builder.make_project_files_for_option(optional)
+      end
+    end
+
+
   end
 
 rescue => error

data/lib/prigner/cli.rb

@@ -39,8 +39,7 @@ module Prigner::CLI
   def self.run(*args)
     command = args.shift if commands.include? args.first
     raise RuntimeError, "unknown command '#{args.first}'" unless command
-    rubyopt = "-I#{Prigner::ROOT}/lib"
-    exec ruby, rubyopt, source(command), *args
+    exec ruby, source(command), *args
   end
 
   class Status

data/lib/prigner/extensions.rb

@@ -9,8 +9,6 @@ end
 
 class Hash
 
-  alias has? has_key?
-
   # Only symbolize all keys, including all key in sub-hashes. 
   def symbolize_keys
     return self.clone if self.empty?
@@ -58,6 +56,8 @@ class Struct
 end
 
 class Pathname
+
+  # For compatibilities with Net::HTTP.get method.
   def get(file)
     result = self.join(file.gsub(/^\/(.*?)$/){$1})
     def result.to_s
@@ -66,17 +66,29 @@ class Pathname
     result
   end
 
+  # For compatibilities with the Net::HTTPResponse.read_body method.
   alias read_body read
 
+  # For compatibilities with the Net::HTTP.address method.
   alias address expand_path
 
+  # For compatibilities with the Net::HTTP.port method.
   def port
     nil
   end
 
+  # For compatibilities with the Net::HTTP.start method.
   def start
     block_given? ? (yield self) : self
   end
 
 end
 
+class NilClass
+
+  # nil is empty? of course!
+  def empty?
+    true
+  end
+
+end

data/lib/prigner/template.rb

@@ -15,6 +15,8 @@
 # project using +specfile+.
 class Prigner::Template
 
+  Option = Struct.new(:enabled, :description, :files)
+
   # Namespace of template.
   attr_reader :namespace
 
@@ -52,7 +54,7 @@ class Prigner::Template
     initialize_options
     initialize_directories
     initialize_models
-  rescue Exception => error
+  rescue Errno::ENOENT => error
     raise RuntimeError, error.message
   end
 
@@ -90,6 +92,14 @@ class Prigner::Template
     end
   end
 
+  # If the option has list of files, then initialize all models.
+  def initialize_models_for_option(optname)
+    option = optname.to_sym
+    unless @options[option].files.empty?
+      @models[option] = parse_models(@options[option].files)
+    end
+  end
+
   private
 
   # Return the specfile placed in template path.
@@ -102,24 +112,38 @@ class Prigner::Template
     @spec = Prigner::Spec.load(specfile)
   end
 
-  # Initialize options.
+  # The "+options+" attribute is a Hash that contains a list of the Option
+  # structure.
   def initialize_options
-    @options = @spec.options.inject({}) do |options, (name, desc)|
-      options[name] = { :enabled => nil, :description => desc }
+    @options = @spec.options.inject({}) do |options, (name, params)|
+      options[name] = Option.new
+      options[name].enabled     = false
+      options[name].description = params["description"] || params
+      options[name].files       = params["files"]   || {}
       options
     end.to_struct if @spec.options
   end
 
   def initialize_directories
-    @directories = @spec.directories
+    @directories = @spec.directories || []
   end
 
+  # All models are listed by a Hash and are indexed by "+required+" key and the
+  # option names.
   def initialize_models
-    @models = @spec.files.inject({}) do |models, (source, file)|
+    @models = {}
+    @models[:required] = parse_models(@spec.files) if @spec.files
+  end
+
+  # Parses a Hash that contains a pair of the model file name and the result
+  # output name.
+  def parse_models(hash)
+    hash.inject({}) do |models, (source, file)|
       model = Prigner::Model.new(@path.join("models", source))
+      models ||= {}
       models[model] = file ? file : source
       models
-    end if @spec.files
+    end
   end
 
 end

data/lib/prigner.rb

@@ -1,7 +1,7 @@
 #@ --- 
 #@ :timestamp: 2009-07-16 14:05:16 -04:00
-#@ :date: 2010-10-21
-#@ :tag: 0.1.1
+#@ :date: 2010-10-27
+#@ :tag: 0.2.0
 # encoding: UTF-8
 
 # Copyright (c) 2009, 2010, Hallison Batista

data/prigner.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   #
 
   #version
-  spec.version = "0.1.1"
-  spec.date = "2010-10-21"
+  spec.version = "0.2.0"
+  spec.date = "2010-10-27"
   #
 
   #dependencies
@@ -40,26 +40,35 @@ Gem::Specification.new do |spec|
     "lib/prigner/project.rb",
     "lib/prigner/template.rb",
     "prigner.gemspec",
+    "share/templates/bash/default/models/script.sh",
+    "share/templates/bash/default/models/scriptrc",
+    "share/templates/bash/default/specfile",
     "share/templates/ruby/default/models/CHANGELOG",
     "share/templates/ruby/default/models/COPYING",
     "share/templates/ruby/default/models/README.rdoc",
+    "share/templates/ruby/default/models/executable",
     "share/templates/ruby/default/models/module.rb",
+    "share/templates/ruby/default/models/testhelper.rb",
     "share/templates/ruby/default/specfile",
     "share/templates/ruby/gem/models/CHANGELOG",
     "share/templates/ruby/gem/models/COPYING",
-    "share/templates/ruby/gem/models/README.mkd",
+    "share/templates/ruby/gem/models/README.rdoc",
     "share/templates/ruby/gem/models/Rakefile",
-    "share/templates/ruby/gem/models/empty_test.rb",
+    "share/templates/ruby/gem/models/cli.rb",
+    "share/templates/ruby/gem/models/executable",
     "share/templates/ruby/gem/models/gemspec",
     "share/templates/ruby/gem/models/module.rb",
+    "share/templates/ruby/gem/models/testhelper.rb",
     "share/templates/ruby/gem/specfile",
     "test/builder_test.rb",
     "test/fixtures/model.rb.erb",
-    "test/fixtures/templates/shared/templates/ruby/default/README.mkd",
     "test/fixtures/templates/shared/templates/ruby/default/models/README.mkd",
     "test/fixtures/templates/shared/templates/ruby/default/models/Rakefile",
+    "test/fixtures/templates/shared/templates/ruby/default/models/cli.rb",
     "test/fixtures/templates/shared/templates/ruby/default/models/empty_test.rb",
+    "test/fixtures/templates/shared/templates/ruby/default/models/executable",
     "test/fixtures/templates/shared/templates/ruby/default/models/module.rb",
+    "test/fixtures/templates/shared/templates/ruby/default/models/testhelper.rb",
     "test/fixtures/templates/shared/templates/ruby/default/specfile",
     "test/fixtures/templates/shared/templates/ruby/sinatra/models/README.mkd",
     "test/fixtures/templates/shared/templates/ruby/sinatra/models/Rakefile",

data/share/templates/bash/default/models/script.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+#$ <%=project.name%> v0.1.0
+#$
+#$ Usage:
+#$   <%=project.name%> [options] [args]
+#$
+#$ Options:
+#$   -h,--help      Show this message.
+#$
+
+function <%=project.name%> {
+  local path="${BASH_SOURCE%/*}/"
+
+  # This function show the message written in the header.
+  function __help {
+    local   origin="$(1<${0})"
+    local comments="${origin}"
+
+    comments="${comments#\#!*\#\$}"
+    comments="${comments%\#\$*}"
+    comments="${comments//\#\$ }"
+    comments="${comments:1:${#comments}}"
+
+    test "${comments//\$}" != "${origin}" && echo "${comments//\#\$}"
+  }
+  function _h { __help; return 0; }
+
+  if [[ ${#} -eq 0 ]]; then
+    __help
+    exit 0
+  elif [[ ${1} =~ -.|-- ]]; then
+    source $path/<%=project.name%>rc
+
+    local option=""
+
+    [[ "${1}" =~ ^-.* ]] && option=${1//-/_}
+
+    shift 1
+
+    ${option} ${@}
+  fi
+
+}
+
+<%=project.name%> ${@}

data/share/templates/bash/default/models/scriptrc

@@ -0,0 +1,2 @@
+# put the global variables in this file
+

data/share/templates/bash/default/specfile

@@ -0,0 +1,18 @@
+author:
+  Hallison Batista
+email:
+  hallison@codigorama.com
+version:
+  0.1.0
+description:
+  A simple Bash script
+
+options:
+
+directories:
+
+files:
+  script.sh: (project)
+  scriptrc: (project)rc
+
+# vim: filetype=yaml

data/share/templates/ruby/default/models/executable

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "<%=project.name%>"
+
+ARGV.options do |args|
+
+  args.on "-s", "--set VALUE", String, "Set anything" do |anything|
+    puts "Setting anything to #{anything} ..."
+  end
+
+  args.on "-a", "--anything", TrueClass, "Do anything!" do |enabled|
+    puts "Enable to doing anything ..." if enabled
+  end
+
+  unless ARGV.empty?
+    args.parse!
+  else
+    puts args
+    exit 0
+  end
+
+end

data/share/templates/ruby/default/models/testhelper.rb

@@ -0,0 +1,23 @@
+# This code extracted from book "Ruby Best Practices" and the code be found
+# in http://github.com/sandal/rbp/blob/master/testing/test_unit_extensions.rb
+
+TEST_HOME = File.expand_path(File.dirname(__FILE__)) unless defined? TEST_HOME
+FIXTURES  = File.join(TEST_HOME, "fixtures") unless defined? FIXTURES
+
+module Test::Unit
+  class TestCase
+    def self.should(description, &block)
+      test_name = "test_#{description.gsub(/\s+/,'_')}".downcase.to_sym
+      defined = instance_method(test_name) rescue false
+      raise "#{test_name} is already defined in #{self}" if defined
+      if block_given?
+        define_method(test_name, &block)
+      else
+        define_method(test_name) do
+          flunk "No implementation provided for #{description}"
+        end
+      end
+    end
+  end
+end
+

data/share/templates/ruby/default/specfile

@@ -1,9 +1,24 @@
-author      : Hallison Batista
-email       : hallison@codigorama.com
-version     : 0.1.0
-description : Default template for Ruby projects
+author:
+  Hallison Batista
+email:
+  hallison@codigorama.com
+version:
+  0.1.0
+description:
+  Default template for Ruby projects.
 
 options:
+  bin:
+    description:
+      Includes executable file.
+    files:
+      executable: bin/(project)
+  test:
+    description:
+      Includes test files.
+    files:
+      test.rb: test/(project)_test.rb
+      testhelper.rb: test/helper.rb
 
 directories:
   - lib/(project)
@@ -14,3 +29,4 @@ files:
   README.rdoc:
   module.rb : lib/(project).rb
 
+# vim: filetype=yaml

data/share/templates/ruby/gem/models/README.rdoc

@@ -0,0 +1,4 @@
+= <%=project.upper_camel_case_namespace%>
+
+This is my great Ruby project.
+