prigner 0.1.0

data/lib/prigner.rb

@@ -0,0 +1,186 @@
+#@ --- 
+#@ :timestamp: 2009-07-16 14:05:16 -04:00
+#@ :date: 2010-10-18
+#@ :tag: 0.1.0
+#@ :milestone: Alpha
+# encoding: UTF-8
+
+# Copyright (c) 2009, 2010, Hallison Batista
+
+# The Prigner is a Projec Design Kit which help developers in DRY.
+module Prigner
+
+  # RubyGems
+  require "rubygems" unless $LOADED_FEATURES.include? "rubygems.rb"
+
+  # Standard library requirements
+  require "pathname"
+  require "optparse"
+  require "yaml"
+
+  # Internal requirements
+  require "prigner/extensions"
+
+  # Root directory for project.
+  ROOT = Pathname.new(__FILE__).dirname.join('..').expand_path.freeze
+
+  # Modules
+  autoload :Project,  "prigner/project"
+  autoload :Model,    "prigner/model"
+  autoload :Template, "prigner/template"
+  autoload :Builder,  "prigner/builder"
+  autoload :CLI,      "prigner/cli"
+
+  # Return the current version.
+  def self.version
+    @version ||= Version.current
+  end
+
+  class Version #:nodoc:
+
+    FILE = Pathname.new(__FILE__).freeze
+
+    attr_accessor :tag, :date, :milestone
+    attr_reader :timestamp
+
+    def initialize(attributes = {})
+      attributes.each do |attribute, value|
+        send("#{attribute}=", value) if respond_to? "#{attribute}="
+      end
+      @timestamp = attributes[:timestamp]
+    end
+
+    def to_hash
+      [:tag, :date, :milestone, :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(/^/, '#@ ')
+      FILE.open("w+") do |file|
+        file << source.join("")
+      end
+      self
+    end
+
+    class << self
+      def current
+        yaml = FILE.readlines[0..4].
+                 join("").
+                 gsub(/\#@ /,'')
+        new(YAML.load(yaml))
+      end
+
+      def to_s
+        name.match(/(.*?)::.*/)
+        "#{$1} v#{current.tag}, #{current.date} (#{current.milestone})"
+      end
+    end # self
+
+  end # Version
+
+  # == Specification class
+  #
+  # This class implements the basic attributes for Template specification.
+  class Spec
+
+    # Author name of template.
+    attr_reader :author
+
+    # Email for more information about template.
+    attr_reader :email
+
+    # Template version.
+    attr_reader :version
+
+    # Template description.
+    attr_reader :description
+
+    # Options that enables several features in model files.
+    attr_reader :options
+
+    # List of directories that will be created in project tree.
+    attr_reader :directories
+
+    # List of files that link a model to result file.
+    attr_reader :files
+
+    # Default values.
+    DEFAULTS = {
+      "options"     => {},
+      "directories" => [],
+      "files"       => {}
+    }
+
+    # Initialize the spec using options in Hash.
+    #
+    # Example:
+    #
+    #   Prigner::Spec.new :author  => "Anakin Skywalker",
+    #                     :email   => "anakin@tatooine.net",
+    #                     :version => "1.0.0",
+    #                     :options => {
+    #                       "lightsaber" => "Enable red light saber",
+    #                       "force"      => "Use the force"
+    #                     },
+    #                     :directories => %w{galactic/republic galactic/empire},
+    #                     :files       => {
+    #                       "son.erb"    => "jedi/luke_skywalker.knight"
+    #                       "chosen.erb" => "rebels/leia_organa.princess"
+    #                     }
+    def initialize(attributes = {})
+      DEFAULTS.update(attributes || {}).each do |attribute, value|
+        instance_variable_set "@#{attribute}", value if self.respond_to? attribute
+      end
+    end
+
+    # Load a Specfile and initialize a new Spec that be used in Template.
+    def self.load(specfile)
+      new(YAML.load_file(specfile))
+    rescue Exception => error
+      raise RuntimeError, "Unable to load Specfile."
+    end
+
+  end # Spec
+
+  # == Binder to common filters
+  #
+  # When a new Project is created, then several filters are available to use
+  # in Skel files.
+  class Binder
+
+    # Project.
+    attr_reader :project
+
+    # Template options.
+    attr_reader :options
+
+    alias option options
+
+    # The binder work binding to Project filters and Template options for use
+    # in Skel files.
+    def initialize(project, options)
+      @project, @options = project, options
+    end
+
+    def date
+      Date.today.clone
+    end
+
+    # Check if an options is enabled in Template.
+    def enabled?(option, &block)
+      yield block if @options[option].enabled
+    end
+
+    def binding #:nodoc:
+      super
+    end
+
+  end
+
+end # Prigner
+

data/prigner.gemspec

@@ -0,0 +1,120 @@
+Gem::Specification.new do |spec|
+  spec.platform = Gem::Platform::RUBY
+
+  #about
+  spec.name = "prigner"
+  spec.summary = "Project designer."
+  spec.description = "Prigner is a Project Design Kit."
+  spec.authors = ["Hallison Batista"]
+  spec.email = "hallison@codigorama.com"
+  spec.homepage = "http://codigorama.com/products/prigner"
+  spec.executables = [ "prign" ]
+  spec.default_executable = "prign"
+  #
+
+  #version
+  spec.version = "0.1.0"
+  spec.date = "2010-10-18"
+  #
+
+  #dependencies
+  #spec.add_dependency ""
+  #
+
+  #manifest
+  spec.files = [
+    "CHANGELOG",
+    "COPYING",
+    "README.mkd",
+    "Rakefile",
+    "bin/prign",
+    "lib/prigner.rb",
+    "lib/prigner/builder.rb",
+    "lib/prigner/cli.rb",
+    "lib/prigner/cli/copy.rb",
+    "lib/prigner/cli/list.rb",
+    "lib/prigner/cli/new.rb",
+    "lib/prigner/extensions.rb",
+    "lib/prigner/model.rb",
+    "lib/prigner/project.rb",
+    "lib/prigner/template.rb",
+    "prigner.gemspec",
+    "share/templates/ruby/default/models/CHANGELOG",
+    "share/templates/ruby/default/models/COPYING",
+    "share/templates/ruby/default/models/README.rdoc",
+    "share/templates/ruby/default/models/module.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/Rakefile",
+    "share/templates/ruby/gem/models/empty_test.rb",
+    "share/templates/ruby/gem/models/gemspec",
+    "share/templates/ruby/gem/models/module.rb",
+    "share/templates/ruby/gem/specfile",
+    "test/builder_test.rb",
+    "test/fixtures/model.rb.erb",
+    "test/fixtures/templates/shared/ruby/default/README.mkd",
+    "test/fixtures/templates/shared/ruby/default/models/README.mkd",
+    "test/fixtures/templates/shared/ruby/default/models/Rakefile",
+    "test/fixtures/templates/shared/ruby/default/models/empty_test.rb",
+    "test/fixtures/templates/shared/ruby/default/models/module.rb",
+    "test/fixtures/templates/shared/ruby/default/specfile",
+    "test/fixtures/templates/user/bash/default/specfile",
+    "test/fixtures/templates/user/ruby/program/models/README.erb",
+    "test/fixtures/templates/user/ruby/program/models/cli.rb.erb",
+    "test/fixtures/templates/user/ruby/program/models/module.rb.erb",
+    "test/fixtures/templates/user/ruby/program/models/program.rb.erb",
+    "test/fixtures/templates/user/ruby/program/specfile",
+    "test/fixtures/templates/user/vim/default/specfile",
+    "test/fixtures/templates/user/vim/plugin/specfile",
+    "test/fixtures/templates/user/vim/syntax/specfile",
+    "test/helpers.rb",
+    "test/model_test.rb",
+    "test/project_test.rb",
+    "test/spec_test.rb",
+    "test/template_test.rb"
+  ]
+  #
+
+  spec.test_files = spec.files.select{ |path| path =~ /^test\/*test*/ }
+
+  spec.require_paths = ["lib"]
+
+  #documentation
+  spec.has_rdoc = true
+  spec.extra_rdoc_files = [
+    "README.mkd",
+    "COPYING",
+    "CHANGELOG"
+  ]
+  spec.rdoc_options = [
+    "--inline-source",
+    "--line-numbers",
+    "--charset", "utf8",
+    "--main", "Prigner",
+    "--title", "Prigner v#{spec.version} API Documentation"
+  ]
+
+  #rubygems
+  spec.rubyforge_project = spec.name
+  spec.post_install_message = <<-end_message.gsub(/^[ ]{4}/,'')
+    #{'-'*78}
+    Prigner v#{spec.version}
+
+    Thanks for use Prigner.
+
+    Try run:
+
+    $ prign list
+
+    See all shared templates. If you want customize a template, just run:
+
+    $ prign copy <namespace>[:template]
+
+    Please, feedback in http://github.com/codigorama/prigner/issues.
+    #{'-'*78}
+  end_message
+  #
+end
+

data/share/templates/ruby/default/models/CHANGELOG

@@ -0,0 +1,13 @@
+<%=date%>
+-----------
+
+* Pre-Alpha. Project has been started.
+
+* Include basic directory tree.
+
+* Basic files have been added:
+
+  * Development tasks.
+
+  * Tests;
+

data/share/templates/ruby/default/models/COPYING

@@ -0,0 +1,21 @@
+Copyright (c) <%=date.year%> <%=project.author%>
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

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

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

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

@@ -0,0 +1,5 @@
+module <%=project.upper_camel_case_namespace%>
+
+  # codify
+
+end

data/share/templates/ruby/default/specfile

@@ -0,0 +1,16 @@
+author      : Hallison Batista
+email       : hallison@codigorama.com
+version     : 0.1.0
+description : Default template for Ruby projects
+
+options:
+
+directories:
+  - lib/(project)
+
+files:
+  CHANGELOG:
+  COPYING:
+  README.rdoc:
+  module.rb : lib/(project).rb
+

data/share/templates/ruby/gem/models/CHANGELOG

@@ -0,0 +1,13 @@
+<%=date%>
+-----------
+
+* Pre-Alpha. Project has been started.
+
+* Include basic directory tree.
+
+* Basic files have been added:
+
+  * Development tasks.
+
+  * Tests;
+

data/share/templates/ruby/gem/models/COPYING

@@ -0,0 +1,21 @@
+Copyright (c) <%=date.year%> <%=project.author%>
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

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

@@ -0,0 +1,5 @@
+<%=project.class_name%>
+<%="="*project.class_name.size%>
+
+This is my great Ruby project.
+

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

@@ -0,0 +1,213 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+
+require "rake/clean"
+require "lib/<%=project.name%>"
+
+# Helpers
+# =============================================================================
+
+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
+end
+
+def manifest
+  @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 gemspec
+  @gemspec ||= Struct.new(:spec, :file).new
+  @gemspec.file ||= Pathname.new("<%=project.name%>.gemspec")
+  @gemspec.spec ||= eval @gemspec.file.read
+  @gemspec
+end
+
+# Documentation
+# =============================================================================
+
+namespace :doc do
+
+  CLOBBER << FileList["doc/*"]
+
+  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
+
+  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
+
+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 patch version"
+  task :patch do
+    version.tag = "#{major}.#{minor}.#{patch+=1}"
+    version.save!
+    puts version.to_hash.to_yaml
+  end
+
+  desc "Dump build version"
+  task :build do
+    version.tag = "#{major}.#{minor}.#{patch}.#{build+=1}"
+    version.save!
+    puts version.to_hash.to_yaml
+  end
+
+  desc "Update version date (current #{version.date})"
+  task :date, [:date] do |spec, args|
+    require "parsedate"
+    require "date"
+    yyyy, mm, dd = ParseDate.parsedate(args[:date]).compact if args[:date]
+    version.date = (yyyy && mm && dd) ? Date.new(yyyy, mm, dd) : Date.today
+    version.save!
+    puts version.to_hash.to_yaml
+  end
+end
+
+task :version => "version:build"
+
+# RubyGems
+# =============================================================================
+
+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}"
+
+    puts "Updating file list ..."
+      spec.sub! /spec\.files\s*=\s*\[.*?\]/m, "spec.files = [\n#{manifest}\n  ]"
+
+    gemspec.file.open("w+") { |file| file << spec }
+
+    puts "Successfully update #{gemspec.file} file"
+  end
+
+  desc "Build gem package #{gemspec.spec.file_name}"
+  task :build => gemspec.file do
+    sh "gem build #{gemspec.file}"
+  end
+
+  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
+
+end
+
+task :gem => "gem:build"
+
+# Test
+# =============================================================================
+
+desc "Run tests"
+task :test, [:pattern] do |spec, args|
+  test(args[:pattern] ? "test/#{args[:pattern]}_test.rb" : "test/*_test.rb")
+end
+
+# Default
+# =============================================================================
+
+task :default => "test"
+

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

@@ -0,0 +1,16 @@
+require "test/unit"
+require "test/helpers"
+require "lib/<%=project.name%>"
+
+class <%=project.class_name%>Test < Test::Unit::TestCase
+
+  def setup
+    # start here
+  end
+
+  should "check the truth" do
+    assert true
+  end
+
+end
+