firebolt 0.9.0 → 0.9.1

data/README.md

@@ -1,6 +1,6 @@
 # Firebolt
 
-Firebolt is a simple cache warmer. It warms the cache using a specially defined warmer class. It also has an optional file-based warmer.
+Firebolt is a simple cache warmer. It warms the cache using a specially defined warmer class. It also has an optional file-based warmer to make boot-time fast!
 
 It's not quite ready for Prime Time™ and needs specs (YIKES!). Feel free add some, if you like...
 
@@ -20,16 +20,50 @@ Or install it yourself as:
 
 ## Usage
 
-To use Firebolt, you first need to configure it:
+To use Firebolt, you first need to configure it.
+
+#### Configure & Initialize!
+
+```Ruby
+::Firebolt.configure do |config|
+  # Required
+  config.cache = ::Rails.cache # Or anything that adheres to Rails's cache interface
+  config.warming_frequency = 12.hours # In seconds. Get minutes/hours/days helper w/ ActiveSupport
+  config.warmer = ::YourAwesomeCacheWarmer
+
+  # Optional
+  config.cache_file_enabled = true # Automatically enabled when cache_file_path is set
+  config.cache_file_path = '/path/to/your/project/tmp' # Defaults to /tmp
+end
+```
+
+Then you need to initialize it:
 
 ```Ruby
-::Firebolt.initialize! do |firebolt_config|
-  firebolt_config.cache = ::Rails.cache
-  firebolt_config.frequency = 12.hours
-  firebolt_config.warmer = ::YourAwesomeCacheWarmer
+# Calling initialize! starts the warming cycle.
+# It's best to skip the warming cycle while running specs. Warming is
+# automatically skipped while running specs in Rails apps. In other apps, set
+# FIREBOLT_SKIP_WARMING to true (or 1, or 'sandwich').
+::Firebolt.initialize!
+
+# Also takes a block so you can initialize and configure at the same time:
+::Firebolt.initialize! do |config|
+  config.cache = ::Rails.cache
+  config.warming_frequency = 12.hours
+  config.warmer = ::YourAwesomeCacheWarmer
 end
 ```
 
+#### Reading cached data
+
+Firebolt provides two methods for retrieving cached data: `Firebolt.read` & `Firebolt.fetch`.
+
+`Firebolt.read` takes your cache key and return the value from the cache.
+
+`Firebolt.fetch` does the same thing, but also takes an optional block that is called when there is a cache miss.
+
+#### Warming the cache
+
 Firebolt uses a cache warmer that you create. Valid cache warmers must:
 
 1. Include `Firebolt::Warmer`
@@ -47,7 +81,15 @@ class YourAwesomeCacheWarmer
 end
 ```
 
-More documentation coming soon...
+Firebolt uses this warmer to re-warm the cache at the frequency you configure (e.g. `config.warming_frequency`). If it's set to re-warm every 12 hours, Firebolt will warm the cache every twelve hours.
+
+Under the hood, Firebolt keeps track of the current cache set. That way, it's able to warm a new cache set and swap it with the old cache set in place, avoiding cache misses.
+
+#### The file warmer
+
+Firebolt is built to be fast and unobtrusive, but sometimes warming a cache can take some time. That's where the file warmer comes in. When the file warmer is enabled, after warming the cache, Firebolt will write the cached data to a file. The next time your app starts up, it will warm the cache from the file. Each subsequent warming happens with your custom warmer.
+
+To use file warmer, simply set the `cache_file_enabled` and `cache_file_path` config options.
 
 ## Contributing
 

data/lib/firebolt/railtie.rb

@@ -0,0 +1,23 @@
+module Firebolt
+  class Railtie < Rails::Railtie
+    initializer "firebolt.rails.configuration" do |app|
+      # Configure Firebolt
+      ::Firebolt.configure do |config|
+        app.config.firebolt.each do |config_key, config_value|
+          config_setter = "#{config_key}="
+          config.__send__(config_setter, config_value) if config.respond_to?(config_setter)
+        end
+
+        # Set defaults based on Rails
+        config.cache ||= ::Rails.cache
+        config.cache_file_path ||= ::File.join(::Rails.root, 'tmp')
+      end
+    end
+
+    # Load Firebolt Rake tasks
+    rake_tasks do
+      # load 'firebolt/tasks/cache.rake'
+      load ::File.join('firebolt', 'tasks', 'cache.rake')
+    end
+  end
+end

data/lib/firebolt/version.rb

@@ -1,3 +1,3 @@
 module Firebolt
-  VERSION = "0.9.0"
+  VERSION = "0.9.1"
 end

data/lib/firebolt.rb

@@ -9,9 +9,10 @@ require "firebolt/cache_worker"
 require "firebolt/config"
 require "firebolt/warmer"
 require "firebolt/file_warmer"
-
 require "firebolt/version"
 
+require "firebolt/railtie" if defined?(::Rails::Railtie)
+
 module Firebolt
   extend ::Firebolt::Cache
 
@@ -41,9 +42,11 @@ module Firebolt
   end
 
   def self.initialize_rufus_scheduler
-    frequency = ::Rufus.to_time_string(config.warming_frequency)
+    return if config.warming_frequency.nil?
+
+    warming_frequency = ::Rufus.to_time_string(config.warming_frequency)
 
-    ::Rufus::Scheduler.start_new.every(frequency) do
+    ::Rufus::Scheduler.start_new.every(warming_frequency) do
       ::SuckerPunch::Queue[:firebolt_queue].async.perform(config.warmer)
     end
   end
@@ -55,7 +58,6 @@ module Firebolt
 
     raise "Firebolt.config.cache has not been set" unless config.cache
     raise "Firebolt.config.warmer has not been set" unless config.warmer
-    raise "Firebolt.config.warming_frequency has not been set" unless config.warming_frequency
 
     configure_sucker_punch
     initialize_rufus_scheduler

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: firebolt
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
   prerelease: 
 platform: ruby
 authors:
@@ -96,6 +96,7 @@ files:
 - lib/firebolt/config.rb
 - lib/firebolt/file_warmer.rb
 - lib/firebolt/keys.rb
+- lib/firebolt/railtie.rb
 - lib/firebolt/tasks/cache.rake
 - lib/firebolt/version.rb
 - lib/firebolt/warmer.rb
@@ -114,7 +115,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3262743682020511243
+      hash: 553194532783204057
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -123,10 +124,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3262743682020511243
+      hash: 553194532783204057
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Firebolt is a simple cache warmer. It warms the cache using a specially defined