datum 0.8.0 → 0.8.1

data/README.md

@@ -1,4 +1,4 @@
-# Datum is currently under development and pre-1.0
+##### Datum is currently under development and pre-1.0
 
 ## Datum
 
@@ -12,9 +12,15 @@ Datum is a simple take on Data Driven Testing for Rails. Datum:
 
 ## Rails 3
 
-Datum is still in development. Currently, we're working with Rails 3.2.6 and Ruby 1.9.3.
+Datum is still in development. Currently, we're working with Rails 3.2.6 and Ruby 1.9.3. 
 
-### Getting Started
+For now, our target test framework is <b>Test::Unit</b>.
+
+## Getting Started
+
+Datum is a simple tool for data driven testing. If you have a test case that you can parameterize and want to manage your parameters via a database, Datum is fun.
+
+### Setting Up
 
 Add Datum to your Gemfile:
 
@@ -32,4 +38,95 @@ rake datum:enable
 
 Enable will create several directories in your test directory. It will also prompt you to ask for permission to update your database.yml and application.rb. You MUST review both files even if you have Enable update them for you.
 
-When you are finished, you are ready to add Datum migrations and models to your application as needed.
+Additionally, Enable will further prompt you for permission to verify all core Datum functionality. Verification will include all basic Datum rake tasks along with execution of tests that use Datum's drive_with. 
+
+<span style="color: red;">WARNING:</span> Enable's verification <b>WILL DROP the Datum Database</b>. If you are re-installing Datum, be sure to back-up your Datum store BEFORE running Enable.
+
+When finished, you are ready to create a Datum specific database and add migrations and models. 
+
+### Creating a Datum Specific Database and Tables
+
+To create a Datum specific database:
+
+```console
+rake datum:db:create
+```
+
+To generate Datum specific migrations and models, the command and options are similar to using Rails scaffolds.
+
+```console
+rails generate datum ModelName column_one:type column_two:type
+```
+
+Models and migrations are placed in your application under test/lib/datum/models and test/lib/datum/migrate. Edit these files as needed. When you are ready to migrate use the Datum migration command.
+
+```console
+rake datum:db:migrate
+```
+
+You are now ready to put data in a newly created table.
+
+### Binding a Test Case to a Table
+
+When writing a unit test or functional test with <b>Test::Unit</b>, bind your test case to your table with drive_with.
+
+```ruby
+test "vote_counter should count positive votes" do
+  drive_with :table_items
+```
+
+Once bound to your table, drive_with will work with the Datum infrastructure so that your test case will execute once for every row in the table.
+
+To access the current row, use the datum accessor:
+
+```ruby
+test "vote_counter should count positive votes" do
+  drive_with :table_items
+  puts "starting test case..."
+  puts "the current id of the row: #{datum.id}"
+```
+
+Will output:
+
+```console
+  starting test case...
+  1
+  
+  starting test case...
+  2
+  
+  starting test case...
+  3
+```
+### Move Datum Table Data Beyond the Datum Database
+
+To convert your Datum tables to fixtures (for storage in scc, etc)
+
+```console
+rake datum:db:dump
+```
+
+To get Datum data from fixtures into the Datum specific database:
+
+```console
+rake datum:db:load
+```
+
+To convert a Datum table into a file so that drive_with does <b>not</b> use the table (and is thus <b>not</b> dependent on a Datum database / settings / etc) 
+
+```console
+rake datum:db:localize[table_items]
+```
+
+## Troubleshooting
+
+### In Development
+Datum is still being created and isn't officially *ready*. It's likely that we have code paths that are not fully tested and some that are plain broken. Stay tuned for a 1.0.
+
+## Additional Information
+
+### Tyemill
+Tyemill is a technology company in Seattle, Washington. We make a few line-of-business applications and love Ruby, Rails and Open Source.
+
+## License
+MIT License. Copyright 2012 Tyemill LLC. http://tyemill.com

data/lib/datum/context.rb

@@ -17,9 +17,9 @@ module Datum
       result = nil if @@table_data.nil?
       result = @@table_data.delete_at(0) unless @@table_data.nil?
       @@initialized = false if !result.nil? && @@table_data.count == 0
-      
+
       log "next row table_data: #{@@table_data}"
-      log "next row result: #{result.attributes}" unless result.nil?
+      #log "next row result: #{result.attributes}" unless result.nil?
       log "next row initialized: #{@@initialized}"
       return result
     end

data/lib/datum/db_tasks.rb

@@ -1,12 +1,13 @@
 
 module Datum
+  
   class DbTasks
     def initialize
       Rails.env = @@datum_environment
     end
     
     def create
-      Rake::Task['db:create'].invoke()
+      Rake::Task['db:create'].invoke()  
     end
     
     def migrate
@@ -73,10 +74,15 @@ module Datum
         f1.puts "]\nend\nend"
       end
     end
-    
+
     private
     @@local_path = "#{Rails.root}/test/lib/datum"
+    
     @@datum_environment = "datum"
     
+    def context
+      return Datum::Context
+    end
+
   end
 end

data/lib/datum/driver_helper.rb

@@ -38,8 +38,10 @@ module Datum
     def self.load_model_data table
       data = nil
       begin
+        log "load_model_data attempting to constantize"
         driver_method = table.to_s.singularize
         data = driver_method.classify.constantize.all.reverse
+        log "load_model_data data loaded"
       rescue Exception => exc
         log "load_model_data: could not get data from model #{driver_method}"
         log exc
@@ -53,18 +55,50 @@ module Datum
     def self.load_file_data table
       data = nil
       begin
-        require "lib/datum/locals/#{table}"
-        cls = driver_method.classify.pluralize.constantize
+        driver_method = table.to_s.singularize
+        log "load_file_data: attempting require..."
+        file = "lib/datum/locals/#{table}"
+        klas = driver_method.classify.pluralize
+        require file
+        log "load_file_data: require was successful"
+        cls = klas.constantize
+        log "load_file_data: classify pluralize constantize was successful"
         data = cls::data.reverse
+        log "load_file_data: data reading was successful"
         data = mock_data data
+        log "load_file_data: mocking was successful"
       rescue Exception => exc
         ## database-driven
-        log "load_file_data: file load failed. moving to database load."
+        log "load_file_data: file load failed for: #{file}"
+        log "load_file_data: driver_method: #{driver_method}"
+        log "load_file_data: class: #{klas}"
+        log "... attempting database connection."
       end
       
       return data
     end
     
+    def self.mock_data data
+      modified_data = []
+      data.each_with_index {|e, i|
+        o = Object.new
+        e.each_pair {|key, value|
+          addMockExtension key, value, o
+        }
+        modified_data.push o
+      }
+      return modified_data
+    end
+
+    def self.addMockExtension(ext, instance, obj)
+      method_name = ext.to_sym
+      obj.class.send :define_method, method_name do
+        return instance unless instance.to_i.to_s == instance || instance == ""
+        return nil if instance == ""
+        return instance.to_i
+      end
+    end
+
     private 
     
     def self.context

data/lib/datum/enable_task.rb

@@ -8,6 +8,9 @@ module Datum
       notify_check
       update_yml if @@update_yml
       update_app if @@update_app
+
+      (Datum::VerificationTask.new).verify
+
       puts " Datum enabled.\n "
     end
     
@@ -46,7 +49,8 @@ module Datum
       puts "\n>>>>>>>>>>>>>>>> Attempt updates for you? y/n"
       continue = STDIN.gets.chomp
       unless continue == 'y' || continue == 'yes'
-        puts "\n Files must be updated manually to fully enable Datum\n "
+        puts "\n Files must be updated manually to fully enable Datum"
+        puts " Run rake task 'datum:db:verify' after manual update.\n "
         exit!
       end
     end

data/lib/datum/verification_task.rb

@@ -0,0 +1,124 @@
+module Datum
+  # some reports of connections / settings issues. 
+  # verify allows for a full check of the datum db scenarios
+  # intended to be used as part of enable to report datum readiness
+  class VerificationTask
+
+    def verify
+      
+      puts "\n### !!!Datum Verification !!!"
+      puts "### !!!This command DROPS the Datum Database!!!"
+      puts "\n>>>>>>>>>>>>>>>> Proceed with Datum Verification? y/n"
+      continue = STDIN.gets.chomp
+      
+      unless continue == 'y' || continue == 'yes'
+        puts "\n ... Canceling Datum Verification\n "
+        exit!
+      end
+      
+      database_ready = false
+      database_removed = false
+      files_removed = false
+
+      begin
+        dbtsks = DbTasks.new
+        puts "\n Verifing Datum functionality...\n "
+        dbtsks.create 
+        puts "   >> Database created"
+        copy_verification_files
+        puts "   >> Directories verified\n "
+        dbtsks.migrate
+        database_ready = true 
+        puts "   >> Migration complete"
+        seed_verification_table
+        puts "   >> Storage verified"
+        puts "   >> Attempting data driven test cases from database"
+        exec_test
+        puts "   >> Database driven test complete"
+        dbtsks.dump
+        puts "   >> Fixtures generated"
+        remove_verification_table_data
+        dbtsks.load
+        puts "   >> Fixture data uploaded"
+        dbtsks.localize({:table => "datum_versions"})
+        puts "   >> Localization complete"
+        dbtsks.drop
+        database_removed = true
+        puts "   >> Database dropped"
+        puts "   >> Attempting data driven test cases from file"
+        exec_test
+        puts "   >> Data file driven test complete"
+        remove_verification_files
+        files_removed = true
+        puts " \n ... Core Datum functionality verified!\n "
+      rescue Exception => exc
+        puts "   >> !!!! Verification failed !!!!"
+        puts "#{exc}"
+        puts "\n### !!! Please file email datum@tyemill.com with the above output !!!"
+      ensure
+        remove_verification_table_data if database_ready && !database_removed
+        remove_verification_files unless files_removed 
+      end
+    end
+
+    protected
+
+    def seed_verification_table
+      DatumVersion.create([
+        {:version => "0.0.1"},
+        {:version => "0.8.0"},
+        {:version => "0.8.1"}])
+    end
+
+    def exec_test
+      puts "   >> Starting data-driven test cases...\n "
+      result = system "ruby -Itest #{@@test_src}"
+      raise 'Datum Testcases did not complete successfully!' if !result
+      puts "\n "
+    end
+
+    def remove_verification_table_data
+      DatumVersion.delete_all
+    end
+
+    def copy_verification_files
+      FileUtils.cp_r @@migration_src, "#{@@local_path}/migrate"
+      FileUtils.cp_r @@model_src, "#{@@local_path}/models"
+      FileUtils.cp_r @@test_src, "#{@@unit_dir}"
+    end
+
+    # delete: the migration, the fixture, the ruby file, the model
+    def remove_verification_files
+      files = ["#{@@local_path}/migrate/#{@@migration_file}",
+        "#{@@local_path}/fixtures/#{@@fixture_file}",
+        "#{@@local_path}/locals/#{@@ruby_file}",
+        "#{@@local_path}/models/#{@@model_file}", @@test_drop]
+
+      files.each { |file|
+        context.log "Removing file: #{file}"
+        FileUtils.remove_file file  
+      }
+    end
+
+    private
+    @@local_path = "#{Rails.root}/test/lib/datum"
+    @@gem_path = File.expand_path(File.dirname(__FILE__))
+    @@migration_file = "20120726105125_create_datum_versions.rb"
+    @@version_str = "DatumVersion"
+    @@version_tbl = @@version_str.tableize
+    @@version_single = @@version_tbl.singularize  
+    @@model_file = "#{@@version_single}.rb"
+    @@fixture_file = "#{@@version_tbl}.yml"
+    @@test_file = "#{@@version_single}_test.rb"
+    @@ruby_file = "#{@@version_tbl}.rb"
+    @@migration_src = "#{@@gem_path}/verify_helpers/#{@@migration_file}"
+    @@model_src = "#{@@gem_path}/verify_helpers/#{@@model_file}"
+    @@test_src = "#{@@gem_path}/verify_helpers/#{@@test_file}"
+    @@unit_dir = "#{Rails.root}/test/unit"
+    @@test_drop = "#{@@unit_dir}/#{@@test_file}"
+
+    def context
+      return Datum::Context
+    end
+  end
+end

data/lib/datum/verify_helpers/20120726105125_create_datum_versions.rb

@@ -0,0 +1,18 @@
+# used to help verify basic datum functionality
+# see rake datum:db:verify for details
+class CreateDatumVersions < ActiveRecord::Migration
+  
+  ActiveRecord::Base.establish_connection :datum
+  ActiveRecord::Base.connection.initialize_schema_migrations_table
+   
+  def self.up
+    create_table :datum_versions do |t|
+      t.string :version
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :datum_versions
+  end
+end

data/lib/datum/verify_helpers/datum_version.rb

@@ -0,0 +1,6 @@
+# used to help verify basic datum functionality
+# see rake datum:db:verify for details
+class DatumVersion < ActiveRecord::Base
+  establish_connection :datum
+  
+end

data/lib/datum/verify_helpers/datum_version_test.rb

@@ -0,0 +1,11 @@
+
+# simple test for Datum functionality verification
+require 'test_helper'
+
+class DatumVersionTest < ActiveSupport::TestCase
+
+  test "datum versions should be accessible" do
+    drive_with :datum_versions
+    str = datum.version
+  end
+end

data/lib/datum/version.rb

@@ -1,3 +1,5 @@
 module Datum
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end
+
+## Added datum:db:verify to simplify pre-release holes in config

data/lib/datum.rb

@@ -23,7 +23,7 @@ module Datum
      datum_helper::load_data table if !datum_context::initialized?
      @@driver_row = datum_context.next_row
      log "drive_with table: #{table}"
-     log "drive_with row: #{@@driver_row.attributes}" unless @@driver_row.nil?
+     #log "drive_with row: #{@@driver_row.attributes}" unless @@driver_row.nil?
     end
     
     def datum

data/lib/tasks/datum.rake

@@ -1,4 +1,4 @@
-
+require "datum/verification_task"
 require "datum/enable_task"
 require "datum/db_tasks"
 
@@ -25,14 +25,19 @@ namespace :datum do
     
     desc "Loads fixtures specific to datum database"
     task :load do invoke "load" end
-      
+    
+    #desc "Quick verification of basic datum functionality"
+    #task :verify do invoke "verify" end
+    
     desc "Enables datum execution without database dependency"
     task :localize, :table do |t, args|
       (Datum::DbTasks.new).localize args
     end
     
+    private
     def invoke method
       (Datum::DbTasks.new).send(method)
     end
+    
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datum
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-24 00:00:00.000000000 Z
+date: 2012-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70278656633660 !ruby/object:Gem::Requirement
+  requirement: &70155510735080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +22,7 @@ dependencies:
         version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70278656633660
+  version_requirements: *70155510735080
 description: Flexible data-driven test solution for Rails
 email:
 - datum@tyemill.com
@@ -36,6 +36,10 @@ files:
 - lib/datum/enable_notification.rb
 - lib/datum/enable_task.rb
 - lib/datum/railtie.rb
+- lib/datum/verification_task.rb
+- lib/datum/verify_helpers/20120726105125_create_datum_versions.rb
+- lib/datum/verify_helpers/datum_version.rb
+- lib/datum/verify_helpers/datum_version_test.rb
 - lib/datum/version.rb
 - lib/datum.rb
 - lib/generators/datum/datum_generator.rb
@@ -97,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2858443151350475509
+      hash: 2549513625839685057
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -106,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2858443151350475509
+      hash: 2549513625839685057
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.15