butler_static 0.0.7 → 0.0.8.alpha.20

data/README.md

@@ -1,6 +1,20 @@
 # Butler
 
-TODO: Write a gem description
+Butler is a Rack Web Server for Static Files based on ActionDispatch::Static.
+It is intended to be used as a Rails Middleware in an environment where serving static assets through a specialized web server such as nginx is technically not an option.
+
+### Background
+
+Butler extends ActionDispatch::Static's functionality to allow a the developer to set custom rules for the HTTP headers that the files sent should carry.
+
+The author's intent was to allow Rails to serve static assets with custom HTTP Headers.
+This allows for example serving webfonts or icon fonts carrying the appropriate HTTP headers via a Content Delivery Network (CDN) such as Amazon's Cloudfront. Files requested by the CDN will need to carry the headers the file should be sent with to the visitor's browser already when being sent from the web server.
+
+ActionDispatch::Static, Rack::Static et al. don't allow (yet) to add custom HTTP headers to files because the underlying Rack::File implementation only allows for setting a static 'Cache-Control' header.
+
+Code and Tests taken from Rails' ActionDispatch::Static.
+
+If no matching file can be found in the precompiled assets the request will bubble up to the Rails stack to decide how to handle it, which mimicks ActionDispatch::Static's behaviour.
 
 ## Installation
 
@@ -18,12 +32,94 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+```ruby
+# config/environment/production.rb
+
+# Use Butler
+# to serve precompiled assets
+config.assets.use_butler = true
+
+# Rules for HTTP Headers to be set on files
+# sent by Butler
+config.assets.header_rules = {
+  rule => {http_field => content},
+  rule => {http_field => content}
+}
+```
+
+### Providing Rules for setting HTTP Headers
+
+There are a few way to set rules for all files or files in a certain folder or a certain extension.
+
+```ruby
+  # 1) Global Rules
+  :global => Matches every file
+  Ex.: :global => {
+        'Cache-Control' => 'public, max-age=31536000', # 1 year
+        'Some Custom Header' => 'Some Custom Content'
+      }
+
+  # 2) Folders
+  '/folder' => Matches all files in a certain folder
+  '/folder/subfolder' => ...
+    Note: Provide the folder as a string,
+         with or without the starting slash
+  Ex.: '/fonts' => {'Access-Control-Allow-Origin' => '*'}
+
+  # 3) File Extensions
+  ['css', 'js'] => Will match all files ending in .css or .js
+  %w(css js) => ...
+    Note: Provide the file extensions in an array,
+         use any ruby syntax you like to set that array up
+  Ex.: %w(eot ttf otf woff svg) => {... => ...}
+
+  # 4) Regular Expressions / Regexp
+  %r{\.(?:css|js)\z} => will match all files ending in .css or .js
+  /\.(?:eot|ttf|otf|woff|svg)\z/ => will match all files ending
+    in the most common web font formats
+
+  # 5) Shortcuts
+  There is currently only one shortcut defined.
+  :fonts => will match all files ending in eot, ttf, otf, woff, svg
+    using the Regexp stated above
+  Ex.: :fonts => {'Access-Control-Allow-Origin' => '*'} # Will allow fonts and icon fonts to be displayed in Firefox 3.5+
+
+
+  Note: The rules will be applied in the order the are listed,
+       thus more special rules further down below can override
+       general global HTTP header settings
+```
+
+## Complete Example Use Case
+
+The example code below is from a Rails app deployed to [Heroku](http://www.heroku.com) using butler to serve the precompiled assets.
+Cache-Control headers are set on all served files, and Access-Control Headers on Fonts / Icon Fonts.
+
+```ruby
+# config/environment/production.rb
+
+# Use Butler
+# to serve precompiled assets
+config.assets.use_butler = true
+
+# Rules for HTTP Headers
+# to be set on static files sent by Butler
+config.assets.header_rules = {
+  :global => {'Cache-Control' => 'public, max-age=31536000'},
+  :fonts  => {'Access-Control-Allow-Origin' => '*'}
+}
+```
+That's it. I hope you like Butler.
+Shoot me an [email](github@tklemm.eu) or [tweet](https://www.twitter.com/thomasjklemm) if you have any questions or thoughts about how to improve Butler. Enjoy your life!
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+3. Improve Butler
+3a. Run tests continually (`bundle exec guard start`) or manually every time (`rake test`)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -3,6 +3,7 @@ require 'bundler/gem_tasks'
 
 # Tests
 require 'guard'
+desc "Run all tests"
 task :test do
   Guard.setup
   Guard.guards('minitest').run_all

data/butler.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |gem|
   gem.version       = Butler::VERSION
   gem.authors       = ["Thomas Klemm"]
   gem.email         = ["github@tklemm.eu"]
-  gem.description   = "Butler is a Rack Middleware that serves static assets for your Rails app."
-  gem.summary       = "Butler is a Rack Middleware that serves static assets for your Rails app. It allows you to set HTTP headers for individual files or folders based on rules."
+  gem.description   = "Butler is a Rack Middleware that serves static assets for your Rails app. It allows you to set HTTP headers for individual files or folders based on rules."
+  gem.summary       = "butler_static-#{ Butler::VERSION }"
   gem.homepage      = "https://github.com/thomasklemm/butler"
 
   gem.files         = `git ls-files`.split($/)
@@ -19,6 +19,7 @@ Gem::Specification.new do |gem|
 
   # Dependencies
   gem.add_dependency 'rack'
+  gem.add_dependency 'rails', '>= 3.1.0'
 
   # Tests
   gem.add_development_dependency 'minitest'
@@ -26,6 +27,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'turn'
   # Only ActiveSupport and ActionController nescessary
   # gem.add_development_dependency 'rails', '~> 3.2.8'
-  gem.add_development_dependency 'activesupport', '~> 3.2.8'
-  gem.add_development_dependency 'actionpack', '~> 3.2.8'
+  # gem.add_development_dependency 'activesupport', '~> 3.2.8'
+  # gem.add_development_dependency 'actionpack', '~> 3.2.8'
 end

data/lib/butler.rb

@@ -2,7 +2,7 @@ require 'butler/version'
 require 'butler/static'
 require 'butler/handler'
 require 'butler/asset'
-require 'butler/railtie'
+require 'butler/railtie' if defined? Rails
 
 module Butler
   # Butler

data/lib/butler/railtie.rb

@@ -1,6 +1,30 @@
-require 'butler'
-
 module Butler
-  class Railtie < Rails::Railtie
+  class Railtie < ::Rails::Railtie
+    puts 'Processing Railtie...'
+    # config.butler = ActiveSupport::OrderedOptions.new # enable namespaced configuration in Rails environments
+
+    # # Config
+    # use_butler   = Rails.application.config.assets.use_butler || nil
+    # path         = Rails.application.config.paths['public'].first
+
+    # header_rules = Rails.application.config.assets.header_rules || {}
+    # options      = { header_rules: header_rules }
+
+    initializer "butler.configure_rails_initialization" do |app|
+      app.middleware.swap 'ActionDispatch::Static', 'Butler::Static'
+      raise app.inspect
+      # if use_butler
+      #   if defined? ActionDispatch::Static
+      #     if defined? Rack::Cache # will not work
+      #       app.config.middleware.delete ActionDispatch::Static
+      #       app.config.middleware.insert_before Rack::Cache, Butler::Static, path, options
+      #     else
+      #       app.config.middleware.swap ActionDispatch::Static, Butler::Static, path, options
+      #     end
+      #   else
+      #     app.config.middleware.use Butler::Static, path, options
+      #   end
+      # end
+    end
   end
 end

data/lib/butler/static.rb

@@ -34,7 +34,8 @@ module Butler
   # the request will bubble up to the Rails stack to decide
   # how to handle it
   #
-  # Usage:
+  # Usage with Rails:
+  #  # config/environment/production.rb
   #  config.middleware.delete ActionDispatch::Static
   #  config.middleware.insert_before Rack::Cache, Butler::Static
   #
@@ -75,13 +76,12 @@ module Butler
   #        general global HTTP header settings
   #
   class Static
-    def initialize(app, path=nil, options={})
-      @app = app
-      path ||= Rails.application.config.paths['public'].first if defined? Rails
-      header_rules = {}
-      header_rules = Rails.application.config.assets.header_rules if defined? Rails
-      header_rules = options[:header_rules] if options[:header_rules]
-      @file_handler = Butler::Handler.new(path, header_rules: header_rules)
+    def initialize(app, path, options={})
+      @app = app # Rails app
+      config = {}
+      # Rules for setting HTTP Headers on files
+      config[:header_rules] = options[:header_rules] if options[:header_rules]
+      @file_handler = Butler::Handler.new(path, config)
     end
 
     def call(env)

data/lib/butler/version.rb

@@ -1,3 +1,3 @@
 module Butler
-  VERSION = "0.0.7"
-end
+  VERSION = "0.0.8.alpha.20"
+end

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: butler_static
 version: !ruby/object:Gem::Version
-  version: 0.0.7
-  prerelease: 
+  version: 0.0.8.alpha.20
+  prerelease: 6
 platform: ruby
 authors:
 - Thomas Klemm
@@ -28,23 +28,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.1.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
-  name: guard-minitest
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: turn
+  name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -76,39 +76,24 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.8
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 3.2.8
-- !ruby/object:Gem::Dependency
-  name: actionpack
+  name: turn
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: '0'
 description: Butler is a Rack Middleware that serves static assets for your Rails
-  app.
+  app. It allows you to set HTTP headers for individual files or folders based on
+  rules.
 email:
 - github@tklemm.eu
 executables: []
@@ -175,16 +160,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>='
+  - - ! '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: Butler is a Rack Middleware that serves static assets for your Rails app.
-  It allows you to set HTTP headers for individual files or folders based on rules.
+summary: butler_static-0.0.8.alpha.20
 test_files:
 - spec/butler/asset_spec.rb
 - spec/butler/files/index.html