seed_helper 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3c95329706e74e3e698f4768b2d7e942283d6770
-  data.tar.gz: bbb2c2508fb0f869d5df4e792c40df7a44780787
+  metadata.gz: f1942680d76a807e344ad2e7f847c0bb08b82b73
+  data.tar.gz: 3359c7b204678197cd1e2c73d38b0817a8b0aaf1
 SHA512:
-  metadata.gz: 180af533d88d1f4d76b671b611cebbc69786457d4d9e7bfd7c97f72505e6260f6ef14e6cc9c16ac062f0286f9169d225d8e2fccc6078e7d5d390b583617610bf
-  data.tar.gz: c988b10fa8c803a703b534e5e0bac3e73a714fca08d69ff951d0cf6886a842ccc4dbc88a90f1a70571c0005c0db62da4e7356f73e18b325ad87d659c2911c610
+  metadata.gz: e0ac9998fd0a2f994b0bf45ded6e9d1d1713afca81b0e395f0f4b9a6347edec69dd973369c60bee290cd6f577e1e15e1c88a8008bedf0ea16e6aed9ec66c49a9
+  data.tar.gz: 2fdae7db2b14e0ee7626bc9fdbfdbab0ce5119fe58f2eda94a7bcc6d524515d3a96088cf8db654ad81ad665f3c1056dd8867b8c986801564922f4405229cb186

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.2

data/Gemfile

@@ -2,5 +2,10 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in seed_helper.gemspec
 gemspec
-gem 'rspec'
+
+# Test only dependencies
 gem 'byebug'
+# Use Rails to be able to perform queries on a real DB
+gem 'rails'
+gem 'rspec'
+gem 'sqlite3'

data/README.md

@@ -26,7 +26,7 @@ SeedHelper.create_seed_task(:create_roles) do
     # Will print out a red message if Role fails to save
     # Will print out a green message is Role succesfully creates
     # Will print out a cyan message if Role already exists
-    role = SeedHelper.create_resource(Role, {name: role_name})
+    role = SeedHelper.find_or_create_resource(Role, {name: role_name})
 
   end
 
@@ -53,6 +53,16 @@ SeedHelper.create_seed_task(:create_users, [:create_roles]) do
 end
 ```
 
+By default, the `.find_or_create_resource` method uses the hash you provide it to find a User with those attributes. It can then determine whether or not it needs to create a new User.
+
+This becomes problematic when we have a lot of fields, since we don't want to try and identify a User by some of those fields - password, for example.
+
+In that case, we can pass through a third argument of all those additional fields:
+
+```ruby
+SeedHelper.find_or_create_resource(User, {email: email}, {password: "password", role: role_name})
+```
+
 ## Example: Using FactoryGirl
 
 If you don't want to provide specific attributes, you can use the `.bulk_create` function to do so. EG:
@@ -93,4 +103,4 @@ SeedHelper.create_seed_task(:second_task_name, [:task_name])
 # No dependencies (other than environment) but with a custom title. This will show up as
 # description of task in `rake -T` and will be printed to screen when task runs
 SeedHelper.create_seed_task(:third_task_name, [], "My sick name")
-```
+```

data/lib/seed_helper.rb

@@ -7,11 +7,22 @@ class SeedHelper
   extend SeedHelper::OutputFormatter
   extend SeedHelper::RakeHelper
 
-  def self.find_or_create_resource(resource_class, attributes)
-    if resource = find_resource(resource_class, attributes)
+  # If a resource_class with matching identifiable_attributes exists, return that user and present a
+  # resource_already_exists message.
+  #
+  # Otherwise, create a new instance of resource_class using the identifiable_attributes and
+  # additional_attributes.
+  #
+  # @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"}
+  # @param [Hash] additional_attributes: A hash of attributes and values that don't identify
+  #                                      the given resource, but should be assigned to the new resource.
+  def self.find_or_create_resource(resource_class, identifiable_attributes, additional_attributes={})
+    if resource = find_resource(resource_class, identifiable_attributes)
       resource_already_exists(resource)
     else
-      resource = resource_class.new(attributes)
+      resource = resource_class.new(identifiable_attributes.merge(additional_attributes))
       create_resource(resource)
     end
     return resource

data/lib/seed_helper/version.rb

@@ -1,3 +1,3 @@
 class SeedHelper
-  VERSION = "1.7.0"
+  VERSION = "1.8.0"
 end

data/spec/lib/{seed_formatter_spec.rb → seed_helper/output_formatter_spec.rb}

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe SeedHelper do
 
   describe '#output' do
-    subject { SeedHelper.output message, options }
+    subject { SeedHelper.output(message, options) }
     let(:message) { "message" }
     let(:options) { {} }
 
@@ -38,7 +38,7 @@ describe SeedHelper do
   end
 
   describe '#message' do
-    subject { SeedHelper.message message, options }
+    subject { SeedHelper.message(message, options) }
     let(:message) { "message" }
     let(:options) { {:prefix => prefix, :color => color} }
     let(:prefix)  { nil }
@@ -72,7 +72,7 @@ describe SeedHelper do
   end
 
   describe '#success' do
-    subject { SeedHelper.success message, options }
+    subject { SeedHelper.success(message, options) }
     let(:message) { "message" }
     let(:options) { {:prefix => prefix, :color => color} }
     let(:prefix)  { nil }
@@ -106,7 +106,7 @@ describe SeedHelper do
   end
 
   describe '#error' do
-    subject { SeedHelper.error message, options }
+    subject { SeedHelper.error(message, options) }
     let(:message) { "message" }
     let(:options) { {:prefix => prefix, :color => color} }
     let(:prefix)  { nil }

data/spec/lib/seed_helper_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe SeedHelper do
+
+  describe '.find_or_create_resource' do
+    subject { SeedHelper.find_or_create_resource(User, {email: email}, additional_args) }
+    let(:email) { "jordan@example.com" }
+
+    context "without providing additional args" do
+      let(:additional_args) { {} }
+
+      context "when resource already exists" do
+        let!(:user) { User.create(email: email) }
+        it { should eq(user) }
+      end
+
+      context "when resource doesn't exist" do
+        it "creates a new Resource" do
+          expect(User.count).to eq(0)
+          new_user = subject
+          expect(User.count).to eq(1)
+          expect(new_user).to be_kind_of(User)
+          expect(new_user.email).to eq(email)
+        end
+      end
+    end
+
+    context "providing additional args" do
+      let(:additional_args) { {name: "Name"} }
+
+      context "when a matching resource exists" do
+        let!(:user) { User.create(email: email, name: "Other name") }
+
+        it "only matches on identifiable args" do
+          expect(subject).to eq(user)
+        end
+      end
+
+      context "when no resource exists" do
+        it "creates a new item with the identifiable attributes and the additional attributes" do
+          expect(User.count).to eq(0)
+          new_user = subject
+          expect(User.count).to eq(1)
+          expect(new_user).to be_kind_of(User)
+          expect(new_user.email).to eq(email)
+          expect(new_user.name).to eq("Name")
+        end
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,4 +1,32 @@
 require 'rubygems'
-require 'bundler/setup'
+require 'bundler'
+Bundler.require
+require 'rails/all'
 
-require 'seed_helper'
+require 'seed_helper'
+
+# Create an in-memory database to do some basic tests with a real model
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
+
+class User < ActiveRecord::Base
+  def to_s
+    email
+  end
+end
+
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :users, force: true do |t|
+    t.string :email
+    t.string :name
+  end
+
+end
+
+RSpec.configure do |config|
+
+  # DIY Database Cleaner
+  config.before(:each) { User.delete_all }
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seed_helper
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Jordan Maguire
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-03 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -62,7 +62,8 @@ files:
 - lib/seed_helper/version.rb
 - license.txt
 - seed_helper.gemspec
-- spec/lib/seed_formatter_spec.rb
+- spec/lib/seed_helper/output_formatter_spec.rb
+- spec/lib/seed_helper_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jordanmaguire/seed_helper
 licenses:
@@ -84,10 +85,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Make seeding data easier in Rails projects
 test_files:
-- spec/lib/seed_formatter_spec.rb
+- spec/lib/seed_helper/output_formatter_spec.rb
+- spec/lib/seed_helper_spec.rb
 - spec/spec_helper.rb