seed_helper 1.9.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfc6dbc5105c39c42b3fefac804b1283552ffb41
-  data.tar.gz: 1858088eedc41671ab90953fa829be840b282461
+  metadata.gz: 048e17c475ef146eb29e46267161a5cd96578edd
+  data.tar.gz: 611c97c09747d53bcb84b688ad288d993ddaa4d7
 SHA512:
-  metadata.gz: 30014d393b676042af0efea31f307c6cf69534cef51c57de00b7efa6d137f5b1753343eaaede91b699f9c84c3d60f8da799de0df79104324dc2b68c82b5b4e32
-  data.tar.gz: bc0f3de3e9d77e8bf4f8dd7260836395ac5ec2033ae6b895d4fef59e8037e92d411bc839a9b2eb79d9e24a241742937709baa9322689142a9efa7c31b39c295f
+  metadata.gz: 80438d1fa54715f4c2808e01ebda9f004c641182f169e0c75d6035b20d34412e489ff6b16ff0019035f51b3d2d9d0484786334ec37ee107baa9e4ad5f8c9aca6
+  data.tar.gz: 4172124ba98660806a1b9eb11d589a479f6c0d99d88ce19c21f352bf1f1d7047410eaa7e5dc2376fa9ab809a0d5a4975f1c5e2814162f51f65ef08040018f80f

data/README.md

@@ -68,9 +68,8 @@ SeedHelper.find_or_create_resource(User, {email: email}, {password: "password",
 Sometimes you'll want to create an object using FactoryGirl. You can pass a block to `.find_or_create_resource` to achieve this. EG:
 
 ```ruby
-email = "admin@example.com"
-SeedHelper.find_or_create_resource(User, {email: email}) do
-  FactoryGirl.build(:user, :admin, :with_profile_picture, email: email, password: "Alligator8")
+SeedHelper.find_or_create_resource(User, {email: "admin@example.com"}, {password: "Alligator8"}) do |attributes|
+  FactoryGirl.build(:user, :admin, :with_profile_picture, attributes)
 end
 ```
 
@@ -91,6 +90,15 @@ SeedHelper.bulk_create(MyClass) do
 end
 ```
 
+If you want to bulk create some associated objects for a given object, you can pass a hash of attributes to scope the `.bulk_create` by:
+
+```ruby
+Client.all.each do |client|
+  SeedHelper.bulk_create(User, {client_id: client.id}) do |client_attributes|
+    FactoryGirl.create_list(:user, 5, client_attributes)
+  end
+end
+
 ## Example: Output
 
 SeedHelper provides multiple methods for showing output that can be used outside of the `create_resource` method:

data/lib/seed_helper.rb

@@ -1,9 +1,11 @@
 require 'colorize'
 require 'seed_helper/version'
+require 'seed_helper/bulk_create'
 require 'seed_helper/output_formatter'
 require 'seed_helper/rake_helper'
 
 class SeedHelper
+  extend SeedHelper::BulkCreate
   extend SeedHelper::OutputFormatter
   extend SeedHelper::RakeHelper
 
@@ -23,7 +25,7 @@ class SeedHelper
       resource_already_exists(resource)
     else
       if constructor.present?
-        resource = constructor.call
+        resource = constructor.call(identifiable_attributes.merge(additional_attributes))
       else
         resource = resource_class.new(identifiable_attributes.merge(additional_attributes))
       end
@@ -43,21 +45,6 @@ class SeedHelper
     did_save
   end
 
-  def self.bulk_create(klass, &creation_block)
-    klass_plural = klass.name.pluralize
-
-    if klass.any?
-      resource_already_exists(klass_plural)
-    else
-      begin
-        creation_block.call
-        success("Created #{klass_plural}")
-      rescue
-        error("Failed to create #{klass_plural}: #{$!}")
-      end
-    end
-  end
-
 private
 
   def self.find_resource(resource_class, attributes)

data/lib/seed_helper/bulk_create.rb

@@ -0,0 +1,42 @@
+module SeedHelper::BulkCreate
+
+  # Allow an easy means of using something like FactoryGirl.create_list to seed a number
+  # of records.
+  #
+  # If any instances of resource_class with matching identifiable_attributes exists, present a
+  # resource_already_exists message.
+  #
+  # Otherwise, run the provided creation_block.
+  #
+  # @param [Class] resource_class: The class to create the resource in. EG: User
+  # @param [Hash] identifiable_attributes: A hash of attributes and values that can be used to
+  #                                        identify the given resource. EG: {email: "jordan@example.com"}
+  # @params [Proc] creation_block: A block that will create some objects
+  def bulk_create(klass, identifiable_attributes={}, &creation_block)
+    message_identifier = bulk_create_message_identifier(klass, identifiable_attributes)
+
+    if klass.where(identifiable_attributes).exists?
+      resource_already_exists(message_identifier)
+    else
+      begin
+        creation_block.call(identifiable_attributes)
+        success("Created #{message_identifier}")
+      rescue
+        error("Failed to create #{message_identifier}: #{$!}")
+      end
+    end
+  end
+
+private
+
+  def bulk_create_message_identifier(klass, identifiable_attributes)
+    klass_plural = klass.name.pluralize
+
+    if identifiable_attributes.any?
+      "#{klass_plural} (#{identifiable_attributes})"
+    else
+      klass_plural
+    end
+  end
+
+end

data/lib/seed_helper/version.rb

@@ -1,3 +1,3 @@
 class SeedHelper
-  VERSION = "1.9.0"
+  VERSION = "1.11.0"
 end

data/spec/lib/seed_helper/bulk_create_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe SeedHelper::BulkCreate do
+
+  describe '#bulk_create' do
+    subject { SeedHelper.bulk_create(User, identifiable_attributes) { User.create(email: email)} }
+
+    let(:email) { "jordan@example.com" }
+
+    context "with identifiable_attributes" do
+      let(:identifiable_attributes) { {email: email} }
+
+      context "when a User with those attributes already exists" do
+        before { User.create!(email: email) }
+
+        it "sends an 'already exists' message" do
+          expect(SeedHelper).to receive(:resource_already_exists).with("Users ({:email=>\"jordan@example.com\"})")
+          subject
+        end
+      end
+
+      context "when no User with those attributes already exists" do
+        before { User.create!(email: "other@example.com") }
+
+        it "runs the given block" do
+          expect { subject }.to change { User.count }.by(1)
+        end
+
+        it "prints a success message" do
+          expect(SeedHelper).to receive(:success).with("Created Users ({:email=>\"jordan@example.com\"})")
+          subject
+        end
+      end
+    end
+
+    context "with no identifiable_attributes" do
+      let(:identifiable_attributes) { {} }
+
+      context "when a User already exists" do
+        before { User.create! }
+
+        it "sends an 'already exists' message" do
+          expect(SeedHelper).to receive(:resource_already_exists).with("Users")
+          subject
+        end
+      end
+
+      context "when no Users exist" do
+        it "runs the given block" do
+          expect { subject }.to change { User.count }.to(1)
+        end
+
+        it "prints a success message" do
+          expect(SeedHelper).to receive(:success).with("Created Users")
+          subject
+        end
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seed_helper
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Jordan Maguire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-15 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -57,11 +57,13 @@ files:
 - README.md
 - Rakefile
 - lib/seed_helper.rb
+- lib/seed_helper/bulk_create.rb
 - lib/seed_helper/output_formatter.rb
 - lib/seed_helper/rake_helper.rb
 - lib/seed_helper/version.rb
 - license.txt
 - seed_helper.gemspec
+- spec/lib/seed_helper/bulk_create_spec.rb
 - spec/lib/seed_helper/output_formatter_spec.rb
 - spec/lib/seed_helper_spec.rb
 - spec/spec_helper.rb
@@ -90,6 +92,7 @@ signing_key:
 specification_version: 4
 summary: Make seeding data easier in Rails projects
 test_files:
+- spec/lib/seed_helper/bulk_create_spec.rb
 - spec/lib/seed_helper/output_formatter_spec.rb
 - spec/lib/seed_helper_spec.rb
 - spec/spec_helper.rb