cequel 1.0.0.rc2 → 1.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4988b87b5a5a9fc843dcaaf3bdfb3a5842b20cc8
-  data.tar.gz: ce93eaeb725d23f31a22dc3f8e2e84fc4d9ec0e7
+  metadata.gz: 1ed6d7b1a7f6b34c7ebfb6421f5402b163f79ad2
+  data.tar.gz: 6e88f21a67e23480f71b2c391f20d21df851b490
 SHA512:
-  metadata.gz: b738d10a75bd0f977eeff27c119ccd9d7980c66e2e1bdf004ef74e980dc847514ea7083cd9432f28b4d1099a151c635a71f50cd1f1757d6a20c16c42074504a0
-  data.tar.gz: be8264f1142625d8755a149550f68a9c2dc66b93c7a6a562f0c893043dbaf859ab879632911c8b753b96cdd07ea025b2348f12a237e07bdc4c7cad27015093a8
+  metadata.gz: 53f2888d6b7fe8be5b36cb647e558be6b2ea4a8cffde531125f398a03bc922b19a90e5c02c6a92434a0ff9f7f7b40bd0339280b0d7e21f9daf2e7695a5647a8a
+  data.tar.gz: c92544762c93bab662602603d9d32810fd19f2010dd8754c955ac9ec674207104753453de508a0bf8fff346c4b6cd9d147d6b72230c38396ff9995fd098cd9fa

data/lib/cequel/record.rb

@@ -21,6 +21,7 @@ require 'cequel/record/mass_assignment'
 require 'cequel/record/callbacks'
 require 'cequel/record/validations'
 require 'cequel/record/dirty'
+require 'cequel/record/conversion'
 
 require 'cequel/record'
 
@@ -88,6 +89,7 @@ module Cequel
       include Validations
       include Dirty
       extend ActiveModel::Naming
+      include Conversion
       include ActiveModel::Serializers::JSON
       include ActiveModel::Serializers::Xml
     end

data/lib/cequel/record/association_collection.rb

@@ -2,7 +2,7 @@ module Cequel
   module Record
     #
     # Collection of records from a
-    # {Associations::ClassMethods#has_many has_many} associaiton. Encapsulates
+    # {Associations::ClassMethods#has_many has_many} association. Encapsulates
     # and behaves like a {RecordSet}, but unlike a normal RecordSet the loaded
     # records are held in memory after they are loaded.
     #
@@ -11,6 +11,7 @@ module Cequel
     #
     class AssociationCollection < DelegateClass(RecordSet)
       include Enumerable
+      extend Forwardable
 
       #
       # @yield [Record]
@@ -20,10 +21,84 @@ module Cequel
         target.each(&block)
       end
 
+      #
+      # (see RecordSet#find)
+      #
+      def find(*keys)
+        if block_given? then super
+        else record_set.find(*keys)
+        end
+      end
+
+      #
+      # (see RecordSet#select)
+      #
+      def select(*columns)
+        if block_given? then super
+        else record_set.select(*columns)
+        end
+      end
+
+      #
+      # (see RecordSet#first)
+      #
+      def first(*args)
+        if loaded? then super
+        else record_set.first(*args)
+        end
+      end
+
+      #
+      # @!method count
+      #   Get the count of child records stored in the database. This method
+      #   will always query Cassandra, even if the records are loaded in
+      #   memory.
+      #
+      #   @return [Integer] number of child records in the database
+      #   @see #size
+      #   @see #length
+      #
+      def_delegator :record_set, :count
+
+      #
+      # @!method length
+      #   The number of child instances in the in-memory collection. If the
+      #   records are not loaded in memory, they will be loaded and then
+      #   counted.
+      #
+      #   @return [Integer] length of the loaded record collection in memory
+      #   @see #size
+      #   @see #count
+      #
+      def_delegator :entries, :length
+
+      #
+      # Get the size of the child collection. If the records are loaded in
+      # memory from a previous operation, count the length of the array in
+      # memory. If the collection is unloaded, perform a `COUNT` query.
+      #
+      # @return [Integer] size of the child collection
+      # @see #length
+      # @see #count
+      #
+      def size
+        loaded? ? length : count
+      end
+
+      #
+      # @return [Boolean] true if this collection's records are loaded in
+      #   memory
+      #
+      def loaded?
+        !!@target
+      end
+
       private
 
+      alias_method :record_set, :__getobj__
+
       def target
-        @target ||= __getobj__.entries
+        @target ||= record_set.entries
       end
     end
   end

data/lib/cequel/record/conversion.rb

@@ -0,0 +1,15 @@
+module Cequel
+  module Record
+    #
+    # Provides support for ActiveModel::Conversions
+    #
+    module Conversion
+      extend ActiveSupport::Concern
+
+      included do
+        include ActiveModel::Conversion
+        alias_method :to_key, :key_values
+      end
+    end
+  end
+end

data/lib/cequel/record/lazy_record_collection.rb

@@ -67,6 +67,11 @@ module Cequel
         self
       end
 
+      # @private
+      def assert_fully_specified!
+        self
+      end
+
       private
 
       attr_reader :record_set

data/lib/cequel/record/persistence.rb

@@ -86,6 +86,7 @@ module Cequel
       def key_values
         key_attributes.values
       end
+      alias_method :to_key, :key_values
 
       #
       # Check if an unloaded record exists in the database

data/lib/cequel/record/record_set.rb

@@ -224,8 +224,7 @@ module Cequel
       #
       def at(*scoped_key_values)
         warn "`at` is deprecated. Use `[]` instead"
-        scoped_key_values
-          .reduce(self) { |record_set, key_value| record_set[key_value] }
+        traverse(*scoped_key_values)
       end
 
       #
@@ -314,6 +313,9 @@ module Cequel
       # Return a loaded Record or collection of loaded Records with the
       # specified primary key values
       #
+      # Multiple arguments are mapped onto unscoped key columns. To specify
+      # multiple values for a given key column, use an array.
+      #
       # @param scoped_key_values one or more values for the final primary key
       #   column
       # @return [Record] if a single key is specified, return the loaded
@@ -322,15 +324,31 @@ module Cequel
       #   collection of loaded records at those keys
       # @raise [RecordNotFound] if not all the keys correspond to records in
       #   the table
-      # @raise [ArgumentError] if not all primary key columns have been
-      #   specified
       #
-      # @note This should only be called when all but the last column in the
-      #   primary key is already specified in this record set
-      def find(*scoped_key_values)
-        (scoped_key_values.one? ?
-          self[scoped_key_values.first] :
-          values_at(*scoped_key_values)).load!
+      # @example One record with one-column primary key
+      #   # find the blog with subdomain 'cassandra'
+      #   Blog.find('cassandra')
+      #
+      # @example Multiple records with one-column primary key
+      #   # find the blogs with subdomain 'cassandra' and 'postgres'
+      #   Blog.find(['cassandra', 'postgres'])
+      #
+      # @example One record with two-column primary key
+      #   # find the post instance with blog subdomain 'cassandra' and
+      #   # permalink 'my-post'
+      #   Post.find('cassandra', 'my-post')
+      #
+      # @example Multiple records with two-column primary key
+      #   # find the post instances with blog subdomain cassandra and
+      #   # permalinks 'my-post' and 'my-new-post'
+      #   Post.find('cassandra', ['my-post', 'my-new-post']
+      #
+      def find(*keys)
+        return super if block_given?
+        keys = [keys] if almost_fully_specified? && keys.many?
+        records = traverse(*keys).assert_fully_specified!.load!
+        force_array = keys.any? { |value| value.is_a?(Array) }
+        force_array ? Array.wrap(records) : records
       end
 
       #
@@ -472,6 +490,8 @@ module Cequel
       def count
         data_set.count
       end
+      alias_method :length, :count
+      alias_method :size, :count
 
       #
       # Enumerate over the records in this record set
@@ -594,6 +614,13 @@ module Cequel
         end
       end
 
+      # @private
+      def assert_fully_specified!
+        raise ArgumentError,
+              "Missing key component(s) " \
+              "#{unscoped_key_names.join(', ')}"
+      end
+
       def_delegators :entries, :inspect
 
       # @private
@@ -635,6 +662,16 @@ module Cequel
         end
       end
 
+      def traverse(*keys)
+        keys.reduce(self) do |record_set, key_value|
+          if key_value.is_a?(Array)
+            record_set.values_at(*key_value)
+          else
+            record_set[key_value]
+          end
+        end
+      end
+
       def scoped_key_names
         scoped_key_columns.map { |column| column.name }
       end
@@ -671,6 +708,10 @@ module Cequel
         scoped_key_values.length == target_class.key_columns.length
       end
 
+      def almost_fully_specified?
+        scoped_key_values.length == target_class.key_columns.length - 1
+      end
+
       def partition_specified?
         scoped_key_values.length >= target_class.partition_key_columns.length
       end

data/lib/cequel/record/scoped.rb

@@ -49,6 +49,11 @@ module Cequel
         end
       end
 
+      # @private
+      def assert_fully_specified!
+        self
+      end
+
       private
 
       def initialize_new_record(*)

data/lib/cequel/version.rb

@@ -1,4 +1,4 @@
 module Cequel
   # The current version of the library
-  VERSION = '1.0.0.rc2'
+  VERSION = '1.0.0.rc3'
 end

data/spec/examples/record/associations_spec.rb

@@ -138,6 +138,57 @@ describe Cequel::Record::Associations do
       blog.posts(true).map(&:title).should == ['Post 1', 'Post 2']
     end
 
+    it 'should support #find with key' do
+      blog.posts.find(posts.first.id).should == posts.first
+    end
+
+    it 'should support #find with block' do
+      blog.posts.find { |post| post.title.include?('1') }.should == posts[1]
+    end
+
+    it 'should support #select with block' do
+      blog.posts.select { |post| !post.title.include?('2') }
+        .should == posts.first(2)
+    end
+
+    it 'should support #select with arguments' do
+      expect { blog.posts.select(:title).first.id }
+        .to raise_error(Cequel::Record::MissingAttributeError)
+    end
+
+    it 'should load #first directly from the database if unloaded' do
+      blog.posts.first.title
+      blog.posts.should_not be_loaded
+    end
+
+    it 'should read #first from loaded collection' do
+      blog.posts.entries
+      disallow_queries!
+      blog.posts.first.title.should == 'Post 0'
+    end
+
+    it 'should always query the database for #count' do
+      blog.posts.entries
+      posts.first.destroy
+      blog.posts.count.should == 2
+    end
+
+    it 'should always load the records for #length' do
+      blog.posts.length.should == 3
+      blog.posts.should be_loaded
+    end
+
+    it 'should count from database for #size if unloaded' do
+      blog.posts.size.should == 3
+      blog.posts.should_not be_loaded
+    end
+
+    it 'should count records in memory for #size if loaded' do
+      blog.posts.entries
+      disallow_queries!
+      blog.posts.size.should == 3
+    end
+
     it "does not allow invalid :dependent options" do
       expect {
         Post.class_eval do

data/spec/examples/record/persistence_spec.rb

@@ -27,6 +27,11 @@ describe Cequel::Record::Persistence do
       end.tap(&:save)
     end
 
+    describe 'new record' do
+      specify { Blog.new.should_not be_persisted }
+      specify { Blog.new.should be_transient }
+    end
+
     describe '#save' do
       context 'on create' do
         it 'should save row to database' do

data/spec/examples/record/record_set_spec.rb

@@ -129,11 +129,21 @@ describe Cequel::Record::RecordSet do
 
       it { should be_persisted }
       it { should_not be_transient }
-      specify { Blog.new.should_not be_persisted }
-      specify { Blog.new.should be_transient }
 
       it 'should cast argument to correct type' do
-        Blog.find('blog-0'.force_encoding('ASCII-8BIT')).should be
+        Blog.find('blog-0'.force_encoding('ASCII-8BIT')).should == blogs.first
+      end
+
+      it 'should return multiple results as an array from vararg keys' do
+        Blog.find('blog-0', 'blog-1').should == blogs.first(2)
+      end
+
+      it 'should return multiple results as an array from array of keys' do
+        Blog.find(['blog-0', 'blog-1']).should == blogs.first(2)
+      end
+
+      it 'should return result in an array from one-element array of keys' do
+        Blog.find(['blog-1']).should == [blogs[1]]
       end
 
       it 'should raise RecordNotFound if bad argument passed' do
@@ -164,6 +174,23 @@ describe Cequel::Record::RecordSet do
         expect { Post['cequel'].find('bogus')}.
           to raise_error(Cequel::Record::RecordNotFound)
       end
+
+      it 'should take vararg of values for single key' do
+        Post.find('cassandra', 'cequel0').should == posts.first
+      end
+
+      it 'should take multiple values for key' do
+        Post.find('cassandra', ['cequel0', 'cequel1']).should == posts.first(2)
+      end
+
+      it 'should use Enumerable#find if block given' do
+        Post['cassandra'].find { |post| post.title.include?('1') }
+          .should == posts[1]
+      end
+
+      it 'should raise error if not enough key values specified' do
+        expect { Post.find('cassandra') }.to raise_error(ArgumentError)
+      end
     end
   end
 
@@ -335,6 +362,9 @@ describe Cequel::Record::RecordSet do
     end
   end
 
+  describe '#find' do
+  end
+
   describe '#[]' do
     it 'should return partial collection' do
       Post['cassandra'].find_each(:batch_size => 2).map(&:title).

data/spec/support/helpers.rb

@@ -109,9 +109,6 @@ module Cequel
       def disallow_queries!
         cequel.should_not_receive(:execute)
       end
-
     end
-
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cequel
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc2
+  version: 1.0.0.rc3
 platform: ruby
 authors:
 - Mat Brown
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-01 00:00:00.000000000 Z
+date: 2014-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -176,6 +176,7 @@ files:
 - lib/cequel/record/callbacks.rb
 - lib/cequel/record/collection.rb
 - lib/cequel/record/configuration_generator.rb
+- lib/cequel/record/conversion.rb
 - lib/cequel/record/data_set_builder.rb
 - lib/cequel/record/dirty.rb
 - lib/cequel/record/errors.rb