datum 4.0.4 → 4.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb2d6d84f89ffc9d2380e4db9d82da26f7a3a9bf
-  data.tar.gz: b7cc6d41b42ba6ebdb0508a050ec5a78f359e60e
+  metadata.gz: 189dfaef662ee5db7f92dea90151f0f808987ac9
+  data.tar.gz: 8ffcc8a0765caac9d1a98e21862e5dd920dc159c
 SHA512:
-  metadata.gz: 7dace5163e5d7fa38f1ebb6f675090c8a5b313846769c4fc6e917731582569bb8254a71efc0b5fb02ba14fa853caa803b28450f4d24e2baf5e9da574daec536a
-  data.tar.gz: 8388f9a6ec216e3e2e1fd521fb05ba8dfb847a1d6b1799e716614faa90672cc915ca3d9495cb6d14cba096e8c38a0efc9f18f0971ce8a9a28b2447d6bb0cc036
+  metadata.gz: 22383aee690483716546ebfc14aa72f4b63181b65f5eacdba1bced66882131a1beb707ca5a7a7e3ca03c25225e2b28384493e783233488ae8d554bdbea84219a
+  data.tar.gz: 1e148954393e12195835fd7625f60d28ae9df0d2d08890ea63177f8ed238433e1ab4df80515aaadccd620852087ab0f0ada7fa1f84b2fdb7137663f5e4c63e96

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,11 @@
+##### Datum is currently being updated. Hold on.
+
+
+
+## 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,73 @@
+require "datum/helpers"
+
+module Datum
+# A Container object holds attributes for a single data test.
+class Container
+
+  # 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] Container compatible Hash key
+  def self.key tst_instance, data_method_name
+    Helpers.build_key(tst_instance, data_method_name)
+  end
+
+  # @!attribute [r] data_method_name
+  # @return [String] The name of the data test method
+  attr_reader :data_method_name
+
+  # @!attribute [r] test_instance
+  # @return [TestCase] The ActiveSupport::TestCase instance of the data test
+  attr_reader :test_instance
+
+  # @!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
+
+  # @!attribute [r] count
+  # @return [int] The total number of tests / data elements / datums
+  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] A Hash of data elements, datum structs for the test case
+  def data; @loaded_data.merge(@invoked_data); end
+
+  alias_method :length, :count
+  alias_method :size, :count
+  alias_method :test_count, :count
+
+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,60 @@
+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
+  # 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,61 @@
+module Datum
+
+# @!visibility private
+# Various helper functions
+class Helpers
+  class << self
+
+    # @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
+
+    # @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
+
+    # @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] 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 [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
+
+    # @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
+
+    # Reads a ruby file and eval's it's contents at the current code location
+    #
+    # @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
+
+    # @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,10 @@
+module Datum
+  VERSION = "4.0.5"
+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

data/lib/datum.rb

@@ -0,0 +1,37 @@
+
+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
+module Datum
+  @@all_containers, @@scenario_path, @@data_path, @@datum_path = nil
+
+  class << self
+
+    # @!attribute [r] path
+    # @return [Pathname] Fully qualified path for the root of datum directory
+    def path; @@datum_path ||= Rails.root.join('test', 'datum'); end
+
+    # @!attribute [r] data_path
+    # @return [Pathname] Fully qualified path for the datum/data directory
+    def data_path; @@data_path ||= ::Datum.path.join('data'); end
+
+    # @!attribute [r] scenario_path
+    # @return [Pathname] Fully qualified path for the datum/scenarios directory
+    def scenario_path; @@scenario_path ||= ::Datum.path.join('scenarios'); end
+
+    # @!attribute [r] containers
+    # @return [Hash] Hash of all loaded Containers
+    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,74 @@
+# @!visibility private
+module Plan9 # Module for simple code reuse between various projects.
+
+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.
+#
+  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
+
+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,16 @@
+
+# For use in a scenario file, imports an existing scenario's code and objects
+#
+# @param [symbol, String] scenario_name 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 [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, override_hash = nil
+  ::Datum::Helpers.clone_resource resource, override_hash
+end

data/lib/support/test.rb

@@ -0,0 +1,28 @@
+require "datum/helpers"
+require "datum/container"
+require "datum/datum"
+
+# Extends ActiveSupport::Test with the process_scenario method and includes
+# the Datum module
+#
+# @note Supports most extending test types (functional, integration, etc)
+class ActiveSupport::TestCase
+  include Datum
+  # Imports a scenario file into the execution context of the current test
+  #
+  # @param [symbol, String] scenario_name The name of a scenario file
+  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
+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.0.4
+  version: 4.0.5
 platform: ruby
 authors:
 - Tyemill
@@ -9,42 +9,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2015-02-15 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  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
-  name: pg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+dependencies: []
 description: Flexible data-driven test solution for Rails
 email:
 - datum@tyemill.com
 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