rakegen 0.6.3

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2008 Matthew King
+
+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/Manifest

@@ -0,0 +1,15 @@
+CHANGELOG
+lib/rakegen/polite_file.rb
+lib/rakegen.rb
+LICENSE
+README
+test/helper.rb
+test/test_polite_file.rb
+test/test_rakegen.rb
+test/testdata/app/alpha/beta/five.erb
+test/testdata/app/four.erb
+test/testdata/app/one
+test/testdata/app/six.textile
+test/testdata/app/three.rb
+test/testdata/app/two.txt
+Manifest

data/README

@@ -0,0 +1,19 @@
+= Rakegen
+
+Rakegen is a Rake extension for generating and updating projects from templates.  Give Rakegen a source and a target, and it creates a rake task that will make the necessary directories and copy the template files to the target.  Rakegen processes .erb files by default, but you can register a template processing lambda for any file extension.  Because Rakegen is Rake-based, you can add your own dependencies and actions to any target file.
+
+== Usage
+
+  generator = Rakegen.new("generate:app") do |gen|
+    gen.source = "templates/application"
+    gen.target = "/Users/matthew/dev/waves/thingy"
+    gen.excludes << "**/*.yaml"
+    gen.template_assigns = {:application_name => "thingy"}
+    gen.executables = %w{ bin/waves-console  bin/waves-server }
+  end
+  
+This will define a task named, naturally enough, "generate:app".  You can invoke it in the usual way, with <tt>rake generate_app</tt>, or you can call it from Ruby:
+
+  Rake::Task["generate:app"].invoke
+  
+At the moment, Rakegen happily clobbers any copyable files with mod dates older than the associated template file.  Files produced by template processing always get clobbered.  Soon to come is a more courteous file task that asks if you want to clobber or skip.

data/lib/rakegen.rb

@@ -0,0 +1,134 @@
+require 'rubygems'
+require 'rake'
+require 'rake/tasklib'
+require 'rakegen/polite_file'
+require 'erubis'
+require "highline/import"
+
+class Rakegen < Rake::TaskLib
+  
+  # Name of the primary Rake task
+  attr_accessor :name
+  
+  attr_accessor :description
+  
+  # Directory to use as source
+  attr_writer :source
+  
+  # Directory to use as target.  Not required to exist.
+  attr_writer :target
+  
+  # List of directories that need to be created
+  attr_reader :directories
+  
+  # List of files to be copied
+  attr_accessor :copy_files
+  attr_accessor :all_files
+  attr_accessor :files
+  
+  # List of files to be processed (using, e.g. Erubis)
+  attr_accessor :template_files
+  
+  # Hash of extension => lambda
+  attr_accessor :template_processors
+  
+  # variables for use in template processing
+  attr_accessor :template_assigns
+  
+  attr_accessor :excludes
+  
+  attr_accessor :executables
+    
+  # Create a Rakegen task named <em>task_name</em>.  Default task name is +app+.
+  def initialize(name=:app)
+    @name = name
+    @excludes = []
+    @executables = []
+    @template_processors = {}
+    @template_processors["erb"] = lambda do |source_file, target_file|
+      require 'erubis'
+      File.open(target_file, 'w') do |trg|
+        File.open(source_file, 'r') do |src|
+          trg.print Erubis::Eruby.new(src.read).evaluate(template_assigns)
+        end
+      end
+    end
+    
+    yield self # if block_given?
+    
+    Dir.chdir(@source) do
+      @files = Rake::FileList.new("**/*").exclude(*@excludes).to_a
+      @directories = Rake::FileList.new("**/").map { |f| f.chomp("/") }.to_a
+    end
+  
+    
+    @template_files = @template_processors.inject([]) do |tfiles, processor|
+      ext = processor[0]
+      tfiles + @files.select { |f| f =~ /\.#{ext}$/ }
+    end
+    @copy_files = @files - @directories - @template_files
+    
+    @all_files = @files - @template_files + @template_files.map { |f| f.chomp(File.extname(f)) }
+    
+    @target_executables = @executables.map { |f| target(f) }
+    
+    define
+  end
+  
+  
+  def polite_file(args, &block)
+    PoliteFileTask.define_task(args, &block)
+  end
+  
+  # If given a path, joins it to @source.  Otherwise returns @source
+  def source(path=nil)
+    path ? File.join(@source, path) : @source
+  end
+  
+  # If given a path, joins it to @targe.  Otherwise returns @target
+  def target(path=nil)
+    path ? File.join(@target, path) : @target
+  end
+  
+  # Define the necessary Rakegen tasks
+  def define
+      desc "Create or update project using Rakegen"
+      task name => @all_files.map { |f| target(f) }
+      
+      # default is namespace(:app)
+      namespace name do
+        
+        @copy_files.each do |cf|
+          source_file, target_file = source(cf), target(cf)
+          polite_file target_file => source_file do
+            cp source_file, target_file
+          end
+        end
+        
+        @template_files.each do |tf|
+          extension = File.extname(tf)
+          source_file, target_file = source(tf), target(tf.chomp(extension))
+          block = @template_processors[extension[1..-1]]
+          polite_file target_file do
+            block.call(source_file, target_file)
+          end
+        end
+        
+        @directories.each do |file|
+          source_file, target_file = source(file), target(file)
+          directory(target_file)
+        end
+        
+        unless RUBY_PLATFORM =~ /mswin32/
+          @target_executables.each do |executable|
+            file executable do |task|
+              system "chmod +x #{task.name}"
+            end
+          end
+        end
+        
+      end
+      
+  end
+  
+end

data/lib/rakegen/polite_file.rb

@@ -0,0 +1,15 @@
+class PoliteFileTask < Rake::FileTask
+    
+  # Is this file task needed?  Yes if doesn't exist (or different content, TBI)
+  def needed?
+    return true unless File.exist?(name)
+    return confirm?
+  end
+
+  def confirm?
+    agree("Overwrite '#{name}' ?", false)
+    true
+    # will use highline stuff
+  end
+  
+end

data/rakegen.gemspec

@@ -0,0 +1,55 @@
+
+# Gem::Specification for Rakegen-0.6.3
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{rakegen}
+  s.version = "0.6.3"
+
+  s.specification_version = 2 if s.respond_to? :specification_version=
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Matthew King"]
+  s.date = %q{2008-05-14}
+  s.description = %q{Generation and updation of projects from templates.  Rake-powered, for sustainable blah blah.}
+  s.email = %q{automatthew@gmail.com}
+  s.files = ["CHANGELOG", "lib/rakegen/polite_file.rb", "lib/rakegen.rb", "LICENSE", "README", "test/helper.rb", "test/test_polite_file.rb", "test/test_rakegen.rb", "test/testdata/app/alpha/beta/five.erb", "test/testdata/app/four.erb", "test/testdata/app/one", "test/testdata/app/six.textile", "test/testdata/app/three.rb", "test/testdata/app/two.txt", "Manifest", "rakegen.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rakegen}
+  s.rubygems_version = %q{1.1.1}
+  s.summary = %q{Generation and updation of projects from templates.  Rake-powered, for sustainable blah blah.}
+  s.test_files = ["test/test_polite_file.rb", "test/test_rakegen.rb"]
+
+  s.add_dependency(%q<rake>, [">= 0"])
+  s.add_dependency(%q<erubis>, [">= 0"])
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# %w{rubygems}.each do |dep|
+#   require dep
+# end
+# 
+# Version = '0.6.3'
+# 
+# task :default => [:test]
+# 
+# begin
+#   gem 'echoe', '>=2.7'
+#   require 'echoe'
+#   Echoe.new('rakegen', Version) do |p|
+#     p.project = 'rakegen'
+#     p.summary = "Generation and updation of projects from templates.  Rake-powered, for sustainable blah blah."
+#     p.author = "Matthew King"
+#     p.email = "automatthew@gmail.com"
+#     p.ignore_pattern = /^(\.git).+/
+#     p.test_pattern = "test/test_*.rb"
+#     p.dependencies << "rake"
+#     p.dependencies << "erubis"
+#   end
+# rescue
+#   "(ignored echoe gemification, as you don't have the Right Stuff)"
+# end

data/test/helper.rb

@@ -0,0 +1,11 @@
+%w( rubygems test/spec mocha English ).each { |f| require f }
+require 'redgreen' if ENV['TM_FILENAME'].nil?
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rakegen'
+
+TEST_DIR = File.join(File.dirname(__FILE__), "testdata")
+TEST_APP = File.join(TEST_DIR, "app")
+COPY_FILE = File.join(TEST_DIR, "copy")
+CREATE_FILE = File.join(TEST_DIR, "create_only")
+TEMPLATE_FILE = File.join(TEST_DIR, "template.erb")

data/test/test_polite_file.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "helper")
+
+context "A file_copy task" do
+  
+  before(:all) do
+    File.open(COPY_FILE, "w") { |f| f.print "one" }
+  end
+  
+  before(:each) do
+    @target = File.join(TEST_DIR, "copy_target")
+    
+    @generator = Rakegen.new do |gen|
+      gen.source = "/tmp"
+      gen.target = @target
+      
+      gen.polite_file @target do
+        cp COPY_FILE, @target
+      end
+      
+    end
+  end
+  
+  after(:each) do
+    rm @target if File.exist?(@target)
+  end
+  
+  after(:all) do
+    rm COPY_FILE if File.exist?(COPY_FILE)
+  end
+  
+  
+  specify "should be needed when the file does not exist" do
+    Rake::Task[@target].needed?.should == true
+  end
+  
+  specify "should ask if file exists (no idea how to test Highline stuff)" do
+    File.open(@target, "w") { |f| f.print "two" }
+    # Rake::Task[@target].needed?.should == true
+  end
+  
+
+  
+end

data/test/test_rakegen.rb

@@ -0,0 +1,84 @@
+require File.join(File.dirname(__FILE__), "helper")
+
+context "Simple rakegen" do
+  
+  before(:each) do
+    @target = File.join(TEST_DIR, "app_target")
+    @generator = Rakegen.new("waves:app") do |gen|
+      gen.source = TEST_APP
+      gen.target = @target
+      gen.excludes << "**/two.*"
+      gen.template_assigns = {:verb => "jumped"}
+      gen.executables << "one"
+    end
+    
+    @tasks = Rake.application.tasks.map { |t| t.name }
+    
+    @directories = %w{
+      alpha
+      alpha/beta
+      alpha/gamma
+    }
+    
+    @copy_files = %w{
+      one
+      six.textile
+      three.rb
+    }
+    
+    @template_files = %w{ 
+      alpha/beta/five.erb 
+      four.erb 
+    }
+    
+  end
+  
+  after(:each) do
+    rm_r @target if File.exist?(@target)
+  end
+  
+  specify "should have all directories in the directories list" do
+    @generator.directories.to_a.should == @directories
+    # @generator.template_files.should == 1
+  end
+  
+  specify "should have all non-erb files in the copy list" do
+    @generator.copy_files.to_a.should == @copy_files
+  end
+
+  specify "should have all .erb files in the template list" do
+    @generator.template_files.should == @template_files
+  end
+  
+  specify "should have an empty excludes list" do
+    @generator.excludes.should == ["**/two.*"]
+  end
+  
+  specify "should have an executables list" do
+    @generator.executables.should == ["one"]
+  end
+  
+  specify "should have a working erb template_processor" do
+    @generator.template_processors["erb"].should.respond_to :call
+    @generator.template_processors["erb"].call("#{TEST_APP}/four.erb", "#{TEST_DIR}/catch.txt")
+    File.open("#{TEST_DIR}/catch.txt", "r").read.should == "Yossarian jumped."
+    rm "#{TEST_DIR}/catch.txt"
+  end
+  
+  specify "should copy or process all files and directories" do
+    Rake::Task["waves:app"].invoke
+    @copy_files.each do |f|
+      assert File.exist?(File.join(@target, f))
+    end
+    @directories.each do |dir|
+      assert File.directory?(@generator.target(dir))
+    end
+    @template_files.each do |tf|
+      assert File.exist?(@generator.target(tf.chomp(".erb")))
+    end
+    File.open(File.join(@target, "four"), "r").read.should == "Yossarian jumped."
+    assert File.executable?(@generator.target("one"))
+  end
+  
+    
+end

data/test/testdata/app/alpha/beta/five.erb

@@ -0,0 +1 @@
+<%= Time.now %>

data/test/testdata/app/four.erb

@@ -0,0 +1 @@
+Yossarian <%= @verb %>.

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: rakegen
+version: !ruby/object:Gem::Version 
+  version: 0.6.3
+platform: ruby
+authors: 
+- Matthew King
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-14 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: erubis
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Generation and updation of projects from templates.  Rake-powered, for sustainable blah blah.
+email: automatthew@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- CHANGELOG
+- lib/rakegen/polite_file.rb
+- lib/rakegen.rb
+- LICENSE
+- README
+- test/helper.rb
+- test/test_polite_file.rb
+- test/test_rakegen.rb
+- test/testdata/app/alpha/beta/five.erb
+- test/testdata/app/four.erb
+- test/testdata/app/one
+- test/testdata/app/six.textile
+- test/testdata/app/three.rb
+- test/testdata/app/two.txt
+- Manifest
+- rakegen.gemspec
+has_rdoc: true
+homepage: ""
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: rakegen
+rubygems_version: 1.1.1
+signing_key: 
+specification_version: 2
+summary: Generation and updation of projects from templates.  Rake-powered, for sustainable blah blah.
+test_files: 
+- test/test_polite_file.rb
+- test/test_rakegen.rb