Sessioner

🚫 This project is no longer maintained as of 2019-01-01. This project and all related versions will destroyed on 2020-01-01.

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.

Table of Contents

• Features
• Requirements
• Setup
• Usage
• Tests
• Versioning
• Code of Conduct
• Contributions
• License
• History
• Credits

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 2.6.x.
2. Ruby on Rails 5.x.x.

Setup

Type the following to install:

gem install sessioner

Add the following to your Gemfile:

gem "sessioner"

Usage

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

class Admin::UsersController < Admin::BaseController
  sessioner
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
  sessioner search: false
end

If auto-namespaced keys aren't your thing, then you can disable as follows:

class Admin::UsersController < Admin::BaseController
  sessioner 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
  sessioner page: {key: "current_page"}, search: {key: "query"}
end

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](https://github.com /activerecord-hackery/ransack) gem in addition to this gem, the following would be possible:

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

In situations where default search criteria might be too complex and murky to define within via the sessioner 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
  sessioner search: {default: :default_search}

  private

  def default_search
    {published_true: true}
  end
end

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

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.

Tests

To test, run:

bundle exec rake

Versioning

Read Semantic Versioning for details. Briefly, it means:

• Major (X.y.z) - Incremented for any backwards incompatible public API changes.
• Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
• Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.

Code of Conduct

Please note that this project is released with a CODE OF CONDUCT. By participating in this project you agree to abide by its terms.

Contributions

Read CONTRIBUTING for details.

License

Copyright 2011 Alchemists. Read LICENSE for details.

History

Read CHANGES for details. Built with Gemsmith.

Credits

Developed by Brooke Kuhlmann at Alchemists.