initial-test-data 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61d3e869ddd51d5bf3a99beb4d37ef4d1c827bd7
-  data.tar.gz: 5d01a799a3b693079041dcb5595a3497e350a0f4
+  metadata.gz: f858811a806c2fc042d1396bd6390e4c05e2e6dc
+  data.tar.gz: 900a063128080d53afbbf8238b6deb959816dc7e
 SHA512:
-  metadata.gz: 5192af3b5299ac030f60c1c56b460756c821569c6c5ba8082b8806ae5826f5f4dd905b782804c4903dfcf0f4a42e9257754ef5dd7b9411a5b2277a052e56632a
-  data.tar.gz: d740f02c057358f054d37fde8cb48f6b49dac5e9b5778d6c2285e6dacc6922eb745969c2f1b0c12504f8073c93000bbb21873572aa4b2cf0dc80eb1de7dee572
+  metadata.gz: 586696349dc870ea98209f3a5a7da6eb4f48abe7910b3814e71738c28d510c51a0442b62e51c7c5c37f64869a6d2a2243c1c4a28ed6a5c9ceaa1b8c5f3e8060e
+  data.tar.gz: e247db303eb1b98f9e2d8adccf07534b6e4deddcfe5d4031a4e7187d4868f94d9b67ecfe8cb76ab70f44a9c49113655b2424ac19182308187d704a12be079506

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG - initial-test-data
 
+## 0.4.0 (February 1, 2016)
+
+* Introduce utility methods `store` and `fetch`.
+
 ## 0.3.0 (January 31, 2016)
 
 * Monitor `app/models/**/*.rb`. When any modification is detected,

data/README.md

@@ -29,7 +29,25 @@ Configuration of test framework
 
 ### MiniTest
 
-To be written.
+Edit `test/test_helper.rb` like this:
+
+```ruby
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path('../../config/environment', __FILE__)
+require 'rails/test_help'
+require 'initial-test-data'
+
+InitialTestData.load
+
+class ActiveSupport::TestCase
+  include InitialTestData::Utilities
+
+  # (snip)
+end
+```
+
+Note that the default value of the first argument of `load` method is `'test'`,
+so you can omit it when your test scripts are located in the `test` directory.
 
 ### RSpec
 
@@ -43,6 +61,8 @@ require 'rspec/rails'
 require 'initial-test-data'
 
 RSpec.configure do |config|
+  config.include InitialTestData::Utilities
+
   config.before(:suite) do
     InitialTestData.load('spec')
   end
@@ -110,19 +130,87 @@ option to the `InitialTestData.load` method:
 ```ruby
 RSpec.configure do |config|
   config.before(:suite) do
-    InitialTestData.load('spec', monitoring: [ 'app/services', 'lib' ]
+    InitialTestData.load('spec',
+      monitoring: [ 'app/services', 'lib', 'spec/factories' ]
   end
 end
 ```
 
 You should use relative paths from the `Rails.root`.
 
+### Utility methods: `store` and `fetch`
+
+The `initial-test-data` provides two utility methods, `store` and `fetch`,
+to make it easy to refer the initialized records in your tests.
+
+You can use the `store` method within the initialization scripts
+in order to register an ActiveRecord object by name:
+
+```ruby
+include InitialTestData::Utilities
+
+store(Customer.create(...), :john)
+store(ShopOwner.create(...), :mike)
+```
+
+Then, you can get this record with `fetch` method in the test scripts:
+
+```ruby
+customer = fetch(:customer, :john)
+show_owner = fetch(:shop_owner, :mike)
+```
+
+The fetch method treats `:john` and `"john"` as the same key.
+
+Note that the `initial-test-data` creates a YAML file
+named `initial_data_record_ids.yml` in the `tmp` directory
+to track the primary key values of registered records.
+Please do not remove or tamper it.
+
 Example
 -------
 
 ### MiniTest and Active Record
 
-To be written
+```ruby
+# test/initial_data/customers.rb
+
+include InitialTestData::Utilities
+
+0.upto(9) do |n|
+  c = Customer.create(
+    email: "test#{n}@example.com",
+    given_name: 'John',
+    family_name: 'Doe'
+  )
+  store(c, "test#{n}")
+end
+
+# test/integration/manage_customers_test.rb
+
+require 'test_helper'
+
+class ManageCustomersTest < ActionDispatch::IntegrationTest
+  test "Change the name of a customer" do
+    customer = fetch(:customer, :test0)
+
+    get "/customers/#{customer.id}/edit"
+    assert_response :success
+
+    patch "/customers/#{customer.id}",
+      customer: { given_name: 'Mike', family_name: 'Smith' }
+    assert_redirected_to [ assigns(:customer) ]
+
+    follow_redirect!
+    assert_select "h1", "Listing Customers"
+
+    customer.reload
+
+    assert_equal 'Mike', customer.given_name
+    assert_equal 'Smith', customer.family_name
+  end
+end
+```
 
 ### RSpec, Capybara and Factory Girl
 
@@ -130,9 +218,11 @@ To be written
 # spec/initial_data/customers.rb
 
 include FactoryGirl::Syntax::Methods
+include InitialTestData::Utilities
 
 0.upto(9) do |n|
-  create(:customer, email: "test#{n}@example.com")
+  c = create(:customer, email: "test#{n}@example.com")
+  store(c, "test#{n}")
 end
 
 # spec/features/manage_customers_spec.rb
@@ -140,7 +230,7 @@ end
 require 'rails_helper'
 
 feature 'Manage customers' do
-  let(:customer) { Customer.find_by(email: 'test0@example.com') }
+  let(:customer) { fetch(:customer, :test0) }
 
   scenario 'Change the name of a customer' do
     visit root_path

data/lib/initial-test-data/initial_test_data.rb

@@ -1,8 +1,10 @@
 require 'digest/md5'
 require 'database_cleaner'
+require 'active_support'
 
-class InitialTestData
+module InitialTestData
   DIGEST_TABLE_NAME = '_initial_data_digest'
+  RECORD_IDS = HashWithIndifferentAccess.new
 
   class << self
     def load(*args)
@@ -11,18 +13,30 @@ class InitialTestData
 
       klass = define_class
 
-      digest_path = Rails.root.join('tmp', 'initial_data.md5')
-
       md5_digest = generate_md5_digest
       md5_digest_cache = klass.first.try(:md5_value)
 
-      unless md5_digest == md5_digest_cache
+      needs_reinitialization = true
+      record_ids_path = Rails.root.join('tmp', 'initial_data_record_ids.yml')
+      if File.exists?(record_ids_path) && md5_digest == md5_digest_cache
+        begin
+          RECORD_IDS.merge! YAML.load_file(record_ids_path)
+          needs_reinitialization = false
+        rescue SyntaxError
+        end
+      end
+
+      if needs_reinitialization
         initialize_data
 
         digest = klass.first
         digest ||= klass.new
         digest.md5_value = md5_digest
         digest.save
+
+        File.open(record_ids_path, 'w') do |f|
+          f.write RECORD_IDS.to_yaml
+        end
       end
     end
 
@@ -92,5 +106,13 @@ class InitialTestData
         end
       end
     end
+
+
+    def save_record_ids
+
+    end
+
+    def load_record_ids
+    end
   end
 end

data/lib/initial-test-data/utilities.rb

@@ -0,0 +1,33 @@
+require 'active_support'
+
+module InitialTestData
+  module Utilities
+    def store(record, name)
+      model_name = record.class.model_name.singular
+      record_name = name.to_s
+
+      RECORD_IDS[model_name] ||= HashWithIndifferentAccess.new
+
+      if RECORD_IDS[model_name].has_key?(record_name)
+        raise "The key '#{record_name}' already exists " +
+          "for #{record.class.model_name.name}."
+      elsif !record.kind_of?(ActiveRecord::Base)
+        raise "Given object is not an instance of ActiveRecord::Base."
+      elsif record.new_record?
+        raise "Given record is not persisted yet."
+      else
+        RECORD_IDS[model_name][record_name] = record.id
+      end
+    end
+
+    def fetch(model_name, name)
+      if RECORD_IDS[model_name].kind_of?(Hash) &&
+         RECORD_IDS[model_name][name]
+         klass = model_name.to_s.camelize.constantize
+         klass.find RECORD_IDS[model_name][name]
+      else
+        raise "No record is registered with the key '#{model_name}' and '#{name}'."
+      end
+    end
+  end
+end

data/lib/initial-test-data.rb

@@ -1 +1,2 @@
 require 'initial-test-data/initial_test_data'
+require 'initial-test-data/utilities'

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: initial-test-data
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tsutomu KURODA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-31 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -36,6 +50,7 @@ files:
 - README.md
 - lib/initial-test-data.rb
 - lib/initial-test-data/initial_test_data.rb
+- lib/initial-test-data/utilities.rb
 homepage: https://github.com/oiax/initial-test-data
 licenses:
 - MIT