active_archive 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4a27cc51a169e10a792eb78e458c4f578f86000b
-  data.tar.gz: 3b1f2b28213632d8d97a26b77cb1c3e0fbb79079
+  metadata.gz: 870fb2643b79b471095f5e3c621c56019628cf93
+  data.tar.gz: 5811d3442ada47fc1ddafea1f2acab79212d584d
 SHA512:
-  metadata.gz: 534b1317fa36b6dc2822dc783b4817b7ff3db6c8b7255298808ee0f014a18aa3aaec0a2ddb9dd1914317559a2fde0fdec6f792161a79949b8031b83ee429bc4e
-  data.tar.gz: b7dba38f3a22e7ad42d5b4a9714fe1be10bf460e7c2ab6d4764b6675f339090af17c1b01242a0ad6dadbe9c587395b4a3dd99895b4d64fb439642f99c4f2bff3
+  metadata.gz: 213c9daf7f511404a5f92eea6f31a1e978feeb03cbcb32e0b5da70c93906f48332f8c02e2359aa71a8d0611071b6ebdea24049d56ff013f709c7b6cf27c9f29e
+  data.tar.gz: af77de6275006aa877d1326f695fb161b72ce46986c6e39fa5554b7455bf41513a1cc9f69b0bc40b7e9a7331e6b0bf9522446b594e775e6587f30c20035495d3

data/.fasterer.yml

@@ -0,0 +1,19 @@
+speedups:
+  rescue_vs_respond_to: true
+  module_eval: true
+  shuffle_first_vs_sample: true
+  for_loop_vs_each: true
+  each_with_index_vs_while: false
+  map_flatten_vs_flat_map: true
+  reverse_each_vs_reverse_each: true
+  select_first_vs_detect: true
+  sort_vs_sort_by: true
+  fetch_with_argument_vs_block: true
+  keys_each_vs_each_key: true
+  hash_merge_bang_vs_hash_brackets: true
+  block_vs_symbol_to_proc: true
+  proc_call_vs_yield: true
+  gsub_vs_tr: true
+  select_last_vs_reverse_detect: true
+  getter_vs_attr_reader: true
+  setter_vs_attr_writer: true

data/.flayignore

@@ -0,0 +1,2 @@
+./spec/lib/active_archive/*.rb
+./spec/support/db/*.rb

data/.reek

@@ -0,0 +1,20 @@
+---
+Attribute:
+  enabled: false
+FeatureEnvy:
+  exclude:
+    - 'ActiveArchive::Base#retrieve_dependent_records'
+IrresponsibleModule:
+  enabled: false
+NilCheck:
+  enabled: false
+ManualDispatch:
+  enabled: false
+NestedIterators:
+  max_allowed_nesting: 2
+TooManyStatements:
+  max_statements: 10
+  exclude:
+    - 'ActiveArchive::Base#retrieve_dependent_records'
+UtilityFunction:
+  enabled: false

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  TargetRubyVersion: 2.3
+LineLength:
+  Max: 120
+Rails/Delegate:
+  Enabled: false
+Rails/Output:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/FirstParameterIndentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: aligned
+Style/RescueModifier:
+  Enabled: false

data/Gemfile

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

data/README.md

@@ -11,7 +11,7 @@ ActiveArchive is a library for preventing database records from being destroyed.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "active_archive"
+gem 'active_archive'
 ```
 
 And then execute:
@@ -37,12 +37,10 @@ Or install it yourself as:
 `rails generate active_archive:install` will generate the following `active_archive.rb` file:
 
 ```ruby
-# config/initalizers/active_archive.rb
+# Path: ../config/initalizers/active_archive.rb
 
-ActiveArchive.configure do |config|
-  # option = default
-
-  config.all_records_archivable  = false
+ActiveArchive::Settings.configure do |config|
+  config.all_records_archivable = false
   config.dependent_record_window = 3.seconds
 end
 ```

data/Rakefile

@@ -1,3 +1,3 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 task default: :spec

data/active_archive.gemspec

@@ -1,30 +1,35 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "active_archive/version"
+require 'active_archive/version'
 
 Gem::Specification.new do |spec|
-  spec.name = "active_archive"
+  spec.name = 'active_archive'
   spec.version = ActiveArchive::VERSION
-  spec.authors = ["Juan Gomez"]
-  spec.email = ["j.gomez@drexed.com"]
+  spec.authors = ['Juan Gomez']
+  spec.email = ['j.gomez@drexed.com']
 
-  spec.summary = %q{Gem for soft-deleting ActiveRecord objects.}
-  spec.description = %q{Prevent database records from being destroyed.}
-  spec.homepage = "https://github.com/drexed/active_archive"
+  spec.summary = 'Gem for soft-deleting ActiveRecord objects.'
+  spec.description = 'Prevent database records from being destroyed.'
+  spec.homepage = 'https://github.com/drexed/active_archive'
 
   spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib", "support"]
+  spec.require_paths = %w(lib support)
 
-  spec.add_runtime_dependency "rails"
+  spec.add_runtime_dependency 'rails'
+  spec.add_runtime_dependency 'dry-configurable'
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "coveralls"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "sqlite3"
-  spec.add_development_dependency "database_cleaner"
-  spec.add_development_dependency "generator_spec"
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'flay'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'rubocop'
 end

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "active_archive"
+require 'bundler/setup'
+require 'active_archive'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "active_archive"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start

data/bin/rake

@@ -6,11 +6,10 @@
 # this file is here to facilitate running it.
 #
 
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
 
-require "rubygems"
-require "bundler/setup"
+require 'rubygems'
+require 'bundler/setup'
 
-load Gem.bin_path("rake", "rake")
+load Gem.bin_path('rake', 'rake')

data/config/locales/en.yml

@@ -1,5 +1,5 @@
 en:
   active_archive:
     archival:
-      archived: "Archived"
-      unarchived: "Unarchived"
+      archived: 'Archived'
+      unarchived: 'Unarchived'

data/lib/active_archive/base.rb

@@ -9,14 +9,14 @@ module ActiveArchive
     end
 
     def archived?
-      archivable? ? !!archived_at : destroyed?
+      archivable? ? !archived_at.nil? : destroyed?
     end
 
     def archivable?
       respond_to?(:archived_at)
     end
 
-    def destroy(force=nil)
+    def destroy(force = nil)
       with_transaction_returning_status do
         if unarchivable? || should_force_destroy?(force)
           permanently_delete_records_after { super() }
@@ -33,9 +33,9 @@ module ActiveArchive
       I18n.t("active_archive.archival.#{archived? ? :archived : :unarchived}")
     end
 
-    def unarchive(options=nil)
+    def unarchive(opts = nil)
       with_transaction_returning_status do
-        (should_unarchive_parent_first?(options) ? unarchival.reverse : unarchival).each { |r| r.call(options) }
+        (should_unarchive_parent_first?(opts) ? unarchival.reverse : unarchival).each { |record| record.call(opts) }
         self
       end
     end
@@ -53,40 +53,34 @@ module ActiveArchive
     private
 
     def attempt_notifying_observers(callback)
-      notify_observers(callback)
-    rescue NoMethodError
-      # RETURN
+      notify_observers(callback) if respond_to?(:notify_observers)
     end
 
-    def destroy_with_active_archive(force=nil)
+    def destroy_with_active_archive(force = nil)
       run_callbacks(:destroy) do
-        (archived? || new_record?) ? save : set_archived_at(Time.now, force)
-        true
+        archived? || new_record? ? save : set_archived_at(Time.now, force)
+        return(true)
       end
 
       archived? ? self : false
     end
 
-    def get_archived_record
+    def retrieve_archived_record
       self.class.unscoped.find(id)
     end
 
-    def get_dependent_records
+    def retrieve_dependent_records
       dependent_records = {}
 
       self.class.reflections.each do |key, reflection|
         next unless reflection.options[:dependent] == :destroy
-        next unless records = send(key)
 
-        if records.respond_to? :size
-          next unless records.size > 0
-        else
-          records = [] << records
-        end
+        records = send(key)
+        next unless records
+        records.respond_to?(:empty?) ? (next if records.empty?) : (records = [] << records)
 
         dependent_record = records.first
-        next if dependent_record.nil?
-        dependent_records[dependent_record.class] = records.map(&:id)
+        dependent_record.nil? ? next : dependent_records[dependent_record.class] = records.map(&:id)
       end
 
       dependent_records
@@ -104,16 +98,16 @@ module ActiveArchive
     end
 
     def permanently_delete_records_after(&block)
-      dependent_records = get_dependent_records
-      dependent_results = yield
+      dependent_records = retrieve_dependent_records
+      dependent_results = yield(block)
       permanently_delete_records(dependent_records) if dependent_results
-      return(dependent_results)
+      dependent_results
     end
 
     def unarchival
       [
-        ->(validate) { unarchive_destroyed_dependent_records(validate) },
-        ->(validate) do
+        -> (validate) { unarchive_destroyed_dependent_records(validate) },
+        lambda do |validate|
           run_callbacks(:unarchive) do
             set_archived_at(nil, validate)
             return(true)
@@ -122,44 +116,51 @@ module ActiveArchive
       ]
     end
 
-    def unarchive_destroyed_dependent_records(force = nil)
-      self.class.reflections.select do |name, reflection|
-        "destroy" == reflection.options[:dependent].to_s && reflection.klass.archivable?
-      end.each do |name, reflection|
-        cardinality = reflection.macro.to_s.gsub("has_", "").to_sym
-        case cardinality
-        when :many
-          records = (archived_at ? set_record_window(send(name), name, reflection) : send(name))
-        when :one, :belongs_to
-          self.class.unscoped { records = [] << send(name) }
-        end
+    def dependent_records_for_unarchival(name, reflection)
+      record = send(name)
 
-        [records].flatten.compact.each { |d| d.unarchive(force) }
-        send(name, :reload)
+      case reflection.macro.to_s.gsub('has_', '').to_sym
+      when :many
+        records = archived_at ? set_record_window(record, name, reflection) : record
+      when :one, :belongs_to
+        self.class.unscoped { records = [] << record }
       end
+
+      [records].flatten.compact
     end
 
-    def set_archived_at(value, force=nil)
+    def unarchive_destroyed_dependent_records(force = nil)
+      self.class.reflections
+          .select { |_, reflection| 'destroy' == reflection.options[:dependent].to_s && reflection.klass.archivable? }
+          .each do |name, reflection|
+            dependent_records_for_unarchival(name, reflection).each { |record| record.unarchive(force) }
+          end
+    end
+
+    def set_archived_at(value, force = nil)
       return self unless archivable?
-      record = get_archived_record
+      record = retrieve_archived_record
       record.archived_at = value
 
       begin
         should_ignore_validations?(force) ? record.save(validate: false) : record.save!
-        @attributes = record.instance_variable_get("@attributes")
-      rescue => e
+        @attributes = record.instance_variable_get('@attributes')
+      rescue => error
         record.destroy
-        raise(e)
+        raise(error)
       end
     end
 
-    def set_record_window(request, name, reflection)
+    def set_record_window(_, name, reflection)
+      quoted_table_name = reflection.quoted_table_name
+      window = ActiveArchive::Settings.config.dependent_record_window
+
       send(name).unscope(where: :archived_at)
                 .where([
-                        "#{reflection.quoted_table_name}.archived_at > ? AND #{reflection.quoted_table_name}.archived_at < ?",
-                        archived_at - ActiveArchive.configuration.dependent_record_window,
-                        archived_at + ActiveArchive.configuration.dependent_record_window
-                      ])
+                         "#{quoted_table_name}.archived_at > ? AND #{quoted_table_name}.archived_at < ?",
+                         archived_at - window,
+                         archived_at + window
+                       ])
     end
 
     def should_force_destroy?(force)
@@ -176,3 +177,5 @@ module ActiveArchive
 
   end
 end
+
+ActiveRecord::Base.include(ActiveArchive::Base)

data/lib/active_archive/methods.rb

@@ -2,15 +2,15 @@ module ActiveArchive
   module Methods
 
     def archivable?
-      columns.detect { |c| c.name == "archived_at" }
+      columns.detect { |column| column.name == 'archived_at' }
     end
 
-    def archive_all(conditions=nil)
+    def archive_all(conditions = nil)
       conditions ? where(conditions).destroy_all : destroy_all
     end
 
-    def unarchive_all(conditions=nil)
-      (conditions ? where(conditions) : all).to_a.each { |r| r.unarchive }
+    def unarchive_all(conditions = nil)
+      (conditions ? where(conditions) : all).to_a.each(&:unarchive)
     end
 
   end

data/lib/active_archive/railtie.rb

@@ -0,0 +1,19 @@
+module ActiveArchive
+  class Railtie < ::Rails::Railtie
+
+    initializer 'active_archive' do |app|
+      ActiveArchive::Railtie.instance_eval do
+        [app.config.i18n.available_locales].flatten.each do |locale|
+          (I18n.load_path << path(locale)) if File.file?(path(locale))
+        end
+      end
+    end
+
+    protected
+
+    def path(locale)
+      File.expand_path("../../config/locales/#{locale}.yml", __FILE__)
+    end
+
+  end
+end

data/lib/active_archive/settings.rb

@@ -0,0 +1,11 @@
+require 'dry-configurable'
+
+module ActiveArchive
+  class Settings
+    extend Dry::Configurable
+
+    setting :all_records_archivable, false
+    setting :dependent_record_window, 3.seconds
+
+  end
+end

data/lib/active_archive/table_definition.rb

@@ -1,14 +1,20 @@
-module ActiveRecord
-  module ConnectionAdapters
-    class TableDefinition
+module ActiveArchive
+  module TableDefinition
 
-      def timestamps_with_archived_at(options)
-        timestamps_without_archived_at(options)
-        column(:archived_at, :datetime) if ActiveArchive.configuration.all_records_archivable
-      end
+    def timestamps(*args)
+      options = args.extract_options!
+      options[:null] = false if options[:null].nil?
 
-      alias_method_chain(:timestamps, :archived_at)
+      column(:created_at, :datetime, options)
+      column(:updated_at, :datetime, options)
 
+      if ActiveArchive::Settings.config.all_records_archivable == true
+        options[:null] = true
+        column(:archived_at, :datetime, options)
+      end
     end
+
   end
 end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.prepend(ActiveArchive::TableDefinition)

data/lib/active_archive/version.rb

@@ -1,3 +1,3 @@
 module ActiveArchive
-  VERSION = "3.0.0"
+  VERSION = '4.0.0'.freeze
 end

data/lib/active_archive.rb

@@ -1,56 +1,9 @@
-require "active_archive/version"
-require "active_archive/configuration"
-
-module ActiveArchive
-
-  class << self
-    attr_accessor :configuration
-  end
-
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
-
-  def self.configuration=(config)
-    @configuration = config
-  end
-
-  def self.configure
-    yield(configuration)
-  end
-
-end
-
-require "active_archive/table_definition"
-require "active_archive/methods"
-require "active_archive/scopes"
-require "active_archive/base"
-require "generators/active_archive/install_generator"
-
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.send(:include, ActiveArchive::Base)
-end
-
-if defined?(Rails)
-  require "rails"
-
-  module ActiveArchive
-    class Railtie < ::Rails::Railtie
-
-      initializer "active_archive" do |app|
-        ActiveArchive::Railtie.instance_eval do
-          [app.config.i18n.available_locales].flatten.each do |locale|
-            (I18n.load_path << path(locale)) if File.file?(path(locale))
-          end
-        end
-      end
-
-      protected
-
-      def self.path(locale)
-        File.expand_path("../../config/locales/#{locale}.yml", __FILE__)
-      end
-
-    end
-  end
-end
+require 'rails'
+require 'active_archive/version'
+require 'active_archive/railtie'
+require 'active_archive/settings'
+require 'active_archive/table_definition'
+require 'active_archive/methods'
+require 'active_archive/scopes'
+require 'active_archive/base'
+require 'generators/active_archive/install_generator'

data/lib/generators/active_archive/install_generator.rb

@@ -1,11 +1,11 @@
-require "rails/generators"
+require 'rails/generators'
 
 module ActiveArchive
   class InstallGenerator < Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path('../templates', __FILE__)
 
     def copy_initializer_file
-      copy_file("install.rb", "config/initializers/active_archive.rb")
+      copy_file('install.rb', 'config/initializers/active_archive.rb')
     end
 
   end

data/lib/generators/active_archive/templates/install.rb

@@ -1,4 +1,4 @@
-ActiveArchive.configure do |config|
+ActiveArchive::Settings.configure do |config|
   config.all_records_archivable = false
   config.dependent_record_window = 3.seconds
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_archive
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Juan Gomez
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-03 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  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
@@ -122,6 +136,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fasterer
+  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: flay
+  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: reek
+  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: rubocop
+  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: Prevent database records from being destroyed.
 email:
 - j.gomez@drexed.com
@@ -130,8 +200,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".fasterer.yml"
+- ".flayignore"
 - ".gitignore"
+- ".reek"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -144,9 +218,10 @@ files:
 - config/locales/en.yml
 - lib/active_archive.rb
 - lib/active_archive/base.rb
-- lib/active_archive/configuration.rb
 - lib/active_archive/methods.rb
+- lib/active_archive/railtie.rb
 - lib/active_archive/scopes.rb
+- lib/active_archive/settings.rb
 - lib/active_archive/table_definition.rb
 - lib/active_archive/version.rb
 - lib/generators/active_archive/install_generator.rb

data/lib/active_archive/configuration.rb

@@ -1,10 +0,0 @@
-class ActiveArchive::Configuration
-
-  attr_accessor :all_records_archivable, :dependent_record_window
-
-  def initialize
-    @all_records_archivable = false
-    @dependent_record_window = 3.seconds
-  end
-
-end