rails-dev-tweaks 0.3.1 → 0.4.0

data/README.md

@@ -3,23 +3,27 @@ A collection of tweaks to improve your Rails (3.1+) development experience.
 
 To install, simply add it to your gemfile:
 
-    gem 'rails-dev-tweaks', '~> 0.3.1'
+    gem 'rails-dev-tweaks', '~> 0.4.0'
 
 At the moment, the current tweaks center around speeding up requests by giving granular control over which requests
-cause the Rails autoloader to kick in:
+cause the Rails reloader to kick in.
 
 
-# Granular Autoload
-Rails' autoloading facility is a wonderful help for development mode, but sometimes it's a little overkill and ends up
-hampering your rate of iteration while developing a Rails app.  rails-dev-tweaks introduces granular control over which
-kinds of requests are autoloaded.
+## Intended Usage
+This gem is intended to provide a default configuration that covers most rails apps.  You should be aware of some of
+the more imposing defaults, in case they don't jive with your workflow.  Important points of note:
+
+* _All_ asset requests _will not_ reload your app's code.  This is probably only a problem if you are using custom sass
+  functions, or otherwise referencing your app from within assets.
+
+* _All_ XHR requests _will not_ reload your app's code until you make a regular content request!  The assumption is
+  that you generally do not debug XHR responses without reloading the base page first.
 
-However, why should you use request-based autoload control instead of smart autoloaders that check file modification
-times, such as [rails-dev-boost](https://github.com/thedarkone/rails-dev-boost)?  The primary worry with smart
-autoloaders is that they have an extremely difficult time tracking all dependencies of a particular constant.  This can
-result in extremely confusing and difficult to debug issues; Theoretically, request-based autoloading should be a bit
-less finicky.
+If any of these points don't work out for you, don't fret!  You can override the defaults with some simple
+configuration tweaks to your environment.  Read on:
 
+
+# Granular Autoload
 You can specify autoload rules for your app via a configuration block in your application or environment configuration.
 These rules are specified via exclusion (`skip`) and inclusion (`keep`).  Rules defined later override those defined
 before.
@@ -44,6 +48,7 @@ The default autoload rules should cover most development patterns:
 
       skip '/favicon.ico'
       skip :assets
+      skip :xhr
       keep :forced
     end
 
@@ -64,10 +69,6 @@ packager is mounted using the traditional Rails dispatching infrastructure, it's
 (unloader). This matcher will match any requests that are routed to Sprockets (specifically any mounted
 Sprockets::Environment instance).
 
-_The downside_ to this matcher is that your Rails environment won't reload until you make a regular request to the dev
-server (which should be your usual request pattern, anyway).  Assets still reload properly (unless you're referencing
-your application's Ruby code).
-
 ### :forced
 To aid in live-debugging when you need to, this matcher will match any request that has `force_autoload` set as a
 parameter (GET or POST), or that has the `Force-Autoload` header set to something.

data/lib/rails_dev_tweaks/configuration.rb

@@ -11,6 +11,7 @@ class RailsDevTweaks::Configuration
 
       skip '/favicon.ico'
       skip :assets
+      skip :xhr
       keep :forced
     end
   end

data/lib/rails_dev_tweaks/version.rb

@@ -1,4 +1,4 @@
 module RailsDevTweaks
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-dev-tweaks
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &2167156100 !ruby/object:Gem::Requirement
+  requirement: &2158338760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,7 +22,7 @@ dependencies:
         version: 3.1.0.rc4
   type: :runtime
   prerelease: false
-  version_requirements: *2167156100
+  version_requirements: *2158338760
 description: A collection of tweaks to improve your Rails (3.1+) development experience.
 email:
 - info@wavii.com
@@ -56,18 +56,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1289302315746076260
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1289302315746076260
 requirements: []
 rubyforge_project: rails-dev-tweaks
 rubygems_version: 1.6.2