dynamoid 0.0.3 → 0.0.4

data/Dynamoid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "dynamoid"
-  s.version = "0.0.3"
+  s.version = "0.0.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Symonds"]
-  s.date = "2012-02-26"
+  s.date = "2012-02-27"
   s.description = "Dynamoid is an ORM for Amazon's DynamoDB that supports offline development, associations, querying, and everything else you'd expect from an ActiveRecord-style replacement."
   s.email = "josh@joshsymonds.com"
   s.extra_rdoc_files = [
@@ -40,6 +40,8 @@ Gem::Specification.new do |s|
     "lib/dynamoid/components.rb",
     "lib/dynamoid/config.rb",
     "lib/dynamoid/config/options.rb",
+    "lib/dynamoid/criteria.rb",
+    "lib/dynamoid/criteria/chain.rb",
     "lib/dynamoid/document.rb",
     "lib/dynamoid/errors.rb",
     "lib/dynamoid/fields.rb",
@@ -63,6 +65,8 @@ Gem::Specification.new do |s|
     "spec/dynamoid/associations_spec.rb",
     "spec/dynamoid/attributes_spec.rb",
     "spec/dynamoid/config_spec.rb",
+    "spec/dynamoid/criteria/chain_spec.rb",
+    "spec/dynamoid/criteria_spec.rb",
     "spec/dynamoid/document_spec.rb",
     "spec/dynamoid/fields_spec.rb",
     "spec/dynamoid/finders_spec.rb",

data/README.markdown

@@ -4,7 +4,7 @@ Dynamoid is an ORM for Amazon's DynamoDB for Ruby applications. It provides simi
 
 ## Warning!
 
-I'm still working on this gem a lot. You can only use the old-school ActiveRecord style finders like ```find_all_by_<attribute_name>``` or directly finding by an ID.
+I'm still working on this gem a lot. It only provides .where(arguments) in its criteria chaining so far. More is coming though!
 
 ## Installation
 
@@ -14,11 +14,11 @@ Installing Dynamoid is pretty simple. First include the Gem in your Gemfile:
 gem 'dynamoid'
 ```
 
-Then you need to initialize it to get it going, so put code similar to this somewhere (a Rails initializer would be a great place for this if you're using Rails):
+Then you need to initialize it to get it going. Put code similar to this somewhere (a Rails initializer would be a great place for this if you're using Rails):
 
 ```ruby
   Dynamoid.configure do |config|
-    config.adapter = 'local' # This adapter allows offline development without connecting to the DynamoDB servers.
+    config.adapter = 'local' # This adapter allows offline development without connecting to the DynamoDB servers. Data is NOT persisted.
     # config.adapter = 'aws_sdk' # This adapter establishes a connection to the DynamoDB servers using's Amazon's own awful AWS gem.
     # config.access_key = 'access_key' # If connecting to DynamoDB, your access key is required.
     # config.secret_key = 'secret_key' # So is your secret key. 
@@ -52,25 +52,37 @@ class User
 end
 ```
 
-### Usage
+## Usage
 
-Right now, you can only do a couple things with this amazing functionality:
+Dynamoid's syntax is very similar to ActiveRecord's.
 
 ```ruby
 u = User.new(:name => 'Josh')
 u.email = 'josh@joshsymonds.com'
 u.save
+```
+
+Save forces persistence to the datastore: a unique ID is also assigned, but it is a string and not an auto-incrementing number.
+
+```ruby
+u.id # => "3a9f7216-4726-4aea-9fbc-8554ae9292cb"
+```
+
+Along with persisting the model's attributes, indexes are automatically updated on save. To use associations, you use association methods very similar to ActiveRecord's:
 
+```ruby
 address = u.addresses.create
 address.city = 'Chicago'
 address.save
-
-u == User.find(u.id)
-u == User.find_by_name('Josh')
-u.addresses == User.find_by_name_and_email('Josh','josh@joshsymonds.com').addresses
 ```
 
-Not super exciting yet, true... but it's getting there!
+Querying can be done in one of three ways:
+
+```ruby
+Address.find(address.id)              # Find directly by ID.
+Address.where(:city => 'Chicago').all # Find by any number of matching criteria... though presently only "where" is supported.
+Address.find_by_city('Chicago')       # The same as above, but using ActiveRecord's older syntax.
+```
 
 ## Credits
 

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/lib/dynamoid.rb

@@ -14,6 +14,7 @@ require 'dynamoid/fields'
 require 'dynamoid/indexes'
 require 'dynamoid/associations'
 require 'dynamoid/persistence'
+require 'dynamoid/criteria'
 require 'dynamoid/finders'
 require 'dynamoid/config'
 require 'dynamoid/components'

data/lib/dynamoid/adapter/aws_sdk.rb

@@ -85,9 +85,8 @@ module Dynamoid
         table = @@connection.tables[table_name]
         table.load_schema
         results = []
-        table.items.select do |data|
-          attributes = data.attributes.symbolize_keys!
-          results << attributes if scan_hash.all?{|k, v| !attributes[k].nil? && attributes[k] == v}
+        table.items.where(scan_hash).select do |data|
+          results << data.attributes.symbolize_keys!
         end
         results
       end

data/lib/dynamoid/components.rb

@@ -21,5 +21,6 @@ module Dynamoid #:nodoc
     include Dynamoid::Persistence
     include Dynamoid::Finders
     include Dynamoid::Associations
+    include Dynamoid::Criteria
   end
 end

data/lib/dynamoid/criteria.rb

@@ -0,0 +1,20 @@
+require 'dynamoid/criteria/chain'
+
+# encoding: utf-8
+module Dynamoid #:nodoc:
+
+  # This module defines criteria and criteria chains.
+  module Criteria
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      [:where, :all, :first, :each].each do |meth|
+        define_method(meth) do |opts|
+          chain = Dynamoid::Criteria::Chain.new(self)
+          chain.send(meth, opts)
+        end
+      end
+    end
+  end
+  
+end

data/lib/dynamoid/criteria/chain.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+module Dynamoid #:nodoc:
+  module Criteria
+
+    # The class object that gets passed around indicating state of a building query.
+    # Also provides query execution.
+    class Chain
+      attr_accessor :query, :source, :index, :values
+      include Enumerable
+      
+      def initialize(source)
+        @query = {}
+        @source = source
+      end
+      
+      def where(args)
+        args.each {|k, v| query[k] = v}
+        self
+      end
+      
+      def all
+        records
+      end
+      
+      def first
+        records.first
+      end
+      
+      def each(&block)
+        records.each(&block)
+      end
+      
+      private
+      
+      def records
+        return records_with_index unless index.empty?
+        records_without_index
+      end
+      
+      def records_with_index
+        ids = Dynamoid::Adapter.get_item(source.index_table_name(index), source.key_for_index(index, values_for_index))
+        if ids.nil? || ids.empty?
+          []
+        else
+          Array(source.find(ids[:ids].to_a))
+        end
+      end
+      
+      def records_without_index
+        if Dynamoid::Config.warn_on_scan
+          Dynamoid.logger.warn 'Queries without an index are forced to use scan and are generally much slower than indexed queries!'
+          Dynamoid.logger.warn "You can index this query by adding this to #{self.to_s.downcase}.rb: index [#{attributes.sort.collect{|attr| ":#{attr}"}.join(', ')}]"
+        end
+        Dynamoid::Adapter.scan(source.table_name, query).collect {|hash| source.new(hash)}
+      end
+      
+      def values_for_index
+        [].tap {|arr| index.each{|i| arr << query[i]}}
+      end
+      
+      def index
+        Array(source.indexes.find {|i| i == query.keys.sort.collect(&:to_sym)})
+      end
+    end
+    
+  end
+  
+end

data/lib/dynamoid/document.rb

@@ -8,6 +8,8 @@ module Dynamoid #:nodoc:
     include Dynamoid::Components
 
     attr_accessor :new_record
+    alias :persisted? :new_record 
+    alias :new_record? :new_record
     
     def initialize(attrs = {})
       @new_record = true

data/lib/dynamoid/finders.rb

@@ -31,29 +31,17 @@ module Dynamoid #:nodoc:
         if method =~ /find/
           finder = method.to_s.split('_by_').first
           attributes = method.to_s.split('_by_').last.split('_and_')
-          
-          results = if index = self.indexes.find {|i| i == attributes.sort.collect(&:to_sym)}
-            ids = Dynamoid::Adapter.get_item(self.index_table_name(index), self.key_for_index(index, args))
-            if ids.nil? || ids.empty?
-              []
-            else
-              self.find(ids[:ids].to_a)
-            end
-          else
-            if Dynamoid::Config.warn_on_scan
-              Dynamoid.logger.warn 'Queries without an index are forced to use scan and are generally much slower than indexed queries!'
-              Dynamoid.logger.warn "You can index this query by adding this to #{self.to_s.downcase}.rb: index [#{attributes.sort.collect{|attr| ":#{attr}"}.join(', ')}]"
-            end
-            scan_hash = {}
-            attributes.each_with_index {|attr, index| scan_hash[attr.to_sym] = args[index]}
-            Dynamoid::Adapter.scan(self.table_name, scan_hash).collect {|hash| self.new(hash)}
-          end
+
+          chain = Dynamoid::Criteria::Chain.new(self)
+          chain.query = Hash.new.tap {|h| attributes.each_with_index {|attr, index| h[attr.to_sym] = args[index]}}
           
           if finder =~ /all/
-            return Array(results)
+            return chain.all
           else
-            return results.first
+            return chain.first
           end
+        else
+          super
         end
       end
     end

data/spec/dynamoid/adapter/aws_sdk_spec.rb

@@ -111,6 +111,14 @@ describe Dynamoid::Adapter::AwsSdk do
         Dynamoid::Adapter.scan('dynamoid_tests_TestTable1', :name => 'Josh').should == [{:name=>"Josh", :id=>"2"}, {:name=>"Josh", :id=>"1"}] 
       end
       
+      it 'performs scan on a table and returns all items if no criteria are specified' do
+        Dynamoid::Adapter.put_item('dynamoid_tests_TestTable1', {:id => '1', :name => 'Josh'})
+        Dynamoid::Adapter.put_item('dynamoid_tests_TestTable1', {:id => '2', :name => 'Josh'})
+
+        Dynamoid::Adapter.scan('dynamoid_tests_TestTable1', {}).should == [{:name=>"Josh", :id=>"2"}, {:name=>"Josh", :id=>"1"}] 
+      end
+      
+      
     end
     
     # DescribeTable

data/spec/dynamoid/adapter/local_spec.rb

@@ -135,6 +135,14 @@ describe Dynamoid::Adapter::Local do
     
       Dynamoid::Adapter.scan('Test Table', :name => 'Josh').should == [{ :id=> '1', :name=>"Josh" }, { :id=> '2', :name=>"Josh" }]
     end
+    
+    it 'performs scan on a table and returns all items if no criteria are specified' do
+      Dynamoid::Adapter.create_table('Test Table', :id)
+      Dynamoid::Adapter.put_item('Test Table', {:id => '1', :name => 'Josh'})
+      Dynamoid::Adapter.put_item('Test Table', {:id => '2', :name => 'Josh'})
+    
+      Dynamoid::Adapter.scan('Test Table', {}).should == [{ :id=> '1', :name=>"Josh" }, { :id=> '2', :name=>"Josh" }]
+    end
   
     # UpdateItem
   

data/spec/dynamoid/criteria/chain_spec.rb

@@ -0,0 +1,66 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe "Dynamoid::Associations::Chain" do
+
+  before(:each) do
+    @user = User.create(:name => 'Josh', :email => 'josh@joshsymonds.com', :password => 'Test123')
+    @chain = Dynamoid::Criteria::Chain.new(User)
+  end
+  
+  it 'finds matching index for a query' do
+    @chain.query = {:name => 'Josh'}
+    @chain.send(:index).should == [:name]
+    
+    @chain.query = {:email => 'josh@joshsymonds.com'}
+    @chain.send(:index).should == [:email]
+    
+    @chain.query = {:name => 'Josh', :email => 'josh@joshsymonds.com'}
+    @chain.send(:index).should == [:email, :name]
+  end
+  
+  it 'does not find an index if there is not an appropriate one' do
+    @chain.query = {:password => 'Test123'}
+    @chain.send(:index).should == []
+  end
+  
+  it 'returns values for index for a query' do
+    @chain.query = {:name => 'Josh'}
+    @chain.send(:values_for_index).should == ['Josh']
+    
+    @chain.query = {:email => 'josh@joshsymonds.com'}
+    @chain.send(:values_for_index).should == ['josh@joshsymonds.com']
+    
+    @chain.query = {:name => 'Josh', :email => 'josh@joshsymonds.com'}
+    @chain.send(:values_for_index).should == ['josh@joshsymonds.com', 'Josh']
+  end
+  
+  it 'finds records with an index' do
+    @chain.query = {:name => 'Josh'}
+    @chain.send(:records_with_index).should == [@user]
+    
+    @chain.query = {:email => 'josh@joshsymonds.com'}
+    @chain.send(:records_with_index).should == [@user]
+    
+    @chain.query = {:name => 'Josh', :email => 'josh@joshsymonds.com'}
+    @chain.send(:records_with_index).should == [@user]
+  end
+  
+  it 'finds records without an index' do
+    @chain.query = {:password => 'Test123'}
+    @chain.send(:records_without_index).should == [@user]
+  end
+  
+  it 'defines each' do
+    @chain.query = {:name => 'Josh'}
+    @chain.each {|u| u.update_attribute(:name, 'Justin')}
+    
+    User.find(@user.id).name.should == 'Justin'
+  end
+  
+  it 'includes Enumerable' do
+    @chain.query = {:name => 'Josh'}
+    
+    @chain.collect {|u| u.name}.should == ['Josh']
+  end
+  
+end

data/spec/dynamoid/criteria_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Dynamoid::Criteria" do
+  
+  before do
+    @user1 = User.create(:name => 'Josh', :email => 'josh@joshsymonds.com')
+    @user2 = User.create(:name => 'Justin', :email => 'justin@joshsymonds.com')
+  end
+  
+  it 'finds first using where' do
+    User.where(:name => 'Josh').first.should == @user1
+  end
+  
+  it 'finds all using where' do
+    User.where(:name => 'Josh').all.should == [@user1]
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dynamoid
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-26 00:00:00.000000000 Z
+date: 2012-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70135836907680 !ruby/object:Gem::Requirement
+  requirement: &70219190581820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70135836907680
+  version_requirements: *70219190581820
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70135836906980 !ruby/object:Gem::Requirement
+  requirement: &70219190581300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70135836906980
+  version_requirements: *70219190581300
 - !ruby/object:Gem::Dependency
   name: aws-sdk
-  requirement: &70135836906300 !ruby/object:Gem::Requirement
+  requirement: &70219190580760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70135836906300
+  version_requirements: *70219190580760
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70135836905060 !ruby/object:Gem::Requirement
+  requirement: &70219190580120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70135836905060
+  version_requirements: *70219190580120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70135836904480 !ruby/object:Gem::Requirement
+  requirement: &70219190579300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70135836904480
+  version_requirements: *70219190579300
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70135836903920 !ruby/object:Gem::Requirement
+  requirement: &70219190640280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70135836903920
+  version_requirements: *70219190640280
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70135836072500 !ruby/object:Gem::Requirement
+  requirement: &70219190639520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70135836072500
+  version_requirements: *70219190639520
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70135836071700 !ruby/object:Gem::Requirement
+  requirement: &70219190638920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70135836071700
+  version_requirements: *70219190638920
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70135836071100 !ruby/object:Gem::Requirement
+  requirement: &70219190637920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70135836071100
+  version_requirements: *70219190637920
 description: Dynamoid is an ORM for Amazon's DynamoDB that supports offline development,
   associations, querying, and everything else you'd expect from an ActiveRecord-style
   replacement.
@@ -143,6 +143,8 @@ files:
 - lib/dynamoid/components.rb
 - lib/dynamoid/config.rb
 - lib/dynamoid/config/options.rb
+- lib/dynamoid/criteria.rb
+- lib/dynamoid/criteria/chain.rb
 - lib/dynamoid/document.rb
 - lib/dynamoid/errors.rb
 - lib/dynamoid/fields.rb
@@ -166,6 +168,8 @@ files:
 - spec/dynamoid/associations_spec.rb
 - spec/dynamoid/attributes_spec.rb
 - spec/dynamoid/config_spec.rb
+- spec/dynamoid/criteria/chain_spec.rb
+- spec/dynamoid/criteria_spec.rb
 - spec/dynamoid/document_spec.rb
 - spec/dynamoid/fields_spec.rb
 - spec/dynamoid/finders_spec.rb
@@ -189,7 +193,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1286880132188396224
+      hash: -353023235406473694
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: