orm_adapter-dynamoid 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 arukoh
+
+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,29 @@
+# OrmAdapter::Dynamoid
+
+Adds [dynamoid](https://github.com/Veraticus/Dynamoid) adapter to [orm_adapter](https://github.com/ianwhite/orm_adapter/) which provides a single point of entry for using basic features of popular ruby ORMs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'orm_adapter-dynamoid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install orm_adapter-dynamoid
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+$:.push File.expand_path("../lib", __FILE__)
+
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require "orm_adapter/version"
+
+task :default => :spec
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/orm_adapter-dynamoid.rb

@@ -0,0 +1,9 @@
+require 'orm_adapter'
+require "orm_adapter-dynamoid/version"
+require 'orm_adapter-dynamoid/dynamoid' if defined?(Dynamoid::Document)
+
+module OrmAdapter
+  module Dynamoid
+    # Your code goes here...
+  end
+end

data/lib/orm_adapter-dynamoid/dynamoid.rb

@@ -0,0 +1,73 @@
+require 'dynamoid'
+
+module Dynamoid
+  module Errors
+    class DocumentNotFound < StandardError; end
+  end
+end
+
+module Dynamoid
+  module Document
+    module ClassMethods
+      include OrmAdapter::ToAdapter
+    end
+
+    class OrmAdapter < ::OrmAdapter::Base
+      # get a list of column names for a given class
+      def column_names
+        klass.attributes.keys
+      end
+
+      # @see OrmAdapter::Base#get!
+      def get!(id)
+        klass.find_by_id(wrap_key(id)) || raise(Dynamoid::Document::DocumentNotFound)
+      end
+
+      # @see OrmAdapter::Base#get
+      def get(id)
+        klass.where(klass.hash_key => wrap_key(id)).first
+      end
+
+      # @see OrmAdapter::Base#find_first
+      def find_first(options = {})
+        conditions, order = extract_conditions!(options)
+#        klass.limit(1).where(conditions_to_fields(conditions)).order_by(order).first
+        klass.where(conditions_to_fields(conditions)).limit(1).first
+      end
+
+      # @see OrmAdapter::Base#find_all
+      def find_all(options = {})
+        conditions, order, limit, offset = extract_conditions!(options)
+#        klass.where(conditions_to_fields(conditions)).order_by(order).limit(limit).offset(offset)
+        klass.where(conditions_to_fields(conditions)).limit(limit)
+      end
+
+      # @see OrmAdapter::Base#create!
+      def create!(attributes = {})
+        klass.create!(attributes)
+      end
+
+      # @see OrmAdapter::Base#destroy
+      def destroy(object)
+        object.destroy if valid_object?(object)
+      end
+
+    protected
+
+      def conditions_to_fields(conditions)
+        conditions.inject({}) do |fields, (key, value)|
+          if value.is_a?(Dynamoid::Document) && assoc_key = association_key(key)
+            fields.merge(assoc_key => Set[value.id])
+          else
+            fields.merge(key => value)
+          end
+        end
+      end
+
+      def association_key(key)
+        k = "#{key}_ids"
+        column_names.find{|c| c == k || c == k.to_sym}
+      end
+    end
+  end
+end

data/lib/orm_adapter-dynamoid/version.rb

@@ -0,0 +1,5 @@
+module OrmAdapter
+  module Dynamoid
+    VERSION = "0.0.1"
+  end
+end

data/orm_adapter-dynamoid.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/orm_adapter-dynamoid/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = "arukoh"
+  gem.email         = "arukoh10@gmail.com"
+  gem.description   = "Adds dynamoid (https://github.com/Veraticus/Dynamoid) adapter to orm_adapter (https://github.com/ianwhite/orm_adapter/) which provides a single point of entry for using basic features of popular ruby ORMs."
+  gem.summary       = "Adds dynamoid ORM adapter to the orm_adapter project"
+  gem.homepage      = "https://github.com/arukoh/orm_adapter-dynamoid"
+
+  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.name          = "orm_adapter-dynamoid"
+  gem.require_paths = ["lib"]
+  gem.version       = OrmAdapter::Dynamoid::VERSION
+  
+  gem.add_dependency "orm_adapter"
+  gem.add_dependency "dynamoid", ">= 0.4.1"
+
+  gem.add_development_dependency "rake", ">= 0.8.7"
+  gem.add_development_dependency "rspec", ">= 2.4.0"
+end

data/spec/dynamoid_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'example_app_shared'
+require 'models'
+
+if !defined?(Dynamoid)
+  puts "** require 'dynamoid' to run the specs in #{__FILE__}"
+  exit 1
+end
+  
+Dynamoid.configure do |config|
+  config.adapter   = 'local'
+  config.namespace = "orm_adapter-dynamoid_test"
+  config.logger    = Logger.new($stdout)
+  config.logger.level = Logger::ERROR
+end
+
+module DynamoidOrmSpec
+  # here be the specs!
+  describe Dynamoid::Document::OrmAdapter do
+    before do
+#      User.each{|u| u.destroy}
+#      Note.each{|n| n.destroy}
+      Dynamoid::Adapter.create_table(User.table_name, User.hash_key, :range_key => User.range_key)
+      Dynamoid::Adapter.create_table(Note.table_name, Note.hash_key, :range_key => Note.range_key)
+    end
+  
+    it_should_behave_like "example app with orm_adapter" do
+      let(:user_class) { User }
+      let(:note_class) { Note }
+    end
+  end
+end

data/spec/example_app_shared.rb

@@ -0,0 +1,240 @@
+# 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
+
+        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").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.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 => 1)
+          user_adapter.find_all(:limit => 1).should == [user1]
+          user_adapter.find_all(:limit => 2).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 => 1)
+#          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]
+#        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 == user
+        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 Dynamoid::Document
+  field :name
+  field :rating
+  has_many :notes
+end
+
+class Note
+  include Dynamoid::Document
+  field :body, :default => "made by orm"
+  belongs_to :owner, :class => User
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+require 'rubygems'
+require 'rspec'
+require 'dynamoid'
+require 'orm_adapter'
+require 'orm_adapter-dynamoid'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: orm_adapter-dynamoid
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- arukoh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-30 00:00:00.000000000 Z
+dependencies:
+- !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: dynamoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !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: Adds dynamoid (https://github.com/Veraticus/Dynamoid) adapter to orm_adapter
+  (https://github.com/ianwhite/orm_adapter/) which provides a single point of entry
+  for using basic features of popular ruby ORMs.
+email: arukoh10@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/orm_adapter-dynamoid.rb
+- lib/orm_adapter-dynamoid/dynamoid.rb
+- lib/orm_adapter-dynamoid/version.rb
+- orm_adapter-dynamoid.gemspec
+- spec/dynamoid_spec.rb
+- spec/example_app_shared.rb
+- spec/models.rb
+- spec/spec_helper.rb
+homepage: https://github.com/arukoh/orm_adapter-dynamoid
+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: 559551681
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 559551681
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Adds dynamoid ORM adapter to the orm_adapter project
+test_files:
+- spec/dynamoid_spec.rb
+- spec/example_app_shared.rb
+- spec/models.rb
+- spec/spec_helper.rb