orm_adapter-nobrainer 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 892a6a4f6de55d2c43f6ac0ef383cbc385657029
+  data.tar.gz: cba3bbe77b3678f1a93e4a88ce42f636f0042bd0
+SHA512:
+  metadata.gz: 81857aef2d003e96892806fb86c1e7e514e289c47e2172e1fa2b17e2ad1712732a263fa8a5e5d40632bce1514e7b231b81b6ac04202c6df42165d11f1941fe1d
+  data.tar.gz: adf74a48305f7d7d2a341d6437bd0fa64daa2a90b82b5b708571427d70817205334251c416f49cf0da7e92e0b25e36138327b68ef99140f4e1894500a8269493

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Colin Mattson
+
+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,44 @@
+# orm_adapter-nobrainer
+
+orm_adapter-nobrainer is an [OrmAdapter][orma] plugin that adds support for
+Nicolas Viennot's [NoBrainer][nborm] RethinkDB ORM.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'orm_adapter-nobrainer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orm_adapter-nobrainer
+
+## Usage
+
+Include it in your Gemfile.
+
+## Caveats
+
+**N.B.:** Not all orm_adapter tests pass! Due to eccentricities in the way
+NoBrainer handles associations, orm_adapter-nobrainer currently fails (as
+expected) when attempting to write to a has-many association.
+
+This will *likely* not affect real-world use, but is on the roadmap to be
+addressed.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/orm_adapter-nobrainer/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 a new Pull Request
+
+[orma]: https://github.com/ianwhite/orm_adapter
+[nborm]: https://github.com/nviennot/nobrainer/

data/Rakefile

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

data/lib/orm_adapter-nobrainer.rb

@@ -0,0 +1,3 @@
+require 'orm_adapter'
+require 'orm_adapter-nobrainer/version'
+require 'orm_adapter-nobrainer/nobrainer'

data/lib/orm_adapter-nobrainer/nobrainer.rb

@@ -0,0 +1,75 @@
+require 'nobrainer'
+
+module NoBrainer
+  module Document
+    module ClassMethods
+      include OrmAdapter::ToAdapter
+    end
+
+    class OrmAdapter < ::OrmAdapter::Base
+      # Get a list of column/property/field names
+      def column_names
+        klass.fields.keys
+      end
+
+      # Get an instance by id of the model. Raises an error if a model is not found.
+      def get!(id)
+        klass.find!(wrap_key(id))
+      end
+
+      # Get an instance by id of the model. Returns nil if a model is not found.
+      def get(id)
+        klass.find(wrap_key(id))
+      end
+
+      # Find the first instance, optionally matching conditions, and specifying order
+      #
+      # You can call with just conditions, providing a hash
+      #
+      #   User.to_adapter.find_first :name => "Fred", :age => 23
+      #
+      # Or you can specify :order, and :conditions as keys
+      #
+      #   User.to_adapter.find_first :conditions => {:name => "Fred", :age => 23}
+      #   User.to_adapter.find_first :order => [:age, :desc]
+      #   User.to_adapter.find_first :order => :name, :conditions => {:age => 18}
+      #
+      # When specifying :order, it may be
+      # * a single arg e.g. <tt>:order => :name</tt>
+      # * a single pair with :asc, or :desc as last, e.g. <tt>:order => [:name, :desc]</tt>
+      # * an array of single args or pairs (with :asc or :desc as last), e.g. <tt>:order => [[:name, :asc], [:age, :desc]]</tt>
+      #
+      def find_first(options = {})
+        conditions, order = extract_conditions!(options)
+        klass.where(conditions).order_by(order_to_nql(order)).first
+      end
+
+      # Find all models, optionally matching conditions, and specifying order
+      # @see OrmAdapter::Base#find_first for how to specify order and conditions
+      def find_all(options = {})
+        conditions, order, limit, offset = extract_conditions!(options)
+        klass.where(conditions).order_by(order_to_nql(order)).limit(limit).skip(offset)
+      end
+
+      # Create a model using attributes
+      def create!(attributes = {})
+        klass.create!(attributes)
+      end
+
+      # Destroy an instance by passing in the instance itself.
+      def destroy(object)
+        object.destroy if valid_object?(object)
+      end
+
+      protected
+      # NoBrainer does not accept arrays as an `order_by` argument.
+      def order_to_nql(order)
+        if order.empty?
+          nil
+        else
+          order.to_h
+        end
+      end
+    end
+  end
+end

data/lib/orm_adapter-nobrainer/version.rb

@@ -0,0 +1,3 @@
+module OrmAdapterNoBrainer
+    VERSION = '0.9.0'
+end

data/orm_adapter-nobrainer.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'orm_adapter-nobrainer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'orm_adapter-nobrainer'
+  spec.version       = OrmAdapterNoBrainer::VERSION
+  spec.summary       = %q{NoBrainer support for orm_adapter}
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = 'https://github.com/cmattson/orm_adapter-nobrainer'
+  spec.license       = 'MIT'
+  spec.authors       = ['Colin Mattson']
+  spec.email         = ['colinmattson@gmail.com']
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.7'
+  spec.add_development_dependency 'rake',     '~> 10.0'
+  spec.add_development_dependency 'rspec',    '~> 3.0.0'
+  spec.add_development_dependency 'yard',     '>= 0.6.0'
+  spec.add_development_dependency 'rethinkdb', '~> 1.13'
+
+  spec.add_dependency 'orm_adapter',  '~> 0.5.0'
+  spec.add_dependency 'nobrainer',    '~> 0.15.0'
+end

data/spec/example_app_shared.rb

@@ -0,0 +1,242 @@
+# Copied from orm_adapter and fixed some Specs
+
+# to test your new orm_adapter, make an example app that matches the functionality
+# found in the existing specs for example, look at spec/orm_adapter/adapters/active_record_spec.rb
+#
+# Then you can execute this shared spec as follows:
+#
+#   it_should_behave_like "example app with orm_adapter" do
+#     let(:user_class) { User }
+#     let(:note_class) { Note }
+#
+#     # optionaly define the following functions if the ORM does not support
+#     # this syntax - this should NOT use the orm_adapter, because we're testing that
+#     def create_model(klass, attrs = {})
+#       klass.create!(attrs)
+#     end
+#
+#     def reload_model(model)
+#       model.class.find(model.id)
+#     end
+#   end
+#
+shared_examples_for "example app with orm_adapter" do
+
+  def create_model(klass, attrs = {})
+    klass.create!(attrs)
+  end
+
+  def reload_model(model)
+    model.class.find(model.id)
+  end
+
+  describe "an ORM class" do
+    subject { note_class }
+
+    it "#to_adapter should return an adapter instance" do
+      subject.to_adapter.should be_a(OrmAdapter::Base)
+    end
+
+    it "#to_adapter should return an adapter for the receiver" do
+      subject.to_adapter.klass.should == subject
+    end
+
+    it "#to_adapter should be cached" do
+      subject.to_adapter.object_id.should == subject.to_adapter.object_id
+    end
+  end
+
+  describe "adapter instance" do
+    let(:note_adapter) { note_class.to_adapter }
+    let(:user_adapter) { user_class.to_adapter }
+
+    describe "#get!(id)" do
+      it "should return the instance with id if it exists" do
+        user = create_model(user_class)
+        user_adapter.get!(user.id).should == user
+      end
+
+      it "should allow to_key like arguments" do
+        user = create_model(user_class)
+        user_adapter.get!(user.to_key).should == user
+      end
+
+      it "should raise an error if there is no instance with that id" do
+        lambda { user_adapter.get!("nonexistent id") }.should raise_error
+      end
+    end
+
+    describe "#get(id)" do
+      it "should return the instance with id if it exists" do
+        user = create_model(user_class)
+        user_adapter.get(user.id).should == user
+      end
+
+      it "should allow to_key like arguments" do
+        user = create_model(user_class)
+        user_adapter.get(user.to_key).should == user
+      end
+
+      it "should return nil if there is no instance with that id" do
+        user_adapter.get("nonexistent id").should be_nil
+      end
+    end
+
+    describe "#find_first" do
+      describe "(conditions)" do
+        it "should return first model matching conditions, if it exists" do
+          user = create_model(user_class, :name => "Fred")
+          user_adapter.find_first(:name => "Fred").should == user
+        end
+
+        it "should return nil if no conditions match" do
+          user_adapter.find_first(:name => "Betty").should == nil
+        end
+
+        it 'should return the first model if no conditions passed' do
+          user = create_model(user_class)
+          create_model(user_class)
+          user_adapter.find_first.should == user
+        end
+
+        it "when conditions contain associated object, should return first model if it exists" do
+          user = create_model(user_class)
+          note = create_model(note_class, :owner => user)
+          note_adapter.find_first(:owner => user).should == note
+        end
+
+        it "understands :id as a primary key condition (allowing scoped finding)" do
+          create_model(user_class, :name => "Fred")
+          user = create_model(user_class, :name => "Fred")
+          user_adapter.find_first(:id => user.id, :name => "Fred").should == user
+          user_adapter.find_first(:id => user.id, :name => "Not Fred").should be_nil
+        end
+      end
+
+      describe "(:order => <order array>)" do
+        it "should return first model in specified order" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user_adapter.find_first(:order => [:name, [:rating, :desc]]).should == user2
+        end
+      end
+
+      describe "(:conditions => <conditions hash>, :order => <order array>)" do
+        it "should return first model matching conditions, in specified order" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user_adapter.find_first(:conditions => {:name => "Fred"}, :order => [:rating, :desc]).should == user2
+        end
+      end
+    end
+
+    describe "#find_all" do
+      describe "(conditions)" do
+        it "should return only models matching conditions" do
+          user1 = create_model(user_class, :name => "Fred")
+          user2 = create_model(user_class, :name => "Fred")
+          user3 = create_model(user_class, :name => "Betty")
+          user_adapter.find_all(:name => "Fred").to_a.should =~ [user1, user2]
+        end
+
+        it "should return all models if no conditions passed" do
+          user1 = create_model(user_class, :name => "Fred")
+          user2 = create_model(user_class, :name => "Fred")
+          user3 = create_model(user_class, :name => "Betty")
+          user_adapter.find_all.to_a.should =~ [user1, user2, user3]
+        end
+
+        it "should return empty array if no conditions match" do
+          user_adapter.find_all(:name => "Fred").should == []
+        end
+
+        it "when conditions contain associated object, should return first model if it exists" do
+          user1, user2 = create_model(user_class), create_model(user_class)
+          note1 = create_model(note_class, :owner => user1)
+          note2 = create_model(note_class, :owner => user2)
+          note_adapter.find_all(:owner => user2).should == [note2]
+        end
+      end
+
+      describe "(:order => <order array>)" do
+        it "should return all models in specified order" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user3 = create_model(user_class, :name => "Betty", :rating => 1)
+          user_adapter.find_all(:order => [:name, [:rating, :desc]]).should == [user3, user2, user1]
+        end
+      end
+
+      describe "(:conditions => <conditions hash>, :order => <order array>)" do
+        it "should return only models matching conditions, in specified order" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user3 = create_model(user_class, :name => "Betty", :rating => 1)
+          user_adapter.find_all(:conditions => {:name => "Fred"}, :order => [:rating, :desc]).should == [user2, user1]
+        end
+      end
+
+      describe "(:limit => <number of items>)" do
+        it "should return a limited set of matching models" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user3 = create_model(user_class, :name => "Betty", :rating => 3)
+          user_adapter.find_all(:limit => 1, :order => [:rating, :asc]).should == [user1]
+          user_adapter.find_all(:limit => 2, :order => [:rating, :asc]).should == [user1, user2]
+        end
+      end
+
+      describe "(:offset => <offset number>) with limit (as DataMapper doesn't allow offset on its own)" do
+        it "should return an offset set of matching models" do
+          user1 = create_model(user_class, :name => "Fred", :rating => 1)
+          user2 = create_model(user_class, :name => "Fred", :rating => 2)
+          user3 = create_model(user_class, :name => "Betty", :rating => 3)
+          user_adapter.find_all(:limit => 3, :offset => 0, :order => [:rating, :asc]).should == [user1, user2, user3]
+          user_adapter.find_all(:limit => 3, :offset => 1, :order => [:rating, :asc]).should == [user2, user3]
+          user_adapter.find_all(:limit => 1, :offset => 1, :order => [:rating, :asc]).should == [user2]
+        end
+      end
+    end
+
+    describe "#create!(attributes)" do
+      it "should create a model with the passed attributes" do
+        user = user_adapter.create!(:name => "Fred")
+        reload_model(user).name.should == "Fred"
+      end
+
+      it "should raise error when create fails" do
+        lambda { user_adapter.create!(:user => create_model(note_class)) }.should raise_error
+      end
+
+      it "when attributes contain an associated object, should create a model with the attributes" do
+        user = create_model(user_class)
+        note = note_adapter.create!(:owner => user)
+        reload_model(note).owner.should == user
+      end
+
+      it "when attributes contain an has_many assoc, should create a model with the attributes" do
+        notes = [create_model(note_class), create_model(note_class)]
+        user = user_adapter.create!(:notes => notes)
+        reload_model(user).notes.should == notes
+      end
+    end
+
+    describe "#destroy(instance)" do
+      it "should destroy the instance if it exists" do
+        user = create_model(user_class)
+        (!!user_adapter.destroy(user)).should == true  # make it work with both RSpec 2.x and 3.x
+        user_adapter.get(user.id).should be_nil
+      end
+
+      it "should return nil if passed with an invalid instance" do
+        user_adapter.destroy("nonexistent instance").should be_nil
+      end
+
+      it "should not destroy the instance if it doesn't match the model class" do
+        user = create_model(user_class)
+        note_adapter.destroy(user).should be_nil
+        user_adapter.get(user.id).should == user
+      end
+    end
+  end
+end

data/spec/models.rb

@@ -0,0 +1,12 @@
+class User
+  include NoBrainer::Document
+  field :name
+  field :rating
+  has_many :notes, foreign_key: :owner_id
+end
+
+class Note
+  include NoBrainer::Document
+  field :body, default: 'made by orm'
+  belongs_to :owner, foreign_key: :owner_id, class_name: 'User'
+end

data/spec/no_brainer_spec.rb

@@ -0,0 +1,20 @@
+require 'models'
+require 'example_app_shared'
+
+NoBrainer.configure do |config|
+  config.rethinkdb_url = 'rethinkdb://localhost/orm_adapter_spec'
+  # We don't care about this data. We do care about speed.
+  config.durability = :soft
+end
+
+describe NoBrainer::Document::OrmAdapter do
+  before do
+    User.destroy_all
+    Note.destroy_all
+  end
+  
+  it_should_behave_like "example app with orm_adapter" do
+    let(:user_class) { User }
+    let(:note_class) { Note }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+
+require 'rspec'
+require 'nobrainer'
+require 'orm_adapter'
+require 'orm_adapter-nobrainer'

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: orm_adapter-nobrainer
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- Colin Mattson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: rethinkdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: nobrainer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.0
+description: 
+email:
+- colinmattson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/orm_adapter-nobrainer.rb
+- lib/orm_adapter-nobrainer/nobrainer.rb
+- lib/orm_adapter-nobrainer/version.rb
+- orm_adapter-nobrainer.gemspec
+- spec/example_app_shared.rb
+- spec/models.rb
+- spec/no_brainer_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/cmattson/orm_adapter-nobrainer
+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.4.1
+signing_key: 
+specification_version: 4
+summary: NoBrainer support for orm_adapter
+test_files:
+- spec/example_app_shared.rb
+- spec/models.rb
+- spec/no_brainer_spec.rb
+- spec/spec_helper.rb
+has_rdoc: