@@ -2,3 +2,4 @@
* 1 major enhancement:
* Initial release
+ * It works somewhat, will use in practice to see where it is headed
History.txt
@@ -1,7 +1,4 @@
For more information on gigantron, see http://gigantron.rubyforge.org
-NOTE: Change this information in PostInstall.txt
-You can also delete it if you don't want it.
-
-
+Do you enjoy the tangy zip of miracle whip?
PostInstall.txt
@@ -1,26 +1,48 @@
-= gigantron
+= Gigantron: Processor of Data
-* FIX (url)
+http://gigantron.rubyforge.org
+http://github.com/schleyfox/gigantron
== DESCRIPTION:
-FIX (describe your package)
+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 DataMapper models.
== FEATURES/PROBLEMS:
-* FIX (list of features or problems)
+Features:
+* Generates folder/file structure for new DP projects
+* Contains generators for both models and tasks
== SYNOPSIS:
- FIX (code sample of usage)
+Use:
+
+shell> $ gigantron projectname
+
+to generate the project folder and then
+
+shell> $ script/generate model modelname
+
+OR
+
+shell> $ script/generate task taskname
+
+to add code.
== REQUIREMENTS:
-* FIX (list of requirements)
+* RubyGems
+* RubiGen
+* Rake
+* DataMapper
+* ActiveSupport
+* Shoulda
== INSTALL:
-* FIX (sudo gem install, anything else)
+sudo gem install gigantron
== LICENSE:
@@ -45,4 +67,4 @@ 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.
\ No newline at end of file
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
README.txt
@@ -1,5 +1,7 @@
-Description:
-
+Description:
+Generate the directory and file structure for a gigantron project.
+
Usage:
+shell> $ gigantron projectname
app_generators/gigantron/USAGE
@@ -8,7 +8,14 @@ RUBYFORGE_PROJECT = 'gigantron' # The unix name for your project
HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
EXTRA_DEPENDENCIES = [
-# ['activesupport', '>= 1.3.1']
+ ['activesupport', '>= 2.0.2'],
+ ['rubigen', '>= 1.3.2'],
+ ['rake', '>= 0.8.1'],
+ ['Shoulda', '>= 1.1.1'],
+ ['dm-core', '>= 0.9.1'],
+ ['do_sqlite3', '>= 0.9.1'],
+ ['data_objects', '>= 0.9.1'],
+ ['dm-more', '>= 0.9.1']
] # An array of rubygem dependencies [name, version]
@config_file = "~/.rubyforge/user-config.yml"
@@ -70,4 +77,4 @@ CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
PATH = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
$hoe.rsync_args = '-av --delete --ignore-errors'
-$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""
\ No newline at end of file
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""
config/hoe.rb
@@ -1,5 +1,11 @@
Description:
+Generate a DataMapper model for your Gigantron project.
Usage:
+shell> $ script/generate model modelname
+
+1. edit models/modelname.rb to create the table schema
+2. write tests in test/models/test_modelname.rb
+3. run 'rake db:automigrate' to have changes updated
gigantron_generators/model/USAGE
@@ -1,5 +1,10 @@
Description:
+Generate task for your Gigantron project
Usage:
-
+shell> $ script/generate task taskname
+
+1. edit tasks/taskname.rake to add functionality
+2. write tests in test/tasks/test_taskname.rb
+3. run 'rake taskname' to run task
gigantron_generators/task/USAGE
@@ -1,11 +1,149 @@
-<html>
- <head>
- <meta http-equiv="Content-type" content="text/html; charset=utf-8">
- <title>gigantron</title>
-
- </head>
- <body id="body">
- <p>This page has not yet been created for RubyGem <code>gigantron</code></p>
- <p>To the developer: To generate it, update website/index.txt and run the rake task <code>website</code> to generate this <code>index.html</code> file.</p>
- </body>
-</html>
\ No newline at end of file
+<!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.0.1</a>
+ </div>
+ <h1>→ ‘gigantron’</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 DataMapper models.</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>
+
+
+ <h2>The basics</h2>
+
+
+<pre>
+# Generate new project
+shell> $ 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> $ cd project
+# Create new model
+shell> $ script/generate model modis
+ exists models/
+ create models/modis.rb
+ exists test/
+ exists test/models/
+ create test/models/test_modis.rb
+shell> $ 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>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
+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>, 1st 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>
website/index.html
@@ -1,10 +1,25 @@
-h1. gigantron
+h1. Gigantron: Processor of Data
h1. → 'gigantron'
h2. What
+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 DataMapper models.
+
+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.
+
+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.
h2. Installing
@@ -12,9 +27,45 @@ h2. Installing
h2. The basics
-
-h2. Demonstration of usage
-
+<pre>
+# Generate new project
+shell> $ 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> $ cd project
+# Create new model
+shell> $ script/generate model modis
+ exists models/
+ create models/modis.rb
+ exists test/
+ exists test/models/
+ create test/models/test_modis.rb
+shell> $ 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>
+
+One can edit these files to add functionality. Gigantron by default includes
+ActiveSupport for convenience.
h2. How to submit patches
website/index.txt
b8ebf8f07f7008b4d552417c1c3106d024fa96cd
Ben Hughes
ben@pixelmachine.org
http://github.com/schleyfox/gigantron/commit/41b42faa543dd5b9f85f8a71ac81ae6f4790a504
41b42faa543dd5b9f85f8a71ac81ae6f4790a504
2008-06-01T14:31:53-07:00
2008-06-01T14:31:53-07:00
Doc-ed and prepared for initial release
c8d9b74d136ee8d52b2bbdd25171131ddd17764a
Ben Hughes
ben@pixelmachine.org