gigantron 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+== 0.0.1 2008-05-31
+
+* 1 major enhancement:
+  * Initial release
+  * It works somewhat, will use in practice to see where it is headed

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ben Hughes
+
+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.txt

@@ -0,0 +1,48 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+app_generators/gigantron/USAGE
+app_generators/gigantron/gigantron_generator.rb
+app_generators/gigantron/templates/Rakefile
+app_generators/gigantron/templates/database.yml
+app_generators/gigantron/templates/initialize.rb
+app_generators/gigantron/templates/tasks/import.rake
+app_generators/gigantron/templates/test/tasks/test_import.rb
+app_generators/gigantron/templates/test/test_helper.rb
+bin/gigantron
+config/hoe.rb
+config/requirements.rb
+gigantron_generators/model/USAGE
+gigantron_generators/model/model_generator.rb
+gigantron_generators/model/templates/models/model.rb
+gigantron_generators/model/templates/test/models/test_model.rb
+gigantron_generators/task/USAGE
+gigantron_generators/task/task_generator.rb
+gigantron_generators/task/templates/tasks/task.rake
+gigantron_generators/task/templates/test/tasks/test_task.rb
+lib/gigantron.rb
+lib/gigantron/tasks/db.rb
+lib/gigantron/tasks/test.rb
+lib/gigantron/version.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/test_generator_helper.rb
+test/test_gigantron.rb
+test/test_gigantron_generator.rb
+test/test_helper.rb
+test/test_model_generator.rb
+test/test_task_generator.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,4 @@
+
+For more information on gigantron, see http://gigantron.rubyforge.org
+
+Do you enjoy the tangy zip of miracle whip?

data/README.txt

@@ -0,0 +1,70 @@
+= Gigantron: Processor of Data
+
+http://gigantron.rubyforge.org
+http://github.com/schleyfox/gigantron
+
+== DESCRIPTION:
+
+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:
+
+Features:
+* Generates folder/file structure for new DP projects
+* Contains generators for both models and tasks
+
+== SYNOPSIS:
+
+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:
+
+* RubyGems
+* RubiGen
+* Rake
+* DataMapper
+* ActiveSupport
+* Shoulda
+
+== INSTALL:
+
+sudo gem install gigantron
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/app_generators/gigantron/USAGE

@@ -0,0 +1,7 @@
+Description: 
+Generate the directory and file structure for a gigantron project.
+
+  
+Usage:
+shell> $ gigantron projectname
+  

data/app_generators/gigantron/gigantron_generator.rb

@@ -0,0 +1,80 @@
+class GigantronGenerator < RubiGen::Base
+  
+  DEFAULT_SHEBANG = File.join(Config::CONFIG['bindir'],
+                              Config::CONFIG['ruby_install_name'])
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @destination_root = File.expand_path(args.shift)
+    @name = base_name
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory ''
+      BASEDIRS.each { |path| m.directory path }
+
+      # Create stubs
+      m.file "Rakefile", "Rakefile"
+      m.file "database.yml", "database.yml"
+      m.file "initialize.rb", "initialize.rb"
+
+      m.file "tasks/import.rake", "tasks/import.rake"
+
+      m.file "test/test_helper.rb", "test/test_helper.rb"
+
+      m.directory "test/models"
+      m.directory "test/tasks"
+
+      m.file "test/tasks/test_import.rb", "test/tasks/test_import.rb"
+
+     
+      m.dependency "install_rubigen_scripts", [destination_root, 'gigantron'], 
+        :shebang => options[:shebang], :collision => :force
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      opts.separator ''
+      opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+
+    # Installation skeleton.  Intermediate directories are automatically
+    # created so don't sweat their absence here.
+    BASEDIRS = %w(
+      tasks
+      db
+      models
+      lib
+      test
+    )
+end

data/app_generators/gigantron/templates/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'fileutils'
+
+GTRON_ENV = :real
+require 'initialize'
+
+require 'gigantron/tasks/test'
+require 'gigantron/tasks/db'
+
+Dir['tasks/**/*.rake'].each {|r| load r }
+

data/app_generators/gigantron/templates/database.yml

@@ -0,0 +1,9 @@
+:real:
+  :adapter: sqlite3
+  :database: db/real.sqlite3
+  :timeout: 5000
+
+:test:
+  :adapter: sqlite3
+  :database: db/test.sqlite3
+  :timeout: 5000

data/app_generators/gigantron/templates/initialize.rb

@@ -0,0 +1,26 @@
+# This file handles all the background initialization work that the programmer
+# shouldn't have to worry about.  
+# This includes database startup, common requires, activesupport, and other
+# magic.  I'm not sure if this is a good idea or not.
+
+# ENV works like in rails, except is :real or :test
+GTRON_ENV rescue GTRON_ENV = :real 
+
+GTRON_ROOT = File.dirname(__FILE__)
+
+require 'rubygems'
+require 'rake'
+
+require 'activesupport'
+#set up autoload paths
+Dependencies.load_paths << "#{GTRON_ROOT}/lib/"
+
+gem 'dm-core'
+require 'data_mapper'
+
+
+def get_db_conn(env)
+  DataMapper.setup(:default, YAML::load(File.read("database.yml"))[env])
+  Dir["models/**/*.rb"].each {|r| load r }
+  nil
+end

data/app_generators/gigantron/templates/tasks/import.rake

@@ -0,0 +1,10 @@
+desc "Import data into the database"
+task :import do
+  # Acquire your data (e.g. from input/ or something) and parse it into
+  # your database.  Your models should probably be the ones doing the heavy
+  # lifting on this one.
+  #
+  # Ex:
+  #   Foo.import_yaml(FileList["input/*.yml"].to_a)
+  get_db_conn(GTRON_ENV)
+end

data/app_generators/gigantron/templates/test/tasks/test_import.rb

@@ -0,0 +1,23 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class TestImport < Test::Unit::TestCase
+  def setup
+    get_db_conn(GTRON_ENV)
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    load File.dirname(__FILE__) + '/../../tasks/import.rake'
+  end
+
+  should "import data" do
+    # Testing rake is a bit different
+    # http://blog.nicksieger.com/articles/2007/06/11/test-your-rake-tasks
+    # Example:
+    #   @rake["task_name"].invoke
+    @rake["import"].invoke
+    assert true
+  end
+
+  def teardown
+    Rake.application = nil
+  end
+end

data/app_generators/gigantron/templates/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require File.dirname(__FILE__) + '/../initialize'
+silence_warnings { GTRON_ENV = :test }

data/bin/gigantron

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rubigen'
+
+if %w(-v --version).include? ARGV.first
+  require 'gigantron/version'
+  puts "#{File.basename($0)} #{Gigantron::VERSION::STRING}"
+  exit(0)
+end
+
+require 'rubigen/scripts/generate'
+source = RubiGen::PathSource.new(:application, 
+  File.join(File.dirname(__FILE__), "../app_generators"))
+RubiGen::Base.reset_sources
+RubiGen::Base.append_sources source
+RubiGen::Scripts::Generate.new.run(ARGV, :generator => 'gigantron')

data/config/hoe.rb

@@ -0,0 +1,80 @@
+require 'gigantron/version'
+
+AUTHOR = 'Ben Hughes'  # can also be an array of Authors
+EMAIL = "ben@pixelmachine.org"
+DESCRIPTION = "description of gem"
+GEM_NAME = 'gigantron' # what ppl will type to install your gem
+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', '>= 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"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = Gigantron::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'gigantron documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+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 ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/gigantron_generators/model/USAGE

@@ -0,0 +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
+  

data/gigantron_generators/model/model_generator.rb

@@ -0,0 +1,51 @@
+class ModelGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      m.directory "models/"
+      m.template  "models/model.rb", "models/#{@name}.rb"
+      
+      m.directory "test/"
+      m.directory "test/models/"
+      m.template  "test/models/test_model.rb", "test/models/test_#{name}.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/gigantron_generators/model/templates/models/model.rb

@@ -0,0 +1,6 @@
+class <%= name.capitalize %>
+  include DataMapper::Resource
+
+  property :id, Integer, :serial => true
+
+end

data/gigantron_generators/model/templates/test/models/test_model.rb

@@ -0,0 +1,13 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Test<%= name.capitalize %> < Test::Unit::TestCase
+  def setup
+    get_db_conn(GTRON_ENV)
+    DataMapper.auto_migrate!
+  end
+
+  #replace with real tests
+  should "be true" do
+    assert true
+  end
+end

data/gigantron_generators/task/USAGE

@@ -0,0 +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

data/gigantron_generators/task/task_generator.rb

@@ -0,0 +1,50 @@
+class TaskGenerator < RubiGen::Base
+
+  default_options :author => nil
+
+  attr_reader :name
+
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    record do |m|
+      m.directory "tasks/"
+      m.template  "tasks/task.rake", "tasks/#{@name}.rake"
+      m.directory "test/"
+      m.directory "test/tasks/"
+      m.template  "test/tasks/test_task.rb", "test/tasks/test_#{@name}.rb"
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a ...
+
+USAGE: #{$0} #{spec.name} name
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/gigantron_generators/task/templates/tasks/task.rake

@@ -0,0 +1,4 @@
+desc "Write a task description and write it good!"
+task :<%= name %> do
+  get_db_conn(GTRON_ENV)
+end

data/gigantron_generators/task/templates/test/tasks/test_task.rb

@@ -0,0 +1,22 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+class Test<%= name.capitalize %> < Test::Unit::TestCase
+  def setup
+    get_db_conn(GTRON_ENV)
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    load File.dirname(__FILE__) + '/../../tasks/<%= name %>.rake'
+  end
+
+  should "be true" do
+    # Testing rake is a bit different
+    # http://blog.nicksieger.com/articles/2007/06/11/test-your-rake-tasks
+    # Example:
+    #   @rake["task_name"].invoke
+    assert true
+  end
+
+  def teardown
+    Rake.application = nil
+  end
+end

data/lib/gigantron/tasks/db.rb

@@ -0,0 +1,8 @@
+namespace :db do
+  desc "Automatically migrate databases according to models"
+  task :automigrate do
+    puts "Migrating your database"
+    get_db_conn(GTRON_ENV)
+    DataMapper.auto_migrate!
+  end
+end

data/lib/gigantron/tasks/test.rb

@@ -0,0 +1,30 @@
+require 'rake/testtask'
+
+desc "Test all models and tasks"
+task :test do
+  errors = %w(test:models test:tasks).collect do |task|
+    begin
+      Rake::Task[task].invoke
+      nil
+    rescue => e
+      task
+    end
+  end.compact
+  abort "Errors running #{errors.to_sentence}!" if errors.any?
+end
+
+namespace :test do
+  Rake::TestTask.new(:models) do |t|
+    t.libs << "test"
+    t.pattern = 'test/models/test_*.rb'
+    t.verbose = true
+  end
+  Rake::Task['test:models'].comment = "Run model tests"
+
+  Rake::TestTask.new(:tasks) do |t|
+    t.libs << "test"
+    t.pattern = 'test/tasks/test_*.rb'
+    t.verbose = true
+  end
+  Rake::Task['test:tasks'].comment = "Run task tests"
+end