easy_reference_data 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 797948128bb29186093a3c03a061440ada7d8022
-  data.tar.gz: 3d27734336da1da1609c831788c1a3b6a4b133a0
+SHA256:
+  metadata.gz: bd25797a8180f4486dd3746f13cf052fff6d3b91a7b61bea365ca89120ddb1cd
+  data.tar.gz: 85f70d58dca410136ea7e12b4234b9f40c0a45997ef64bc3dcbf28a13b8216b9
 SHA512:
-  metadata.gz: 634a7afb6d365a4efea98214540762e6e2ad8a7393a62b61200b9c78a8797d8cc594b6caa6155786ae4e14ca17bad67bf77e156cc465742c102689c55de3c68c
-  data.tar.gz: 1cf44764bbd14bce2e61fbe9cf35b1156622b782f1aa461746c3d49afbc20c10fe86b33c23de4736e98c295e8c2561550a2f46802ac252f397b709dc09eee01e
+  metadata.gz: bc4c9f6abe89f1170d0b566909f3383353376b575aac5e170e0cc5aeef79d2c78fa368df1efbcc1d6a1c479b0d05ea0c721d915fe7ba447fc0fba782809e13c1
+  data.tar.gz: f4af0162d855cdf8c0d2d8af89264fe4cae4dfaa8b5e3e851a148228bf33f570c49dd63f2c45c893997f96c2bf01e7b03989bc5dffd705498cbd761f2848f7b4

data/ChangeLog

@@ -1,3 +1,9 @@
+1.1.0 - 2019-02-05
+
+  Enhancements
+  
+  * added option to wrap in a transaction
+
 1.0.0 - 2017-07-18
 
   Enhancements

data/README.md

@@ -22,10 +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:

data/easy_reference_data.gemspec

@@ -20,6 +20,6 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'rails', '>= 3.0.0'
 
   gem.add_development_dependency 'rspec', '~> 3.6.0'
-  gem.add_development_dependency 'sqlite3', '~> 1.3'
+  gem.add_development_dependency 'sqlite3', '~> 1.3.0'
   gem.add_development_dependency 'database_cleaner', '~> 1.6'
 end

data/lib/easy/reference_data/refresh.rb

@@ -2,6 +2,7 @@ require 'active_support'
 
 module Easy
   module ReferenceData
+
     def self.refresh(clazz, unique_attribute_symbol, unique_attribute_value, attributes)
       self.update_or_create(clazz, attributes.merge(unique_attribute_symbol => unique_attribute_value), keys: [unique_attribute_symbol])
     end
@@ -27,5 +28,30 @@ module Easy
       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 = "1.0.0"
+    VERSION = "1.1.0"
   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

@@ -13,7 +13,7 @@ RSpec.describe Easy::ReferenceData do
           expect{ Easy::ReferenceData.update_or_create(User, {system_code: 1}, keys: [:system_code])}.not_to change{ User.count }
         end
 
-        context "with additional attribues" do
+        context "with additional attributes" do
           it "updates the existing record" do
             user = User.create(system_code: 1, name: "Jo")
 
@@ -43,8 +43,8 @@ RSpec.describe Easy::ReferenceData do
 
   describe ".refresh" do
 
-    context "with a unique attribue" do
-      context "and no exisitng record" do
+    context "with a unique attribute" do
+      context "and no existing record" do
 
         it "creates a new record" do
           expect{
@@ -54,7 +54,7 @@ RSpec.describe Easy::ReferenceData do
 
       end
 
-      context "and an exisitng record" do
+      context "and an existing record" do
         it "updates the existing record" do
           user = User.create(system_code: 1, name: "Jo")
 
@@ -70,4 +70,53 @@ RSpec.describe Easy::ReferenceData do
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_reference_data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nigel Ramsay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-28 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -110,8 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Loads files from db/reference/*.rb