config_scripts 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e82cdbad99dab608fa83f34a745b56777259ab2b
-  data.tar.gz: 37dc15c3bd6d16d396cde24dc92300088a07af18
+  metadata.gz: a161b59fb0e28a4b36f776dc7c544cee24713e44
+  data.tar.gz: c927b4b738d5fae4c9b48ae89c422c2feaea9dbc
 SHA512:
-  metadata.gz: 51cd44bd284762c00fc92df25e5f8d427999b5daa8eac0cacafdf3cde9d1e22273c549162f987a6c3500f54f3acd8670f2c061d9055e98930ba730dfb6191c80
-  data.tar.gz: 8a6e8dc9c8b05a67f974b0cc4aad9b38d51bc4b50e61732d14ab4ec89793935a9edf75a9aece1b6eb4e3c386e06cfbf9b177dd9843efb8341af78058c1ee3911
+  metadata.gz: 3ee4b06ae66ba9c16a0a538116d950d6af3fcf175e7922e5700cd4b29b9c0be2f07c8abbd01005ca771f80d42ba904cf4c0255c325b15818a1922908df9f1f81
+  data.tar.gz: df3d33f6d667d3840c1dc1babd22b5d2f00627416b22fe18c1da142d407131b3e5325247e38d23dd3fd5327bb93dfcb5a61fdcd1b0d4096b4b2459345c132c37

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 0.4.4 - 20 May 2014
+
+* Adds the ability to remove default scopes when reading and writing seeds
+* Adds more error messaging when a seed entry cannot be read
+
 # Version 0.4.3 - 24 April 2014
 
 * Ensures the config scripts run in alphabetical order by filename,

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    config_scripts (0.4.3)
+    config_scripts (0.4.4)
       rails (> 3.0.0)
 
 GEM

data/lib/config_scripts/seeds/seed_set.rb

@@ -153,6 +153,7 @@ module ConfigScripts
         @folder = folder || @name
         @options = options
         @seed_types = {}
+        @unscoped_classes = []
         self.instance_eval(&block) if block_given?
         ConfigScripts::Seeds::SeedSet.register_seed_set(self)
       end
@@ -164,29 +165,61 @@ module ConfigScripts
       # It will create the folder and then write the file for each seed type
       # that has been defined.
       def write
-        folder_path = Rails.root.join('db', 'seeds', 'data', self.folder)
-        FileUtils.mkdir_p(folder_path)
-        puts "Writing seeds for #{self.name} to #{folder_path}"
-        self.seed_types.each do |klass, seed_type|
-          seed_type.write_to_folder(folder_path)
+        self.write_with_unscoped(@unscoped_classes)
+      end
+
+      # This method writes the data for this seed set to its seed folder.
+      #
+      # It will remove all default scopes from the classes provided before doing the write.
+      #
+      # @param [Array<Class>] unscoped_classes
+      #   The classes whose scopes we will remove.
+      def write_with_unscoped(unscoped_classes)
+        if unscoped_classes.any?
+          unscoped_classes.first.unscoped do
+            self.write_with_unscoped(unscoped_classes[1..-1])
+          end
+        else
+          folder_path = Rails.root.join('db', 'seeds', 'data', self.folder)
+          FileUtils.mkdir_p(folder_path)
+          puts "Writing seeds for #{self.name} to #{folder_path}"
+          self.seed_types.each do |klass, seed_type|
+            seed_type.write_to_folder(folder_path)
+          end
         end
       end
 
       # This method reads the data for this seed set from its seed folder.
       #
-      # @param [Boolean] reset
-      #   Whether we should reset the existing records before loading the seeds.
-      #
       # It will load the data for each seed type's file, enclosing all the
       # seed types in a transaction block.
+      #
+      # @param [Boolean] reset
+      #   Whether we should reset the existing records before loading the seeds.
       def read(reset=false)
-        folder_path = Rails.root.join('db', 'seeds', 'data', self.folder)
-        FileUtils.mkdir_p(folder_path)
-        puts "Reading seeds for #{self.name} from #{folder_path}"
-        ActiveRecord::Base.transaction do
-          self.reset_records if reset
-          self.seed_types.each do |klass, seed_type|
-            seed_type.read_from_folder(folder_path)
+        self.read_with_unscoped(reset, @unscoped_classes)
+      end
+
+      # This method reads the data for this seed set from its seed folder.
+      #
+      # @param [Boolean] reset
+      #   Whether we should reset the existing records before loading the seeds.
+      #
+      # @param [Array<Class>] unscoped_classes
+      #   The classes that we need to remove default scopes from before loading
+      #   the seeds.
+      def read_with_unscoped(reset, unscoped_classes)
+        if unscoped_classes.any?
+          unscoped_classes.first.unscoped { self.read_with_unscoped(reset, unscoped_classes[1..-1]) }
+        else
+          folder_path = Rails.root.join('db', 'seeds', 'data', self.folder)
+          FileUtils.mkdir_p(folder_path)
+          puts "Reading seeds for #{self.name} from #{folder_path}"
+          ActiveRecord::Base.transaction do
+            self.reset_records if reset
+            self.seed_types.each do |klass, seed_type|
+              seed_type.read_from_folder(folder_path)
+            end
           end
         end
       end
@@ -229,6 +262,17 @@ module ConfigScripts
         @reset_block = block
       end
 
+      # This method specifies classes that will be unscoped when writing the seed data.
+      #
+      # @param [Array<Class>] classes
+      #   The classes to unscope.
+      #
+      # @return [Array<Class>]
+      #   The new list of unscoped classes.
+      def unscope(*classes)
+        @unscoped_classes += classes
+      end
+
       # @!group Seed Identifiers
 
       # This method gets a seed type that we have on file for a class.

data/lib/config_scripts/seeds/seed_type.rb

@@ -204,6 +204,7 @@ module ConfigScripts
               record.save!
             rescue
               puts "#{self.filename}.csv"
+              puts "#{row}"
               raise
             end
           end
@@ -350,7 +351,7 @@ module ConfigScripts
       #   The record
       def record_for_seed_identifier(identifier)
         return nil if identifier.blank?
-        records = self.all
+        records = self.items
         self.identifier_attributes.each_with_index do |attribute, index|
           if self.associations.has_key?(attribute)
             value = self.read_value_for_association(attribute, identifier)

data/lib/config_scripts/version.rb

@@ -1,4 +1,4 @@
 module ConfigScripts
   # The current version of the library.
-  VERSION = "0.4.3"
+  VERSION = "0.4.4"
 end

data/spec/dummy/app/models/hair_color.rb

@@ -1,2 +1,3 @@
 class HairColor < ActiveRecord::Base
+  has_many :people
 end

data/spec/dummy/app/models/person.rb

@@ -1,4 +1,6 @@
 class Person < ActiveRecord::Base
   belongs_to :hair_color
   belongs_to :scope, polymorphic: true
+
+  default_scope { where archived: false }
 end

data/spec/dummy/db/migrate/20140520061856_add_archived_to_people.rb

@@ -0,0 +1,5 @@
+class AddArchivedToPeople < ActiveRecord::Migration
+  def change
+  	add_column :people, :archived, :boolean, null: false, default: false
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140209132911) do
+ActiveRecord::Schema.define(version: 20140520061856) do
 
   create_table "config_scripts", force: true do |t|
     t.string "name"
@@ -31,6 +31,7 @@ ActiveRecord::Schema.define(version: 20140209132911) do
     t.integer  "hair_color_id"
     t.string   "scope_type"
     t.integer  "scope_id"
+    t.boolean  "archived",      default: false, null: false
   end
 
   add_index "people", ["hair_color_id"], name: "index_people_on_hair_color_id"

data/spec/seeds/seed_set_spec.rb

@@ -106,23 +106,59 @@ describe ConfigScripts::Seeds::SeedSet do
       set.stub :seed_types => {Person: seed_type}
       seed_type.stub write_to_folder: nil, read_from_folder: true
       set.stub :puts
+      Person.create(name: 'John', archived: true)
+      Person.create(name: 'Jane', archived: false)
     end
 
     describe "write" do
-      before do
-        set.write
-      end
+      context do
+        before do
+          set.write
+        end
+
+        it "creates the seed folder" do
+          expect(FileUtils).to have_received(:mkdir_p).with(seed_folder)
+        end
 
-      it "creates the seed folder" do
-        expect(FileUtils).to have_received(:mkdir_p).with(seed_folder)
+        it "writes all of the seed types to the folder" do
+          expect(seed_type).to have_received(:write_to_folder).with(seed_folder)
+        end
+
+        it "says where it's writing the seeds to" do
+          expect(set).to have_received(:puts).with("Writing seeds for test_seeds to #{seed_folder}")
+        end
       end
 
-      it "writes all of the seed types to the folder" do
-        expect(seed_type).to have_received(:write_to_folder).with(seed_folder)
+      context "with no unscoped seed types" do
+        it "does not see records filtered out by a default scope" do
+          seed_type.stub :write_to_folder do
+            expect(Person.count).to eq 1
+          end
+          set.write
+        end
       end
 
-      it "says where it's writing the seeds to" do
-        expect(set).to have_received(:puts).with("Writing seeds for test_seeds to #{seed_folder}")
+      context "with unscoped seed types" do
+        before do
+          set.unscope Person
+        end
+
+        it "sees records filtered out by a default scope" do
+          seed_type.stub :write_to_folder do
+            expect(Person.count).to eq 2
+          end
+          set.write
+        end
+
+        it "sees records filtered out by a default scope in associations" do
+          hair_color = HairColor.create!(color: 'blonde')
+          Person.unscoped.first.update_attributes(hair_color: hair_color)
+          expect(hair_color.people.count).to eq 0
+          seed_type.stub :write_to_folder do
+            expect(hair_color.people.count).to eq 1
+          end
+          set.write
+        end
       end
     end
 
@@ -149,6 +185,28 @@ describe ConfigScripts::Seeds::SeedSet do
         end
       end
 
+      context "with no unscoped seed types" do
+        it "does not see records filtered out by a default scope" do
+          seed_type.stub :read_from_folder do
+            expect(Person.count).to eq 1
+          end
+          set.read
+        end
+      end
+
+      context "with unscoped seed types" do
+        before do
+          set.unscope Person
+        end
+
+        it "sees records filtered out by a default scope" do
+          seed_type.stub :read_from_folder do
+            expect(Person.count).to eq 2
+          end
+          set.read
+        end
+      end
+
       context "when resetting" do
         it "resets the records" do
           set.read(true)
@@ -238,6 +296,18 @@ describe ConfigScripts::Seeds::SeedSet do
         expect(value).to eq 1
       end
     end
+
+    describe "unscoped" do
+      let(:set) { ConfigScripts::Seeds::SeedSet.new('test_seeds', 1) }
+
+      it "adds the arguments to the list" do
+        expect(set.instance_variable_get("@unscoped_classes")).to eq []
+        set.unscope String
+        expect(set.instance_variable_get("@unscoped_classes")).to eq [String]
+        set.unscope Person, HairColor
+        expect(set.instance_variable_get("@unscoped_classes")).to eq [String, Person, HairColor]
+      end
+    end
   end
 
   describe "seed identifiers" do

data/spec/seeds/seed_type_spec.rb

@@ -199,8 +199,13 @@ describe ConfigScripts::Seeds::SeedType do
         end
 
         it "outputs the problem file name" do
-          expect($stdout).to receive(:puts).with('people.csv')
           expect{ subject }.to raise_error
+          expect($stdout).to have_received(:puts).with('people.csv')
+        end
+
+        it "outputs the problem row" do
+          expect{subject}.to raise_error
+          expect($stdout).to have_received(:puts).with('{"name"=>"a", "hair_color"=>"b"}')
         end
       end
 
@@ -358,6 +363,17 @@ describe ConfigScripts::Seeds::SeedType do
       it "gets the records by applying the scope" do
         expect(subject).to eq [person2, person1]
       end
+
+      it "does not include a record filtered out by a default scope" do
+        person2.update_attributes archived: true
+        expect(subject).not_to include person2
+      end
+
+      it "allows using the unscoped method to filter out records by a scope" do
+        seed_type.has_scope :unscoped
+        person2.update_attributes archived: true
+        expect(subject).to include person2
+      end
     end
 
     describe "options" do
@@ -414,6 +430,28 @@ describe ConfigScripts::Seeds::SeedType do
         end
       end
 
+      context "with a record that is filtered out by a default scope" do
+        let(:identifier) { ['Jim'] }
+        before do
+          seed_type.has_identifier_attributes :name
+          person3.update_attributes archived: true, name: 'Jim'
+        end
+
+        context "when the scope is in place" do
+          it "does not find the record" do
+            expect(subject).to be_nil
+          end
+        end
+
+        context "when it is unscoped" do
+          it "finds the record" do
+            seed_type.has_scope :unscoped
+            expect(subject).to eq person3
+          end
+        end
+      end
+
+
       context "with a multi-field reference to another record" do
         let(:identifier) { ['red','FF0000','John'] }
 

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: config_scripts
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - John Brownlee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-25 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: yard
   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'
 - !ruby/object:Gem::Dependency
   name: simplecov
   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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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'
 - !ruby/object:Gem::Dependency
   name: timecop
   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'
 - !ruby/object:Gem::Dependency
   name: generator_spec
   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'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   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'
 description: Library for creating trackable config scripts, and reading and writing
@@ -158,9 +158,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -223,6 +223,7 @@ files:
 - spec/dummy/db/migrate/20140208182101_add_hair_color_to_person.rb
 - spec/dummy/db/migrate/20140208225801_add_scope_to_people.rb
 - spec/dummy/db/migrate/20140209132911_add_hex_value_to_hair_color.rb
+- spec/dummy/db/migrate/20140520061856_add_archived_to_people.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep
@@ -250,17 +251,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Config scripts and seed files for Rails
@@ -305,6 +306,7 @@ test_files:
 - spec/dummy/db/migrate/20140208182101_add_hair_color_to_person.rb
 - spec/dummy/db/migrate/20140208225801_add_scope_to_people.rb
 - spec/dummy/db/migrate/20140209132911_add_hex_value_to_hair_color.rb
+- spec/dummy/db/migrate/20140520061856_add_archived_to_people.rb
 - spec/dummy/db/schema.rb
 - spec/dummy/lib/assets/.keep
 - spec/dummy/log/.keep