prigner 0.1.0

data/share/templates/ruby/gem/models/gemspec

@@ -0,0 +1,67 @@
+Gem::Specification.new do |spec|
+  spec.platform = Gem::Platform::RUBY
+
+  #about
+  spec.name = "<%=project.name%>"
+  spec.summary = "Say anything about <%=project.name%>"
+  spec.description = "Describes <%=project.name%>"
+  spec.author = "<%=project.author%>"
+  spec.email = ""
+  spec.homepage = "http://rubygems.org/gems/<%=project.name%>"
+  #spec.executables = [ "" ]
+  #spec.default_executable = ""
+  #
+
+  #version
+  spec.version = "0.0.1"
+  spec.date = "<%=date%>"
+  #
+
+  #dependencies
+  #spec.add_dependency ""
+  #
+
+  #manifest
+  spec.files = [
+    "CHANGELOG",
+    "COPYING",
+    "README.mkd",
+    "Rakefile",
+    "lib/<%=project.name%>.rb",
+    "<%=project.name%>.gemspec",
+    "test/<%=project.name%>_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", "<%=project.class_name%>",
+    "--title", "<%=project.class_name%> v#{spec.version} API Documentation"
+  ]
+
+  #rubygems
+  spec.rubyforge_project = spec.name
+  spec.post_install_message = <<-end_message.gsub(/^[ ]{4}/,'')
+    #{'-'*78}
+    <%=project.class_name%> v#{spec.version}
+
+    Thanks for use <%=project.class_name%>.
+
+    #{'-'*78}
+  end_message
+  #
+end
+

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

@@ -0,0 +1,71 @@
+#@ --- 
+#@ :tag: 0.0.1
+#@ :date: <%=date%>
+#@ :milestone: Pre-Alpha
+#@ :timestamp: <%=Time.now.strftime "%F %T %z"%>
+
+# encoding: UTF-8
+
+module <%=project.upper_camel_case_namespace%>
+
+  # RubyGems
+  require "rubygems" unless $LOADED_FEATURES.include? "rubygems.rb"
+
+  # Standard library requirements
+  require "pathname"
+  require "yaml"
+
+  # 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
+
+end
+

data/share/templates/ruby/gem/specfile

@@ -0,0 +1,20 @@
+author      : Hallison Batista
+email       : hallison@codigorama.com
+version     : 0.1.0
+description : Default template for RubyGem projects
+
+options:
+
+directories:
+  - lib/(project)
+  - test/fixtures
+
+files:
+  CHANGELOG:
+  COPYING:
+  README.mkd:
+  Rakefile:
+  gemspec:       (project).gemspec
+  module.rb:     lib/(project).rb
+  empty_test.rb: test/(project)_test.rb
+

data/test/builder_test.rb

@@ -0,0 +1,38 @@
+require "test/unit"
+require "test/helpers"
+require "lib/prigner"
+
+class BuilderTest < Test::Unit::TestCase
+
+  def setup
+    @template = Prigner::Template.load(:ruby)
+    @project  = Prigner::Project.new("#{FIXTURES}/project/duck")
+    @builder  = Prigner::Builder.new(@project, @template)
+  end
+
+  def teardown
+    FileUtils.remove_dir @project.path if File.exist? @project.path
+  end
+
+  should "create project path" do
+    @builder.make_project_path.each do |path, status|
+      assert status, "Project path #{path} not created"
+    end
+  end
+
+  should "create project directories" do
+    directories = @builder.make_project_directories
+    directories.each do |directory, status|
+      assert status, "Directory #{directory} not created"
+    end
+  end
+
+  should "create project files" do
+    files = @builder.make_project_files
+    files.each do |file, status|
+      assert status, "File #{file} not created"
+    end
+  end
+
+end
+

data/test/fixtures/model.rb.erb

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+# name   : <%=name%>
+# version: <%=version%>
+# author : <%=author%>
+
+module Project
+<%for function in functions%>
+  def <%=function%>
+    # type code for <%=function%>
+  end
+<%end%>
+end

data/test/fixtures/templates/shared/ruby/default/README.mkd

@@ -0,0 +1,2 @@
+Foo
+===

data/test/fixtures/templates/shared/ruby/default/models/README.mkd

@@ -0,0 +1,2 @@
+<%=project.class_name%>
+<%='=' * project.class_name.size%>

data/test/fixtures/templates/shared/ruby/default/models/Rakefile

@@ -0,0 +1,7 @@
+<%= '# $Id$' if option.svn.enabled %>
+require "lib/<%=project.name%>"
+
+task :test do |spec, args|
+  sh "testrb -v test/*_test.rb"
+end
+

data/test/fixtures/templates/shared/ruby/default/models/empty_test.rb

@@ -0,0 +1,21 @@
+<%= '# $Id$' if option.svn.enabled %>
+BASE_PATH = "#{File.expand_path(File.dirname(__FILE__))}/.."
+
+$LOAD_PATH.unshift(BASE_PATH) unless $LOAD_PATH.include? BASE_PATH
+
+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
+

data/test/fixtures/templates/shared/ruby/default/models/module.rb

@@ -0,0 +1,6 @@
+<%= '# $Id$' if option.svn.enabled %>
+module <%=project.upper_camel_case_namespace%>
+
+  # codify
+
+end

data/test/fixtures/templates/shared/ruby/default/specfile

@@ -0,0 +1,18 @@
+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.
+
+directories:
+  - test/fixtures
+  - lib/(project)
+
+files:
+  README.mkd    :
+  module.rb     : lib/(project).rb
+  empty_test.rb : test/(project)_test.rb
+

data/test/fixtures/templates/user/ruby/program/models/README.erb

@@ -0,0 +1,2 @@
+<%=name.capitalize%>
+<%='=' * name.size%>

data/test/fixtures/templates/user/ruby/program/models/cli.rb.erb

@@ -0,0 +1,5 @@
+module <%=name.capitalize%>::CLI
+  def self.run(*args)
+    # codify
+  end
+end

data/test/fixtures/templates/user/ruby/program/models/module.rb.erb

@@ -0,0 +1,6 @@
+<%= '# $Id$' if option.svn.enabled -%>
+module <%=name.capitalize%>
+
+  # codify
+
+end

data/test/fixtures/templates/user/ruby/program/models/program.rb.erb

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+<%=name.capitalize%>::CLI.run(*ARGV)

data/test/fixtures/templates/user/ruby/program/specfile

@@ -0,0 +1,18 @@
+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.
+
+directories:
+  - test/fixtures
+  - lib/(project)
+
+files:
+  README.mkd.erb    :
+  module.rb.erb     : lib/(project).rb
+  empty_test.rb.erb : test/(project)_test.rb
+

data/test/helpers.rb

@@ -0,0 +1,22 @@
+# 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
+
+FIXTURES = File.expand_path(File.join(File.dirname(__FILE__), "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/test/model_test.rb

@@ -0,0 +1,82 @@
+require "test/unit"
+require "test/helpers"
+require "lib/prigner"
+
+class ModelTest < Test::Unit::TestCase
+
+  def setup
+    @binds    = {
+      :name    => "project",
+      :version => "0.1.0",
+      :author  => "John Doe",
+      :functions => [
+        :create,
+        :recover,
+        :update,
+        :delete
+      ]
+    }
+    @file  = "#{FIXTURES}/model-result.rb"
+    @model = Prigner::Model.new("#{FIXTURES}/model.rb.erb", @binds)
+  end
+
+  def teardown
+    File.delete(@file) if File.exist?(@file)
+  end
+
+  should "check bind values" do
+    @binds.map do |key, value|
+      assert_equal value, @model.binder.send(key)
+    end
+  end
+
+  should "build contents" do
+    @model.build!
+
+    assert_equal <<-end_result.gsub(/^[ ]{6}/, ''), @model.contents
+      #!/usr/bin/ruby
+      # name   : project
+      # version: 0.1.0
+      # author : John Doe
+
+      module Project
+
+        def create
+          # type code for create
+        end
+
+        def recover
+          # type code for recover
+        end
+
+        def update
+          # type code for update
+        end
+
+        def delete
+          # type code for delete
+        end
+
+      end
+    end_result
+  end
+
+  should "write file using contents parsed" do
+    @model.write @file
+    assert File.exist?(@file)
+    assert_equal @model.contents, File.read(@file)
+  end
+
+  should "write result file" do
+    file = "#{FIXTURES}/models/should-exist-new-project.rb"
+    @model.write file
+
+    assert_equal file, @model.file_written
+    assert_equal @model.contents, File.read(file)
+    assert File.exist?(file)
+
+    File.delete(file) 
+  end
+
+end
+

data/test/project_test.rb

@@ -0,0 +1,46 @@
+require "test/unit"
+require "test/helpers"
+require "lib/prigner"
+
+class ProjectTest < Test::Unit::TestCase
+
+  def setup
+    @project = Prigner::Project.new("#{FIXTURES}/project/ruby-tagger")
+  end
+
+  should "check basic attributes of project" do
+    assert_equal "#{FIXTURES}/project/ruby-tagger", @project.path
+    assert_equal "ruby-tagger", @project.name
+  end
+
+  should "split name" do
+    assert_equal %w{ruby tagger}, @project.name_splited
+  end
+
+  should "naming to upper camel case" do
+    assert_equal "RubyTagger", @project.upper_camel_case_name
+    assert_equal "rubyTagger", @project.lower_camel_case_name
+  end
+
+  should "naming to namespace with upper camel case" do
+    assert_equal "Ruby::Tagger", @project.upper_camel_case_namespace("::")
+    assert_equal "Ruby.Tagger",  @project.upper_camel_case_namespace(".")
+  end
+
+  should "naming to namespace with lower camel case" do
+    assert_equal "ruby::Tagger", @project.lower_camel_case_namespace("::")
+    assert_equal "ruby.Tagger",  @project.lower_camel_case_namespace(".")
+  end
+
+  should "naming to namespace with upper case" do
+    assert_equal "RUBY::TAGGER", @project.upper_case_namespace("::")
+    assert_equal "RUBY.TAGGER",  @project.upper_case_namespace(".")
+  end
+  
+  should "naming to namespace with lower case" do
+    assert_equal "ruby::tagger", @project.lower_case_namespace("::")
+    assert_equal "ruby.tagger",  @project.lower_case_namespace(".")
+  end
+
+end
+

data/test/spec_test.rb

@@ -0,0 +1,64 @@
+require "test/unit"
+require "test/helpers"
+require "lib/prigner"
+
+class SpecTest < Test::Unit::TestCase
+
+  def setup
+    @info = {
+      "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."
+    }
+    @directories = [
+      "test/fixtures",
+      "lib/(project)"
+    ]
+    @files = {
+      "README.mkd" => nil,
+      "module.rb"  => "lib/(project).rb",
+      "empty_test.rb" => "test/(project)_test.rb"
+    }
+    specfile = "#{FIXTURES}/templates/shared/ruby/default/specfile"
+    @spec = Prigner::Spec.load(specfile)
+  end
+
+  should "check basic informatio about template" do
+    @info.each do |attribute, value|
+      assert_equal value, @spec.send(attribute)
+    end
+
+    assert_equal @directories.sort, @spec.directories.sort
+
+    %w{options files}.each do |checker|
+      instance_variable_get("@#{checker}").each do |attribute, value|
+        assert_equal value, @spec.send(checker)[attribute]
+      end
+    end
+  end
+
+  should "set default values when initialize with emtpy attributes" do
+    spec = Prigner::Spec.new(nil)
+    assert_kind_of Array, spec.directories
+    assert_kind_of Hash,  spec.files
+    assert_kind_of Hash,  spec.options
+  end
+
+  should "raise runtime error if specfile is nil" do
+    assert_raises RuntimeError do
+      Prigner::Spec.load(nil)
+    end
+  end
+
+  should "raise runtime error if specfile not exist" do
+    assert_raises RuntimeError do
+      Prigner::Spec.load("not/found")
+    end
+  end
+end
+

data/test/template_test.rb

@@ -0,0 +1,88 @@
+require "test/unit"
+require "test/helpers"
+require "lib/prigner"
+
+class Prigner::Template
+  def self.shared_path
+    [ "#{FIXTURES}/templates/user",
+      "#{FIXTURES}/templates/shared" ]
+  end
+end
+
+class TemplateTest < Test::Unit::TestCase
+
+  def setup
+    @options = {
+      :svn => "Include Subversion keywords in code.",
+      :git => "Enable Git flags in templates."
+    }
+    @path         = "#{FIXTURES}/templates/shared/ruby/default"
+    @project_path = "#{FIXTURES}/project/foo"
+    @template     = Prigner::Template.new(@path)
+  end
+
+  def teardown
+    FileUtils.remove_dir @project_path if File.exist? @project_path
+  end
+
+  should "load basic attributes from directory name" do
+    assert_equal "ruby", @template.namespace
+    assert_equal "default", @template.name
+  end
+
+  should "load options" do
+    @options.keys.each do |option|
+      assert_equal @options[option], @template.options[option].description
+    end
+  end
+
+  should "disable all options by default" do
+    @options.keys.each do |option|
+      assert !@template.options[option].enabled
+    end
+  end
+
+  should "load a template using namespace" do
+    template = Prigner::Template.load(:ruby)
+    assert_equal @path, template.path.to_s
+    assert_equal "ruby", template.namespace
+    assert_equal "default", template.name
+  end
+
+  should "load a template looking home user directory" do
+    ENV['HOME'] = "#{FIXTURES}/templates/user"
+    template = Prigner::Template.load(:ruby, :program)
+    assert_equal "ruby", template.namespace
+    assert_equal "program", template.name
+  end
+
+  should "check number of models and directories" do
+    assert_equal 2, @template.directories.size
+    assert_equal 3, @template.models.size, "Models size not matched"
+  end
+
+  should "list all template paths from shared path" do
+    assert_equal 6, Prigner::Template.all_template_paths.size
+  end
+
+  should "list all templates grouped by namespace" do
+    assert_equal 3, Prigner::Template.all.keys.size
+    assert_equal 1, Prigner::Template.all["bash"].size
+    assert_equal 2, Prigner::Template.all["ruby"].size
+    assert_equal 3, Prigner::Template.all["vim"].size
+  end
+
+  should "raise runtime error when specfile not found" do
+    assert_raises RuntimeError do
+      Prigner::Template.new("not/exist")
+    end
+  end
+
+  should "raise runtime error when nil values to namespace and/or template" do
+    assert_raises RuntimeError do
+      Prigner::Template.load(nil, nil)
+    end
+  end
+
+end
+