etat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3ce676012deefc95e65555d86ec981b3a0e61ccb
+  data.tar.gz: e0b86cd39e02bccd8dc4abf73590dfe32ced0f72
+SHA512:
+  metadata.gz: ba4f0ea7a05b86a7c502ad7aa5b57a947d14b07e402b5edf82d3c1cf0130be60c58dcf02f5cecd3ba575727ab7364736e6aef729d2d40bfb8e9e4e3a89213968
+  data.tar.gz: 21f5f8a7fe2166e4d6ef1eae7e3ba4c4a7a00981d581ebcbfe494672266298d9a82c334db153ab29b22c4ad377803c9c816d7ae19815ce15594c522b87a85dbe

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jean-Philippe Boily
+
+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,43 @@
+# Etat
+
+Etat is a minimalistic gem to help you (me, for now) manage some states in your app. It is built for Rails 4 and assumes the use of ActiveRecord 4. See the 'usage' section for more.
+
+Etat means "State" in French.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'etat'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+class MyModel < ActiveRecord::Base
+  has_states :draft, :published, :deleted
+  event :publish do
+    # some code to happen on publish...
+    self.state = :publish
+    self.save!
+  end
+end
+```
+
+Etat will generate a few methods and scopes that will help you:
+`MyModel.states` will give you an array of the states. # [:draft, :published, :deleted]
+`MyModel.all_published`: scope that will return all records with that state (and equivalents for each states).
+`MyModel.all_but_published`: scope that will return all records except the ones with that state (and equivalents for each states).
+`my_model_instance.state`: it will return the current state, as a symbol, always.
+`my_model_instance.published?`: boolean. Will tell you if current record has that state or not (and equivalents for each states).
+
+## 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/etat.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'etat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "etat"
+  spec.version       = Etat::VERSION
+  spec.authors       = ["Jean-Philippe Boily"]
+  spec.email         = ["j@jipi.ca"]
+  spec.description   = %q{Etat is a minimalistic gem to help you (me, for now) manage some states in your Rails app.}
+  spec.summary       = %q{Etat is a minimalistic gem to help you (me, for now) manage some states in your Rails app. It is built for Rails 4 and assumes the use of ActiveRecord 4.}
+  spec.homepage      = "http://github.com/jipiboily/etat"
+  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_dependency "activerecord", ">= 4.0.0"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/etat.rb

@@ -0,0 +1,9 @@
+require "etat/version"
+
+require 'active_record'
+require 'active_support/concern'
+
+require 'etat/active_record'
+
+module Etat
+end

data/lib/etat/active_record.rb

@@ -0,0 +1,53 @@
+module Etat
+  module ActiveRecord
+    extend ActiveSupport::Concern
+
+    def state
+      if attributes['state']
+        attributes['state'].to_sym
+      else
+        attributes['state']
+      end
+    end
+
+    module ClassMethods
+      def has_states *states
+        @states = []
+        states.each do |state|
+          if state.is_a?(Symbol)
+            create_state_with state
+            create_scopes state
+            @states << state
+          else
+            raise 'States should be symbol'
+          end
+        end
+      end
+
+      def event event_name, &block
+        define_method(event_name) do
+          instance_eval &block
+        end
+      end
+
+      def states
+        @states
+      end
+
+      private
+      def create_scopes state
+        self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          scope "all_#{state}", -> { where(state: state) }
+          scope "all_but_#{state}", -> { where("state != ?", state) }
+        RUBY
+      end
+
+      private
+      def create_state_with state
+        define_method("#{state}?") do
+          self.state == state.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/etat/version.rb

@@ -0,0 +1,3 @@
+module Etat
+  VERSION = "0.0.1"
+end

data/spec/factories.rb

@@ -0,0 +1,13 @@
+FactoryGirl.define do
+  factory :draft, class: FakeModel do
+    state :draft
+  end
+
+  factory :published, class: FakeModel do
+    state :published
+  end
+
+  factory :deleted, class: FakeModel do
+    state :deleted
+  end
+end

data/spec/lib/active_record_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Etat::ActiveRecord do
+  describe '.states' do
+    it { expect(FakeModel.states).to eq [:draft, :published, :deleted] }
+  end
+
+  describe :scopes do
+    before do
+      published = create_list(:published, 4)
+      drafts = create_list(:draft, 3)
+      deleted = create_list(:deleted, 2)
+      @counts_per_state = {
+        published: published.size,
+        deleted: deleted.size,
+        draft: drafts.size,
+        total: (published.size + deleted.size + drafts.size)
+      }
+    end
+
+    FakeModel.states.each do |state|
+      describe ".all_#{state}" do
+        it "returns only '#{state}' records" do
+          expect(FakeModel.send("all_#{state}").count).to eq @counts_per_state[state]
+        end
+      end
+
+      describe ".all_but_#{state}" do
+        it "returns all records besides '#{state}' ones" do
+          expect(FakeModel.send("all_but_#{state}").count).to eq (@counts_per_state[:total] - @counts_per_state[state])
+        end
+      end
+
+      describe "##{state}?" do
+        it 'returns true if this is the current state' do
+          expect(FakeModel.new(state: state).send("#{state}?")).to be_true
+        end
+
+        it 'returns false if this is not the current state' do
+          expect(FakeModel.new(state: 'invalid state').send("#{state}?")).to be_false
+        end
+      end
+    end
+  end
+
+  describe '.event' do
+    it { expect(FakeModel.new.publish.draft?).to be_false }
+    it { expect(FakeModel.new.publish.published?).to be_true }
+    it { expect(FakeModel.new.publish.deleted?).to be_false }
+
+    it { expect(FakeModel.new.unpublish.draft?).to be_true }
+    it { expect(FakeModel.new.unpublish.published?).to be_false }
+    it { expect(FakeModel.new.unpublish.deleted?).to be_false }
+
+    it { expect(FakeModel.new.delete.draft?).to be_false }
+    it { expect(FakeModel.new.delete.published?).to be_false }
+    it { expect(FakeModel.new.delete.deleted?).to be_true }
+  end
+
+  describe '#state' do
+    it { expect(FakeModel.new(state: 'draft').state).to be_a Symbol }
+    it { expect(FakeModel.new(state: 'draft').state).to eq :draft }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'sqlite3'
+require 'factory_girl_rails'
+
+require 'etat'
+
+
+# Require support directory
+Dir[File.expand_path('../../spec/support/**/*.rb', __FILE__)].map(&method(:require))
+
+require 'factories'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    FakeModel.delete_all
+  end
+
+  config.before(:all) do
+    Etat::SpecHelper::Database.create_database
+  end
+
+  config.after(:all) do
+    Etat::SpecHelper::Database.delete_database
+  end
+end

data/spec/support/database.rb

@@ -0,0 +1,35 @@
+module Etat::SpecHelper
+  module Database
+    def self.create_database
+      SQLite3::Database.new FileUtils.touch(Etat::SpecHelper::Database.db_file).first
+      self.connect
+      self.create_fake_table
+    end
+
+    def self.delete_database
+      FileUtils.rm(Etat::SpecHelper::Database.db_file) if File.exists?(Etat::SpecHelper::Database.db_file)
+    end
+
+    def self.db_file
+      File.expand_path('../../test.db', __FILE__)
+    end
+
+    private
+    class CreateFakeModel < ActiveRecord::Migration
+      def up
+        create_table(:fake_models) do |t|
+          t.string :state
+          t.timestamp
+        end
+      end
+    end
+
+    def self.create_fake_table
+      CreateFakeModel.new.up
+    end
+
+    def self.connect
+      ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: Etat::SpecHelper::Database.db_file)
+    end
+  end
+end

data/spec/support/factory_girl.rb

@@ -0,0 +1,3 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/support/fake_model.rb

@@ -0,0 +1,20 @@
+class FakeModel < ActiveRecord::Base
+  include Etat::ActiveRecord
+
+  has_states :draft, :published, :deleted
+
+  event :publish do
+    self.state = :published
+    self
+  end
+
+  event :unpublish do
+    self.state = :draft
+    self
+  end
+
+  event :delete do
+    self.state = :deleted
+    self
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: etat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean-Philippe Boily
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.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: factory_girl_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: 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: Etat is a minimalistic gem to help you (me, for now) manage some states
+  in your Rails app.
+email:
+- j@jipi.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- etat.gemspec
+- lib/etat.rb
+- lib/etat/active_record.rb
+- lib/etat/version.rb
+- spec/factories.rb
+- spec/lib/active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/factory_girl.rb
+- spec/support/fake_model.rb
+homepage: http://github.com/jipiboily/etat
+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.0.2
+signing_key: 
+specification_version: 4
+summary: Etat is a minimalistic gem to help you (me, for now) manage some states in
+  your Rails app. It is built for Rails 4 and assumes the use of ActiveRecord 4.
+test_files:
+- spec/factories.rb
+- spec/lib/active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/database.rb
+- spec/support/factory_girl.rb
+- spec/support/fake_model.rb