datum 0.8.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Tyemill. http://tyemill.com
+
+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/README.md

@@ -0,0 +1,35 @@
+# Datum is currently under development and pre-1.0
+
+## Datum
+
+Datum is a simple take on Data Driven Testing for Rails. Datum:
+
+* Enables a table to drive a test case
+* Quick conversion from data-driven via a database to via a file
+* Dump tables to fixtures for scc storage
+* Load tables from fixtures
+* Generate datum specific migrations and models
+
+## Rails 3
+
+Datum is still in development. Currently, we're working with Rails 3.2.6 and Ruby 1.9.3.
+
+### Getting Started
+
+Add Datum to your Gemfile:
+
+```ruby
+  gem 'datum'
+```
+
+Run the bundle command to install it.
+
+After you install Datum and add it to your Gemfile, you need to enable it:
+
+```console
+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.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Datum'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/datum/context.rb

@@ -0,0 +1,55 @@
+
+module Datum
+  
+  class Context
+    
+    def self.initialized?
+      return @@initialized
+    end
+    
+    def self.continue?
+      @@table_data.nil? ? false : (@@table_data.count != 0 ? true : false)
+    end
+    
+    protected
+    
+    def self.next_row
+      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 initialized: #{@@initialized}"
+      return result
+    end
+    
+    def self.datum_directory
+      return @@directory
+    end
+    
+    def self.table_data
+      return @@table_data
+    end
+    
+    def self.table_data= data
+      @@table_data = data
+      @@initialized = true if !@@table_data.nil?
+    end
+    
+    def self.log msg
+      Datum::DriverHelper.log msg
+    end
+    
+    @@directory = "#{Rails.env}/lib/datum"
+    @@test_directory = "#{Rails.env}/test/lib/datum"
+    @@table_data = nil
+    @@initialized = false
+    
+    private
+    
+    
+  
+  end
+  
+end

data/lib/datum/db_tasks.rb

@@ -0,0 +1,82 @@
+
+module Datum
+  class DbTasks
+    def initialize
+      Rails.env = @@datum_environment
+    end
+    
+    def create
+      Rake::Task['db:create'].invoke()
+    end
+    
+    def migrate
+      ActiveRecord::Base.establish_connection(Rails.env)
+      ActiveRecord::Migrator.migrate "#{@@local_path}/migrate"
+    end
+    
+    def drop
+      Rake::Task['db:drop'].invoke()
+    end
+    
+    # get into the datum fixtures directory, walk the yml, load into db
+    def load
+      Dir.glob("#{@@local_path}/fixtures/*.yml").entries.each do |entry|
+        file_name = entry.to_s.split('/').last.to_s.split('.')[0]
+        target_model = file_name.classify.constantize
+        data_hash = YAML.load(File.read(entry))
+        data_hash.each_value {|value|
+          value.delete "id"
+          value.delete "created_at"
+          value.delete "updated_at"
+          target_model.create value
+        }
+      end
+    end
+    
+    # get into datum db, get relevant tables, produce ymls (for sharing)
+    # tonyamoyal.com/2009/12/09/
+    # converting-table-data-to-yaml-for-testing-in-ruby-on-rails/
+    def dump
+      sql  = "SELECT * FROM %s"
+      skip_tables = ["schema_info", "schema_migrations"]
+      ActiveRecord::Base.establish_connection(Rails.env)
+      tables = (ActiveRecord::Base.connection.tables - skip_tables)
+      tables.each do |table_name|
+        i = "000"
+        File.open("#{@@local_path}/fixtures/#{table_name}.yml", 
+        'w') do |file|
+          data = ActiveRecord::Base.connection.select_all(sql % table_name)
+          file.write data.inject({}) { |hash, record|
+            hash["#{table_name}_#{i.succ!}"] = record
+            hash}.to_yaml
+        end
+      end
+    end
+    
+    # take Models data, produce a file for use without db
+    def localize args
+      tasked_model = args[:table].classify.constantize
+      data = tasked_model.all
+      file_name = args[:table]
+      File.open("#{@@local_path}/locals/#{file_name}.rb", 'w') do |f1|
+        f1.puts "\n\n#\n# data dump for code access of table #{file_name}"
+        f1.puts "#\nmodule #{tasked_model.to_s.pluralize}"
+        f1.puts "def self.data\nd = ["
+          data.each_with_index {|e, i|
+            hash = e.attributes
+            hash.each_pair {|key, value|
+              new_value = value.to_s
+              hash[key] = new_value
+            }
+            f1.puts "#{hash.to_s},"
+          }
+        f1.puts "]\nend\nend"
+      end
+    end
+    
+    private
+    @@local_path = "#{Rails.root}/test/lib/datum"
+    @@datum_environment = "datum"
+    
+  end
+end

data/lib/datum/driver_helper.rb

@@ -0,0 +1,75 @@
+
+module Datum
+  
+  class DriverHelper
+    
+    def self.load_data table
+      context.table_data = load_file_data(table) || load_model_data(table)
+    end
+    
+    def self.add_datum_exec_ext init_before_exec, result
+      return result if !init_before_exec && !context.initialized?
+      
+      first = !init_before_exec && context.initialized?
+      last = init_before_exec && !context.initialized?
+      
+      base = "," if result == "."
+      base = "," + result unless base == ","
+      base = "[" + base if first
+      base += "]" if last
+      return base
+    end
+    
+    def self.enable_logger
+      @@logger = true
+    end
+    
+    def self.disable_logger
+      @@logger = false
+    end
+    
+    protected
+    @@logger = false
+    
+    def self.log msg
+      Rails.logger.debug "$$ " + msg unless !@@logger
+    end
+    
+    def self.load_model_data table
+      data = nil
+      begin
+        driver_method = table.to_s.singularize
+        data = driver_method.classify.constantize.all.reverse
+      rescue Exception => exc
+        log "load_model_data: could not get data from model #{driver_method}"
+        log exc
+      raise 
+        "Accessing datum database with table / model #{driver_method} failed."
+      end
+      
+      return data
+    end
+    
+    def self.load_file_data table
+      data = nil
+      begin
+        require "lib/datum/locals/#{table}"
+        cls = driver_method.classify.pluralize.constantize
+        data = cls::data.reverse
+        data = mock_data data
+      rescue Exception => exc
+        ## database-driven
+        log "load_file_data: file load failed. moving to database load."
+      end
+      
+      return data
+    end
+    
+    private 
+    
+    def self.context
+      return Datum::Context
+    end
+    
+  end
+end

data/lib/datum/enable_notification.rb

@@ -0,0 +1,27 @@
+
+module Datum
+  NOTIFICATION = 
+  "
+  ### !!!ADDITIONAL UPDATES REQUIRED!!!
+  
+   Datum requires:
+    + application.rb to reference testcase specific models
+    + database.yml to contain a datum environment
+    
+    - application.rb should contain:
+    config.autoload_paths += %W(\#{Rails.root}/test/lib/datum/models)
+    
+    - database.yml should contain something like:
+    
+    datum:
+      adapter: mysql2
+      encoding: utf8
+      reconnect: false
+      database: yourapp_datum
+      pool: 5
+      username: root
+      password: 
+      socket: /tmp/mysql.sock
+
+  "
+end

data/lib/datum/enable_task.rb

@@ -0,0 +1,118 @@
+
+module Datum
+  class EnableTask
+
+    def rock
+      puts "\n Enabling Datum Data-Driven Testing Tools."
+      create_directories
+      notify_check
+      update_yml if @@update_yml
+      update_app if @@update_app
+      puts " Datum enabled.\n "
+    end
+    
+    private
+    @@application_path = @@info = nil
+    @@update_app = @@update_yml = false
+    @@datum_drop_path = "test/lib/datum"
+    @@datum_model_path = 'config.autoload_paths += %W(#{Rails.root}/' + 
+    "#{@@datum_drop_path}" + '/models)'
+    @@datum_app_scan = "config.autoload_paths.*#{@@datum_drop_path}/models"
+    #@@datum_app_scan = "config.autoload_paths.*test\/lib\/datum\/models"
+    #@@datum_drop_path.gsub(Regexp.new("\\/"), "\\/")
+    #"config.autoload_paths.*#{encoded_path}\/models"
+    
+    def create_directories
+      ["#{@@datum_drop_path}/fixtures", "#{@@datum_drop_path}/locals",
+      "#{@@datum_drop_path}/migrate", "#{@@datum_drop_path}/models"].each { 
+        |path| FileUtils.mkdir_p(path) if !File::directory?(path)}  
+      
+      puts " Datum directories created."
+    end
+    
+    def notify_check
+      @@update_yml = need_yml?
+      @@update_app = need_app?
+    
+      notify unless !@@update_yml && !@@update_app
+    end
+    
+    def notify
+      require "datum/enable_notification"
+      puts "#{Datum::NOTIFICATION}"
+      puts " Files that may need updates: "
+      puts "   database.yml" if @@update_yml
+      puts "   application.rb" if @@update_app
+      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 "
+        exit!
+      end
+    end
+    
+    def update_yml
+      app_name = Rails.root.to_s.split("/").last
+      target_hash = @@info["test"] ? @@info["test"] : @@info["development"]
+      
+      if target_hash.nil?
+        puts " Can't update database.yml without a pre-existing"
+        puts " test or development segment."
+        puts "###### !!!! Please update database.yml manually !!!! ######\n "
+        return
+      end
+      
+      File.open(Rails.root.join("config/database.yml"), 'a') do |f1|
+        f1.puts "\n\n#\n# database entry for data-driven testing.\n#"
+        f1.puts "datum:"
+        target_hash.each_pair {|key, value| 
+          f1.puts "  #{key}: #{value}" unless key == "database"
+          f1.puts "  database: #{app_name}_datum" if key == "database"
+        }
+      end
+      
+      puts " database.yml updated with datum entry"
+    end
+    
+    def update_app
+      FileUtils.mkdir_p("tmp")
+      tmp_path = "tmp/app.tmp"
+      tempfile = File.open(tmp_path, 'w')
+      readfile = open_app_file
+
+      readfile.each do |line|
+        tempfile << line
+        if line.strip == "class Application < Rails::Application"
+tempfile << "\n    # Added as part of datum install, enables access to datum specific models\n"
+tempfile << "    #{@@datum_model_path}\n\n"
+        end
+      end
+      
+      readfile.close
+      tempfile.close
+      FileUtils.mv(tmp_path, @@application_path)
+      
+      puts " application.rb updated with datum model reference"
+    end
+    
+    def need_yml?
+      @@info = YAML::load(IO.read(Rails.root.join("config/database.yml")))
+      return true unless @@info["datum"]
+      return false
+    end
+    
+    def need_app?
+      pattern = Regexp.new "#{@@datum_app_scan}"
+      readfile = open_app_file
+      readfile.each do |line|
+        return false if line.scan(pattern).length != 0
+      end
+      return true
+    end
+    
+    def open_app_file
+      @@application_path = Rails.root.join("config/application.rb")
+      return File.new(@@application_path)
+    end
+  end
+end

data/lib/datum/railtie.rb

@@ -0,0 +1,14 @@
+
+module Datum
+  require 'rails'
+#  require 'active_support'
+
+  class Railtie < Rails::Railtie
+    rake_tasks do 
+      load "tasks/datum.rake"
+    end
+#    initializer 'Rails logger' do
+#      Datum.logger = Rails.logger
+#    end
+  end
+end

data/lib/datum/version.rb

@@ -0,0 +1,3 @@
+module Datum
+  VERSION = "0.8.0"
+end

data/lib/datum.rb

@@ -0,0 +1,101 @@
+# datum helps data-driven testing.
+#
+# Author:: Gabriel Marius, Tyemill
+# Copyright:: Copyright (c) 2012 Tyemill, llc.
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+
+require 'datum/railtie'
+require 'datum/driver_helper'
+require 'datum/context'
+#require 'test/unit'
+
+module Datum
+  ActiveSupport::TestCase.class_eval do
+    alias_method :original_initialize, :initialize
+    
+    
+    def initialize(tst)
+      log NEW_TST
+      original_initialize tst
+    end
+    
+    def drive_with table 
+     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?
+    end
+    
+    def datum
+      return @@driver_row
+    end
+    
+    private
+    @@driver_row = nil
+    NEW_TST = "@@@     N E W  T S T  C A S E     @@@@@@@@@@@@@@@@@@@@@@@@@@@@"
+    def log msg
+      datum_helper.log msg
+    end
+    
+    def datum_helper
+      return Datum::DriverHelper
+    end
+    
+    def datum_context
+      return Datum::Context
+    end
+    
+  end
+
+  MiniTest::Unit.class_eval do
+      alias_method :original__run_suite, :_run_suite
+
+    def _run_suite suite, type
+      header = "#{type}_suite_header"
+      puts send(header, suite) if respond_to? header
+
+      filter = options[:filter] || '/./'
+      filter = Regexp.new $1 if filter =~ /\/(.*)\//
+
+      testcases = suite.send("#{type}_methods").grep(filter)
+      assertions = []
+      p_test = nil
+      testcases.map { |test_case|  
+        while datum_context::continue? || p_test != test_case do
+          __runner assertions, test_case, suite
+          p_test = test_case
+        end
+      }
+      return assertions.size, assertions.inject(0) { |sum, n| sum + n }
+    end
+
+    def __runner(assertions, test_case, suite)
+      testcase_result = inner_runner(test_case, suite)
+      assertions.push testcase_result
+    end
+
+    def inner_runner(method, suite)
+      inst = suite.new method
+      inst._assertions = 0
+      print "#{suite}##{method} = " if @verbose
+      @start_time = Time.now
+      datum_init = datum_context::initialized?
+      result = inst.run self
+      time = Time.now - @start_time
+      print "%.2f s = " % time if @verbose
+      result = Datum::DriverHelper::add_datum_exec_ext datum_init, result
+      print result
+      puts if @verbose
+
+      inst._assertions
+    end
+
+    private
+    def datum_context
+      return Datum::Context
+    end
+
+  end
+  
+  
+end

data/lib/generators/datum/datum_generator.rb

@@ -0,0 +1,104 @@
+require 'rails/generators/migration'
+require 'rails/generators/generated_attribute'
+
+# Generator code was modified from https://github.com/ryanb/nifty-generators/
+# Nifty Generators is Copyright (c) 2011 Ryan Bates and distributed via the
+# MIT License
+class DatumGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  no_tasks { attr_accessor :scaffold_name, :model_attributes}
+  source_root File.expand_path('../templates', __FILE__)
+  
+  argument :scaffold_name, :type => :string, :required => true, :banner => 'ModelName'
+  argument :args_for_m, :type => :array, :default => [], :banner => 'model:attributes'
+  
+  class_option :skip_migration, 
+  :desc => 'Don\'t generate migration file for model.', :type => :boolean
+  
+  class_option :skip_model, 
+  :desc => 'Don\'t generate a model or migration file.', :type => :boolean
+  
+  def initialize(*args, &block)
+    super
+    print_usage unless scaffold_name.underscore =~ /^[a-z][a-z0-9_\/]+$/
+    
+    @datum_path = "test/lib/datum"
+    @model_attributes = []
+    @skip_model = options.skip_model?
+
+    args_for_m.each do |arg|
+      if arg.include?(':')
+        @model_attributes << Rails::Generators::GeneratedAttribute.new(*arg.split(':'))
+      end
+    end
+
+    @model_attributes.uniq!
+
+    if @model_attributes.empty?
+      @skip_model = true # skip model if no attributes
+      if model_exists?
+        model_columns_for_attributes.each do |column|
+          @model_attributes << Rails::Generators::GeneratedAttribute.new(
+          column.name.to_s, column.type.to_s)
+        end
+      else
+        @model_attributes << Rails::Generators::GeneratedAttribute.new(
+        'name', 'string')
+      end
+    end
+  end
+  
+  def create_model
+    unless @skip_model
+      template 'datum_model.rb', "#{@datum_path}/models/#{model_path}.rb"
+    end
+  end
+  def create_migration
+    unless @skip_model || options.skip_migration?
+      migration_template 'datum_migration.rb', 
+      "#{@datum_path}/migrate/create_#{model_path.pluralize.gsub('/', '_')}.rb"
+    end
+  end
+  
+private
+
+  def plural_name
+    scaffold_name.underscore.pluralize
+  end
+  
+  def plural_class_name
+    plural_name.camelize
+  end
+  
+  def table_name
+    if scaffold_name.include?('::') && @namespace_model
+      plural_name.gsub('/', '_')
+    end
+  end
+  
+  def class_name
+    scaffold_name.split('::').last.camelize
+  end
+  
+  def model_path
+    class_name.underscore
+  end
+  
+  def model_exists?
+    File.exist? destination_path("#{@datum_path}/models/#{singular_name}.rb")
+  end
+  
+  def destination_path(path)
+    File.join(destination_root, path)
+  end
+  
+  # FIXME: Should be proxied to ActiveRecord::Generators::Base
+  # Implement the required interface for Rails::Generators::Migration.
+  def self.next_migration_number(dirname) #:nodoc:
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+end