find_or_create_on_scopes 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,26 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.bundle
+.rvmrc
+test.sqlite
+
+## PROJECT::DOCUMENTATION
+.yardoc
+doc

data/.rspec

@@ -0,0 +1 @@
+-cfs

data/Gemfile

@@ -0,0 +1,13 @@
+source :rubygems
+
+# DEPENDENCIES
+gem 'activerecord', require: 'active_record'
+
+# DEVELOPMENT
+gem 'jeweler'
+gem 'yard'
+gem 'RedCloth', require: 'redcloth'
+gem 'sqlite3'
+
+# TEST
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,56 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    RedCloth (4.2.3)
+    activemodel (3.0.1)
+      activesupport (= 3.0.1)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.1)
+      activemodel (= 3.0.1)
+      activesupport (= 3.0.1)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.1)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    gemcutter (0.6.1)
+    git (1.2.5)
+    i18n (0.4.2)
+    jeweler (1.4.0)
+      gemcutter (>= 0.1.0)
+      git (>= 1.2.5)
+      rubyforge (>= 2.0.0)
+    json_pure (1.4.6)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rubyforge (2.0.4)
+      json_pure (>= 1.1.7)
+    sqlite3 (0.1.1)
+      ffi (>= 0.6.3)
+    tzinfo (0.3.23)
+    yard (0.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  RedCloth
+  activerecord
+  jeweler
+  rspec
+  sqlite3
+  yard

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tim Morgan
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,34 @@
+h1. find_or_create_on_scopes -- Conditional creators for ActiveRecord
+
+| *Author* | Tim Morgan |
+| *Version* | 1.0 (Oct 29, 2010) |
+| *License* | Released under the MIT license. |
+
+h2. About
+
+@find_or_create_on_scopes@ adds handy @find_or_create@-type methods to @ActiveRecord@. You can use these methods to conditionally create, initialize, or update records depending on the presence of similar records. They work on your base model class and any scopes derived therefrom. (See _Usage_ for examples.)
+
+h2. Installation
+
+*Important Note:* This gem requires Ruby 1.9. Ruby 1.8 is not and will never be supported.
+
+To install, simply add the @find_or_create_on_scopes@ gem to your Rails application's @Gemfile@:
+
+<pre><code>
+gem 'find_or_create_on_scopes'
+</code></pre>
+
+h2. Usage
+
+See the @FindOrCreateOnScopes@ module documentation for the complete list of conditional creators/updaters. Some basic examples to give you an overview:
+
+<pre><code>
+# Tries to find a user named 'riscfuture'. If such a User exists, returns it. If
+# not, creates a user and sets its password to '123'.
+User.where(login: 'riscfuture').find_or_create(password: '123')
+
+# Tries to find a user named 'riscfuture'. If such a User exists, updates its
+# password to '123'. If not, creates a new user and sets its password to '123'.
+# Raises an exception if validation fails.
+User.where(login: 'riscfuture').create_or_update!(password: '123')
+</code></pre>

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+begin
+  require 'bundler'
+rescue LoadError
+  puts "Bundler is not installed; install with `gem install bundler`."
+  exit 1
+end
+
+Bundler.require :default
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "find_or_create_on_scopes"
+  gem.summary = %Q{find_or_create-type methods on ActiveRecord scopes}
+  gem.description = %Q{Adds methods to ActiveRecord for conditionally finding, creating, or updating records.}
+  gem.email = "git@timothymorgan.info"
+  gem.homepage = "http://github.com/riscfuture/find_or_create_on_scopes"
+  gem.authors = [ "Tim Morgan" ]
+  gem.required_ruby_version = '>= 1.9'
+  gem.add_dependency "activerecord", ">= 0"
+end
+Jeweler::GemcutterTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+YARD::Rake::YardocTask.new('doc') do |doc|
+  doc.options << "-m" << "textile"
+  doc.options << "--protected"
+  doc.options << "-r" << "README.textile"
+  doc.options << "-o" << "doc"
+  doc.options << "--title" << "find_or_create_on_scopes Documentation".inspect
+  
+  doc.files = [ 'lib/**/*', 'README.textile' ]
+end
+
+task(default: :spec)

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/find_or_create_on_scopes.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{find_or_create_on_scopes}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Morgan"]
+  s.date = %q{2010-10-29}
+  s.description = %q{Adds methods to ActiveRecord for conditionally finding, creating, or updating records.}
+  s.email = %q{git@timothymorgan.info}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".rspec",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "find_or_create_on_scopes.gemspec",
+     "lib/find_or_create_on_scopes.rb",
+     "spec/find_or_create_on_scopes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/riscfuture/find_or_create_on_scopes}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9")
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{find_or_create-type methods on ActiveRecord scopes}
+  s.test_files = [
+    "spec/find_or_create_on_scopes_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+  end
+end
+

data/lib/find_or_create_on_scopes.rb

@@ -0,0 +1,86 @@
+# Adds @find_or_create@-type methods to named scopes.
+
+module FindOrCreateOnScopes
+
+  # Locates a record according to the current scope. Returns the record if
+  # found. If not found, creates a new record with the options of the current
+  # scope and @create_options@.
+  #
+  # @param [Hash] create_options Attributes to apply to the record if it's newly
+  # created.
+  # @yield [record] Yields the record before it is saved.
+  # @yieldparam [ActiveRecord::Base] The found or created record before it is
+  # saved.
+  # @return [ActiveRecord::Base] The found or created record.
+
+  def find_or_create(create_options={}, &block)
+    find_or_initialize_and_do :save, create_options, &block
+  end
+
+  # Same as {#find_or_create} but calls @save!@ instead of @save@ on the record.
+  #
+  # @see #find_or_create
+
+  def find_or_create!(create_options={}, &block)
+    find_or_initialize_and_do :save!, create_options, &block
+  end
+
+  # Same as {#find_or_create} but does not save the record. Please note that
+  # unless this method is called in a transaction, you might have a race
+  # condition when trying to save the record.
+  #
+  # @see #find_or_create
+
+  def find_or_initialize(init_options={}, &block)
+    find_or_initialize_and_do nil, init_options, &block
+  end
+
+  # Locates a record according to the current scope. Updates the record with
+  # @update_options@ if found. If not found, creates a new record with the
+  # current scope's options and @update_options@.
+  #
+  # @param [Hash] update_options Attributes to apply to the record whether or
+  # not it's newly created.
+  # @yield [record] Yields the record before it is saved.
+  # @yieldparam [ActiveRecord::Base] The found or created record before it is
+  # saved.
+  # @return [ActiveRecord::Base] The found or created record.
+
+  def create_or_update(update_options={}, &block)
+    create_or_update_and_do :save, update_options, &block
+  end
+
+  # Same as {#create_or_update} but calls @save!@ instead of @save@ on the
+  # record.
+  #
+  # @see #create_or_update
+
+  def create_or_update!(update_options={}, &block)
+    create_or_update_and_do :save!, update_options, &block
+  end
+
+  private
+
+  def find_or_initialize_and_do(meth, options)
+    record = nil
+    transaction do
+      record = first || new(options)
+      yield record if block_given?
+      record.send(meth) if meth
+    end
+    return record
+  end
+
+  def create_or_update_and_do(meth, options)
+    record = nil
+    transaction do
+      record = first || new
+      record.attributes = options
+      yield record if block_given?
+      record.send(meth) if meth
+    end
+    return record
+  end
+end
+
+ActiveRecord::Relation.send :include, FindOrCreateOnScopes

data/spec/find_or_create_on_scopes_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe FindOrCreateOnScopes do
+  {
+    :find_or_create => :save,
+    :find_or_create! => :save!,
+    :find_or_initialize => nil
+  }.each do |meth, saver|
+    describe "##{meth}" do
+      it "should find an object if a matching one exists" do
+        record = Option.create!(name: 'foo', value: 'bar')
+        Option.where(name: 'foo').send(meth, value: 'bar2').should eql(record)
+      end
+
+      it "should create an object if a matching one does not exist" do
+        Option.create!(name: 'foo2', value: 'bar2')
+        record = Option.where(name: 'foo').send(meth, value: 'bar2')
+        record.name.should eql('foo')
+        record.value.should eql('bar2')
+      end
+
+      it "should do so in a transaction" do
+        Option.should_receive(:transaction)
+        Option.where(name: 'foo').send(meth, value: 'bar')
+      end
+
+      it "should yield the object to the block" do
+        record = Option.where(name: 'foo').send(meth, value: 'bar') { |u| u.field = "foobar" }
+        record.field.should eql('foobar')
+
+        record = Option.where(name: 'foo').send(meth, value: 'bar') { |u| u.field = "foobar2" }
+        record.field.should eql('foobar2')
+      end
+
+      if saver then
+        it "should call #{saver}" do
+          record = Option.new
+          Option.stub!(:new).and_return(record)
+          record.should_receive(saver).once.and_return(true)
+          Option.where(name: 'foo').send(meth, value: 'bar').should eql(record)
+        end
+      end
+    end
+  end
+
+  {
+    :create_or_update => :save,
+    :create_or_update! => :save!,
+  }.each do |meth, saver|
+    describe "##{meth}" do
+      it "should find an object and update it if a matching one exists" do
+        record = Option.create!(name: 'foo', value: 'bar')
+        Option.where(name: 'foo').send(meth, value: 'bar2').should eql(record)
+        record.reload.value.should eql('bar2')
+      end
+
+      it "should create an object if a matching one does not exist" do
+        Option.create!(name: 'foo2', value: 'bar2')
+        record = Option.where(name: 'foo').send(meth, value: 'bar')
+        record.name.should eql('foo')
+        record.value.should eql('bar')
+      end
+
+      it "should do so in a transaction" do
+        Option.should_receive(:transaction)
+        Option.where(name: 'foo').send(meth, value: 'bar')
+      end
+
+      it "should yield the object to the block" do
+        record = Option.where(name: 'foo').send(meth, value: 'bar') { |u| u.field = "foobar" }
+        record.field.should eql('foobar')
+
+        record = Option.where(name: 'foo').send(meth, value: 'bar') { |u| u.field = "foobar2" }
+        record.field.should eql('foobar2')
+      end
+
+      if saver then
+        it "should call #{saver}" do
+          record = Option.new
+          Option.stub!(:new).and_return(record)
+          record.should_receive(saver).and_return(true)
+          Option.where(name: 'foo').send(meth, value: 'bar').should eql(record)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+Bundler.require :default, :test
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'find_or_create_on_scopes'
+
+ActiveRecord::Base.establish_connection(
+  adapter: 'sqlite3',
+  database: 'test.sqlite'
+)
+
+class Option < ActiveRecord::Base
+  attr_accessor :field
+end
+
+RSpec.configure do |config|
+  config.before(:each) do
+    Option.connection.execute "DROP TABLE IF EXISTS options"
+    Option.connection.execute "CREATE TABLE options (id INTEGER PRIMARY KEY ASC, name VARCHAR(127) NOT NULL, value VARCHAR(255))"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: find_or_create_on_scopes
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tim Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-29 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+description: Adds methods to ActiveRecord for conditionally finding, creating, or updating records.
+email: git@timothymorgan.info
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- find_or_create_on_scopes.gemspec
+- lib/find_or_create_on_scopes.rb
+- spec/find_or_create_on_scopes_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/riscfuture/find_or_create_on_scopes
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 9
+      version: "1.9"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: find_or_create-type methods on ActiveRecord scopes
+test_files: 
+- spec/find_or_create_on_scopes_spec.rb
+- spec/spec_helper.rb