discriminable 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b312ea73ac2afbbe72341feffdf97fce4edeee0e918d54ae33ea4b0c822b08cb
-  data.tar.gz: 7f56a7e7fe5b6668f37d1dc8c08730f5fd5bf6a06668b8402a5194b23cb9ba88
+  metadata.gz: 63543cd5b47a63a6870368d2d16c9570e7cd0cebb53cfd296d717884c37fb4c3
+  data.tar.gz: b4417f8e33ff2d24a71a9ec436a26b66c38cab59395ed7fbb1182c818ff48439
 SHA512:
-  metadata.gz: 53c746dbd6c1db4286132420909652551a0471043f29e8a6a1dae37b74905253ae6bdd9f78904a941474e6cdee24cf90f33d85d2e220bdaf841f162c11a54383
-  data.tar.gz: daa33d8edf5ebc3b336388f66f22b826a7fab98f022c27c80dfa5f5068e8d3b537cccf7f9e12f59fe22d5a4ab742aece66f907e33cfd5924864d972cea1201c9
+  metadata.gz: e053310353bf54fcfbef35b32b5de0015f9b28903cb6dc04631bc04cfbaeec274359c0dc34d687eca7a9813eee36590f2c745e90d3c9587e381fceb9bb38886d
+  data.tar.gz: dbf905a1c5a7c7c10154ad5cc9eb73b67d81cd65513e5ac7a1ab33086dbfaee92a885b511942ecc37db4b8528a75283d270ec807db9c4982defb7ba7f2c814a8

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [2.2.0](https://github.com/gregorw/discriminable/compare/v2.1.1...v2.2.0) (2022-04-16)
+
+
+### Features
+
+* Alternative syntax respecting open-closed principle ([8a8f885](https://github.com/gregorw/discriminable/commit/8a8f8857dc24753dc08f21b2bfbb7b4317b7ed5c))
+
 ### [2.1.1](https://github.com/gregorw/discriminable/compare/v2.1.0...v2.1.1) (2022-04-15)
 
 

data/README.md

@@ -29,20 +29,36 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ```ruby
-ActiveRecord::Schema.define do
-  create_table :orders do |t|
-    t.integer :state, limit: 1, default: 0
-  end
+class Order < ActiveRecord::Base
+  include Discriminable
+
+  enum state: { open: 0, completed: 1 }
+  discriminable state: { open: "Cart" }
 end
 
+class Cart < Order
+end
+
+Cart.create
+=> #<Cart id: 1, state: "open">
+Order.all
+=> #<ActiveRecord::Relation [#<Cart id: 1, state: "open">]>
+```
+
+### Alternative syntax
+
+Instead of defining subclass names within the parent you may prefer to be open for extension but closed for modification (open-closed principle) using the alternative syntax.
+
+```ruby
 class Order < ActiveRecord::Base
   include Discriminable
 
   enum state: { open: 0, completed: 1 }
-  discriminable state: { open: "Cart" }
+  discriminable_by :state
 end
 
 class Cart < Order
+  discriminable_as :open
 end
 
 Cart.create

data/Rakefile

@@ -14,3 +14,8 @@ require "rubocop/rake_task"
 RuboCop::RakeTask.new
 
 task default: %i[test rubocop]
+
+# Release task
+# gem build *.gemspec
+# gem push *.gem
+# rm *.gem

data/TODO.md

@@ -1,5 +1,6 @@
-- [ ] multiple values per subclass
-- [ ] default to first value when using hash syntax
-- [ ] open-closed principle
+- [x] multiple values per subclass
+- [x] default to first value when using hash syntax
+- [x] open-closed principle
+- [ ] use `type` column with enum, int, string, etc.
 - [ ] test permitted attributes
-- [ ] `self.abstract_class = true`
+- [ ] `self.abstract_class = true`

data/lib/discriminable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Discriminable
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/lib/discriminable.rb

@@ -26,6 +26,8 @@ module Discriminable
   included do
     class_attribute :discriminable_map, instance_writer: false
     class_attribute :discriminable_inverse_map, instance_writer: false
+    class_attribute :discriminable_values, instance_writer: false
+    class_attribute :discriminable_as_descendant_value, instance_writer: false
   end
 
   # Specify the column to use for discrimination.
@@ -33,7 +35,7 @@ module Discriminable
     def discriminable(**options)
       raise "Subclasses should not override .discriminable" unless base_class?
 
-      discriminator, map = options.first
+      attribute, map = options.first
 
       self.discriminable_map = map.with_indifferent_access
 
@@ -41,14 +43,41 @@ module Discriminable
       # { a: "C", b: "C" }.invert => { "C" => :b }
       # { a: "C", b: "C" }.to_a.reverse.to_h.invert => { "C" => :a }
       self.discriminable_inverse_map = map.to_a.reverse.to_h.invert
-      self.inheritance_column = discriminator.to_s
+      self.inheritance_column = attribute.to_s
+    end
+
+    def discriminable_by(attribute)
+      raise "Subclasses should not override .discriminable_by" unless base_class?
+
+      self.discriminable_as_descendant_value = true
+      self.inheritance_column = attribute.to_s
+    end
+
+    def discriminable_as(*values)
+      raise "Only subclasses should specify .discriminable_as" if base_class?
+
+      self.discriminable_values = values.map do |value|
+        value.instance_of?(Symbol) ? value.to_s : value
+      end
     end
 
     def sti_name
+      if discriminable_as_descendant_value
+        self.discriminable_inverse_map ||= Hash.new do |map, value|
+          map[value] = name.constantize.discriminable_values&.first
+        end
+      end
+
       discriminable_inverse_map[name]
     end
 
     def sti_class_for(value)
+      if discriminable_as_descendant_value
+        self.discriminable_map ||= Hash.new do |map, v|
+          map[v] = descendants.detect { |d| d.discriminable_values.include? v }&.name
+        end
+      end
+
       return self unless (type_name = discriminable_map[value])
 
       super type_name

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discriminable
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Gregor Wassmann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord