activerecord-find_only 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dcb55a9dcdf663195d4f9afdfba53e0f72ede250d1278c6fa10ec91453405b05
+  data.tar.gz: a9c811cf6e122c1fb9394426c2fccd3dc0455b48e4a8f325cc7dc18bccef2c30
+SHA512:
+  metadata.gz: 63ed293c02e7709f79a6f33da9f9ca00cb194de0658f8176c330db63eb1830cd6ad963fb266e3a9f09d5719cac5a2c4000962df20497c8985236c27f1626cbae
+  data.tar.gz: 24fe2b5aebc61a5fde354aab974f22f917a2531063841baa467a845946aa60c303b7f263352f10beee411524904a470507e5a1fbccd619ae68dcd6e4153dc726

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/bundle/
+/.yardoc
+/.byebug_history
+/.rvmrc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activerecord-find_only.gemspec
+gemspec
+
+gem "byebug"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    activerecord-find_only (0.3.0)
+      activerecord
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.2.1)
+      activesupport (= 5.2.2.1)
+    activerecord (5.2.2.1)
+      activemodel (= 5.2.2.1)
+      activesupport (= 5.2.2.1)
+      arel (>= 9.0)
+    activesupport (5.2.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    sqlite3 (1.3.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord-find_only!
+  bundler (~> 1.16)
+  byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3 (~> 1.3.6)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Joshua Flanagan
+
+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,35 @@
+# ActiveRecord::FindOnly
+
+Provides the `#find_only` and `#find_only!` methods for querying ActiveRecord objects.
+
+`#find_only` - returns the only record that meets the criteria. If no records match
+the criteria, `nil` is returned. Raises `TooManyRecords` if more than one
+records matches the criteria.
+
+`#find_only!` - returns the only record that meets the criteria. If no records match
+the criteria, `RecordNotFound` is raised. Raises `TooManyRecords` if more than
+one records matches the criteria.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record-find_only'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record-find_only
+
+## Usage
+
+See the spec files for example usage.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-find_only.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "active_record/find_only/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-find_only"
+  spec.version       = ActiveRecord::FindOnly::VERSION
+  spec.authors       = ["Joshua Flanagan"]
+  spec.email         = ["joshuaflanagan@gmail.com"]
+
+  spec.summary       = %q{Query for a single item, and ensure it is the only one.}
+  spec.description   = %q{Provides find_only and find_only! query methods}
+  spec.homepage      = "https://github.com/joshuaflanagan/active_record-find_only"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "sqlite3", "~> 1.3.6" # dictated by activerecord-5.2.2.1/lib/active_record/connection_adapters/sqlite3_adapter.rb:12
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_record/find_only"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --standalone
+
+# Do any other automated setup that you need to do here

data/lib/active_record/find_only/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module FindOnly
+    VERSION = "0.3.0"
+  end
+end

data/lib/active_record/find_only.rb

@@ -0,0 +1,57 @@
+unless defined?(Arel)
+  raise 'activerecord-find_only has to be required after ActiveRecord/Arel'
+end
+
+unless defined?(ActiveRecord)
+  raise 'activerecord-find_only has to be required after ActiveRecord'
+end
+
+require "active_record"
+require "active_record/find_only/version"
+
+module ActiveRecord
+  module FindOnly
+    class TooManyRecords < ActiveRecord::ActiveRecordError
+    end
+
+    # Gives the only record that matches the criteria.
+    # If no record matches the criteria, nil is returned.
+    # If more than one record matches the criteria, TooManyRecords is raised.
+    def find_only
+      found_records = take(2)
+      if found_records.length > 1
+        raise TooManyRecords
+      end
+      found_records[0]
+    end
+
+    # Gives the only record that matches the criteria.
+    # If no record matches the criteria, RecordNotFound is raised.
+    # If more than one record matches the criteria, TooManyRecords is raised.
+    def find_only!
+      find_only || raise_record_not_found_exception!
+    end
+  end
+
+  Relation.class_eval do
+    include FindOnly
+  end
+
+  Querying.class_eval do
+    delegate :find_only, :find_only!, to: :all
+  end
+
+  Associations::CollectionProxy.class_eval do
+    def find_only
+      if loaded?
+        if records.length > 1
+          raise ActiveRecord::FindOnly::TooManyRecords
+        end
+        records[0]
+      else
+        super
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-find_only
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Joshua Flanagan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Provides find_only and find_only! query methods
+email:
+- joshuaflanagan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-find_only.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/find_only.rb
+- lib/active_record/find_only/version.rb
+homepage: https://github.com/joshuaflanagan/active_record-find_only
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: Query for a single item, and ensure it is the only one.
+test_files: []