onesie 1.0.0

data/.autotest

@@ -0,0 +1,5 @@
+require "autotest/restart"
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+end

data/CHANGELOG.rdoc

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2010-08-23
+
+* Birthday!

data/Manifest.txt

@@ -0,0 +1,7 @@
+.autotest
+CHANGELOG.rdoc
+Manifest.txt
+README.rdoc
+Rakefile
+lib/onesie.rb
+test/test_onesie.rb

data/README.rdoc

@@ -0,0 +1,88 @@
+= Onesie
+
+* http://github.com/jbarnette/onesie
+
+== Description
+
+A Rack middleware to make URLs in one-page webapps easier.
+
+In a couple of recent projects, I've needed to avoid full page
+refreshes as much as possible. In the first, I wanted to keep an
+embedded music player active while the user was browsing. In the
+second, I just wanted fancier transitions between pages.
+
+It's possible to do this in an ad-hoc way, but I very quickly got
+tired of hacking things together. Enter Onesie.
+
+Onesie congealed from these requirements:
+
+* I want a one-page web app,
+* But I want the back button to work,
+* And I want search engines to still index some stuff,
+* And I (mostly) don't want to change the way I write a Rails/Sinatra app.
+
+If someone visits <tt>http://example.org/meta/contact</tt>, I want
+them to be redirected to <tt>http://example.org/blah/#/meta/contact</tt>,
+but after the redirection I still want the original route to be
+rendered for search engine indexing, etc.
+
+When Onesie gets a request, it looks to see if under your preferred
+one-page app path ("blah" in the example above). If it's not, Onesie
+sets the current request's path in the session and redirects to your
+app path.
+
+If a request is under the one-page app path, the "real" request's path
+is retrieved from the session and used for subsequent routing and
+rendering. This means that, as above, a request for
+
+    http://example.org/meta/contact
+
+Will be redirected to
+
+    http://example.org/blah/#/meta/contact
+
+But still render the correct action in the wrapped app, even though
+URL fragments aren't passed to the server.
+
+This is a terrible explanation. I'll write a sample app or something
+soon.
+
+== Examples
+
+    require "onesie"
+
+    # in config.ru, after any session support
+    use Onesie
+
+    # in Rails
+
+    unless Rails.env.test?
+      config.middleware.insert_before ActionDispatch::Flash, "Onesie"
+    end
+
+== Installation
+
+    $ gem install onesie
+
+== License
+
+Copyright 2010 John Barnette (code@jbarnette.com)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,15 @@
+require "hoe"
+
+Hoe.plugins.delete :rubyforge
+Hoe.plugin :doofus, :isolate, :git
+
+Hoe.spec "onesie" do
+  developer "John Barnette", "code@jbarnette.com"
+
+  self.extra_rdoc_files = Dir["*.rdoc"]
+  self.history_file     = "CHANGELOG.rdoc"
+  self.readme_file      = "README.rdoc"
+  self.testlib          = :minitest
+
+  extra_deps << ["rack", ">= 1.2"]
+end

data/lib/onesie.rb

@@ -0,0 +1,81 @@
+require "rack/request"
+
+# For any request path that doesn't match <tt>options[:path]</tt>,
+# immediately redirect to <tt>#{options[:path]}/#/#{request-path}</tt>
+# after dropping the original request path in the session. For any
+# request that comes in, matches <tt>options[:path]</tt>, and has a
+# request-path in the session, rewrite the request to match the path
+# info in the session, remove the session copy, and allow the app to
+# route/handle as normal.
+
+class Onesie
+
+  # Duh.
+  VERSION = "1.0.0"
+
+  attr_reader :except, :only, :path
+
+  # Create a new instance of this middleware. +app+ (required) is the
+  # Rack application we're wrapping. Valid +options+:
+  #
+  #     :except  # An Array of prefix strings or Regexps to ignore.
+  #     :log     # A lambda for logging, takes one message arg.
+  #     :only    # An array of prefix strings or Regexps to require.
+  #     :path    # The correct path for the one-page app. Default: "/"
+
+  def initialize app, options = {}
+    @app    = app
+    @except = Array(options[:except]).map { |e| regexpify e }
+    @log    = options[:log]
+    @only   = Array(options[:only]).map   { |o| regexpify o }
+    @path   = options[:path] || "/"
+
+    if FalseClass === @log
+      @log = lambda { |m| }
+    elsif !@log
+      if defined? Rails
+        @log = lambda { |m| Rails.logger.info "  [Onesie] #{m}" }
+      else
+        @log = lambda { |m| puts "[Onesie] #{m}" }
+      end
+    end
+  end
+
+  def call env
+    request = Rack::Request.new env
+    session = env["rack.session"]
+
+    session.delete "onesie.path" if /onesie.clear/ =~ env["REQUEST_URI"]
+
+    allowed = only.empty? || only.any? { |o| o =~ request.path_info }
+    denied  = except.any? { |e| e =~ request.path_info }
+
+    return @app.call env if request.xhr? || !allowed || denied
+
+    if request.path_info == @path
+      path = session.delete("onesie.path") || "/"
+      old_path_info = request.path_info
+
+      env["PATH_INFO"] = env["onesie.path"] = path
+      env["REQUEST_URI"].sub!(/^#{old_path_info}/, path)
+
+      @log.call "actual path is #{path}"
+      return @app.call env
+    end
+
+    session["onesie.path"] = dest = request.path_info
+    request.path_info = @path
+    request.path_info << "/" unless "/" == request.path_info[-1, 1]
+
+    dest = request.url + "##{dest}"
+    @log.call "redirecting to #{dest}"
+
+    [302, { "Location" => dest }, "Redirecting."]
+  end
+
+  protected
+
+  def regexpify thing
+    Regexp === thing ? thing : /^#{Regexp.escape thing}/
+  end
+end

data/test/test_onesie.rb

@@ -0,0 +1,81 @@
+require "minitest/autorun"
+require "onesie"
+
+class TestOnesie < MiniTest::Unit::TestCase
+  def test_initialize
+    app = Onesie.new nil
+
+    assert_equal [], app.except
+    assert_equal [], app.only
+    assert_equal "/", app.path
+  end
+
+  def test_initialize_except
+    app = Onesie.new nil, :except => "/foo"
+    refute_nil app.except.first
+  end
+
+  def test_initialize_only
+    app = Onesie.new nil, :only => "/foo"
+    refute_nil app.only.first
+  end
+
+  def test_call_onesie_clear
+    app     = make_app
+    env     = make_env "REQUEST_URI" => "onesie.clear"
+    session = env["rack.session"]
+
+    session["onesie.path"] = "foo"
+
+    app.call env
+    refute_equal "foo", session["onesie.path"]
+  end
+
+  def test_call_except
+    called = false
+    app    = make_app(:except => "/foo") { called = true }
+    env    = make_env
+
+    env["REQUEST_URI"] = env["PATH_INFO"] = "/bar"
+    status, headers, body = app.call env
+
+    refute called
+    assert_equal 302, status
+    assert_match(/\/bar$/, headers["Location"])
+
+    env["REQUEST_URI"] = env["PATH_INFO"] = "/foo"
+    app.call env
+    assert called
+  end
+
+  def test_call_only
+    called = false
+    app    = make_app(:only => "/foo") { called = true }
+    env    = make_env
+
+    env["REQUEST_URI"] = env["PATH_INFO"] = "/bar"
+    app.call env
+    assert called
+
+    called = false
+    env["REQUEST_URI"] = env["PATH_INFO"] = "/foo"
+    status, headers, body = app.call env
+
+    refute called
+    assert_equal 302, status
+    assert_match(/\/foo$/, headers["Location"])
+  end
+
+  def make_app *args, &block
+    options = Hash === args.last ? args.pop : {}
+    app = args.first || block
+    Onesie.new app, { :log => false }.merge(options)
+  end
+
+  def make_env extras = {}
+    {
+      "rack.session"    => {},
+      "rack.url_scheme" => "http",
+    }.merge extras
+  end
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification 
+name: onesie
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- John Barnette
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-24 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id002
+description: |-
+  A Rack middleware to make URLs in one-page webapps easier.
+  
+  In a couple of recent projects, I've needed to avoid full page
+  refreshes as much as possible. In the first, I wanted to keep an
+  embedded music player active while the user was browsing. In the
+  second, I just wanted fancier transitions between pages.
+  
+  It's possible to do this in an ad-hoc way, but I very quickly got
+  tired of hacking things together. Enter Onesie.
+  
+  Onesie congealed from these requirements:
+  
+  * I want a one-page web app,
+  * But I want the back button to work,
+  * And I want search engines to still index some stuff,
+  * And I (mostly) don't want to change the way I write a Rails/Sinatra app.
+  
+  If someone visits <tt>http://example.org/meta/contact</tt>, I want
+  them to be redirected to <tt>http://example.org/blah/#/meta/contact</tt>,
+  but after the redirection I still want the original route to be
+  rendered for search engine indexing, etc.
+  
+  When Onesie gets a request, it looks to see if under your preferred
+  one-page app path ("blah" in the example above). If it's not, Onesie
+  sets the current request's path in the session and redirects to your
+  app path.
+  
+  If a request is under the one-page app path, the "real" request's path
+  is retrieved from the session and used for subsequent routing and
+  rendering. This means that, as above, a request for
+  
+      http://example.org/meta/contact
+  
+  Will be redirected to
+  
+      http://example.org/blah/#/meta/contact
+  
+  But still render the correct action in the wrapped app, even though
+  URL fragments aren't passed to the server.
+  
+  This is a terrible explanation. I'll write a sample app or something
+  soon.
+email: 
+- code@jbarnette.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- Manifest.txt
+- CHANGELOG.rdoc
+- README.rdoc
+files: 
+- .autotest
+- CHANGELOG.rdoc
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/onesie.rb
+- test/test_onesie.rb
+has_rdoc: true
+homepage: http://github.com/jbarnette/onesie
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: onesie
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Rack middleware to make URLs in one-page webapps easier
+test_files: 
+- test/test_onesie.rb