easy_reference_data 0.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f98e724b8d7d645fba3e31b1b5063bdad8a48dd7fd886a18176322c5aa963ba0
+  data.tar.gz: b4cf4cbb36e876f950e6b7448e6707f4b8a50d4f4232059fd42d2df0c56f378c
+SHA512:
+  metadata.gz: 9c4009145e6aa23048edae9e02edcaae860f425973c0e7ef791adb514681a84f923285956c42879973326fc004650a0cebf46cfe4764d31da7f7fbabe8291a09
+  data.tar.gz: 51fd5e66df3981df0a7a8f836357361cb4d9949d2835704fb457602dfb2348db8e0bf5088ac40c1fbaccef348e05411d5a0cef69917ebba5cf89df0c38d8d5b2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.byebug_history

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+sudo: false
+branches:
+  rvm:
+    - 2.2.7
+    - 2.3.4
+    - 2.4.1

data/BUILD.md

@@ -0,0 +1,18 @@
+Build instructions
+------------------
+
+1. Update `lib/easy/reference_data/version.rb` with new version number
+2. Update `ChangeLog` with description of changes
+3. Commit and tag with new version. Eg: `v1.1.0`
+4. Run: `gem build easy_reference_data`
+5. Run: `gem push easy_reference_data-v<version>.gem`
+6. Push commits and tags:
+
+```
+git push origin master
+git push origin --tags
+```
+
+Finally, confirm that the published version is visible on RubyGems:
+
+https://rubygems.org/gems/easy_reference_data

data/ChangeLog

@@ -1,3 +1,34 @@
+1.2.0 - 2021-05-27
+
+  Bug fixes
+
+    * Replace Rails 6.1 deprecated `update_attributes!` with `update!`
+
+1.1.0 - 2019-02-05
+
+  Enhancements
+  
+  * added option to wrap in a transaction
+
+1.0.0 - 2017-07-18
+
+  Enhancements
+  
+  * added .update_or_create method to replace the implementation of .refresh
+    .update_or_create allows you to use a combination of keys to identity records that have no single unique attribute.
+
+0.1.2 - 2012-11-15
+
+  Bug fixes
+
+    * don't use mass assignment operation for creating new records
+
+0.1.1 - 2012-11-15
+
+  Enhancements
+
+    * add extra output messages when creating/updating reference data
+
 0.1.0 - 2012-11-14
 
   Bug fixes

data/README.md

@@ -22,9 +22,18 @@ Place references in 'db/reference/'
 
 References will be loaded in ascending order, so if an order is desired, prepend 000, 001, 002... etc to the filename.
 
+If an unhandled error occurs during the loading of a specific file, then all the data loaded prior to the error will remain.
+
 Run with:
+
     rake easy:reference_data:refresh
 
+To have all the reference data files loaded in one transaction, run with:
+
+    rake easy:reference_data:refresh[wrap_in_transaction]
+
+The `wrap_in_transaction` parameter will wrap the entire load process in a single transaction. This means any unhandled errors will result in all the data loaded prior to the error being rolled back.  
+
 ## Deployment
 
 Add this line to your application's deploy.rb file:
@@ -36,9 +45,16 @@ Add this line to your application's deploy.rb file:
 The below example ensures that there are 3 users existing in the database after running the 'rake reference_data:load'
 
     ### db/reference/000_users.rb
-    Easy::ReferenceData.refresh User, :system_code, 'nigel', name: 'Nigel Ramsay', email: 'nigel.ramsay@mailinator.com'
-    Easy::ReferenceData.refresh User, :system_code, 'fred', name: 'Fred Schmitt', email: 'fred.schmitt@mailinator.com'
-    Easy::ReferenceData.refresh User, :system_code, 'bert', name: 'Bert Symthe', email: 'bert.smythe@mailinator.com'
+    Easy::ReferenceData.update_or_create User, {system_code: 'nigel', name: 'Nigel Ramsay', email: 'nigel.ramsay@mailinator.com'}, keys: [:system_code]
+    Easy::ReferenceData.update_or_create User, {system_code: 'fred', name: 'Fred Schmitt', email: 'fred.schmitt@mailinator.com'}, keys: [:system_code]
+    Easy::ReferenceData.update_or_create User, {system_code: 'bert', name: 'Bert Symthe', email: 'bert.smythe@mailinator.com'}, keys: [:system_code]
+
+Multiple keys can be used to identify records that would otherwise not have a unique attribute
+
+    ### db/reference/000_prices.rb
+    Easy::ReferenceData.update_or_create Price, {product_id: 1, type: "Price::RetailPrice", price: 5}, keys: [:product_id, :type]
+    Easy::ReferenceData.update_or_create Price, {product_id: 1, type: "Price::CostPrice", price: 4}, keys: [:product_id, :type]
+    Easy::ReferenceData.update_or_create Price, {product_id: 2, type: "Price::RetailPrice", price: 5}, keys: [:product_id, :type]
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/easy_reference_data.gemspec

@@ -18,4 +18,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_runtime_dependency 'rails', '>= 3.0.0'
+
+  gem.add_development_dependency 'rspec', '~> 3.6.0'
+  gem.add_development_dependency 'sqlite3', '~> 1.4.0'
+  gem.add_development_dependency 'database_cleaner', '~> 1.6'
 end

data/lib/easy/reference_data/refresh.rb

@@ -1,24 +1,57 @@
+require 'active_support'
+
 module Easy
   module ReferenceData
+
     def self.refresh(clazz, unique_attribute_symbol, unique_attribute_value, attributes)
-      record = clazz.where(unique_attribute_symbol => unique_attribute_value).first
+      self.update_or_create(clazz, attributes.merge(unique_attribute_symbol => unique_attribute_value), keys: [unique_attribute_symbol])
+    end
 
-      if record.nil?
-        record = clazz.new(unique_attribute_symbol => unique_attribute_value)
-      end
+    def self.update_or_create(clazz, attributes, options)
+      unique_attribute_keys = options.fetch(:keys)
 
-      attributes.each_pair do |key, value|
-        record.send "#{key}=", value
+      record = clazz.where(attributes.slice(*unique_attribute_keys)).first_or_initialize
+
+      if record.new_record?
+        $stderr.puts "..creating #{clazz}(#{attributes.slice(*unique_attribute_keys)})"
+      else
+        $stderr.puts "..updating #{clazz}(#{attributes.slice(*unique_attribute_keys)})"
       end
 
       begin
-        record.save!
+        record.update!(attributes)
       rescue
-        puts "Save failed for #{record.class}[#{unique_attribute_symbol}: #{unique_attribute_value}] with attributes #{attributes.inspect}"
+        $stderr.puts "Save failed for #{record.class} with attributes #{attributes.inspect}"
         raise
       end
 
       record
     end
+
+    def self.load_files(wrap_in_transaction: false)
+      if wrap_in_transaction
+        ActiveRecord::Base.transaction do
+          load_the_files
+        end
+      else
+        load_the_files
+      end
+    end
+
+    private_class_method
+
+    def self.files
+      files = Dir[File.join(Rails.root, 'db', 'reference', '*.rb')].sort
+      files += Dir[File.join(Rails.root, 'db', 'reference', Rails.env, '*.rb')].sort
+      files
+    end
+
+    def self.load_the_files
+      files.each do |file|
+        puts "Populating reference #{file}"
+        load file
+      end
+    end
+
   end
 end

data/lib/easy/reference_data/version.rb

@@ -1,5 +1,5 @@
 module Easy
   module ReferenceData
-    VERSION = "0.1.0"
+    VERSION = "1.2.0"
   end
-end
+end

data/lib/tasks/easy_reference_data.rake

@@ -1,14 +1,8 @@
 namespace :easy do
   namespace :reference_data do
-    desc "Refreshes reference data values for the current environment."
-    task :refresh => :environment do
-      files = Dir[File.join(Rails.root, 'db', 'reference', '*.rb')].sort
-      files += Dir[File.join(Rails.root, 'db', 'reference', Rails.env, '*.rb')].sort
-
-      files.each do |file|
-        puts "Populating reference #{file}"
-        load file
-      end
+    desc "Refreshes reference data values for the current environment. Pass the wrap_in_transaction flag to refresh in a transaction."
+    task :refresh, [:wrap_in_transaction] => :environment do |_task, args|
+      Easy::ReferenceData.load_files(wrap_in_transaction: args[:wrap_in_transaction] == "wrap_in_transaction")
     end
   end
-end
+end

data/spec/easy/reference_data/refresh_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require 'easy/reference_data/refresh'
+
+RSpec.describe Easy::ReferenceData do
+
+  describe ".update_or_create" do
+    context "with a single unique attribute" do
+      context "and an existing record" do
+
+        it "does not change the record" do
+          user = User.create(system_code: 1)
+
+          expect{ Easy::ReferenceData.update_or_create(User, {system_code: 1}, keys: [:system_code])}.not_to change{ User.count }
+        end
+
+        context "with additional attributes" do
+          it "updates the existing record" do
+            user = User.create(system_code: 1, name: "Jo")
+
+            expect{ Easy::ReferenceData.update_or_create(User, {system_code: 1, name: "Jane"}, keys: [:system_code])}.to change{ user.reload.name }.to "Jane"
+          end
+        end
+      end
+
+      context "and no existing record" do
+        it "creates a new record" do
+          expect{ Easy::ReferenceData.update_or_create(User, {system_code: 1}, keys: [:system_code])}.to change{ User.count }
+        end
+      end
+
+    end
+
+    context "with multiple attributes" do
+      it "updates the matching record" do
+        jo_smith = User.create(system_code: 1, name: "Jo", email: "jo.smith@example.com")
+        jo_brown = User.create(system_code: 1, name: "Jo", email: "jo.brown@example.com")
+
+        expect{ Easy::ReferenceData.update_or_create(User, {name: "Jo", email: "jo.brown@example.com", system_code: 2}, keys: [:name, :email])}.to change{ jo_brown.reload.system_code }.to 2
+      end
+
+    end
+  end
+
+  describe ".refresh" do
+
+    context "with a unique attribute" do
+      context "and no existing record" do
+
+        it "creates a new record" do
+          expect{
+            Easy::ReferenceData.refresh User, :system_code, 1, name: "Jane", email: "jane@example.com"
+          }.to change{ User.count }
+        end
+
+      end
+
+      context "and an existing record" do
+        it "updates the existing record" do
+          user = User.create(system_code: 1, name: "Jo")
+
+          expect{ Easy::ReferenceData.refresh User, :system_code, 1, name: "Jane", email: "jane@example.com" }.to change{ user.reload.name }.to "Jane"
+        end
+
+        it "does not create duplicate records" do
+          user = User.create(system_code: 1, name: "Jo")
+
+          expect{ Easy::ReferenceData.refresh User, :system_code, 1, name: "Jo", email: "jane@example.com" }.not_to change{ User.count }
+        end
+      end
+    end
+
+  end
+
+  describe ".load_files" do
+    before do
+      allow(subject).to receive(:files).and_return([@file1 = double(to_str: "easy/reference_data/refresh.rb")])
+    end
+
+    context "when the wrap_in_transaction argument is true" do
+      let(:call) {subject.load_files(wrap_in_transaction: true)}
+
+      it "starts a transaction" do
+        expect(ActiveRecord::Base).to receive(:transaction).and_call_original
+        call
+      end
+
+      it "loads all the files" do
+        allow(Kernel).to receive(:load).with(@file1)
+        call
+      end
+
+    end
+
+    context "when the wrap_in_transaction argument is false" do
+      let(:call) {subject.load_files(wrap_in_transaction: false)}
+
+      it "does not start a transaction" do
+        expect(ActiveRecord::Base).not_to receive(:transaction)
+        call
+      end
+
+      it "loads all the files" do
+        allow(Kernel).to receive(:load).with(@file1)
+        call
+      end
+    end
+
+    context "if the wrap_in_transaction argument is not passed in" do
+      let(:call) {subject.load_files}
+
+      it "does not start a transaction" do
+        expect(ActiveRecord::Base).not_to receive(:transaction)
+        call
+      end
+
+      it "loads all the files" do
+        allow(Kernel).to receive(:load).with(@file1)
+        call
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,121 @@
+require 'active_record'
+require 'database_cleaner'
+
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+require 'support/models'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # is tagged with `:focus`, all examples get run. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = "doc"
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:transaction)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

data/spec/support/models.rb

@@ -0,0 +1,5 @@
+require 'active_record'
+load 'support/schema.rb'
+
+class User < ActiveRecord::Base
+end

data/spec/support/schema.rb

@@ -0,0 +1,11 @@
+require 'active_record'
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.integer :system_code
+    t.string :name
+    t.string :email
+  end
+end

metadata

@@ -1,32 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: easy_reference_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Nigel Ramsay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: Used to create a predefined set of model instances
 email:
 - nigel.ramsay@abletech.co.nz
@@ -34,7 +73,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- BUILD.md
 - ChangeLog
 - Gemfile
 - LICENSE.txt
@@ -47,29 +89,34 @@ files:
 - lib/easy/reference_data/version.rb
 - lib/easy_reference_data.rb
 - lib/tasks/easy_reference_data.rake
+- spec/easy/reference_data/refresh_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
 homepage: http://github.com/AbleTech/easy_reference_data
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.1.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Loads files from db/reference/*.rb
-test_files: []
-has_rdoc: 
+test_files:
+- spec/easy/reference_data/refresh_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb