preserve 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ac09bc7bb243e6a19585afb9a6c9f91d84bebc18
+  data.tar.gz: 030f19ee58810f1870009bd2221daccfd5b03a25
+SHA512:
+  metadata.gz: f5a7403a8855b2f15e53010e995a018457add9da87c3643ae081afff7f7360f5b5c8a50d46ac5a8c61dd5bb97a44b2fe910c718a1225a39a545296ff07341b51
+  data.tar.gz: bcd43a0e6e5ed9486bf8e473d21a8ea56b338a2f0550f0943a9e59c91a5dc1647529c02361b2215874077daf7d356f45cf635a26f6f5cd0b9468ded345ddb751

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Bartosz Pieńkowski
+
+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/README.md

@@ -0,0 +1,148 @@
+# Preserve
+
+Preserve is a Rails plugin which stores selected parameters in a session to make them available in subsequent requests.
+
+## Installation
+
+Add the following line to your application's Gemfile:
+
+```ruby
+gem 'preserve'
+```
+
+Install the gem with Bundler:
+
+```
+$ bundle install
+```
+
+Or do it manually by running:
+
+```
+$ gem install preserve
+```
+
+## Usage
+
+For the sole purpose of this example, assume we have a Rails application with a controller showing all parameters sent in a request.
+
+```ruby
+class ParametersController < ApplicationController
+  def index
+    render json: request_parameters
+  end
+
+  private
+
+  def request_parameters
+    params.except(:controller, :action)
+  end
+end
+```
+
+Routes are declared as following:
+
+```ruby
+Rails.application.routes.draw do
+  resources :parameters, only: :index
+end
+```
+
+Let's start the application and test its behaviour using [cURL](http://curl.haxx.se/).
+The whole concept is based on a session, so in order for this to work, the cookie engine must be enabled (hence `-c` and `-b` options).
+
+In the first request, the `per_page` parameter is set to 20.
+
+```
+$ curl -c cookies http://localhost:3000/parameters?per_page=20
+```
+```json
+{"per_page":"20"}
+```
+
+As expected, the application returns the parameter and its value.
+
+The next request is sent without any parameters.
+
+```
+$ curl -b cookies http://localhost:3000/parameters
+```
+```json
+{}
+```
+
+Obviously, the `per_page` parameter is no longer available.
+
+Now, let's call the `preserve` method inside the `ParametersController` class with the parameter name as an argument.
+
+```ruby
+class ParametersController < ApplicationController
+  preserve :per_page
+
+  # ...
+end
+```
+
+Sending the same two requests again gives a different result.
+
+```
+$ curl -c cookies http://localhost:3000/parameters?per_page=20
+```
+```json
+{"per_page":"20"}
+```
+
+```
+$ curl -b cookies http://localhost:3000/parameters
+```
+```json
+{"per_page":"20"}
+```
+
+This time, the `per_page` parameter is still available when the second request is made, even though it wasn't sent particularly in that request.
+
+### Multiple arguments
+
+If more than one parameter needs to be preserved within the same controller, its name can be passed as a succeeding argument to the `preserve` method.
+
+```ruby
+preserve :per_page, :page
+```
+
+### Restrictions
+
+Limiting functionality provided by the gem to a certain set of controller actions can be achieved by applying the `:only` (or `:except`) option.
+
+```ruby
+preserve :per_page, only: :index
+```
+
+It behaves exactly like the `:only` option of an [Action Controller filter](http://guides.rubyonrails.org/action_controller_overview.html#filters).
+In fact, the gem sets such filter underneath, so you can make use of all its options – they will be passed to that filter.
+
+### Application-wide parameters
+
+When there's a need to store a parameter used across the whole application, the `preserve` method should be called inside the `ApplicationController`.
+
+```ruby
+class ApplicationController < ActionController::Base
+  preserve :locale
+end
+```
+
+In more complex scenarios, controller inheritance can be utilized to further adjust the scope.
+
+### Setting a session key prefix
+
+By default, parameter values are stored in a session with a key that consists of a controller name and parameter name (e.g. `users_order` for the `order` parameter in the `UsersController`).
+
+In most cases such combination results in a unique session key, but there might be a situation when it's necessary to add a prefix in order to avoid conflicts with a session key that is already in use.
+It can be done by passing the `:prefix` option.
+
+```ruby
+class UsersController < ApplicationController
+  preserve :order, prefix: 'preserved'
+end
+```
+
+From now on, the parameter will be stored in a session with the `preserved_users_order` key.

data/Rakefile

@@ -0,0 +1,33 @@
+#!/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Preserve'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/preserve.rb

@@ -0,0 +1,36 @@
+require 'active_support'
+
+module Preserve
+  def self.filter(name, key)
+    lambda do
+      if params[name].blank?
+        value = session[key.to_sym]
+        params[name] = value if value.present?
+      else
+        session[key.to_sym] = params[name]
+      end
+    end
+  end
+
+  def preserve(*parameters)
+    options = parameters.extract_options!
+    prefix = options.delete(:prefix)
+
+    parameters.each do |name|
+      key = [prefix, controller_name, name].compact.join('_')
+      _preserve_filter(options, &Preserve.filter(name, key))
+    end
+  end
+
+  def _preserve_filter(*args, &block)
+    if respond_to?(:before_action)
+      before_action(*args, &block)
+    else
+      before_filter(*args, &block)
+    end
+  end
+end
+
+ActiveSupport.on_load(:action_controller) do
+  extend Preserve
+end

data/lib/preserve/version.rb

@@ -0,0 +1,3 @@
+module Preserve
+  VERSION = '0.1.0'
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,4 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+  preserve :locale
+end

data/spec/dummy/app/controllers/parameters_controller.rb

@@ -0,0 +1,18 @@
+class ParametersController < ApplicationController
+  preserve :per_page, :page, only: :index
+  preserve :order, prefix: 'preserved'
+
+  def index
+    render json: request_parameters
+  end
+
+  def create
+    render json: request_parameters
+  end
+
+  private
+
+  def request_parameters
+    params.except(:controller, :action)
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "preserve"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+