prigner 0.1.1 → 0.2.0

data/share/templates/ruby/gem/models/Rakefile

@@ -1,145 +1,92 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
 
 require "rake/clean"
+require "rake/testtask"
+require "rake/gempackagetask"
+require "rake/rdoctask"
 require "lib/<%=project.name%>"
 
-# Helpers
+# Configurations
 # =============================================================================
 
-def rdoc(*args)
-  @rdoc ||= if Gem.available? "hanna"
-              ["hanna", "--fmt", "html", "--accessor", "option_accessor=RW", *args]
-            else
-              ["rdoc", *args]
-            end
-  sh @rdoc.join(" ")
-end
-
-def test(pattern)
-  testfiles = Dir[pattern]
-  if Gem.available? "turn"
-    sh [ "turn", *testfiles ].join(" ")
-  else
-    testfiles.each do |testfile|
-      sh "ruby #{testfile}"
-    end
-  end
+def git(cmd, *args)
+  `git #{cmd.to_s.gsub('_','-')} #{args.join(' ')}`
 end
 
 def manifest
-  @manifest ||= `git ls-files`.split("\n").sort.reject do |out|
+  @manifest ||= git(:ls_files).split("\n").sort.reject do |out|
     out =~ /^\./ || out =~ /^doc/
   end.map do |file|
     "    #{file.inspect}"
   end.join(",\n")
 end
 
-def log
-  @log ||= `git log --date=short --format='%d;%cd;%s;%b;'`
-end
-
 def version
   @version ||= <%=project.class_name%>.version
 end
 
+def tag
+  git(:tag).split("\n").last
+end
+
+def specfile
+  @specfile ||= Pathname.new("<%=project.name%>.gemspec")
+end
+
 def gemspec
-  @gemspec ||= Struct.new(:spec, :file).new
-  @gemspec.file ||= Pathname.new("<%=project.name%>.gemspec")
-  @gemspec.spec ||= eval @gemspec.file.read
-  @gemspec
+  @gemspec ||= eval(specfile.read)
 end
 
-# Documentation
+# Test
 # =============================================================================
 
-namespace :doc do
+Rake::TestTask.new do |test|
+  test.libs << "test"
+  test.test_files = FileList["test/*_test.rb"]
+  test.verbose = true
+end
 
-  CLOBBER << FileList["doc/*"]
+# Packaging
+# =============================================================================
 
-  file "doc/api/index.html" => FileList["lib/**/*.rb", "README.mkd", "CHANGELOG"] do |filespec|
-    rm_rf "doc"
-    rdoc "--op", "doc/api",
-         "--charset", "utf8",
-         "--main", "'<%=project.class_name%>'",
-         "--title", "'<%=project.class_name%> v#{version.tag} API Documentation'",
-         "--inline-source",
-         "--promiscuous",
-         "--line-numbers",
-         filespec.prerequisites.join(" ")
-  end
+Rake::GemPackageTask.new gemspec do |spec|
+  spec.need_tar = true
+end
 
-  desc "Build API documentation (doc/api)"
-  task :api => "doc/api/index.html"
-
-  desc "Creates/updates CHANGELOG file."
-  task :changelog do |spec|
-    historic = {}
-    text     = ""
-
-    log.scan(/(.*?);(.*?);(.*?);(.*?);/m) do |tag, date, subject, content|
-      
-      historic[date] = {
-        :release => "#{date} #{tag.match(/(v\d\..*)/im) ? tag : nil}",
-        :changes => []
-      } unless historic.has_key? date
-
-      historic[date][:changes] << "\n* #{subject}\n"
-      historic[date][:changes] << content.gsub(/(.*?)\n/m){"\n  #{$1}\n"} unless content.empty?
-    end
-
-    historic.keys.sort.reverse.each do |date|
-      entry = historic[date]
-      puts "Adding historic from date #{date} ..."
-      text  << <<-end_text.gsub(/^[ ]{8}/,'')
-        #{entry[:release]}
-        #{"-" * entry[:release].size}
-        #{entry[:changes]}
-      end_text
-    end
-
-    File.open("CHANGELOG", "w+") { |changelog| changelog << text }
-    puts "Historic has #{historic.keys.size} entry dates"
-    puts "Successfully updated CHANGELOG file"
-  end
+# Documentation
+# =============================================================================
 
+Rake::RDocTask.new :doc do |rdoc|
+  rdoc.main       = "<%=project.upper_camel_case_namespace%>"
+  rdoc.title      = "<%=project.upper_camel_case_namespace%> v#{version.tag} API Documentation"
+  rdoc.rdoc_dir   = "doc/api"
+  rdoc.rdoc_files = FileList["lib/**/*.rb", "README.rdoc", "CHANGELOG"]
+  rdoc.options << "--charset utf8" << "--inline-source" << "--promiscuous" << "--line-numbers"
 end
 
 # Versioning
 # =============================================================================
 
-namespace :version do
-
-  major, minor, patch, build = version.tag.split(".").map{ |key| key.to_i } << 0
-
-  desc "Dump major version"
-  task :major do
-    version.tag = "#{major+=1}.0.0"
-    version.save!
-    puts version.to_hash.to_yaml
-  end
-
-  desc "Dump minor version"
-  task :minor do
-    version.tag = "#{major}.#{minor+=1}.0"
-    version.save!
-    puts version.to_hash.to_yaml
-  end
+desc "Dump version (current v#{version.tag})."
+task :version, [:counter,:release] do |spec, args|
+  numbering = version.numbering
+  tagnames  = %w[major minor patch]
 
-  desc "Dump patch version"
-  task :patch do
-    version.tag = "#{major}.#{minor}.#{patch+=1}"
-    version.save!
-    puts version.to_hash.to_yaml
+  if index = tagnames.index(args[:counter])
+    numbering[index] += 1
+    numbering.fill(0, (index + 1)..-1)
+  else
+    numbering[-1] += 1
   end
 
-  desc "Dump build version"
-  task :build do
-    version.tag = "#{major}.#{minor}.#{patch}.#{build+=1}"
-    version.save!
-    puts version.to_hash.to_yaml
-  end
+  numbering[-1] = "#{numbering[-1]}#{args[:release]}"
+  version.tag   = numbering.join(".")
+  version.save!
+  puts version.to_hash.to_yaml
+end
 
-  desc "Update version date (current #{version.date})"
+namespace :version do
+  desc "Update version date (current #{version.date})."
   task :date, [:date] do |spec, args|
     require "parsedate"
     require "date"
@@ -149,65 +96,51 @@ namespace :version do
     puts version.to_hash.to_yaml
   end
 end
-
-task :version => "version:build"
-
-# RubyGems
+#
+# Packaging
 # =============================================================================
 
-namespace :gem do
-
-  file gemspec.file => FileList["{lib,test}/**", "Rakefile"] do
-    spec = gemspec.file.read
-
-    puts "Updating version ..."
-      spec.sub! /spec\.version\s*=\s*".*?"/,  "spec.version = #{version.tag.inspect}"
-
-    puts "Updating date of version ..."
-      spec.sub! /spec\.date\s*=\s*".*?"/,     "spec.date = #{version.date.to_s.inspect}"
+task :tagged do
+  abort "The gemspec not updated to version #{version.tag} (#{gemspec.version})" \
+    unless gemspec.version.to_s == version.tag
+  abort "The version #{version.tag} is not tagged." \
+    unless tag[1..-1] == version.tag
+end
 
-    puts "Updating file list ..."
-      spec.sub! /spec\.files\s*=\s*\[.*?\]/m, "spec.files = [\n#{manifest}\n  ]"
+file specfile => FileList["{bin,lib,test}/**", "Rakefile"] do
+  spec = specfile.read
 
-    gemspec.file.open("w+") { |file| file << spec }
+  puts "Updating version ..."
+    spec.sub! /spec\.version\s*=\s*".*?"/,  "spec.version = #{version.tag.inspect}"
 
-    puts "Successfully update #{gemspec.file} file"
-  end
+  puts "Updating date of version ..."
+    spec.sub! /spec\.date\s*=\s*".*?"/,     "spec.date = #{version.date.to_s.inspect}"
 
-  desc "Build gem package #{gemspec.spec.file_name}"
-  task :build => gemspec.file do
-    sh "gem build #{gemspec.file}"
-  end
+  puts "Updating file list ..."
+    spec.sub! /spec\.files\s*=\s*\[.*?\]/m, "spec.files = [\n#{manifest}\n  ]"
 
-  desc "Deploy gem package to RubyGems.org"
-  task :deploy => :build do
-    sh "gem push #{gemspec.spec.file_name}"
-  end
-
-  desc "Install gem package #{gemspec.spec.file_name}"
-  task :install => :build do
-    sh "gem install #{gemspec.spec.file_name} --local"
-  end
-
-  desc "Uninstall gem package #{gemspec.spec.file_name}"
-  task :uninstall do
-    sh "gem uninstall #{gemspec.spec.name} --version #{gemspec.spec.version}"
-  end
+  specfile.open("w+") { |file| file << spec }
 
+  puts "Successfully update #{specfile} file"
 end
 
-task :gem => "gem:build"
+desc "Release gem package to repositories."
+task :release => [ :tagged, :package ] do
+  sh "gem push #{package('.gem')}"
+end
 
-# Test
-# =============================================================================
+desc "Install gem package #{gemspec.file_name}."
+task :install => :package do
+  sh "gem install #{package('.gem')} --local"
+end
 
-desc "Run tests"
-task :test, [:pattern] do |spec, args|
-  test(args[:pattern] ? "test/#{args[:pattern]}_test.rb" : "test/*_test.rb")
+desc "Uninstall gem package #{gemspec.file_name}."
+task :uninstall do
+  sh "gem uninstall #{gemspec.name} --version #{gemspec.version}"
 end
 
 # Default
 # =============================================================================
 
-task :default => "test"
+task :default => :test
 

data/share/templates/ruby/gem/models/cli.rb

@@ -0,0 +1,43 @@
+# == Command-Line Interface
+#
+# This module look a command placed in CLI directory and run it.
+module <%=project.upper_camel_case_namespace%>
+
+module CLI
+
+  require "rbconfig"
+
+  # Ruby VM installed in OS.
+  def self.ruby
+    File.join(*::RbConfig::CONFIG.values_at("bindir", "ruby_install_name")) +
+    ::RbConfig::CONFIG["EXEEXT"]
+  end
+
+  # The CLI path.
+  def self.path
+    "#{<%=project.upper_camel_case_namespace%>::ROOT}/lib/<%=project.name%>/cli"
+  end
+
+  # List of commands placed in <tt>lib/prigner/cli/</tt>.
+  def self.commands
+    Dir["#{path}/*.rb"].map do |source|
+      File.basename(source, ".rb")
+    end.sort
+  end
+
+  # Source command placed in CLI directory.
+  def self.source(command)
+    "#{path}/#{command}.rb"
+  end
+
+  # Look command in *CLI* directory and execute (by exec).
+  def self.run(*args)
+    command = args.shift if commands.include? args.first
+    raise RuntimeError, "unknown command '#{args.first}'" unless command
+    exec ruby, rubyopt, source(command), *args
+  end
+
+end
+
+end
+

data/share/templates/ruby/gem/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/gem/models/gemspec

@@ -8,12 +8,14 @@ Gem::Specification.new do |spec|
   spec.author = "<%=project.author%>"
   spec.email = ""
   spec.homepage = "http://rubygems.org/gems/<%=project.name%>"
-  #spec.executables = [ "" ]
-  #spec.default_executable = ""
+<%if option.bin.enabled%>
+  #executable
+  spec.executables = [ "<%=project.name%>" ]
+  spec.default_executable = "<%=project.name%>"
   #
-
+<%end%>
   #version
-  spec.version = "0.0.1"
+  spec.version = "0.1.0"
   spec.date = "<%=date%>"
   #
 
@@ -25,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.files = [
     "CHANGELOG",
     "COPYING",
-    "README.mkd",
+    "README.rdoc",
     "Rakefile",
     "lib/<%=project.name%>.rb",
     "<%=project.name%>.gemspec",
@@ -40,7 +42,7 @@ Gem::Specification.new do |spec|
   #documentation
   spec.has_rdoc = true
   spec.extra_rdoc_files = [
-    "README.mkd",
+    "README.rdoc",
     "COPYING",
     "CHANGELOG"
   ]
@@ -56,9 +58,9 @@ Gem::Specification.new do |spec|
   spec.rubyforge_project = spec.name
   spec.post_install_message = <<-end_message.gsub(/^[ ]{4}/,'')
     #{'-'*78}
-    <%=project.class_name%> v#{spec.version}
+    <%=project.upper_camel_case_namespace%> v#{spec.version}
 
-    Thanks for use <%=project.class_name%>.
+    Thanks for use <%=project.upper_camel_case_namespace%>.
 
     #{'-'*78}
   end_message

data/share/templates/ruby/gem/models/module.rb

@@ -1,7 +1,6 @@
 #@ --- 
-#@ :tag: 0.0.1
+#@ :tag: 0.1.0
 #@ :date: <%=date%>
-#@ :milestone: Pre-Alpha
 #@ :timestamp: <%=Time.now.strftime "%F %T %z"%>
 
 # encoding: UTF-8
@@ -15,18 +14,24 @@ module <%=project.upper_camel_case_namespace%>
   require "pathname"
   require "yaml"
 
+  ROOT = File.join(File.dirname(__FILE__), "..")
+
   # Return the current version.
   def self.version
     @version ||= Version.current
   end
 
-  class Version #:nodoc:
+  # The objective of this class is to implement various ideas proposed by the
+  # Semantic Versioning Specification (see reference[http://semver.org/]).
+  class Version
 
     FILE = Pathname.new(__FILE__).freeze
 
-    attr_accessor :tag, :date, :milestone
+    attr_accessor :date, :tag
+
     attr_reader :timestamp
 
+    # Basic initialization of the attributes using a single hash.
     def initialize(attributes = {})
       attributes.each do |attribute, value|
         send("#{attribute}=", value) if respond_to? "#{attribute}="
@@ -34,17 +39,27 @@ module <%=project.upper_camel_case_namespace%>
       @timestamp = attributes[:timestamp]
     end
 
+    # The numbering of the major, minor and patch values.
+    def numbering
+      self.tag.split(".").map do |key|
+        if key.match(/^(\d{1,})(\w+).*$/)
+          [ $1.to_i, $2 ]
+        else
+          key.to_i
+        end
+      end.flatten
+    end
+
     def to_hash
-      [:tag, :date, :milestone, :timestamp].inject({}) do |hash, key|
+      [:tag, :date, :timestamp].inject({}) do |hash, key|
         hash[key] = send(key)
         hash
       end
     end
 
     def save!
-      @date = Date.today
       source = FILE.readlines
-      source[0..4] = self.to_hash.to_yaml.to_s.gsub(/^/, '#@ ')
+      source[0..3] = self.to_hash.to_yaml.to_s.gsub(/^/, '#@ ')
       FILE.open("w+") do |file|
         file << source.join("")
       end
@@ -53,7 +68,7 @@ module <%=project.upper_camel_case_namespace%>
 
     class << self
       def current
-        yaml = FILE.readlines[0..4].
+        yaml = FILE.readlines[0..3].
                  join("").
                  gsub(/\#@ /,'')
         new(YAML.load(yaml))
@@ -61,7 +76,7 @@ module <%=project.upper_camel_case_namespace%>
 
       def to_s
         name.match(/(.*?)::.*/)
-        "#{$1} v#{current.tag}, #{current.date} (#{current.milestone})"
+        "#{$1} v#{current.tag} (#{current.date})"
       end
     end # self
 

data/share/templates/ruby/gem/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/gem/specfile

@@ -1,9 +1,19 @@
-author      : Hallison Batista
-email       : hallison@codigorama.com
-version     : 0.1.0
-description : Default template for RubyGem projects
+author:
+  Hallison Batista
+email:
+  hallison@codigorama.com
+version:
+  0.2.0
+description:
+  Default template for RubyGem projects.
 
 options:
+  bin:
+    description:
+      Includes executable file.
+    files:
+      executable: bin/(project)
+      cli.rb: lib/(project)/cli.rb
 
 directories:
   - lib/(project)
@@ -12,9 +22,11 @@ directories:
 files:
   CHANGELOG:
   COPYING:
-  README.mkd:
+  README.rdoc:
   Rakefile:
-  gemspec:       (project).gemspec
-  module.rb:     lib/(project).rb
-  empty_test.rb: test/(project)_test.rb
+  gemspec: (project).gemspec
+  module.rb: lib/(project).rb
+  test.rb: test/(project)_test.rb
+  testhelper.rb: test/helper.rb
 
+# vim: filetype=yaml

data/test/builder_test.rb

@@ -2,6 +2,11 @@ require "test/unit"
 require "test/helpers"
 require "lib/prigner"
 
+def Prigner.shared_path
+  [ "#{ENV['HOME']}/.prigner/templates",
+    "#{FIXTURES}/templates/shared/templates" ]
+end
+
 class BuilderTest < Test::Unit::TestCase
 
   def setup
@@ -34,5 +39,15 @@ class BuilderTest < Test::Unit::TestCase
     end
   end
 
+  should "create optional files" do
+    options = %w[bin test]
+    options.each do |option|
+      files = @builder.make_project_files_for_option(option)
+      files.each do |file, status|
+        assert status, "File #{file} not created"
+      end
+    end
+  end
+
 end
 

data/test/fixtures/templates/shared/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/test/fixtures/templates/shared/templates/ruby/default/specfile

@@ -1,18 +1,30 @@
-author      : John Doe
-email       : john.doe@se7en.com
-version     : 0.1.0
-description : Default template for Ruby projects
+author: John Doe
+email: john.doe@se7en.com
+version: 0.1.0
+description: Default template for Ruby projects
 
 options:
-  svn: Include Subversion keywords in code.
-  git: Enable Git flags in templates.
+  svn:
+    Include Subversion keywords in code.
+  git:
+    Enable Git flags in templates.
+  bin:
+    description: Include executable file in bin/<name>.
+    files:
+      executable: bin/(project)
+      cli.rb: lib/(project)/cli.rb
+  test:
+    description: Include test files.
+    files:
+      empty_test.rb: test/(project)_test.rb
+      testhelper.rb: test/helper.rb
 
 directories:
   - test/fixtures
   - lib/(project)
 
 files:
-  README.mkd    :
-  module.rb     : lib/(project).rb
-  empty_test.rb : test/(project)_test.rb
+  README.mkd:
+  module.rb: lib/(project).rb
 
+# vim: filetype=yaml