affairs_of_state 0.1.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 82cee7ae333311fa7e78ad67e2dadf4519588278
-  data.tar.gz: c9e55851f6777e1c0db00e04752b620537cfdf4f
+SHA256:
+  metadata.gz: 2757335e832c9809fa86e7c365dda4d6fe31b49ab837665ecbd80ec2f3b27ac2
+  data.tar.gz: 18c9e1b16df324170b4af93859379540e56aafa27068490a743bd155b3a9c83a
 SHA512:
-  metadata.gz: 9a6113b5f54561f269db052207e4cdc352495ff90af4919422b16704db46b9c3da3898f41dd8660b68dab77fc7db6be71d523f374bc81bbd7088522bcfc527d7
-  data.tar.gz: 207c299cae44330886c9ba4a93dbbff7a1d1d15eb119d05ebbff8153957a56df780ea01ad855e77846a76e68cf7f05f9decc0ad4ad1e5479d172de4d3fe2bd4d
+  metadata.gz: 6e9b37707ae931a4a9231b4b453b075db2d0c1e16c4bddf1696f20adcf26bd5b23744e6f185602d50e036465d1cf060dd2b4951857d252d387a5c140b4a18029
+  data.tar.gz: 03c8db3940a2c167922048afecfa75d1ad4f28fcb386e16fc57bbbe6101c2f8416fece5ba12bba7af21407746149ec0252d46a7ce407b618b7db9af1f535ad7b

data/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on: [ push, pull_request ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        gemfile:
+          - "activerecord-6.0.gemfile"
+          - "activerecord-6.1.gemfile"
+          - "activerecord-latest.gemfile"
+    runs-on: ubuntu-latest
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/${{ matrix.gemfile }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.2
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - name: Run tests
+        run: |
+          bundle exec rspec --format doc

data/README.md

@@ -1,8 +1,8 @@
 # Affairs of State
 
-[![Build Status](https://travis-ci.org/kmcphillips/affairs_of_state.png?branch=master)](https://travis-ci.org/kmcphillips/affairs_of_state)
+![Build Status](https://github.com/kmcphillips/affairs_of_state/actions/workflows/ci.yml/badge.svg)
 
-You have an Active Record model. It nees to have multiple states, but not complex rules. This gem gives you validation, easy check and change methods, and a single configuration line.
+You have an Active Record model. It nees to have multiple states, boolean convenience methods, simple validation, but not complex rules. This gem gives you this in a single line class method.
 
 ## Installation
 
@@ -12,13 +12,7 @@ Add this line to your application's Gemfile:
 gem 'affairs_of_state'
 ```
 
-And then execute:
-
-```ruby
-$ bundle
-```
-
-Or install it yourself as:
+Or install it with:
 
 ```ruby
 $ gem install affairs_of_state
@@ -29,7 +23,7 @@ $ gem install affairs_of_state
 The gem assumes you have a string column named `status` on your model:
 
 ```ruby
-add_column :model_name, :status, :default => "active"
+add_column :model_name, :status, default: "active"
 ```
 
 Then you just list your states in the model:
@@ -41,13 +35,13 @@ affairs_of_state :active, :inactive
 If you'd like to use another column, lets say `state`, pass it in as a configuration option:
 
 ```ruby
-affairs_of_state :active, :inactive, :column => :state
+affairs_of_state :active, :inactive, column: :state
 ```
 
 You can also turn off validation:
 
 ```ruby
-affairs_of_state :active, :inactive, :allow_blank => true
+affairs_of_state :active, :inactive, allow_blank: true
 ```
 
 Or give it a long list of statuses:
@@ -59,10 +53,14 @@ affairs_of_state :ordered, :cancelled, :shipped, :lost, :in_transit
 You can also pass a proc or a method name symbol to the :if option to bypass validation:
 
 ```ruby
-affairs_of_state :active, :inactive, :if => lambda{|object| only_validate_if_this_is_true(object) }
-# or
-affairs_of_state :active, :inactive, :if => :only_validate_if_this_method_returns_true
+affairs_of_state :active, :inactive, if: ->(object) { only_validate_if_this_is_true(object) }
 ```
+or
+```ruby
+affairs_of_state :active, :inactive, if: :only_validate_if_this_method_returns_true
+```
+
+Currently it is limited only be called once per model.
 
 
 ## Methods
@@ -114,6 +112,6 @@ rspec
 
 ## The usual
 
-Author: Kevin McPhillips - github@kevinmcphillips.ca
+By Kevin McPhillips (github@kevinmcphillips.ca)
 
-License: [MIT](http://opensource.org/licenses/MIT)
+[MIT License](http://opensource.org/licenses/MIT)

data/affairs_of_state.gemspec

@@ -16,10 +16,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = AffairsOfState::VERSION
 
-  gem.add_dependency "activerecord", "> 3.0"
+  gem.add_dependency "activerecord", ">= 6.0"
+  gem.add_dependency "activesupport", ">= 6.0"
 
-  gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "sqlite3"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "sqlite3", "~> 1.4.0"
   gem.add_development_dependency "pry"
+  gem.add_development_dependency "rake"
 
 end

data/gemfiles/activerecord-6.0.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'activerecord', '~> 6.0'

data/gemfiles/activerecord-6.1.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'activerecord', '~> 6.1'

data/gemfiles/activerecord-latest.gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '..'
+
+gem 'activerecord'

data/lib/affairs_of_state/config.rb

@@ -0,0 +1,16 @@
+module AffairsOfState
+  class Config
+    attr_accessor :column, :allow_blank, :scopes, :if
+    attr_reader :statuses
+
+    def statuses=(val)
+      @statuses = val.flatten.map(&:to_s)
+
+      @statuses.each do |status|
+        raise ArgumentError.new("Affairs of State: '#{ status }' is not a valid status") if ["new"].include?(status)
+      end
+
+      @statuses
+    end
+  end
+end

data/lib/affairs_of_state/version.rb

@@ -1,3 +1,3 @@
 module AffairsOfState
-  VERSION = "0.1.4"
+  VERSION = "0.6.0"
 end

data/lib/affairs_of_state.rb

@@ -1,67 +1,65 @@
+require "active_support"
+require "active_support/concern"
+require "active_record"
+
 require "affairs_of_state/version"
+require "affairs_of_state/config"
 
 module AffairsOfState
+  extend ActiveSupport::Concern
 
-  def self.included(base)
-    base.extend ClassMethods
-  end
+  class_methods do
+    def affairs_of_state(*statuses, column: :status, allow_blank: false, scopes: true, if: nil)
+      raise ArgumentError.new("Affairs of State: cannot be invoked multiple times on the same model") if @affairs_of_state_config
+
+      affairs_of_state_config.statuses = statuses
+      affairs_of_state_config.column = column
+      affairs_of_state_config.allow_blank = allow_blank
+      affairs_of_state_config.scopes = scopes
+      affairs_of_state_config.if = binding.local_variable_get(:if)
 
-  module ClassMethods
-    def affairs_of_state(*args)
-      @_status_options = ({:column => :status, :allow_blank => false, :scopes => true, :if => nil}).merge(args.extract_options!)
-      @_statuses = args.flatten.map(&:to_s)
+      const_set(:STATUSES, affairs_of_state_config.statuses)
+
+      affairs_of_state_config.statuses.each do |status|
+        define_method("#{ status }?") do
+          self.send(self.class.affairs_of_state_config.column) == status
+        end
 
-      const_set("STATUSES", @_statuses)
+        define_method("#{ status }!") do
+          self.send("#{ self.class.affairs_of_state_config.column }=", status)
+          self.save
+        end
+      end
 
-      validates(@_status_options[:column], :inclusion => {:in => @_statuses, :allow_blank => @_status_options[:allow_blank]}, :if => @_status_options[:if])
+      validates(affairs_of_state_config.column, inclusion: { in: affairs_of_state_config.statuses, allow_blank: affairs_of_state_config.allow_blank }, if: affairs_of_state_config.if)
 
-      if @_status_options[:scopes]
-        @_statuses.each do |status|
-          raise "Affairs of State: '#{ status }' is not a valid status" unless valid_status?(status)
-          self.scope status.to_sym, -> { where(@_status_options[:column] => status.to_s) }
+      if affairs_of_state_config.scopes
+        affairs_of_state_config.statuses.each do |status|
+          self.scope(status.to_sym, -> { where(affairs_of_state_config.column => status) })
         end
       end
 
       include InstanceMethods
       extend SingletonMethods
+
       true
     end
 
-    private
-
-    def valid_status?(status)
-      ![:new].include?(status.to_sym)
+    def affairs_of_state_config
+      @affairs_of_state_config ||= AffairsOfState::Config.new
     end
   end
 
   module InstanceMethods
-    def method_missing(method, *args)
-      if self.class::STATUSES.map{|s| "#{s}?".to_sym }.include?(method)
-        self.class.send(:define_method, method) do
-          self.status == method.to_s.gsub(/\?$/, "")
-        end
-
-        send method
-
-      elsif self.class::STATUSES.map{|s| "#{s}!".to_sym }.include?(method)
-        self.class.send(:define_method, method) do
-          self.send("#{self.class.instance_variable_get('@_status_options')[:column]}=", method.to_s.gsub(/\!$/, ""))
-          self.save
-        end
-
-        send method
-      else
-        super
-      end
-    end
   end
 
   module SingletonMethods
     def statuses_for_select
-      @_statuses.map{|s| [s.humanize, s]}
+      affairs_of_state_config.statuses.map{ |s| [s.humanize, s] }
     end
   end
-
 end
 
-ActiveRecord::Base.send :include, AffairsOfState
+ActiveSupport.on_load(:active_record) do
+  ::ActiveRecord::Base.send :include, AffairsOfState
+end

data/spec/affairs_of_state_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe AffairsOfState do
-
   describe "with a simple configuration" do
     class Pie < ActiveRecord::Base
       affairs_of_state :active, :inactive, :cancelled
@@ -71,6 +70,16 @@ describe AffairsOfState do
     it "should validate the column is set" do
       expect(Pie2.new(status: nil, super_status: "active")).to be_valid
     end
+
+    it "should know the accessors" do
+      expect(Pie2.new(status: nil, super_status: "inactive").inactive?).to be(true)
+    end
+
+    it "should know the setters" do
+      instance = Pie2.create!(status: nil, super_status: "inactive")
+      expect(instance.active!).to be(true)
+      expect(instance.super_status).to eq("active")
+    end
   end
 
   describe "without validations" do
@@ -163,8 +172,18 @@ describe AffairsOfState do
 
   describe "invalid status name" do
     it "should raise a good warning" do
-      expect(->{ class Pie8 < ActiveRecord::Base ; affairs_of_state :new ; end }).to raise_error("Affairs of State: 'new' is not a valid status")
+      expect(->{ class Pie8 < ActiveRecord::Base ; affairs_of_state :new ; end }).to raise_error(ArgumentError, "Affairs of State: 'new' is not a valid status")
     end
   end
 
+  describe "multiple invocations" do
+    it "raises an error" do
+      expect(->{
+        class Pie9 < ActiveRecord::Base
+          affairs_of_state :not_important
+          affairs_of_state :something
+        end
+      }).to raise_error(ArgumentError, "Affairs of State: cannot be invoked multiple times on the same model")
+    end
+  end
 end

data/spec/config_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe AffairsOfState::Config do
+  subject{ AffairsOfState::Config.new }
+
+  describe "accessors" do
+    let(:expected){ double }
+
+    it "has :column" do
+      subject.column = expected
+      expect(subject.column).to eq(expected)
+    end
+
+    it "has :allow_blank" do
+      subject.allow_blank = expected
+      expect(subject.allow_blank).to eq(expected)
+    end
+
+    it "has :scopes" do
+      subject.scopes = expected
+      expect(subject.scopes).to eq(expected)
+    end
+
+    it "has :if" do
+      subject.if = expected
+      expect(subject.if).to eq(expected)
+    end
+  end
+
+  describe "#statuses=" do
+    it "converts to string" do
+      subject.statuses = [:a, :b]
+      expect(subject.statuses).to eq(["a", "b"])
+    end
+
+    it "flattens" do
+      subject.statuses = ["a", [:b]]
+      expect(subject.statuses).to eq(["a", "b"])
+    end
+
+    it "makes sure no invalid statuses are allowed" do
+      expect(->{
+        subject.statuses = [:new]
+      }).to raise_error(ArgumentError, "Affairs of State: 'new' is not a valid status")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,18 +1,18 @@
-require 'active_record'
-require 'affairs_of_state'
-require 'pry'
+require "affairs_of_state"
+
+require "pry"
+require "sqlite3"
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true
 end
 
-
 ## Create an AR model to test with
 I18n.enforce_available_locales = false
 
 ActiveRecord::Base.establish_connection(
-  :adapter => "sqlite3",
-  :database => "#{File.expand_path(File.join(File.dirname(__FILE__), '..'))}/spec/db/test.sqlite3"
+  adapter: "sqlite3",
+  database: "#{File.expand_path(File.join(File.dirname(__FILE__), '..'))}/spec/db/test.sqlite3"
 )
 
 ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'pies'")

metadata

@@ -1,45 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: affairs_of_state
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Kevin McPhillips
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-06-06 00:00:00.000000000 Z
+date: 2021-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,24 +102,29 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - affairs_of_state.gemspec
+- gemfiles/activerecord-6.0.gemfile
+- gemfiles/activerecord-6.1.gemfile
+- gemfiles/activerecord-latest.gemfile
 - lib/affairs_of_state.rb
+- lib/affairs_of_state/config.rb
 - lib/affairs_of_state/version.rb
 - spec/affairs_of_state_spec.rb
+- spec/config_spec.rb
 - spec/db/.gitkeep
 - spec/spec_helper.rb
 homepage: http://github.com/kmcphillips/affairs_of_state
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,14 +139,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: You have an Active Record model. It nees to have multiple states, but not
   complex rules. This gem gives you validation, easy check and change methods, and
   a single configuration line.
-test_files:
-- spec/affairs_of_state_spec.rb
-- spec/db/.gitkeep
-- spec/spec_helper.rb
+test_files: []

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - "2.1.0"
-script: bundle exec rspec