lite-regulation 1.0.0

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,21 @@
+en:
+  lite:
+    regulation:
+      activation:
+        active: 'Active'
+        inactive: 'Inactive'
+      containment:
+        contained: 'Contained'
+        uncontained: 'Uncontained'
+      expiration:
+        expired: 'Expired'
+        unexpired: 'Unexpired'
+      quarantine:
+        quarantined: 'Quarantined'
+        unquarantined: 'Unquarantined'
+      suspension:
+        suspended: 'Suspended'
+        unsuspended: 'Unsuspended'
+      visibility:
+        invisible: 'Invisible'
+        visible: 'Visible'

data/docs/ACTIVATION.md

@@ -0,0 +1,41 @@
+# Activation
+
+#### Usage
+
+```ruby
+# 1. Add column to table
+class AddRegulationTimestampColumn < ActiveRecord::Migration
+  def change
+    t.datetime :inactivated_at
+
+    # - or -
+
+    add_column :your_model, :inactivated_at, :datetime
+  end
+end
+
+# 2. Include module
+class User < ActiveRecord::Base
+  include Lite::Regulation::Activation
+end
+```
+
+#### Methods
+
+```ruby
+user = User.first
+user.inactive!
+user.inactive?      #=> true
+
+user.active!
+user.active?        #=> true
+
+user.to_activation  #=> Returns the visibility state locale string (ex: Active)
+```
+
+#### Scopes
+
+```ruby
+User.inactive # Returns all inactive records
+User.active   # Returns all active records
+```

data/docs/CONTAINMENT.md

@@ -0,0 +1,41 @@
+# Containment
+
+#### Usage
+
+```ruby
+# 1. Add column to table
+class AddRegulationTimestampColumn < ActiveRecord::Migration
+  def change
+    t.datetime :contained_at
+
+    # - or -
+
+    add_column :your_model, :contained_at, :datetime
+  end
+end
+
+# 2. Include module
+class User < ActiveRecord::Base
+  include Lite::Regulation::Containment
+end
+```
+
+#### Methods
+
+```ruby
+user = User.first
+user.uncontain!
+user.uncontained?   #=> true
+
+user.contain!
+user.contained?     #=> true
+
+user.to_containment #=> Returns the visibility state locale string (ex: Contained)
+```
+
+#### Scopes
+
+```ruby
+User.contained    # Returns all contained records
+User.uncontained  # Returns all uncontained records
+```

data/docs/EXPIRATION.md

@@ -0,0 +1,45 @@
+# Expiration
+
+#### Usage
+
+```ruby
+# 1. Add column to table
+class AddRegulationTimestampColumn < ActiveRecord::Migration
+  def change
+    t.datetime :expires_at
+
+    # - or -
+
+    add_column :your_model, :expires_at, :datetime
+  end
+end
+
+# 2. Include module
+class User < ActiveRecord::Base
+  include Lite::Regulation::Expiration
+end
+```
+
+#### Methods
+
+```ruby
+user = User.first
+user.unexpire!
+user.unexpired?       #=> true
+
+user.expire!
+user.expired?         #=> true
+
+user.extend!
+user.extend!(20.days)
+user.expired?         #=> false
+
+user.to_expiration    #=> Returns the visibility state locale string (ex: Expired)
+```
+
+#### Scopes
+
+```ruby
+User.expired    # Returns all expired records
+User.unexpired  # Returns all unexpired records
+```

data/docs/QUARANTINE.md

@@ -0,0 +1,41 @@
+# Quarantine
+
+#### Usage
+
+```ruby
+# 1. Add column to table
+class AddRegulationTimestampColumn < ActiveRecord::Migration
+  def change
+    t.datetime :quarantined_at
+
+    # - or -
+
+    add_column :your_model, :quarantined_at, :datetime
+  end
+end
+
+# 2. Include module
+class User < ActiveRecord::Base
+  include Lite::Regulation::Quarantine
+end
+```
+
+#### Methods
+
+```ruby
+user = User.first
+user.unquarantine!
+user.unquarantined? #=> true
+
+user.quarantine!
+user.quarantined?   #=> true
+
+user.to_quarantine  #=> Returns the visibility state locale string (ex: Quarantined)
+```
+
+#### Scopes
+
+```ruby
+User.unquarantined  # Returns all unquarantined records
+User.quarantined    # Returns all quarantined records
+```

data/docs/SUSPENSION.md

@@ -0,0 +1,41 @@
+# Suspension
+
+#### Usage
+
+```ruby
+# 1. Add column to table
+class AddRegulationTimestampColumn < ActiveRecord::Migration
+  def change
+    t.datetime :suspended_at
+
+    # - or -
+
+    add_column :your_model, :suspended_at, :datetime
+  end
+end
+
+# 2. Include module
+class User < ActiveRecord::Base
+  include Lite::Regulation::Suspension
+end
+```
+
+#### Methods
+
+```ruby
+user = User.first
+user.unsuspend!
+user.unsuspended?   #=> true
+
+user.suspend!
+user.suspended?     #=> true
+
+user.to_suspension  #=> Returns the visibility state locale string (ex: Suspended)
+```
+
+#### Scopes
+
+```ruby
+User.unsuspended  # Returns all unsuspended records
+User.suspended    # Returns all suspended records
+```

data/docs/VISIBILITY.md

@@ -0,0 +1,41 @@
+# Visibility
+
+#### Usage
+
+```ruby
+# 1. Add column to table
+class AddRegulationTimestampColumn < ActiveRecord::Migration
+  def change
+    t.datetime :invisible_at
+
+    # - or -
+
+    add_column :your_model, :invisible_at, :datetime
+  end
+end
+
+# 2. Include module
+class User < ActiveRecord::Base
+  include Lite::Regulation::Visibility
+end
+```
+
+#### Methods
+
+```ruby
+user = User.first
+user.invisible!
+user.invisible?     #=> true
+
+user.visible!
+user.visible?       #=> true
+
+user.to_visibility  #=> Returns the visibility state locale string (ex: Visible)
+```
+
+#### Scopes
+
+```ruby
+User.invisible  # Returns all invisible records
+User.visible    # Returns all visible records
+```

data/lib/lite/regulation.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'active_support'
+
+require 'lite/regulation/version'
+require 'lite/regulation/railtie' if defined?(Rails)
+
+%w[base activation containment expiration quarantine suspension visibility].each do |name|
+  require "lite/regulation/#{name}"
+end

data/lib/lite/regulation/activation.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Activation
+
+      extend ActiveSupport::Concern
+
+      included do
+        scope :active, -> { where(inactivated_at: nil) }
+        scope :inactive, -> { where.not(inactivated_at: nil) }
+      end
+
+      def active!
+        return true if active?
+
+        update(inactivated_at: nil)
+      end
+
+      def active?
+        inactivated_at.nil?
+      end
+
+      def inactive!
+        return true if inactive?
+
+        update(inactivated_at: Time.current)
+      end
+
+      def inactive?
+        !active?
+      end
+
+      def inactivated_at_or_time
+        return inactivated_at if inactive?
+
+        Lite::Regulation::Base.timestamp
+      end
+
+      def to_activation
+        I18n.t("lite.regulation.activation.#{:in if inactive?}active")
+      end
+
+    end
+  end
+end

data/lib/lite/regulation/base.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Base
+
+      def self.timestamp
+        Time.respond_to?(:current) ? Time.current : Time.now
+      end
+
+    end
+  end
+end

data/lib/lite/regulation/containment.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Containment
+
+      extend ActiveSupport::Concern
+
+      included do
+        scope :contained, -> { where.not(contained_at: nil) }
+        scope :uncontained, -> { where(contained_at: nil) }
+      end
+
+      def contain!
+        return true if contained?
+
+        update(contained_at: Time.current)
+      end
+
+      def contained?
+        !uncontained?
+      end
+
+      def contained_at_or_time
+        return contained_at if contained?
+
+        Lite::Regulation::Base.timestamp
+      end
+
+      def to_containment
+        I18n.t("lite.regulation.containment.#{uncontained? ? :uncontained : :contained}")
+      end
+
+      def uncontain!
+        return true if uncontained?
+
+        update(contained_at: nil)
+      end
+
+      def uncontained?
+        contained_at.nil?
+      end
+
+    end
+  end
+end

data/lib/lite/regulation/expiration.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Expiration
+
+      extend ActiveSupport::Concern
+
+      # rubocop:disable Style/Lambda
+      included do
+        scope :expired, -> do
+          where('expires_at IS NULL OR expires_at < ?', Lite::Regulation::Base.timestamp)
+        end
+        scope :unexpired, -> do
+          where('expires_at IS NOT NULL AND expires_at >= ?', Lite::Regulation::Base.timestamp)
+        end
+      end
+      # rubocop:enable Style/Lambda
+
+      def expire!
+        return true if expires_at.nil?
+
+        update(expires_at: nil)
+      end
+
+      def expired?
+        return true if expires_at.nil?
+
+        Lite::Regulation::Base.timestamp >= expires_at
+      end
+
+      def extend!(amount = nil)
+        update(expires_at: extension_date(amount))
+      end
+
+      def unexpire!
+        return true unless expires_at.nil?
+
+        update(expires_at: extension_date)
+      end
+
+      def unexpired?
+        return false if expires_at.nil?
+
+        Lite::Regulation::Base.timestamp < expires_at
+      end
+
+      def expires_at_or_time(amount = nil)
+        return expires_at if unexpired?
+
+        extension_date(amount)
+      end
+
+      def to_expiration
+        I18n.t("lite.regulation.expiration.#{:un if unexpired?}expired")
+      end
+
+      private
+
+      def extension_date(amount = nil)
+        amount = 30 if amount.nil?
+        return amount unless amount.is_a?(Integer)
+
+        Lite::Regulation::Base.timestamp + amount
+      end
+
+    end
+  end
+end