conflict_detector 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec', '~> 2.0'
+  gem 'rspec-nc'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ennova
+
+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,22 @@
+# Conflict Detector
+
+ConflictDetector is a convenience class for saving the record, or returning the conflict.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'conflict_detector'
+```
+
+## Usage
+
+``` ruby
+def create
+  @post = Post.build(params[:post])
+  detector = ConflictDetector.new(@post, :title, :content, :user_id)
+  @post = detector.conflicting_or_created_record
+  respond_with @post, :status => detector.status
+end
+```

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/conflict_detector.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/conflict_detector/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Tate Johnson', 'Odin Dutton', 'Jason Weathered']
+  gem.email         = ['tate@tatey.com', 'odindutton@gmail.com', 'jason@jasoncodes.com']
+  gem.summary       = %q{ConflictDetector is a convenience class for saving the record, or returning the conflict.}
+  gem.description   = gem.summary
+  gem.homepage      = 'https://github.com/ennova/conflict_detector'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.name          = 'conflict_detector'
+  gem.require_paths = ['lib']
+  gem.version       = ConflictDetector::VERSION
+end

data/lib/conflict_detector.rb

@@ -0,0 +1,53 @@
+require 'conflict_detector/version'
+
+class ConflictDetector
+  attr_accessor :model
+  attr_accessor :names
+  attr_accessor :status
+
+  def initialize model, *names
+    @model = model
+    @names = names
+  end
+
+  # Checks if the model is a duplicate. Duplication is determined by finding
+  # a record that matches the values of the attribute +names+.
+  #
+  # Returns the conflicting model if it is found, otherwise nil.
+  def conflict
+    record = model.class.where(conditions).first
+    if record
+      conflict!
+      record
+    end
+  end
+
+  def create
+    created!
+    model.save
+    model
+  end
+
+  # Convenience method that attempts to save the model, detecting for a
+  # conflict first.
+  #
+  # Returns conflicting record if conflicting record is found, otherwise
+  # the created record.
+  def conflicting_or_created_record
+    conflict || create
+  end
+
+  protected
+
+  def conditions
+    names.inject({}) { |conditions, name| conditions.merge name => model.public_send(name) }
+  end
+
+  def conflict!
+    @status = :conflict
+  end
+
+  def created!
+    @status = :created
+  end
+end

data/lib/conflict_detector/version.rb

@@ -0,0 +1,3 @@
+class ConflictDetector
+  VERSION = '0.0.1'
+end

data/spec/conflict_detector_spec.rb

@@ -0,0 +1,109 @@
+require 'conflict_detector'
+
+describe ConflictDetector do
+  describe 'conflict' do
+    describe 'record does exist' do
+      let(:detector) { ConflictDetector.new(model, :description) }
+      let(:record) { Object.new }
+      let(:model) do
+        mock = mock 'Model'
+        mock.should_receive(:description).and_return('Hello, World!')
+        mock.should_receive(:class).and_return(mock)
+        mock.should_receive(:where).with(:description => 'Hello, World!').and_return(mock)
+        mock.should_receive(:first).and_return(record)
+        mock
+      end
+
+      it 'should be the record' do
+        detector.conflict.should equal(record)
+      end
+
+      describe 'status' do
+        before do
+          detector.conflict
+        end
+
+        it 'should be conflict' do
+          detector.status.should eq(:conflict)
+        end
+      end
+    end
+
+    describe 'record does not exist' do
+      let(:detector) { ConflictDetector.new(model) }
+      let(:model) do
+        mock = mock 'Model'
+        mock.should_receive(:class).and_return(mock)
+        mock.should_receive(:where).and_return(mock)
+        mock.should_receive(:first).and_return(nil)
+        mock
+      end
+
+      it 'should be nil' do
+        detector.conflict.should be_nil
+      end
+
+      describe 'status' do
+        before do
+          detector.conflict
+        end
+
+        it 'should be nil' do
+          detector.status.should be_nil
+        end
+      end
+    end
+  end
+
+  describe 'create' do
+    let(:detector) { ConflictDetector.new(model) }
+    let(:model) do
+      mock = mock 'Model'
+      mock.should_receive(:save).and_return(true)
+      mock
+    end
+
+    it 'should be the model' do
+      detector.create.should equal(model)
+    end
+
+    describe 'status' do
+      before do
+        detector.create
+      end
+
+      it 'should be created' do
+        detector.status.should eq(:created)
+      end
+    end
+  end
+
+  describe 'conflicting or creating record' do
+    describe 'conflict' do
+      let(:record) { Object.new }
+      let(:detector) do
+        detector = ConflictDetector.new(nil)
+        detector.should_receive(:conflict).and_return(record)
+        detector
+      end
+
+      it 'should be the conflicting record' do
+        detector.conflicting_or_created_record.should equal(record)
+      end
+    end
+
+    describe 'create' do
+      let(:record) { Object.new }
+      let(:detector) do
+        detector = ConflictDetector.new(nil)
+        detector.should_receive(:conflict).and_return(nil)
+        detector.should_receive(:create).and_return(record)
+        detector
+      end
+
+      it 'should be the created record' do
+        detector.conflicting_or_created_record.should equal(record)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: conflict_detector
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tate Johnson
+- Odin Dutton
+- Jason Weathered
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies: []
+description: ConflictDetector is a convenience class for saving the record, or returning
+  the conflict.
+email:
+- tate@tatey.com
+- odindutton@gmail.com
+- jason@jasoncodes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- conflict_detector.gemspec
+- lib/conflict_detector.rb
+- lib/conflict_detector/version.rb
+- spec/conflict_detector_spec.rb
+homepage: https://github.com/ennova/conflict_detector
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1871014682422888898
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1871014682422888898
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ConflictDetector is a convenience class for saving the record, or returning
+  the conflict.
+test_files:
+- spec/conflict_detector_spec.rb