@@ -2,6 +2,8 @@ CHANGELOG lib/rakegen/polite_file.rb lib/rakegen.rb LICENSE +Manifest +rakegen.gemspec README test/helper.rb test/test_polite_file.rb @@ -12,4 +14,3 @@ test/testdata/app/one test/testdata/app/six.textile test/testdata/app/three.rb test/testdata/app/two.txt -Manifest Manifest @@ -12,8 +12,8 @@ Rakegen is a Rake extension for generating and updating projects from templates. 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: +This will define a task named, naturally enough, "generate:app". If you define the generator in a rakefile, you can run it with <tt>rake generate:app</tt>. If you're building your own executable, 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. \ No newline at end of file + generator.invoke + +Rakegen asks you before clobbering existing files. \ No newline at end of file README @@ -2,7 +2,7 @@ require dep end -Version = '0.6.5' +Version = '0.6.6' task :default => [:test] @@ -14,6 +14,7 @@ begin 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.url = "http://rakegen.rubyforge.org" p.ignore_pattern = /^(\.git).+/ p.test_pattern = "test/test_*.rb" p.dependencies << "rake" Rakefile @@ -39,9 +39,26 @@ class Rakegen < Rake::TaskLib attr_accessor :executables - # Create a Rakegen task named <em>task_name</em>. Default task name is +app+. - def initialize(name=:app) - @name = name + # Create a generator. The task_name becomes the primary Rake task, which has dependency + # tasks that get all the work done. You can use a string to supply a namespaced task name, + # such as "waves:app". + # + # In the required block, you must define the source and target directories. You may also define + # a list of excludes, a list of executables, assign variables for templates, and lambdas for processing + # different kinds of templates, keyed by the file extension. + # + # generator = Rakegen.new do |gen| + # gen.source = "some/place" + # gen.target = "some/where/else" + # gen.excludes = "**/*.yaml" + # gen.executables = %w{ bin/console bin/server } + # gen.template_assigns[:monkey] = "howler" + # gen.template_processors[:erb] = lambda { |src, tgt| MyErb.process(src, tgt) } + # end + # + + def initialize(task_name = :app) + @name = task_name @excludes = [] @executables = [] @template_processors = {} @@ -54,7 +71,10 @@ class Rakegen < Rake::TaskLib end end - yield self # if block_given? + yield self + + raise "You must supply a source." unless @source + raise "You must supply a target." unless @target Dir.chdir(@source) do @files = Rake::FileList.new("**/*").exclude(*@excludes).to_a @@ -75,6 +95,19 @@ class Rakegen < Rake::TaskLib define end + # Invoke the primary task. In other words, run the generator. + def invoke + Rake::Task[name].invoke + end + + # A rake file-based task that assesses neededness of target files based on user confirmation, + # rather than relative timestamps. As with Rake#file, you can do arbitrary stuff + # in the block: + # + # polite_file "some/target/file" do + # str = File.read("/etc/profile").reverse + # File.write( "some/target/file", str) + # end def polite_file(args, &block) PoliteFileTask.define_task(args, &block) @@ -85,12 +118,14 @@ class Rakegen < Rake::TaskLib path ? File.join(@source, path) : @source end - # If given a path, joins it to @targe. Otherwise returns @target + # If given a path, joins it to @target. Otherwise returns @target def target(path=nil) path ? File.join(@target, path) : @target end - # Define the necessary Rakegen tasks + private + + # Define all the generator's dependent tasks def define desc "Create or update project using Rakegen" task name => @all_files.map { |f| target(f) } lib/rakegen.rb @@ -1,6 +1,6 @@ class PoliteFileTask < Rake::FileTask - # Is this file task needed? Yes if doesn't exist (or different content, TBI) + # Is this file task needed? Yes if doesn't exist or if the user agrees to clobber. def needed? return true unless File.exist?(name) return confirm? lib/rakegen/polite_file.rb @@ -1,20 +1,20 @@ -# Gem::Specification for Rakegen-0.6.5 +# Gem::Specification for Rakegen-0.6.6 # Originally generated by Echoe Gem::Specification.new do |s| s.name = %q{rakegen} - s.version = "0.6.5" + s.version = "0.6.6" s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version= s.authors = ["Matthew King"] - s.date = %q{2008-09-01} + s.date = %q{2008-09-03} s.description = %q{Generation and updation of projects from templates. Rake-powered, for sustainable blah blah.} s.email = %q{automatthew@gmail.com} s.extra_rdoc_files = ["CHANGELOG", "lib/rakegen/polite_file.rb", "lib/rakegen.rb", "LICENSE", "README"] - 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.files = ["CHANGELOG", "lib/rakegen/polite_file.rb", "lib/rakegen.rb", "LICENSE", "Manifest", "rakegen.gemspec", "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"] s.has_rdoc = true - s.homepage = %q{} + s.homepage = %q{http://rakegen.rubyforge.org} s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Rakegen", "--main", "README"] s.require_paths = ["lib"] s.rubyforge_project = %q{rakegen} @@ -49,7 +49,7 @@ end # require dep # end # -# Version = '0.6.5' +# Version = '0.6.6' # # task :default => [:test] # @@ -61,6 +61,7 @@ end # 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.url = "http://rakegen.rubyforge.org" # p.ignore_pattern = /^(\.git).+/ # p.test_pattern = "test/test_*.rb" # p.dependencies << "rake" rakegen.gemspec @@ -33,7 +33,7 @@ context "A file_copy task" do Rake::Task[@target].needed?.should == true end - specify "should ask if file exists (no idea how to test Highline stuff)" do + specify "should ask if file exists" do File.open(@target, "w") { |f| f.print "two" } # run in shell and answer "n". Also, find better way to test. puts "Answer no to the next prompt" test/test_polite_file.rb @@ -1,6 +1,6 @@ require File.join(File.dirname(__FILE__), "helper") -context "Simple rakegen" do +context "A Simple rakegen" do before(:each) do @target = File.join(TEST_DIR, "app_target") @@ -37,36 +37,36 @@ context "Simple rakegen" do rm_r @target if File.exist?(@target) end - specify "should have all directories in the directories list" do + specify "includes 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 + specify "includes 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 + + specify "includes all .erb files in the template list" do @generator.template_files.should == @template_files end - specify "should have an empty excludes list" do + specify "has an empty excludes list" do @generator.excludes.should == ["**/two.*"] end - specify "should have an executables list" do + specify "has an executables list" do @generator.executables.should == ["one"] end - specify "should have a working erb template_processor" do + specify "has 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 + specify "can copy or process all files and directories using #invoke" do + @generator.invoke @copy_files.each do |f| assert File.exist?(File.join(@target, f)) end test/test_rakegen.rb 1cdf1606935d6c231b251d84c38b15b4544e9855 Matthew King automatthew@gmail.com http://github.com/automatthew/rakegen/commit/d1f758c08e222a7536ff02c2f373f84141b08f44 d1f758c08e222a7536ff02c2f373f84141b08f44 2008-09-03T07:14:21-07:00 2008-09-03T07:14:21-07:00 added #invoke method; slightly better docs 0c5d5e468c10c27155cdb0f352037f303944848e Matthew King automatthew@gmail.com