acts_as_archival 0.4.0

data/test/scope_test.rb

@@ -0,0 +1,50 @@
+require_relative "test_helper"
+
+class ActsAsArchivalTest < ActiveSupport::TestCase
+  test "simple unarchived scope" do
+    Archival.create!
+    Archival.create!
+
+    assert_equal 2, Archival.unarchived.count
+  end
+
+  test "simple archived scope" do
+    Archival.create!.archive
+    Archival.create!.archive
+
+    assert_equal 2, Archival.archived.count
+  end
+
+  test "mixed scopes" do
+    Archival.create!
+    Archival.create!.archive
+
+    assert_equal 1, Archival.archived.count
+    assert_equal 1, Archival.unarchived.count
+  end
+
+  test "simple archived_from_archive_number" do
+    archive_number = "TEST-IT"
+    Archival.create!.archive(archive_number)
+    Archival.create!.archive(archive_number)
+
+    assert_equal 2, Archival.archived_from_archive_number(archive_number).count
+  end
+
+  test "negative archived_from_archive_number" do
+    archive_number = "TEST-IT"
+    bogus_number = "BROKE-IT"
+    Archival.create!.archive(archive_number)
+    Archival.create!.archive(archive_number)
+
+    assert_equal 0, Archival.archived_from_archive_number(bogus_number).count
+  end
+
+  test "mixed archived_from_archive_number" do
+    archive_number = "TEST-IT"
+    Archival.create!.archive(archive_number)
+    Archival.create!.archive
+
+    assert_equal 1, Archival.archived_from_archive_number(archive_number).count
+  end
+end

data/test/script/db_setup

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "yaml"
+require 'highline/import'
+
+def read_database_config
+  database_file = File.join(File.dirname(__FILE__), "/../", "database.yml")
+  $DB_CONFIG = YAML.load(File.read(database_file))
+end
+
+def get_root_password
+  $ROOT_PW = ask("Provide root mySQL password to setup '#{$DB_CONFIG["database"]}': ") { |q| q.echo = false}
+  if !$ROOT_PW || $ROOT_PW.empty?
+    puts "error reading password"
+    exit 4
+  end
+end
+
+def check_root_password
+  password_check = "echo 'show databases;' | mysql -u root -p'#{$ROOT_PW}' > /dev/null"
+  unless system password_check
+    puts "incorrect password"
+    exit 7
+  end
+end
+
+def execute_mysql(message, statement, user = nil, password = nil)
+  puts message
+  `echo '#{statement}' | mysql -u #{user} -p'#{password}'`
+end
+
+def drop_existing(db, user, pass)
+  drop_statement   = "drop database if exists #{db};"
+  execute_mysql("dropping #{db}", drop_statement, user, pass)
+end
+
+def create_db(db, user, pass)
+  create_statement =  "create database #{db};"
+  execute_mysql("creating #{db}", create_statement, user, pass)
+end
+
+def grant_permission_on_db(db, user, pass)
+  grant_statement  =  "grant all on `#{db}`.* to `#{$DB_CONFIG["username"]}`@`localhost` identified by \"#{$DB_CONFIG["password"]}\";"
+  execute_mysql("granting on #{db}", grant_statement, user, pass)
+end
+
+read_database_config
+get_root_password
+check_root_password
+
+db   = $DB_CONFIG["database"]
+user = "root"
+pass = $ROOT_PW
+
+drop_existing(db, user, pass)
+create_db(db, user, pass)
+grant_permission_on_db(db, user, pass)

data/test/test_helper.rb

@@ -0,0 +1,60 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require "bundler/setup"
+require "test/unit"
+require "active_record"
+require "assertions"
+require "database_cleaner"
+require "acts_as_archival"
+
+def prepare_for_tests
+  setup_logging if ENV["LOGGING_ENABLED"]
+  setup_active_record
+  setup_database_cleaner
+  create_test_tables
+  require_test_classes
+end
+
+def setup_logging
+  require "logger"
+  logfile = File.dirname(__FILE__) + "/debug.log"
+  ActiveRecord::Base.logger = Logger.new(logfile)
+end
+
+def setup_active_record
+  dbconfig_file = File.dirname(__FILE__) + "/database.yml"
+  dbconfig = YAML.load File.read(dbconfig_file)
+  ActiveRecord::Base.establish_connection(dbconfig)
+end
+
+def setup_database_cleaner
+  DatabaseCleaner.strategy = :truncation
+  ActiveSupport::TestCase.send(:setup) do
+    DatabaseCleaner.clean
+  end
+end
+
+def create_test_tables
+  schema_file   = File.dirname(__FILE__) + "/schema.rb"
+  load(schema_file) if File.exist?(schema_file)
+end
+
+def require_test_classes
+  ActiveSupport::Inflector.inflections do |inflect|
+    inflect.irregular "poly", "polys"
+  end
+
+  [:archival,
+   :archival_kid,
+   :archival_grandkid,
+   :independent_archival,
+   :exploder,
+   :plain,
+   :mass_attribute_protected,
+   :readonly_when_archived,
+   :missing_archived_at,
+   :missing_archive_number,
+   :poly
+  ].each {|test_class_file| require_relative "fixtures/#{test_class_file}"}
+end
+
+prepare_for_tests

data/test/through_association_test.rb

@@ -0,0 +1,25 @@
+require_relative "test_helper"
+
+class ThroughAssociationTest < ActiveSupport::TestCase
+  test "archive a through associated object whose 'bridge' is archival" do
+    archival = Archival.create!
+    bridge   = archival.archival_kids.create!
+    through  = bridge.archival_grandkids.create!
+    archival.archive
+
+    assert archival.reload.archived?
+    assert bridge.reload.archived?
+    assert through.reload.archived?
+  end
+
+  # TODO Make something like this pass
+  # test "archive a through associated object whose 'bridge' is not archival" do
+  #   archival = Archival.create!
+  #   bridge   = archival.independent_archival_kids.create!
+  #   through  = bridge.archival_grandkids.create!
+  #   archival.archive
+
+  #   assert archival.reload.archived?
+  #   assert through.reload.archived?
+  # end
+end

data/test/transaction_test.rb

@@ -0,0 +1,32 @@
+require_relative "test_helper"
+require "rr"
+
+class TransactionTest < ActiveSupport::TestCase
+  include RR::Adapters::TestUnit
+
+  test "archiving is transactional" do
+    archival = Archival.create!
+    exploder = archival.exploders.create!
+    any_instance_of(Exploder) do |exploder|
+      stub(exploder).archive { raise "Rollback Imminent" }
+    end
+    archival.archive
+
+    assert_not archival.archived?, "If this failed, you might be trying to test on a system that doesn't support nested transactions"
+    assert_not exploder.reload.archived?
+  end
+
+  test "unarchiving is transactional" do
+    archival = Archival.create!
+    exploder = archival.exploders.create!
+    any_instance_of(Exploder) do |exploder|
+      stub(exploder).unarchive { raise "Rollback Imminent" }
+    end
+    archival.archive
+    archival.unarchive
+
+    assert archival.reload.archived?
+    assert exploder.reload.archived?
+  end
+
+end

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_archival
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Joel Meador
+- Michael Kuehl
+- Matthew Gordon
+- Vojtech Salbaba
+- David Jones
+- Dave Woodward
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70256103651080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70256103651080
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70256103650640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103650640
+- !ruby/object:Gem::Dependency
+  name: assertions-eb
+  requirement: &70256103650140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103650140
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70256103649660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103649660
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: &70256103648960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103648960
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: &70256103648360 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103648360
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70256103647620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103647620
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70256103646620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70256103646620
+description: ! 'We had the problem that acts_as_paranoid and similar plugins/gems
+  always work on
+
+  a record by record basis and made it very difficult to restore records
+
+  atomically (or archive them, for that matter).
+
+
+  Because the archive and unarchive methods are in transactions, and every
+
+  archival record involved gets the same archive number upon archiving, you can
+
+  easily restore or remove an entire set of records without having to worry about
+
+  partial deletion or restoration.
+
+
+  Additionally, other plugins generally screw with how destroy/delete work.  We
+
+  don''t because we actually want to be able to destroy records.
+
+'
+email:
+- joel@expectedbehavior.com
+- michael@expectedbehavior.com
+- matt@expectedbehavior.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- acts_as_archival.gemspec
+- init.rb
+- lib/acts_as_archival.rb
+- lib/acts_as_archival/version.rb
+- lib/expected_behavior/acts_as_archival.rb
+- lib/expected_behavior/acts_as_archival_active_record_methods.rb
+- test/ambiguous_table_test.rb
+- test/associations_test.rb
+- test/basic_test.rb
+- test/column_test.rb
+- test/database.yml
+- test/deep_nesting_test.rb
+- test/fixtures/archival.rb
+- test/fixtures/archival_grandkid.rb
+- test/fixtures/archival_kid.rb
+- test/fixtures/exploder.rb
+- test/fixtures/independent_archival.rb
+- test/fixtures/mass_attribute_protected.rb
+- test/fixtures/missing_archive_number.rb
+- test/fixtures/missing_archived_at.rb
+- test/fixtures/plain.rb
+- test/fixtures/poly.rb
+- test/fixtures/readonly_when_archived.rb
+- test/mass_attribute_test.rb
+- test/polymorphic_test.rb
+- test/readonly_when_archived_test.rb
+- test/responds_test.rb
+- test/schema.rb
+- test/scope_test.rb
+- test/script/db_setup
+- test/test_helper.rb
+- test/through_association_test.rb
+- test/transaction_test.rb
+homepage: http://expectedbehavior.com
+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'
+      segments:
+      - 0
+      hash: -1239227818634757629
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1239227818634757629
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Atomic archiving/unarchiving for ActiveRecord-based apps
+test_files:
+- test/ambiguous_table_test.rb
+- test/associations_test.rb
+- test/basic_test.rb
+- test/column_test.rb
+- test/database.yml
+- test/deep_nesting_test.rb
+- test/fixtures/archival.rb
+- test/fixtures/archival_grandkid.rb
+- test/fixtures/archival_kid.rb
+- test/fixtures/exploder.rb
+- test/fixtures/independent_archival.rb
+- test/fixtures/mass_attribute_protected.rb
+- test/fixtures/missing_archive_number.rb
+- test/fixtures/missing_archived_at.rb
+- test/fixtures/plain.rb
+- test/fixtures/poly.rb
+- test/fixtures/readonly_when_archived.rb
+- test/mass_attribute_test.rb
+- test/polymorphic_test.rb
+- test/readonly_when_archived_test.rb
+- test/responds_test.rb
+- test/schema.rb
+- test/scope_test.rb
+- test/script/db_setup
+- test/test_helper.rb
+- test/through_association_test.rb
+- test/transaction_test.rb