active_regulation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee29d99c3d4372c7c8e9bd32e4d6060d81164a1d
+  data.tar.gz: 7d49c2268b1c094b90978d125d0ac25200f384b1
+SHA512:
+  metadata.gz: 5afb2a5923f2d4465dfe661d76766ee5af2a9133da3d33c87bd87c08f5888c5b0c8f1bbff15f441f961378ccb5786ded22ef8b1c79ffa0be50b5e7380bf63995
+  data.tar.gz: 574caf9bac2a2112f42c587836d6c110e330858434e0ca44dce8018587074e659df2a34589e2bcb8064e89a8609d6be535c28d299cc5257e7d03207f50346bad

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,13 @@
+before_install:
+  - sudo apt-get install libxml2-dev
+cache: bundler
+language: ruby
+notifications:
+  email:
+    recipients:
+      - j.gomez@drexed.com
+    on_failure: change
+    on_success: never
+rvm:
+  - ruby-head
+script: 'bundle exec rake'

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,78 @@
+# ActiveRegulation
+
+[![Gem Version](https://badge.fury.io/rb/active_regulation.svg)](http://badge.fury.io/rb/active_regulation)
+[![Build Status](https://travis-ci.org/drexed/active_regulation.svg?branch=master)](https://travis-ci.org/drexed/active_regulation)
+[![Coverage Status](https://coveralls.io/repos/drexed/active_regulation/badge.png)](https://coveralls.io/r/drexed/active_regulation)
+
+ActiveRegulation is a library for commonly used record states.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_regulation'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_regulation
+
+## Table of Contents
+
+* [Methods](#methods)
+* [Usage](#usage)
+
+## Methods
+
+**Modules:**
+ * activation
+ * containment
+ * visibility
+
+**Attributes:**
+ * :inactivated_at
+ * :contained_at
+ * :invisible_at
+
+```ruby
+class User < ActiveRecord::Base
+
+  # Add one of the datetime attributes
+  # above to the corresponding table.
+
+  include ActiveRegulation::Containment
+
+end
+```
+
+## Usage
+```ruby
+user = User.create!
+
+user.active?       #=> true
+user.inactive?     #=> false
+
+user.inactive!
+user.active?       #=> false
+
+user.active!
+user.active?       #=> true
+
+user.to_activation #=> 'Active'
+
+User.active        #=> retrieves all active records
+User.inactive      #=> retrieves all inactive records
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/active_regulation/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/active_regulation.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_regulation/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "active_regulation"
+  spec.version       = ActiveRegulation::VERSION
+  spec.authors       = ["Juan Gomez"]
+  spec.email         = ["j.gomez@drexed.com"]
+
+  spec.summary       = %q{Commonly used record states.}
+  spec.description   = %q{Manage the states of records by commonly used attributes.}
+  spec.homepage      = "https://github.com/drexed/active_regulation"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib", "support"]
+
+  spec.add_runtime_dependency "activerecord"
+  spec.add_runtime_dependency "activesupport"
+
+  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"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "active_regulation"
+
+# 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

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/setup

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

data/config/locales/en.yml

@@ -0,0 +1,11 @@
+en:
+  active_regulation:
+    activation:
+      active: "Active"
+      inactive: "Inactive"
+    containment:
+      contained: "Contained"
+      uncontained: "Uncontained"
+    visibility:
+      invisible: "Invisible"
+      visible: "Visible"

data/lib/active_regulation.rb

@@ -0,0 +1,33 @@
+require "active_regulation/version"
+require "active_regulation/activation"
+require "active_regulation/containment"
+require "active_regulation/visibility"
+
+if defined?(Rails)
+  require 'rails'
+
+  module ActiveRegulation
+    class Railtie < ::Rails::Railtie
+
+      initializer 'active_regulation' do |app|
+        ActiveRegulation::Railtie.instance_eval do
+          locales_from(app.config.i18n.available_locales).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
+
+      def self.locales_from(args)
+        array = Array(args || [])
+        array.blank? ? '*' : array
+      end
+
+    end
+  end
+end

data/lib/active_regulation/activation.rb

@@ -0,0 +1,31 @@
+module ActiveRegulation
+  module Activation
+    extend ActiveSupport::Concern
+
+    included do
+      scope :active,   -> { where(inactivated_at: nil) }
+      scope :inactive, -> { where.not(inactivated_at: nil) }
+    end
+
+    def active!
+      update(inactivated_at: nil) if inactive?
+    end
+
+    def inactive!
+      update(inactivated_at: Time.now) if active?
+    end
+
+    def active?
+      inactivated_at.nil?
+    end
+
+    def inactive?
+      !active?
+    end
+
+    def to_activation
+      I18n.t("active_regulation.activation.#{active? ? :active : :inactive}")
+    end
+
+  end
+end

data/lib/active_regulation/containment.rb

@@ -0,0 +1,31 @@
+module ActiveRegulation
+  module Containment
+    extend ActiveSupport::Concern
+
+    included do
+      scope :contained,   -> { where.not(contained_at: nil) }
+      scope :uncontained, -> { where(contained_at: nil) }
+    end
+
+    def contain!
+      update(contained_at: Time.now) if uncontained?
+    end
+
+    def uncontain!
+      update(contained_at: nil) if contained?
+    end
+
+    def contained?
+      !uncontained?
+    end
+
+    def uncontained?
+      contained_at.nil?
+    end
+
+    def to_containment
+      I18n.t("active_regulation.containment.#{uncontained? ? :uncontained : :contained}")
+    end
+
+  end
+end

data/lib/active_regulation/version.rb

@@ -0,0 +1,3 @@
+module ActiveRegulation
+  VERSION = "0.1.0"
+end

data/lib/active_regulation/visibility.rb

@@ -0,0 +1,31 @@
+module ActiveRegulation
+  module Visibility
+    extend ActiveSupport::Concern
+
+    included do
+      scope :visible,   -> { where(invisible_at: nil) }
+      scope :invisible, -> { where.not(invisible_at: nil) }
+    end
+
+    def invisible!
+      update(invisible_at: Time.now)
+    end
+
+    def visible!
+      update(invisible_at: nil)
+    end
+
+    def invisible?
+      !visible?
+    end
+
+    def visible?
+      invisible_at.nil?
+    end
+
+    def to_visibility
+      I18n.t("active_regulation.visibility.#{visible? ? :visible : :invisible}")
+    end
+
+  end
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: active_regulation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Juan Gomez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-11 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: coveralls
+  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: 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'
+- !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'
+description: Manage the states of records by commonly used attributes.
+email:
+- j.gomez@drexed.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- active_regulation.gemspec
+- bin/console
+- bin/rake
+- bin/setup
+- config/locales/en.yml
+- lib/active_regulation.rb
+- lib/active_regulation/activation.rb
+- lib/active_regulation/containment.rb
+- lib/active_regulation/version.rb
+- lib/active_regulation/visibility.rb
+homepage: https://github.com/drexed/active_regulation
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- support
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Commonly used record states.
+test_files: []