cardiac 0.2.0.pre3 → 0.2.0.pre5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faafad3cb935e5bb55d912bce4253d8a87167355
-  data.tar.gz: 176df035bb2ab9e4e84d78b85a7608f1d9e7f857
+  metadata.gz: 261e36951731f899ea83b30a9f35c0e69d651abe
+  data.tar.gz: 87e4b496c8d9eb31e1f2c9fb5e06df89a52e27db
 SHA512:
-  metadata.gz: ef4123ec8f187b9bf88850845a01d0678aabd2d5780795948a3fb02c8c03012686f3c67d48ef791b4b3f14af371606a805a6e4de9d99e31b4196b00185965651
-  data.tar.gz: 5ee48420e2b3053599dc737913f1c2aa43a2a2197c07e411ff884be131f4b290c379d1b7b5e1054a521d9954cf858eef49dcf42967d2d261bdef4ed41d9fc994
+  metadata.gz: 832b11c9e2bd6338857f28c5c9bd41d11e58d90aacbfa38b10eb438c165975a35374252c73f3a5038b9c7d2f1f15d44bdf308ef1728c70521606a84ab64be742
+  data.tar.gz: e9b1188718e09854fe9f7448d2c88859b31a5da351b618484acf744413fce97f660ce9464dcf7db3355e535f3fe552e4bdfd8dc6e158e8f501564628069ab0df

data/lib/cardiac/client.rb

@@ -16,8 +16,8 @@ module Cardiac
       def call(env)
         @app.call(env)
       ensure
-        if message = env['rack.errors'].to_s.presence
-          Cardiac::Model::Base.logger.error message
+        if message = env['rack.errors'].string.presence
+          Cardiac::Model::Base.logger.error "cardiac: #{message}"
         end
       end
     end

data/lib/cardiac/log_subscriber.rb

@@ -1,6 +1,8 @@
 module Cardiac
   
   class LogSubscriber < ActiveSupport::LogSubscriber
+    class_attribute :verbose
+    self.verbose = false
     
     delegate :logger, to: '::Cardiac::Model::Base'
 
@@ -13,17 +15,28 @@ module Cardiac
       return unless logger.debug?
 
       payload   = event.payload
-      name, url = payload[:name], payload[:url]
+      name, url, verb, result = *payload.values_at(:name, :url, :verb, :result)
+      
+      cache_trace = result.headers['X-Rack-Client-Cache'] if result
         
       stats = "#{event.duration.round(1)}ms"
-      stats = "CACHED #{stats}" if name!='CACHE' && /fresh/ === payload[:response_headers].try(:[],'X-Rack-Client-Cache')
-      name  = "#{name} #{payload[:verb]} (#{stats})"
-
-      if extra = payload.except(:name, :verb, :url, :response_headers).presence
-        extra = "  " + extra.map{|key,value|
+      stats = "CACHED #{stats}" if cache_trace && name!='CACHE' && /fresh/ === cache_trace
+      name  = "#{name} #{verb} (#{stats})"
+      
+      if extra = payload.except(:name, :verb, :url, :result).presence
+        extra = extra.map{|key,value|
                    key = key.to_s.underscore.upcase
-                   "#{key}: #{key=='PAYLOAD' ? value : value.inspect}"
-                 }.join(",\n\t +")
+                   "\n\t +#{key}: #{key=='PAYLOAD' ? value : value.inspect}"
+                 }
+      end
+      
+      if verbose && result
+        verbosity = Hash===verbose ? verbose : {status: true, cache: true, headers: false, body: false}
+        extra ||= []
+        extra.unshift "\n\t +BODY: #{body.inspect}" if verbosity[:body]
+        extra.unshift "\n\t +HEADERS: #{headers.inspect}" if verbosity[:headers]
+        extra.unshift "CACHE: #{cache_trace}" if verbosity[:cache]
+        extra.unshift result.status if verbosity[:status]
       end
 
       if odd?
@@ -33,7 +46,7 @@ module Cardiac
         name = color(name, MAGENTA, true)
       end
 
-      debug "  #{name}  #{url}#{extra}"
+      debug "  #{name}  #{url}#{'  ['+extra.join('; ')+']' if extra}"
     end
 
     def identity(event)

data/lib/cardiac/model/base.rb

@@ -15,6 +15,7 @@ module Cardiac
       include Cardiac::Model::Callbacks
       include Cardiac::Model::Declarations
       include Cardiac::Model::Operations
+      include Cardiac::Model::CacheDecoration
       include ActiveSupport::Configurable
       
       # Instances may not explicitly define their own base resource.

data/lib/cardiac/model/cache_decoration.rb

@@ -0,0 +1,73 @@
+module Cardiac
+  module Model
+    
+    # Cardiac::Model cache decoration methods.
+    module CacheDecoration
+      extend ActiveSupport::Concern
+      
+      module ClassMethods
+        
+        # The callback to be installed on the adapter.
+        MODEL_CACHE_CONTROL_PROC = Proc.new{|adapter| adapter.klass._model_cache_control(adapter.response) }
+        
+        # Causes all find(..) methods to go through an object-level cache,
+        # which is populated on demand whenever it is needed.
+        #
+        # Pass +false+ to uninstall the model cache.
+        def cache_all! options={}
+          if options
+            @_model_cache_control = (Hash===options ? options : {}).update(expires_at: Time.now)
+            __operation_proxy__.__adapter__.after_execute MODEL_CACHE_CONTROL_PROC
+          else
+            @model_cache = @_model_cache_control = nil
+            __operation_proxy__.__adapter__.skip_callback :execute, :after,  MODEL_CACHE_CONTROL_PROC
+          end
+        end
+        
+        # Internal method that controls the model cache, using the given response object.
+        def _model_cache_control(response)
+          response = Rack::Cache::Response.new(*response.to_a)
+          if response.fresh?
+            @_model_cache_control[:expires_at] = response.expires || (response.date + response.ttl)
+          else
+            @_model_cache_control[:expires_at] = Time.now
+          end
+        end
+    
+      protected
+        
+        # Override this internal method to use a local model cache for retrieving all instances.
+        def find_all(*args, &evaluator)
+          unless @_model_cache_control
+            super
+          else
+            if @model_cache.nil? || @_model_cache_control[:expires_at].past?
+              result = super(*args)
+              sort_by = @_model_cache_control[:sort_by] and result.sort_by!(&sort_by)
+              @model_cache = Hash[result.map{|record| record.readonly! ; record.freeze ; [record.id.to_s, record] }]
+            end
+            evaluator ? @model_cache.values.each(&evaluator) : @model_cache.values
+          end
+        end
+        
+      private
+        
+        # Override this internal method utilize a market cache for retrieving single instances.
+        # TODO: This should not require knowledge of Model::Base internals.
+        #
+        # @see Cardiac::Model::Querying
+        def find_by_identity(id, &evaluator)
+          unless @_model_cache_control
+            super
+          else
+            find_all if @model_cache.nil? || @_model_cache_control[:expires_at].past?
+            record = @model_cache[id.to_s] unless id.nil?
+            evaluator.call(record) if evaluator
+            record
+          end
+        end  
+      end 
+        
+    end
+  end
+end

data/lib/cardiac/model/operations.rb

@@ -4,28 +4,17 @@ module Cardiac
     module Operations
       extend ActiveSupport::Concern
       
-      # Extensions that are applied to the OperationHandler. 
-      module HandlerExtensions
-        def transmit!(*args)
-          super
-        end
-      end
-      
       # Extensions that are applied to the ResourceAdapter.
       module AdapterExtensions
         def __codecs__
           @__codecs__ ||= Module.new{ include ::Cardiac::Representation::Codecs }
         end
-      
-        def __handler__
-          @__handler__ ||= Class.new(::Cardiac::OperationHandler){ include HandlerExtensions; self }
-        end
       end
       
       # Extensions that are applied to the OperationProxy.
       module ProxyExtensions
         def __adapter__
-          @__adapter__ ||= Class.new(::Cardiac::ResourceAdapter){ include AdapterExtensions ; self }
+          @__adapter__ ||= Class.new(::Cardiac::ResourceAdapter){ extend AdapterExtensions ; self }
         end
       end
       
@@ -34,6 +23,7 @@ module Cardiac
       private
         
         # All remote operations go through this method.
+        # The decoded payload is returned, after storing the maximum age as represented by the request.
         def perform_operation(name, *args, &block)
           proxy = __operation_proxy__.new(base_resource)
           proxy.klass = self
@@ -41,7 +31,7 @@ module Cardiac
         end
 
         def __operation_proxy__
-          @__operation_proxy__ ||= Class.new(OperationProxy){ include ProxyExtensions ; self }
+          @__operation_proxy__ ||= Class.new(OperationProxy){ extend ProxyExtensions ; self }
         end
       end
     end

data/lib/cardiac/model/querying.rb

@@ -95,7 +95,9 @@ module Cardiac
       
         # @see ActiveRecord::Persistence#instantiate
         def instantiate(record, options = {})
-          allocate.init_with options.merge('attributes'=>record).stringify_keys
+          record = allocate.init_with options.merge('attributes'=>record).stringify_keys
+          yield record if block_given?
+          record
         end
         
         # See ActiveRecord::Relation::FinderMethods#raise_record_not_found_exception

data/lib/cardiac/model.rb

@@ -13,5 +13,6 @@ module Cardiac
     autoload :Persistence
     autoload :Querying
     autoload :Validations
+    autoload :CacheDecoration
   end
 end

data/lib/cardiac/operation_builder.rb

@@ -67,9 +67,11 @@ module Cardiac
       resolved.result.payload
     end
   
-    def __adapter__
+    def self.__adapter__
       @__adapter__ ||= ::Cardiac::ResourceAdapter
     end
     
+    delegate :__adapter__, to: 'self.class'
+    
   end
 end

data/lib/cardiac/railtie.rb

@@ -28,6 +28,12 @@ module Cardiac
     config.app_middleware.insert_after "::ActionDispatch::Callbacks",
       "Cardiac::ResourceCache::Middleware"
       
+    initializer 'cardiac.log_subscriber' do |app|
+      ActiveSupport.on_load(:cardiac) do
+        Cardiac::LogSubscriber.verbose = app.config.cardiac.verbose
+      end
+    end
+      
     initializer 'cardiac.build_client_middleware' do |app|
       ActiveSupport.on_load(:cardiac) do
         Cardiac::Client.tap do |client|
@@ -45,9 +51,7 @@ module Cardiac
           # NOTE: Certain headers should ALWAYS be ignored by the client.
           if client_cache = app.config.cardiac.client_cache
             client_cache = {} unless Hash===client_cache
-              
-            client_cache[:verbose] = app.config.cardiac.verbose unless client_cache.key? :verbose
-              
+            client_cache[:verbose] = false unless client_cache.key? :verbose
             client_cache[:ignore_headers] = Array(client_cache[:ignore_headers]) + ['Set-Cookie','X-Content-Digest']
               
             client.use Rack::Cache, Hash[ client_cache.map{|k,v| ["rack-cache.#{k}", v] } ]

data/lib/cardiac/resource/adapter.rb

@@ -7,11 +7,11 @@ module Cardiac
   
   # An adapter for performing operations on a resource.
   class ResourceAdapter
-    include ::ActiveSupport::Callbacks
     include Representation::LookupMethods
     include ResourceCache::InstanceMethods
     
-    define_callbacks :resolve, :prepare, :encode, :execute, :decode
+    extend ActiveModel::Callbacks
+    define_model_callbacks :resolve, :prepare, :encode, :execute, :decode
     
     attr_accessor :klass, :resource, :payload, :result
     
@@ -66,7 +66,7 @@ module Cardiac
       resolved? or raise UnresolvableResourceError
       prepared? or prepare! or raise InvalidOperationError
       encode! *arguments
-      execute!
+      execute! &block
     ensure
       decode! if completed?
     end
@@ -120,18 +120,18 @@ module Cardiac
       end
     end
     
-    def execute!
+    def execute! &response_handler
       run_callbacks :execute do
         clear_resource_cache unless request_is_safe?
           
         instrumenter.instrument "operation.cardiac", event=event_attributes do
           if resource_cache_enabled? http_verb
             url, headers = __client_options__.slice(:url, :headers)
-            self.result = cache_resource(url.to_s, headers, event) { transmit! }
+            self.result = cache_resource(url.to_s, headers, event) { transmit!(&response_handler) }
           else
-            self.result = transmit!
+            self.result = transmit!(&response_handler)
           end
-          event[:response_headers] = result.response.headers if result && result.response
+          event[:result] = response if response
         end
             
         completed?
@@ -160,8 +160,8 @@ module Cardiac
 
   private
   
-    def transmit!
-      __handler__.new(__client_options__, payload, &__client_handler__).transmit!
+    def transmit!(&response_handler)
+      __handler__.new(__client_options__, payload, &response_handler).transmit!
     end
    
     def model_name
@@ -176,20 +176,19 @@ module Cardiac
       h.keep_if{|key,value| key==:verb || key==:url || value.present? }
     end
     
-    def __codecs__
+    def self.__codecs__
       @__codecs__ ||= ::Cardiac::Representation::Codecs
     end
   
-    def __handler__
+    def self.__handler__
       @__handler__ ||= ::Cardiac::OperationHandler
     end
     
-    def __client_handler__
-    end
-    
     def __klass_get method_name
       @klass.public_send(method_name) if @klass && @klass.respond_to?(method_name, false)
     end
+    
+    delegate :__codecs__, :__handler__, to: 'self.class'
   end
 
 end

data/lib/cardiac/version.rb

@@ -1,3 +1,3 @@
 module Cardiac
-  VERSION = '0.2.0.pre3'
+  VERSION = '0.2.0.pre5'
 end

data/spec/rails-3.2/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../..
   specs:
-    cardiac (0.2.0.pre3)
+    cardiac (0.2.0.pre4)
       active_attr (>= 0.8.2)
       activemodel (>= 3.2, < 4.1)
       activesupport (>= 3.2, < 4.1)