datum 0.9.2 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f77d49168ee185b2c925c6d8d8fbd1ff3cb068f1
+  data.tar.gz: d19c0a88777502311e33d0f68fdbc96d51b1b3bb
+SHA512:
+  metadata.gz: dcb2e5bc40bf205726f0ee085f1b3322555da1165cf28f83a27e15216cda777dbf0d3d12b6537439d829480b2f2572cdf80cbceaeeefe93e9366fd6f3ae64f36
+  data.tar.gz: 93044e6c559672410de7f9475a4118998ba878e61dc1b1dd40363b3378b8ddc30e7aba246ecd56f28f43fc62be0e1ab13a22b2c67aa337efd0864c6834ffbbf7

data/MIT-LICENSE

@@ -1,4 +1,28 @@
-Copyright (c) 2012 Tyemill. http://tyemill.com
+Copyright 2015 Tyemill
+
+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.
+
+#### From https://github.com/iconara/immutable_struct/blob/master/LICENSE
+#### Provided due to use of immutable_struct/blob/master/lib/immutable_struct.rb
+
+Copyright (c) 2010 Theo Hultberg
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,137 +1,9 @@
-##### 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. 
-
-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:
-
-```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.
-
-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.
+##### Datum is currently being updated. Hold on.
 
 ## License
 (The MIT License)
 
-Copyright 2012 Tyemill LLC. http://tyemill.com
+Copyright 2012 - 2015 Tyemill LLC. 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:
 

data/Rakefile

@@ -1,16 +1,10 @@
-#!/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
+
+require 'rdoc/task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -35,4 +29,4 @@ Rake::TestTask.new(:test) do |t|
 end
 
 
-task :default => :test
+task default: :test

data/lib/datum/container.rb

@@ -0,0 +1,64 @@
+require "datum/helpers"
+
+module Datum
+# A Container object holds attributes for a single data test.
+class Container
+
+  # @return [String] the name of the data test method
+  attr_reader :data_method_name
+  # @return [TestCase] the ActiveSupport::TestCase instance of the data test
+  attr_reader :test_instance
+
+  # constructor
+  #
+  # @param data_method_name [String] the name of test method to be called
+  # @param tst_instance [TestCase] the instance containing the data_method_name
+  def initialize(data_method_name, tst_instance)
+    @data_method_name = data_method_name; @test_instance = tst_instance
+    @loaded_data = {}; @invoked_data = {}
+    ::Datum.send(:add_container, self,
+      Container.key(@test_instance, @data_method_name))
+  end
+
+  # @return [int] The total number of tests / data elements / datums
+  def count; @loaded_data.count + @invoked_data.count; end;
+  # @return [Hash] of data
+  def data; @loaded_data.merge(@invoked_data); end
+
+  alias_method :length, :count
+  alias_method :size, :count
+  alias_method :test_count, :count
+
+  # @param [TestCase] the ActiveSupport::TestCase instance for the data_test
+  # @param [String] the name of the data_test method
+  # @return [String] Container compatible Hash key
+  def self.key tst_instance, data_method_name
+    Helpers.build_key(tst_instance, data_method_name)
+  end
+
+private
+
+  def add_datum datum
+    test_name = Helpers.build_test_name(data_method_name, test_count + 1)
+    @loaded_data[Datum.key(test_instance, test_name)] = datum
+    add_data_test test_name
+    [count, test_name]
+  end
+
+  def invoke_datum key, tst_case
+    @invoked_data[key] = datum = @loaded_data.delete(key)
+    tst_case.instance_variable_set :@datum, datum
+    tst_case.send datum.container.data_method_name
+  end
+
+  def add_data_test test_name
+    test_instance.send(:define_method, test_name) do
+      datum_key = Datum.key(nm = self.class.to_s, __method__)
+      container_key = Container.key(nm,
+        Helpers.data_method_from_test_name(__method__))
+      ::Datum.containers[container_key].send(:invoke_datum, datum_key, self)
+    end
+  end
+
+end
+end

data/lib/datum/datum.rb

@@ -0,0 +1,51 @@
+require "datum/container"
+require "datum/helpers"
+require "plan9/structures"
+
+module Datum
+# Datum ImmutableStruct to be extended by data_test test cases
+class Datum < Plan9::ImmutableStruct
+  def self.new(*attrs, &block)
+    attrs.push "datum_id"
+    super(*attrs, &block)
+  end
+
+  # @return [String] Datum compatible Hash key
+  def self.key test_instance, test_name
+    Helpers.build_key(test_instance, test_name)
+  end
+
+protected
+
+  def self.init_new(struct)
+    super(struct)
+    datumize_constructor!(struct)
+    struct
+  end
+
+private
+  def self.datumize_constructor! struct
+
+  struct.class_eval do
+    alias_method :datum_initialize, :initialize
+
+    # @return [String] The name of the test method
+    attr_reader :test_method_name
+    # @return [Container] A reference to the Container of this Datum
+    attr_reader :container
+
+    def initialize(*atrs)
+      dtm_id = configure_attributes
+      is_hash_case?(*atrs) ? atrs.first[:datum_id] = dtm_id : atrs.push(dtm_id)
+      datum_initialize(*atrs)
+    end
+
+    private
+    def configure_attributes
+      @container = ::Datum.send(:current_container)
+      (dtm_id, @test_method_name = @container.send(:add_datum, self))[0]
+    end
+  end
+  end
+end
+end

data/lib/datum/helpers.rb

@@ -0,0 +1,58 @@
+module Datum
+# Various helper functions
+class Helpers
+  class << self
+
+    # @param test_name [String] test case name generated from data_test usage
+    # @return [int] the index of the data_test / datum_id
+    def index_from_test_name test_name
+      ((test_name.to_s.split('_')[-1]).to_i)
+    end
+
+    # @param test_name [String] test case name generated from data_test usage
+    # @return [String] name of the data_test method which generated the test
+    def data_method_from_test_name test_name
+      test_name.slice(/(?<=_).*(?=_)/)
+    end
+
+    # @param data_method_name [String] the name of the data_test method
+    # @param counter [int] the index / datum_id of the current test case
+    # @return [String] test name for current test case, index, data_test method
+    def build_test_name data_method_name, counter
+     "test_#{data_method_name}_#{counter}"
+    end
+
+    # @param test_instance [TestCase] the ActiveSupport::TestCase instance
+    # @param method [String] the name of the method
+    # @return [String] a key for usage in Datum-compatible Hash instances
+    def build_key test_instance, method
+     "#{test_instance}_#{method}"
+    end
+
+    # @param file_name [String] the name of the file to read
+    # @param directory [Pathname] a Pathname representing the file's directory
+    # @param ext [String] optional extention of the file (default: '.rb')
+    # @return [String] the file's contents
+    def read_file file_name, directory, ext = ".rb"
+      File.read directory.join("#{file_name}#{ext}")
+    end
+
+    # reads a ruby file and eval's it's contents at the current code location
+    # @param file_name [String] the name of the file to import
+    # @param directory [Pathname] a Pathname representing the file's directory
+    # @param current_binding [Binding] context at a particular code location
+    def import_file file_name, directory, current_binding
+      eval(read_file(file_name, directory), current_binding)
+    end
+
+    # @param resource [ActiveRecord::Base] an ActiveRecord Model instance
+    # @param override_hash [Hash] Hash of attributes / values to override from
+    # return [Hash] Hash of attributes from provided resource
+    def clone_resource resource, override_hash = nil
+      override_hash.nil? ? resource.dup.attributes.with_indifferent_access :
+        resource.dup.attributes.merge(
+          override_hash.with_indifferent_access).with_indifferent_access
+    end
+  end
+end
+end

data/lib/datum/version.rb

@@ -1,30 +1,11 @@
 module Datum
-  VERSION = "0.9.2"
+  VERSION = "4.0.0"
 end
 
-## 0.8.1
-## Added datum:db:verify to simplify detecting pre-release holes in config
-## Added tests to formally sign-off datum releases (not complete)
-## 0.8.2
-## Fixed errors in verification / environment
-## 0.8.3
-## Added functionality in verification to handle existing datum files
-## 0.8.4
-## Fixed bug with leftover verification test case.
-## 0.8.5
-## Fixed bug with pre-existing datum database (verification failed when
-## pre-existing store exists)
-## 0.8.6
-## Fixed migration not observing schema version (regression)
-## Updated drop to use connection instead of rake task (unreliable)
-## 0.8.7
-## Added db:prepare rake task
-## 0.9.0
-## prepare no longer uses load, instead it uses load_when_empty
-## attr_accessor added to datum_version model
-## 0.9.1
-## updated datum_migration template to include attr_accessible for all 
-## attributes
-## fixed datum verification to use attr_accessible
-## 0.9.2
-## tiny update to fix template for models
+
+
+## 0.8.1 - 0.9.2
+## Original datum, proof-of-concept
+##
+## 4.0.0
+## Full rewrite, updated with latest concepts and code -- Still in Testing

data/lib/datum.rb

@@ -1,101 +1,29 @@
-# 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'
+require "datum/helpers"
+require "datum/datum"
+require "datum/container"
+require "support/test"
+require "support/scenario"
 
 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
+  @@all_containers, @@scenario_path, @@data_path, @@datum_path = nil
 
-    def _run_suite suite, type
-      header = "#{type}_suite_header"
-      puts send(header, suite) if respond_to? header
+  class << self
 
-      filter = options[:filter] || '/./'
-      filter = Regexp.new $1 if filter =~ /\/(.*)\//
+    # @return [Pathname] fully qualified path for the root of datum directory
+    def path; @@datum_path ||= Rails.root.join('test', 'datum'); end
+    # @return [Pathname] fully qualified path for the datum/data directory
+    def data_path; @@data_path ||= ::Datum.path.join('data'); end
+    # @return [Pathname] fully qualified path for the datum/scenarios directory
+    def scenario_path; @@scenario_path ||= ::Datum.path.join('scenarios'); end
+    # @return [Hash] Hash of all loaded Containers
+    def containers; @@all_containers ||= {}; end
 
-      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 }
+  private
+    def add_container container, key
+      ::Datum.containers[key] = container
+      ::Datum.instance_variable_set(:"@current_container", container)
     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
-
+    def current_container; @current_container; end;
   end
-  
-  
-end
+end

data/lib/plan9/structures.rb

@@ -0,0 +1,71 @@
+module Plan9
+
+# A few improvements to a Ruby Struct
+#
+# Re-organized slightly, this code is reused from 'ImmutableStruct'
+# by Theo Hultberg. See https://github.com/iconara/immutable_struct
+# Copyright notice mentioned in the LICENSE file.
+#
+class ImprovedStruct
+  def self.new(*attrs, &block)
+    init_new(Struct.new(*attrs, &block))
+  end
+protected
+  def self.init_new(struct)
+    optionalize_constructor!(struct)
+    extend_dup!(struct)
+    struct
+  end
+private
+  def self.optionalize_constructor!(struct)
+    struct.class_eval do
+      alias_method :struct_initialize, :initialize
+
+      def initialize(*attrs)
+        if is_hash_case?(*attrs)
+          struct_initialize(*members.map { |m| attrs.first[m.to_sym] })
+        else
+          struct_initialize(*attrs)
+        end
+      end
+
+    protected
+      # @return (bool) true if attrs are Hash, false otherwise
+      def is_hash_case?(*a)
+        members.size > 1 && a && a.size == 1 && a.first.instance_of?(Hash)
+      end
+    end
+  end
+
+  def self.extend_dup!(struct)
+    struct.class_eval do
+      def dup(overrides={})
+        self.class.new(to_h.merge(overrides))
+      end
+    end
+  end
+end
+
+# A read-only Struct
+#
+# Re-organized slightly, this code is reused from 'ImmutableStruct'
+# by Theo Hultberg. See https://github.com/iconara/immutable_struct
+# Copyright notice mentioned in the LICENSE file.
+class ImmutableStruct < ImprovedStruct
+protected
+  def self.init_new(struct)
+    make_immutable!(struct)
+    super(struct)
+  end
+
+private
+  def self.make_immutable!(struct)
+    # removes the member= method, to prevent write
+    struct.send(:undef_method, "[]=".to_sym)
+    struct.members.each do |member|
+      struct.send(:undef_method, "#{member}=".to_sym)
+    end
+  end
+
+end
+end

data/lib/support/scenario.rb

@@ -0,0 +1,14 @@
+
+# for use in a scenario file, imports an existing scenario's code and objects
+# @param scenario_name (Symbol) the name of a scenario file
+def __import scenario_name
+  ::Datum::Helpers.import_file scenario_name, ::Datum.scenario_path, binding
+end
+
+# for use in a scenario file, clones the attributes of an existing instance
+# @param resource [ActiveRecord::Base] an ActiveRecord Model instance
+# @param override_hash [Hash] Hash of attributes / values to override from
+# return [Hash] Hash of attributes from provided resource
+def __clone resource, override_hash = nil
+  ::Datum::Helpers.clone_resource resource, override_hash
+end

data/lib/support/test.rb

@@ -0,0 +1,27 @@
+
+
+require "datum/helpers"
+require "datum/container"
+require "datum/datum"
+
+# Extends ActiveSupport::Test with the process_scenario method
+#
+# @note supports most extending test types (functional, integration, etc)
+class ActiveSupport::TestCase
+  include Datum
+  # imports a scenario file into the context of current test
+  # @param scenario_name (Symbol) the name of a scenario file
+  def process_scenario scenario_name
+    __import(scenario_name)
+  end
+end
+
+# Used to define a test to work in conjuction with Datum struct extensions
+# found in a file with the same name in the test/datum/data directory
+# @param name (String) name of the file in the datum/data directory
+# @param block (block) a block of Ruby code
+def data_test name, &block
+  ::Datum::Container.new(name, self)
+  self.send(:define_method, name, &block)
+  self.class_eval(::Datum::Helpers.read_file(name, ::Datum.data_path))
+end