wallet 0.0.1

data/README.rdoc

@@ -0,0 +1 @@
+Wallet is a rails gem that allows you to manage all of your action caching configuration in a single yaml file. It supports TTL.

data/examples/tv/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/examples/tv/app/controllers/channels_controller.rb

@@ -0,0 +1,11 @@
+class ChannelsController < ApplicationController
+ 
+  caches_action :cartoon_network, :expires_in => 10.seconds 
+
+  def cartoon_network
+  end
+
+  def current
+  end
+
+end

data/examples/tv/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/examples/tv/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/examples/tv/config/environment.rb

@@ -0,0 +1,41 @@
+# Be sure to restart your server when you modify this file
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.3' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  # Settings in config/environments/* take precedence over those specified here.
+  # Application configuration should go into files in config/initializers
+  # -- all .rb files in that directory are automatically loaded.
+
+  # Add additional load paths for your own custom dirs
+  # config.load_paths += %W( #{RAILS_ROOT}/extras )
+
+  # Specify gems that this application depends on and have them installed with rake gems:install
+  # config.gem "bj"
+  # config.gem "hpricot", :version => '0.6', :source => "http://code.whytheluckystiff.net"
+  # config.gem "sqlite3-ruby", :lib => "sqlite3"
+  # config.gem "aws-s3", :lib => "aws/s3"
+
+  # Only load the plugins named here, in the order given (default is alphabetical).
+  # :all can be used as a placeholder for all plugins not explicitly named
+  # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+  # Skip frameworks you're not going to use. To use Rails without a database,
+  # you must remove the Active Record framework.
+  # config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
+
+  # Activate observers that should always be running
+  # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+  # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+  # Run "rake -D time" for a list of tasks for finding time zone names.
+  config.time_zone = 'UTC'
+
+  # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+  # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}')]
+  # config.i18n.default_locale = :de
+end

data/examples/tv/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.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 webserver 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.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/examples/tv/config/environments/production.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+config.action_view.cache_template_loading            = true
+
+# See everything in the log (default is :info)
+# config.log_level = :debug
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Use a different cache store in production
+config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false
+
+# Enable threaded mode
+# config.threadsafe!

data/examples/tv/config/environments/test.rb

@@ -0,0 +1,28 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+config.action_view.cache_template_loading            = true
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+# Use SQL instead of Active Record's schema dumper when creating the test database.
+# This is necessary if your schema can't be completely dumped by the schema dumper,
+# like if you have constraints or database-specific column types
+# config.active_record.schema_format = :sql

data/examples/tv/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying do debug a problem that might steem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/examples/tv/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/examples/tv/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/examples/tv/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,19 @@
+# Be sure to restart your server when you modify this file.
+
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/examples/tv/config/initializers/session_store.rb

@@ -0,0 +1,15 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying cookie session data integrity.
+# If you change this key, all old sessions will become invalid!
+# Make sure the secret is at least 30 characters and all random, 
+# no regular words or you'll be exposed to dictionary attacks.
+ActionController::Base.session = {
+  :key         => '_tv_session',
+  :secret      => '91c1045d111179c9c4f12bea2f0539bd547c4e313f9ac11d0b737b60257666d0be6aea4542e620bc51d55635e98d2e1b2c46bdb308ffe3b73fd8fe8d59a811bc'
+}
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# ActionController::Base.session_store = :active_record_store

data/examples/tv/config/initializers/wallet.rb

@@ -0,0 +1 @@
+require 'wallet'

data/examples/tv/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  # map.root :controller => "welcome"
+
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/examples/tv/lib/wallet.rb

@@ -0,0 +1,112 @@
+# Author::    Matt Parker  (mailto:moonmaster9000@gmail.com)
+# License::   Distributes under the same terms as Ruby
+
+class Wallet
+  
+  # This error gets thrown whenever you attempt to retreive a TTL
+  # for an action that's not in the wallet. 
+  class ActionNotCached < Exception
+  end
+
+  attr_reader :config #:nodoc:
+  attr_reader :default_ttl #:nodoc:
+
+  # Pass in a yaml string to this method that represents your configuration. 
+  # Let's assume you have a PagesController with a show action and an index action, 
+  # and let's suppose you would like wallet to default your action cache ttl's to 5 hours. 
+  # Then your yaml might be formatted like so:
+  #   # /path/to/wallet.yml
+  #   
+  #   default_ttl: 5.hours
+  #
+  #   pages:
+  #     show: 
+  #     index: 20.minutes
+  #
+  # That would result in the following values:
+  #   irb> w = Wallet.new File.open("/path/to/wallet.yml")
+  #   irb> w.cached? :pages, :show
+  #   => true
+  #   irb> w.cached? :pages, :index
+  #   => true
+  #   irb> w.cached? :pages, :new
+  #   => false
+  #   irb> w.ttl :pages, :show
+  #   => 300
+  #   irb> w.ttl :pages, :index
+  #   => 1200
+  #   irb> w.ttl :pages, :new
+  #   Wallet::ActionNotCached: You asked for the TTL for the 'new' action in the 'pages' controller, 
+  #   but according to our wallet configuration, that action is not cached.
+  #       from ./lib/wallet/wallet.rb:54:in `ttl'
+  #       from (irb):6
+  def initialize(config_yml="")
+    yml = YAML.load config_yml rescue nil
+    @config = yml || {}
+    @default_ttl = (eval(@config["default_ttl"]).to_i || 60) rescue 60
+  end
+
+  # Returns true or false based on whether or not a controller action is configured for caching in the wallet
+  #   irb> w = Wallet.new "pages:\n  show:"
+  #   irb> w.cached? :pages, :show
+  #   => true
+  def cached?(controller, action)
+    controller, action = stringify_params controller, action
+    @config.has_key?(controller) && 
+      @config[controller].respond_to?(:has_key?) && 
+      @config[controller].has_key?(action)
+  end
+
+  def cached_actions(controller)
+    @config[controller] ? @config[controller].keys : []
+  end
+
+  # Returns the value of the ttl for a controller / action. Throws an exception if the controller/action isn't setup
+  # for caching. 
+  #   irb> w = Wallet.new "pages:\n  show:"
+  #   irb> w.cached? :pages, :show
+  #   => true
+  #   irb> w.ttl :pages, :new
+  #   Wallet::ActionNotCached: You asked for the TTL for the 'new' action in the 'pages' controller, 
+  #   but according to our wallet configuration, that action is not cached.
+  #       from ./lib/wallet/wallet.rb:54:in `ttl'
+  #       from (irb):6
+  def ttl(controller, action)
+    raise ActionNotCached.new("You asked for the TTL for the '#{action}' action in the '#{controller}' controller, but according to our wallet configuration, that action is not cached.") unless cached?(controller, action) 
+    controller, action = stringify_params controller, action
+    if @config[controller][action]
+      (eval(@config[controller][action]).to_i || @default_ttl) rescue @default_ttl
+    else
+      @default_ttl
+    end
+  end
+
+  private
+  def stringify_params(*args)
+    args.map! {|a| a.to_s}
+    return *args
+  end
+
+end
+
+ActionController::Base.class_eval do
+  before_filter :wallet
+  @@action_cached_controllers = {}
+
+  def wallet
+    @wallet ||= Wallet.new((File.open(RAILS_ROOT + "/config/wallet.yml") rescue ""))
+    controller_class_name = self.class.name 
+    controller = controller_class_name.underscore.gsub(/_controller$/, '')
+
+    # if we haven't already setup action caching on this controller
+    if @@action_cached_controllers[controller] == nil
+
+      @@action_cached_controllers[controller] = controller
+      @wallet.cached_actions(controller).each do |action|
+        puts "I'm setting up action caching for #{controller_class_name}::#{action}"
+        controller_class_name.constantize.send :caches_action, action.to_sym, :expires_in => @wallet.ttl(controller, action)
+      end
+    end
+  end
+
+end

data/examples/tv/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/examples/tv/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/lib/wallet/action_controller.rb

@@ -0,0 +1,19 @@
+ActionController::Base.class_eval do
+  before_filter :wallet
+  @@action_cached_controllers = {}
+
+  def wallet
+    @wallet ||= Wallet.new((File.open(RAILS_ROOT + "/config/wallet.yml") rescue ""))
+    controller_class_name = self.class.name 
+    controller = controller_class_name.underscore.gsub(/_controller$/, '')
+
+    # if we haven't already setup action caching on this controller
+    if @@action_cached_controllers[controller] == nil
+      @@action_cached_controllers[controller] = controller
+      @wallet.cached_actions(controller).each do |action|
+        controller_class_name.constantize.send :caches_action, action.to_sym, :expires_in => @wallet.ttl(controller, action)
+      end
+    end
+  end
+
+end if defined?(ActionController::Base)

data/lib/wallet/wallet.rb

@@ -0,0 +1,90 @@
+# Author::    Matt Parker  (mailto:moonmaster9000@gmail.com)
+# License::   Distributes under the same terms as Ruby
+
+class Wallet
+  
+  # This error gets thrown whenever you attempt to retreive a TTL
+  # for an action that's not in the wallet. 
+  class ActionNotCached < Exception
+  end
+
+  attr_reader :config #:nodoc:
+  attr_reader :default_ttl #:nodoc:
+
+  # Pass in a yaml string to this method that represents your configuration. 
+  # Let's assume you have a PagesController with a show action and an index action, 
+  # and let's suppose you would like wallet to default your action cache ttl's to 5 hours. 
+  # Then your yaml might be formatted like so:
+  #   # /path/to/wallet.yml
+  #   
+  #   default_ttl: 5.hours
+  #
+  #   pages:
+  #     show: 
+  #     index: 20.minutes
+  #
+  # That would result in the following values:
+  #   irb> w = Wallet.new File.open("/path/to/wallet.yml")
+  #   irb> w.cached? :pages, :show
+  #   => true
+  #   irb> w.cached? :pages, :index
+  #   => true
+  #   irb> w.cached? :pages, :new
+  #   => false
+  #   irb> w.ttl :pages, :show
+  #   => 300
+  #   irb> w.ttl :pages, :index
+  #   => 1200
+  #   irb> w.ttl :pages, :new
+  #   Wallet::ActionNotCached: You asked for the TTL for the 'new' action in the 'pages' controller, 
+  #   but according to our wallet configuration, that action is not cached.
+  #       from ./lib/wallet/wallet.rb:54:in `ttl'
+  #       from (irb):6
+  def initialize(config_yml="")
+    yml = YAML.load config_yml rescue nil
+    @config = yml || {}
+    @default_ttl = (eval(@config["default_ttl"]).to_i || 60) rescue 60
+  end
+
+  # Returns true or false based on whether or not a controller action is configured for caching in the wallet
+  #   irb> w = Wallet.new "pages:\n  show:"
+  #   irb> w.cached? :pages, :show
+  #   => true
+  def cached?(controller, action)
+    controller, action = stringify_params controller, action
+    @config.has_key?(controller) && 
+      @config[controller].respond_to?(:has_key?) && 
+      @config[controller].has_key?(action)
+  end
+
+  def cached_actions(controller)
+    @config[controller] ? @config[controller].keys : []
+  end
+
+  # Returns the value of the ttl for a controller / action. Throws an exception if the controller/action isn't setup
+  # for caching. 
+  #   irb> w = Wallet.new "pages:\n  show:"
+  #   irb> w.cached? :pages, :show
+  #   => true
+  #   irb> w.ttl :pages, :new
+  #   Wallet::ActionNotCached: You asked for the TTL for the 'new' action in the 'pages' controller, 
+  #   but according to our wallet configuration, that action is not cached.
+  #       from ./lib/wallet/wallet.rb:54:in `ttl'
+  #       from (irb):6
+  def ttl(controller, action)
+    raise ActionNotCached.new("You asked for the TTL for the '#{action}' action in the '#{controller}' controller, but according to our wallet configuration, that action is not cached.") unless cached?(controller, action) 
+    controller, action = stringify_params controller, action
+    if @config[controller][action]
+      (eval(@config[controller][action]).to_i || @default_ttl) rescue @default_ttl
+    else
+      @default_ttl
+    end
+  end
+
+  private
+  def stringify_params(*args)
+    args.map! {|a| a.to_s}
+    return *args
+  end
+
+end

data/lib/wallet.rb

@@ -0,0 +1,2 @@
+require 'wallet/wallet'
+require 'wallet/action_controller'

data/spec/lib_specs/wallet_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Wallet do
+  describe "Wallet::new" do
+    it "should load the config on initialization if provided with a path to a yaml file" do
+      YAML.should_receive(:load).once
+      wallet = Wallet.new(File.open(File.dirname(__FILE__) + '/../support/wallet.yml'))
+      wallet.config.should_not == false
+    end
+    
+    it "should not load the wallet.yml file on initialization if no file is provided" do
+      YAML.should_receive(:load).once
+      wallet = Wallet.new
+      wallet.config.should be_empty
+    end
+
+    it "should set the default_ttl to 60 if no default_ttl: is provided in the config yml" do
+      wallet = Wallet.new
+      wallet.default_ttl.should == 60
+    end
+
+    it "should set the default_ttl to 300 if the default_ttl is set to 5.hours in the config yml" do
+      wallet = Wallet.new "default_ttl: 5.hours"
+      wallet.default_ttl.should == 5.hours.to_i
+    end
+
+    it "should set the default_ttl to 60 seconds if i make a mistake in my default_ttl entry in the config yml" do
+      wallet = Wallet.new "default_ttl: 5.hurs"
+      wallet.default_ttl.should == 60
+    end
+  end
+
+  describe "Wallet::cached?" do
+    before do
+      config_yml = "pages:\n  show:\n"
+      @wallet = Wallet.new config_yml
+    end
+
+    it "should return true for a controller/action that is cached" do
+      @wallet.cached?("pages", "show").should == true
+    end
+
+    it "should return false for a controller/action that is not cached" do
+      @wallet.cached?("blah", "blah").should == false
+      @wallet.cached?("pages", "blah").should == false
+    end
+
+    it "should work with both strings and symbols" do
+      @wallet.cached?("pages", "show").should == true
+      @wallet.cached?(:pages, :show).should == true
+    end
+  end
+
+  describe "Wallet::ttl" do
+    before do
+      config_yml = "pages:\n  show: 5.minute\n  index: "
+      @wallet = Wallet.new config_yml
+    end
+
+    it "should return 5 minutes for the pages:show ttl" do
+      @wallet.ttl(:pages, :show).should == 5.minutes.to_i
+    end
+
+    it "should return the default ttl for the index action" do
+      @wallet.ttl(:pages, :index).should == @wallet.default_ttl
+    end
+
+    it "should raise a ActionNotCached error for the dne action" do
+      proc {@wallet.ttl(:pages, :dne)}.should raise_error(Wallet::ActionNotCached)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$LOAD_PATH << './lib'
+require 'activesupport'
+require 'wallet'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: wallet
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Matt Parker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-21 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: Wallet is a rails gem that allows you to manage all of your action caching configuration in a single yaml file. Supports TTLs.
+email: moonmaster9000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- lib/wallet.rb
+- lib/wallet/action_controller.rb
+- lib/wallet/wallet.rb
+has_rdoc: true
+homepage: http://github.com/moonmaster9000/wallet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Centralized YAML configuration for action caching.
+test_files: 
+- spec/lib_specs/wallet_spec.rb
+- spec/spec_helper.rb
+- examples/tv/app/controllers/application_controller.rb
+- examples/tv/app/controllers/channels_controller.rb
+- examples/tv/app/helpers/application_helper.rb
+- examples/tv/config/boot.rb
+- examples/tv/config/environment.rb
+- examples/tv/config/environments/development.rb
+- examples/tv/config/environments/production.rb
+- examples/tv/config/environments/test.rb
+- examples/tv/config/initializers/backtrace_silencers.rb
+- examples/tv/config/initializers/inflections.rb
+- examples/tv/config/initializers/mime_types.rb
+- examples/tv/config/initializers/new_rails_defaults.rb
+- examples/tv/config/initializers/session_store.rb
+- examples/tv/config/initializers/wallet.rb
+- examples/tv/config/routes.rb
+- examples/tv/lib/wallet.rb
+- examples/tv/test/performance/browsing_test.rb
+- examples/tv/test/test_helper.rb