simplest_status 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 845888ba96293dd86f09dfa9d2f04de2b0645972
+  data.tar.gz: f10292a0a5691358a4e6f8df725c52edd3d81878
+SHA512:
+  metadata.gz: aebf80db4038ac7a6b7c6b4fc29d76270ef7a5ada06c954fc7a75200552e38b4fe6ec224919d5d59b1acc8f6cb7af1e709f306653689fbf31b1423df666a48c6
+  data.tar.gz: bd1c060400a9a0c3a983600c53b1c77e425a8263c351ad765b986203f575bb23316bd909f9f43ea7ceb0e1dbd1685454ebe3834ce4cc4d0739fb18fcb78b6138

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+*.gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,27 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.2
+gemfile:
+  - gemfiles/rails_20.gemfile
+  - gemfiles/rails_31.gemfile
+  - gemfiles/rails_32.gemfile
+  - gemfiles/rails_40.gemfile
+  - gemfiles/rails_41.gemfile
+  - gemfiles/rails_42.gemfile
+matrix:
+  exclude:
+    - rvm: 2.2.2
+      gemfile: gemfiles/rails_20.gemfile
+    - rvm: 2.2.2
+      gemfile: gemfiles/rails_31.gemfile
+    - rvm: 2.2.2
+      gemfile: gemfiles/rails_32.gemfile
+    - rvm: 2.2.2
+      gemfile: gemfiles/rails_40.gemfile
+before_install: gem install bundler -v 1.10.2
+addons:
+  code_climate:
+    repo_token: 406484919b3c7b57d10643c465efb9cbe9109a59ea6b5d64fb099c6c1e81a9f4

data/Appraisals

@@ -0,0 +1,23 @@
+appraise "rails-20" do
+  gem "rails", "~> 2.0.5"
+end
+
+appraise "rails-31" do
+  gem "rails", "~> 3.1.12"
+end
+
+appraise "rails-32" do
+  gem "rails", "~> 3.2.21"
+end
+
+appraise "rails-40" do
+  gem "rails", "~> 4.0.13"
+end
+
+appraise "rails-41" do
+  gem "rails", "~> 4.1.10"
+end
+
+appraise "rails-42" do
+  gem "rails", "~> 4.2.1"
+end

data/Gemfile

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

data/README.md

@@ -0,0 +1,114 @@
+# SimplestStatus [![Gem Version](https://badge.fury.io/rb/simplest_status.svg)](http://badge.fury.io/rb/simplest_status) [![Code Climate](https://codeclimate.com/github/vigetlabs/simplest_status/badges/gpa.svg)](https://codeclimate.com/github/vigetlabs/simplest_status) [![Test Coverage](https://codeclimate.com/github/vigetlabs/simplest_status/badges/coverage.svg)](https://codeclimate.com/github/vigetlabs/simplest_status/coverage) [![Build Status](https://travis-ci.org/vigetlabs/simplest_status.svg)]((https://travis-ci.org/vigetlabs/simplest_status))
+
+SimplestStatus is a gem built to provide simple, convenient status functionality for Rails models.  It's designed to work with practically every version of Rails (tested as far back as 2.0.5) and will work with Ruby 1.9.3 and up.
+
+SimplestStatus is similar to the recently introduced [`enum`](http://api.rubyonrails.org/classes/ActiveRecord/Enum.html) (debuted in Rails 4.1), but is different in that it doesn't rely on a particular version of Rails, it's geared specifically toward `status` columns, and it provides additional functionality like constant-based status lookup, label helpers, and validations.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplest_status'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simplest_status
+
+## Usage
+Add an `integer`-type `status` field to a model with `:null => false` and `:default => 0`:
+```ruby
+class AddStatusToPostsMigration < ActiveRecord::Migration
+  def change
+    add_column :posts, :status, :integer, :null => false, :default => 0
+  end
+end
+```
+Then in your model, extend `SimplestStatus` and list out your statuses:
+```ruby
+class Post < ActiveRecord::Base
+  extend SimplestStatus
+
+  statuses :draft, :preview, :published, :archived
+end
+```
+
+This will generate a number of constants, methods, and model validations.
+
+#### Status List
+```ruby
+Post.statuses # => { :draft => 0, :preview => 1, :published => 2, :archived => 3 }
+```
+
+The returned hash is a [`StatusCollection`](link) that, when iterated over, yields [`Status`](link) objects:
+```
+Post.statuses.first.tap do |status|
+  status.name          # => :draft
+  status.value         # => 0
+  status.string        # => 'draft'
+  status.to_hash       # => { :draft => 0 }
+  status.constant_name # => 'DRAFT'
+  status.label         # => 'Draft'
+  status.for_select    # => ['Draft', 0]
+end
+```
+
+It also provides a helper method for usage in a form select:
+```ruby
+Post.statuses.for_select # => [['Draft', 0], ['Preview', 1], ['Published', 2], ['Archived', 3]]
+```
+
+#### Constants
+Instead of referring to status values by the underlying integer, SimplestStatus generates constants for this purpose:
+```ruby
+Post::DRAFT     # => 0
+Post::PREVIEW   # => 1
+Post::PUBLISHED # => 2
+Post::ARCHIVED  # => 3
+```
+
+#### Scopes
+```ruby
+Post.draft
+Post.preview
+Post.published
+Post.archived
+```
+
+#### Predicate Methods
+```ruby
+Post.new(:status => Post::DRAFT) do |post|
+  post.draft?     # => true
+  post.preview?   # => false
+  post.published? # => false
+  post.archived?  # => false
+end
+```
+
+#### Status Mutation Methods
+```ruby
+Post.new(:status => Post::ARCHIVED) do
+  post.draft      # status from Post::ARCHIVED to Post::DRAFT
+  post.preview    # status from Post::DRAFT to Post::PREVIEW
+  post.published  # status from Post::PREVIEW to Post::PUBLISHED
+  post.archived   # status from Post::PUBLISHED to Post::ARCHIVED
+end
+```
+
+#### Status Label Method
+```ruby
+Post.new(:status => Post::DRAFT).status_label     # => 'Draft'
+Post.new(:status => Post::PREVIEW).status_label   # => 'Preview'
+Post.new(:status => Post::PUBLISHED).status_label # => 'Published'
+Post.new(:status => Post::ARCHIVED).status_label  # => 'Archived'
+```
+
+#### Status Validations
+SimplestStatus will automatically add the following validations:
+```ruby
+validates :status, :presence => true, :inclusion => { :in => proc { statuses.values } }
+```

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simplest_status"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/rails_20.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 2.0.5"
+
+gemspec :path => "../"

data/gemfiles/rails_31.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.1.12"
+
+gemspec :path => "../"

data/gemfiles/rails_32.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 3.2.21"
+
+gemspec :path => "../"

data/gemfiles/rails_40.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.0.13"
+
+gemspec :path => "../"

data/gemfiles/rails_41.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.1.10"
+
+gemspec :path => "../"

data/gemfiles/rails_42.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rails", "~> 4.2.1"
+
+gemspec :path => "../"

data/lib/simplest_status/model_methods.rb

@@ -0,0 +1,61 @@
+module SimplestStatus
+  module ModelMethods
+    def self.included(base)
+      Configurator.new(base).configure
+    end
+
+    private
+
+    class Configurator < Struct.new(:model)
+      def configure
+        model.statuses.each do |status|
+          set_constant_for status
+          define_class_methods_for status
+          define_instance_methods_for status
+        end
+
+        define_status_label_method
+        set_validations
+      end
+
+      private
+
+      def set_constant_for(status_info)
+        model.send :const_set, status_info.constant_name, status_info.value
+      end
+
+      def define_class_methods_for(status_info)
+        model.send :define_singleton_method, status_info.symbol do
+          where(:status => status_info.value)
+        end
+      end
+
+      def define_instance_methods_for(status_info)
+        define_predicate(status_info)
+        define_status_setter(status_info)
+      end
+
+      def define_predicate(status_info)
+        model.send :define_method, "#{status_info.symbol}?" do
+          status == status_info.value
+        end
+      end
+
+      def define_status_setter(status_info)
+        model.send :define_method, status_info.symbol do
+          update_attributes(:status => status_info.value)
+        end
+      end
+
+      def define_status_label_method
+        model.send :define_method, :status_label do
+          self.class.statuses.label_for(status)
+        end
+      end
+
+      def set_validations
+        model.send :validates, :status, :presence => true, :inclusion => { :in => proc { model.statuses.values } }
+      end
+    end
+  end
+end

data/lib/simplest_status/status.rb

@@ -0,0 +1,42 @@
+module SimplestStatus
+  class Status
+    attr_reader :name, :value
+
+    def initialize(input)
+      @name, @value = Array(input)
+    end
+
+    def symbol
+      name.to_sym
+    end
+
+    def string
+      name.to_s
+    end
+    alias :to_s :string
+
+    def to_hash
+      { name => value }
+    end
+
+    def matches?(input)
+      [string, value.to_s].include? input.to_s
+    end
+
+    def constant_name
+      string.upcase
+    end
+
+    def label
+      string.split(/[\s_-]+/).map(&:capitalize).join(' ')
+    end
+
+    def for_select
+      [label, value]
+    end
+
+    def ==(status)
+      self.to_hash == status.to_hash
+    end
+  end
+end

data/lib/simplest_status/status_collection.rb

@@ -0,0 +1,34 @@
+module SimplestStatus
+  autoload :Status, 'simplest_status/status'
+
+  class StatusCollection < Hash
+    def each
+      super do |status|
+        yield Status.new(status)
+      end
+    end
+
+    def [](status_name)
+      status_for(status_name).value
+    end
+    alias :value_for :[]
+
+    def status_for(input)
+      find do |status|
+        status.matches? input
+      end
+    end
+
+    def add(status, value = self.size)
+      self.merge!(status => value)
+    end
+
+    def label_for(value)
+      status_for(value).label
+    end
+
+    def for_select
+      map(&:for_select)
+    end
+  end
+end

data/lib/simplest_status/version.rb

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

data/lib/simplest_status.rb

@@ -0,0 +1,16 @@
+require "simplest_status/version"
+
+module SimplestStatus
+  autoload :StatusCollection, 'simplest_status/status_collection'
+  autoload :ModelMethods,     'simplest_status/model_methods'
+
+  def statuses(*status_list)
+    @statuses ||= status_list.reduce(StatusCollection.new) do |collection, status|
+      collection.add(status)
+    end
+
+    send(:include, ModelMethods) unless ancestors.include? ModelMethods
+
+    @statuses
+  end
+end

data/simplest_status.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'simplest_status/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simplest_status"
+  spec.version       = SimplestStatus::VERSION
+  spec.authors       = ["Ryan Stenberg"]
+  spec.email         = ["ryan.stenberg@viget.com"]
+
+  spec.summary       = "Simple status functionality for Rails models."
+  spec.description   = "SimplestStatus provides a dead-simple DSL for defining statuses on Rails models, which generates scopes, constants, and a number of instance-level convenience methods."
+  spec.homepage      = "https://github.com/vigetlabs/simplest_status"
+  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 = %w(lib)
+
+  spec.add_dependency "rails"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "appraisal"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: simplest_status
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Stenberg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-06-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: codeclimate-test-reporter
+  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: appraisal
+  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: SimplestStatus provides a dead-simple DSL for defining statuses on Rails
+  models, which generates scopes, constants, and a number of instance-level convenience
+  methods.
+email:
+- ryan.stenberg@viget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/rails_20.gemfile
+- gemfiles/rails_31.gemfile
+- gemfiles/rails_32.gemfile
+- gemfiles/rails_40.gemfile
+- gemfiles/rails_41.gemfile
+- gemfiles/rails_42.gemfile
+- lib/simplest_status.rb
+- lib/simplest_status/model_methods.rb
+- lib/simplest_status/status.rb
+- lib/simplest_status/status_collection.rb
+- lib/simplest_status/version.rb
+- simplest_status.gemspec
+homepage: https://github.com/vigetlabs/simplest_status
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple status functionality for Rails models.
+test_files: []