simplest_status 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 845888ba96293dd86f09dfa9d2f04de2b0645972
-  data.tar.gz: f10292a0a5691358a4e6f8df725c52edd3d81878
+  metadata.gz: 96f95a8993c3f7812338534148c8cf8c97754955
+  data.tar.gz: ae0f8f974872382df6b6ff331b31bf4cabf99f79
 SHA512:
-  metadata.gz: aebf80db4038ac7a6b7c6b4fc29d76270ef7a5ada06c954fc7a75200552e38b4fe6ec224919d5d59b1acc8f6cb7af1e709f306653689fbf31b1423df666a48c6
-  data.tar.gz: bd1c060400a9a0c3a983600c53b1c77e425a8263c351ad765b986203f575bb23316bd909f9f43ea7ceb0e1dbd1685454ebe3834ce4cc4d0739fb18fcb78b6138
+  metadata.gz: 1ffa1b67cf8a92c48bf6e2a8b1ed8c180e5d99687cf9352ba74df7bfa5a74b832672e6ca322226ea0df7689eb3ea58117b8e4e8f5d6530f4a28479fddc2b8856
+  data.tar.gz: 8d9cc09f264a0e1c6517afaa833bb0035005bb372ae726d956a524284241ea50ab727951b7defef78379eab3159eb00045508de64e4e68ec32dd9409127f9515

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 .DS_Store
 *.gemfile.lock
+*.gem

data/.travis.yml

@@ -5,7 +5,7 @@ rvm:
   - 2.1.0
   - 2.2.2
 gemfile:
-  - gemfiles/rails_20.gemfile
+  - gemfiles/rails_30.gemfile
   - gemfiles/rails_31.gemfile
   - gemfiles/rails_32.gemfile
   - gemfiles/rails_40.gemfile
@@ -14,7 +14,7 @@ gemfile:
 matrix:
   exclude:
     - rvm: 2.2.2
-      gemfile: gemfiles/rails_20.gemfile
+      gemfile: gemfiles/rails_30.gemfile
     - rvm: 2.2.2
       gemfile: gemfiles/rails_31.gemfile
     - rvm: 2.2.2

data/Appraisals

@@ -1,5 +1,5 @@
-appraise "rails-20" do
-  gem "rails", "~> 2.0.5"
+appraise "rails-30" do
+  gem "rails", "~> 3.0.0"
 end
 
 appraise "rails-31" do

data/README.md

@@ -1,8 +1,8 @@
 # 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 a gem built to provide simple, convenient status functionality for Rails models.  It's designed to work with any currently-supported version of Rails (tested as far back as 3.0.0) 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.
+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 and it also provides additional functionality like constant-based status lookup, label helpers, and validations.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -20,28 +20,33 @@ 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`:
+There are two ways to use SimplestStatus, through the default `statuses` method or the `simple_status` method.
+
+The default assumes you've set up an `integer`-type `status` field with `:null => false` and `:default => 0`.  For a `simple_status`, use the same column-type and settings, just give it the name of your custom status:
 ```ruby
 class AddStatusToPostsMigration < ActiveRecord::Migration
   def change
     add_column :posts, :status, :integer, :null => false, :default => 0
+    add_column :posts, :locale, :integer, :null => false, :default => 0
   end
 end
 ```
-Then in your model, extend `SimplestStatus` and list out your statuses:
+Then in your model, extend `SimplestStatus` and list out your statuses using `statuses` or `simple_status`:
 ```ruby
 class Post < ActiveRecord::Base
   extend SimplestStatus
 
   statuses :draft, :preview, :published, :archived
+
+  simple_status :locale, [:english, :spanish, :russian]
 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 }
+Post.locales  # => { :english => 0, :spanish => 1, :russian => 2 }
 ```
 
 The returned hash is a [`StatusCollection`](link) that, when iterated over, yields [`Status`](link) objects:
@@ -55,11 +60,22 @@ Post.statuses.first.tap do |status|
   status.label         # => 'Draft'
   status.for_select    # => ['Draft', 0]
 end
+
+Post.locales.first.tap do |locale|
+  locale.name          # => :english
+  locale.value         # => 0
+  locale.string        # => 'english'
+  locale.to_hash       # => { :english => 0 }
+  locale.constant_name # => 'ENGLISH'
+  locale.label         # => 'English'
+  locale.for_select    # => ['English', 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]]
+Post.locales.for_select  # => [['English', 0], ['Spanish', 1], ['Russian', 2]]
 ```
 
 #### Constants
@@ -69,6 +85,10 @@ Post::DRAFT     # => 0
 Post::PREVIEW   # => 1
 Post::PUBLISHED # => 2
 Post::ARCHIVED  # => 3
+
+Post::ENGLISH   # => 0
+Post::SPANISH   # => 1
+Post::RUSSIAN   # => 2
 ```
 
 #### Scopes
@@ -77,6 +97,10 @@ Post.draft
 Post.preview
 Post.published
 Post.archived
+
+Post.english
+Post.spanish
+Post.russian
 ```
 
 #### Predicate Methods
@@ -87,6 +111,12 @@ Post.new(:status => Post::DRAFT) do |post|
   post.published? # => false
   post.archived?  # => false
 end
+
+Post.new(:locale => Post::RUSSIAN) do |post|
+  post.english? # => false
+  post.spanish? # => false
+  post.russian? # => true
+end
 ```
 
 #### Status Mutation Methods
@@ -97,6 +127,12 @@ Post.new(:status => Post::ARCHIVED) do
   post.published  # status from Post::PREVIEW to Post::PUBLISHED
   post.archived   # status from Post::PUBLISHED to Post::ARCHIVED
 end
+
+Post.new(:status => Post::SPANISH) do
+  post.english # locale from Post::SPANISH to Post::ENGLISH
+  post.spanish # locale from Post::ENGLISH to Post::SPANISH
+  post.russian # locale from Post::SPANISH to Post::RUSSIAN
+end
 ```
 
 #### Status Label Method
@@ -105,10 +141,15 @@ 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'
+
+Post.new(:locale => Post::ENGLISH).locale_label # => 'English'
+Post.new(:locale => Post::SPANISH).locale_label # => 'Spanish'
+Post.new(:locale => Post::RUSSIAN).locale_label # => 'Russian'
 ```
 
 #### Status Validations
 SimplestStatus will automatically add the following validations:
 ```ruby
-validates :status, :presence => true, :inclusion => { :in => proc { statuses.values } }
+validates :status, :presence => true, :inclusion => { :in => statuses.values }
+validates :locale, :presence => true, :inclusion => { :in => locales.values }
 ```

data/gemfiles/{rails_20.gemfile → rails_30.gemfile}

@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 2.0.5"
+gem "rails", "~> 3.0.0"
 
 gemspec :path => "../"

data/lib/simplest_status.rb

@@ -5,12 +5,18 @@ module SimplestStatus
   autoload :ModelMethods,     'simplest_status/model_methods'
 
   def statuses(*status_list)
-    @statuses ||= status_list.reduce(StatusCollection.new) do |collection, status|
-      collection.add(status)
-    end
+    instance_variable_get(:@statuses) || simple_status(:status, status_list)
+  end
 
-    send(:include, ModelMethods) unless ancestors.include? ModelMethods
+  def simple_status(field_name, values)
+    status_collection_for(field_name, values).configure_for(self)
+  end
 
-    @statuses
+  private
+
+  def status_collection_for(status_method, values)
+    values.reduce(StatusCollection.new(status_method)) do |collection, value|
+      collection.add(value)
+    end
   end
 end

data/lib/simplest_status/model_methods.rb

@@ -1,61 +1,79 @@
 module SimplestStatus
-  module ModelMethods
-    def self.included(base)
-      Configurator.new(base).configure
+  class ModelMethods
+    attr_reader :model, :statuses
+
+    def initialize(model, statuses)
+      @model    = model
+      @statuses = statuses
     end
 
-    private
+    def add
+      define_statuses_accessor_for statuses
 
-    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
+      populate_statuses
 
-        define_status_label_method
-        set_validations
-      end
+      process_each_status
 
-      private
+      define_status_label_method_for statuses
 
-      def set_constant_for(status_info)
-        model.send :const_set, status_info.constant_name, status_info.value
-      end
+      set_validations_for statuses
+    end
 
-      def define_class_methods_for(status_info)
-        model.send :define_singleton_method, status_info.symbol do
-          where(:status => status_info.value)
-        end
+    private
+
+    def define_statuses_accessor_for(statuses)
+      model.send :define_singleton_method, statuses.model_accessor do
+        instance_variable_get('@' + statuses.model_accessor)
       end
+    end
+
+    def populate_statuses
+      model.send(:instance_variable_set, '@' + statuses.model_accessor, statuses)
+    end
 
-      def define_instance_methods_for(status_info)
-        define_predicate(status_info)
-        define_status_setter(status_info)
+    def process_each_status
+      statuses.each do |status|
+        set_constant_for status
+        define_class_methods_for status, statuses.status_name
+        define_instance_methods_for status
       end
+    end
+
+    def set_constant_for(status)
+      model.send :const_set, status.constant_name, status.value
+    end
 
-      def define_predicate(status_info)
-        model.send :define_method, "#{status_info.symbol}?" do
-          status == status_info.value
-        end
+    def define_class_methods_for(status, status_name)
+      model.send :define_singleton_method, status.symbol do
+        where(status_name => status.value)
       end
+    end
+
+    def define_instance_methods_for(status)
+      define_predicate(status, statuses.status_name)
+      define_status_setter(status, statuses.status_name)
+    end
 
-      def define_status_setter(status_info)
-        model.send :define_method, status_info.symbol do
-          update_attributes(:status => status_info.value)
-        end
+    def define_predicate(status, status_name)
+      model.send :define_method, "#{status.symbol}?" do
+        send(status_name) == status.value
       end
+    end
 
-      def define_status_label_method
-        model.send :define_method, :status_label do
-          self.class.statuses.label_for(status)
-        end
+    def define_status_setter(status, status_name)
+      model.send :define_method, status.symbol do
+        update_attributes(status_name => status.value)
       end
+    end
 
-      def set_validations
-        model.send :validates, :status, :presence => true, :inclusion => { :in => proc { model.statuses.values } }
+    def define_status_label_method_for(statuses)
+      model.send :define_method, "#{statuses.status_name}_label" do
+        self.class.send(statuses.model_accessor).label_for send(statuses.status_name)
       end
     end
+
+    def set_validations_for(statuses)
+      model.send :validates, statuses.status_name, :presence => true, :inclusion => { :in => statuses.values }
+    end
   end
 end

data/lib/simplest_status/status_collection.rb

@@ -1,3 +1,5 @@
+require "active_support/inflector"
+
 module SimplestStatus
   autoload :Status, 'simplest_status/status'
 
@@ -14,9 +16,7 @@ module SimplestStatus
     alias :value_for :[]
 
     def status_for(input)
-      find do |status|
-        status.matches? input
-      end
+      find { |status| status.matches?(input) } || NullStatus.new
     end
 
     def add(status, value = self.size)
@@ -30,5 +30,21 @@ module SimplestStatus
     def for_select
       map(&:for_select)
     end
+
+    def configure_for(model)
+      tap { ModelMethods.new(model, self).add }
+    end
+
+    def status_name
+      default
+    end
+
+    def model_accessor
+      status_name.to_s.pluralize
+    end
+
+    private
+
+    NullStatus = Struct.new(:value)
   end
 end

data/lib/simplest_status/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplest_status
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Stenberg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-12 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -126,7 +126,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- gemfiles/rails_20.gemfile
+- gemfiles/rails_30.gemfile
 - gemfiles/rails_31.gemfile
 - gemfiles/rails_32.gemfile
 - gemfiles/rails_40.gemfile