genosaurus 1.1.1

data/doc/rdoc-style.css

@@ -0,0 +1,208 @@
+
+body {
+    font-family: Verdana,Arial,Helvetica,sans-serif;
+    font-size:   90%;
+    margin: 0;
+    margin-left: 40px;
+    padding: 0;
+    background: white;
+}
+
+h1,h2,h3,h4 { margin: 0; color: #efefef; background: transparent; }
+h1 { font-size: 150%; }
+h2,h3,h4 { margin-top: 1em; }
+
+a { background: #eef; color: #039; text-decoration: none; }
+a:hover { background: #039; color: #eef; }
+
+/* Override the base stylesheet's Anchor inside a table cell */
+td > a {
+  background: transparent;
+  color: #039;
+  text-decoration: none;
+}
+
+/* and inside a section title */
+.section-title > a {
+  background: transparent;
+  color: #eee;
+  text-decoration: none;
+}
+
+/* === Structural elements =================================== */
+
+div#index {
+    margin: 0;
+    margin-left: -40px;
+    padding: 0;
+    font-size: 90%;
+}
+
+
+div#index a {
+    margin-left: 0.7em;
+}
+
+div#index .section-bar {
+   margin-left: 0px;
+   padding-left: 0.7em;
+   background: #ccc;
+   font-size: small;
+}
+
+
+div#classHeader, div#fileHeader {
+    width: auto;
+    color: white;
+    padding: 0.5em 1.5em 0.5em 1.5em;
+    margin: 0;
+    margin-left: -40px;
+    border-bottom: 3px solid #006;
+}
+
+div#classHeader a, div#fileHeader a {
+    background: inherit;
+    color: white;
+}
+
+div#classHeader td, div#fileHeader td {
+    background: inherit;
+    color: white;
+}
+
+
+div#fileHeader {
+    background: #057;
+}
+
+div#classHeader {
+    background: #048;
+}
+
+
+.class-name-in-header {
+  font-size:  180%;
+  font-weight: bold;
+}
+
+
+div#bodyContent {
+    padding: 0 1.5em 0 1.5em;
+}
+
+div#description {
+    padding: 0.5em 1.5em;
+    background: #efefef;
+    border: 1px dotted #999;
+}
+
+div#description h1,h2,h3,h4,h5,h6 {
+    color: #125;;
+    background: transparent;
+}
+
+div#validator-badges {
+    text-align: center;
+}
+div#validator-badges img { border: 0; }
+
+div#copyright {
+    color: #333;
+    background: #efefef;
+    font: 0.75em sans-serif;
+    margin-top: 5em;
+    margin-bottom: 0;
+    padding: 0.5em 2em;
+}
+
+
+/* === Classes =================================== */
+
+table.header-table {
+    color: white;
+    font-size: small;
+}
+
+.type-note {
+    font-size: small;
+    color: #DEDEDE;
+}
+
+.xxsection-bar {
+    background: #eee;
+    color: #333;
+    padding: 3px;
+}
+
+.section-bar {
+   color: #333;
+   border-bottom: 1px solid #999;
+    margin-left: -20px;
+}
+
+
+.section-title {
+    background: #79a;
+    color: #eee;
+    padding: 3px;
+    margin-top: 2em;
+    margin-left: -30px;
+    border: 1px solid #999;
+}
+
+.top-aligned-row {  vertical-align: top }
+.bottom-aligned-row { vertical-align: bottom }
+
+/* --- Context section classes ----------------------- */
+
+.context-row { }
+.context-item-name { font-family: monospace; font-weight: bold; color: black; }
+.context-item-value { font-size: small; color: #448; }
+.context-item-desc { color: #333; padding-left: 2em; }
+
+/* --- Method classes -------------------------- */
+.method-detail {
+    background: #efefef;
+    padding: 0;
+    margin-top: 0.5em;
+    margin-bottom: 1em;
+    border: 1px dotted #ccc;
+}
+.method-heading {
+  color: black;
+  background: #ccc;
+  border-bottom: 1px solid #666;
+  padding: 0.2em 0.5em 0 0.5em;
+}
+.method-signature { color: black; background: inherit; }
+.method-name { font-weight: bold; }
+.method-args { font-style: italic; }
+.method-description { padding: 0 0.5em 0 0.5em; }
+
+/* --- Source code sections -------------------- */
+
+a.source-toggle { font-size: 90%; }
+div.method-source-code {
+    background: #262626;
+    color: #ffdead;
+    margin: 1em;
+    padding: 0.5em;
+    border: 1px dashed #999;
+    overflow: hidden;
+}
+
+div.method-source-code pre { color: #ffdead; overflow: hidden; }
+
+/* --- Ruby keyword styles --------------------- */
+
+.standalone-code { background: #221111; color: #ffdead; overflow: hidden; }
+
+.ruby-constant  { color: #7fffd4; background: transparent; }
+.ruby-keyword { color: #00ffff; background: transparent; }
+.ruby-ivar    { color: #eedd82; background: transparent; }
+.ruby-operator  { color: #00ffee; background: transparent; }
+.ruby-identifier { color: #ffdead; background: transparent; }
+.ruby-node    { color: #ffa07a; background: transparent; }
+.ruby-comment { color: #b22222; font-weight: bold; background: transparent; }
+.ruby-regexp  { color: #ffa07a; background: transparent; }
+.ruby-value   { color: #7fffd4; background: transparent; }

data/lib/genosaurus.rb

@@ -0,0 +1,176 @@
+require 'rubygems'
+require 'mack_ruby_core_extensions'
+require 'fileutils'
+require 'erb'
+require 'yaml'
+
+class Genosaurus
+
+  include FileUtils
+  
+  class << self
+    
+    # Instantiates a new Genosaurus, passing the ENV hash as options into it, runs the generate method, and returns the Genosaurus object.
+    def run(options = ENV.to_hash)
+      gen = self.new(options)
+      gen.generate
+      gen
+    end
+    
+  end
+  
+  # Takes any options needed for this generator. If the generator requires any parameters an ArgumentError exception will be
+  # raised if those parameters are found in the options Hash. The setup method is called at the end of the initialization.
+  def initialize(options = {})
+    @options = options
+    self.class.required_params.each do |p|
+      raise ::ArgumentError.new("The required parameter '#{p.to_s.upcase}' is missing for this generator!") unless param(p)
+    end
+    @generator_name = self.class.name
+    @generator_name_underscore = @generator_name.underscore
+    @templates_directory_path = nil
+    @manifest_path = nil
+    $".each do |f|
+      if f.match(/#{@generator_name_underscore}\.rb$/)
+        @templates_directory_path = File.join(File.dirname(f), "templates")
+        @manifest_path = File.join(File.dirname(f), "manifest.yml")
+      end
+    end
+    setup
+  end
+  
+  # Returns the path to the templates directory.
+  # IMPORTANT: The location of the templates_directory_path is VERY important! Genosaurus will attempt to find this location
+  # automatically, HOWEVER, if there is a problem, or you want to be special, you can override this method in your generator
+  # and have it return the correct path.
+  def templates_directory_path
+    @templates_directory_path
+  end
+  
+  # Returns the path to the manifest.yml. This is only used if you have a manifest.yml file, if there is no file, or this
+  # method returns nil, then an implied manifest is used based on the templates_directory_path contents.
+  # IMPORTANT: Genosaurus will attempt to find this location automatically, HOWEVER, if there is a problem, or you want to 
+  # be special, you can override this method in your generator and have it return the correct path.
+  def manifest_path
+    @manifest_path
+  end
+  
+  # To be overridden in subclasses to do any setup work needed by the generator.
+  def setup
+    # does nothing, unless overridden in subclass.
+  end
+  
+  # To be overridden in subclasses to do work before the generate method is run.
+  def before_generate
+  end
+  
+  # To be overridden in subclasses to do work after the generate method is run.
+  # This is a simple way to call other generators.
+  def after_generate
+  end
+  
+  # Returns the manifest for this generator, which is used by the generate method to do the dirty work.
+  # If there is a manifest.yml, defined by the manifest_path method, then the contents of that file are processed
+  # with ERB and returned. If there is not manifest.yml then an implied manifest is generated from the contents
+  # of the templates_directory_path.
+  def manifest
+    ivar_cache do 
+      if File.exists?(manifest_path)
+        # run using the yml file
+        template = ERB.new(File.open(manifest_path).read, nil, "->")
+        man = YAML.load(template.result(binding))
+      else
+        files = Dir.glob(File.join(templates_directory_path, "**/*.template"))
+        man = {}
+        files.each_with_index do |f, i|
+          output_path = f.gsub(templates_directory_path, "")
+          output_path.gsub!(".template", "")
+          output_path.gsub!(/^\//, "")
+          man["template_#{i+1}"] = {
+            "type" => File.directory?(f) ? "directory" : "file",
+            "template_path" => f,
+            "output_path" => ERB.new(output_path, nil, "->").result(binding)
+          }
+        end
+      end
+      # puts man.inspect
+      man
+    end
+  end
+  
+  
+  # Used to define arguments that are required by the generator.
+  def self.require_param(*args)
+    required_params << args
+    required_params.flatten!
+  end
+  
+  # Returns the required_params array.
+  def self.required_params
+    @required_params ||= []
+  end
+
+  # Returns a parameter from the initial Hash of parameters.
+  def param(key)
+    (@options[key.to_s.downcase] ||= @options[key.to_s.upcase])
+  end
+
+  # Takes an input_file runs it through ERB and 
+  # saves it to the specified output_file. If the output_file exists it will
+  # be skipped. If you would like to force the writing of the file, use the
+  # :force => true option.
+  def template(input_file, output_file, options = @options)
+    if File.exists?(output_file)
+      unless options[:force]
+        puts "Skipped: #{output_file}"
+        return
+      end
+    end
+    # incase the directory doesn't exist, let's create it.
+    directory(File.dirname(output_file))
+    # puts "input_file: #{input_file}"
+    # puts "output_file: #{output_file}"
+    if $genosaurus_output_directory
+      output_file = File.join($genosaurus_output_directory, output_file) 
+    end
+    File.open(output_file, "w") {|f| f.puts ERB.new(File.open(input_file).read, nil, "->").result(binding)}
+    puts "Wrote: #{output_file}"
+  end
+  
+  # Creates the specified directory.
+  def directory(output_dir, options = @options)
+    if $genosaurus_output_directory
+      output_dir = File.join($genosaurus_output_directory, output_dir) 
+    end
+    if File.exists?(output_dir)
+      puts "Exists: #{output_dir}"
+      return
+    end
+    mkdir_p(output_dir)
+    puts "Created: #{output_dir}"
+  end
+  
+  # This does the dirty work of generation.
+  def generate
+    generate_callbacks do
+      manifest.each_value do |info|
+        case info["type"]
+        when "file"
+          template(info["template_path"], info["output_path"])
+        when "directory"
+          directory(info["output_path"])
+        else
+          raise "Unknown 'type': #{info["type"]}!"
+        end
+      end
+    end
+  end
+  
+  private
+  def generate_callbacks
+    before_generate
+    yield
+    after_generate
+  end
+  
+end # Genosaurus

data/test/genosaurus_test.rb

@@ -0,0 +1,81 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class GenosaurusBaseTest < Test::Unit::TestCase
+  
+  def test_simple_implied_generator
+    hello_file = File.join($genosaurus_output_directory, "hello_world.rb")
+    goodbye_file = File.join($genosaurus_output_directory, "goodbye_world.rb")
+    assert !File.exists?(hello_file)
+    assert !File.exists?(goodbye_file)
+    @generator = HelloGoodbyeGenerator.run("name" => "Mark")
+    assert File.exists?(hello_file)
+    assert File.exists?(goodbye_file)
+    File.open(hello_file, "r") do |f|
+      assert_equal "Hello Mark\n", f.read
+    end
+    File.open(goodbye_file, "r") do |f|
+      assert_equal "Goodbye cruel world! Love, Mark\n", f.read
+    end
+  end
+
+  def test_simple_implied_manifest
+    @generator = HelloGoodbyeGenerator.new("name" => "Mark")
+    manifest = @generator.manifest
+    assert manifest.is_a?(Hash)
+    assert_equal 2, manifest.size
+    temp1 = manifest["template_1"]
+    assert_equal "file", temp1["type"]
+    assert_equal File.join(File.dirname(__FILE__), "lib", "hello_goodbye_generator", "templates", "goodbye_world.rb.template"), temp1["template_path"]
+    assert_equal "goodbye_world.rb", temp1["output_path"]
+    temp2 = manifest["template_2"]
+    assert_equal "file", temp2["type"]
+    assert_equal File.join(File.dirname(__FILE__), "lib", "hello_goodbye_generator", "templates", "hello_world.rb.template"), temp2["template_path"]
+    assert_equal "hello_world.rb", temp2["output_path"]
+  end
+  
+  def test_require_param
+    assert_raise(ArgumentError) { HelloGoodbyeGenerator.new }
+    @generator = HelloGoodbyeGenerator.new("name" => :foo)
+    assert_not_nil @generator
+    assert_equal :foo, @generator.param(:name)    
+  end
+  
+  def test_complex_implied_generator
+    album_dir = File.join($genosaurus_output_directory, "beatles", "albums")
+    lyrics_file = File.join($genosaurus_output_directory, "beatles", "lyrics", "i_am_the_walrus.txt")
+    assert !File.exists?(album_dir)
+    assert !File.exists?(lyrics_file)
+    @generator = IAmTheWalrusGenerator.run("name" => "i_am_the_walrus")
+    assert File.exists?(album_dir)
+    assert File.exists?(lyrics_file) 
+    File.open(lyrics_file, "r") do |f|
+      assert_equal "Lyrics for: I Am The Walrus\n", f.read
+    end
+  end
+  
+  def test_simple_yml_manifest
+    @generator = StrawberryFieldsGenerator.new
+    manifest = @generator.manifest
+    assert manifest.is_a?(Hash)
+    assert_equal 2, manifest.size
+    info = manifest["directory_1"]
+    assert_equal "beatles/albums/magical_mystery_tour", info["output_path"]
+    assert_equal "directory", info["type"]
+    info = manifest["template_1"]
+    assert_equal File.join(File.dirname(__FILE__), "lib", "strawberry_fields_generator", "templates", "fields.txt"), info["template_path"]
+    assert_equal "beatles/albums/magical_mystery_tour/lyrics/strawberry_fields_forever.lyrics", info["output_path"]
+  end
+  
+  def clean_tmp
+    FileUtils.rm_rf($genosaurus_output_directory, :verbose => false)
+  end
+  
+  def setup
+    clean_tmp
+  end
+  
+  def teardown
+    clean_tmp
+  end
+  
+end

data/test/lib/hello_goodbye_generator/hello_goodbye_generator.rb

@@ -0,0 +1,3 @@
+class HelloGoodbyeGenerator < Genosaurus
+  require_param :name
+end

data/test/lib/hello_goodbye_generator/templates/goodbye_world.rb.template

@@ -0,0 +1 @@
+Goodbye cruel world! Love, <%= param(:name) %>

data/test/lib/hello_goodbye_generator/templates/hello_world.rb.template

@@ -0,0 +1 @@
+Hello <%= param(:name) %>

data/test/lib/i_am_the_walrus_generator/i_am_the_walrus_generator.rb

@@ -0,0 +1,2 @@
+class IAmTheWalrusGenerator < Genosaurus
+end

data/test/lib/i_am_the_walrus_generator/templates/beatles/lyrics/<%=param(:name)%>.txt.template

@@ -0,0 +1 @@
+Lyrics for: <%= param(:name).gsub("_", " ").capitalize_all_words %>

data/test/lib/strawberry_fields_generator/manifest.yml

@@ -0,0 +1,7 @@
+directory_1:
+  type: directory
+  output_path: beatles/albums/magical_mystery_tour
+template_1:
+  type: file
+  template_path: <%= File.join(templates_directory_path, "fields.txt") %>
+  output_path: beatles/albums/magical_mystery_tour/lyrics/strawberry_fields_forever.lyrics

data/test/lib/strawberry_fields_generator/strawberry_fields_generator.rb

@@ -0,0 +1,2 @@
+class StrawberryFieldsGenerator < Genosaurus
+end

data/test/lib/strawberry_fields_generator/templates/fields.txt

@@ -0,0 +1,29 @@
+Let me take you down, 'cause I'm going to Strawberry Fields.
+Nothing is real and nothing to get hung about.
+Strawberry Fields forever.
+
+Living is easy with eyes closed, misunderstanding all you see.
+It's getting hard to be someone but it all works out.
+It doesn't matter much to me.
+
+Let me take you down, 'cause I'm going to Strawberry Fields.
+Nothing is real and nothing to get hung about.
+Strawberry Fields forever.
+
+No one I think is in my tree, I mean it must be high or low.
+That is you can't you know tune in but it's all right.
+That is I think it's not too bad.
+
+Let me take you down, 'cause I'm going to Strawberry Fields.
+Nothing is real and nothing to get hung about.
+Strawberry Fields forever.
+
+Always no sometimes think it's me, but you know I know when it's a dream.
+I think I know I mean "Yes," but it's all wrong.
+That is I think I disagree.
+
+Let me take you down, 'cause I'm going to Strawberry Fields.
+Nothing is real and nothing to get hung about.
+Strawberry Fields forever.
+Strawberry Fields forever.
+Strawberry Fields forever.

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require "test/unit"
+require 'fileutils'
+require File.join(File.dirname(__FILE__), "..", "lib", "genosaurus")
+# place common methods, assertions, and other type things in this file so
+# other tests will have access to them.
+
+if $genosaurus_output_directory.nil?
+  $genosaurus_output_directory = File.join(FileUtils.pwd, "tmp")
+end
+
+puts "$genosaurus_output_directory: #{$genosaurus_output_directory}"
+
+Dir.glob(File.join(File.dirname(__FILE__), "lib", "**/*.rb")).each {|f| require f}
+
+class Test::Unit::TestCase
+  
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: genosaurus
+version: !ruby/object:Gem::Version 
+  version: 1.1.1
+platform: ruby
+authors: 
+- markbates
+autorequire: genosaurus
+bindir: bin
+cert_chain: []
+
+date: 2008-04-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mack_ruby_core_extensions
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "genosaurus was developed by: markbates"
+email: mark@markbates.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/genosaurus.rb
+- README
+- doc/classes/Genosaurus.html
+- doc/created.rid
+- doc/files/lib/genosaurus_rb.html
+- doc/files/README.html
+- doc/fr_class_index.html
+- doc/fr_file_index.html
+- doc/fr_method_index.html
+- doc/index.html
+- doc/rdoc-style.css
+has_rdoc: true
+homepage: http://www.mackframework.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+- 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: magrathea
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: genosaurus
+test_files: 
+- test/genosaurus_test.rb
+- test/lib
+- test/lib/directory_generator
+- test/lib/directory_generator/templates
+- test/lib/directory_generator/templates/months
+- test/lib/directory_generator/templates/months/february.template
+- test/lib/directory_generator/templates/months/january.template
+- test/lib/directory_generator/templates/months/march.template
+- test/lib/hello_goodbye_generator
+- test/lib/hello_goodbye_generator/hello_goodbye_generator.rb
+- test/lib/hello_goodbye_generator/templates
+- test/lib/hello_goodbye_generator/templates/goodbye_world.rb.template
+- test/lib/hello_goodbye_generator/templates/hello_world.rb.template
+- test/lib/i_am_the_walrus_generator
+- test/lib/i_am_the_walrus_generator/i_am_the_walrus_generator.rb
+- test/lib/i_am_the_walrus_generator/templates
+- test/lib/i_am_the_walrus_generator/templates/beatles
+- test/lib/i_am_the_walrus_generator/templates/beatles/albums.template
+- test/lib/i_am_the_walrus_generator/templates/beatles/lyrics
+- test/lib/i_am_the_walrus_generator/templates/beatles/lyrics/<%=param(:name)%>.txt.template
+- test/lib/strawberry_fields_generator
+- test/lib/strawberry_fields_generator/manifest.yml
+- test/lib/strawberry_fields_generator/strawberry_fields_generator.rb
+- test/lib/strawberry_fields_generator/templates
+- test/lib/strawberry_fields_generator/templates/fields.txt
+- test/test_helper.rb