Skip to content
Enhances ActionController with common session management functionality. http://www.alchemists.io
Ruby
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
gemfiles
lib
spec
.gitignore
.rspec
.travis.yml
CHANGELOG.rdoc
CONTRIBUTING.md
Gemfile
Guardfile
LICENSE.rdoc
README.rdoc
Rakefile
sessioner.gemspec

README.rdoc

Overview

Enhances ActionController with common session management functionality beyond what is provided by default. This reduces some of the repetitive work related to storing and retrieving information from the session store.

Features

  • Auto-prefixes session keys based on controller namespace and name.

  • Auto-stores the key=value pair for pagination.

  • Auto-stores the key=value pair for search.

  • Adds convenience methods for storing key=value pairs via the session.

Requirements

  1. Ruby on Rails.

Setup

Type the following from the command line to install:

gem install sessioner

Add the following to your Gemfile:

gem "sessioner"

Usage

To use, add the is_sessionable macro to your controller of choice, for example:

class Admin::UsersController < Admin::BaseController
  is_sessionable
end

By default, this will auto-configure the session with the following keys and values:

{admin_users_page: params[:page], admin_users_search: params[:search]}

Should only page support be required but not search, then the following is possible:

class Admin::UsersController < Admin::BaseController
  is_sessionable search: false
end

If you're thinking “Hey, auto-namespaced keys ain't my bag, baby!”, then you can disable as follows:

class Admin::UsersController < Admin::BaseController
  is_sessionable page: {namespace: false}, search: {namespace: false}
end

The session keys are customizable as well. By default, the keys default to “page” and “search”. However, these could be customized as follows:

class Admin::UsersController < Admin::BaseController
  is_sessionable page: {key: "current_page"}, search: {key: "query"}
end

NOTE: By customizing the session keys, this also means that the parameters have to match as well. Using the example above, the session keys would be “admin_users_current_page” and “admin_users_query” while the parameter keys would need to be “current_page” and “query”. The session and parameters keys must always match.

Default values can be supplied as well. For example, you might want to display new posts that are published (boolean) by default. Assuming you are using the Ransack gem in addition to this gem, the following would be possible:

class Admin::PostsController < Admin::BaseController
  is_sessionable search: {default: {published_true: true}}
end

In situations where default search criteria might be too complex and murky to define within via the is_sessionable macro, you call a method for the default options. Using the same example above, we could modify the code as follows:

class Admin::PostsController < Admin::BaseController
  is_sessionable search: {default: :default_search}

  private

  def default_search
    {published_true: true}
  end
end

NOTE: Any method used for default settings must be a symbol and begin with “default”, otherwise the method will not be called.

Notes

Rails defaults to using a cookie store (as found via the config/initializers/session_store.rb). This limits you to 4KB of memory per session. Be wary of how much memory you plan to consume or switch to using a different session store altogether.

Testing

To test, do the following:

  1. cd to the gem root.

  2. bundle install

  3. bundle exec rspec spec

Contributions

Read CONTRIBUTING for details.

Credits

Developed by Brooke Kuhlmann at Red Alchemist

License

Copyright © 2011 Red Alchemist. Read the LICENSE for details.

History

Read the CHANGELOG for details. Built with Gemsmith.

Something went wrong with that request. Please try again.