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

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Winfield
+
+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,36 @@
+# ORM Adapter for couchrest_model
+
+Add couchrest_model support to [orm_adapter](https://github.com/ianwhite/orm_adapter)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'orm_adapter_couchrest_model'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orm_adapter_couchrest_model
+
+## Usage
+
+Please refer to [orm_adapter](https://github.com/ianwhite/orm_adapter)'s README
+
+## Run Tests
+
+You need CouchDB running at localhost to run the tests
+
+Default test db is http://locahost:5984/orm_adapter_spec without admin
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. add test to verify it
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

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

data/lib/orm_adapter_couchrest_model.rb

@@ -0,0 +1,7 @@
+require "orm_adapter"
+require "orm_adapter_couchrest_model/version"
+require "orm_adapter_couchrest_model/couchrest_model" if defined?(CouchRest::Model::Base)
+
+module OrmAdapterCouchrestModel
+  # Your code goes here...
+end

data/lib/orm_adapter_couchrest_model/couchrest_model.rb

@@ -0,0 +1,55 @@
+require 'couchrest_model'
+
+module CouchRest
+  module Model
+    class Base
+      extend OrmAdapter::ToAdapter
+
+      class OrmAdapter < ::OrmAdapter::Base
+        def column_names
+          klass.properties
+        end
+
+        def get!(id)
+          klass.get!(wrap_key(id))
+        end
+
+        def get(id)
+          klass.get(wrap_key(id))
+        end
+
+        def find_first(options = {})
+          conditions, order, limit, offset = extract_conditions!(options)
+          if conditions.empty?
+            klass.first
+          elsif conditions.keys.first == :id
+            klass.get(conditions.values.first)
+          else
+            view = klass.send("by_#{conditions.keys.first}")
+            view.key(conditions.values.first).limit(1).first
+          end
+        end
+
+        def find_all(options = {})
+          conditions, order, limit, offset = extract_conditions!(options)
+          if conditions.empty?
+            klass.all(:limit => limit, :skip => offset).all
+          elsif conditions.keys.first == :id
+            klass.get(conditions.values.first)
+          else
+            view = klass.send("by_#{conditions.keys.first}")
+            view.key(conditions.values.first).limit(limit).skip(offset).all
+          end
+        end
+
+        def create!(attributes = {})
+          klass.create!(attributes)
+        end
+
+        def destroy(object)
+          object.destroy if valid_object?(object)
+        end
+      end
+    end
+  end
+end

data/lib/orm_adapter_couchrest_model/version.rb

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

data/orm_adapter_couchrest_model.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/orm_adapter_couchrest_model/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "orm_adapter_couchrest_model"
+  gem.version       = OrmAdapterCouchrestModel::VERSION
+  gem.authors       = ["lainuo"]
+  gem.email         = ["winfield301@gmail.com"]
+  gem.description   = %q{ORM adapter for couchrest_model}
+  gem.summary       = %q{ORM adapter for couchrest_model}
+  gem.homepage      = "https://github.com/winfield/orm_adapter_couchrest_model"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.rubyforge_project = "orm_adapter_couchrest_model"
+
+  gem.add_dependency "activemodel", ">= 3.0.0"
+  gem.add_dependency "orm_adapter"
+  gem.add_dependency "couchrest_model", "2.0.0.beta2"
+
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rake", ">= 0.8.7"
+  gem.add_development_dependency "rspec", ">= 2.4.0"
+end

data/spec/couchrest_model_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'example_app_shared'
+
+if !defined?(CouchRest::Model)
+  puts "** require 'couchrest_model' to run the specs in #{__FILE__}"
+else
+
+  module CouchrestModelOrmSpec
+    class User < CouchRest::Model::Base
+      use_database CouchRest.database!("http://127.0.0.1:5984/orm_adapter_spec")
+
+      property :name
+      design do
+        view :by_name
+      end
+    end
+
+    class Note < CouchRest::Model::Base
+      use_database CouchRest.database!("http://127.0.0.1:5984/orm_adapter_spec")
+
+      property :body
+      design do
+        view :by_body
+      end
+    end
+
+    # here be the specs!
+    describe CouchRest::Model::Base::OrmAdapter do
+      let(:default_database) { CouchRest.database!("http://127.0.0.1:5984/orm_adapter_spec") }
+
+      before do
+        default_database.recreate!
+      end
+
+      it_should_behave_like "example app with orm_adapter" do
+        let(:user_class) { User }
+        let(:note_class) { Note }
+      end
+    end
+  end
+end

data/spec/example_app_shared.rb

@@ -0,0 +1,272 @@
+# 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 "execute 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
+
+        # CouchDB generate random UUID, and find first by UUID,
+        # so this is meaningless
+        #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
+
+        # associations are not supported
+        #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
+          # CouchDB can only accept one condition, since it can only
+          # accept on view(query), so this will return `user`
+          user_adapter.find_first(:id => user.id, :name => "Not Fred").should == user
+        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")
+          # CouchDB generate random UUID, and find first by UUID,
+          # so we cannot rely on it's sequence
+          # user_adapter.find_all(:name => "Fred").should == [user1, user2]
+          result = user_adapter.find_all(:name => "Fred")
+          result.count.should == 2
+          result.should include(user1)
+          result.should include(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")
+          # CouchDB generate random UUID, and find first by UUID,
+          # so we cannot rely on it's sequence
+          # user_adapter.find_all.should == [user1, user2, user3]
+          result = user_adapter.find_all
+          result.count.should == 3
+          result.should include(user1)
+          result.should include(user2)
+          result.should include(user3)
+        end
+
+        it "should return empty array if no conditions match" do
+          user_adapter.find_all(:name => "Fred").should == []
+        end
+
+        # associations are not supported
+        #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 => 1)
+          # CouchDB generate random UUID, and find first by UUID,
+          # so we cannot rely on it's sequence
+          #user_adapter.find_all(:limit => 1).should == [user1]
+          #user_adapter.find_all(:limit => 2).should == [user1, user2]
+          user_adapter.find_all(:limit => 1).count.should == 1
+          user_adapter.find_all(:limit => 2).count.should == 2
+        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 => 1)
+          # CouchDB generate random UUID, and find first by UUID,
+          # so we cannot rely on it's sequence
+          # user_adapter.find_all(:limit => 3, :offset => 0).should == [user1, user2, user3]
+          # user_adapter.find_all(:limit => 3, :offset => 1).should == [user2, user3]
+          # user_adapter.find_all(:limit => 1, :offset => 1).should == [user2]
+          user_adapter.find_all(:limit => 3, :offset => 0).count.should == 3
+          user_adapter.find_all(:limit => 3, :offset => 1).count.should == 2
+          user_adapter.find_all(:limit => 1, :offset => 1).count.should == 1
+        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
+
+      # couchrest_model will not raise error when attributes
+      # do not match properties
+      #it "should raise error when create fails" do
+      #  lambda { user_adapter.create!(:user => create_model(note_class)) }.should raise_error
+      #end
+
+      # associations are not supported
+      #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
+
+      # associations are not supported
+      #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
+        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/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'couchrest_model'
+require 'orm_adapter'
+require 'orm_adapter_couchrest_model'
+
+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
+
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: orm_adapter_couchrest_model
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- lainuo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: orm_adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: couchrest_model
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+description: ORM adapter for couchrest_model
+email:
+- winfield301@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/orm_adapter_couchrest_model.rb
+- lib/orm_adapter_couchrest_model/couchrest_model.rb
+- lib/orm_adapter_couchrest_model/version.rb
+- orm_adapter_couchrest_model.gemspec
+- spec/couchrest_model_spec.rb
+- spec/example_app_shared.rb
+- spec/spec_helper.rb
+homepage: https://github.com/winfield/orm_adapter_couchrest_model
+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: 3466702076077206945
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3466702076077206945
+requirements: []
+rubyforge_project: orm_adapter_couchrest_model
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ORM adapter for couchrest_model
+test_files:
+- spec/couchrest_model_spec.rb
+- spec/example_app_shared.rb
+- spec/spec_helper.rb