ettu 0.0.3 → 0.0.4

data/README.md

@@ -33,15 +33,15 @@ Rails 4 ETags can be used in the following way:
 
 ```ruby
 class ProductsController < ApplicationController
-    def show
-        @product = Product.find(params[:id])
+  def show
+    @product = Product.find(params[:id])
 
-        # Sugar syntax
-        fresh_when @product
+    # Sugar syntax
+    fresh_when @product
 
-        # Hash syntax
-        fresh_when etag: @product, last_modified: @product.updated_at, public: true
-    end
+    # Hash syntax
+    fresh_when etag: @product, last_modified: @product.updated_at, public: true
+  end
 end
 ```
 
@@ -53,23 +53,44 @@ browser.
 
 ### Configuring
 
-Of course, you can override Ettu's behavior. Using a custom js file?
-Just pass in like so:
+Ettu can be disabled for any environment using the `ettu.disabled`
+config option.
 
-    fresh_when @product, js: 'custom.js'
+```ruby
+# config/environments/*.rb
+My::Application.configure do
+  config.ettu.disabled = true
+end
+```
 
-The same things goes for custom css files:
+Of course, you can override Ettu's default behavior:
 
-    fresh_when @product, css: 'custom.css'
+```ruby
+# config/initializers/ettu.rb
+Ettu.configure do |config|
+  # Set the default js file
+  config.js = 'app.js'
+  # Or don't account for javascript
+  # config.js = false
+
+  # Set the default css file
+  config.css = 'style.css'
+  # Or don't account for css
+  # config.css = false
+
+  # Add in extra assets to account for
+  config.assets = ['first.js', 'second.css']
+end
+```
 
-Have several other assets you want to account for? Pass them in as an
-array with the `assets` key:
+Or each can be passed on an individual basis:
 
-    fresh_when @product, assets: ['first.css', 'second.js']
+    fresh_when @product, js: 'app.js', css: 'style.css', assets: 'super.css'
 
-You can specify a template with the `view` key:
+Additionally, you can specify a different template to calculate with the
+`view` option:
 
-    fresh_when @product, "products/index"
+    fresh_when @product, view: "products/index"
 
 You can even stop Ettu from accounting for any of them by setting the
 value to `false`:
@@ -91,17 +112,12 @@ while in the **development** environment. This is not an issue that
 affects staging or production, because the template cache will be
 recreated after each deploy.
 
-In the mean time, you can monkey-patch around this:
+In the mean time, you can enable a monkey-patch with:
 
 ```ruby
 # config/environments/development.rb
-class BlackHole < Hash
-    def []=(k, v); end
-end
-module ActionView
-  class Digestor
-    @@cache = BlackHole.new
-  end
+My::Application.configure do
+  config.ettu.development_hack = true
 end
 ```
 

data/lib/ettu/fresh_when.rb

@@ -1,4 +1,4 @@
-module Ettu
+class Ettu
   module FreshWhen
     extend ActiveSupport::Concern
 
@@ -17,8 +17,7 @@ module Ettu
           etags << ettu.js_etag
           etags << ettu.css_etag
         end
-        assets = ettu.options.fetch(:assets, []).map { |asset| ettu.asset_etag(asset) }
-        etags.concat assets
+        etags.concat ettu.asset_etags
 
         ettu_params = {etag: etags, last_modified: ettu.last_modified}
 

data/lib/ettu/railtie.rb

@@ -1,10 +1,26 @@
-module Ettu
+class Ettu
   class Railtie < Rails::Railtie
-    initializer 'install' do
-      require 'ettu'
+    config.ettu = ActiveSupport::OrderedOptions.new
+
+    initializer 'load' do |app|
+
+      unless app.config.ettu.disabled
+        require 'ettu'
+        ActiveSupport.on_load :action_controller do
+          ActionController::Base.send :include, FreshWhen
+        end
+
+        if app.config.ettu.development_hack
+          class BlackHole < Hash
+            def []=(k, v); end
+          end
+          module ::ActionView
+            class Digestor
+              @@cache = BlackHole.new
+            end
+          end
+        end
 
-      ActiveSupport.on_load :action_controller do
-        ActionController::Base.send :include, FreshWhen
       end
     end
   end

data/lib/ettu/version.rb

@@ -1,3 +1,3 @@
-module Ettu
-  VERSION = '0.0.3'
+class Ettu
+  VERSION = '0.0.4'
 end

data/lib/ettu.rb

@@ -3,6 +3,86 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
 
 require 'ettu/version'
-require 'ettu/ettu'
 require 'ettu/fresh_when'
 require 'ettu/railtie' if defined? Rails
+
+class Ettu
+  attr_reader :options
+
+  class << self
+    @@config = ActiveSupport::OrderedOptions.new
+    @@config.js = 'application.js'
+    @@config.css = 'application.css'
+    @@config.assets = []
+
+    def configure
+      yield @@config
+    end
+  end
+
+  def initialize(record_or_options = nil, additional_options = {})
+    if record_or_options.is_a? Hash
+      @record = nil
+      @options = record_or_options
+    else
+      @record = record_or_options
+      @options = additional_options
+    end
+    @asset_etags = {}
+  end
+
+  def response_etag
+    @options.fetch(:etag, @record)
+  end
+
+  def last_modified
+    @options.fetch(:last_modified, @record.try(:updated_at))
+  end
+
+  def view_etag(view, format, lookup_context)
+    @view_etag ||= view_digest(view, format, lookup_context)
+  end
+
+  def js_etag
+    js = @options.fetch(:js, @@config.js)
+    asset_etag js
+  end
+
+  def css_etag
+    css = @options.fetch(:css, @@config.css)
+    asset_etag css
+  end
+
+  def asset_etags
+    assets = @config.fetch(:assets, @@config.assets)
+    [*assets].map { |asset| asset_etag(asset) }
+  end
+
+  private
+
+  def asset_etag(asset)
+    @asset_etags[asset] ||= asset_digest(asset)
+  end
+
+  # Jeremy Kemper
+  # https://gist.github.com/jeremy/4211803
+  def view_digest(view, format, lookup_context)
+    ActionView::Digestor.digest(
+      view,
+      format,
+      lookup_context
+    )
+  end
+
+  # Jeremy Kemper
+  # https://gist.github.com/jeremy/4211803
+  # Check precompiled asset manifest (production) or compute the digest (dev).
+  def asset_digest(asset)
+    return nil unless asset.present?
+    if manifest = Rails.application.config.assets.digests
+      manifest[asset]
+    else
+      Rails.application.assets[asset].digest
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ettu
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -91,7 +91,6 @@ files:
 - Rakefile
 - ettu.gemspec
 - lib/ettu.rb
-- lib/ettu/ettu.rb
 - lib/ettu/fresh_when.rb
 - lib/ettu/railtie.rb
 - lib/ettu/version.rb

data/lib/ettu/ettu.rb

@@ -1,66 +0,0 @@
-module Ettu
-  class Ettu
-    attr_reader :options
-
-    def initialize(record_or_options = nil, additional_options = {})
-      if record_or_options.is_a? Hash
-        @record = nil
-        @options = record_or_options
-      else
-        @record = record_or_options
-        @options = additional_options
-      end
-      @asset_etags = {}
-    end
-
-    def response_etag
-      @options.fetch(:etag, @record)
-    end
-
-    def last_modified
-      @options.fetch(:last_modified, @record.try(:updated_at))
-    end
-
-    def view_etag(view, format, lookup_context)
-      @view_etag ||= view_digest(view, format, lookup_context)
-    end
-
-    def asset_etag(asset)
-      @asset_etags[asset] ||= asset_digest(asset)
-    end
-
-    def js_etag
-      js = @options.fetch(:js, 'application.js')
-      asset_etag js
-    end
-
-    def css_etag
-      css = @options.fetch(:css, 'application.css')
-      asset_etag css
-    end
-
-    private
-
-    # Jeremy Kemper
-    # https://gist.github.com/jeremy/4211803
-    def view_digest(view, format, lookup_context)
-      ActionView::Digestor.digest(
-        view,
-        format,
-        lookup_context
-      )
-    end
-
-    # Jeremy Kemper
-    # https://gist.github.com/jeremy/4211803
-    # Check precompiled asset manifest (production) or compute the digest (dev).
-    def asset_digest(asset)
-      return nil unless asset.present?
-      if manifest = Rails.application.config.assets.digests
-        manifest[asset]
-      else
-        Rails.application.assets[asset].digest
-      end
-    end
-  end
-end