rails_sorbet_enum 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96bafabeef49a552e30d79d812f9be8fd0a647fbe5502fe8c5c31cef92509297
-  data.tar.gz: f77529b1c8592ee3e5756e9de84373ad2a241477448f6bf78c5b06de73a0b1c8
+  metadata.gz: cdef0b96b3a3eae6bd045fe68a35e277ddc318bb59a4053319001fc94726174b
+  data.tar.gz: 5444e0c5b93bd459c86183d8f2ee50a4548e5163d8e6bcb67a4cc81d9f34a401
 SHA512:
-  metadata.gz: 2f68bc575101df45bf6c82e3b855fba15b03a148576516a88686883f4dec45f89429d9c1911b041134da2d4d9820a21d73e9f26ff4a087f559b0329e72a09bfe
-  data.tar.gz: b66f0e77ad304f584f0d38872aeef8990eb34f4333142b9e75eb673d9051818e207ddc1f195ad197847a216384e0cb46c0d63e05eda97f4cafe553097bd1e76c
+  metadata.gz: 6a694bb027560e17856b7837e7c303762e623b6434dbffb028276a13ea052c7d4599511208e4d3f9dd8aa1aaf9f4ceda1f95be4b88f2635f8caa0c3ecdeb1726
+  data.tar.gz: f0c4512d3cf449bd88cc2afbf26ef5af0fb46a695363687d1313dff244e6c37eda646f18f15ed3ebaa2cfc714d3d0db6c0ae7cfcef70a5475934a77633995ce0

data/.rubocop.yml

@@ -5,9 +5,15 @@ AllCops:
   NewCops: enable
   TargetRubyVersion: 3.1
 
+Layout/ArgumentAlignment:
+  EnforcedStyle: with_fixed_indentation
+
 Metrics/AbcSize:
   Enabled: false
 
+Metrics/BlockLength:
+  Enabled: false
+
 Metrics/MethodLength:
   Enabled: false
 

data/README.md

@@ -1,28 +1,47 @@
-# RailsSorbetEnum
+# rails_sorbet_enum
 
-TODO: Delete this and the text below, and describe your gem
-
-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/rails_sorbet_enum`. To experiment with that code, run `bin/console` for an interactive prompt.
+A gem that adds support for using typed [Sorbet T::Enums](https://sorbet.org/docs/tenum)
+as Rails ActiveRecord enum columns.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add rails_sorbet_enum
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Usage
+
+Declare the enum by including `RailsSorbetEnum::Concern` and calling `sorbet_enum`.
 
-```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+# app/models/my_model.rb
+class MyModel < ApplicationModel
+  include RailsSorbetEnum::Concern
+
+  class Status < T::Enum
+    enums do
+      Pending = new('pending')
+      Done = new('done')
+    end
+  end
+
+  # :status is the column name with `string` type
+  sorbet_enum(:status, Status)
+end
 ```
 
-## Usage
+The `status` field will be of the enum type, rather than a string.
 
-TODO: Write usage instructions here
+```ruby
+my_model.status                          #=> MyModel::Status
+my_model.status = MyModel::Status::Done
+
+# If the enum field is set to a non-enum value, the assignment will raise
+# rather than failing validation.
+my_model.status = 'done'                 #=> raises ActiveRecord::SerializationTypeMismatch
+```
 
 ## Development
 
@@ -30,6 +49,3 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_sorbet_enum.

data/lib/rails_sorbet_enum/concern.rb

@@ -7,7 +7,6 @@ require "sorbet-runtime"
 
 module RailsSorbetEnum
   # Concern allows ActiveRecord models to use typechecked Sorbet T::Enums
-  # with backing ActiveRecord::Enum fields
   module Concern
     extend ActiveSupport::Concern
 
@@ -18,22 +17,47 @@ module RailsSorbetEnum
 
       include ::ActiveRecord::Enum
 
-      sig { params(name: Symbol, type: T.class_of(T::Enum)).void }
-      def sorbet_enum(name, type)
+      sig do
+        params(
+          name: Symbol,
+          type: T.class_of(T::Enum),
+          presence: T::Boolean
+        ).void
+      end
+      def sorbet_enum(name, type, presence: true)
         sorbet_enum_attributes << [name, type]
 
         # The Rails enum values are the serialized T::Enum ones
-        T.unsafe(self).enum(name, type.values.map(&:serialize).index_with(&:to_s))
+        serialize(name, coder: Serializer.new(type))
+
+        validates name,
+          presence: presence,
+          inclusion: { in: type.values, allow_blank: !presence }
 
-        T.unsafe(self).define_method("#{name}_enum") do
-          val = T.unsafe(self).public_send(name)
-          return unless val
+        T.unsafe(self).define_method("#{name}=") do |arg|
+          raise ArgumentError, "expected #{type.name} but got #{arg.class}" if arg && arg.class != type
 
-          type.deserialize(val)
+          super(arg)
         end
 
-        T.unsafe(self).define_method("#{name}_enum=") do |arg|
-          T.unsafe(self).public_send("#{name}=", arg.serialize)
+        # Defines helpers to check if the field is equal to each enum value.
+        # For the following enum definition:
+        # class Status < T::Enum
+        #   enums do
+        #     Pending = new
+        #     Done
+        #   end
+        # end
+        # status_enum(:status, Status)
+        #
+        # The following helpers are generated:
+        # * status_pending?
+        # * status_done?
+        type.each_value do |enum_value|
+          value_name = enum_value.instance_variable_get(:@const_name).to_s.downcase
+          T.unsafe(self).define_method("#{name}_#{value_name}?") do
+            send(name) == enum_value
+          end
         end
       end
 

data/lib/rails_sorbet_enum/require.rb

@@ -3,3 +3,4 @@
 
 require_relative "version"
 require_relative "concern"
+require_relative "serializer"

data/lib/rails_sorbet_enum/serializer.rb

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RailsSorbetEnum
+  class Serializer
+    extend T::Sig
+
+    sig { params(object_class: T.class_of(T::Enum)).void }
+    def initialize(object_class)
+      @object_class = object_class
+    end
+
+    sig { params(obj: T.untyped).returns(String) }
+    def dump(obj)
+      case obj
+      when T::Enum
+        obj.serialize
+      else
+        raise ActiveRecord::SerializationTypeMismatch,
+          "expected #{@object_class.name} and got #{obj.class}"
+      end
+    end
+
+    sig { params(str: T.nilable(String)).returns(T.nilable(T::Enum)) }
+    def load(str)
+      return if str.nil?
+
+      @object_class.try_deserialize(str)
+    end
+  end
+end

data/lib/rails_sorbet_enum/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module RailsSorbetEnum
-  VERSION = "0.1.0"
+  VERSION = "0.3.0"
 end

data/lib/tapioca/dsl/compilers/rails_sorbet_enum_compiler.rb

@@ -19,7 +19,7 @@ module Tapioca
         class << self
           extend T::Sig
 
-          sig { override.returns(T::Enumerable[Module]) }
+          sig { override.returns(T::Enumerable[T::Module[T.anything]]) }
           def gather_constants
             all_classes
               .select { |c| c < RailsSorbetEnum::Concern }
@@ -31,7 +31,7 @@ module Tapioca
           root.create_path(constant) do |klass|
             klass.create_module(RBI_MODULE_NAME) do |methods_mod|
               T.unsafe(constant).sorbet_enum_attributes.each do |enum_name, enum_type|
-                return_type =
+                type_with_nilability =
                   if T.unsafe(constant).column_for_attribute(enum_name).null
                     "T.nilable(#{enum_type.name})"
                   else
@@ -39,16 +39,20 @@ module Tapioca
                   end
 
                 methods_mod.create_method(
-                  "#{enum_name}_enum",
-                  return_type: return_type
-                )
-                methods_mod.create_method(
-                  "#{enum_name}_enum=",
+                  "#{enum_name}=",
                   parameters: [
-                    create_param("value", type: enum_type.name)
+                    create_param("value", type: type_with_nilability)
                   ],
                   return_type: "void"
                 )
+
+                enum_type.each_value do |enum_value|
+                  value_name = enum_value.instance_variable_get(:@const_name).to_s.downcase
+                  methods_mod.create_method(
+                    "#{enum_name}_#{value_name}?",
+                    return_type: "T::Boolean"
+                  )
+                end
               end
             end
             klass.create_include(RBI_MODULE_NAME)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_sorbet_enum
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Franklin Hu
@@ -81,6 +81,7 @@ files:
 - lib/rails_sorbet_enum.rb
 - lib/rails_sorbet_enum/concern.rb
 - lib/rails_sorbet_enum/require.rb
+- lib/rails_sorbet_enum/serializer.rb
 - lib/rails_sorbet_enum/version.rb
 - lib/tapioca/dsl/compilers/rails_sorbet_enum_compiler.rb
 - sig/rails_sorbet_enum.rbs