archiving 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2d7eaeb6598b5ba00ae3d6bdef468545d68d5641
+  data.tar.gz: 24c623836849c74f9c6ee567acc146da8e84ee8f
+SHA512:
+  metadata.gz: 3f614efd041c2409ed9b39b12e823f4ba9a41165bec256dc4a64d1faeb0d11897706fb0edb614eb1ad4b9f5ac7cf3cd825bcb52cfe8e372922de501a7941036a
+  data.tar.gz: d3402e030227800278ed6b73d18bcf3bfba6657b129ca34b31fc031e1ddb6375e385c7f28bf57076d57ae5c015a3c6d3039808627a6722b0ff7d309ffc813613

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Firmafon ApS
+
+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,4 @@
+# Archiving
+[![Build Status](https://travis-ci.org/firmafon/archiving.svg)](https://travis-ci.org/firmafon/archiving)
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,38 @@
+#!/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    = 'Archiving'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/archiving/archive_table.rb

@@ -0,0 +1,108 @@
+require "active_support/concern"
+require "active_support/inflector"
+
+module Archiving
+  module ArchiveTable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :archive_table
+
+      def has_archive_table
+        model = name.constantize
+        @archive_model = model.const_set("Archive", Class.new(model))
+        @archive_model.after_initialize do |record|
+          record.readonly! unless record.new_record?
+        end
+        @archive_model.table_name = "#{table_name}_archive"
+      end
+
+      def archive
+        @archive_model
+      end
+
+      def with_archive(query = nil, order: nil, limit: nil, offset: nil)
+        active = select_archive_attributes_for(self, archive_table_type: "active")
+        active = query.call(active) if query
+
+        archived = select_archive_attributes_for(archive, archive_table_type: "archived")
+        archived = query.call(archived) if query
+
+        sql = "(#{active.to_sql}) UNION (#{archived.to_sql})"
+
+        if order
+          sql << sanitize_sql([" ORDER BY %s", order])
+        end
+        if limit
+          sql << sanitize_sql([" LIMIT %s", limit])
+        end
+        if offset
+          sql << sanitize_sql([" OFFSET %s", offset])
+        end
+
+        find_active_and_archived_by_sql(sql)
+      end
+
+      def archive_aged_records(where: ['created_at < ?', 6.months.ago], order: :id, batch_size: 100, before_callback: nil)
+        return unless archive
+
+        records = nil
+        while records.nil? || records.any?
+          before_callback.call if before_callback
+
+          records = self.where(where).order(order).limit(batch_size)
+          transaction do
+            records.each(&:archive!)
+          end
+        end
+      end
+
+      attr_reader :archive_associations
+
+      def has_archive_associations(associations)
+        @archive_associations = associations
+      end
+
+      private
+        def select_archive_attributes_for(relation, archive_table_type: nil)
+          quoted_type = connection.quote(archive_table_type)
+
+          relation.select(attribute_names).select("#{quoted_type} as archive_table_type")
+        end
+
+        def find_active_and_archived_by_sql(sql)
+          connection.select_all(sanitize_sql(sql), "#{name} Union Load").map do |record|
+            model = record["archive_table_type"] == 'archived' ? archive : self
+            model.instantiate(record)
+          end
+        end
+    end
+
+    def archive!
+      transaction do
+        self.class.archive.new.tap do |archive|
+          attributes.each { |k, v| archive[k] = v }
+          raise "Unarchivable attributes" if archive.attributes != attributes
+
+          archive.save!(validate: false)
+        end
+
+        archive_associations!
+        delete
+      end
+    end
+
+    private
+      def archive_associations!
+        Array(self.class.archive_associations).each do |assoc_name|
+          next unless association = send(assoc_name)
+
+          if association.respond_to?(:archive!)
+            association.archive!
+          elsif association.respond_to?(:each)
+            association.select { |a| a.respond_to?(:archive!) }.each(&:archive!)
+          end
+        end
+      end
+  end
+end

data/lib/archiving/migrations.rb

@@ -0,0 +1,16 @@
+require "active_support/concern"
+
+module Archiving
+  module Migrations
+    extend ActiveSupport::Concern
+
+    included do
+      def create_archive_table(table)
+        active_table = quote_table_name(table)
+        archive_table = quote_table_name("#{table}_archive")
+
+        execute("CREATE TABLE IF NOT EXISTS #{archive_table} LIKE #{active_table}")
+      end
+    end
+  end
+end

data/lib/archiving/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+
+module Archiving
+  class Railtie < ::Rails::Railtie
+    initializer 'archiving.install' do |app|
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.include ArchiveTable
+        ActiveRecord::ConnectionAdapters::SchemaStatements.include Migrations
+      end
+    end
+  end
+end

data/lib/archiving.rb

@@ -0,0 +1,3 @@
+require "archiving/archive_table"
+require "archiving/migrations"
+require "archiving/railtie" if defined?(Rails.application)

data/test/archive_table_test.rb

@@ -0,0 +1,195 @@
+require 'test_helper'
+
+class ArchiveTableTest < ActiveSupport::TestCase
+  setup do
+    Post.delete_all
+    Post::Archive.delete_all
+  end
+
+  test "creates archive model" do
+    assert Post::Archive < Post
+  end
+
+  test "shorthand for archive model" do
+    assert_equal Post::Archive, Post.archive
+  end
+
+  test "add archive suffix to table name" do
+    assert_equal "posts_archive", Post::Archive.table_name
+  end
+
+  test "with_archive unions results from both tables" do
+    p1 = Post.create!
+    a1 = Post::Archive.create!
+
+    set = Post.with_archive
+
+    assert_equal Set.new([p1, a1]), Set.new(set)
+  end
+
+  test "with_archive applies lambda to query" do
+    Post.create!(title: "Post 1", tag: "news")
+    p2 = Post.create!(title: "Post 2", tag: "misc")
+    Post::Archive.create!(title: "Archive 1", tag: "news")
+    a2 = Post::Archive.create!(title: "Archive 2", tag: "misc")
+
+    set = Post.with_archive(lambda {|scoped|
+      scoped.where(tag: "misc")
+    })
+
+    assert_equal Set.new([p2, a2]), Set.new(set)
+  end
+
+  test "with_archive takes :limit" do
+    Post.create!
+    Post.create!
+    Post::Archive.create!
+    Post::Archive.create!
+
+    set = Post.with_archive(limit: 3)
+
+    assert_equal 3, set.size
+  end
+
+  test "with_archive takes :offset" do
+    Post.create!
+    Post.create!
+    Post::Archive.create!
+    Post::Archive.create!
+
+    set = Post.with_archive(limit: 10, offset: 2)
+
+    assert_equal 2, set.size
+  end
+
+  test "with_archive takes :order" do
+    p1 = Post.create!(tag: 3)
+    p2 = Post.create!(tag: 4)
+    a1 = Post::Archive.create!(tag: 1)
+    a2 = Post::Archive.create!(tag: 2)
+
+    set = Post.with_archive(order: "tag DESC")
+
+    assert_equal [p2, p1, a2, a1], set
+  end
+
+  test "with_archive takes lambda and options" do
+    Post.create!(title: "4", tag: "news")
+    Post.create!(title: "3", tag: "misc")
+    a1 = Post::Archive.create!(title: "2", tag: "misc")
+    a2 = Post::Archive.create!(title: "1", tag: "misc")
+
+    set = Post.with_archive(
+      lambda {|scoped|
+        scoped.where(tag: "misc")
+      },
+      limit: 2,
+      order: "title ASC"
+    )
+
+    assert_equal [a2, a1], set
+  end
+
+  test "new archive records can be persisted" do
+    assert_nothing_raised do
+      Post::Archive.create!
+    end
+  end
+
+  test "existing archive records are read only" do
+    archive = Post::Archive.create!
+    archive = Post::Archive.find(archive.id)
+
+    assert_raises(ActiveRecord::ReadOnlyRecord) do
+      archive.update_attribute(:title, "New post")
+    end
+  end
+
+  test "existing archive records fetched with with_archive are read only" do
+    Post::Archive.create!
+
+    archive = Post.with_archive.first
+
+    assert_raises(ActiveRecord::ReadOnlyRecord) do
+      archive.title = "New post"
+      archive.save!
+    end
+  end
+
+  test "archiving aged records" do
+    p1 = Post.create!(title: "Post 1", tag: "news")
+    p2 = Post.create!(title: "Post 2", tag: "misc")
+
+    assert_difference "Post.count", -1 do
+      assert_difference "Post::Archive.count", 1 do
+        Post.archive_aged_records(where: "tag = 'news'")
+      end
+    end
+    assert_nil Post.find_by_id p1.id
+    assert Post::Archive.find_by_id p1.id
+    assert Post.find_by_id p2.id
+    assert_nil Post::Archive.find_by_id p2.id
+  end
+
+  test "archiving aged records with before callback" do
+    Post.create!(title: "Post 1", tag: "news")
+    Post.create!(title: "Post 2", tag: "misc")
+    before_called = false
+
+    Post.archive_aged_records(where: "tag = 'news'", before_callback: lambda {
+      before_called = true
+    })
+
+    assert_equal true, before_called
+  end
+
+  test "archiving a specific record" do
+    p1 = Post.create!(title: "Post 1", tag: "news")
+    assert_difference "Post.count", -1 do
+      assert_difference "Post::Archive.count", 1 do
+        p1.archive!
+      end
+    end
+    assert_nil Post.find_by_id p1.id
+    assert Post::Archive.find_by_id p1.id
+  end
+
+  test "archiving associations" do
+    p1 = Post.create!(title: "Post 1", tag: "news")
+    l1 = LogDay.create!(day: Date.today, post: p1)
+    l1.log_lines.create!(descr: "hallo")
+    l1.log_lines.create!(descr: "hurra")
+    assert_equal 2, l1.log_lines.count
+
+    l1.archive!
+    assert_nil LogDay.find_by_id l1.id
+    assert LogDay.archive.find_by_id l1.id
+    assert_nil Post.find_by_id p1.id
+    assert Post.archive.find_by_id p1.id
+    l1.log_lines.each do |l|
+      assert_nil LogLine.find_by_id l.id
+      assert LogLine.archive.find_by_id l.id
+    end
+  end
+
+  test "archiving polymorphic associations" do
+    p1 = Post.create!(title: "Post 1", tag: "news")
+    l1 = LogDay.create!(day: Date.today, postable: p1)
+    assert_nil l1.post
+    assert_equal p1, l1.postable
+    l1.log_lines.create!(descr: "hallo")
+    l1.log_lines.create!(descr: "hurra")
+    assert_equal 2, l1.log_lines.count
+
+    l1.archive!
+    assert_nil LogDay.find_by_id l1.id
+    assert LogDay.archive.find_by_id l1.id
+    assert_nil Post.find_by_id p1.id
+    assert Post.archive.find_by_id p1.id
+    l1.log_lines.each do |l|
+      assert_nil LogLine.find_by_id l.id
+      assert LogLine.archive.find_by_id l.id
+    end
+  end
+
+end

data/test/archiving_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ArchivingTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Archiving
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# 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