the_artist_formerly_known_as_mongoid_document 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 092bc3b05b2a76809bf1f724656e1902f04df519
+  data.tar.gz: 277758e9c228352ecf9978f93ca7d3f7b8ffd6c1
+SHA512:
+  metadata.gz: 455f899dac192979767f1d3f50e3874fb538a0298f2b9e39ba8186179675598356d026911e437ba2e060b49b045f5f80d74ac61dac6174712bce8722bbb5e83e
+  data.tar.gz: 594f627e5636940d80ff7994fdf7ade0102f21bb1979c4ae1c7d718595159d54699adf8e9e4b011bf5b3650e6379121effa4f15a75a9ffe3816d0f83f8196103

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Dunlap
+
+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,65 @@
+# TheArtistFormerlyKnownAsMongoidDocument
+
+Moving away from Mongo/Mongoid in a Rails app?  Still wish to honor legacy
+mongo `ObjectId`s?  Well do I have the solution for you!
+`TheArtistFormerlyKnownAsMongoidDocument` is a simple approach that allows
+`#find` methods to still look up by a mongo id.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'the_artist_formerly_known_as_mongoid_document'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-the_artist_formerly_known_as_mongoid_document
+
+## Usage
+
+As you migrate from a `Mongoid::Document` model to a new `ActiveRecord` model,
+make sure to include an indexed field `mongo_id` which contains the old mongo
+id. In your new model, extend `TheArtistFormerlyKnownAsMongoidDocument`.
+For example:
+
+```ruby
+require 'the_artist_formerly_known_as_mongoid_document'
+
+class Artist < ActiveRecord::Base
+  extend 'TheArtistFormerlyKnownAsMongoidDocument'
+
+  # ...
+
+end
+```
+
+You can then use `#find` for both `mongo_id`s:
+
+```ruby
+Artist.find('52829a3e73d8b08b00ad5d63')
+```
+
+And of course you can still look for plain-old regular `id`s:
+
+```ruby
+Artist.find(1)
+```
+
+### Note
+
+If you are using something like [FriendlyId], it is wise to put `extend
+TheArtistFormerlyKnownAsMongoidDocument` after `extend FriendlyId`.
+
+## Contributing
+
+1. Fork it
+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
+
+[FriendlyId]: https://github.com/norman/friendly_id

data/Rakefile

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

data/lib/the_artist_formerly_known_as_mongoid_document/version.rb

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

data/lib/the_artist_formerly_known_as_mongoid_document.rb

@@ -0,0 +1,19 @@
+require "the_artist_formerly_known_as_mongoid_document/version"
+
+module TheArtistFormerlyKnownAsMongoidDocument
+  # find by either the id proper or mongo_id
+  # @param *args either a single id or multiple ids
+  # @note currently searching by multiple mongo ids is unsupported
+  # @note this calls super (and therefore hits the database twice) if not found by the mongo id
+  # @return [TheArtistFormallyKnownAsMongoidDoument::Base] object representing the model found by either id or mongo_id
+  def find(*args)
+    id = args.first
+    if args.count == 1 && !id.is_a?(Numeric) && id.to_s.match( /^[0-9a-fA-F]{24}$/ )
+      found_by_mongo_id = where mongo_id: id
+      return super if found_by_mongo_id.count == 0
+      return found_by_mongo_id.first
+    else
+      return super
+    end
+  end
+end

data/spec/lib/the_artist_formally_known_as_mongoid_document_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'the_artist_formerly_known_as_mongoid_document'
+
+describe TheArtistFormerlyKnownAsMongoidDocument do
+  let(:matched_mongo_id) { '507f1f77bcf86cd799439011' }
+  let(:unmatched_mongo_id) { '5282956f60f1e162f4742098' }
+  before(:each) do
+    build_model :artist do
+      string :name
+      string :mongo_id
+    end
+    Artist.extend(TheArtistFormerlyKnownAsMongoidDocument)
+    @prince = Artist.create(mongo_id: matched_mongo_id, name: 'Prince')
+  end
+
+  describe '.find' do
+    it 'should look up by mongo_id when a mongo id is supplied' do
+      #Artist.should_receive(:where).with(mongo_id: matched_mongo_id) { [ Artist.new( name: 'Prince', mongo_id: matched_mongo_id ) ] }
+      expect( Artist.find(matched_mongo_id) ).to eq(@prince)
+    end
+
+    it 'should look up by id when a numeric id is supplied' do
+      expect( Artist.find(@prince.id) ).to eq(@prince)
+    end
+
+    it 'should raise and error if no record exists by the mongoid id' do
+      expect{ Artist.find(unmatched_mongo_id) }.to raise_error( ActiveRecord::RecordNotFound ) 
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'acts_as_fu'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+  config.include ActsAsFu
+end

data/the_artist_formerly_known_as_mongoid_document.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'the_artist_formerly_known_as_mongoid_document/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "the_artist_formerly_known_as_mongoid_document"
+  spec.version       = TheArtistFormerlyKnownAsMongoidDocument::VERSION
+  spec.authors       = ["Steven Dunlap"]
+  spec.email         = ["steven@roadtrippers.com"]
+  spec.description   = 'Make migrating away from Mongoid slightly less painful.' 
+  spec.summary       = 'Provide legacy support for old mongo ids in the finder methods at the model level after migrating away from Mongoid.'
+  spec.homepage      = "http://github.com/roadtrippers/the_artist_formerly_known_as_mongoid_document"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "acts_as_fu"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: the_artist_formerly_known_as_mongoid_document
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven Dunlap
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: acts_as_fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make migrating away from Mongoid slightly less painful.
+email:
+- steven@roadtrippers.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/the_artist_formerly_known_as_mongoid_document.rb
+- lib/the_artist_formerly_known_as_mongoid_document/version.rb
+- spec/lib/the_artist_formally_known_as_mongoid_document_spec.rb
+- spec/spec_helper.rb
+- the_artist_formerly_known_as_mongoid_document.gemspec
+homepage: http://github.com/roadtrippers/the_artist_formerly_known_as_mongoid_document
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Provide legacy support for old mongo ids in the finder methods at the model
+  level after migrating away from Mongoid.
+test_files:
+- spec/lib/the_artist_formally_known_as_mongoid_document_spec.rb
+- spec/spec_helper.rb