rails_temporary_data 1.0.0

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+test/dummy_rails_app/log/*.log

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rails_temporary_data.gemspec
+gemspec

data/README.md

@@ -0,0 +1,80 @@
+RailsTemporaryData
+==================
+
+Rails engine to simply save big temporary data (too big for session cookie store) in a database. It is great for a step-by-step wizard or similar functionality.
+
+Why
+---
+While working on [Padbase](http://www.padbase.com) we needed [2 steps signup process](http://www.padbase.com/pads/new) (1. enter property info, 2. enter user info). Info entered in first step could get very large and we couldn't save it in a session because of [CookieOverflow](http://api.rubyonrails.org/classes/ActionDispatch/Cookies/CookieOverflow.html), didn't want to switch to ActiveRecord store and didn't want to save invalid property in database with the flag (partial validations, ...). Solution was to create separate table for this temporary data and RailsTemporaryData was born.
+**This way you get best from both worlds. Standard session data is still saved in a cookie and you can save larger amount of data in a database.**
+
+Install
+-------
+
+Start by adding the gem to your application's Gemfile
+
+    gem 'rails_temporary_data', :git => 'git://github.com/vlado/rails_temporary_data.git'
+
+Update your bundle
+
+    bundle install
+    
+Generate migration
+
+    rails generate rails_temporary_data
+  
+Run migration
+
+    rake db:migrate
+    
+Example
+--------
+
+  class DummyController < ApplicationController
+
+    def set_data
+      set_tmp_data("some_key", { first_name: "Vlado", last_name: "Cingel", bio: "Very ... very long bio" })
+      ...
+    end
+
+    def get_data
+      tmp_data = get_tmp_data("some_key").data
+      # do something with tmp data
+      first_name = tmp_data[:first_name] # => Vlado
+      ...
+    end
+
+  end
+
+You can optionally set data expiry time (default is 2 days)
+
+  class DummyController < ApplicationController
+
+    def set_data
+      set_tmp_data("some_key", { first_name: "Vlado", last_name: "Cingel", bio: "Very ... very long bio" }, Time.now + 3.days)
+      ...
+    end
+
+  end
+
+To clear data you don't need any more
+
+  class DummyController < ApplicationController
+
+    def get_data
+      tmp_data = get_tmp_data("some_key").data
+      # do something with tmp data
+      clear_tmp_data("some_key")
+    end
+
+  end
+
+To help you clear unwanted and/or expired data rake task is provided. You should set a cron job to call this task daily.
+
+  rake rails_temporary_data:delete_expired
+
+
+TODO
+----
+
+* Default expires_at as configuration option

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+desc "Run tests"
+task :default => :test
+
+load "tasks/rails_temporary_data.rake"

data/app/models/temporary_data.rb

@@ -0,0 +1,21 @@
+class TemporaryData < ActiveRecord::Base
+  serialize :data
+  before_create :set_default_expires_at
+
+  scope :unexpired, lambda { where("expires_at > ?", Time.current) }
+  scope :expired, lambda { where("expires_at < ?", Time.current) }
+
+  def self.delete_expired
+    expired.delete_all
+  end
+
+  def self.not_expired
+    unexpired
+  end
+
+  private
+
+    def set_default_expires_at
+      self.expires_at = Time.current + 48.hours if expires_at.nil? || expires_at < Time.current
+    end
+end

data/lib/generators/rails_temporary_data_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class RailsTemporaryDataGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_temporary_data.rb'
+  end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,10 @@
+class CreateTemporaryData < ActiveRecord::Migration
+  def change
+    create_table :temporary_data do |t|
+      t.text :data
+      t.datetime :expires_at
+
+      t.timestamps
+    end
+  end
+end

data/lib/rails_temporary_data.rb

@@ -0,0 +1,7 @@
+require "rails_temporary_data/version"
+require "rails_temporary_data/controller_helpers"
+require "rails_temporary_data/engine"
+
+module RailsTemporaryData
+  # Your code goes here...
+end

data/lib/rails_temporary_data/controller_helpers.rb

@@ -0,0 +1,23 @@
+module RailsTemporaryData
+  module ControllerHelpers
+    extend ActiveSupport::Concern
+
+    def set_tmp_data(key, data, expires_at = nil)
+      tmp_data = TemporaryData.create!(:data => data, :expires_at => expires_at)
+      session[key] = tmp_data.id
+    end
+
+    def get_tmp_data(key)
+      tmp_data = TemporaryData.unexpired.find_by_id(session[key])
+      session[key] = nil if tmp_data.nil?
+      tmp_data
+    end
+
+    def clear_tmp_data(key)
+      tmp_data = TemporaryData.unexpired.find_by_id(session[key])
+      session[key] = nil
+      tmp_data.destroy if tmp_data
+    end
+
+  end
+end

data/lib/rails_temporary_data/engine.rb

@@ -0,0 +1,9 @@
+module RailsTemporaryData
+  class Engine < ::Rails::Engine
+
+    config.after_initialize do
+      ApplicationController.send(:include, RailsTemporaryData::ControllerHelpers)
+    end
+
+  end
+end

data/lib/rails_temporary_data/version.rb

@@ -0,0 +1,3 @@
+module RailsTemporaryData
+  VERSION = "1.0.0"
+end

data/lib/tasks/rails_temporary_data.rake

@@ -0,0 +1,8 @@
+namespace :rails_temporary_data do
+
+  desc "Removes expired entries from temporary data table"
+  task :delete_expired => :environment do
+    TemporaryData.delete_expired
+  end
+
+end

data/rails_temporary_data.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rails_temporary_data/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rails_temporary_data"
+  s.version     = RailsTemporaryData::VERSION
+  s.authors     = ["Vlado Cingel"]
+  s.email       = ["vladocingel@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Rails engine to simply save temporary data that is too big for session in database}
+  s.description = %q{Rails engine to simply save temporary data that is too big for session in database}
+
+  s.rubyforge_project = "rails_temporary_data"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency("rake")
+  s.add_development_dependency("sqlite3")
+
+  s.add_dependency("rails")
+end

data/test/controller_helpers_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class ControllerHelpersTest < ActionController::TestCase
+
+  def setup
+    @controller = DummyController.new
+  end
+
+  test "set and get tmp data" do
+    data = { "foo" => "bar" }
+    expires_at = Time.current + 24.hours
+
+    get :set_data, :data => data, :expires_at => expires_at
+    get :get_data
+
+    @tmp_data = assigns(:tmp_data)
+
+    assert_equal 1, session["test_data"]
+    assert_equal data, @tmp_data.data
+    assert_equal expires_at.to_a, @tmp_data.expires_at.to_a
+  end
+
+  test "@tmp_data should not be returned (=nil) and session cleared if it is expired in the meantime" do
+    data = { "foo" => "bar" }
+    expires_at = Time.current + 1.second
+
+    get :set_data, :data => { "foo" => "bar" }, :expires_at => expires_at
+    sleep 1
+    get :get_data
+
+    assert_nil session["test_data"]
+    assert_nil assigns(:tmp_data)
+  end
+
+  test "#clear_tmp_data shoould destroy both tmp data and sessions value" do
+    get :set_data, :data => { "foo" => "bar" }
+    assert_equal 1, TemporaryData.count
+    get :clear_data
+    assert_equal 0, TemporaryData.count
+    assert_nil session["test_data"]
+  end
+
+end

data/test/dummy_rails_app/Rakefile

@@ -0,0 +1,9 @@
+# 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__)
+require 'rake'
+
+Dummy::Application.load_tasks
+
+load "#{File.expand_path('../../..', __FILE__)}/lib/tasks/rails_temporary_data.rake"

data/test/dummy_rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy_rails_app/app/controllers/dummy_controller.rb

@@ -0,0 +1,18 @@
+class DummyController < ApplicationController
+
+  def set_data
+    set_tmp_data("test_data", params[:data], params[:expires_at])
+    head :ok
+  end
+
+  def get_data
+    @tmp_data = get_tmp_data("test_data")
+    head :ok
+  end
+
+  def clear_data
+    clear_tmp_data("test_data")
+    head :ok
+  end
+
+end

data/test/dummy_rails_app/app/helpers/application_helper.rb

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

data/test/dummy_rails_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy_rails_app/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 Dummy::Application

data/test/dummy_rails_app/config/application.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+
+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.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # 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
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/dummy_rails_app/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy_rails_app/config/database.yml

@@ -0,0 +1,20 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: ":memory:"

data/test/dummy_rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy_rails_app/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/dummy_rails_app/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/test/dummy_rails_app/config/environments/test.rb

@@ -0,0 +1,35 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/environment.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  #config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+end

data/test/dummy_rails_app/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/test/dummy_rails_app/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/test/dummy_rails_app/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/test/dummy_rails_app/config/initializers/secret_token.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+Dummy::Application.config.secret_token = '50777595d4b6041cfca51636cf4e262508f96cc081757729e7123d04a5abdf9e3554e4f519b71106e41c5146a9b07b5affd2e410af1130db3a7f4538b70e2429'

data/test/dummy_rails_app/config/initializers/session_store.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+Dummy::Application.config.session_store :cookie_store, :key => '_dummy_session'
+
+# Use the database for sessions instead of the cookie-based default,
+# which shouldn't be used to store highly confidential information
+# (create the session table with "rake db:sessions:create")
+# Dummy::Application.config.session_store :active_record_store

data/test/dummy_rails_app/config/locales/en.yml

@@ -0,0 +1,5 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See http://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  hello: "Hello world"

data/test/dummy_rails_app/config/routes.rb

@@ -0,0 +1,58 @@
+Dummy::Application.routes.draw do
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  # root :to => "welcome#index"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  match ':controller(/:action(/:id(.:format)))'
+end

data/test/dummy_rails_app/db/migrate/20120309215634_create_temporary_data.rb

@@ -0,0 +1,10 @@
+class CreateTemporaryData < ActiveRecord::Migration
+  def change
+    create_table :temporary_data do |t|
+      t.text :data
+      t.datetime :expires_at
+
+      t.timestamps
+    end
+  end
+end

data/test/dummy_rails_app/public/404.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The page you were looking for doesn't exist (404)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/404.html -->
+  <div class="dialog">
+    <h1>The page you were looking for doesn't exist.</h1>
+    <p>You may have mistyped the address or the page may have moved.</p>
+  </div>
+</body>
+</html>

data/test/dummy_rails_app/public/422.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>The change you wanted was rejected (422)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/422.html -->
+  <div class="dialog">
+    <h1>The change you wanted was rejected.</h1>
+    <p>Maybe you tried to change something you didn't have access to.</p>
+  </div>
+</body>
+</html>

data/test/dummy_rails_app/public/500.html

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>We're sorry, but something went wrong (500)</title>
+  <style type="text/css">
+    body { background-color: #fff; color: #666; text-align: center; font-family: arial, sans-serif; }
+    div.dialog {
+      width: 25em;
+      padding: 0 4em;
+      margin: 4em auto 0 auto;
+      border: 1px solid #ccc;
+      border-right-color: #999;
+      border-bottom-color: #999;
+    }
+    h1 { font-size: 100%; color: #f00; line-height: 1.5em; }
+  </style>
+</head>
+
+<body>
+  <!-- This file lives in public/500.html -->
+  <div class="dialog">
+    <h1>We're sorry, but something went wrong.</h1>
+    <p>We've been notified about this issue and we'll take a look at it shortly.</p>
+  </div>
+</body>
+</html>

data/test/temporary_data_test.rb

@@ -0,0 +1,68 @@
+require 'test_helper'
+
+class TemporaryDataTest < ActiveSupport::TestCase
+
+  test "data column is serialized" do
+    tmp_data = TemporaryData.create(:data => { :first_name => "Vlado", :last_name => "Cingel" })
+    assert "Vlado", tmp_data.data[:first_name]
+  end
+
+  test "expires_at is set before create to time in future if blank (not provided) or set to past" do
+    tmp_data_1 = TemporaryData.create(:data => {})
+    assert tmp_data_1.expires_at > Time.current
+    tmp_data_2 = TemporaryData.create(:data => {}, :expires_at => Time.current - 1.hour)
+    assert tmp_data_2.expires_at > Time.current
+  end
+
+  test "expires_at is not set before create if provided" do
+    expires_at = Time.current + 5.hours
+    tmp_data = TemporaryData.create(:data => {}, :expires_at => expires_at)
+    assert_equal expires_at, tmp_data.expires_at
+  end
+
+  test "it should return all data (including expired) when no scope is defined" do
+    tmp_data_1 = TemporaryData.create(:data => { :tmp_data => 1 }, :expires_at => Time.current + 1.second)
+    tmp_data_2 = TemporaryData.create(:data => { :tmp_data => 2 }, :expires_at => Time.current + 1.hour)
+    sleep 1 # wait for 1 second so tmp_data_1 expires
+    tmp_data = TemporaryData.all
+    assert tmp_data.include?(tmp_data_2)
+    assert tmp_data.include?(tmp_data_1)
+  end
+
+  test "unexpired scope should return only not expired data by default" do
+    tmp_data_1 = TemporaryData.create(:data => { :tmp_data => 1 }, :expires_at => Time.current + 1.second)
+    tmp_data_2 = TemporaryData.create(:data => { :tmp_data => 2 }, :expires_at => Time.current + 1.hour)
+    sleep 1 # wait for 1 second so tmp_data_1 expires
+    tmp_data = TemporaryData.unexpired.all
+    assert tmp_data.include?(tmp_data_2)
+    assert !tmp_data.include?(tmp_data_1)
+  end
+
+  test "not_expired as alias for unexpired" do
+    tmp_data_1 = TemporaryData.create(:data => { :tmp_data => 1 }, :expires_at => Time.current + 1.second)
+    tmp_data_2 = TemporaryData.create(:data => { :tmp_data => 2 }, :expires_at => Time.current + 1.hour)
+    sleep 1 # wait for 1 second so tmp_data_1 expires
+
+    assert_equal TemporaryData.unexpired.all, TemporaryData.not_expired.all
+  end
+
+  test "expired scope should return expired data when no scope is defined" do
+    tmp_data_1 = TemporaryData.create(:data => { :tmp_data => 1 }, :expires_at => Time.current + 1.second)
+    tmp_data_2 = TemporaryData.create(:data => { :tmp_data => 2 }, :expires_at => Time.current + 1.hour)
+    sleep 1 # wait for 1 second so tmp_data_1 expires
+    tmp_data = TemporaryData.expired.all
+    assert !tmp_data.include?(tmp_data_2)
+    assert tmp_data.include?(tmp_data_1)
+  end
+
+  test "delete_expired method should delete all temporary data with expires_at field in the past" do
+    tmp_data_1 = TemporaryData.create(:data => { :tmp_data => 1 }, :expires_at => Time.current + 1.second)
+    tmp_data_2 = TemporaryData.create(:data => { :tmp_data => 2 }, :expires_at => Time.current + 1.hour)
+    assert_equal 2, TemporaryData.unscoped.count
+
+    sleep 1 # wait for 1 second so tmp_data_1 expires
+    TemporaryData.delete_expired
+    assert_equal [tmp_data_2], TemporaryData.all
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+ENV["RAILS_ENV"] = "test"
+require 'dummy_rails_app/config/environment'
+require 'rails/test_help'
+
+Bundler.setup
+
+ActiveRecord::Migrator.migrate(File.expand_path("../dummy_rails_app/db/migrate/", __FILE__))
+
+class ActiveSupport::TestCase
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

metadata

@@ -0,0 +1,179 @@
+--- !ruby/object:Gem::Specification 
+name: rails_temporary_data
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Vlado Cingel
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-21 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: Rails engine to simply save temporary data that is too big for session in database
+email: 
+- vladocingel@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- app/models/temporary_data.rb
+- lib/generators/rails_temporary_data_generator.rb
+- lib/generators/templates/migration.rb
+- lib/rails_temporary_data.rb
+- lib/rails_temporary_data/controller_helpers.rb
+- lib/rails_temporary_data/engine.rb
+- lib/rails_temporary_data/version.rb
+- lib/tasks/rails_temporary_data.rake
+- rails_temporary_data.gemspec
+- test/controller_helpers_test.rb
+- test/dummy_rails_app/Rakefile
+- test/dummy_rails_app/app/controllers/application_controller.rb
+- test/dummy_rails_app/app/controllers/dummy_controller.rb
+- test/dummy_rails_app/app/helpers/application_helper.rb
+- test/dummy_rails_app/app/views/layouts/application.html.erb
+- test/dummy_rails_app/config.ru
+- test/dummy_rails_app/config/application.rb
+- test/dummy_rails_app/config/boot.rb
+- test/dummy_rails_app/config/database.yml
+- test/dummy_rails_app/config/environment.rb
+- test/dummy_rails_app/config/environments/development.rb
+- test/dummy_rails_app/config/environments/production.rb
+- test/dummy_rails_app/config/environments/test.rb
+- test/dummy_rails_app/config/initializers/backtrace_silencers.rb
+- test/dummy_rails_app/config/initializers/inflections.rb
+- test/dummy_rails_app/config/initializers/mime_types.rb
+- test/dummy_rails_app/config/initializers/secret_token.rb
+- test/dummy_rails_app/config/initializers/session_store.rb
+- test/dummy_rails_app/config/locales/en.yml
+- test/dummy_rails_app/config/routes.rb
+- test/dummy_rails_app/db/migrate/20120309215634_create_temporary_data.rb
+- test/dummy_rails_app/db/test.sqlite3
+- test/dummy_rails_app/public/404.html
+- test/dummy_rails_app/public/422.html
+- test/dummy_rails_app/public/500.html
+- test/dummy_rails_app/public/favicon.ico
+- test/dummy_rails_app/public/stylesheets/.gitkeep
+- test/temporary_data_test.rb
+- test/test_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: rails_temporary_data
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Rails engine to simply save temporary data that is too big for session in database
+test_files: 
+- test/controller_helpers_test.rb
+- test/dummy_rails_app/Rakefile
+- test/dummy_rails_app/app/controllers/application_controller.rb
+- test/dummy_rails_app/app/controllers/dummy_controller.rb
+- test/dummy_rails_app/app/helpers/application_helper.rb
+- test/dummy_rails_app/app/views/layouts/application.html.erb
+- test/dummy_rails_app/config.ru
+- test/dummy_rails_app/config/application.rb
+- test/dummy_rails_app/config/boot.rb
+- test/dummy_rails_app/config/database.yml
+- test/dummy_rails_app/config/environment.rb
+- test/dummy_rails_app/config/environments/development.rb
+- test/dummy_rails_app/config/environments/production.rb
+- test/dummy_rails_app/config/environments/test.rb
+- test/dummy_rails_app/config/initializers/backtrace_silencers.rb
+- test/dummy_rails_app/config/initializers/inflections.rb
+- test/dummy_rails_app/config/initializers/mime_types.rb
+- test/dummy_rails_app/config/initializers/secret_token.rb
+- test/dummy_rails_app/config/initializers/session_store.rb
+- test/dummy_rails_app/config/locales/en.yml
+- test/dummy_rails_app/config/routes.rb
+- test/dummy_rails_app/db/migrate/20120309215634_create_temporary_data.rb
+- test/dummy_rails_app/db/test.sqlite3
+- test/dummy_rails_app/public/404.html
+- test/dummy_rails_app/public/422.html
+- test/dummy_rails_app/public/500.html
+- test/dummy_rails_app/public/favicon.ico
+- test/dummy_rails_app/public/stylesheets/.gitkeep
+- test/temporary_data_test.rb
+- test/test_helper.rb
+has_rdoc: