lite-archive 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: eab433e896044aa98e3b783ad2cff008d0dd3e4f673cf3334690449c33d295e7
+  data.tar.gz: f54b9c5798ce6e4b79deaeb26c4246a39efb5e849a876831e0a850b9f9323cb0
+SHA512:
+  metadata.gz: 34db46befa8329a1343249d3dbd24cdb6010e636fa0cfe2a1d291eb1c0a24513cf74d792b9389d0a99296dd0735102a62fabfe7ffefa83ae46b04eb79f2f0d3d
+  data.tar.gz: 3ca9d5a415a4074eef9763b04eb87093c941da6f35ed6da29de9f91c59e9c54829a8604685999a89dcfebe63ce8c592d88d9fb8023ea5e2e60bce78e88890180

data/.fasterer.yml

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

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--backtrace
+--color
+--format progress
+--order random

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require:
+  - rubocop-performance
+  - rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.6
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+LineLength:
+  Max: 100
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'spec/**/**/*'
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines_except_namespace
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines_except_namespace
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/**/*'
+    - '*.gemspec'
+Metrics/ModuleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/ExpandPathArguments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.5
+- 2.6
+- ruby-head
+matrix:
+  fast_finish: true
+  allow_failures:
+  - rvm: ruby-head
+before_install:
+- gem update --system
+- gem install bundler
+install:
+- bundle install --jobs=3 --retry=3
+script:
+- bundle exec rspec
+- bundle exec rubocop
+- bundle exec fasterer
+notifications:
+  email: false
+  slack:
+    secure: VdEizS3D0v5cSQBgPDMooq5mGwf2sYQALnt0MF3dr/hLK36IeLI6FR5GkiC+qWXW88QnDm2i1HbgeM5SlSUZfU9EOGrnGIzCUe690q7XTI+N35P/Op59Ma1fOV2ojEjg2wwJzUVtfS6fYMzI0mfNAN8gg9ASN1fHtCnh5VK9AECC4931b0TxdwrJECRE+hzDSRGcmjqX+Nam0jj6GzJt0blBMcHpJAd+Ari/gGcb5v3+rBdzPLY79/HECZvzPORFDOqtgWKHv7gWQ44HEyGwJXp0fzBb1G1CCAwxMldqv7Jz4lPaADulFaAJOPMaNjTYIajhhjW8nG4zAav45cFhctpW/9YujYHBe9PnhmFFSopBGTJzXYJnAmTzrDKupZOxrLvx4ZWR+DRs7F6v73rPlKYpnmaEmy+wbp4Awju7Shc64veuCohw7sVMivUH634u6Yd5ezh22nyTb541i1RPwy0T7E9nRBXTz5sFnymQGUuvUfBPpRwDJUVxsBO86xofHHzY7YgKo2haiZP07wRX0LVxrnVyD31vMY+oTMAlvHK2WzGnX757gcXbwtLEb3qD8WYEi0mGVHSVo3CvYggv3mTCpgR2U3t+Wl9oxFDbNNQulaomSheBWVBcncYeftBLdZcLFTBtx/WbT/rppS4XxYrVkfGraJ17P6kGnhJCbmo=

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0] - 2019-07-01
+### Added
+- Initial project version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at j.gomez@drexed.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lite-archive.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    lite-archive (1.0.0)
+      activerecord
+      activesupport
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    database_cleaner (1.7.0)
+    diff-lcs (1.3)
+    erubi (1.8.0)
+    fasterer (0.5.1)
+      colorize (~> 0.7)
+      ruby_parser (>= 3.13.0)
+    generator_spec (0.9.4)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.2)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-rails (3.8.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.0)
+      rubocop (>= 0.71.0)
+    rubocop-rspec (1.33.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.1)
+    ruby_parser (3.13.1)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.12.1)
+    sqlite3 (1.4.1)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  database_cleaner
+  fasterer
+  generator_spec
+  lite-archive!
+  rake
+  rspec
+  rspec-rails
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  sqlite3
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Juan Gomez
+
+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,126 @@
+# Lite::Archive
+
+[![Gem Version](https://badge.fury.io/rb/lite-archive.svg)](http://badge.fury.io/rb/lite-archive)
+[![Build Status](https://travis-ci.org/drexed/lite-archive.svg?branch=master)](https://travis-ci.org/drexed/lite-archive)
+
+Lite::Archive is a library for archiving (soft-delete) database records.
+
+**NOTE:** If you are coming from `ActiveArchive`, please read the [port](#port) section.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lite-archive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lite-archive
+
+## Table of Contents
+
+* [Configurations](#configurations)
+* [Usage](#usage)
+* [Methods](#methods)
+* [Scopes](#scopes)
+* [Callbacks](#callbacks)
+* [Port](#port)
+
+## Configurations
+
+`rails g lite:archive:install` will generate the following file:
+`../config/initalizers/lite-archive.rb`
+
+```ruby
+Lite::Archive.configure do |config|
+  config.all_records_archivable = false
+end
+```
+
+## Usage
+
+An `archived_at` column must be added to tables where you do not want records destroyed.
+If the table does not have this column, records will be destroy instead of archived.
+
+```ruby
+class AddArchivedAtColumns < ActiveRecord::Migration
+  def change
+    # Adds archived_at automatically (if all_records_archivable is set to true)
+    t.timestamp
+
+    # Adds archived_at timestamp
+    t.timestamp archive: true
+
+    # Does NOT add archived_at timestamp
+    t.timestamp archive: false
+
+    # Manual column (null constraint must be false)
+    add_column :your_model, :archived_at, :datetime
+  end
+end
+```
+
+## Methods
+
+```ruby
+user = User.first
+user.archive        #=> Archives the User record and its dependents
+user.unarchive      #=> Unarchives the User record and its dependents
+user.to_archival    #=> Returns the User archival state locale string (ex: Archived)
+
+User.archive_all    #=> Archives all User records and their dependents
+User.unarchive_all  #=> Unarchives all User record and their dependents
+```
+
+## Scopes
+
+```ruby
+User.archived.all   #=> Returns only archived records
+User.unarchived.all #=> Returns only unarchived records
+```
+
+## Callbacks
+
+ ```ruby
+ class User < ActiveRecord::Base
+   # ... omitted ...
+
+   before_archive :do_something
+   after_archive :do_something
+
+   before_unarchived :do_something
+   after_unarchive :do_something
+
+   # ... omitted ...
+ end
+```
+
+## Port
+
+`Lite::Archive` is compatible port of [ActiveArchive](https://github.com/drexed/active_archive).
+
+Switching is as easy as renaming `ActiveArchive` to `Lite::Archive`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lite-archive. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lite::Archive project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lite-archive/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-leap-day

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lite/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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  lite:
+    archive:
+      archival:
+        archived: 'Archived'
+        unarchived: 'Unarchived'

data/lib/generators/lite/archive/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+module Lite
+  module Archive
+    class InstallGenerator < Rails::Generators::Base
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_initializer_file
+        copy_file('install.rb', 'config/initializers/lite-archive.rb')
+      end
+
+    end
+  end
+end

data/lib/generators/lite/archive/templates/install.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Lite::Archive.configure do |config|
+  config.all_records_archivable = false
+end

data/lib/lite/archive.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+
+require 'lite/archive/version'
+require 'lite/archive/railtie' if defined?(Rails)
+
+%w[configuration table_definition methods scopes base].each do |name|
+  require "lite/archive/#{name}"
+end
+
+require 'generators/lite/archive/install_generator'

data/lib/lite/archive/base.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+    module Base
+
+      def self.included(base)
+        base.extend Methods
+        base.extend Scopes
+
+        base.instance_eval do
+          %i[archive unarchive].each { |name| define_model_callbacks name, only: %i[before after] }
+        end
+      end
+
+      def archival?
+        return destroyed? if unarchivable?
+
+        (will_save_change_to_archived_at? || saved_change_to_archived_at?) && archived?
+      end
+
+      def archivable?
+        respond_to?(:archived_at)
+      end
+
+      def archived?
+        archivable? ? !archived_at.nil? : destroyed?
+      end
+
+      def archive
+        return destroy if unarchivable?
+
+        with_transaction_returning_status do
+          run_callbacks :archive do
+            mark_as_archived
+            mark_relections_as_archived
+            self
+          end
+        end
+      end
+
+      def unarchival?
+        return !destroyed? if unarchivable?
+
+        (will_save_change_to_archived_at? || saved_change_to_archived_at?) && unarchived?
+      end
+
+      def unarchived?
+        !archived?
+      end
+
+      def unarchivable?
+        !archivable?
+      end
+
+      def unarchive
+        return self if unarchivable?
+
+        with_transaction_returning_status do
+          run_callbacks :unarchive do
+            mark_as_unarchived
+            mark_relections_as_unarchived
+            self
+          end
+        end
+      end
+
+      def to_archival
+        I18n.t("lite.archive.archival.#{:un unless archived?}archived")
+      end
+
+      private
+
+      def dependent_destroy?(reflection)
+        reflection.options[:dependent] == :destroy
+      end
+
+      def mark_as_archived
+        ts = timestamp
+
+        self.updated_at = ts if updatable?
+        self.archived_at = ts
+        save(validate: false)
+      end
+
+      def mark_as_unarchived
+        self.updated_at = timestamp if updatable?
+        self.archived_at = nil
+        save(validate: false)
+      end
+
+      # rubocop:disable Metrics/CyclomaticComplexity, Metrics/MethodLength
+      def mark_relections_as_archived
+        self.class.reflections.each do |table_name, reflection|
+          next unless dependent_destroy?(reflection)
+
+          dependents = reflection_dependents(table_name)
+          next if dependents.nil?
+
+          action = case [reflection_marco(reflection), archivable?]
+                   when ['one', true] then :archive
+                   when ['one', false] then :destroy
+                   when ['many', true] then :archive_all
+                   when ['many', false] then :destroy_all
+                   end
+
+          dependents.send(action)
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      def mark_relections_as_unarchived
+        self.class.reflections.each do |table_name, reflection|
+          next unless dependent_destroy?(reflection)
+
+          klass = relection_klass(reflection.class_name)
+          next unless klass.archivable?
+
+          dependents = reflection_dependents(table_name)
+          next if dependents.nil?
+
+          action = case reflection_marco(reflection)
+                   when 'one' then :unarchive
+                   when 'many' then :unarchive_all
+                   end
+
+          dependents.send(action)
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def reflection_dependents(table_name)
+        send(table_name)
+      end
+
+      def relection_klass(table_name)
+        table_name.classify.constantize
+      end
+
+      def reflection_marco(reflection)
+        reflection.macro.to_s.gsub('has_', '')
+      end
+
+      def timestamp
+        Time.respond_to?(:current) ? Time.current : Time.now
+      end
+
+      def updatable?
+        respond_to?(:updated_at)
+      end
+
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.include(Lite::Archive::Base)
+end

data/lib/lite/archive/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+
+    class Configuration
+
+      attr_accessor :all_records_archivable
+
+      def initialize
+        @all_records_archivable = false
+      end
+
+    end
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configuration=(config)
+      @configuration = config
+    end
+
+    def self.configure
+      yield(configuration)
+    end
+
+  end
+end

data/lib/lite/archive/methods.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+    module Methods
+
+      def archivable?
+        columns.detect { |col| col.name == 'archived_at' }
+      end
+
+      def archive_all(conditions = nil)
+        records(conditions, action: :archive)
+      end
+
+      def unarchive_all(conditions = nil)
+        records(conditions, action: :unarchive)
+      end
+
+      private
+
+      def records(conditions = nil, action:)
+        where(conditions).find_each(&action)
+      end
+
+    end
+  end
+end

data/lib/lite/archive/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+    class Railtie < ::Rails::Railtie
+
+      initializer 'lite-archive' do |app|
+        Lite::Archive::Railtie.instance_eval do
+          [app.config.i18n.available_locales].flatten.each do |locale|
+            path = File.expand_path("../../../config/locales/#{locale}.yml", __FILE__)
+            next if !File.file?(path) || I18n.load_path.include?(path)
+
+            I18n.load_path << path
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/lite/archive/scopes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+    module Scopes
+
+      def archived
+        where.not(archived_at: nil)
+      end
+
+      def unarchived
+        where(archived_at: nil)
+      end
+
+    end
+  end
+end

data/lib/lite/archive/table_definition.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+    module TableDefinition
+
+      def timestamps(*args)
+        options = args.extract_options!
+
+        column(:created_at, :datetime, options)
+        column(:updated_at, :datetime, options)
+
+        return unless Lite::Archive.configuration.all_records_archivable == true
+        return if options[:archive] == false
+
+        options[:null] = true
+        column(:archived_at, :datetime, options)
+      end
+
+    end
+  end
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.prepend(Lite::Archive::TableDefinition)

data/lib/lite/archive/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Lite
+  module Archive
+
+    VERSION ||= '1.0.0'
+
+  end
+end

data/lite-archive.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lite/archive/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'lite-archive'
+  spec.version = Lite::Archive::VERSION
+  spec.authors = ['Juan Gomez']
+  spec.email = %w[j.gomez@drexed.com]
+
+  spec.summary = 'Archive (soft-delete) ActiveRecord database records'
+  spec.homepage = 'http://drexed.github.io/lite-archive'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata.merge(
+      'allowed_push_host' => 'https://rubygems.org',
+      'changelog_uri' => 'https://github.com/drexed/lite-archive/blob/master/CHANGELOG.md',
+      'homepage_uri' => spec.homepage,
+      'source_code_uri' => 'https://github.com/drexed/lite-archive'
+    )
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  spec.add_runtime_dependency 'activerecord'
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'fasterer'
+  spec.add_development_dependency 'generator_spec'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-performance'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,252 @@
+--- !ruby/object:Gem::Specification
+name: lite-archive
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-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: activesupport
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: 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: generator_spec
+  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: rake
+  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: 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'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  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-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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: 
+email:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".fasterer.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- _config.yml
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- lib/generators/lite/archive/install_generator.rb
+- lib/generators/lite/archive/templates/install.rb
+- lib/lite/archive.rb
+- lib/lite/archive/base.rb
+- lib/lite/archive/configuration.rb
+- lib/lite/archive/methods.rb
+- lib/lite/archive/railtie.rb
+- lib/lite/archive/scopes.rb
+- lib/lite/archive/table_definition.rb
+- lib/lite/archive/version.rb
+- lite-archive.gemspec
+homepage: http://drexed.github.io/lite-archive
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Archive (soft-delete) ActiveRecord database records
+test_files: []