discriminable 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6d47dda88efcbf4f311ff843e0b4e3e06ffda5f205d810e9a4ab4ad089d13ad
-  data.tar.gz: 64d5ad043e453d28d98603d5c3153783ac153c97bcd70179ea86e962bcdd4f85
+  metadata.gz: 332984f03395d4725f162027692324d66fa591f19820d7690201677c37ab8d0c
+  data.tar.gz: 49017319a8f0cc0ff6bbf498ec32fc68fc51cf062821d683e58b1340b317e7f3
 SHA512:
-  metadata.gz: 1e272415e3aef0d7c365b0189564261ac138029d3feb1e8bcc7c01468132763f2af723c8b73df8806f5f313f30b0d7bbbe070b00f3f67ddbb4103677aa6d3b3e
-  data.tar.gz: 04c96941797c296976f88ecf00b84c51c26d9dcfd954012c3abec8ae17dec6bcd03d6958f47af2e01ba93bd206ca42f3e8c5fa0eff5019e7925e81d28f41ce24
+  metadata.gz: 23b33e6a0ebe2009ec62ef57747fbb585cd400837476a3199f28ff8733f607f3974b667713fd788457824adaa9a09ee93e0093e071010016d389b2eab2ec415a
+  data.tar.gz: fabeb7320aa926567261756a3d2c9863feb193abfd4124da42a47588d84ab3b6a4736bd197d850aa74fbd8c6841c7077bbeb41020549f0e962ca54f0d132e494

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 ## [Unreleased]
 
+### [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)
+
+
+### Bug Fixes
+
+* Subclass is not properly initialized on new objects ([c24706c](https://github.com/gregorw/discriminable/commit/c24706c9e8cd4c80ea20016e341f010a5a3c792b))
+* Use correct, i.e. first value, when using multiple states for same subclass ([3a05c0d](https://github.com/gregorw/discriminable/commit/3a05c0d3a76080a39f40b1d57ce2862316693f97))
+
 ## [2.1.0](https://github.com/gregorw/discriminable/compare/v2.0.0...v2.1.0) (2022-04-01)
 
 

data/README.md

@@ -1,10 +1,20 @@
-[![Ruby](https://github.com/gregorw/discriminable/actions/workflows/main.yml/badge.svg)](https://github.com/gregorw/discriminable/actions/workflows/main.yml)
+
 
 # Discriminable
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/discriminable`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![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)
+[![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).
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -18,13 +28,45 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+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_by :state
+end
 
-## Development
+class Cart < Order
+  discriminable_as :open
+end
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Cart.create
+=> #<Cart id: 1, state: "open">
+Order.all
+=> #<ActiveRecord::Relation [#<Cart id: 1, state: "open">]>
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

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,2 +1,6 @@
+- [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`
-- [ ] …

data/lib/discriminable/version.rb

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

data/lib/discriminable.rb

@@ -25,7 +25,8 @@ module Discriminable
 
   included do
     class_attribute :discriminable_map, instance_writer: false
-    class_attribute :discriminable_inverse, 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,15 +34,41 @@ 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
-      self.discriminable_inverse = map.invert
-      self.inheritance_column = discriminator.to_s
+
+      # 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 }
+      self.discriminable_inverse_map = map.to_a.reverse.to_h.invert
+      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
-      discriminable_inverse[name]
+      discriminable_inverse_map[name]
     end
 
     def sti_class_for(value)
@@ -57,8 +84,13 @@ module Discriminable
       attrs = attrs.to_h if attrs.respond_to?(:permitted?)
       return unless attrs.is_a?(Hash)
 
-      value = base_class.type_for_attribute(inheritance_column).cast(attrs[inheritance_column])
+      value = attrs.with_indifferent_access[inheritance_column]
+      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.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Gregor Wassmann
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.26'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement