michaelbarton-gigantron 0.1.7 → 0.1.8

data/README.rdoc

@@ -0,0 +1,63 @@
+= Gigantron: Processor of Data
+
+== Description:
+
+Gigantron is a simple framework for the creation and organisation of
+data processing projects. Data-processing transforms are created as Rake tasks
+and data is handled through ActiveRecord models.
+
+== Install:
+
+  gem sources -a http://gems.github.com
+  sudo gem install michaelbarton-gigantron
+
+== Getting started:
+
+Create a new gigantron project at the command line specifying the name of the new project you are creating. This will create a new directory called projectname.
+
+  $ gigantron projectname
+
+To get started using gigantron you first need to set up a database to store your data. The file database.yml.example has an example configuration to use an example sqlite3 database. Change the file database.yml.example to database.yml and the project will use these database settings.
+
+To start storing data in the database, you'll next need to create a database model. These models act as bridge between the database tables, and the manipulating them in ruby code. Create a model using generate executable in the script directory.
+
+  $ script/generate model model_name
+
+This creates a migration file and a model file. The migration can be used to define a database table to store your data. The model is used to access the database using object orientated programming. More information on using migrations and models can be found in the activerecord documentation.
+
+One you have defined a model and migration, use rake at the command line to create the database. The following command will create the sqlite database.
+
+  $ rake db:migrate
+
+You can can define and create your own rake task again using the script/generate script.
+
+  $ script/generate task task_name
+
+More information on defining rake tasks can be found in the rake documentation. All your current rake tasks can be listed using the following command.
+
+  $ rake -T
+
+== License:
+
+(The MIT License)
+
+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/Rakefile

@@ -12,7 +12,6 @@ begin
  
     s.files =  FileList["[A-Z]*", "{bin,templates,lib,test}/**/*","README.markdown"]
 
-    s.add_dependency('activesupport', '>= 2.0.2')
     s.add_dependency('templater',     '>= 0.5.0')
     s.add_dependency('rake',          '>= 0.8.1')
     s.add_dependency('Shoulda',       '>= 1.1.1')

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 1
-:patch: 7
+:patch: 8
 :major: 0

data/bin/gigantron

@@ -6,19 +6,11 @@ require 'templater'
 $:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'gigantron/generators/helper'
-require 'gigantron/generators/task_generator'
-require 'gigantron/generators/model_generator'
-require 'gigantron/generators/migration_generator'
 require 'gigantron/generators/new_project_generator'
 
 module GigantronGenerators
   extend Templater::Manifold
-
   add :project,   NewProjectGenerator
-  add :model,     ModelGenerator
-  add :migration, MigrationGenerator
-  add :task,      TaskGenerator
-
 end
 
-GigantronGenerators.run_cli Dir.pwd, 'gigantron', '0.1.5', ARGV
+GigantronGenerators.run_cli Dir.pwd, 'gigantron', '0.1.5', ['project',ARGV].flatten

data/lib/gigantron/generators/helper.rb

@@ -1,11 +1,13 @@
-require 'activesupport'
-
 class Templater::Generator
   def camel_case
-    self.name.camel_case
+    self.name.split('_').map{|e| e.capitalize}.join
   end
   def underscore
-    self.name.underscore
+    self.name.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
   end
   def next_migration_num
     migrations = File.join(%W|#{self.destination_root} db migrate [0-9][0-9][0-9]_*.rb|)

data/lib/gigantron/generators/new_project_generator.rb

@@ -8,18 +8,21 @@ class NewProjectGenerator < Templater::Generator
 
   empty_directory :root,          '%root%'
   empty_directory :log,           File.join('%root%','log')
+  empty_directory :db,            File.join('%root%','db')
   empty_directory :tasks,         File.join('%root%','tasks')
   empty_directory :test,          File.join('%root%','test')
+  empty_directory :script,        File.join('%root%','script')
   empty_directory :'test/models', File.join('%root%','test','models')
+  empty_directory :'test/tasks',  File.join('%root%','test','tasks')
 
   files = [
    ['Rakefile'],
    ['initialize.rb'],
    ['database.yml.example'],
 
-   ['tasks' ,'import.rake'    ],
-   ['test'  ,'test_helper.rb' ],
-   ['test'  ,'tasks',         'test_import.rb'],
+   ['script' ,'generate'       ],
+   ['tasks'  ,'database.rake'  ],
+   ['test'   ,'test_helper.rb' ],
   ]
 
   files.each do |file_array|

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

@@ -1,10 +1,6 @@
 require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Test<%= name.camelcase %> < Test::Unit::TestCase
-  def setup
-    get_db_conn(GTRON_ENV)
-    Gigantron.migrate_dbs
-  end
 
   #replace with real tests
   should "be true" do

data/templates/project/Rakefile

@@ -2,11 +2,11 @@ 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 }
 
+task :environment do
+  Gigantron.boot :real
+end

data/templates/project/database.yml.example

@@ -1,9 +1,6 @@
-# JRuby
-#:test:
-#  :adapter: jdbcsqlite3
-#  :url: jdbc:sqlite:db/test.sqlite3
-
-# Ruby 1.8
-#:test:
-#  :adapter: sqlite3
-#  :database: db/test.sqlite3
+:real:
+  :adapter: sqlite3
+  :database: db/real.sqlite3
+:test:
+  :adapter: sqlite3
+  :database: db/test.sqlite3

data/templates/project/initialize.rb

@@ -1,31 +1,32 @@
-# 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 'activerecord'
 
-#set up autoload paths
-$: << "#{GTRON_ROOT}/lib/"
+module Gigantron
+  class << self
+    def boot(environment)
+      ActiveRecord::Base.establish_connection(db[environment])
 
-require 'rubygems'
-require 'rake'
+      ActiveRecord::Base.logger = Logger.new(
+        File.join(File.dirname(__FILE__),'log',"#{environment}.log"))
 
-require 'active_record'
+      Dir[File.join(%W|#{File.dirname(__FILE__)} models ** *.rb |)].each {|r| 
+        load r }
+    end
 
-def get_db_conn(env)
-  env = env.to_sym
-  #set up logging
-  ActiveRecord::Base.logger = Logger.new("#{GTRON_ROOT}/log/#{env}.log")
+    def migrations
+      File.join(File.dirname(__FILE__), 'db', 'migrate')
+    end
 
-  #load in dbs from database.yml
-  ActiveRecord::Base.establish_connection(
-    YAML::load(File.read("#{GTRON_ROOT}/database.yml"))[env])
+    def db
+      YAML::load(File.read(File.join(File.dirname(__FILE__),'database.yml')))
+    end
 
-  #load all models
-  Dir["#{GTRON_ROOT}/models/**/*.rb"].each {|r| load r }
+    def up!(version=nil)
+      ActiveRecord::Migrator.migrate migrations, version
+    end
 
-  nil
+    def down!
+      up!
+    end
+  end
 end

data/templates/project/script/generate

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'templater'
+
+require 'gigantron/generators/helper'
+require 'gigantron/generators/task_generator'
+require 'gigantron/generators/model_generator'
+require 'gigantron/generators/migration_generator'
+
+module GigantronGenerators
+  extend Templater::Manifold
+
+  add :model,     ModelGenerator
+  add :migration, MigrationGenerator
+  add :task,      TaskGenerator
+
+end
+
+GigantronGenerators.run_cli Dir.pwd, 'gigantron', '0.1.5', ARGV

data/templates/project/tasks/database.rake

@@ -0,0 +1,16 @@
+namespace :db do
+
+  desc "Drops all database tables"
+  task :drop => :environment do
+    Gigantron.down!
+  end
+
+  desc "Migrates database"
+  task :migrate => :environment do
+    version = ENV["VERSION"] ? ENV["VERSION"].to_i : nil
+    Gigantron.up! version
+  end
+
+  desc "Drops and remigrates the database"
+  task :reset => ['drop', 'migrate']
+end

data/templates/project/test/test_helper.rb

@@ -1,8 +1,24 @@
+$:.unshift("..")
+
 require 'rubygems'
+require 'rake'
 require 'test/unit'
 require 'shoulda'
 
-require 'gigantron/migrator'
-require File.dirname(__FILE__) + '/../initialize'
-silence_warnings { GTRON_ENV = :test }
-ENV['GTRON_ENV'] = 'test'
+require 'initialize'
+
+ActiveRecord::Migration.verbose = false
+
+Gigantron.boot :test
+Gigantron.down!
+Gigantron.up!
+
+def rake_up
+  Rake.application = Rake::Application.new
+  Rake::Task.define_task :environment
+  Rake.application
+end
+
+def rake_down
+  Rake.application = nil
+end

data/templates/task/tasks/task.rake

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

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

@@ -2,17 +2,14 @@ require File.dirname(__FILE__) + '/../test_helper.rb'
 
 class Test<%= name.camelcase %> < Test::Unit::TestCase
   def setup
-    get_db_conn(GTRON_ENV)
-    @rake = Rake::Application.new
-    Rake.application = @rake
+    @rake = rake_up
     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
+    @rake["<%= name %>"].invoke
+
+    # Test expected behaviour after rake call
     assert true
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: michaelbarton-gigantron
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors: 
 - Ben Hughes
@@ -9,19 +9,9 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-18 00:00:00 -07:00
+date: 2009-06-03 00:00:00 -07:00
 default_executable: gigantron
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.0.2
-    version: 
 - !ruby/object:Gem::Dependency 
   name: templater
   type: :runtime
@@ -69,9 +59,9 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README.markdown
+- README.rdoc
 files: 
-- README.markdown
+- README.rdoc
 - Rakefile
 - VERSION.yml
 - bin/gigantron
@@ -81,22 +71,19 @@ files:
 - lib/gigantron/generators/model_generator.rb
 - lib/gigantron/generators/new_project_generator.rb
 - lib/gigantron/generators/task_generator.rb
-- lib/gigantron/migrator.rb
-- lib/gigantron/tasks/db.rb
 - lib/gigantron/tasks/test.rb
-- lib/gigantron/version.rb
 - templates/migration/db/migrate/migration.rb
 - templates/model/models/model.rb
 - templates/model/test/models/test_model.rb
 - templates/project/Rakefile
 - templates/project/database.yml.example
 - templates/project/initialize.rb
-- templates/project/tasks/import.rake
-- templates/project/test/tasks/test_import.rb
+- templates/project/script/generate
+- templates/project/tasks/database.rake
 - templates/project/test/test_helper.rb
 - templates/task/tasks/task.rake
 - templates/task/test/tasks/test_task.rb
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/schleyfox/gigantron
 post_install_message: 
 rdoc_options: 

data/README.markdown

@@ -1,75 +0,0 @@
-# Gigantron: Processor of Data
-
-  * 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 ActiveRecord* models.
-
-* Will switch back to DataMapper once it plays nice with JRuby
-
-## FEATURES/PROBLEMS:
-
-  * 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
-  * ActiveRecord
-  * ActiveSupport
-  * Shoulda
-
-## INSTALL:
-
-sudo gem install gigantron
-
-## HACKING:
-
-Check out the website for a quick overview of how to fiddle with the generators
-behind Gigantron. http://gigantron.rubyforge.org.
-
-## LICENSE:
-
-(The MIT License)
-
-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/lib/gigantron/migrator.rb

@@ -1,10 +0,0 @@
-
-# simple function to handle migrating Gigantron databases
-module Gigantron
-  def self.migrate_dbs
-    ActiveRecord::Migration.verbose = 
-      ENV["VERBOSE"] ? ENV["VERBOSE"] == "true" : true
-    ActiveRecord::Migrator.migrate("#{GTRON_ROOT}/db/migrate/", 
-      ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
-  end
-end

data/lib/gigantron/tasks/db.rb

@@ -1,11 +0,0 @@
-require 'gigantron/migrator'
-
-namespace :db do
-  desc "Migrate databases according to models"
-  task :migrate do
-    puts "Migrating your database"
-    get_db_conn(GTRON_ENV)
-    
-    Gigantron.migrate_dbs
-  end
-end

data/lib/gigantron/version.rb

@@ -1,9 +0,0 @@
-module Gigantron #:nodoc:
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 1
-    TINY  = 3
-
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
-end

data/templates/project/tasks/import.rake

@@ -1,10 +0,0 @@
-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(ENV["GTRON_ENV"] || GTRON_ENV)
-end

data/templates/project/test/tasks/test_import.rb

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