acts_as_temporary 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Daniel Reedy
+
+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,94 @@
+# ActsAsTemporary
+
+On occasion I've had the need to store data for a short period of time within an application's database but did not want it to artificially inflate the ID numbers.
+This gem uses a _TemporaryObject_ model that stores the "definition" (read: attributes) of a model. It can then be recalled at a later date. Upon saving a recalled object the temporary version is deleted. 
+
+## Requirements
+
+This project builds upon ActiveRecord. In theory this should work with nothing outside of a Rails application
+
+## Installation
+
+This project is distributed as a gem and it should be as simple as adding the following line to your **Gemfile**.
+
+    gem 'acts_as_temporary', '~> 0.0.1'
+
+You'll need to copy and run the migration from the engine.
+
+    $ cd _/your/rails/app_
+    $ rake acts_as_temporary_engine:install:migrations
+    $ rake db:migrate
+
+## Configuration
+
+In your _{environment}.rb_ file you can set the shelf life of a temporary object with the following configuration definition:
+
+    config.acts_as_temporary_shelf_life = 1.day # Set the duration to something that makes sense
+
+By default the shelf life of a temporary object is _365.days_.
+
+# Usage
+
+## Class Methods
+
+### can\_be\_temporary
+
+Within the model you would like to be able to temporarily store you just need to add the following line.
+
+    can_be_temporary
+
+For example, if you wish to make the _Registration_ model one that can be temporary the model would look like this to start.
+
+    class Registration < ActiveRecord::Base
+      can_be_temporary
+    end
+
+### clear\_stale\_objects
+
+Rolls through the temporary objects table and clears any old temporary objects. By default anything older than 24 hours is considered stale.
+
+## Instance Methods
+
+### #store
+
+The _#store_ instance method takes the instance and stores it as a temporary object. The temporary object's ID is then stored within the objects _@temporary\_id_ instance variable.
+
+### #recall
+
+The _#recall_ instance method takes the ID of a temporary object and attempts to instantiate that data.
+
+### #is_temporary?
+
+Returns __true__ if the current object has a _@temporary\_id_.
+
+## Deleting Temporary Objects
+
+There are two methods for deleting temporary objects. The first, and most common, is to simply call _save_ and the second is to call _drop\_temporary_ on an object that has been recalled.
+
+### #save
+
+If the object saves without error the temporary object will be destroyed.
+
+### #drop\_temporary
+
+Deletes the associated temporary object from the database without saving the calling object
+
+### Example
+
+    registration = Registration.new(params[:registration])
+    registration.is_temporary? # => false
+    
+    registration.store # => this object's data is stored in the database and the ID of the temporary object is interally assigned
+    registration.id # => nil
+    registration.temporary_id # => 14123
+    registration.is_temporary? # => true
+    
+    registration = Registration.recall(14123)
+    registration.id # => nil
+    registration.is_temporary? # => true
+    
+    registration.save # => true
+    registration.is_temporary? # => false
+
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,28 @@
+#!/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    = 'ActsAsTemporary'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/temporary_object.rb

@@ -0,0 +1,5 @@
+class TemporaryObject < ActiveRecord::Base
+  validates_presence_of :permanent_class
+  validates_presence_of :definition
+  serialize :definition
+end

data/db/migrate/20110919190814_create_temporary_objects.rb

@@ -0,0 +1,10 @@
+class CreateTemporaryObjects < ActiveRecord::Migration
+  def change
+    create_table :temporary_objects do |t|
+      t.string :permanent_class
+      t.text :definition
+
+      t.timestamps
+    end
+  end
+end

data/lib/acts_as_temporary/acts_as_temporary.rb

@@ -0,0 +1,61 @@
+module ActsAsTemporary
+  def can_be_temporary
+    #has_many :reviews, :as=>:reviewable, :dependent=>:destroy
+    include InstanceMethods
+    attr_reader :temporary_id
+    after_save :drop_temporary
+    
+    def recall(temp_id=nil)
+      raise ArgumentError, "Please provide a temporary object ID" if temp_id.blank?
+      temporary_object = TemporaryObject.find(temp_id)
+      if temporary_object
+        raise TypeError, "Temporary object and calling object must be the same class" unless temporary_object.permanent_class.eql?(self.name)
+        new_object = self.new(temporary_object.definition)
+        new_object.instance_variable_set("@temporary_id",temp_id)
+        new_object
+      end
+    end
+    
+    def clear_stale_objects
+      expiry_date = Time.now - Rails.application.config.acts_as_temporary_shelf_life
+      TemporaryObject.delete_all(["permanent_class = ? AND created_at < ?", self.name, expiry_date])
+    end
+  end
+  module InstanceMethods
+    def can_be_temporary?
+      true
+    end
+    
+    def shelf_life
+      Rails.application.config.acts_as_temporary_shelf_life
+    end
+    
+    def store
+      temporary_object = TemporaryObject.new
+      temporary_object.permanent_class = self.class.name
+      temporary_object.definition = self.attributes
+      temporary_object.save
+      @temporary_id = temporary_object.id
+    end
+    
+    def recall(temp_id=nil)
+      temp_id ||= @temporary_id
+      self.class.send(:recall, temp_id)
+    end
+    
+    def is_temporary?
+      @temporary_id.present?
+    end
+    
+    def drop_temporary
+      if @temporary_id.present?
+        TemporaryObject.destroy(@temporary_id)
+        @temporary_id = nil
+      end
+    end
+    
+    
+  end
+end
+
+ActiveRecord::Base.extend ActsAsTemporary

data/lib/acts_as_temporary/engine.rb

@@ -0,0 +1,10 @@
+require 'acts_as_temporary'
+require 'rails'
+
+module ActsAsTemporary
+  class Engine < Rails::Engine
+    config.before_initialize do |app|
+      app.config.acts_as_temporary_shelf_life = 365.days
+    end
+  end
+end

data/lib/acts_as_temporary/version.rb

@@ -0,0 +1,3 @@
+module ActsAsTemporary
+  VERSION = "0.1.0"
+end

data/lib/acts_as_temporary.rb

@@ -0,0 +1,2 @@
+require "acts_as_temporary/acts_as_temporary"
+require "acts_as_temporary/engine"

data/lib/tasks/acts_as_temporary_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :acts_as_temporary do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_temporary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Daniel Reedy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-20 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70293734107740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70293734107740
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70293734107240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70293734107240
+- !ruby/object:Gem::Dependency
+  name: steak
+  requirement: &70293734106660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70293734106660
+description: In the event that you do not want to clutter your production databases
+  with what could be temporary data you can use this plugin to temporarily store and
+  later retreive data with your database.
+email:
+- danreedy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/temporary_object.rb
+- db/migrate/20110919190814_create_temporary_objects.rb
+- lib/acts_as_temporary/acts_as_temporary.rb
+- lib/acts_as_temporary/engine.rb
+- lib/acts_as_temporary/version.rb
+- lib/acts_as_temporary.rb
+- lib/tasks/acts_as_temporary_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.md
+homepage: http://about.me/reedy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Adds the abililty to temporarily store an object through ActiveRecord
+test_files: []