discriminable 2.1.1 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b312ea73ac2afbbe72341feffdf97fce4edeee0e918d54ae33ea4b0c822b08cb
-  data.tar.gz: 7f56a7e7fe5b6668f37d1dc8c08730f5fd5bf6a06668b8402a5194b23cb9ba88
+  metadata.gz: 4a89c1ad10593a4aa548c3792343092ef153d6a9a5abd0a65ac253005dcb1b69
+  data.tar.gz: 67db220cf69fa783068f8eb9b2d4852f4a44066926da4703ac41233ff62f88d7
 SHA512:
-  metadata.gz: 53c746dbd6c1db4286132420909652551a0471043f29e8a6a1dae37b74905253ae6bdd9f78904a941474e6cdee24cf90f33d85d2e220bdaf841f162c11a54383
-  data.tar.gz: daa33d8edf5ebc3b336388f66f22b826a7fab98f022c27c80dfa5f5068e8d3b537cccf7f9e12f59fe22d5a4ab742aece66f907e33cfd5924864d972cea1201c9
+  metadata.gz: dbdd8c37b95997ccf9daf4556a79d7248e9d20165ecf8f51022961ed3ae884cb3a16316ff7e8aa7669da53af38e6fba5f9e1a61fcbe13b370c536cdc5bd5fbb1
+  data.tar.gz: 94af960d7e56c3b913faf4d2c5ef721d0400c8e3235884b03cc77707f4015372c12cd108370de41016ffabb7e202217eab9cb14657d566b161b82567b307479f

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## [Unreleased]
 
+### [2.2.2](https://github.com/gregorw/discriminable/compare/v2.2.1...v2.2.2) (2022-04-17)
+
+
+### Bug Fixes
+
+* Typo in gemspec uris ([f77253f](https://github.com/gregorw/discriminable/commit/f77253f2cb2f400e04baf3c7bd6083f42ae3aa6b))
+
+### [2.2.1](https://github.com/gregorw/discriminable/compare/v2.2.0...v2.2.1) (2022-04-17)
+
+
+### Bug Fixes
+
+* Simplify STI using OCP ([68f49c2](https://github.com/gregorw/discriminable/commit/68f49c2d0b7a9437525fe0bc9ebef1927fccb2e8))
+
+## [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

@@ -3,7 +3,7 @@
 # Discriminable
 
 [![Gem Version](https://badge.fury.io/rb/discriminable.svg)](https://rubygems.org/gems/discriminable)
-[![CI](https://github.com/gregorw/discriminable/actions/workflows/main.yml/badge.svg)](https://github.com/gregorw/discriminable/actions/workflows/main.yml)
+[![CI](https://github.com/gregorw/discriminable/actions/workflows/main.yml/badge.svg?event=push)](https://github.com/gregorw/discriminable/actions/workflows/main.yml)
 [![Maintainability](https://api.codeclimate.com/v1/badges/94041c5f946b64040368/maintainability)](https://codeclimate.com/github/gregorw/discriminable/maintainability)
 [![Test Coverage](https://api.codeclimate.com/v1/badges/94041c5f946b64040368/test_coverage)](https://codeclimate.com/github/gregorw/discriminable/test_coverage)
 
@@ -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,6 @@ 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.2"
 end

data/lib/discriminable.rb

@@ -26,6 +26,7 @@ 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
   end
 
   # Specify the column to use for discrimination.
@@ -33,7 +34,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,7 +42,29 @@ 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
+
+    # rubocop:disable Metrics/AbcSize
+    def discriminable_by(attribute)
+      raise "Subclasses should not override .discriminable_by" unless base_class?
+
+      self.inheritance_column = attribute.to_s
+      self.discriminable_map ||= Hash.new do |map, value|
+        map[value] = discriminable_descendants(value)&.name
+      end
+      self.discriminable_inverse_map ||= Hash.new do |map, value|
+        map[value] = value.constantize.discriminable_values&.first
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    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
@@ -65,5 +88,9 @@ module Discriminable
       value = base_class.type_for_attribute(inheritance_column).cast(value)
       sti_class_for(value)
     end
+
+    def discriminable_descendants(value)
+      descendants.detect { |d| d.discriminable_values.include? value }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discriminable
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.2
 platform: ruby
 authors:
 - Gregor Wassmann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -131,13 +131,13 @@ files:
 - lib/discriminable.rb
 - lib/discriminable/version.rb
 - sig/discriminable.rbs
-homepage: https://github.com/gregorw/discrimainable
+homepage: https://github.com/gregorw/discriminable
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/gregorw/discrimainable
-  source_code_uri: https://github.com/gregorw/discrimainable
-  changelog_uri: https://github.com/gregorw/discrimainable/CHANGELOG.md
+  homepage_uri: https://github.com/gregorw/discriminable
+  source_code_uri: https://github.com/gregorw/discriminable
+  changelog_uri: https://github.com/gregorw/discriminable/CHANGELOG.md
   rubygems_mfa_required: 'false'
 post_install_message:
 rdoc_options: []