affairs_of_state 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73f6fed4bcc0422024de20521810e21f4d9a77411382af6d6b8f52c79f941ca7
-  data.tar.gz: b128a4dcea99c0c3e192792ffea7a6a6b670f58994c26bd2c8d808360fd620bf
+  metadata.gz: 393e826c50c889d987390c00c48332b5f25b36dacc8977a4b6ae872b031507c0
+  data.tar.gz: 268729f4f4e5d03616028ae9ad663e9333ec77be659c1eb17ff4ba78f9ea44f1
 SHA512:
-  metadata.gz: 8fe6d2bf961248735b23fa41afaa2ebe8712a9ea55896537c6dd66efcabe1426491635e8fa3be707bbb068756a7fc3f726893cb6cefc36a61b36f6785a1c3f45
-  data.tar.gz: b5df8b2a439fead18dc1e79340141137b307ecb1024d7e82884f17312f9231f3e26d680e5bd31309da2447e183ee27b8a7d5ae1470e89929172c5422dd806eeb
+  metadata.gz: b28c839c99db9cf1a7560766f46bda687825c23e6d17c2f20b1246d239990f26a450e5a9350c10f1ea191678b929ecf88c0a389be7620d13f37e26d3d02525eb
+  data.tar.gz: 88a2b5f1cefe5ac0017eeaa9b2c2d480895b51f31497adf049a8ce54dbd3966f3c9e8f472d1b300e9d650c644ca1cb3b67063ddcbf7067e914e21c42d96a05f6

data/README.md

@@ -38,6 +38,12 @@ If you'd like to use another column, lets say `state`, pass it in as a configura
 affairs_of_state :active, :inactive, column: :state
 ```
 
+You can scope the helper and scope methods by a prefix:
+
+```ruby
+affairs_of_state :active, :inactive, prefix: :admin
+```
+
 You can also turn off validation:
 
 ```ruby
@@ -72,6 +78,12 @@ widget = Widget.first
 widget.cancelled! if widget.active?
 ```
 
+These methods are scoped by the prefix if one is set:
+```ruby
+widget = Widget.first
+widget.admin_cancelled! if widget.admin_active?
+```
+
 You can also access all your statuses on the model. If only one is defined it is default, otherwise the column name needs to be passed in:
 
 ```ruby
@@ -79,12 +91,16 @@ Widget.statuses  # -> ["active", "cancelled"]
 Widget.statuses(:status)  # -> ["active", "cancelled"]
 ```
 
-It also provides scopes automagically:
+It also provides scopes automagically, scoped by prefix if one is set:
 
 ```ruby
 Widget.active
 Widget.cancelled
 ```
+```ruby
+Widget.admin_active
+Widget.admin_cancelled
+```
 
 For select inputs in forms there is a convenience method that returns all states in the format expected by `options_for_select`. Again if only one is defined on the model it returns as default, if multiple are defined the column name needs to be passed in:
 

data/lib/affairs_of_state/active_record_extension.rb

@@ -4,10 +4,11 @@ module AffairsOfState
     extend ActiveSupport::Concern
 
     class_methods do
-      def affairs_of_state(*statuses, column: :status, allow_blank: false, scopes: true, if: nil)
+      def affairs_of_state(*statuses, column: :status, allow_blank: false, scopes: true, if: nil, prefix: nil)
         # config object that defines behaviour
         config = AffairsOfState::Config.new(
           statuses: statuses,
+          prefix: prefix,
           column: column,
           allow_blank: !!allow_blank,
           scopes: scopes,
@@ -16,31 +17,32 @@ module AffairsOfState
 
         # check for conflicts with existing calls
         raise ArgumentError, "Affairs of State: #{ self } has already been called on `#{ config.column }`" if affairs_of_state_configs[config.column]
-        overlapping_statuses = affairs_of_state_configs.values.map(&:statuses) & config.statuses
+        statuses_and_methods = affairs_of_state_configs.values.map(&:methods_for_statuses).map { |m| m.map{ |(k, v)| [k, v] } }.flatten
+        overlapping_statuses = statuses_and_methods & config.methods_for_statuses.map{ |k, v| [k, v] }.flatten
         raise ArgumentError, "Affairs of State: #{ self } already has a status #{ overlapping_statuses }" if overlapping_statuses.any?
 
         # status methods
-        config.statuses.each do |status|
-          define_method("#{ status }?") do
+        config.methods_for_statuses.each do |status, method_name|
+          define_method("#{ method_name }?") do
             self.send(config.column) == status
           end
 
-          define_method("#{ status }!") do
+          define_method("#{ method_name }!") do
             self.send("#{ config.column }=", status)
             self.save
           end
         end
 
-        # column validation
-        validates(config.column, inclusion: { in: config.statuses, allow_blank: config.allow_blank }, if: config.if)
-
         # scopes
         if config.scopes
-          config.statuses.each do |status|
-            self.scope(status.to_sym, -> { where(config.column => status) })
+          config.methods_for_statuses.each do |status, method_name|
+            self.scope(method_name.to_sym, -> { where(config.column => status) })
           end
         end
 
+        # column validation
+        validates(config.column, inclusion: { in: config.statuses, allow_blank: config.allow_blank }, if: config.if)
+
         # cache the config on the object
         affairs_of_state_configs[config.column] = config
 

data/lib/affairs_of_state/config.rb

@@ -1,16 +1,24 @@
 # frozen_string_literal: true
 module AffairsOfState
   class Config
-    attr_reader :statuses, :column, :allow_blank, :scopes, :if
+    attr_reader :statuses, :column, :allow_blank, :scopes, :if, :methods_for_statuses
 
     DISALLOWED_STATUSES = [ "new" ].freeze
 
-    def initialize(statuses:, column:, allow_blank:, scopes:, if:)
+    def initialize(statuses:, column:, allow_blank:, scopes:, if:, prefix:)
       @column = column
       @allow_blank = !!allow_blank
       @scopes = !!scopes
       @if = binding.local_variable_get(:if)
+      @prefix = prefix.presence
       @statuses = statuses.flatten.map(&:to_s)
+      @methods_for_statuses = @statuses.to_h do |s|
+        if @prefix
+          [s.to_s, "#{ prefix }_#{ s }"]
+        else
+          [s.to_s, s.to_s]
+        end
+      end
       @statuses.each do |status|
         raise ArgumentError.new("Affairs of State: '#{ status }' is not a valid status") if DISALLOWED_STATUSES.include?(status)
       end

data/lib/affairs_of_state/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module AffairsOfState
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

data/spec/affairs_of_state_spec.rb

@@ -215,7 +215,7 @@ describe AffairsOfState do
 
     it "raises if called twice on the same column" do
       expect {
-        class Pie < ActiveRecord::Base
+        class Pie10 < ActiveRecord::Base
           self.table_name = "pies"
 
           affairs_of_state :active, :inactive
@@ -226,7 +226,7 @@ describe AffairsOfState do
 
     it "raises if called twice with the same status in both" do
       expect {
-        class Pie < ActiveRecord::Base
+        class Pie11 < ActiveRecord::Base
           self.table_name = "pies"
 
           affairs_of_state :active, :inactive
@@ -235,6 +235,17 @@ describe AffairsOfState do
       }.to raise_error(ArgumentError)
     end
 
+    it "raises if collision between prefixes" do
+      expect {
+        class Pie12 < ActiveRecord::Base
+          self.table_name = "pies"
+
+          affairs_of_state :admin_active, :admin_inactive
+          affairs_of_state :dormant, :active, column: :super_status, prefix: :admin
+        end
+      }.to raise_error(ArgumentError)
+    end
+
     it "raises if statuses is called with no argument" do
       expect {
         subject.statuses
@@ -257,4 +268,36 @@ describe AffairsOfState do
       expect(subject.statuses_for_select("super_status")).to eq([["Moderated", "moderated"], ["Unmoderated", "unmoderated"]])
     end
   end
+
+  describe "multiple invocations with prefix" do
+    class Pie13 < ActiveRecord::Base
+      self.table_name = "pies"
+
+      affairs_of_state :active, :inactive
+      affairs_of_state :moderated, :unmoderated, column: :super_status
+      affairs_of_state :positive, :mixed, :negative, column: :sentiment, prefix: :sentiment
+    end
+
+    subject { Pie13 }
+
+    it "returns the statuses" do
+      expect(subject.statuses(:sentiment)).to eq([ "positive", "mixed", "negative" ])
+    end
+
+    it "adds the setter and getter methods with the prefix" do
+      p = subject.new
+      expect(p).to_not be_sentiment_positive
+      expect(p).to_not be_sentiment_mixed
+      expect(p).to_not be_sentiment_negative
+      p.sentiment_mixed!
+      expect(p).to be_sentiment_mixed
+    end
+
+    it "adds the scopes with the prefix" do
+      p = subject.create! sentiment: "positive", status: "active", super_status: "unmoderated"
+      subject.create! sentiment: "mixed", status: "active", super_status: "unmoderated"
+      subject.create! sentiment: "negative", status: "active", super_status: "unmoderated"
+      expect(subject.sentiment_positive).to eq([p])
+    end
+  end
 end

data/spec/config_spec.rb

@@ -8,7 +8,8 @@ describe AffairsOfState::Config do
       column: column,
       allow_blank: allow_blank,
       scopes: scopes,
-      if: if_condition
+      if: if_condition,
+      prefix: prefix
     )
   end
   let(:column) { "state" }
@@ -16,6 +17,7 @@ describe AffairsOfState::Config do
   let(:allow_blank) { "sure" }
   let(:scopes) { nil }
   let(:if_condition) { "false" }
+  let(:prefix) { nil }
 
   subject { config }
 
@@ -39,6 +41,10 @@ describe AffairsOfState::Config do
     it "has :statuses and converts to strings and flattens" do
       expect(subject.statuses).to eq(["created", "destroyed"])
     end
+
+    it "has :methods_for_statuses which is the same key values" do
+      expect(subject.methods_for_statuses).to eq({ "created" => "created", "destroyed" => "destroyed" })
+    end
   end
 
   context "with invalid status" do
@@ -48,4 +54,16 @@ describe AffairsOfState::Config do
       expect { subject }.to raise_error(ArgumentError, "Affairs of State: 'new' is not a valid status")
     end
   end
+
+  context "with prefix" do
+    let(:prefix) { :admin }
+
+    it "has :statuses just the same" do
+      expect(subject.statuses).to eq(["created", "destroyed"])
+    end
+
+    it "has :methods_for_statuses" do
+      expect(subject.methods_for_statuses).to eq({ "created" => "admin_created", "destroyed" => "admin_destroyed" })
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -21,4 +21,5 @@ ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS 'pies'")
 ActiveRecord::Base.connection.create_table(:pies) do |t|
   t.string :status
   t.string :super_status
+  t.string :sentiment
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: affairs_of_state
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Kevin McPhillips
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-12 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord