cequel 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 32765637991b209fa0eda38cae999ce92e03d9de
-  data.tar.gz: 5b0f247d96c436fa9947d14162e91b648cc29929
+  metadata.gz: 8151f255eac647140677b154e3d786f1ed817a26
+  data.tar.gz: e7b3214a86a25d8c6d98aa68e9d5e4a992731ab8
 SHA512:
-  metadata.gz: 7739409b3a223c117e17673d769b04b8382de1638c40262e72a68527bf75b87fd66c850681401fd652f998e59ab272d430379d611da2069ac316e9c7a0eb00b0
-  data.tar.gz: 1dc7c4ff48b96d2b6f4716fce64faad2569580a73c54446499809eb2f8947c3bf304da5a4082ae8d14f65da331f0b9ba8266daee99dcadc783bc3b47130a4c58
+  metadata.gz: 95d754925f448719477b3981b89f9be29d23ed6209708bc8675ad839f08da3283c98fc3c9cbdca2afc9eaf62019c46ca7783b0ded8d7da7d446e3fed5a95c87e
+  data.tar.gz: 60dca007fbbb8c678eb5f5219c90824b1bc80e1411a16a246d14f664498c693902eed64aef349cda3762a095399feba39ed5ee703ac41810005bf869388b7ba8

data/Appraisals

@@ -4,12 +4,14 @@ end
 
 appraise "rails-3.2" do
   gem "activesupport", "~> 3.2.0"
+  gem "tzinfo", "~> 0.3"
 end
 
 appraise "rails-3.1" do
   gem "activesupport", "~> 3.1.0"
+  gem "tzinfo", "~> 0.3"
 end
 
 appraise "thrift" do
-  gem "cassandra-cql"
+  gem "cassandra-cql", "~> 1.2"
 end

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 1.2.0
+
+* `where` can now be used to scope primary keys
+* Magic finders for primary keys
+* Pessimistic versioning for all dependencies
+
 ## 1.1.2
 
 * Simplify logging implementation

data/Gemfile

@@ -3,11 +3,11 @@ source 'https://rubygems.org'
 gemspec
 
 group :debug do
-  gem 'debugger', :platforms => :mri_19
-  gem 'byebug', :platforms => [:mri_20, :mri_21]
-  gem 'pry'
+  gem 'debugger', '~> 1.6', :platforms => :mri_19
+  gem 'byebug', '~> 2.7', :platforms => [:mri_20, :mri_21]
+  gem 'pry', '~> 0.9'
 end
 
-gem 'racc', :platforms => :rbx
+gem 'racc', '~> 1.4', :platforms => :rbx
 gem 'rubysl', '~> 2.0', :platforms => :rbx
-gem 'psych', :platforms => :rbx
+gem 'psych', '~> 2.0', :platforms => :rbx

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    cequel (1.1.2)
-      activemodel (>= 3.1)
-      cql-rb
+    cequel (1.2.0)
+      activemodel (>= 3.1, < 5.0)
+      cql-rb (~> 1.2)
 
 GEM
   remote: https://rubygems.org/
@@ -17,14 +17,12 @@ GEM
       multi_json (~> 1.3)
       thread_safe (~> 0.1)
       tzinfo (~> 0.3.37)
-    addressable (2.3.5)
     appraisal (0.5.2)
       bundler
       rake
     ast (1.1.0)
-    atomic (1.1.15)
-    atomic (1.1.15-java)
-    backports (3.6.0)
+    atomic (1.1.16)
+    atomic (1.1.16-java)
     builder (3.1.4)
     byebug (2.7.0)
       columnize (~> 0.3)
@@ -39,40 +37,14 @@ GEM
     debugger-linecache (1.2.0)
     debugger-ruby_core_source (1.3.2)
     diff-lcs (1.2.5)
-    ethon (0.6.3)
-      ffi (>= 1.3.0)
-      mime-types (~> 1.18)
-    faraday (0.8.9)
-      multipart-post (~> 1.2.0)
-    faraday_middleware (0.9.0)
-      faraday (>= 0.7.4, < 0.9)
-    ffi (1.9.3)
     ffi (1.9.3-java)
     ffi2-generators (0.1.1)
-    gh (0.13.2)
-      addressable
-      backports
-      faraday (~> 0.8)
-      multi_json (~> 1.0)
-      net-http-persistent (>= 2.7)
-      net-http-pipeline
-    hashr (0.0.22)
-    highline (1.6.21)
     i18n (0.6.9)
     json (1.8.1)
     json (1.8.1-java)
-    launchy (2.4.2)
-      addressable (~> 2.3)
-    launchy (2.4.2-java)
-      addressable (~> 2.3)
-      spoon (~> 0.0.1)
     method_source (0.8.2)
-    mime-types (1.25.1)
     minitest (4.7.5)
-    multi_json (1.9.0)
-    multipart-post (1.2.0)
-    net-http-persistent (2.9.4)
-    net-http-pipeline (1.0.1)
+    multi_json (1.9.2)
     parser (2.1.7)
       ast (~> 1.1)
       slop (~> 3.4, >= 3.4.5)
@@ -87,8 +59,6 @@ GEM
       slop (~> 3.4)
       spoon (~> 0.0)
     psych (2.0.4)
-    pusher-client (0.4.0)
-      websocket (~> 1.0.0)
     racc (1.4.11)
     rainbow (2.0.0)
     rake (10.1.1)
@@ -100,7 +70,7 @@ GEM
     rspec-expectations (2.14.5)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.6)
-    rubocop (0.19.0)
+    rubocop (0.19.1)
       json (>= 1.7.7, < 2)
       parser (~> 2.1.7)
       powerpack (~> 0.0.6)
@@ -309,33 +279,15 @@ GEM
     rubysl-xmlrpc (2.0.0)
     rubysl-yaml (2.0.4)
     rubysl-zlib (2.0.1)
-    safe_yaml (0.9.7)
     slop (3.5.0)
     spoon (0.0.4)
       ffi
-    thread_safe (0.2.0)
+    thread_safe (0.3.1)
       atomic (>= 1.1.7, < 2)
-    thread_safe (0.2.0-java)
+    thread_safe (0.3.1-java)
       atomic (>= 1.1.7, < 2)
-    travis (1.6.8)
-      addressable (~> 2.3)
-      backports
-      faraday (~> 0.8.7)
-      faraday_middleware (~> 0.9)
-      gh (~> 0.13)
-      highline (~> 1.6)
-      launchy (~> 2.1)
-      pry (~> 0.9)
-      pusher-client (~> 0.4)
-      typhoeus (~> 0.6)
-    travis-lint (1.8.0)
-      hashr (~> 0.0.22)
-      safe_yaml (~> 0.9.0)
-    typhoeus (0.6.7)
-      ethon (~> 0.6.2)
     tzinfo (0.3.39)
-    websocket (1.0.7)
-    yard (0.8.7.3)
+    yard (0.8.7.4)
 
 PLATFORMS
   java
@@ -343,17 +295,14 @@ PLATFORMS
 
 DEPENDENCIES
   appraisal (~> 0.5)
-  byebug
+  byebug (~> 2.7)
   cequel!
-  debugger
-  pry
-  psych
-  racc
-  rake
+  debugger (~> 1.6)
+  pry (~> 0.9)
+  psych (~> 2.0)
+  racc (~> 1.4)
+  rake (~> 10.1)
   rspec (~> 2.0)
-  rubocop
+  rubocop (~> 0.19)
   rubysl (~> 2.0)
-  travis
-  travis-lint
-  tzinfo
   yard (~> 0.6)

data/README.md

@@ -155,6 +155,17 @@ the `[]` operator, these methods operate on the first unscoped primary key:
 Post['bigdata'].after(last_id) # scopes posts with blog_subdomain="bigdata" and id > last_id
 ```
 
+You can also use `where` to scope to primary key columns, but a primary key
+column can only be scoped if all the columns that come before it are also
+scoped:
+
+```ruby
+Post.where(blog_subdomain: 'bigdata') # this is fine
+Post.where(blog_subdomain: 'bigdata', permalink: 'cassandra') # also fine
+Post.where(blog_subdomain: 'bigdata').where(permalink: 'cassandra') # also fine
+Post.where(permalink: 'cassandra') # bad: can't use permalink without blog_subdomain
+```
+
 Note that record sets always load records in batches; Cassandra does not support
 result sets of unbounded size. This process is transparent to you but you'll see
 multiple queries in your logs if you're iterating over a huge result set.
@@ -308,9 +319,6 @@ You can also call the `where` method directly on record sets:
 Post.where(:author_id, id)
 ```
 
-Note that `where` is only for secondary indexed columns; use `[]` to scope
-record sets by primary keys.
-
 ### Consistency tuning ###
 
 Cassandra supports [tunable

data/lib/cequel/record.rb

@@ -13,7 +13,7 @@ require 'cequel/record/data_set_builder'
 require 'cequel/record/bound'
 require 'cequel/record/lazy_record_collection'
 require 'cequel/record/scoped'
-require 'cequel/record/secondary_indexes'
+require 'cequel/record/finders'
 require 'cequel/record/associations'
 require 'cequel/record/association_collection'
 require 'cequel/record/belongs_to_association'
@@ -64,11 +64,11 @@ module Cequel
   #
   # @see Properties Defining properties
   # @see Collection Collection columns
-  # @see SecondaryIndexes Defining secondary indexes
   # @see Associations Defining associations between records
   # @see Persistence Creating, updating, and destroying records
   # @see BulkWrites Updating and destroying records in bulk
   # @see RecordSet Loading records from the database
+  # @see Finders Magic finder methods
   # @see MassAssignment Mass-assignment protection and strong attributes
   # @see Callbacks Lifecycle hooks
   # @see Validations
@@ -84,7 +84,7 @@ module Cequel
       include Persistence
       include Associations
       include Scoped
-      extend SecondaryIndexes
+      extend Finders
       include MassAssignment
       include Callbacks
       include Validations

data/lib/cequel/record/finders.rb

@@ -0,0 +1,102 @@
+module Cequel
+  module Record
+    #
+    # Cequel provides finder methods to construct scopes for looking up records
+    # by primary key or secondary indexed columns.
+    #
+    # @example Example model class
+    #   class Post
+    #     key :blog_subdomain, :text
+    #     key :id, :timeuuid, auto: true
+    #     column :title, :text
+    #     column :body, :text
+    #     column :author_id, :uuid, index: true # this column has a secondary
+    #                                           # index
+    #   end
+    #
+    # @example Using some but not all primary key columns
+    #   # return an Array of all posts with given subdomain (greedy load)
+    #   Post.find_all_by_blog_subdomain(subdomain)
+    #
+    #   # return a {RecordSet} of all posts with the given subdomain (lazy
+    #   # load)
+    #   Post.with_subdomain(subdomain)
+    #
+    # @example Using all primary key columns
+    #   # return the first post with the given subdomain and id, or nil if none
+    #   Post.find_by_blog_subdomain_and_id(subdomain, id)
+    #
+    #   # return a record set to the post with the given subdomain and id
+    #   # (one element array if exists, empty array otherwise)
+    #   Post.with_blog_subdomain_and_id(subdomain, id)
+    #
+    # @example Chaining
+    #   # return the first post with the given subdomain and id, or nil if none
+    #   # Note that find_by_id can only be called on a scope that already has a
+    #   # filter value for blog_subdomain
+    #   Post.with_blog_subdomain(subdomain).find_by_id(id)
+    #
+    # @example Using a secondary index
+    #   # return the first record with the author_id
+    #   Post.find_by_author_id(id)
+    #
+    #   # return an Array of all records with the author_id
+    #   Post.find_all_by_author_id(id)
+    #
+    #   # return a RecordSet scoped to the author_id
+    #   Post.with_author_id(id)
+    #
+    # @since 1.2.0
+    #
+    module Finders
+      private
+
+      def key(*)
+        if key_columns.any?
+          def_key_finders('find_all_by', '.entries')
+          undef_key_finders('find_by')
+        end
+        super
+        def_key_finders('find_by', '.first')
+        def_key_finders('with')
+      end
+
+      def column(name, type, options = {})
+        super
+        if options[:index]
+          def_finder('with', [name])
+          def_finder('find_by', [name], '.first')
+          def_finder('find_all_by', [name], '.entries')
+        end
+      end
+
+      def def_key_finders(method_prefix, scope_operation = '')
+        def_finder(method_prefix, key_column_names, scope_operation)
+        def_finder(method_prefix, key_column_names.last(1), scope_operation)
+      end
+
+      def def_finder(method_prefix, column_names, scope_operation = '')
+        arg_names = column_names.join(', ')
+        method_suffix = finder_method_suffix(column_names)
+        column_filter_expr = column_names
+          .map { |name| "#{name}: #{name}" }.join(', ')
+
+        singleton_class.module_eval(<<-RUBY, __FILE__, __LINE__+1)
+          def #{method_prefix}_#{method_suffix}(#{arg_names})
+            where(#{column_filter_expr})#{scope_operation}
+          end
+        RUBY
+      end
+
+      def undef_key_finders(method_prefix)
+        method_suffix = finder_method_suffix(key_column_names)
+        method_name = "#{method_prefix}_#{method_suffix}"
+        singleton_class.module_eval { undef_method(method_name) }
+      end
+
+      def finder_method_suffix(column_names)
+        column_names.join('_and_')
+      end
+    end
+  end
+end

data/lib/cequel/record/properties.rb

@@ -116,8 +116,16 @@ module Cequel
         # @param options [Options] options for the column
         # @option options [Object,Proc] :default a default value for the
         #   column, or a proc that returns a default value for the column
+        # @option options [Boolean,Symbol] :index create a secondary index on
+        #   this column
         # @return [void]
         #
+        # @note Secondary indexes are not nearly as flexible as primary keys:
+        #   you cannot query for multiple values or for ranges of values. You
+        #   also cannot combine a secondary index restriction with a primary
+        #   key restriction in the same query, nor can you combine more than
+        #   one secondary index restriction in the same query.
+        #
         def column(name, type, options = {})
           def_accessors(name)
           set_attribute_default(name, options[:default])

data/lib/cequel/record/record_set.rb

@@ -181,38 +181,38 @@ module Cequel
       # Filter the record set to records containing a given value in an indexed
       # column
       #
-      # @param column_name [Symbol] column for filter
-      # @param value value to match in given column
-      # @return [RecordSet] record set with filter applied
-      # @raise [IllegalQuery] if this record set is already filtered by an
-      #   indexed column
-      # @raise [ArgumentError] if the specified column is not an data column
-      #   with a secondary index
-      #
-      # @note This should only be used with data columns that have secondary
-      #   indexes. To filter a record set using a primary key, use {#[]}
+      # @overload where(column_name, value)
+      #   @param column_name [Symbol] column for filter
+      #   @param value value to match in given column
+      #   @return [RecordSet] record set with filter applied
+      #   @deprecated
+      #
+      # @overload where(column_values)
+      #   @param column_values [Hash] map of key column names to values
+      #   @return [RecordSet] record set with filter applied
+      #
+      # @raise [IllegalQuery] if applying filter would generate an impossible
+      #   query
+      # @raise [ArgumentError] if the specified column is not a column that
+      #   can be filtered on
+      #
+      # @note Filtering on a primary key requires also filtering on all prior
+      #   primary keys
       # @note Only one secondary index filter can be used in a given query
       # @note Secondary index filters cannot be mixed with primary key filters
       #
-      def where(column_name, value)
-        column = target_class.reflect_on_column(column_name)
-        if scoped_indexed_column
-          fail IllegalQuery,
-               "Can't scope by more than one indexed column in the same query"
-        end
-        unless column
-          fail ArgumentError,
-               "No column #{column_name} configured for #{target_class.name}"
-        end
-        unless column.data_column?
-          fail ArgumentError,
-               "Use the `at` method to restrict scope by primary key"
-        end
-        unless column.indexed?
+      def where(*args)
+        if args.length == 1
+          column_filters = args.first.symbolize_keys
+        elsif args.length == 2
+          warn "where(column_name, value) is deprecated. Use " \
+               "where(column_name => value) instead"
+          column_filters = {args.first.to_sym => args.second}
+        else
           fail ArgumentError,
-               "Can't scope by non-indexed column #{column_name}"
+               "wrong number of arguments (#{args.length} for 1..2)"
         end
-        scoped(scoped_indexed_column: {column_name => column.cast(value)})
+        filter_columns(column_filters)
       end
 
       #
@@ -639,6 +639,11 @@ module Cequel
         entries == other.to_a
       end
 
+      # @private
+      def to_ary
+        entries
+      end
+
       protected
 
       attr_reader :attributes
@@ -683,6 +688,57 @@ module Cequel
         end
       end
 
+      def filter_columns(column_values)
+        return self if column_values.empty?
+
+        if column_values.key?(next_unscoped_key_name)
+          filter_primary_key(column_values.delete(next_unscoped_key_name))
+        else
+          filter_secondary_index(*column_values.shift)
+        end.filter_columns(column_values)
+      end
+
+      def filter_primary_key(value)
+        if scoped_indexed_column
+          fail IllegalQuery,
+               "Can't filter by both primary key and secondary index"
+        end
+        if value.is_a?(Range)
+          self.in(value)
+        else
+          scoped { |attributes| attributes[:scoped_key_values] << value }
+        end
+      end
+
+      def filter_secondary_index(column_name, value)
+        column = target_class.reflect_on_column(column_name)
+        if column.nil?
+          fail ArgumentError,
+               "No column #{column_name} configured for #{target_class.name}"
+        end
+        if column.key?
+          missing_column_names = unscoped_key_names.take_while do |key_name|
+            key_name != column_name
+          end
+          fail IllegalQuery,
+               "Can't scope key column #{column_name} without also scoping " \
+               "#{missing_column_names.join(', ')}"
+        end
+        if scoped_key_values.any?
+          fail IllegalQuery,
+               "Can't filter by both primary key and secondary index"
+        end
+        if scoped_indexed_column
+          fail IllegalQuery,
+               "Can't scope by more than one indexed column in the same query"
+        end
+        unless column.indexed?
+          fail ArgumentError,
+               "Can't scope by non-indexed column #{column_name}"
+        end
+        scoped(scoped_indexed_column: {column_name => column.cast(value)})
+      end
+
       def scoped_key_names
         scoped_key_columns.map { |column| column.name }
       end
@@ -707,6 +763,14 @@ module Cequel
         range_key_column.name
       end
 
+      def next_unscoped_key_column
+        unscoped_key_columns.first
+      end
+
+      def next_unscoped_key_name
+        next_unscoped_key_column.name
+      end
+
       def next_range_key_column
         unscoped_key_columns.second
       end
@@ -736,8 +800,6 @@ module Cequel
       end
 
       def next_unscoped_key_column_valid_for_in_query?
-        next_unscoped_key_column = unscoped_key_columns.first
-
         next_unscoped_key_column == partition_key_columns.last ||
           next_unscoped_key_column == clustering_columns.last
       end

data/lib/cequel/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module Cequel
   # The current version of the library
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
 end

data/spec/examples/record/finders_spec.rb

@@ -0,0 +1,177 @@
+require_relative 'spec_helper'
+
+describe Cequel::Record::Finders do
+  model :Blog do
+    key :subdomain, :text
+    column :name, :text
+    column :description, :text
+    column :owner_id, :uuid
+  end
+
+  model :User do
+    key :login, :text
+    column :name, :text
+  end
+
+  model :Post do
+    key :blog_subdomain, :text
+    key :permalink, :text
+    column :title, :text
+    column :body, :text
+    column :author_id, :uuid, index: true
+  end
+
+  let :blogs do
+    cequel.batch do
+      5.times.map do |i|
+        Blog.create!(subdomain: "cassandra#{i}", name: 'Cassandra')
+      end
+    end
+  end
+
+  let(:author_ids) { Array.new(2) { Cequel.uuid }}
+
+  let :cassandra_posts do
+    cequel.batch do
+      5.times.map do |i|
+        Post.create!(
+          blog_subdomain: 'cassandra',
+          permalink: "cassandra#{i}",
+          author_id: author_ids[i%2]
+        )
+      end
+    end
+  end
+
+  let :postgres_posts do
+    cequel.batch do
+      5.times.map do |i|
+        Post.create!(blog_subdomain: 'postgres', permalink: "postgres#{i}")
+      end
+    end
+  end
+
+  let(:posts) { cassandra_posts + postgres_posts }
+
+  context 'simple primary key' do
+
+    let!(:blog) { blogs.first }
+
+    describe '#find_by_*' do
+      it 'should return matching record' do
+        expect(Blog.find_by_subdomain('cassandra0')).to eq(blog)
+      end
+
+      it 'should return nil if no record matches' do
+        expect(Blog.find_by_subdomain('bogus')).to be_nil
+      end
+
+      it 'should respond to method before it is called' do
+        expect(User).to be_respond_to(:find_by_login)
+      end
+
+      it 'should raise error on wrong name' do
+        expect { Blog.find_by_bogus('bogus') }.to raise_error(NoMethodError)
+      end
+
+      it 'should not respond to wrong name' do
+        expect(User).to_not be_respond_to(:find_by_bogus)
+      end
+    end
+
+    describe '#find_all_by_*' do
+      it 'should raise error if called' do
+        expect { Blog.find_all_by_subdomain('outoftime') }
+        .to raise_error(NoMethodError)
+      end
+
+      it 'should not respond' do
+        expect(User).not_to be_respond_to(:find_all_by_login)
+      end
+    end
+  end
+
+  context 'compound primary key' do
+
+    let!(:post) { posts.first }
+
+    describe '#find_all_by_*' do
+      it 'should return all records matching key prefix' do
+        expect(Post.find_all_by_blog_subdomain('cassandra'))
+          .to eq(cassandra_posts)
+      end
+
+      it 'should greedily load records' do
+        records = Post.find_all_by_blog_subdomain('cassandra')
+        disallow_queries!
+        expect(records).to eq(cassandra_posts)
+      end
+
+      it 'should return empty array if nothing matches' do
+        expect(Post.find_all_by_blog_subdomain('bogus')).to eq([])
+      end
+
+      it 'should not exist for all keys' do
+        expect { Post.find_all_by_blog_subdomain_and_permalink('f', 'b') }
+          .to raise_error(NoMethodError)
+      end
+    end
+
+    describe '#find_by_*' do
+      it 'should return record matching all keys' do
+        expect(Post.find_by_blog_subdomain_and_permalink('cassandra',
+                                                         'cassandra0'))
+          .to eq(cassandra_posts.first)
+      end
+
+      it 'should not exist for key prefix' do
+        expect { Post.find_by_blog_subdomain('foo') }
+          .to raise_error(NoMethodError)
+      end
+
+      it 'should allow lower-order key if chained' do
+        expect(Post.where(blog_subdomain: 'cassandra')
+                 .find_by_permalink('cassandra0')).to eq(cassandra_posts.first)
+      end
+    end
+
+    describe '#with_*' do
+      it 'should return record matching all keys' do
+        expect(Post.with_blog_subdomain_and_permalink('cassandra',
+                                                      'cassandra0'))
+          .to eq(cassandra_posts.first(1))
+      end
+
+      it 'should return all records matching key prefix' do
+        expect(Post.with_blog_subdomain('cassandra'))
+          .to eq(cassandra_posts)
+      end
+    end
+  end
+
+  context 'secondary index' do
+    before { cassandra_posts }
+
+    it 'should expose scope to query by secondary index' do
+      expect(Post.with_author_id(author_ids.first))
+        .to match_array(cassandra_posts.values_at(0, 2, 4))
+    end
+
+    it 'should expose method to retrieve first result by secondary index' do
+      expect(Post.find_by_author_id(author_ids.first))
+        .to eq(cassandra_posts.first)
+    end
+
+    it 'should expose method to eagerly retrieve all results by secondary index' do
+      posts = Post.find_all_by_author_id(author_ids.first)
+      disallow_queries!
+      expect(posts).to match_array(cassandra_posts.values_at(0, 2, 4))
+    end
+
+    it 'should not expose methods for non-indexed columns' do
+      [:find_by_title, :find_all_by_title, :with_title].each do |method|
+        expect(Post).to_not respond_to(method)
+      end
+    end
+  end
+end

data/spec/examples/record/record_set_spec.rb

@@ -585,35 +585,114 @@ describe Cequel::Record::RecordSet do
   end
 
   describe '#where' do
-    it 'should correctly query for secondary indexed columns' do
-      Post.where(:author_id, uuids.first).map(&:permalink).
-        should == %w(cequel0 cequel2 cequel4)
+    context 'simple primary key' do
+      let(:records) { blogs }
+
+      it 'should correctly query for simple primary key with two arguments' do
+        expect(Blog.where(:subdomain, 'blog-0'))
+          .to eq(blogs.first(1))
+      end
+
+      it 'should correctly query for simple primary key with hash argument' do
+        expect(Blog.where(subdomain: 'blog-0'))
+          .to eq(blogs.first(1))
+      end
     end
 
-    it 'should cast argument for column' do
-      Post.where(:author_id, uuids.first.to_s).map(&:permalink).
-        should == %w(cequel0 cequel2 cequel4)
+    context 'compound primary key' do
+      it 'should correctly query for first primary key column' do
+        expect(Post.where(blog_subdomain: 'cassandra'))
+          .to eq(cassandra_posts)
+      end
+
+      it 'should perform IN query when passed multiple values' do
+        expect(Post.where(blog_subdomain: %w(cassandra postgres)))
+          .to match_array(cassandra_posts + postgres_posts)
+      end
+
+      it 'should correctly query for both primary key columns' do
+        expect(Post.where(blog_subdomain: 'cassandra', permalink: 'cequel0'))
+          .to eq(cassandra_posts.first(1))
+      end
+
+      it 'should correctly query for both primary key columns chained' do
+        expect(Post.where(blog_subdomain: 'cassandra')
+               .where(permalink: 'cequel0'))
+          .to eq(cassandra_posts.first(1))
+      end
+
+      it 'should perform range query when passed range' do
+        expect(Post.where(blog_subdomain: %w(cassandra),
+                          permalink: 'cequel0'..'cequel2'))
+          .to eq(cassandra_posts.first(3))
+      end
+
+      it 'should raise error if lower-order primary key specified without higher' do
+        expect { Post.where(permalink: 'cequel0').first }
+          .to raise_error(Cequel::Record::IllegalQuery)
+      end
     end
 
-    it 'should raise ArgumentError if column is not recognized' do
-      expect { Post.where(:bogus, 'Business') }.
-        to raise_error(ArgumentError)
+    context 'secondary indexed column' do
+      it 'should query for secondary indexed columns with two arguments' do
+        Post.where(:author_id, uuids.first).map(&:permalink).
+          should == %w(cequel0 cequel2 cequel4)
+      end
+
+      it 'should query for secondary indexed columns with hash argument' do
+        Post.where(author_id: uuids.first).map(&:permalink).
+          should == %w(cequel0 cequel2 cequel4)
+      end
+
+      it 'should not allow multiple columns in the arguments' do
+        expect { Post.where(author_id: uuids.first, author_name: 'Mat Brown') }
+          .to raise_error(Cequel::Record::IllegalQuery)
+      end
+
+      it 'should not allow chaining of multiple columns' do
+        expect { Post.where(:author_id, uuids.first).
+          where(:author_name, 'Mat Brown') }.
+          to raise_error(Cequel::Record::IllegalQuery)
+      end
+
+      it 'should cast argument for column' do
+        Post.where(:author_id, uuids.first.to_s).map(&:permalink).
+          should == %w(cequel0 cequel2 cequel4)
+      end
     end
 
-    it 'should raise ArgumentError if column is not indexed' do
-      expect { Post.where(:title, 'Cequel 0') }.
-        to raise_error(ArgumentError)
+    context 'mixing keys and secondary-indexed columns' do
+      it 'should not allow mixture in hash argument' do
+        expect { Post.where(blog_subdomain: 'cassandra',
+                            author_id: uuids.first) }
+          .to raise_error(Cequel::Record::IllegalQuery)
+      end
+
+      it 'should not allow mixture in chain with primary first' do
+        expect { Post.where(blog_subdomain: 'cassandra')
+                  .where(author_id: uuids.first) }
+          .to raise_error(Cequel::Record::IllegalQuery)
+      end
+
+      it 'should not allow mixture in chain with secondary first' do
+        expect { Post.where(author_id: uuids.first)
+                  .where(blog_subdomain: 'cassandra') }
+          .to raise_error(Cequel::Record::IllegalQuery)
+      end
     end
 
-    it 'should raise ArgumentError if column is a key' do
-      expect { Post.where(:permalink, 'cequel0') }.
-        to raise_error(ArgumentError)
+    context 'nonexistent column' do
+      it 'should raise ArgumentError if column is not recognized' do
+        expect { Post.where(:bogus, 'Business') }.
+          to raise_error(ArgumentError)
+      end
     end
 
-    it 'should raise IllegalQuery if applied twice' do
-      expect { Post.where(:author_id, uuids.first).
-        where(:author_name, 'Mat Brown') }.
-        to raise_error(Cequel::Record::IllegalQuery)
+    context 'non-indexed column' do
+      it 'should raise ArgumentError if column is not indexed' do
+        expect { Post.where(:title, 'Cequel 0') }.
+          to raise_error(ArgumentError)
+      end
     end
   end
 

data/spec/support/helpers.rb

@@ -108,11 +108,11 @@ module Cequel
       end
 
       def max_statements!(number)
-        cequel.should_receive(:execute).at_most(number).times.and_call_original
+        cequel.client.should_receive(:execute).at_most(number).times.and_call_original
       end
 
       def disallow_queries!
-        cequel.should_not_receive(:execute)
+        cequel.client.should_not_receive(:execute)
       end
 
       def expect_query_with_consistency(matcher, consistency)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cequel
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Mat Brown
@@ -12,10 +12,11 @@ authors:
 - Peter Williams
 - Kenneth Hoffman
 - Antti Tapio
+- Ilya Bazylchuk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-18 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -24,6 +25,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,20 +35,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: cql-rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -91,72 +98,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: travis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: travis-lint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: tzinfo
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 description: |
   Cequel is an ActiveRecord-like domain model layer for Cassandra that exposes
   the robust data modeling capabilities of CQL3, including parent-child
@@ -209,6 +174,7 @@ files:
 - lib/cequel/record/data_set_builder.rb
 - lib/cequel/record/dirty.rb
 - lib/cequel/record/errors.rb
+- lib/cequel/record/finders.rb
 - lib/cequel/record/has_many_association.rb
 - lib/cequel/record/lazy_record_collection.rb
 - lib/cequel/record/mass_assignment.rb
@@ -219,7 +185,6 @@ files:
 - lib/cequel/record/record_set.rb
 - lib/cequel/record/schema.rb
 - lib/cequel/record/scoped.rb
-- lib/cequel/record/secondary_indexes.rb
 - lib/cequel/record/tasks.rb
 - lib/cequel/record/validations.rb
 - lib/cequel/schema.rb
@@ -244,6 +209,7 @@ files:
 - spec/examples/record/associations_spec.rb
 - spec/examples/record/callbacks_spec.rb
 - spec/examples/record/dirty_spec.rb
+- spec/examples/record/finders_spec.rb
 - spec/examples/record/list_spec.rb
 - spec/examples/record/map_spec.rb
 - spec/examples/record/mass_assignment_spec.rb
@@ -253,7 +219,6 @@ files:
 - spec/examples/record/record_set_spec.rb
 - spec/examples/record/schema_spec.rb
 - spec/examples/record/scoped_spec.rb
-- spec/examples/record/secondary_index_spec.rb
 - spec/examples/record/serialization_spec.rb
 - spec/examples/record/set_spec.rb
 - spec/examples/record/spec_helper.rb
@@ -301,6 +266,7 @@ test_files:
 - spec/examples/record/associations_spec.rb
 - spec/examples/record/callbacks_spec.rb
 - spec/examples/record/dirty_spec.rb
+- spec/examples/record/finders_spec.rb
 - spec/examples/record/list_spec.rb
 - spec/examples/record/map_spec.rb
 - spec/examples/record/mass_assignment_spec.rb
@@ -310,7 +276,6 @@ test_files:
 - spec/examples/record/record_set_spec.rb
 - spec/examples/record/schema_spec.rb
 - spec/examples/record/scoped_spec.rb
-- spec/examples/record/secondary_index_spec.rb
 - spec/examples/record/serialization_spec.rb
 - spec/examples/record/set_spec.rb
 - spec/examples/record/spec_helper.rb

data/lib/cequel/record/secondary_indexes.rb

@@ -1,68 +0,0 @@
-# -*- encoding : utf-8 -*-
-module Cequel
-  module Record
-    #
-    # Data columns may be given secondary indexes. This allows you to query the
-    # table for records where the indexed column contains a single value.
-    # Secondary indexes are not nearly as flexible as primary keys: you cannot
-    # query for multiple values or for ranges of values. You also cannot
-    # combine a secondary index restriction with a primary key restriction in
-    # the same query, nor can you combine more than one secondary index
-    # restrictions in the same query.
-    #
-    # If a column is given a secondary index, magic finder methods `find_by_*`,
-    # `find_all_by_*`, and `with_*` are added to the class singleton. See below
-    # for an example.
-    #
-    # Secondary indexes are fairly expensive for Cassandra and should only be
-    # defined where needed.
-    #
-    # @example Defining a secondary index
-    #   class Post
-    #     belongs_to :blog
-    #     key :id, :timeuuid, auto: true
-    #     column :title, :text
-    #     column :body, :text
-    #     column :author_id, :uuid, index: true # this column has a secondary
-    #                                           # index
-    #   end
-    #
-    # @example Using a secondary index
-    #   # return the first record with the author_id
-    #   Post.find_by_author_id(id)
-    #
-    #   # return an Array of all records with the author_id
-    #   Post.find_all_by_author_id(id)
-    #
-    #   # return a RecordSet scoped to the author_id
-    #   Post.with_author_id(id)
-    #
-    #   # same as with_author_id
-    #   Post.where(:author_id, id)
-    #
-    # @since 1.0.0
-    #
-    module SecondaryIndexes
-      # @private
-      def column(name, type, options = {})
-        super
-        name = name.to_sym
-        if options[:index]
-          instance_eval <<-RUBY, __FILE__, __LINE__+1
-            def with_#{name}(value)
-              all.where(#{name.inspect}, value)
-            end
-
-            def find_by_#{name}(value)
-              with_#{name}(value).first
-            end
-
-            def find_all_by_#{name}(value)
-              with_#{name}(value).to_a
-            end
-          RUBY
-        end
-      end
-    end
-  end
-end

data/spec/examples/record/secondary_index_spec.rb

@@ -1,46 +0,0 @@
-# -*- encoding : utf-8 -*-
-require_relative 'spec_helper'
-
-describe Cequel::Record::SecondaryIndexes do
-  model :Post do
-    key :blog_subdomain, :text
-    key :permalink, :text
-    column :title, :text
-    column :author_id, :uuid, :index => true
-  end
-
-  let(:uuids) { Array.new(2) { Cequel.uuid }}
-
-  let!(:posts) do
-    3.times.map do |i|
-      Post.create! do |post|
-        post.blog_subdomain = 'bigdata'
-        post.permalink = "cequel#{i}"
-        post.title = "Cequel #{i}"
-        post.author_id = uuids[i%2]
-      end
-    end
-  end
-
-  it 'should create secondary index in schema' do
-    cequel.schema.read_table(:posts).data_columns.
-      find { |column| column.name == :author_id }.index_name.
-      should be
-  end
-
-  it 'should expose scope to query by secondary index' do
-    Post.with_author_id(uuids.first).map(&:permalink).
-      should == %w(cequel0 cequel2)
-  end
-
-  it 'should expose method to retrieve first result by secondary index' do
-    Post.find_by_author_id(uuids.first).should == posts.first
-  end
-
-  it 'should expose method to eagerly retrieve all results by secondary index' do
-    posts = Post.find_all_by_author_id(uuids.first)
-    disallow_queries!
-    posts.map(&:permalink).should == %w(cequel0 cequel2)
-  end
-
-end