sinatra-support 1.0.1 → 1.0.2

data/HISTORY.md

@@ -1,3 +1,13 @@
+v1.0.2 - Mar 29, 2011
+---------------------
+
+### Added:
+  * Implement CssSupport's `css_aggressive_mtime` directive
+
+### Minor changes:
+  * Update I18n helpers documentation
+  * Update documentation for JsSupport and CssSupport
+
 v1.0.1 - Mar 27, 2011
 ---------------------
 

data/lib/sinatra/support/csssupport.rb

@@ -17,7 +17,7 @@
 # This plugin supports Sass, Less and SCSS and guesses by the
 # file name.
 #
-# == Caveats
+# == Sass caveats
 #
 # Note that you will need to set your Sass/SCSS +load_path+ settings.
 #
@@ -28,9 +28,31 @@
 #     m.set :scss, self.scss.merge(:style => :compressed) if m.production?
 #   end
 #
+# == Less caveats
+#
+# If you're using Less, it's best you separate your CSS into many files,
+# as Less is pretty slow. By default however, CssSupport will ask browsers
+# to recache all CSS files even when one is changed, which is to your
+# disadvantage considering Less's speed.
+#
+# You can disable this behavior so that browsers will only fetch CSS files
+# that changed.
+#
+#   register Sinatra::CssSupport
+#   Main.set :css_aggressive_mtime, false
+#
+# == Settings
+#
+# [+css_max_age+]            The maximum time (in seconds) a browser
+#                            should hold onto a cached copy.
+#                            (default: 30 days)
+# [+css_aggressive_mtime+]   If true, ask browsers to recache all CSS files
+#                            when one is updated. Default: true
+#                     
 module Sinatra::CssSupport
   def self.registered(app)
     app.set :css_max_age, app.development? ? 0 : 86400*30
+    app.set :css_aggressive_mtime, true
   end
 
   def serve_css(url_prefix, options={})
@@ -41,7 +63,13 @@ module Sinatra::CssSupport
       fname = Dir[File.join(prefix, "#{name}.{css,scss,less}")].first  or pass
 
       content_type :css, :charset => 'utf-8'
-      last_modified File.mtime(fname)
+
+      if settings.css_aggressive_mtime
+        last_modified Dir[prefix, "**/*"].map { |f| File.mtime(f).to_i }.max
+      else
+        last_modified File.mtime(fname)
+      end
+
       cache_control :public, :must_revalidate, :max_age => settings.css_max_age
 
       if fname =~ /\.scss$/
@@ -56,3 +84,4 @@ module Sinatra::CssSupport
     end
   end
 end
+

data/lib/sinatra/support/i18nsupport.rb

@@ -8,19 +8,20 @@
 #     set :default_locale, 'fr'  # Optional; defaults to 'en'
 #   end
 #
-# Be sure that you have the +I18n+ gem.
+# Be sure that you have the +I18n+ gem. Use +gem install i18n+, or if you're
+# using Bundler:
 #
 #   # Gemfile
 #   gem "i18n"
 #
-# (or +gem install i18n+)
-#
 # Then put your locale YAML files into +./config/locales+ (whatever path you
 # use for {#load_locales}:
 #
 #   # config/locales/en.yml
 #   en:
 #     an_article: "An article"
+#     create: "Create"
+#     delete: "Delete"
 #
 # == Helpers
 #
@@ -67,21 +68,20 @@
 # == Locale files
 #
 # This gem does not ship with default options for time, date and such.
-# You may want to get those from:
-#
-#   https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale
+# You may want to get those from the Rails-I18n project:
+# https://github.com/svenfuchs/rails-i18n/tree/master/rails/locale
 # 
 # == Using a different backend
 #
 # Instead of calling {#load_locales}, just load the right I18n backend
 # using the I18n gem.
 #
-# You can also just use I18n.store_translations if you still want to use
+# You can also just use +I18n.store_translations+ if you still want to use
 # the default simple I18n backend.
 #
 # == Settings
 #
-# [+default_locale+]    The locale to use by default. Defaults to +"en"+.
+# [+default_locale+]    The locale to use by default. Defaults to +en+.
 #
 module Sinatra::I18nSupport
   def self.registered(app)

data/lib/sinatra/support/jssupport.rb

@@ -4,16 +4,18 @@
 #
 #   require 'sinatra/support/jssupport'
 #
-# Use {#serve_js} in the Sinatra DSL to serve up files.
+#   class Main < Sinatra::Base
+#     register Sinatra::JsSupport
+#     serve_js '/js', from: './app/js'
+#   end
 #
-#   register Sinatra::JsSupport
-#   serve_js '/js', from: './app/js'
-#
-# Assuming you have a +app/js/jquery.js+ file, you will
-# then be able to access it from the given URL prefix.
+# You'll be able to access files via +/js+:
 #
+#   # This will serve /app/js/jquery.js. (or .coffee)
 #   $ curl "http://localhost:4567/js/jquery.js"
 #
+# == CoffeeScript support
+#
 # This plugin supports CoffeeScript. To use it, simply
 # add a CoffeeScript file in the JS file path.
 #
@@ -22,7 +24,12 @@
 #
 #   $ curl "http://localhost:4567/js/application.js"
 #
-# To use CoffeeScript, you will need the +coffee_script+ gem.
+# To use CoffeeScript, install the +coffee_script+ gem.
+# If you're using Bundler, that is:
+#
+#   # Gemfile
+#   gem "coffee-script", require: "coffee_script"
+#
 #
 module Sinatra::JsSupport
   def self.registered(app)

data/lib/sinatra/support/version.rb

@@ -1,6 +1,6 @@
 module Sinatra
   module Support
-    VERSION = "1.0.1"
+    VERSION = "1.0.2"
 
     def self.version
       VERSION

metadata

@@ -2,7 +2,7 @@
 name: sinatra-support
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors: 
 - Cyril David
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-27 00:00:00 +08:00
+date: 2011-03-29 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency