activable 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjEzNzhkOGE4NTU3ODVjMzY2ZDEyZTBkMzQ1ZmNiOTcxZjllYjhkMQ==
+  data.tar.gz: !binary |-
+    NjE2NDRhODIyODRiYjRmNDcwMzljYjQxZjg3NGI3ZjEyNDQ1ZjAzMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDI2NmIzNDMwZTU4YzIwYzE3ZmRjMGFmMGIzYWRlZTFlMTdjNGFkNDQ5OTRl
+    MDcyM2FlZmQ1YWM2NjA5ODZiY2MxZGIxM2VjZGNiNjNhMjk0N2JhNzg1Y2Zi
+    OTZlZjU4MDhmZjZmNTBiM2YyNTIzOTQ1OTNhYjk3YmE2YmIyNzM=
+  data.tar.gz: !binary |-
+    N2VjZmExMjgxNWJlOTg1NDQxMjZmNWQwZWMwZjI0ZTBjMjdkMDk2ZGQyOTUy
+    YTU5ZDE5ZDZiNzEwYTdiYTliYjVmOTNhNDJjNTkzOTQ0NGYyYTY3MDE1ZDBi
+    YzBiYTE1ZTlkZjQ0ZTk1ZTY3ZDQ4ZDdkYTBhODFmNmY1NzYxYzc=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in activable.gemspec
+gemspec
+
+gem "rails", "~> 3.2.13"
+group :test do
+  gem "sqlite3"
+  gem "rspec"
+  gem "factory_girl"
+  gem "generator_spec"
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Diego Selzlein
+
+MIT License
+
+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,102 @@
+# Activable
+
+This gem allows a model to be activated or deactivated, saving informations like
+'activated_at', 'deactivated_at', 'activated_by' and 'deactivated_by'.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activable', git: 'git://github.com/nerde/activable.git'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create the initializer file:
+
+    $ rails g activable:install
+
+Configure the models you want to be "activable". They need to be created first:
+
+    $ rails g model product description
+    $ rails g activable product
+    $ rake db:migrate
+
+Your models will look like this:
+
+```ruby
+class Product < ActiveRecord::Base
+  is_activable
+  # ...
+end
+```
+
+Optionally, you can customize each model to have a differente configuration from
+the on in the initializer file:
+
+```ruby
+class Product < ActiveRecord::Base
+  is_activable has_responsible: false
+  # ...
+end
+
+class Category < ActiveRecord::Base
+  is_activable responsible: "Admin"
+  # ...
+end
+```
+
+### Working with it
+
+By default, new objects of a "activable" model are active:
+
+```ruby
+p = Product.new
+p.active? # => true
+```
+
+If your model has a responsible, you **must** provide it before saving your object:
+
+```ruby
+p = Product.new
+p.save # will not work, it will say that activated_by_id is required
+
+# You need to do something like this
+p = Product.new
+p.activate responsible: current_user
+```
+
+The same rule applies when deactivating an object:
+
+```ruby
+product.deactivate responsible: current_user
+```
+
+You can check whether it is active or not whenever you want by calling the method
+`active?`. Another useful informations are stored and you can see them:
+
+```ruby
+product.activated_at
+product.deactivated_at
+
+# And if it has a responsible:
+product.activated_by # if has responsible
+product.deactivated_by # if has responsible
+```
+
+## Testing the gem
+
+    rspec spec
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activable.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activable"
+  spec.version       = Activable::VERSION
+  spec.authors       = ["Diego Selzlein"]
+  spec.email         = ["diegoselzlein@gmail.com"]
+  spec.description   = %q{Allows a model to be activated and deactivated}
+  spec.summary       = %q{Allows a model to be activated and deactivated}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+end

data/lib/activable/active_record.rb

@@ -0,0 +1,3 @@
+require 'active_record'
+
+ActiveRecord::Base.extend Activable::Models

data/lib/activable/version.rb

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

data/lib/activable.rb

@@ -0,0 +1,83 @@
+require 'rails'
+require "activable/version"
+require 'active_support/dependencies'
+
+module Activable
+  mattr_accessor :configuration
+  @@configuration = {has_responsible: true, responsible: "User"}
+
+  def self.set(options={})
+    @@configuration.merge! options
+  end
+
+  def self.setup
+    yield self
+  end
+
+  module Methods
+    extend ActiveSupport::Concern
+
+    def init_active
+      self.activated_at = Time.now
+    end
+
+    def active?
+      return true unless self.activated_at && self.deactivated_at
+      self.activated_at > self.deactivated_at
+    end
+
+    def activate(options={})
+      verify_responsible(options)
+      self.activated_at = Time.now
+      self.activated_by = options[:responsible] if self.activable_config[:has_responsible]
+    end
+
+    def deactivate(options={})
+      verify_responsible(options)
+      self.deactivated_at = Time.now
+      self.deactivated_by = options[:responsible] if self.activable_config[:has_responsible]
+    end
+
+    def activate!(options={})
+      activate(options)
+      save
+    end
+
+    def deactivate!(options={})
+      deactivate(options)
+      save
+    end
+
+    included do
+      after_initialize :init_active
+      validates_presence_of :activated_at
+      if self.activable_config[:has_responsible]
+        belongs_to :activated_by, :class_name => self.activable_config[:responsible]
+        belongs_to :deactivated_by, :class_name => self.activable_config[:responsible]
+        validates_presence_of :activated_by_id, if: :active?
+        validates_presence_of :deactivated_by_id, unless: :active?
+      end
+    end
+
+    protected
+
+    def verify_responsible(options)
+      if self.activable_config[:has_responsible]
+        resp = options && options[:responsible]
+        if !resp
+          raise "You must provide a responsible to activate a " + self.class.name
+        elsif resp.class.name != self.activable_config[:responsible]
+          raise "Object of type #{resp.class.name} is not a " + self.activable_config[:responsible]
+        end
+      end
+    end
+  end
+
+  module Models
+    def is_activable(options = {})
+      cattr_accessor :activable_config
+      self.activable_config = Activable.configuration.merge options
+      include Activable::Methods
+    end
+  end
+end

data/lib/generators/activable/activable_generator.rb

@@ -0,0 +1,42 @@
+require 'rails/generators/active_record'
+
+module Activable
+  module Generators
+    class ActivableGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a migration to add the activable fields."
+      def copy_migration
+        klass = model_class
+        raise "The model #{class_name.camelize} does not exists!" unless klass && klass.table_name
+        migration_template "migration.rb", "#{migration_path}/add_activable_to_#{table_name}.rb"
+      end
+
+      desc "Adds activable fields to an existing model."
+      def inject_activable_content
+        content = <<CONTENT
+  is_activable
+CONTENT
+        inject_into_class(model_path, model_class, content) if model_exists?
+      end
+
+      protected
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        File.join("app", "models", "#{class_name.downcase.singularize}.rb")
+      end
+
+      def model_class
+        Object::const_get(class_name.singularize.camelize)
+      end
+
+      def migration_path
+        File.join("db", "migrate")
+      end
+    end
+  end
+end

data/lib/generators/activable/install_generator.rb

@@ -0,0 +1,13 @@
+module Activable
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates an Activable initializer."
+
+      def copy_initializer
+        template "activable.rb", "config/initializers/activable.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/activable.rb

@@ -0,0 +1,14 @@
+# Use this hook to configure Activable gem.
+Activable.setup do |config|
+
+  # Load the methods for ActiveRecord
+  require 'activable/active_record'
+
+  # Set here if your models have a responsible when they are either activated or
+  # deactivated.
+  config.set(has_responsible: true)
+
+  # Configure here who is the responsible for activating or deactivating your
+  # models. It has to be a class that extends ActiveRecord::Base.
+  config.set(responsible: "User")
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,8 @@
+class AddActivableTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    add_column :<%= table_name %>, :activated_at, :datetime
+    add_column :<%= table_name %>, :deactivated_at, :datetime
+    add_column :<%= table_name %>, :activated_by_id, :integer
+    add_column :<%= table_name %>, :deactivated_by_id, :integer
+  end
+end

data/spec/activable_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Activable do
+  it "can be configured" do
+    Activable.setup do |config|
+      config.set has_responsible: false
+      config.set responsible: "Atest"
+    end
+    Activable.configuration[:has_responsible].should eql(false)
+    Activable.configuration[:responsible].should eql("Atest")
+  end
+end

data/spec/factories/categories.rb

@@ -0,0 +1,5 @@
+FactoryGirl.define do
+  factory :category do
+    name "Eletronics"
+  end
+end

data/spec/factories/users.rb

@@ -0,0 +1,9 @@
+FactoryGirl.define do
+  factory :user do
+    email "user@nomail.com"
+  end
+
+  factory :another_user, class: User do
+    email "another_user@nomail.com"
+  end
+end

data/spec/generators/activable_generator_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+require 'generators/activable/activable_generator'
+
+describe Activable::Generators::ActivableGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../../tmp", __FILE__)
+  arguments %w(product)
+
+  before do
+    Activable.setup do |config|
+      config.set(has_responsible: true)
+      config.set(responsible: "Responsible")
+    end
+    prepare_destination
+    copy_model
+    run_generator
+  end
+
+  it "adds is_activable to the model" do
+    assert_file 'app/models/product.rb', model_content
+  end
+
+  it "creates a migration file" do
+    assert_migration "db/migrate/add_activable_to_products.rb", migration_content
+  end
+
+  protected
+
+  def copy_model
+    dest = File.join('tmp','app','models')
+    FileUtils.mkdir_p dest
+    FileUtils.cp(File.join('spec','test_app','app','models','product.rb'),
+        File.join(dest,'product.rb'))
+  end
+
+  def migration_content
+<<RUBY
+class AddActivableToProducts < ActiveRecord::Migration
+  def change
+    add_column :products, :activated_at, :datetime
+    add_column :products, :deactivated_at, :datetime
+    add_column :products, :activated_by_id, :integer
+    add_column :products, :deactivated_by_id, :integer
+  end
+end
+RUBY
+  end
+
+  def model_content
+<<RUBY
+class Product < ActiveRecord::Base
+  is_activable
+  attr_accessible :name
+end
+RUBY
+  end
+end

data/spec/generators/install_generator_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'generators/activable/install_generator'
+
+describe Activable::Generators::InstallGenerator do
+  include GeneratorSpec::TestCase
+  destination File.expand_path("../../../tmp", __FILE__)
+
+  before(:all) do
+    prepare_destination
+    run_generator
+  end
+
+  it "creates a default initializer" do
+    assert_file "config/initializers/activable.rb"
+  end
+end

data/spec/has_no_responsible_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Category do
+  it 'should have activable fields' do
+    Category.methods.include?(:is_activable).should be_true
+    c = Category.new
+    c.attributes.include?("activated_at").should be_true
+    c.attributes.include?("deactivated_at").should be_true
+    c.methods.include?(:activated_by).should_not be_true
+    c.methods.include?(:deactivated_by).should_not be_true
+  end
+
+  it 'can be saved with no responsible' do
+    u = FactoryGirl.build(:category)
+    u.save.should be_true
+  end
+
+  it 'can be activated with no responsible' do
+    c = FactoryGirl.build(:category)
+
+    c.activate
+    c.save.should be_true, "Activated category with no responsible should be saved. " +
+        c.errors.full_messages.to_s
+    c.active?.should be_true
+    c.activated_by_id.should be_nil
+    c.activated_at.should_not be_nil
+    c.deactivated_by_id.should be_nil
+    c.deactivated_at.should be_nil
+  end
+
+  it 'can be deactivated with no responsible' do
+    c = FactoryGirl.build(:category)
+
+    c.deactivate
+    c.save.should be_true, "Deactivated category with no responsible should be saved. " +
+        c.errors.full_messages.to_s
+    c.active?.should_not be_true
+    c.deactivated_by_id.should be_nil
+    c.deactivated_at.should_not be_nil
+  end
+end

data/spec/has_responsible_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe User do
+  it 'should have activable fields' do
+    User.methods.include?(:is_activable).should be_true
+    u = User.new
+    u.attributes.include?("activated_at").should be_true
+    u.attributes.include?("deactivated_at").should be_true
+    u.activated_by.should be_nil
+    u.deactivated_by.should be_nil
+  end
+
+  it 'cannot be saved without a responsible' do
+    u = FactoryGirl.build(:user)
+    u.save.should_not be_true
+    u.errors[:activated_by_id].should_not be_empty
+  end
+
+  it 'is active by default' do
+    u = FactoryGirl.build(:user)
+    u.active?.should be_true
+    u.activated_at.should_not be_nil
+  end
+
+  it 'can be activated' do
+    admin = FactoryGirl.build(:user)
+    admin.save(validate: false)
+
+    u = FactoryGirl.build(:another_user)
+
+    u.activate(responsible: admin)
+    u.save.should be_true, "Activated user should be saved. " +
+        u.errors.full_messages.to_s
+    u.active?.should be_true
+    u.activated_by.should be_equal admin
+    u.activated_at.should_not be_nil
+    u.deactivated_by.should be_nil
+    u.deactivated_at.should be_nil
+  end
+
+  it 'can be deactivated' do
+    another_user = FactoryGirl.build(:another_user)
+    another_user.save(validate: false)
+
+    u = FactoryGirl.build(:another_user)
+
+    u.deactivate(responsible: another_user)
+    u.save.should be_true, "Deactivated user should be saved. " +
+        u.errors.full_messages.to_s
+    u.active?.should_not be_true
+    u.deactivated_by.should be_equal another_user
+    u.deactivated_at.should_not be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+ENV["RAILS_ENV"] = "test"
+require 'rubygems'
+require 'bundler/setup'
+require 'active_record'
+require 'activable'
+require 'generator_spec/test_case'
+require 'test_app/config/environment'
+require 'rake'
+require 'factory_girl'
+
+Dir[Pathname.new(File.expand_path('../', __FILE__)).join('support/**/*.rb')].each {|f| require f}
+
+Dir.chdir File.expand_path("../test_app", __FILE__) do
+  system 'rake db:create' unless File.exists?('db/test.sqlite3')
+  system 'rake db:migrate'
+end
+
+RSpec.configure do |config|
+end
+
+FactoryGirl.find_definitions

data/spec/test_app/.gitignore

@@ -0,0 +1,2 @@
+db/*.sqlite3
+log/

data/spec/test_app/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+TestApp::Application.load_tasks

data/spec/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/spec/test_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/test_app/app/models/category.rb

@@ -0,0 +1,4 @@
+class Category < ActiveRecord::Base
+  is_activable has_responsible: false
+  attr_accessible :name
+end

data/spec/test_app/app/models/product.rb

@@ -0,0 +1,3 @@
+class Product < ActiveRecord::Base
+  attr_accessible :name
+end

data/spec/test_app/app/models/user.rb

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  is_activable
+  attr_accessible :email
+end

data/spec/test_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>TestApp</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>