aktibibo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e34cb1bc0d03456888eeb4c900b5917d33ec5f9c
+  data.tar.gz: 632fa275985e6c7ea83b5f146ee5d1ce09c43740
+SHA512:
+  metadata.gz: bf7f53b00cd72ca9f86f747e74efb32517cb0a23783e78dd66498882d9af7f4b1ad2c1774df2afcd331ac111a25cfd4c07137eab40f1d5d1e61fe74657f26f77
+  data.tar.gz: cd027f7c2e718b398a9e068bf84e8ad68a48e5c0147a0c2ea31c1d8475bbd7569f106296b98875638a7b81a14305a7df697b27aba92e2f6f5de8e2f311c85f6a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at hello@katpadi.ph. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kat Padilla
+
+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,80 @@
+# Aktibibo
+
+Aktibibo is a simple gem that allows an ActiveRecord model instance to be set as active, inactive or deactivated using convenience methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'aktibibo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aktibibo
+
+## Setup
+
+1. Create the necessary columns using a migration:
+
+        rails generate migration add_activated_at_to_foo activated_at:datetime
+        rails generate migration add_deactivated_at_to_foo deactivated_at:datetime
+
+2. Define that your model is "activatable":
+
+    ```ruby
+    class Foo < ActiveRecord::Base
+      activatable
+    end
+    ```
+
+## Usage
+
+Let's say that an instance `foo` is available.
+### Methods to activate and deactivate
+```ruby
+foo.activate
+foo.deactivate
+```
+Non-bang methods will just return nil (gracefully) if an already active instance is activated. Same goes for deactivate.
+
+### Methods that set but with a bang!
+```ruby
+foo.activate!
+foo.deactivate!
+```
+Bang methods, on the other hand, will raise `AktibiboError` if activated while active or deactivated while deactivated/inactive.
+
+### Boolean methods
+```ruby
+foo.active?
+foo.deactivated?
+foo.inactive?
+```
+
+### Scopes are provided for easy filtering
+```ruby
+Foo.inactive # Returns all the inactive foos
+Foo.activated # Returns all the active foos
+Foo.deactivated # Returns all the deactivated foos
+```
+
+### Activation and deactivation times are also accessible
+```ruby
+foo.activated_at  # Fri, 29 Apr 2016 08:29:03 UTC +00:00
+foo.deactivated_at # nil
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/katpadi/aktibibo. 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](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/aktibibo.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aktibibo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aktibibo"
+  spec.version       = Aktibibo::VERSION
+  spec.authors       = ["Kat Padilla"]
+  spec.email         = ["hello@katpadi.ph"]
+
+  spec.summary       = %q{Aktibibo allows an ActiveRecord model instance to be set as active, inactive or deactivated using convenience methods.}
+  spec.description   = %q{Aktibibo allows an ActiveRecord model to be declared as "activatable". It provides scopes for filtering and convenience methods to set an instance as active, inactive or deactivated. It also saves the activation and deactivation dates.}
+  spec.homepage      = "https://github.com/katpadi/aktibibo"
+  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"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'mysql2', '~> 0.3'
+
+  spec.add_dependency "activerecord", "~> 4.1"
+end

data/bin/console

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

@@ -0,0 +1,9 @@
+require 'aktibibo/version'
+require 'active_record'
+require 'aktibibo/activatable'
+require 'aktibibo/errors'
+
+module Aktibibo
+end
+
+ActiveRecord::Base.send(:include, Aktibibo::Activatable)

data/lib/aktibibo/activatable.rb

@@ -0,0 +1,51 @@
+module Aktibibo
+  module Activatable
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def activatable
+        scope :inactive, -> { where(activated_at: nil) }
+        scope :active, -> { where.not(activated_at: nil) }
+        scope :deactivated, -> { where.not(deactivated_at: nil) }
+      end
+    end
+
+    def inactive?
+      activated_at.blank? && deactivated_at.blank?
+    end
+
+    def active?
+      activated_at.present? && deactivated_at.blank?
+    end
+
+    def deactivated?
+      deactivated_at.present?
+    end
+
+    def activate
+      return if active?
+      self.activated_at = Time.now.utc if inactive?
+      self.deactivated_at = nil if deactivated?
+      save
+    end
+
+    def activate!
+      fail Errors::AlreadyActivated if active?
+      self.activated_at = Time.now.utc if inactive?
+      self.deactivated_at = nil if deactivated?
+      self.save!
+    end
+
+    def deactivate
+      return if deactivated?
+      self.deactivated_at = Time.now.utc
+      save
+    end
+
+    def deactivate!
+      fail Errors::AlreadyDeactivated if deactivated?
+      self.deactivated_at = Time.now.utc
+      self.save!
+    end
+  end
+end

data/lib/aktibibo/errors.rb

@@ -0,0 +1,7 @@
+module Aktibibo
+  module Errors
+    class AktibiboError < StandardError; end
+    class AlreadyActivated < AktibiboError; end
+    class AlreadyDeactivated < AktibiboError; end
+  end
+end

data/lib/aktibibo/version.rb

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

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: aktibibo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kat Padilla
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Aktibibo allows an ActiveRecord model to be declared as "activatable".
+  It provides scopes for filtering and convenience methods to set an instance as active,
+  inactive or deactivated. It also saves the activation and deactivation dates.
+email:
+- hello@katpadi.ph
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aktibibo.gemspec
+- bin/console
+- bin/setup
+- lib/aktibibo.rb
+- lib/aktibibo/activatable.rb
+- lib/aktibibo/errors.rb
+- lib/aktibibo/version.rb
+homepage: https://github.com/katpadi/aktibibo
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Aktibibo allows an ActiveRecord model instance to be set as active, inactive
+  or deactivated using convenience methods.
+test_files: []