infopark_component_cache 1.1.0 → 2.0.0

data/lib/infopark_component_cache/guards/delayed_obj_count.rb

@@ -0,0 +1,18 @@
+require "infopark_component_cache/delayed_guard"
+require "infopark_component_cache/guards/obj_count"
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This class is a delayed version of ObjCount guard.
+    # The preconfigured delay is 10 seconds.
+    #
+    # @see DelayedGuard
+    # @see ObjCount
+    class DelayedObjCount < ObjCount
+      include DelayedGuard
+      delay :current_count, for: 10.seconds
+    end
+  end
+end

data/lib/infopark_component_cache/guards/delayed_valid_from.rb

@@ -0,0 +1,18 @@
+require "infopark_component_cache/delayed_guard"
+require "infopark_component_cache/guards/valid_from"
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This class is a delayed version of ValidFrom guard.
+    # The preconfigured delay is 10 seconds.
+    #
+    # @see DelayedGuard
+    # @see ValidFrom
+    class DelayedValidFrom < ValidFrom
+      include DelayedGuard
+      delay :current_min_valid_from, for: 10.seconds
+    end
+  end
+end

data/lib/infopark_component_cache/guards/delayed_valid_until.rb

@@ -0,0 +1,18 @@
+require "infopark_component_cache/delayed_guard"
+require "infopark_component_cache/guards/valid_until"
+
+module InfoparkComponentCache
+  module Guards
+    # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+    #
+    # This class is a delayed version of ValidUntil guard.
+    # The preconfigured delay is 10 seconds.
+    #
+    # @see DelayedGuard
+    # @see ValidUntil
+    class DelayedValidUntil < ValidUntil
+      include DelayedGuard
+      delay :current_min_valid_until, for: 10.seconds
+    end
+  end
+end

data/lib/infopark_component_cache/guards/last_changed.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/guards/cms_state_guard"
 
 module InfoparkComponentCache
   module Guards
@@ -6,7 +6,7 @@ module InfoparkComponentCache
     #
     # This Guard class ensures that the objects in database do not change inbetween.
     # (It caches the newest timestamp and compares it to the current value)
-    class LastChanged < ConsistencyGuard
+    class LastChanged < CmsStateGuard
       def consistent?
         last_changed_known? && no_changes_since?
       end
@@ -32,7 +32,7 @@ module InfoparkComponentCache
 
       # @return [Time] the timestamp of the most recent change to any Obj
       def current_last_changed
-        RailsConnector::DateAttribute.parse(RailsConnector::Obj.maximum(:last_changed))
+        RailsConnector::DateAttribute.parse(scoped_relation.maximum(:last_changed))
       end
     end
   end

data/lib/infopark_component_cache/guards/never_consistent.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/consistency_guard"
 
 module InfoparkComponentCache
   module Guards

data/lib/infopark_component_cache/guards/obj_count.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/guards/cms_state_guard"
 
 module InfoparkComponentCache
   module Guards
@@ -7,7 +7,7 @@ module InfoparkComponentCache
     # This Guard class ensures that the total count of Objs in the database
     # does not change inbetween. (It caches the number of Objs and compares
     # it to the current count)
-    class ObjCount < ConsistencyGuard
+    class ObjCount < CmsStateGuard
       def consistent?
         count_known? && no_changes_since?
       end
@@ -33,7 +33,7 @@ module InfoparkComponentCache
 
       # @return [Fixnum] the number of Objs in the database
       def current_count
-        RailsConnector::Obj.count
+        scoped_relation.count
       end
     end
   end

data/lib/infopark_component_cache/guards/valid_from.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/guards/cms_state_guard"
 
 module InfoparkComponentCache
   module Guards
@@ -6,7 +6,7 @@ module InfoparkComponentCache
     #
     # This guard ensures that any object that becomes valid (through valid_from)
     # will cause inconsistency
-    class ValidFrom < ConsistencyGuard
+    class ValidFrom < CmsStateGuard
       def consistent?
         if min_valid_from_known?
           return no_changes_since?
@@ -36,7 +36,7 @@ module InfoparkComponentCache
 
       # @return [Time] the timestamp of the most recent valid_from, or nil if none found
       def current_min_valid_from
-        str_value = RailsConnector::Obj.where('valid_from > ?', Time.now.to_iso).minimum(:valid_from)
+        str_value = scoped_relation.where('valid_from > ?', Time.now.to_iso).minimum(:valid_from)
         if str_value.present?
           RailsConnector::DateAttribute.parse(str_value)
         else

data/lib/infopark_component_cache/guards/valid_until.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/guards/cms_state_guard"
 
 module InfoparkComponentCache
   module Guards
@@ -6,7 +6,7 @@ module InfoparkComponentCache
     #
     # This guard ensures that any object, whose valid until date has been passed
     # will cause inconsistency.
-    class ValidUntil < ConsistencyGuard
+    class ValidUntil < CmsStateGuard
       def consistent?
         if min_valid_until_known?
           return no_changes_since?
@@ -36,7 +36,7 @@ module InfoparkComponentCache
 
       # @return [Time] the timestamp of the the object that will be deactivated in nearest future
       def current_min_valid_until
-        str_value = RailsConnector::Obj.where('valid_until > ?', Time.now.to_iso).minimum(:valid_until)
+        str_value = scoped_relation.where('valid_until > ?', Time.now.to_iso).minimum(:valid_until)
         if str_value.present?
           RailsConnector::DateAttribute.parse(str_value)
         else

data/lib/infopark_component_cache/guards/value_present.rb

@@ -1,4 +1,4 @@
-require 'infopark_component_cache/consistency_guard'
+require "infopark_component_cache/consistency_guard"
 
 module InfoparkComponentCache
   module Guards

data/lib/infopark_component_cache/version.rb

@@ -1,3 +1,3 @@
 module InfoparkComponentCache
-  VERSION = "1.1.0"
+  VERSION = "2.0.0"
 end

data/lib/infopark_component_cache/volatile_cache.rb

@@ -0,0 +1,13 @@
+require "infopark_component_cache/volatile_cache_storage"
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # This module provides quick an convieniet access to 
+  # VolatileCacheStorage in any class that includes it.
+  module VolatileCache
+    def volatile_cache
+      @__volatile_cache ||= VolatileCacheStorage.instance
+    end
+  end
+end

data/lib/infopark_component_cache/volatile_cache_storage.rb

@@ -0,0 +1,18 @@
+require "infopark_component_cache/abstract_cache_storage"
+
+module InfoparkComponentCache
+  # @author Tomasz Przedmojski <tomasz.przedmojski@infopark.de>
+  #
+  # This class has the exact same interface as CacheStorage
+  # but it does not offer any guarantees regarding persistence
+  # of the cache.
+  # It should be not regarded any more safe than a NullCache.
+  # The primasy use case here is to provide caching where
+  # it is "nice to have" but also has to be extremely quick.
+  class VolatileCacheStorage < AbstractCacheStorage
+    protected
+    def backing_storage
+      @@backing_storage ||= ActiveSupport::Cache::MemoryStore.new({ size: 10.megabytes })
+    end
+  end
+end

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/models/obj.rb

@@ -0,0 +1,2 @@
+class Obj
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/spec/dummy/config/application.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "active_resource/railtie"
+
+Bundler.require(*Rails.groups)
+require "infopark_component_cache"
+
+module Dummy
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+    config.filter_parameters += [:password]
+    config.active_support.escape_html_entities_in_json = true
+    config.active_record.whitelist_attributes = true
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,11 @@
+development: &dummy
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+test:
+  <<: *dummy
+
+cms:
+  <<: *dummy

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,10 @@
+Dummy::Application.configure do
+  config.cache_classes = true
+  config.whiny_nils = true
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.action_dispatch.show_exceptions = false
+  config.action_controller.allow_forgery_protection    = false
+  config.active_record.mass_assignment_sanitizer = :strict
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/secret_token.rb

@@ -0,0 +1 @@
+Dummy::Application.config.secret_token = '4806ad3606eea6388c0428912c8c8b37266f29c4c45fa5ecd233316cd5b6a0016aea879cfa603059a7c00296daef192955e26ae3298830bd904c8ff6a791feb1'

data/spec/dummy/config/initializers/session_store.rb

@@ -0,0 +1 @@
+Dummy::Application.config.session_store :cookie_store, key: '_dummy_session'

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,8 @@
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# Disable root element in JSON by default.
+ActiveSupport.on_load(:active_record) do
+  self.include_root_in_json = false
+end

data/spec/dummy/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => 'welcome#index'
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  # match ':controller(/:action(/:id))(.:format)'
+end

data/spec/dummy/db/schema.rb

@@ -0,0 +1,3 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/spec/lib/delayed_guard_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'infopark_component_cache/delayed_guard'
+
+describe InfoparkComponentCache::DelayedGuard do
+  let(:base_class_with_options) do
+    Class.new do
+      def options
+        {}
+      end
+    end
+  end
+
+  let(:undelayed_class) do
+    Class.new(base_class_with_options) do
+      def simple_counter
+        @simple_counter ||= 0
+        @simple_counter += 1
+      end
+    end
+  end
+
+  let(:delayed_class) do
+    Class.new(undelayed_class) do
+      include InfoparkComponentCache::DelayedGuard
+      delay :simple_counter, for: 1.second
+    end
+  end
+
+  let(:undelayed_subject) { undelayed_class.new }
+  let(:delayed_subject) { delayed_class.new }
+
+  context "with caching disabled" do
+    disable_cache
+
+    specify "the calls are not delayed" do
+      10.times do
+        expect(undelayed_subject.simple_counter).to eq(delayed_subject.simple_counter)
+      end
+    end
+  end
+
+  context "with caching enabled" do
+    enable_cache
+    before { InfoparkComponentCache::VolatileCacheStorage.instance.send(:backing_storage).send(:clear) }
+
+    specify "first call returns the same value" do
+      expect(undelayed_subject.simple_counter).to eq(delayed_subject.simple_counter)
+    end
+
+    specify "following call does return the same value" do
+      first_value = delayed_subject.simple_counter
+      expect(first_value).to eq(undelayed_subject.simple_counter)
+      10.times do
+        expect(delayed_subject.simple_counter).to eq(first_value)
+        expect(undelayed_subject.simple_counter).not_to eq(first_value)
+      end
+    end
+
+    context "after the delay has passed" do
+      specify "the calls returns new value" do
+        first_value = delayed_subject.simple_counter
+        expect(first_value).to eq(undelayed_subject.simple_counter)
+
+        sleep 1
+
+        second_value = delayed_subject.simple_counter
+        expect(second_value).not_to eq(first_value)
+        expect(second_value).to eq(undelayed_subject.simple_counter)
+      end
+    end
+  end
+end