discriminable 2.2.1 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 332984f03395d4725f162027692324d66fa591f19820d7690201677c37ab8d0c
-  data.tar.gz: 49017319a8f0cc0ff6bbf498ec32fc68fc51cf062821d683e58b1340b317e7f3
+  metadata.gz: 91332d7c33b8d092f2071dd5d4a59b12786058d8347ba844a8426354133f4e2c
+  data.tar.gz: b743b5f2db1ea1690a5bad69b6b046a58dd14e76c64e47de03dd18a8b57b8003
 SHA512:
-  metadata.gz: 23b33e6a0ebe2009ec62ef57747fbb585cd400837476a3199f28ff8733f607f3974b667713fd788457824adaa9a09ee93e0093e071010016d389b2eab2ec415a
-  data.tar.gz: fabeb7320aa926567261756a3d2c9863feb193abfd4124da42a47588d84ab3b6a4736bd197d850aa74fbd8c6841c7077bbeb41020549f0e962ca54f0d132e494
+  metadata.gz: f0a230f1257e8a53e914c8ac39b879143a897ca0d909441403494afa2e0ba2a48ea529b58efb85b8946c97416dc407ac7bf5cda60a12482cec0aceff22cc6169
+  data.tar.gz: abcc79722fafc181c21f1e27220c4ce46de790e90499de8dd97c94f568b1143d094d6498c93d5975836ec3781fba5e38d8ba51e8b8f002ba1e8dfb4d1d20bb25

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+### [2.2.4](https://github.com/gregorw/discriminable/compare/v2.2.3...v2.2.4) (2022-04-25)
+
+
+### Bug Fixes
+
+* changelog url ([3054a1a](https://github.com/gregorw/discriminable/commit/3054a1a0137d8d3cccb55d7f2f06cb392053dab0))
+* support querying when multiple values are provided ([f75190b](https://github.com/gregorw/discriminable/commit/f75190bcf33dcbddf507626bc77aa4709a594f4d))
+
+### [2.2.3](https://github.com/gregorw/discriminable/compare/v2.2.2...v2.2.3) (2022-04-20)
+
+
+### Bug Fixes
+
+* Allow to use attribute aliases ([448e4e8](https://github.com/gregorw/discriminable/commit/448e4e81925543f1ee4949898f0ac6628eb2d3fd))
+
+### [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)
 
 

data/README.md

@@ -3,28 +3,21 @@
 # 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)
 
-Single table inheritance (STI) for Ruby on Rails models (ActiveRecord) using enum, boolean, string and integer column types.
-
-In other words, use any _existing_ model attribute for STI instead of storing class names in a `type` column.
-
-**Related work**
-
-The idea was originally described in [“Bye Bye STI, Hello Discriminable Model”](https://www.salsify.com/blog/engineering/bye-bye-sti-hello-discriminable-model) by Randy Burkes and this Gem has started out with [his code](https://gist.github.com/rlburkes/798e186acb2f93e787a5).
+This is a Ruby gem that implements single-table inheritance (STI) for ActiveRecord models using string, integer and boolean column types.
 
+In other words, use any (existing) model attribute to discriminate between different classes in your class hierarchy. This makes storing class names in a `type` column redundant.
 
 ## Installation
 
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add discriminable
+    bundle add discriminable
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+or
 
-    $ gem install discriminable
+    gem install discriminable
 
 ## Usage
 
@@ -32,28 +25,29 @@ If bundler is not being used to manage dependencies, install the gem by executin
 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
-=> #<Cart id: 1, state: "open">
+# => #<Cart id: 1, state: "open">
 Order.all
-=> #<ActiveRecord::Relation [#<Cart id: 1, state: "open">]>
+# => #<ActiveRecord::Relation [#<Cart id: 1, state: "open">]>
 ```
 
-### Alternative syntax
+## Features
 
-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.
+### Compatible with enums
 
 ```ruby
 class Order < ActiveRecord::Base
   include Discriminable
 
-  enum state: { open: 0, completed: 1 }
+  enum state: { open: 0, processing: 1, invoiced: 2 }
+
   discriminable_by :state
 end
 
@@ -61,12 +55,42 @@ class Cart < Order
   discriminable_as :open
 end
 
-Cart.create
-=> #<Cart id: 1, state: "open">
-Order.all
-=> #<ActiveRecord::Relation [#<Cart id: 1, state: "open">]>
+class Invoice < Order
+  discriminable_as :invoiced
+end
 ```
 
+### Aliased attributes
+
+In case you are working with a legacy database and cannot change the column name easily it’s easy to reference an aliased attribute in the `discriminable_by` definition.
+
+```ruby
+class Property < ActiveRecord::Base
+  include Discriminable
+
+  alias_attribute :kind, :kind_with_legacy_postfix
+
+  # Aliased attributes are supported when specifying the discriminable attribute
+  discriminable_by :kind
+end
+
+class NumberProperty < Property
+  discriminable_as 1
+end
+```
+
+### Multiple values
+
+Sometimes, in a real project, you may want to map a number of values to a single class. This is possible by specifying:
+
+```ruby
+class OptionProperty < Property
+  # The first mention becomes the default value
+  discriminable_as 2, 3, 4
+end
+```
+
+Note that when creating new records with e.g. `OptionProperty.create` a _default_ value needs to be set in the database for this discriminable class. The Discriminable gem uses the _first_ value in the list as the default.
 
 ## Contributing
 
@@ -79,3 +103,14 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Discriminable project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gregorw/discriminable/blob/main/CODE_OF_CONDUCT.md).
+
+## Related work
+
+The idea for this Gem was influenced by [“Bye Bye STI, Hello Discriminable Model”](https://www.salsify.com/blog/engineering/bye-bye-sti-hello-discriminable-model) by Randy Burkes. This Gem has started out with [his code](https://gist.github.com/rlburkes/798e186acb2f93e787a5).
+
+See also:
+
+- Rails [single table inheritance](https://api.rubyonrails.org/classes/ActiveRecord/Inheritance.html) and [DelegatedType](https://api.rubyonrails.org/classes/ActiveRecord/DelegatedType.html)
+- Java [JPA discrimanator](https://openjpa.apache.org/builds/1.0.2/apache-openjpa-1.0.2/docs/manual/jpa_overview_mapping_discrim.html)
+- Python [model inheritance](https://docs.djangoproject.com/en/4.0/topics/db/models/#model-inheritance-1)
+- [Discriminator](https://github.com/gdpelican/discriminator) gem.

data/TODO.md

@@ -1,6 +1,12 @@
 - [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.
+- [x] Bug: multiple values: Child.all query (double-check)
+- [ ] Rails 5 support (see rails-5 branch)
+- [ ] rubocop-minitest
+- [ ] more tests / examples
+- [ ] Documentation
 - [ ] test permitted attributes
-- [ ] `self.abstract_class = true`
+- [ ] scoping… should work OOTB
+- [ ] ~~`self.abstract_class = true` ➔ This results in separate tables~~
+- [ ] ~~use `type` column with enum, int, string, etc.~~

data/lib/discriminable/version.rb

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

data/lib/discriminable.rb

@@ -36,28 +36,28 @@ module Discriminable
 
       attribute, map = options.first
 
+      # E.g. { value: "ClassName" }
       self.discriminable_map = map.with_indifferent_access
 
       # Use first key as default discriminator
       # { a: "C", b: "C" }.invert => { "C" => :b }
       # { a: "C", b: "C" }.to_a.reverse.to_h.invert => { "C" => :a }
+      # E.g. { "ClassName" => :value }
       self.discriminable_inverse_map = map.to_a.reverse.to_h.invert
-      self.inheritance_column = attribute.to_s
+
+      attribute = attribute.to_s
+      self.inheritance_column = attribute_aliases[attribute] || attribute
     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
+      self.discriminable_map ||= discriminable_map_memoized
+      self.discriminable_inverse_map ||= discriminable_inverse_map_memoized
+
+      attribute = attribute.to_s
+      self.inheritance_column = attribute_aliases[attribute] || attribute
     end
-    # rubocop:enable Metrics/AbcSize
 
     def discriminable_as(*values)
       raise "Only subclasses should specify .discriminable_as" if base_class?
@@ -67,10 +67,22 @@ module Discriminable
       end
     end
 
+    # This is the value of the discriminable attribute
     def sti_name
       discriminable_inverse_map[name]
     end
 
+    def sti_names
+      ([self] + descendants).flat_map(&:discriminable_values)
+    end
+
+    def type_condition(table = arel_table)
+      return super unless discriminable_values.present?
+
+      sti_column = table[inheritance_column]
+      predicate_builder.build(sti_column, sti_names)
+    end
+
     def sti_class_for(value)
       return self unless (type_name = discriminable_map[value])
 
@@ -84,13 +96,27 @@ module Discriminable
       attrs = attrs.to_h if attrs.respond_to?(:permitted?)
       return unless attrs.is_a?(Hash)
 
-      value = attrs.with_indifferent_access[inheritance_column]
-      value = base_class.type_for_attribute(inheritance_column).cast(value)
+      value = discriminable_value(attrs)
       sti_class_for(value)
     end
 
-    def discriminable_descendants(value)
-      descendants.detect { |d| d.discriminable_values.include? value }
+    def discriminable_map_memoized
+      Hash.new do |map, value|
+        map[value] = descendants.detect { |d| d.discriminable_values.include? value }&.name
+      end
+    end
+
+    def discriminable_inverse_map_memoized
+      Hash.new do |map, value|
+        map[value] = value.constantize.discriminable_values&.first
+      end
+    end
+
+    def discriminable_value(attrs)
+      attrs = attrs.with_indifferent_access
+      value = attrs[inheritance_column]
+      value ||= attrs[attribute_aliases.invert[inheritance_column]]
+      base_class.type_for_attribute(inheritance_column).cast(value)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: discriminable
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.2.4
 platform: ruby
 authors:
 - Gregor Wassmann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-17 00:00:00.000000000 Z
+date: 2022-04-25 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/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'false'
 post_install_message:
 rdoc_options: []