lite-regulation 1.0.0

data/lib/lite/regulation/quarantine.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Quarantine
+
+      extend ActiveSupport::Concern
+
+      included do
+        scope :quarantined, -> { where.not(quarantined_at: nil) }
+        scope :unquarantined, -> { where(quarantined_at: nil) }
+      end
+
+      def quarantine!
+        return true if quarantined?
+
+        update(quarantined_at: Time.current)
+      end
+
+      def quarantined?
+        !unquarantined?
+      end
+
+      def quarantined_at_or_time
+        return quarantined_at if quarantined?
+
+        Lite::Regulation::Base.timestamp
+      end
+
+      def to_quarantine
+        I18n.t("lite.regulation.quarantine.#{:un if unquarantined?}quarantined")
+      end
+
+      def unquarantine!
+        return true if unquarantined?
+
+        update(quarantined_at: nil)
+      end
+
+      def unquarantined?
+        quarantined_at.nil?
+      end
+
+    end
+  end
+end

data/lib/lite/regulation/railtie.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    class Railtie < ::Rails::Railtie
+
+      initializer 'lite-regulation' do |app|
+        Lite::Regulation::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/regulation/suspension.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Suspension
+
+      extend ActiveSupport::Concern
+
+      included do
+        scope :suspended, -> { where.not(suspended_at: nil) }
+        scope :unsuspended, -> { where(suspended_at: nil) }
+      end
+
+      def suspend!
+        return true if suspended?
+
+        update(suspended_at: Time.current)
+      end
+
+      def suspended?
+        !unsuspended?
+      end
+
+      def suspended_at_or_time
+        return suspended_at if unsuspended?
+
+        Lite::Regulation::Base.timestamp
+      end
+
+      def to_suspension
+        I18n.t("lite.regulation.suspension.#{:un if unsuspended?}suspended")
+      end
+
+      def unsuspend!
+        return true if unsuspended?
+
+        update(suspended_at: nil)
+      end
+
+      def unsuspended?
+        suspended_at.nil?
+      end
+
+    end
+  end
+end

data/lib/lite/regulation/version.rb

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

data/lib/lite/regulation/visibility.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Lite
+  module Regulation
+    module Visibility
+
+      extend ActiveSupport::Concern
+
+      included do
+        scope :invisible, -> { where.not(invisible_at: nil) }
+        scope :visible, -> { where(invisible_at: nil) }
+      end
+
+      def invisible!
+        return true if invisible?
+
+        update(invisible_at: Time.current)
+      end
+
+      def visible!
+        return true if visible?
+
+        update(invisible_at: nil)
+      end
+
+      def invisible?
+        !visible?
+      end
+
+      def invisible_at_or_time
+        return invisible_at if invisible?
+
+        Lite::Regulation::Base.timestamp
+      end
+
+      def to_visibility
+        I18n.t("lite.regulation.visibility.#{:in if invisible?}visible")
+      end
+
+      def visible?
+        invisible_at.nil?
+      end
+
+    end
+  end
+end

data/lite-regulation.gemspec

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lite/regulation/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'lite-regulation'
+  spec.version = Lite::Regulation::VERSION
+  spec.authors = ['Juan Gomez']
+  spec.email = %w[j.gomez@drexed.com]
+
+  spec.summary = 'Collection of mixins to regulate the state of a database record'
+  spec.homepage = 'http://drexed.github.io/lite-regulation'
+  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-regulation/blob/master/CHANGELOG.md',
+      'homepage_uri' => spec.homepage,
+      'source_code_uri' => 'https://github.com/drexed/lite-regulation'
+    )
+  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 '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,244 @@
+--- !ruby/object:Gem::Specification
+name: lite-regulation
+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: 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
+- docs/ACTIVATION.md
+- docs/CONTAINMENT.md
+- docs/EXPIRATION.md
+- docs/QUARANTINE.md
+- docs/SUSPENSION.md
+- docs/VISIBILITY.md
+- lib/lite/regulation.rb
+- lib/lite/regulation/activation.rb
+- lib/lite/regulation/base.rb
+- lib/lite/regulation/containment.rb
+- lib/lite/regulation/expiration.rb
+- lib/lite/regulation/quarantine.rb
+- lib/lite/regulation/railtie.rb
+- lib/lite/regulation/suspension.rb
+- lib/lite/regulation/version.rb
+- lib/lite/regulation/visibility.rb
+- lite-regulation.gemspec
+homepage: http://drexed.github.io/lite-regulation
+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: Collection of mixins to regulate the state of a database record
+test_files: []