gigantron 0.1.2 → 0.1.3

data/test/test_migration_generator.rb

@@ -1,49 +1,49 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
-
-
-class TestMigrationGenerator < Test::Unit::TestCase
-  include RubiGen::GeneratorTestHelper
-
-  def setup
-    bare_setup
-  end
-
-  def teardown
-    bare_teardown
-  end
-
-  # Some generator-related assertions:
-  #   assert_generated_file(name, &block) # block passed the file contents
-  #   assert_directory_exists(name)
-  #   assert_generated_class(name, &block)
-  #   assert_generated_module(name, &block)
-  #   assert_generated_test_for(name, &block)
-  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
-  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
-  #
-  # Other helper methods are:
-  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
-  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
-  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
-
-  def test_generator_without_options
-    name = "CreateFoo"
-    run_generator('migration', [name], sources)
-    assert_directory_exists "db/"
-    assert_directory_exists "db/migrate/"
-    assert_generated_file   "db/migrate/001_create_foo.rb"
-    name2 = "AlterFoo"
-    run_generator('migration', [name2], sources)
-    assert_generated_file  "db/migrate/002_alter_foo.rb"
-  end
-
-  private
-  def sources
-    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
-    ]
-  end
-
-  def generator_path
-    "gigantron_generators"
-  end
-end
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestMigrationGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "CreateFoo"
+    run_generator('migration', [name], sources)
+    assert_directory_exists "db/"
+    assert_directory_exists "db/migrate/"
+    assert_generated_file   "db/migrate/001_create_foo.rb"
+    name2 = "AlterFoo"
+    run_generator('migration', [name2], sources)
+    assert_generated_file  "db/migrate/002_alter_foo.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "gigantron_generators"
+  end
+end

data/test/test_model_generator.rb

@@ -1,53 +1,53 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
-
-
-class TestModelGenerator < Test::Unit::TestCase
-  include RubiGen::GeneratorTestHelper
-
-  def setup
-    bare_setup
-  end
-
-  def teardown
-    bare_teardown
-  end
-
-  # Some generator-related assertions:
-  #   assert_generated_file(name, &block) # block passed the file contents
-  #   assert_directory_exists(name)
-  #   assert_generated_class(name, &block)
-  #   assert_generated_module(name, &block)
-  #   assert_generated_test_for(name, &block)
-  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
-  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
-  #
-  # Other helper methods are:
-  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
-  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
-  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
-
-  def test_generator_without_options
-    name = "FooBaz"
-    run_generator('model', [name], sources)
-    assert_directory_exists "models/"
-    assert_generated_file   "models/foo_baz.rb"
-    assert_directory_exists "test/"
-    assert_directory_exists "test/models/"
-    assert_generated_file   "test/models/test_foo_baz.rb"
-
-    #check migration
-    assert_directory_exists "db/"
-    assert_directory_exists "db/migrate/"
-    assert_generated_file   "db/migrate/001_create_foo_bazs.rb"
-  end
-
-  private
-  def sources
-    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
-    ]
-  end
-
-  def generator_path
-    "gigantron_generators"
-  end
-end
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestModelGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "FooBaz"
+    run_generator('model', [name], sources)
+    assert_directory_exists "models/"
+    assert_generated_file   "models/foo_baz.rb"
+    assert_directory_exists "test/"
+    assert_directory_exists "test/models/"
+    assert_generated_file   "test/models/test_foo_baz.rb"
+
+    #check migration
+    assert_directory_exists "db/"
+    assert_directory_exists "db/migrate/"
+    assert_generated_file   "db/migrate/001_create_foo_bazs.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "gigantron_generators"
+  end
+end

data/test/test_task_generator.rb

@@ -1,48 +1,48 @@
-require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
-
-
-class TestTaskGenerator < Test::Unit::TestCase
-  include RubiGen::GeneratorTestHelper
-
-  def setup
-    bare_setup
-  end
-
-  def teardown
-    bare_teardown
-  end
-
-  # Some generator-related assertions:
-  #   assert_generated_file(name, &block) # block passed the file contents
-  #   assert_directory_exists(name)
-  #   assert_generated_class(name, &block)
-  #   assert_generated_module(name, &block)
-  #   assert_generated_test_for(name, &block)
-  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
-  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
-  #
-  # Other helper methods are:
-  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
-  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
-  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
-
-  def test_generator_without_options
-    name = "FooBar"
-    run_generator('task', [name], sources)
-    assert_directory_exists "tasks/"
-    assert_generated_file   "tasks/foo_bar.rake"
-    assert_directory_exists "test/"
-    assert_directory_exists "test/tasks"
-    assert_generated_file   "test/tasks/test_foo_bar.rb"
-  end
-
-  private
-  def sources
-    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
-    ]
-  end
-
-  def generator_path
-    "gigantron_generators"
-  end
-end
+require File.join(File.dirname(__FILE__), "test_generator_helper.rb")
+
+
+class TestTaskGenerator < Test::Unit::TestCase
+  include RubiGen::GeneratorTestHelper
+
+  def setup
+    bare_setup
+  end
+
+  def teardown
+    bare_teardown
+  end
+
+  # Some generator-related assertions:
+  #   assert_generated_file(name, &block) # block passed the file contents
+  #   assert_directory_exists(name)
+  #   assert_generated_class(name, &block)
+  #   assert_generated_module(name, &block)
+  #   assert_generated_test_for(name, &block)
+  # The assert_generated_(class|module|test_for) &block is passed the body of the class/module within the file
+  #   assert_has_method(body, *methods) # check that the body has a list of methods (methods with parentheses not supported yet)
+  #
+  # Other helper methods are:
+  #   app_root_files - put this in teardown to show files generated by the test method (e.g. p app_root_files)
+  #   bare_setup - place this in setup method to create the APP_ROOT folder for each test
+  #   bare_teardown - place this in teardown method to destroy the TMP_ROOT or APP_ROOT folder after each test
+
+  def test_generator_without_options
+    name = "FooBar"
+    run_generator('task', [name], sources)
+    assert_directory_exists "tasks/"
+    assert_generated_file   "tasks/foo_bar.rake"
+    assert_directory_exists "test/"
+    assert_directory_exists "test/tasks"
+    assert_generated_file   "test/tasks/test_foo_bar.rb"
+  end
+
+  private
+  def sources
+    [RubiGen::PathSource.new(:test, File.join(File.dirname(__FILE__),"..", generator_path))
+    ]
+  end
+
+  def generator_path
+    "gigantron_generators"
+  end
+end

data/website/index.html

@@ -0,0 +1,224 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Gigantron: Processor of Data
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Gigantron: Processor of Data</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/gigantron"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/gigantron" class="numbers">0.1.3</a>
+    </div>
+    <h1>&#x2192; &#8216;gigantron&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>Gigantron is a simple framework for the creation and organization of
+data processing projects. Data-processing transforms are created as Rake tasks
+and data is handled through ActiveRecord models. (DataMapper was the original
+plan, but it has problems playing nicely with JRuby for now).</p>
+
+
+	<p>Ruby is great for exploratory data processing.  Data processing projects tend 
+to grow up and encompass large numbers of random scripts and input files.  It 
+is easy to get lost in coding and lose organization.  Gigantron is an attempt 
+to use code generation and random magic to make maintaining organized DP 
+projects simple.  Code is separated into data (models) and operations on the 
+data (tasks).  Code generators stub out these files and the associated tests 
+for the user.</p>
+
+
+	<p>Gigantron was written for my own needs working with atmospheric data and will
+evolve through use to reduce the trivialities that can sometimes dominate the
+work of developers.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">gigantron</span></pre></p>
+
+
+	<p>This should handle the major dependencies automatically except for your
+database adapter.  If you are on JRuby the gem is 
+<code>activerecord-jdbcsqlite3-adapter</code> for sqlite3 and 
+<code>activerecord-jdbcmysql-adapter</code> for mysql.  On <span class="caps">MRI</span> be sure to install
+<code>sqlite3-ruby</code> if you are using sqlite.</p>
+
+
+	<p>Note: JDBCSqlite3 is still a work in progress and migrations are basically 
+broken for it.</p>
+
+
+	<h2>The basics</h2>
+
+
+<pre>
+# Generate new project
+shell&gt; $ gigantron project
+      create
+      create  tasks
+      create  db
+      create  models
+      create  lib
+      create  test
+      create  Rakefile
+      create  database.yml
+      create  initialize.rb
+      create  tasks/import.rake
+      create  test/test_helper.rb
+      create  test/models
+      create  test/tasks
+      create  test/tasks/test_import.rb
+  dependency  install_rubigen_scripts
+      create    script
+      create    script/generate
+      create    script/destroy
+shell&gt; $ cd project
+# Create new model
+shell&gt; $ script/generate model modis
+      exists  models/
+      create  models/modis.rb
+      exists  test/
+      exists  test/models/
+      create  test/models/test_modis.rb
+shell&gt; $ script/generate task modis_to_kml
+      exists  tasks/
+      create  tasks/modis_to_kml.rake
+      exists  test/
+      exists  test/tasks/
+      create  test/tasks/test_modis_to_kml.rb
+</pre>
+
+	<p>One can edit these files to add functionality.  Gigantron by default includes
+ActiveSupport for convenience.</p>
+
+
+	<h2>Hacking</h2>
+
+
+	<p>Gigantron is super minimal now, so modifying it is pretty easy.  The gigantron
+application generator (that which is invoked by the <code>gigantron</code> command) lives
+in <code>app_generators/gigantron/</code>.  The template files and the template dir
+structure are in <code>app_generators/gigantron/templates/</code>.  When adding new
+templates, directories, or files, add the names first to the tests in 
+<code>test/test_gigantron_generator.rb</code>, then the stubs to
+<code>app_generators/gigantron/templates</code>, and then finally describe them in the
+manifest section of <code>app_generators/gigantron/gigantron_generator.rb</code>.  It
+should look something like</p>
+
+
+	<p><pre class='syntax'>
+  <span class="keyword">def </span><span class="method">manifest</span>
+    <span class="ident">record</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">m</span><span class="punct">|</span>
+      <span class="punct">...</span>
+      <span class="ident">m</span><span class="punct">.</span><span class="ident">file</span> <span class="punct">&quot;</span><span class="string">new_file</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">new_file</span><span class="punct">&quot;</span> <span class="comment">#straight file copy</span>
+      <span class="ident">m</span><span class="punct">.</span><span class="ident">directory</span> <span class="punct">&quot;</span><span class="string">my_new_dir</span><span class="punct">&quot;</span> <span class="comment">#create directory</span>
+      <span class="ident">m</span><span class="punct">.</span><span class="ident">template</span> <span class="punct">&quot;</span><span class="string">new_thing</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string">new_thing</span><span class="punct">&quot;</span> <span class="comment">#runs file through ERB when copying</span>
+    <span class="keyword">end</span>
+  <span class="keyword">end</span>
+</pre></p>
+
+
+	<p>It might be handy to know that in <code>gigantron_generator.rb</code> the name provided to the generator can be referenced as <code>@name</code>.  This can be used like</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">record</span> <span class="keyword">do</span> <span class="punct">|</span><span class="ident">m</span><span class="punct">|</span>
+  <span class="ident">m</span><span class="punct">.</span><span class="ident">file</span> <span class="punct">&quot;</span><span class="string">renamed_file</span><span class="punct">&quot;,</span> <span class="punct">&quot;</span><span class="string"><span class="expr">#{@name}</span>_file</span><span class="punct">&quot;</span>
+<span class="keyword">end</span>
+</pre></p>
+
+
+	<p>The same value is available to your templates as just <code>name</code>.  You can template
+a file like</p>
+
+
+	<p><pre class='syntax'>
+<span class="keyword">class </span><span class="class">Test</span><span class="punct">&lt;%=</span><span class="string"> name.camelcase %&gt; &lt; Test::Unit::TestCase
+  ...
+end<span class="normal">
+</span></span></pre></p>
+
+
+	<p>The same process applies to the model and task generator for gigantron
+projects.  These generators live in <code>gigantron_generators/</code>.  Modifying them
+is exactly the same as modifying the application generator.</p>
+
+
+	<p>All of this is pretty vanilla <a href="http://rubigen.rubyforge.org">RubiGen</a>, so if in doubt, check out the docos on that fine piece of work.</p>
+
+
+	<p>The only other place for code in Gigantron is is <code>lib/gigantron/tasks/</code> where a few boilerplate test and db tasks live.  I think I ripped the test tasks off of rails.</p>
+
+
+	<p>If you have any questions, do contact me.  I am interested in anything that will make Gigantron suck less and be useful to people.</p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<ul>
+	<li>github: <a href="http://github.com/schleyfox/gigantron/tree/master">http://github.com/schleyfox/gigantron/tree/master</a></li>
+	</ul>
+
+
+<pre>git clone git://github.com/schleyfox/gigantron.git</pre>
+
+	<h3>Build and test instructions</h3>
+
+
+<pre>cd gigantron
+cp test/template_database.yml.example test/template_database.yml
+vim test/template_database.yml
+rake test
+rake install_gem</pre>
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Comments are welcome. Send an email to <a href="mailto:ben@pixelmachine.org">Ben Hughes</a></p>
+    <p class="coda">
+      <a href="ben@pixelmachine.org">Ben Hughes</a>, 24th June 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>