micro_sessions 0.3.0 → 0.4.0

data/spec/features/persisting_session_using_links_spec.rb

@@ -0,0 +1,23 @@
+require 'rails_helper'
+
+RSpec.describe 'persisting storage using links' do
+  context 'when clicking a MicroSession link' do
+    it 'persists the session between different pages' do
+      visit '/mutants'
+
+      click_link 'micro_session_link'
+
+      expect(page).to have_content 'Wolverine'
+    end
+  end
+
+  context 'when clicking a Rails standard link' do
+    it 'does not persist the session between different pages' do
+      visit '/mutants'
+
+      click_link 'rails_standard_link'
+
+      expect(page).to_not have_content 'Wolverine'
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,17 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'spec_helper'
+require File.expand_path('../dummy/init', __FILE__)
+
+# Prevent database truncation if the environment is production
+abort('The Rails environment is running in production mode!') if Rails.env.production?
+
+require 'rspec/rails'
+require 'capybara/rspec'
+
+RSpec.configure do |config|
+  config.include Capybara::DSL
+
+  config.infer_spec_type_from_file_location!
+  config.filter_rails_from_backtrace!
+end

data/spec/spec_helper.rb

@@ -1,9 +1,18 @@
-require "rubygems"
-require "rspec"
-require "active_support"
-require "action_pack"
-require "micro_sessions"
-
 RSpec.configure do |config|
-  config.raise_errors_for_deprecations!
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.expose_dsl_globally = true
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.profile_examples = 10
+  config.order = :random
+
+  Kernel.srand config.seed
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: micro_sessions
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ben Hughes
+- Santiago Doldan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2017-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,23 +17,23 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
     - - "<="
       - !ruby/object:Gem::Version
-        version: 4.1.1
+        version: '5.1'
 description: Provides 'micro-sessions' within the global sessions object keyed off
   an identifier.
-email: ben@railsgarden.com
+email: santiagodolte@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -41,19 +42,30 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
+- lib/micro_session/engine.rb
+- lib/micro_session/store.rb
+- lib/micro_session/version.rb
 - lib/micro_sessions.rb
-- lib/micro_sessions/controller.rb
-- lib/micro_sessions/helpers.rb
-- lib/micro_sessions/micro_session.rb
-- lib/micro_sessions/railtie.rb
-- lib/micro_sessions/version.rb
-- spec/controller_spec.rb
-- spec/helpers_spec.rb
+- spec/controllers/humans_controller_spec.rb
+- spec/controllers/mutants_controller_spec.rb
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/controllers/humans_controller.rb
+- spec/dummy/app/controllers/mutants_controller.rb
+- spec/dummy/app/views/humans/index.html.erb
+- spec/dummy/app/views/mutants/index.html.erb
+- spec/dummy/app/views/mutants/show.html.erb
+- spec/dummy/config/database.yml
+- spec/dummy/config/routes.rb
+- spec/dummy/init.rb
+- spec/dummy/log/test.log
+- spec/features/persisting_session_using_links_spec.rb
+- spec/rails_helper.rb
 - spec/spec_helper.rb
-homepage: http://github.com/rubiety/micro_sessions
-licenses: []
+homepage: http://github.com/santiagodoldan/micro_sessions
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -63,7 +75,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -71,7 +83,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Keyed sessions within the global sessions object.

data/README.rdoc

@@ -1,80 +0,0 @@
-{<img src="https://secure.travis-ci.org/rubiety/micro_sessions.png?branch=master" alt="Build Status" />}[http://travis-ci.org/rubiety/micro_sessions]
-
-== Micro Sessions
-
-In terms of passing data amongst HTTP requests there are really two options:
-* Param or form data passing
-* Storing in cookies
-* Storing in server-side session, keyed off an ID stored as a cookie.
-
-For a certain application where you're using number 3, this comes at a cost - the session is "global".  In other words, in a single browser window with multiple tabs, the server side cannot distinguish between individual "sessions" *within* that browser session. This gem introduces a fourth, more granular method:
-* Storing in server-side session, keyed off an ID stored as a cookie *and* keyed off a request parameter.
-
-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.
-
-== Installation
-
-This gem requires ActionPack and ActiveSupport 3.0 or greater.
-
-Include the gem in your Gemfile:
-  
-  gem "micro_sessions"
-
-NOTE: This gem currently only works with rails 3.0 and rails 3.1, but *not* rails 3.2, due to an issue with overriding url_for. If you want to help with this, see issue #1.
-
-== Usage
-
-Simply include the middleware in your controller:
-
-  class ApplicationController
-    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
-    micro_sessions :key => "_msid"
-  end
-
-By default the key generated will be a 10-digit random hash, though this can be configured as well:
-
-  class ApplicationController
-    micro_sessions :type => :integer, :length => 10
-  end
-
-Valid values for +:type+: are:
-* +:random_hash+
-* +:integer+  (simply increments from one)
-* +:random_integer+ (random integer with a maximum of +:length+ digits)
-
-Session data is accessible to the controller and view through the +micro_session+ object, which works identically to the +session+ object but it specific to the micro-session:
-
-  micro_session[:key] = "Value"
-  micro_session[:key] # => "Value"
-
-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)
-
-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:
-  
-  <% form_for(@user) do |f| %>
-    <%= micro_session_hidden_field %>
-    ...
-  <% end %>
-

data/lib/micro_sessions/controller.rb

@@ -1,30 +0,0 @@
-module MicroSessions
-  module Controller
-    extend ActiveSupport::Concern
-
-    module ClassMethods
-      def micro_sessions(options = {})
-        options.stringify_keys!
-        options.assert_valid_keys(:param, :param_type, :key, :length, :counter)
-
-        options[:param] ||= "_msid"
-        options[:key] ||= "_micro_sessions"
-        options[:param_type] ||= :hash
-        options[:length] ||= 10
-        options[:counter] ||= 1
-
-        class_attribute :micro_session_options
-        self.micro_session_options = options
-
-        class_eval do
-          def micro_session
-            @micro_session ||= MicroSessions::MicroSession.new(self)
-          end
-
-          helper_method :micro_session
-          helper_method :micro_session_options
-        end
-      end
-    end
-  end
-end

data/lib/micro_sessions/helpers.rb

@@ -1,37 +0,0 @@
-module MicroSessions
-  module Helpers
-    module UrlHelper
-      extend ActiveSupport::Concern
-
-      def link_to(name = nil, options = nil, html_options = nil, &block)
-        options = add_micro_session(options)
-
-        super
-      end
-
-      def url_for(options = nil)
-        options = add_micro_session(options)
-
-        super
-      end
-
-      private
-
-      def add_micro_session(options)
-        if options.is_a?(Hash) && ms_value = options.delete(:micro_sessions) && !micro_session.empty?
-          options[micro_session.options[:param]] = (ms_value == true ? micro_session.id : ms_value)
-        end
-
-        options
-      end
-    end
-
-    module FormTagHelper
-      extend ActiveSupport::Concern
-
-      def micro_session_hidden_field
-        hidden_field_tag controller.class.micro_session_options[:param], micro_session.id
-      end
-    end
-  end
-end

data/lib/micro_sessions/micro_session.rb

@@ -1,48 +0,0 @@
-module MicroSessions
-  class MicroSession
-    def initialize(controller)
-      @controller = controller
-    end
-
-    def options
-      @controller.class.micro_session_options
-    end
-
-    def data
-      @controller.session[options[:key]] ||= {}
-      @controller.session[options[:key]][id] ||= {}
-      @controller.session[options[:key]][id].symbolize_keys!
-    end
-
-    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
-    end
-
-    protected
-
-    def id_from_params
-      @controller.params[options[:param]] if @controller.params
-    end
-
-    def generate_id
-      case options[:param_type]
-      when :hash
-        (Object::const_defined?("SecureRandom") ? SecureRandom : ActiveSupport::SecureRandom).hex(options[:length] / 2)
-      when :integer
-        self.counter += 1
-      when :random_integer
-        (Object::const_defined?("SecureRandom") ? SecureRandom : ActiveSupport::SecureRandom).integer
-      end
-    end
-  end
-end

data/lib/micro_sessions/railtie.rb

@@ -1,31 +0,0 @@
-module MicroSessions
-  class Railtie < Rails::Railtie
-    initializer "micro_sessions.configure_view_controller" do
-      ActiveSupport.on_load(:action_controller) do
-        include MicroSessions::Controller
-      end
-
-      ActiveSupport.on_load(:action_view) do
-        include MicroSessions::Helpers::FormTagHelper
-        include MicroSessions::Helpers::UrlHelper
-      end
-    end
-
-    def self.insert_controller
-      ActionController::Base.send(:include, MicroSessions::Controller)
-    end
-
-    def self.insert_view
-      ActionView::Helpers::FormTagHelper.send(:include, MicroSessions::Helpers::FormTagHelper)
-      ActionView::Helpers::UrlHelper.send(:include, MicroSessions::Helpers::UrlHelper)
-    end
-
-    MicroSessions::Railtie.insert_controller
-    MicroSessions::Railtie.insert_view
-
-    config.after_initialize do
-      MicroSessions::Railtie.insert_controller
-      MicroSessions::Railtie.insert_view
-    end
-  end
-end

data/lib/micro_sessions/version.rb

@@ -1,3 +0,0 @@
-module MicroSessions
-  VERSION = "0.3.0"
-end

data/spec/controller_spec.rb

@@ -1,80 +0,0 @@
-require "spec_helper"
-
-describe MicroSessions::Controller do
-  context "with a controller" do
-    before do
-      @controller_class = class SampleController < ActionController::Base
-        micro_sessions
-        self
-      end
-    end
-
-    it "should default param to _msid" do
-      expect(@controller_class.micro_session_options[:param]).to eq("_msid")
-    end
-
-    it "should default key to _micro_sessions" do
-      expect(@controller_class.micro_session_options[:key]).to eq("_micro_sessions")
-    end
-
-    it "should default length to 10" do
-      expect(@controller_class.micro_session_options[:length]).to eq(10)
-    end
-
-    it "should default counter to 1" do
-      expect(@controller_class.micro_session_options[:counter]).to eq(1)
-    end
-
-    context "an instance of the controller" do
-      before do
-        @controller = @controller_class.new
-
-        allow(@controller).to receive(:params).and_return({})
-      end
-
-      it "should expose #micro_session as a method" do
-        expect(@controller.micro_session).to be_kind_of(MicroSessions::MicroSession)
-      end
-
-      it "should generate a 10-character hash id" do
-        expect(@controller.micro_session.id).to be_a(String)
-        expect(@controller.micro_session.id.size).to eq(10)
-      end
-
-      context "with micro session data and another controller" do
-        before do
-          @micro_session_data = { integer: 1, string: "String" }
-
-          @another_controller = @controller_class.new
-
-          allow(@another_controller).to receive(:params).and_return({})
-          allow(@another_controller).to receive(:session).and_return({
-            "_micro_sessions" => {@controller.micro_session.id => @micro_session_data}
-          })
-        end
-
-        context "without passing id" do
-          subject do
-            @another_controller.micro_session
-          end
-
-          it "should not have data" do
-            expect(subject.data).to be_empty
-          end
-        end
-
-        context "when passing id" do
-          subject do
-            allow(@another_controller).to receive(:params).and_return({"_msid" => @controller.micro_session.id})
-
-            @another_controller.micro_session
-          end
-
-          it "should have data" do
-            expect(subject.data).to eq(@micro_session_data)
-          end
-        end
-      end
-    end
-  end
-end