detect_or_create 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in detect_or_create.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 jnwheeler44
+
+MIT License
+
+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.md

@@ -0,0 +1,64 @@
+# DetectOrCreate
+
+Rails 2.3.9 introduces a change which makes find_or_create_by unusable
+with a hash as an argument. This gem gives similar functionality, with
+the added ability to overwrite the existing record that is found.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'detect_or_create'
+
+Add after the Rails::Initializer block:
+
+    require 'detect_or_create'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install detect_or_create
+
+## Usage
+
+Find user with email "user@domain.com" or create a new user with that
+email and additional attributes:
+
+```
+User.detect_or_create(:by => { :email => "user@domain.com" },
+                      :with => { :name => "User", :active => true })
+
+```
+
+Just including the `by` argument will also work if you don't need
+additional attributes.
+
+```
+User.detect_or_create(:by => { :email => "user@domain.com" })
+```
+
+You can also modify what was found:
+
+```
+User.detect_or_create(:by => { :email => "user@domain.com" },
+                      :with => { :name => "Domain User 1",
+                                 :email => "user1@domain.com"},
+                      :overwrite_existing => true)
+```
+
+## Run specs
+
+
+    $ rspec spec/detect_or_create_spec.rb
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/detect_or_create/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/detect_or_create.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'detect_or_create/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "detect_or_create"
+  spec.version       = DetectOrCreate::VERSION
+  spec.authors       = ["jnwheeler44"]
+  spec.email         = ["jnwheeler44@gmail.com"]
+  spec.summary       = %q{Gem to replace find_or_create_by functionality in Rails 2.3}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency 'rails', '~> 2.3'
+  spec.add_development_dependency 'pry'
+  spec.add_runtime_dependency 'rails', '~> 2.3'
+end

data/lib/detect_or_create.rb

@@ -0,0 +1,14 @@
+require "detect_or_create/version"
+require "detect_or_create/class_methods"
+
+module DetectOrCreate
+  def self.included(base)
+    base.extend ClassMethods
+  end
+end
+
+
+class ActiveRecord::Base
+  include DetectOrCreate
+end
+

data/lib/detect_or_create/class_methods.rb

@@ -0,0 +1,50 @@
+module DetectOrCreate
+  module ClassMethods
+    def detect_or_create(args={})
+      if errors = invalid_arguments(args) and errors.present?
+        raise StandardError, "#{errors}"
+      end
+
+      found_object = self.first(:conditions => args[:by]) || self.create(args[:by].merge(args[:with]))
+
+      if args[:overwrite_existing] && !found_object.new_record?
+        found_object.update_attributes(args[:with])
+      end
+
+      found_object
+    end
+
+    private
+
+    def required_keys
+      [:by]
+    end
+
+    def required_types
+      { :by => Hash,
+        :with => Hash }
+    end
+
+    def missing_keys(args)
+      required_keys - args.keys
+    end
+
+    def mismatched_types(args)
+      required_types.collect { |key, type|
+        "`#{key}` must be a #{type}" if args[key].present? && !args[key].is_a?(type)
+      }.compact.join("\n")
+    end
+
+    def invalid_arguments(args)
+      case
+      when missing_keys(args).present?
+        "Missing Arguments: `#{missing_keys(args).join(",")}`"
+      when mismatched_types(args).present?
+        mismatched_types(args)
+      when !args[:by].keys.present?
+        "Missing keys to filter by"
+      end
+    end
+  end
+end
+

data/lib/detect_or_create/version.rb

@@ -0,0 +1,3 @@
+module DetectOrCreate
+  VERSION = "0.0.1"
+end

data/spec/detect_or_create_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe DetectOrCreate do
+  before(:all) { class User < ActiveRecord::Base; end; }
+
+  it 'validates required arguments exist' do
+    expect { User.detect_or_create() }.
+      to raise_error(StandardError, "Missing Arguments: `by`")
+  end
+
+  it 'validates :by type' do
+    expect { User.detect_or_create(:by => ['id = ?', 1]) }.
+      to raise_error(StandardError, "`by` must be a Hash")
+  end
+
+  it 'validates :with type' do
+    expect { User.detect_or_create(:by => {:name => 'name'},
+                                   :with => 1) }.
+      to raise_error(StandardError, "`with` must be a Hash")
+  end
+
+  it 'validates :by values' do
+    expect { User.detect_or_create(:by => {}) }.
+      to raise_error(StandardError, "Missing keys to filter by")
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'active_record'
+require 'detect_or_create'
+
+
+RSpec.configure do |config|
+  # some (optional) config here
+end
+

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification 
+name: detect_or_create
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- jnwheeler44
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-03-04 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 1
+        - 5
+        version: "1.5"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: pry
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :runtime
+  version_requirements: *id007
+description: 
+email: 
+- jnwheeler44@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- detect_or_create.gemspec
+- lib/detect_or_create.rb
+- lib/detect_or_create/class_methods.rb
+- lib/detect_or_create/version.rb
+- spec/detect_or_create_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Gem to replace find_or_create_by functionality in Rails 2.3
+test_files: 
+- spec/detect_or_create_spec.rb
+- spec/spec_helper.rb