datum 4.1.3 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee1edf4f2d3f9a7bc8386ff765d25db81622a113
-  data.tar.gz: 65404192ce0bb1bf2bbb12aa6d3d610a7a21282d
+  metadata.gz: dd71e45fa21da8dee623296b6364276aea53e046
+  data.tar.gz: c62a33f1b5d2d0372eae2dd79f3d1a88a564c9d2
 SHA512:
-  metadata.gz: c09f53fb308eef2919e2ab4c36b33416fd8bbebabb73796e47020b7fbc47c6f768ce677040b511d6b506c5a3db9fe7d254b161f820b691c4b8ad02f17b18b6bd
-  data.tar.gz: d25b032dd1e5e285bf2bb69a015eef7ccf650544f3191af9b637f9886369d2af4ea1e8cde8042451d2b02d3301899a4f66900656f0e582d43131d898d87d075e
+  metadata.gz: 656998cde9a7af4d4548e1d77e2f25ca4a09745479ef4840d680ae62a9115ff87395bd0ad5e8186fe5f0db995c9c5bad272773b1b17c09da2ffa03468556e07e
+  data.tar.gz: f5d4b814485362e88872ee61b54f851c1033b92d5ffe3edb0571cc3a89d0c0c3d75bfbbe3e09e5e7edcf84208f17b81c97dcb151b7b090babf6798a3f18b8dfb

data/MIT-LICENSE

@@ -0,0 +1,44 @@
+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
+"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,311 @@
+## Datum: A flexible data-driven test solution for Rails
+
+### Synopsis
+Datum includes an easy-to-use mechanism for generating test cases based on data attributes. For more granular control when seeding the test database, Datum introduces Scenarios. By combining these features, Datum can be extremely useful and fun.
+
+
+### Feature List
+**1. Tests coupled with datasets**: Datum adds a data-driven extension to the default Rails testing infrastructure. When a data_test is defined, it is coupled with a dataset you define. For each dataset, a test case is generated greatly simplifying adding and removing additional cases.
+
+**2. On-demand test database seeding**: Datum Scenarios are a per-test or per-test-class database seeding mechanism. Each Scenario can use any set of Models in a single file and can be self-contained or referenced via other Scenarios.
+
+### Installing
+Update your Gemfile with:
+
+```ruby
+gem 'datum'
+```
+
+Next run the bundle command:
+
+```console
+bundle install
+```
+
+To create the default datum directories:
+
+```console
+rake datum:install
+```
+
+### Simple Examples
+
+#### data_test: Data Driven Tests for Rails
+To get started, we'll look at a simple Person Model app/models/person.rb:
+
+```ruby
+class Person < ActiveRecord::Base
+
+  validates_presence_of :first_name, :last_name
+
+  # "John Doe" from first_name: "John", last_name: "Doe"
+  def name
+    "#{self.first_name} #{self.last_name}"
+  end
+
+  # "John D." from first_name: "John" last_name: "Doe"
+  def short_name
+    "#{self.first_name} #{self.last_name.capitalize[0]}."
+  end
+end
+```
+
+Now let's create a test test/models/person_test.rb:
+
+```ruby
+require 'test_helper'
+class PersonTest < ActiveSupport::TestCase
+  test 'should confirm short_name' do
+    person = Person.create first_name: "Marge", last_name: "Simpson"
+    assert_equal "Marge S.", person.short_name
+  end
+end
+```
+
+Executing the test:
+
+```console
+# Running:
+
+.
+
+1 runs, 1 assertions, 0 failures, 0 errors, 0 skips
+```
+
+To convert our test to be data-driven - test/models/person_test.rb:
+
+```ruby
+require 'test_helper'
+class PersonTest < ActiveSupport::TestCase
+  #test 'should confirm short_name' do
+  #  person = Person.create first_name: "Marge", last_name: "Simpson"
+  #  assert_equal "Marge S.", person.short_name
+  #end
+
+  data_test 'should_confirm_shortname' do
+    person = Person.create first_name: @datum.first_name, last_name: @datum.last_name
+    assert_equal @datum.short_name, person.short_name
+  end
+end
+```
+
+In the data_test, the fixed values of the original test have been replaced with the usage of the @datum.[attribute] variables. For each dataset defined, the data_test will be called and @datum will provide access.
+
+Next, we'll define our Datum and data in test/datum/data/should_confirm_shortname.rb:
+
+```ruby
+  # Sub-class the Datum struct with attributes we need for our test
+  SimpleShortName = Datum.new(:first_name, :last_name, :short_name)
+
+  # Define instances for our test cases
+  SimpleShortName.new "Marge", "Simpson", "Marge S."
+  SimpleShortName.new "Homer", "Simpson", "Homer S."
+```
+
+Executing:
+
+```console
+# Running:
+
+..
+
+2 runs, 2 assertions, 0 failures, 0 errors, 0 skips
+```
+
+Adding more datasets and thus more generated test cases test/datum/data/should_confirm_shortname.rb:
+
+```ruby
+  SimpleShortName = Datum.new(:first_name, :last_name, :short_name)
+
+  # Define instances for our test cases
+  SimpleShortName.new "Marge",  "Simpson", "Marge S."
+  SimpleShortName.new "Homer",  "Simpson", "Homer S."
+  SimpleShortName.new "Lisa",   "Simpson", "Lisa S."
+  SimpleShortName.new "Bart",   "Simpson", "Bart S."
+  SimpleShortName.new "Maggie", "Simpson", "Maggie S."
+```
+
+```console
+# Running:
+
+.....
+
+5 runs, 5 assertions, 0 failures, 0 errors, 0 skips
+```
+
+#### Scenarios: On-demand Test Database Seeding
+To get started, we'll look at a simple Person Model app/models/person.rb:
+
+```ruby
+class Person < ActiveRecord::Base
+
+  validates_presence_of :first_name, :last_name
+
+  # "John Doe" from first_name: "John", last_name: "Doe"
+  def name
+    "#{self.first_name} #{self.last_name}"
+  end
+
+  # "John D." from first_name: "John" last_name: "Doe"
+  def short_name
+    "#{self.first_name} #{self.last_name.capitalize[0]}."
+  end
+end
+```
+
+Now let's create a test test/models/person_test.rb:
+
+```ruby
+require 'test_helper'
+class PersonTest < ActiveSupport::TestCase
+  test 'should confirm short_name' do
+    person = Person.create first_name: "Marge", last_name: "Simpson"
+    assert_equal "Marge S.", person.short_name
+  end
+end
+```
+
+Instead of using a Fixture or defining our variables in-line, we'll modify our test to use a Scenario. First, let's define the Scenario test/datum/scenarios/simpsons_scenario.rb:
+
+```ruby
+ @marge = Person.create(first_name: "Marge", last_name: "Simpson")
+ @homer = Person.create(__clone(@marge, {first_name: "Homer"}))
+```
+
+Now, let's modify our test, test/models/person_test.rb:
+
+```ruby
+require 'test_helper'
+class PersonTest < ActiveSupport::TestCase
+  test 'should confirm short_name' do
+    process_scenario :simpsons_scenario
+    assert_equal "Marge S.", @marge.short_name
+    assert_equal "Homer S.", @homer.short_name
+  end
+end
+```
+
+#### Data-Driven Tests Combined with On-Demand Test DB Seeding
+To get started, we'll look at a simple Person Model app/models/person.rb:
+
+```ruby
+class Person < ActiveRecord::Base
+
+  validates_presence_of :first_name, :last_name
+
+  # "John Doe" from first_name: "John", last_name: "Doe"
+  def name
+    "#{self.first_name} #{self.last_name}"
+  end
+
+  # "John D." from first_name: "John" last_name: "Doe"
+  def short_name
+    "#{self.first_name} #{self.last_name.capitalize[0]}."
+  end
+end
+```
+
+Now let's define a data_test test/models/person_test.rb:
+
+```ruby
+require 'test_helper'
+class PersonTest < ActiveSupport::TestCase
+  data_test 'should_confirm_shortname' do
+    person = Person.create first_name: @datum.first_name, last_name: @datum.last_name
+    assert_equal @datum.short_name, person.short_name
+  end
+end
+```
+
+Let's add some initial data test/datum/data/should_confirm_shortname.rb:
+
+```ruby
+  SimpleShortName = Datum.new(:first_name, :last_name, :short_name)
+
+  # Define instances for our test cases
+  m = SimpleShortName.new "Marge",  "Simpson", "Marge S."
+  SimpleShortName.new "Homer",  m.last_name, "Homer S."
+  SimpleShortName.new "Lisa",   m.last_name, "Lisa S."
+  SimpleShortName.new "Bart",   m.last_name, "Bart S."
+  SimpleShortName.new "Maggie", m.last_name, "Maggie S."
+```
+
+Now let's define a Scenario test/datum/scenarios/simpsons_scenario.rb:
+
+```ruby
+ @marge   = Person.create(first_name: "Marge", last_name: "Simpson")
+ @homer   = Person.create(__clone(@marge, {first_name: "Homer"}))
+ @lisa    = Person.create(__clone(@marge, {first_name: "Lisa"}))
+ @bart    = Person.create(__clone(@marge, {first_name: "Bart"}))
+ @maggie  = Person.create(__clone(@marge, {first_name: "Maggie"}))
+```
+
+Now let's update our data_test to make use of our Scenario test/models/person_test.rb:
+
+```ruby
+require 'test_helper'
+class PersonTest < ActiveSupport::TestCase
+  data_test 'should_confirm_shortname' do
+    process_scenario :simpsons_scenario
+    person = self.instance_variable_get("@#{@datum.first_name.downcase}")
+    assert_equal @datum.first_name, person.first_name
+    assert_equal @datum.last_name, person.last_name
+    assert_equal @datum.short_name, person.short_name
+  end
+end
+```
+
+Executing the test:
+
+```console
+# Running:
+
+.....
+
+5 runs, 15 assertions, 0 failures, 0 errors, 0 skips
+```
+
+### Real-World Examples (Not Finished)
+A Model Test to verify addresses from different countries:
+
+```ruby
+require 'test_helper'
+class AddressLabelTest < ActiveSupport::TestCase
+
+  # makes use of 'AddressLabel' Model
+  data_test 'should_verify_address_labels' do
+    # label = AddressLabel.create
+
+    #assert_equal @datum.
+    #assert_equal @datum.
+    #assert_equal @datum.
+  end
+end
+```
+
+A Functional Test to verify CRUD with different permissions:
+
+```ruby
+require 'test_helper'
+class AddressLabelTest < ActiveSupport::TestCase
+
+  # makes use of 'AddressLabel' Model
+  data_test 'should_verify_address_labels' do
+    # label = AddressLabel.create
+
+    #assert_equal @datum.
+    #assert_equal @datum.
+    #assert_equal @datum.
+  end
+end
+```
+
+
+
+### License
+
+MIT License. Copyright 2012-2015 Tyemill. http://tyemill.com
+
+You are not granted rights or licenses to the trademarks of Tyemill, including without limitation the Datum name or logo.
+
+Datum struct uses ImprovedStruct and ImmutableStruct which are derivitive works based on ImmutableStruct by Theo Hultberg. This great class can be found here: [Immutable Struct](https://github.com/iconara/immutable_struct)

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+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/container.rb

@@ -0,0 +1,81 @@
+require "datum/helpers"
+
+module Datum
+# A Container holds attributes for a single data test.
+#
+# A data_test definition references a specific file in test/datum/data. When
+# the data file is loaded, each Datum created is associated with a Container
+# which in-turn is associated with the data_test.
+#
+# Container references are stored in Datum::containers
+class Container
+
+  # @!attribute [r] data_method_name
+  # The name of the data test method
+  # @return [String]
+  attr_reader :data_method_name
+
+  # @!attribute [r] test_instance
+  # The ActiveSupport::TestCase instance of the data test
+  # @return [ActiveSupport::TestCase]
+  attr_reader :test_instance
+
+  # @!attribute [r] count
+  # The total number of test cases generated for the data method
+  # @return [Fixnum]
+  def count; @loaded_data.count + @invoked_data.count; end;
+
+  # @!attribute [r] data
+  # A Hash of data elements, datum structs for the test case
+  # @return [Hash]
+  def data; @loaded_data.merge(@invoked_data); end
+
+  alias_method :length, :count
+  alias_method :size, :count
+  alias_method :test_count, :count
+
+  # @!visibility private
+  # Creates a Hash key formatted for use with a Container.
+  # @param [TestCase] tst_instance The TestCase instance for the data_test
+  # @param [String] data_method_name The name of the data_test method
+  # @return [String]
+  def self.key tst_instance, data_method_name
+    Helpers.build_key(tst_instance, data_method_name)
+  end
+
+  # @!visibility private
+  # @param [String] data_method_name The name of test method to be called
+  # @param [TestCase] tst_instance 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
+
+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,69 @@
+require "datum/container"
+require "datum/helpers"
+require "plan9/structures"
+
+module Datum
+# Datum is an Immutable Struct to be used for creating test cases.
+# @!attribute [r] datum_id
+#  The index of the test case and the data from it's Datum
+#  @return [Fixnum]
+# @!attribute [r] test_method_name
+#  The name of the test case generated
+#  @return [String]
+# @!attribute [r] container
+#  The Container reference which generated this Datum and test case
+#  @return [Container]
+class Datum < Plan9::ImmutableStruct
+  # @!visibility private
+  # Creates a Hash key formatted for use with a Datum
+  # @param [TestCase] test_instance The TestCase instance for the test
+  # @param [String] test_name The name of the test
+  # @return [String] Datum compatible Hash key
+  def self.key test_instance, test_name
+    Helpers.build_key(test_instance, test_name)
+  end
+
+  # @!visibility private
+  def self.new(*attrs, &block)
+    attrs.push "datum_id"
+    super(*attrs, &block)
+  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
+
+    # @!attribute [r] test_method_name
+    # @return [String] The name of the test method
+    attr_reader :test_method_name
+
+    # @!attribute [r] container
+    # @return [Container] A reference to the Container of this Datum
+    attr_reader :container
+
+    # @!visibility private
+    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,67 @@
+module Datum
+
+# @!visibility private
+# Various helper functions
+class Helpers
+  class << self
+    # @!visibility private
+    # @param [String] test_name 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
+
+    # @!visibility private
+    # @param [String] test_name 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
+
+    # @!visibility private
+    # Test name for current test case, index, data_test method
+    # @param [String] data_method_name The name of the data_test method
+    # @param [int] counter The index / datum_id of the current test case
+    # @return [String]
+    def build_test_name data_method_name, counter
+     "test_#{data_method_name}_#{counter}"
+    end
+
+    # @!visibility private
+    # @param [TestCase] test_instance The ActiveSupport::TestCase instance
+    # @param [String] method 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
+
+    # @!visibility private
+    # @param [String] file_name The name of the file to read
+    # @param [Pathname] directory A Pathname representing the file's directory
+    # @param [String] ext 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
+
+    # @!visibility private
+    # Reads a ruby file and eval's it's contents in the context of the Binding
+    # @param [String] file_name The name of the file to import
+    # @param [Pathname] directory A Pathname representing the file's directory
+    # @param [Binding] current_binding Context at a particular code location
+    def import_file file_name, directory, current_binding
+      eval(read_file(file_name, directory), current_binding)
+    end
+
+    # @!visibility private
+    # @param [ActiveRecord::Base] resource An ActiveRecord Model instance
+    # @param [Hash] override_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

@@ -0,0 +1,24 @@
+module Datum
+  # @!visibility private
+  VERSION = "4.1.4"
+end
+
+
+## 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
+##
+## 4.0.x
+## Several small updates (readme, etc) -- Readme still needs work.
+## 4.0.6
+## Seems like the build process was dead on arrival? Trying a re-build .7
+## 4.0.7
+## Does not seem to have fixed the issue. :(
+## 4.0.8
+## Removing railtie reference
+## 4.0.9
+## Removing railtie and rake task
+## 4.1.0
+## Removing files.

data/lib/datum.rb

@@ -0,0 +1,45 @@
+
+require "datum/helpers"
+require "datum/datum"
+require "datum/container"
+require "support/test"
+require "support/scenario"
+
+# Datum is a flexible data-driven test solution for Rails.
+#
+# Datum's primary features include defining data-driven tests via the
+# data_test method and Scenarios, a load-on-demand mechanism for seeding the
+# test database.
+module Datum
+  @@all_containers, @@scenario_path, @@data_path, @@datum_path = nil
+
+  class << self
+
+    # @!attribute [r] path
+    # Fully qualified path for the root of datum directory
+    # @return [Pathname]
+    def path; @@datum_path ||= Rails.root.join('test', 'datum'); end
+
+    # @!attribute [r] data_path
+    # Fully qualified path for the datum/data directory
+    # @return [Pathname]
+    def data_path; @@data_path ||= ::Datum.path.join('data'); end
+
+    # @!attribute [r] scenario_path
+    # Fully qualified path for the datum/scenarios directory
+    # @return [Pathname]
+    def scenario_path; @@scenario_path ||= ::Datum.path.join('scenarios'); end
+
+    # @!attribute [r] containers
+    # Hash of all loaded Containers
+    # @return [Hash]
+    def containers; @@all_containers ||= {}; end
+
+  private
+    def add_container container, key
+      ::Datum.containers[key] = container
+      ::Datum.instance_variable_set(:"@current_container", container)
+    end
+    def current_container; @current_container; end;
+  end
+end

data/lib/plan9/structures.rb

@@ -0,0 +1,76 @@
+# @!visibility private
+module Plan9 # Module for simple code reuse between various projects.
+# @!visibility private
+class ImprovedStruct # 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.
+#
+  # @!visibility private
+  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
+      def is_hash_case?(*a)
+      # @return (bool) true if attrs are Hash, false otherwise
+        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
+
+# @!visibility private
+class ImmutableStruct < ImprovedStruct # 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.
+
+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,42 @@
+
+# From a scenario file, imports an existing scenario's code into the current
+# Binding context of the current scenario.
+#
+# @param [Symbol, String] scenario_name The name of a scenario file
+# @return [void]
+#
+# @example Using __import
+#   # test/datum/scenarios/springfield_police_scenario.rb
+#   @clancy = Person.create(first_name: "Clancy", last_name: "Wiggum")
+#   @eddie = Person.create(first_name: "Eddie", last_name: "Police-Officer")
+#
+#   # test/datum/scenarios/extended_simpsons_scenario.rb
+#   @homer = Person.create(first_name: "Homer", last_name: "Simpson")
+#   @marge = Person.create(__clone(@homer, {first_name: "Marge"}))
+#   @bart = Person.create(__clone(@homer, {first_name: "Marge"}))
+#
+#   __import :springfield_police_scenario # will give us clancy, eddie
+#
+#   # Using @eddie from imported :springfield_police_scenario to
+#   # define @lou's last_name
+#   @lou = Person.create first_name: "Lou", last_name: @eddie.last_name
+def __import scenario_name
+  ::Datum::Helpers.import_file scenario_name, ::Datum.scenario_path, binding
+end
+
+# From a scenario file, clones the attributes of an existing instance and
+# overrides as specified.
+#
+# @param [ActiveRecord::Base] resource An ActiveRecord Model instance
+# @param [Hash] override_hash Hash of attributes / values to override from
+#
+# @return [Hash] Hash of attributes from provided resource
+#
+# @example Using __clone
+#   # test/datum/scenarios/simpsons_scenario.rb
+#   # any code included in this file gets loaded when calling process_scenario
+#   @homer = Person.create(first_name: "Homer", last_name: "Simpson")
+#   @marge = Person.create(__clone(@homer, {first_name: "Marge"}))
+def __clone resource, override_hash = nil
+  ::Datum::Helpers.clone_resource resource, override_hash
+end

data/lib/support/test.rb

@@ -0,0 +1,80 @@
+require "datum/helpers"
+require "datum/container"
+require "datum/datum"
+
+# Adds the process_scenario method to ActiveSupport::TestCase and includes
+# the Datum module
+# @note Supports most extending test types (functional, integration, etc)
+# @example Making a Scenario
+#   # test/datum/scenarios/simpsons_scenario.rb
+#   # any code included in this file gets loaded when calling process_scenario
+#   @homer = Person.create(first_name: "Homer", last_name: "Simpson")
+#   @marge = Person.create(__clone(@homer, {first_name: "Marge"}))
+# @!method process_scenario(scenario_name)
+#   Imports a scenario file into the execution context of the current test
+#   @param [Symbol, String] scenario_name The name of a scenario file
+#   @return [void]
+#   @example Using process_scenario
+#     test "should verify basic scenario" do
+#       process_scenario :simpsons_scenario
+#       assert_not_nil @homer, "process_scenario did not define @homer"
+#       assert_not_nil @marge, "process_scenario did not define @marge"
+#     end
+class ActiveSupport::TestCase
+  include Datum
+
+  def process_scenario scenario_name
+    __import(scenario_name)
+  end
+end
+
+# Defines 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 [String] name Name of the file in the datum/data directory
+# @param [Block] block A block of Ruby code
+#
+# @return [void]
+#
+# @example Defining a data_test
+#   # test/datum/data/simple_person_data.rb
+#
+#   # first, define a sub-class of Datum to use in your test
+#   PersonData = Datum.new(:first_name, :last_name, :name, :short_name)
+#
+#   # next, use your sub-class to create datasets which will be accessible to
+#   # your data_test as @datum
+#   #
+#   # your data can be generated, etc... here, we're keeping it simple
+#   homer = PersonData.new("Homer", "Simpson", "Homer Simpson", "Homer S.")
+#   marge = PersonData.new("Marge", homer.last_name,
+#     "Marge #{homer.last_name}", "Marge S.")
+#
+#   # test/datum/scenarios/simpsons_scenario.rb
+#
+#   @homer = Person.create(first_name: "Homer", last_name: "Simpson")
+#   @marge = Person.create(__clone(@homer, {first_name: "Marge"}))
+#
+#   # test/models/person_test.rb
+#   require 'test_helper'
+#   class PersonTest < ActiveSupport::TestCase
+#
+#     # this data method will be called once for each Datum defined in
+#     # test/datum/data/simple_person_data.rb
+#     #
+#     # each time this method is called @datum will reference the current
+#     # dataset
+#     data_test "simple_person_data" do
+#       process_scenario :simpsons_scenario
+#       person = self.instance_variable_get("@#{@datum.first_name.downcase}")
+#       assert_equal @datum.first_name, person.first_name
+#       assert_equal @datum.last_name, person.last_name
+#       assert_equal @datum.name, person.name
+#       assert_equal @datum.short_name, person.short_name
+#     end
+#   end
+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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datum
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.1.4
 platform: ruby
 authors:
 - Tyemill
@@ -14,14 +14,14 @@ dependencies:
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.7
 - !ruby/object:Gem::Dependency
@@ -31,7 +31,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -44,10 +44,20 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/datum.rb
+- lib/datum/container.rb
+- lib/datum/datum.rb
+- lib/datum/helpers.rb
+- lib/datum/version.rb
+- lib/plan9/structures.rb
+- lib/support/scenario.rb
+- lib/support/test.rb
 homepage: https://github.com/tyemill/datum
-licenses:
-- MIT
+licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options: []