acts_as_archivable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cff6426e1832c13129e9e437e184bf50eca1d458
+  data.tar.gz: 23055f73081f54aef61bee39dfe902a8e54f119e
+SHA512:
+  metadata.gz: c2bedb6b66769f7f8e2282c17addb49e35e9a3a47293ddbcf1ea9a9ec4c70e6d82973371efda718bf3bae7f7e43d19c93b7f3cf9ab59951f32c1f00dd75d9a73
+  data.tar.gz: 4b1e6c118df59bca4e9aa4e324ee567f48bc54ae4cdbef01111daad825fd2b143e5e5a60ce9e2e6bfe8c9b94da64f441df0dc5b3983b40fcc4abf78c7f48e10c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_archivable.gemspec
+gemspec
+
+gem 'rspec-core'

data/Guardfile

@@ -0,0 +1,52 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features)
+
+## Uncomment to clear the screen before every task
+# clearing :on
+
+## Guard internally checks for changes in the Guardfile and exits.
+## If you want Guard to automatically start up again, run guard in a
+## shell loop, e.g.:
+##
+##  $ while bundle exec guard; do echo "Restarting Guard..."; done
+##
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  watch(%r{^lib/acts_as_archivable/(.+)/(.+)\.rb$}) { |m| "spec/#{m[1]}/#{m[2]}_spec.rb" }
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jon Collier
+
+MIT License
+
+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,39 @@
+# ActsAsArchivable
+
+ActsAsArchivable makes it super easy to move database records to an archive table.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'acts_as_archivable'
+```
+
+And then execute:
+
+    $ bundle
+
+## WARNING
+This gem contains an `eval` call! `lib/acts_as_archivable/migrating.rb` calls `eval(archived_table_schema)` in order to create the archived version of a given table.
+
+## Usage
+### Setup
+
+    class Comment < ActiveRecord::Base
+      acts_as_archivable months_to_keep: 2
+    end
+
+### Scopes
+
+    # all records older than 2 months
+    Comment.to_be_archived
+
+
+### Moving Rows
+
+    # Creates an ArchivedComment, destroys this comment
+    @comment.move_to_archive
+
+    # Move appropriate rows to the archive
+    Comment.to_be_archived.find_each(&:move_to_archive)

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/acts_as_archivable.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_archivable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'acts_as_archivable'
+  spec.version       = ActsAsArchivable::VERSION
+  spec.authors       = ['Jon Collier']
+  spec.email         = ['jcollier@atlantistech.com']
+  spec.summary       = 'ActsAsArchivable makes it super easy '\
+                       'to move database records to an archive table.'
+  spec.description   = 'There has never been a better time '\
+                       'to move database records to an archive table.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+end

data/lib/acts_as_archivable.rb

@@ -0,0 +1,29 @@
+require 'active_record'
+require 'active_record/version'
+require 'active_support/core_ext/module'
+
+require 'acts_as_archivable/version'
+require 'acts_as_archivable/naming'
+require 'acts_as_archivable/schema'
+require 'acts_as_archivable/migrating'
+require 'acts_as_archivable/instance_methods'
+
+module ActsAsArchivable
+  def acts_as_archivable(options = {})
+    extend ActsAsArchivable::Naming
+    extend ActsAsArchivable::Schema
+    extend ActsAsArchivable::Migrating
+
+    options[:months_to_keep] ||= 2
+
+    scope :to_be_archived, -> { where('created_at < ?', options[:months_to_keep].months.ago) }
+
+    Object.const_set(archived_class_name, Class.new(self))
+    archived_class.table_name = archived_table_name
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  extend ActsAsArchivable
+  include ActsAsArchivable::InstanceMethods
+end

data/lib/acts_as_archivable/instance_methods.rb

@@ -0,0 +1,9 @@
+module ActsAsArchivable
+  module InstanceMethods
+    def move_to_archive
+      archived_object = self.class.archived_class.create(attributes)
+      destroy
+      archived_object
+    end
+  end
+end

data/lib/acts_as_archivable/migrating.rb

@@ -0,0 +1,8 @@
+module ActsAsArchivable
+  module Migrating
+    def create_archived_table
+      return if ActiveRecord::Migration.table_exists?(archived_table_name)
+      eval(archived_table_schema)
+    end
+  end
+end

data/lib/acts_as_archivable/naming.rb

@@ -0,0 +1,15 @@
+module ActsAsArchivable
+  module Naming
+    def archived_table_name
+      "archived_#{table_name}"
+    end
+
+    def archived_class_name
+      "Archived#{self}"
+    end
+
+    def archived_class
+      archived_class_name.constantize
+    end
+  end
+end

data/lib/acts_as_archivable/schema.rb

@@ -0,0 +1,17 @@
+module ActsAsArchivable
+  module Schema
+    def table_schema
+      schema = ActiveRecord::SchemaDumper
+               .send(:new, ActiveRecord::Base.connection)
+               .send(:table, table_name, Tempfile.new('temporary_schema'))
+      schema.rewind
+      schema.read
+    end
+
+    def archived_table_schema
+      table_schema
+        .gsub(/#{table_name}/, archived_table_name)
+        .gsub(/(create_table|add_index)/, 'ActiveRecord::Migration.\1')
+    end
+  end
+end

data/lib/acts_as_archivable/version.rb

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

data/spec/migrating_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe ActsAsArchivable::Migrating do
+  before(:all) do
+    class PageRequest < ActiveRecord::Base
+      acts_as_archivable
+    end
+  end
+  subject! { PageRequest }
+
+  it { is_expected.to respond_to :create_archived_table }
+end

data/spec/naming_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe ActsAsArchivable::Naming do
+  before(:all) do
+    class PageRequest < ActiveRecord::Base
+      acts_as_archivable
+    end
+  end
+  subject! { PageRequest }
+
+  it 'identifies archived class name' do
+    expect(subject.archived_class_name).to eq 'ArchivedPageRequest'
+  end
+
+  it 'identifies archived table name' do
+    expect(subject.archived_table_name).to eq 'archived_page_requests'
+  end
+
+  it 'identifies archived class' do
+    expect(subject.archived_class).to eq ArchivedPageRequest
+  end
+end

data/spec/schema_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ActsAsArchivable::Schema do
+  before(:all) do
+    class PageRequest < ActiveRecord::Base
+      acts_as_archivable
+    end
+  end
+  subject! { PageRequest }
+  let!(:schema) do
+    "  create_table \"page_requests\", force: :cascade do |t|\n    t.integer  \"monitored_page_id\", limit: 4\n    t.integer  \"status\",            limit: 4\n    t.float    \"response_time\",     limit: 24\n    t.datetime \"created_at\",                    null: false\n    t.datetime \"updated_at\",                    null: false\n    t.string   \"proxy\",             limit: 255\n  end\n\n  add_index \"page_requests\", [\"proxy\"], name: \"index_page_requests_on_proxy\", using: :btree\n\n"
+  end
+
+  it { is_expected.to respond_to :table_schema }
+  it { is_expected.to respond_to :archived_table_schema }
+
+  it 'formats an archived schema' do
+    allow(subject).to receive(:table_schema).and_return schema
+    expect(subject.archived_table_schema).to include 'ActiveRecord::Migration.create_table "archived_page_requests"'
+    expect(subject.archived_table_schema).to include 'ActiveRecord::Migration.add_index "archived_page_requests"'
+    puts subject.archived_table_schema
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'pry'
+require 'acts_as_archivable'
+
+RSpec.configure do |config|
+  # config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.expect_with :rspec do |_c|
+    # c.syntax = :should
+  end
+
+  # config.mock_framework = :mocha
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_archivable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jon Collier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: There has never been a better time to move database records to an archive
+  table.
+email:
+- jcollier@atlantistech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_archivable.gemspec
+- lib/acts_as_archivable.rb
+- lib/acts_as_archivable/instance_methods.rb
+- lib/acts_as_archivable/migrating.rb
+- lib/acts_as_archivable/naming.rb
+- lib/acts_as_archivable/schema.rb
+- lib/acts_as_archivable/version.rb
+- spec/migrating_spec.rb
+- spec/naming_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ActsAsArchivable makes it super easy to move database records to an archive
+  table.
+test_files:
+- spec/migrating_spec.rb
+- spec/naming_spec.rb
+- spec/schema_spec.rb
+- spec/spec_helper.rb