cassie 1.0.0.beta.5 → 1.0.0.beta.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ad2343accacdf35f48e99a510cf6905bb86f91b5
-  data.tar.gz: 8e79fb85280c7f756c2f43c4be640f932dcd7eaf
+  metadata.gz: 40bb4e39b19017fcef0127c393ccb0280c8ea6bb
+  data.tar.gz: 9ed902fdd76d02a30e91ccb7385d761df6e4936b
 SHA512:
-  metadata.gz: 9d1823d0746fb58f0c7bc6026cda513f5957fd42d7fe63e162635cc70ac39b14dd6531a8fe85aa7a157e56a03d8669683f015a061329e86fba1cc24256f8ec41
-  data.tar.gz: ea60edb6e9944e0009a2864a0d349990aa349b820751940beb41b73047a13fdc7b3307ef4c9b84aefdc216116c21167ca8d29f7ee1e9394a62a468a09e9df65d
+  metadata.gz: 987f316efd2e36ca612f45fc212bcd6c967dd2e3cd6840923b159a1acb1fa35448843411b14d695125b8a277a966dbbd3d0068b7cf47c40ccea5a96a63a8ad53
+  data.tar.gz: 34edc2ed19b618c8297a9e8a925ae26262e627b14b272c57758f33b201d5c9f56191d78d5b958bdbc6e640db05046fb3f990bbf8e1a9367c7c7c5d02002033db

data/lib/cassie/queries/README.md

@@ -22,7 +22,7 @@ Queries defined on the fly like this tend to create debt for an application in t
   * resist documentation
   * resist refactoring
 
-Your application queries represent distinct application behavior, `cassie` queries are designed to help you create query classes that are reusable, testable and maintainable (so you can sleep better at night).
+Application queries represent distinct application behavior, `cassie` queries are designed to help create query classes that are reusable, testable and maintainable (so you can sleep better at night).
 
 ```ruby
 # Some PORO user model

data/lib/cassie/queries/logging/cql_execution_event.rb

@@ -9,7 +9,11 @@ module Cassie::Queries::Logging
     end
 
     def message
-      color "(#{duration.round(1)}ms) #{statement} [#{consistency.upcase}]"
+      {
+        duration: duration.round(1),
+        query: statement,
+        consistency: consistency.upcase
+      }.extend(Inspector)
     end
 
     protected
@@ -45,8 +49,20 @@ module Cassie::Queries::Logging
       execution_info.trace
     end
 
-    def color(message)
-      "\e[1m\e[37m#{message}\e[0m\e[22m"
+    module Inspector
+      def inspect
+        color "(#{fetch(:duration).round(1)}ms) #{fetch(:query)} [#{fetch(:consistency).upcase}]"
+      end
+
+      def to_s
+        inspect
+      end
+
+      protected
+
+      def color(message)
+        "\e[1m\e[37m#{message}\e[0m\e[22m"
+      end
     end
   end
 end

data/lib/cassie/queries/statement/batches.rb

@@ -11,6 +11,23 @@ module Cassie::Queries::Statement
       attr_accessor :stateless_page_size
     end
 
+    # Uses #fetch_in_batches with a batch size of 1000 (or as
+    # specified by the +:batch_size+ option) to enumerate through all
+    # records, while using batches to limit resource consumption.
+    #
+    # If you do not provide a block to #fetch_each, it will return an Enumerator
+    # for chaining with other methods.
+    #
+    #   UsersByPositionQuery.fetch_each.with_index do |user, index|
+    #     user.position = index
+    #     UserMapper.update_position(user)
+    #   end
+    #
+    # ==== Options
+    # * <tt>:batch_size</tt> - Specifies the size of the batch. Default to 1000.
+    #
+    # NOTE: Any limit specified on the query will affect the batched set.
+    # Cassandra internal paging is used for batching.
     def fetch_each(opts={})
       return to_enum(:fetch_each, opts) unless block_given?
 
@@ -28,24 +45,30 @@ module Cassie::Queries::Statement
     #  end
     #
     #  "max score in group: 26"
+    #
+    # ==== Options
+    # * <tt>:batch_size</tt> - Specifies the size of the batch. Default to 1000.
+    #
+    # NOTE: Any limit specified on the query will affect the batched set.
+    # Cassandra internal paging is used for batching.
     def fetch_in_batches(opts={})
-      # we want to clone the query as soon as the enumerable is
-      # created, not wait until the firt iteration is called
-      # as the client could mutate the object between these states
-      # but we don't want to clone twice if enumerator returned
-      return to_enum(:fetch_in_batches, opts.merge(_paged_query: self.clone)) unless block_given?
-
       opts[:batch_size] ||= 1000
 
+      # clone the query as soon as the enumerable is created
+      # rather than waiting until the firt iteration is executed
+      # as the client could mutate the object between these states.
+      # However we don't want to clone twice if a block isn't passed
+      paged_query = opts.delete(:_paged_query) || self.clone
+
+      return to_enum(:fetch_in_batches, opts.merge(_paged_query: paged_query)) unless block_given?
+
       # use Cassandra internal paging
       # but clone the query to isolate it
-      # but allow all paging queries
+      # and allow all paging queries
       # to execute within a Cassie::Query
       # for use of other features, like logging
-      paged_query = opts.delete(:_paged_query) || self.clone
-
-      # set cassandra internal
-      # stateless page size (independent from limit)
+      #
+      # note: stateless page size is independent from limit
       paged_query.stateless_page_size = opts[:batch_size]
       paged_query.paging_state = nil
       done = false

data/lib/cassie/testing/fake/result.rb

@@ -2,12 +2,12 @@ require_relative 'execution_info'
 
 module Cassie::Testing::Fake
   class Result
-    attr_accessor :rows, :statement
+    attr_reader :rows, :statement, :opts
 
     def initialize(statement, execution_opts={})
       @statement = statement
       @opts = execution_opts
-      @rows = @opts[:rows]
+      @rows = @data = opts[:rows] || []
     end
 
     def execution_info
@@ -15,29 +15,65 @@ module Cassie::Testing::Fake
     end
 
     def rows
-      @rows || []
+      if paging_enabled?
+        index = current_page - 1
+        offset = index * page_size
+        @data.slice(offset, page_size) || []
+      else
+        @data
+      end
     end
 
     def empty?
       rows.empty?
     end
 
+    def paging_enabled?
+      !!page_size
+    end
+
+    def page_size
+      return nil unless opts[:page_size]
+      opts[:page_size].to_i
+    end
+
+    def pages
+      return nil unless paging_enabled?
+      (@data.count / page_size.to_f).ceil
+    end
+
+    def previous_page
+      return nil unless previous_paging_state
+      previous_paging_state.bytes[-1]
+    end
+
+    def current_page
+      return 1 unless paging_enabled? && previous_page
+      previous_page + 1
+    end
+
     def last_page?
-      return nil unless @opts[:page_size]
-      return @last_page if defined?(@last_page)
-      true
+      return nil unless paging_enabled?
+      current_page == pages
     end
 
-    def assert_last_page(val=true)
-      @last_page = val
+    def previous_paging_state
+      return nil unless paging_enabled?
+      @opts[:paging_state]
     end
 
     def paging_state
-      return nil unless @opts[:page_size]
-      return "paging #{SecureRandom.hex(6)}:0" unless @opts[:paging_state]
-      bytes = @opts[:paging_state].bytes
-      bytes[-1] = bytes[-1] + 1
-      return bytes.pack('c*')
+      return nil unless paging_enabled?
+      if previous_paging_state
+        bytes = previous_paging_state.bytes
+        raise 'Too many pages for Cassie testing harness!' if bytes[-1] >= 256
+        bytes[-1] = bytes[-1] + 1
+        bytes.pack('c*')
+      else
+        # use last byte of state string to store pages
+        # presume 255 pages is enough for any testing
+        "paging #{SecureRandom.hex(6)}:" + [1].pack('c*')
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.5
+  version: 1.0.0.beta.6
 platform: ruby
 authors:
 - Evan Prothro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-22 00:00:00.000000000 Z
+date: 2016-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver