initial-test-data 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 33493c61601d245c3dfe070e612a3ef7ba272c12
+  data.tar.gz: 6cfd76859a9a8a07473d39b7c0b10ff4eb26a0ee
+SHA512:
+  metadata.gz: 097420351592a5a1cce9ae6bf44f493c427d098cfe04dc0f9858d801cafa7a858d19ef54d3a4f9fb5f0d5a59fda9f0ee141272b5b0bca2777576f2d0f83bf329
+  data.tar.gz: 53071d19f084cd3638c7ca4b89e26e386ffc2dc4beeb6781aefabfc004aaf3413949aeea96aba08620873df4f7b6b274dd109ab2643bdfa6130567f030d2ce45

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Tsutomu Kuroda
+
+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,122 @@
+initial-test-data
+=================
+
+The `initial-test-data` is a tool to create a text fixture for Rails applications.
+
+Overview
+--------
+
+Although the Rails itself has a standard mechanism
+([Fixtures](http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html)),
+it is rather cumbersome to construct a real (often complicated) data structure
+from YAML files.
+
+The `initial-test-data` provides a a way to create a test fixture using Active Record, Factory Girl, etc.
+
+Installation
+------------
+
+Add the following line to `Gemfile`:
+
+```ruby
+gem 'initial-test-data', group: :test
+```
+
+Run `bin/bundle install` on the terminal.
+
+Configuration of test framework
+-------------------------------
+
+### MiniTest
+
+To be written.
+
+### RSpec
+
+Edit `spec/rails_helper.rb` like this:
+
+```ruby
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+require 'initial-test-data'
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    InitialTestData.load('spec')
+  end
+end
+```
+
+Usage
+-----
+
+### Synopsis
+
+* Create `initial_data` subdirectory in the `test` or `spec` directory.
+* Put any ruby scripts on this file.
+* Run your test suite.
+
+### Caching data
+
+The `initial-test-data` generates the md5 digest of all ruby scripts in
+the `initial_data` directory and stores it to the `_initial_data_digest`
+table of the test database.
+
+If the generated md5 digest is equal to the previously stored value,
+data initializing process will be skipped.
+
+### Load Order
+
+The files in the `initial_data` directory are loaded in alphabetical order.
+If you control the load order, you should make a YAML file called `_index.yml`,
+which has a content like this:
+
+```yaml
+- products
+- customers
+- orders
+```
+
+Example
+-------
+
+### MiniTest and Active Record
+
+To be written
+
+### RSpec, Capybara and Factory Girl
+
+```ruby
+# spec/initial_data/customers.rb
+
+include FactoryGirl::Syntax::Methods
+
+0.upto(9) do |n|
+  create(:customer, email: "test#{n}@example.com")
+end
+
+# spec/features/manage_customers_spec.rb
+
+require 'rails_helper'
+
+feature 'Manage customers' do
+  let(:customer) { Customer.find_by(email: 'test0@example.com') }
+
+  scenario 'Change the name of a customer' do
+    visit root_path
+
+    find('table.customers td', text: customer.email)
+      .find(:xpath, '..').click_link('Edit')
+
+    fill_in 'Given Name', with: 'John'
+    fill_in 'Family Name', with: 'Doe'
+    click_button 'Update'
+
+    customer.reload
+    expect(customer.given_name).to eq('John')
+    expect(customer.family_name).to eq('Doe')
+  end
+end
+```

data/lib/initial-test-data.rb

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

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

@@ -0,0 +1,73 @@
+require 'digest/md5'
+require 'database_cleaner'
+
+class InitialTestData
+  DIGEST_TABLE_NAME = '_initial_data_digest'
+
+  class << self
+    def load(dir = 'test')
+      @dir = dir.to_s
+
+      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
+        initialize_data
+        digest ||= klass.new
+        digest.md5_value = md5_digest
+        digest.save
+      end
+    end
+
+    private
+    def define_class
+      conn = ActiveRecord::Base.connection
+
+      unless conn.table_exists?(DIGEST_TABLE_NAME)
+        conn.create_table(DIGEST_TABLE_NAME) do |t|
+          t.string :md5_value
+        end
+      end
+
+      Class.new(ActiveRecord::Base) do
+        self.table_name = DIGEST_TABLE_NAME
+      end
+    end
+
+    def generate_md5_digest
+      md5 = Digest::MD5.new
+      Dir[Rails.root.join(@dir, 'initial_data', '*.rb')].each do |f|
+        md5.update File.new(f).read
+      end
+
+      md5.hexdigest
+    end
+
+    def initialize_data
+      DatabaseCleaner.strategy = :truncation
+      DatabaseCleaner.clean
+
+      yaml_path = Rails.root.join(@dir, 'initial_data', '_index.yml')
+      if File.exist?(yaml_path)
+        table_names = YAML.load_file(yaml_path)
+        table_names.each do |table_name|
+          path = Rails.root.join(@dir, 'initial_data', "#{table_name}.rb")
+          if File.exist?(path)
+            puts "Creating #{table_name}...."
+            require path
+          end
+        end
+      else
+        Dir[Rails.root.join(@dir, 'initial_data', '*.rb')].each do |f|
+          table_name = f.match(/(\w+)\.rb$/)[1]
+          puts "Creating #{table_name}...."
+          require f
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: initial-test-data
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tsutomu KURODA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: initial-test-data provides a way to create a test fixture using Active
+  Record, Factory Girl, etc.
+email: t-kuroda@oiax.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/initial-test-data.rb
+- lib/initial-test-data/initial_test_data.rb
+homepage: https://github.com/oiax/initial-test-data
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Test fixture creation tool
+test_files: []