micro_sessions 0.1.0 → 0.1.1

data/README.rdoc

@@ -10,12 +10,6 @@ For a certain application where you're using number 3, this comes at a cost - th
 
 This could be useful in instances such as a very complex wizard where transmitting the entire history of data RESTfully via param passing may not be feasible, yet you'd still like to support multiple tabs within the same browser window separately.
 
-== In-Progress
-
-This gem is not useable and is being continually worked on.  Will be released as 0.1.0 once reasonably working and stable.
-
-DO NOT USE!
-
 == Installation
 
 This gem requires ActionPack and ActiveSupport 3.0 or greater.
@@ -32,6 +26,12 @@ Simply include the middleware in your controller:
     micro_sessions
   end
 
+From there you will have access to a +micro_session+ object in your controllers and views, just like the +session+ object.
+  
+  def new
+    micro_session[:key] = "Value"
+  end
+
 By default the name of the request parameter used to differentiate micro-sessions is "_msid", though this can be configured:
   
   class ApplicationController
@@ -57,7 +57,15 @@ Session data is accessible to the controller and view through the +micro_session
 When transitioning between pages for which you'd like to keep the micro-session alive, the request parameter must be passed along with any link, form, or redirect.  The preferred way is to make use of the new +:micro_session+ option on available on the +url_for+ helper, which will accept either a specific value or just "true" to use the "current" micro-session to this request:
   
   link_to user_path(@user, :micro_session => true)
-  redirect_to user_project_path([@user, @project], :micro_session => true)
+
+Note that depending on the context in which you're producing this URL, it may not work correctly.  Unfortunately the low-level url_for call in the Rails routing engine does not have access to the controller object (and hence the micro_session object), so I can't make this work outside of simple ActionView helpers.  You can always explicitly include the URL options by calling:
+  
+  micro_session.url_options  # => {"_msid" => "0123456789"}
+
+Can be used something like this:
+  
+  
+  redirect_to user_path(@user, micro_session.url_options)
 
 If you wish to transmit the identifier via a form, be sure to include the hidden field:
   
@@ -66,7 +74,3 @@ If you wish to transmit the identifier via a form, be sure to include the hidden
     ...
   <% end %>
 
-Destroying a micro-session is as easy as:
-  
-  micro_session.destroy
-

data/lib/micro_sessions/micro_session.rb

@@ -13,7 +13,15 @@ module MicroSessions
       @controller.session[options[:key]][id] ||= {}
     end
     
-    delegate :empty?, :[], :[]=, :to_h, :to_hash, :to => :data
+    def url_options
+      if empty?
+        {}
+      else
+        {options[:param] => id}
+      end
+    end
+    
+    delegate :empty?, :[], :[]=, :to_h, :to_hash, :inspect, :to => :data
     
     def id
       @id ||= id_from_params || generate_id

data/lib/micro_sessions/version.rb

@@ -1,3 +1,3 @@
 module MicroSessions
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: micro_sessions
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Ben Hughes
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-23 00:00:00 +03:00
+date: 2010-10-24 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency