cassie 1.0.0.alpha.5 → 1.0.0.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d925ecc0efe8b9f80a3db861e19e0600aefafccc
-  data.tar.gz: a691902f688cabb92e861b5e8117d620d6e783d0
+  metadata.gz: 2c9e654e90de48031b18a914e9151d6ac15d7766
+  data.tar.gz: bc7286b5a941bea47bdd6894d815445b670e20e5
 SHA512:
-  metadata.gz: a7d29330368b459d759110f461589776c2552c06e496e2ba2be20bbd7e5f841abbbe617b26cdec7fcd4b919a979998bde14f596ba3f9c06930794cac0b6672a4
-  data.tar.gz: a54572302c88f2fb902800481df8ee2b06dc4de63ab988e51f1e5575b561cc37cb851207f2fd81c9c87d28d0ecd7f2119e59accc4348ddde6bf7baca8b670feb
+  metadata.gz: d45abd16581859fe3f76952e2c809b82029b47ba123d064792ecd71a8bd2d622e4e8a5fbccbc9b3f7a524df2bb08c58f4f06dcba1b9cc42b476925847b0e8e43
+  data.tar.gz: 7a9cbcca9a46ba3e5e34a498962120edffedcb382e26d66f40bd091d398b702c5afa7b82db0f0198883387ad8edb088b4366ff4fb1f5aa801888e7524e04cbc0

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

@@ -0,0 +1,20 @@
+module Cassie::Queries::Statement
+  module Callbacks
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveSupport::Callbacks
+      define_callbacks :failure
+    end
+
+    module ClassMethods
+      def after_failure(*args, &block)
+        set_callback(:failure, :after, *args, &block)
+      end
+    end
+
+    def execute
+      run_callbacks :failure unless super
+    end
+  end
+end

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

@@ -18,7 +18,7 @@ module Cassie::Queries::Statement
         include Mapping
 
         self.table = table
-        self.identifier = :delete
+        self.type = :delete
 
         yield(self) if block_given?
       end

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

@@ -11,7 +11,7 @@ module Cassie::Queries::Statement
         include Conditions
 
         self.table = table
-        self.identifier = :insert
+        self.type = :insert
 
         yield(self) if block_given?
       end

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

@@ -3,15 +3,26 @@ module Cassie::Queries::Statement
     extend ActiveSupport::Concern
 
     included do
-      attr_accessor :limit
+      attr_writer :limit
+    end
+
+    module ClassMethods
+      def limit=(val)
+        @limit = val
+      end
 
-      class << self
-        attr_accessor :limit
+      def limit(val=:get)
+        if val == :get
+          @limit if defined?(@limit)
+        else
+          self.limit = val
+        end
       end
     end
 
     def limit
-      @limit || self.class.limit
+      return @limit if defined?(@limit)
+      self.class.limit
     end
 
     protected

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

@@ -5,18 +5,24 @@ module Cassie::Queries::Statement
     MAPPED_METHODS = [:insert, :update, :delete].freeze
 
     included do
+      # We are mapping term values from a client object.
+      # store this object in `_resource` attribte
+      # as they could reasonably want to name it `resource`
       attr_accessor :_resource
 
+      #TODO: consider simplifying by overriding
+      #      `execute` and aliasing via mapped methods
       MAPPED_METHODS.each do |method|
-        next unless method_defined?(method)
+        # overwrite mapper methods that are defined (yuk)
+        next if !method_defined?(method)
 
-        define_method(method) do |resource=nil, opts={}|
-          if resource.nil?
+        define_method(method) do |value=nil, opts={}|
+          if value.nil?
             # if no mapping is taking place, keep previously
             # defined behavior/return value
             return super(opts) if _resource.nil?
           else
-            self._resource = resource
+            self._resource = value
           end
 
           if super(opts)
@@ -30,19 +36,20 @@ module Cassie::Queries::Statement
 
     module ClassMethods
       def map_from(resource_name)
-        attr_accessor resource_name
-
-        define_method "_resource" do
-          send resource_name
+        define_method resource_name do
+          _resource
         end
 
-        define_method "_resource=" do |val|
-          send("#{resource_name}=", val)
+        define_method "#{resource_name}=" do |val|
+          self._resource = val
         end
       end
 
       protected
 
+      # define getter and setter
+      # methods that look up term values
+      # from resource object
       def define_term_methods(field)
         getter = field
         setter = "#{field}="
@@ -51,20 +58,41 @@ module Cassie::Queries::Statement
           raise "accessor or getter already defined for #{field}. Fix the collisions by using the `:value` option."
         else
           # Order of prefrence for finding term value
-          # 1. overriden getter instance method
-          # 2. value set by setter instance method
-          # 3. (Eventually) Mapping getter instance method
-          # 4. instance resource getter instance method
+          #  1. overriden getter instance method
+          #    def id
+          #      "some constant"
+          #    end
+          #  2. value set by setter instance method
+          #    def ensure_special_is_special
+          #      @id = "one off value" if special?
+          #    end
+          #  3. getter instance method on resource object
+          #    query.user = User.new(id: 105)
+          #    query.id
+          #    => 105
           define_method getter do
+            # 1 is handled by definition
+
+            # 2: prefer instance value
             if instance_variable_defined?("@#{field}")
               return instance_variable_get("@#{field}")
             end
-            _resource.send(field) if(_resource && _resource.respond_to?(field))
-          end
 
-          define_method setter do |val|
-            instance_variable_set("@#{field}", val)
+            # 3: fetch from resource
+            if _resource && _resource.respond_to?(field)
+              _resource.send(field)
+            end
           end
+
+          # query.id = 'some val'
+          # initializes underlying instance var
+          # which is preferred over resource object attribute
+          #
+          # Issue: if client defines value for attribute
+          # they might assume later setting to nil would
+          # revert to behavior of fetching from resource object attribute
+          # but that is not the case since the variable is defined
+          attr_writer field
         end
       end
     end

data/lib/cassie/queries/statement/pagination/cursors.rb

@@ -0,0 +1,168 @@
+require_relative '../relations'
+
+module Cassie::Queries::Pagination
+  module Cursors
+    extend ActiveSupport::Concern
+
+    included do
+      include Cassie::Queries::Statement::Relations
+    end
+
+    module ClassMethods
+      def max_cursor(key)
+        include Peeking
+
+        @max_cursor_key = key
+
+        where(key,:lteq,
+              value: :"max_#{key}",
+              if: :max_cursor_enabled?)
+
+        define_max_accessors(key)
+        define_next_max_cursor_alias(key)
+      end
+
+      def since_cursor(key)
+        include Peeking
+
+        @max_cursor_key = key
+
+        where(key, :gt,
+              value: :"since_#{key}",
+              if: :since_cursor_enabled?)
+
+        define_since_accessors(key)
+        define_next_max_cursor_alias(key)
+      end
+
+      def cursor_by(key)
+        max_cursor key
+        since_cursor key
+      end
+
+      private
+
+      def define_max_accessors(key)
+        attr_accessor :max_cursor
+
+        define_method :max_cursor_enabled? do
+          !max_cursor.nil?
+        end
+
+        getter = :"max_#{key}"
+        remove_method getter if method_defined?(getter)
+        define_method getter do
+          self.max_cursor
+        end
+
+        setter = :"max_#{key}="
+        remove_method setter if method_defined?(setter)
+        define_method setter do |val|
+          self.max_cursor = val
+        end
+      end
+
+      def define_since_accessors(key)
+        attr_accessor :since_cursor
+
+        define_method :since_cursor_enabled? do
+          !since_cursor.nil?
+        end
+
+        getter = :"since_#{key}"
+        remove_method getter if method_defined?(getter)
+        define_method getter do
+          self.since_cursor
+        end
+
+        setter = :"since_#{key}="
+        remove_method setter if method_defined?(setter)
+        define_method setter do |val|
+          self.since_cursor = val
+        end
+      end
+
+      def define_next_max_cursor_alias(key)
+        method = "next_max_#{key}"
+
+        unless method_defined?(method)
+          define_method method do
+            next_max_cursor
+          end
+        end
+      end
+    end
+
+    module Peeking
+      extend ActiveSupport::Concern
+
+      included do
+        attr_reader :next_max_cursor
+      end
+
+      module ClassMethods
+        def max_cursor_key
+          @max_cursor_key.to_s
+        end
+      end
+
+      def limit
+        super || page_size
+      end
+
+      def execute
+        # get 1 extra result to determing next page info
+        # but massage results to only have what client expects
+
+        val = peek_at_next_page do
+          super
+        end
+
+        extract_next_max_cursor
+
+        val
+      end
+
+      private
+
+      # cache query object instance page_size
+      # so we can revert _object_ back to
+      # same state and preserve value
+      # inheritance chain behavior
+      def peek_at_next_page(&block)
+        old_page_size = nil
+        was_defined = false
+
+        if defined?(@page_size)
+          old_page_size = @page_size
+          was_defined = true
+        end
+
+        @page_size = page_size + 1
+        yield
+      ensure
+        if was_defined
+          @page_size = old_page_size
+        else
+          remove_instance_variable(:@page_size)
+        end
+      end
+
+      # Extracts the next_max_cursor from the query results
+      # given then current max_cursor and since_cursor
+      # leaving the results as cursoring client expects
+      #
+      # Note: We modify cassie private attribute in place
+      #       otherwise we have to copy rows, make results private
+      #       or have a mismatch between rows in results
+      #       and resources created by query class
+      def extract_next_max_cursor
+        raw_rows = result.instance_variable_get(:@rows)
+
+        @next_max_cursor = if raw_rows.count > page_size
+          raw_rows.delete_at(-1)[self.class.max_cursor_key]
+        end
+      end
+    end
+  end
+end

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

@@ -70,9 +70,5 @@ module Cassie::Queries::Statement
       # we always generate bound statements
       @cql ||= "#{identifier} #{OPERATIONS[op_type]} ?"
     end
-
-    def op_type
-      @op_type
-    end
   end
 end

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

@@ -32,7 +32,7 @@ module Cassie::Queries::Statement
         #      if value option was nil and we
         #      are implicilty creating getter/setters.
         if method_defined?(name) || method_defined?("#{name}=")
-          raise "accessor or getter already defined for #{name}. Fix the collions by using the `:value` option."
+          raise "accessor or getter already defined for #{name}. Fix the collisions by using the `:value` option."
         else
           attr_accessor name
         end

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

@@ -1,5 +1,6 @@
 require_relative 'relations'
 require_relative 'limiting'
+require_relative 'pagination'
 require_relative 'ordering'
 require_relative 'fetching'
 
@@ -15,12 +16,11 @@ module Cassie::Queries::Statement
       #      end
       def select(table)
         include Relations
-        include Limiting
         include Ordering
         include Fetching
 
         self.table = table
-        self.identifier = :select
+        self.type = :select
 
         yield(self) if block_given?
       end

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

@@ -12,7 +12,7 @@ module Cassie::Queries::Statement
         include Conditions
 
         self.table = table
-        self.identifier = :update
+        self.type = :update
 
         yield(self) if block_given?
       end

data/lib/cassie/queries/statement.rb

@@ -1,5 +1,8 @@
 require 'active_support/core_ext/string/filters'
 require_relative 'statement/preparation'
+require_relative 'statement/callbacks'
+require_relative 'statement/limiting'
+require_relative 'statement/pagination'
 require_relative 'statement/selection'
 require_relative 'statement/deleting'
 require_relative 'statement/updating'
@@ -13,6 +16,9 @@ module Cassie::Queries
 
     included do
       include Preparation
+      include Callbacks
+      include Limiting
+      include Pagination
       include Selection
       include Deleting
       include Updating
@@ -22,7 +28,7 @@ module Cassie::Queries
 
       class << self
         attr_accessor :table
-        attr_accessor :identifier
+        attr_accessor :type
       end
     end
 
@@ -46,10 +52,10 @@ module Cassie::Queries
     protected
 
     def build_cql_and_bindings
-      if identifier
-        send "build_#{identifier}_cql_and_bindings"
+      if type
+        send "build_#{type}_cql_and_bindings"
       else
-        [cql, bindings]
+        raise "No statement type has been declared. Call `.select`, `.update`, `.delete`, or `.insert` to set query type."
       end
     end
 
@@ -68,8 +74,8 @@ module Cassie::Queries
 
     private
 
-    def identifier
-      self.class.identifier
+    def type
+      self.class.type
     end
 
     def eval_if_opt?(value)

data/lib/cassie/query.rb

@@ -13,14 +13,12 @@ module Cassie
   require 'cassandra'
   require_relative 'queries/session'
   require_relative 'queries/statement'
-  require_relative 'queries/pagination'
   require_relative 'queries/instrumentation'
   require_relative 'queries/logging'
 
   class Query
     include Queries::Session
     include Queries::Statement
-    include Queries::Pagination
     include Queries::Instrumentation
     include Queries::Logging
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cassie
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.5
+  version: 1.0.0.alpha.6
 platform: ruby
 authors:
 - Evan Prothro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-08 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cassandra-driver
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -95,13 +109,11 @@ files:
 - lib/cassie/queries/logging/cql_execution_event.rb
 - lib/cassie/queries/logging/logger.rb
 - lib/cassie/queries/logging/subscription.rb
-- lib/cassie/queries/pagination.rb
-- lib/cassie/queries/pagination/cursors.rb
-- lib/cassie/queries/pagination/page_size.rb
 - lib/cassie/queries/session.rb
 - lib/cassie/queries/statement.rb
 - lib/cassie/queries/statement/assignment.rb
 - lib/cassie/queries/statement/assignments.rb
+- lib/cassie/queries/statement/callbacks.rb
 - lib/cassie/queries/statement/conditions.rb
 - lib/cassie/queries/statement/deleting.rb
 - lib/cassie/queries/statement/fetching.rb
@@ -110,6 +122,9 @@ files:
 - lib/cassie/queries/statement/loading.rb
 - lib/cassie/queries/statement/mapping.rb
 - lib/cassie/queries/statement/ordering.rb
+- lib/cassie/queries/statement/pagination.rb
+- lib/cassie/queries/statement/pagination/cursors.rb
+- lib/cassie/queries/statement/pagination/page_size.rb
 - lib/cassie/queries/statement/preparation.rb
 - lib/cassie/queries/statement/preparation/cache.rb
 - lib/cassie/queries/statement/relation.rb

data/lib/cassie/queries/pagination/cursors.rb

@@ -1,15 +0,0 @@
-module Cassie::Queries::Pagination
-  module Cursors
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def max_cursor(field, opts={})
-        relation field, :lteq, opts
-      end
-
-      def since_cursor(field, opts={})
-        relation field, :gt, opts
-      end
-    end
-  end
-end