activerecord-ejection_seat 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec011864f722a24abd09c60e4dbfd8c53e1a41a2922ef6827a527f3992d5b941
-  data.tar.gz: ea35286dccfb37c99279b6ffe6403fd20ee72c8a488103bdaa4386e7f6c8b205
+  metadata.gz: d37d5dedef56e4a743bb6b979dfcd53d8e8adaa5dfe7aad1edf3431aea18c987
+  data.tar.gz: a574c315f0b1578a84115e7702bf3613dd01eab053b1a4b6da72186e9aab585e
 SHA512:
-  metadata.gz: a2dfb9277f769f3e9296a5388459e02acfa98ae0697009e3e8587dbaed774d45ec059652a7ffdf61c5a2a36c62b309e32fa10b834f20a8e84d145fc3c6f78dda
-  data.tar.gz: b39ccda5b3aa68a6d63f9be7959f70daf7a8e262f67d0b4afbf9bd250c1f1cb42f25d28592b5223ccd46857548a2ce7936d061bc9f0b62030bbe870b03e7d5c3
+  metadata.gz: bd053a38351b5e7b8310f87a57338e2b08403a7a17f1976171699b672d005bb106b24e87daaea22f4fa090cde35f4d3205571575f075ea9ea16d8a2870d40434
+  data.tar.gz: ad848b3caaf2faed99b6d6d28f4530dc441c6cce7f7001af4d8131b0de94e35443bb7df54d59d3dd0505cfd94e04cf51ffb1c4c100a624087f5628da3d384625

data/.rubocop.yml

@@ -1,11 +1,20 @@
+inherit_mode:
+  merge:
+    - Exclude
+
 require:
+  - rubocop-minitest
   - rubocop-rake
-  - rubocop-rspec
   - rubocop-sorbet
 
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
+  Exclude:
+    - sorbet/**/*.rbi
+
+Style/AccessorGrouping:
+  Enabled: false
 
 Style/StringLiterals:
   Enabled: true
@@ -17,9 +26,3 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Max: 3

data/.ruby-version

@@ -0,0 +1 @@
+3.2.1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.1

data/CODE_OF_CONDUCT.md

@@ -39,7 +39,7 @@ This Code of Conduct applies within all community spaces, and also applies when
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at max@audaciousaardvark.com. All complaints will be reviewed and investigated promptly and fairly.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at maxveldink@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 

data/Gemfile

@@ -8,8 +8,8 @@ gemspec
 group :development do
   gem "rake"
   gem "rubocop"
+  gem "rubocop-minitest"
   gem "rubocop-rake"
-  gem "rubocop-rspec"
   gem "rubocop-sorbet"
   gem "sorbet"
   gem "spoom", require: false
@@ -19,7 +19,7 @@ group :development do
 end
 
 group :development, :test do
-  gem "rspec"
+  gem "minitest"
   gem "sorbet-runtime"
   gem "sorbet-struct-comparable"
   gem "sqlite3"

data/Gemfile.lock

@@ -1,26 +1,26 @@
 PATH
   remote: .
   specs:
-    activerecord-ejection_seat (0.1.0)
-      activerecord (>= 5.2)
+    activerecord-ejection_seat (0.3.1)
+      activerecord (>= 6.0)
       sorbet-runtime
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
+    activemodel (7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activerecord (7.0.4.2)
+      activemodel (= 7.0.4.2)
+      activesupport (= 7.0.4.2)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    debug (1.7.0)
+    concurrent-ruby (1.2.0)
+    debug (1.7.1)
       irb (>= 1.5.0)
       reline (>= 0.3.1)
     diff-lcs (1.5.0)
@@ -30,13 +30,13 @@ GEM
     irb (1.6.2)
       reline (>= 0.3.0)
     json (2.6.3)
-    language_server-protocol (3.17.0.2)
-    minitest (5.16.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.17.0)
     netrc (0.11.0)
     parallel (1.22.1)
-    parser (3.1.3.0)
+    parser (3.2.1.0)
       ast (~> 2.4.1)
-    prettier_print (1.1.0)
+    prettier_print (1.2.0)
     rainbow (3.1.1)
     rake (13.0.6)
     rbi (0.0.16)
@@ -44,66 +44,53 @@ GEM
       parser (>= 2.6.4.0)
       sorbet-runtime (>= 0.5.9204)
       unparser
-    regexp_parser (2.6.1)
+    regexp_parser (2.7.0)
     reline (0.3.2)
       io-console (~> 0.5)
     rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.0)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.41.0)
+    rubocop (1.45.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.23.0, < 2.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.24.0)
-      parser (>= 3.1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.27.0)
+      rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.16.0)
-      rubocop (~> 1.33)
-    rubocop-sorbet (0.6.11)
+    rubocop-sorbet (0.7.0)
       rubocop (>= 0.90.0)
-    ruby-lsp (0.3.7)
+    ruby-lsp (0.4.0)
       language_server-protocol (~> 3.17.0)
       sorbet-runtime
-      syntax_tree (>= 4.0.2, < 5.0.0)
+      syntax_tree (>= 6, < 7)
     ruby-progressbar (1.11.0)
-    sorbet (0.5.10597)
-      sorbet-static (= 0.5.10597)
-    sorbet-runtime (0.5.10597)
-    sorbet-static (0.5.10597-universal-darwin-21)
-    sorbet-static (0.5.10597-universal-darwin-22)
-    sorbet-static (0.5.10597-x86_64-linux)
-    sorbet-static-and-runtime (0.5.10597)
-      sorbet (= 0.5.10597)
-      sorbet-runtime (= 0.5.10597)
+    sorbet (0.5.10676)
+      sorbet-static (= 0.5.10676)
+    sorbet-runtime (0.5.10676)
+    sorbet-static (0.5.10676-universal-darwin-21)
+    sorbet-static (0.5.10676-universal-darwin-22)
+    sorbet-static (0.5.10676-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10676)
+      sorbet (= 0.5.10676)
+      sorbet-runtime (= 0.5.10676)
     sorbet-struct-comparable (1.3.0)
       sorbet-runtime (>= 0.5)
     spoom (1.1.15)
       sorbet (>= 0.5.10187)
       sorbet-runtime (>= 0.5.9204)
       thor (>= 0.19.2)
-    sqlite3 (1.5.4-arm64-darwin)
-    sqlite3 (1.5.4-x86_64-linux)
-    syntax_tree (4.3.0)
-      prettier_print (>= 1.0.2)
-    tapioca (0.10.4)
+    sqlite3 (1.6.0-arm64-darwin)
+    sqlite3 (1.6.0-x86_64-linux)
+    syntax_tree (6.0.0)
+      prettier_print (>= 1.2.0)
+    tapioca (0.10.5)
       bundler (>= 1.17.3)
       netrc (>= 0.11.0)
       parallel (>= 1.21.0)
@@ -113,16 +100,16 @@ GEM
       thor (>= 1.2.0)
       yard-sorbet
     thor (1.2.1)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-    unparser (0.6.5)
+    unicode-display_width (2.4.2)
+    unparser (0.6.7)
       diff-lcs (~> 1.3)
-      parser (>= 3.1.0)
+      parser (>= 3.2.0)
     webrick (1.7.0)
     yard (0.9.28)
       webrick (~> 1.7.0)
-    yard-sorbet (0.7.0)
+    yard-sorbet (0.8.0)
       sorbet-runtime (>= 0.5)
       yard (>= 0.9)
 
@@ -134,11 +121,11 @@ PLATFORMS
 DEPENDENCIES
   activerecord-ejection_seat!
   debug
+  minitest
   rake
-  rspec
   rubocop
+  rubocop-minitest
   rubocop-rake
-  rubocop-rspec
   rubocop-sorbet
   ruby-lsp
   sorbet
@@ -149,4 +136,4 @@ DEPENDENCIES
   tapioca
 
 BUNDLED WITH
-   2.3.26
+   2.4.7

data/README.md

@@ -20,13 +20,26 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-Let's say you have an `ActiveRecord` model for a `User` with a string `name` column and an integer `age` column. Another way to express this would be a `User` type that is a simple, typed struct.
+Let's say you have an `ActiveRecord` model for a `User` with a string `name` column, an integer `age` column, a `role` enum column and a belongs to association with a `Location` model. Another way to express this would be a `User` type that is a simple, typed struct with other supporting structs.
 
 ```ruby
 module Types
+  class UserRoles < T::Enum
+    enums do
+      Admin = new("admin")
+      Member = new("member")
+    end
+  end
+
+  class Location < T::Struct
+    const :name, String
+  end
+
   class User < T::Struct
     const :name, String
     const :age, Integer
+    const :role, UserRoles
+    const :location, Location
   end
 end
 ```
@@ -35,6 +48,9 @@ In our model, we can specify an ejection to this type.
 
 ```ruby
 class User
+  belongs_to :location
+  enum :role, { admin: "admin", member: "member" }
+
   ejects_to Types::User
 end
 ```
@@ -42,17 +58,18 @@ end
 Now, we have two new methods available on `User`. First, we can eject from a `User` instance to a `Types::User`.
 
 ```ruby
-User.new(name: "Max", age: 28).eject
-# => Types::User(name: "Max", age: 28)
-User.new(name: "Max", age: 28).to_struct # alias
+location = Location.new(name: "Florida")
+User.new(name: "Max", age: 28, role: "admin", location: location).eject
+# => Types::User(name: "Max", age: 28, role: Types::UserRoles::Admin, location: Types::Location.new(name: "Florida))
+User.new(name: "Max", age: 28, role: "admin", location: location).to_struct # alias
 ```
 
 Second, we can buckle into the `User` model with a `Types::User`.
 
 ```ruby
-user_struct = Types::User.new(name: "Max", age: 28)
+user_struct = Types::User.new(name: "Max", age: 28, role: Types::UserRoles::Admin, location: Types::Location.new(name: "Florida"))
 User.buckle(user_struct)
-# => User(name: "Max", age: 28)
+# => User(name: "Max", age: 28, role: "admin", location: Location(name: "Florida"))
 User.from_struct(user_struct) # alias
 ```
 
@@ -64,7 +81,7 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/audaciousaardvark/activerecord-ejection_seat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/audaciousaardvark/activerecord-ejection_seat/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/maxveldink/activerecord-ejection_seat. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/maxveldink/activerecord-ejection_seat/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -72,4 +89,8 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in this project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/audaciousaardvark/activerecord-ejection_seat/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in this project's codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/maxveldink/activerecord-ejection_seat/blob/master/CODE_OF_CONDUCT.md).
+
+## Sponsorships
+
+I love creating in the open. If you find this or any other [maxveld.ink](https://maxveld.ink) content useful, please consider sponsoring me on [GitHub](https://github.com/sponsors/maxveldink).

data/Rakefile

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require "minitest/test_task"
 
-RSpec::Core::RakeTask.new(:spec)
+Minitest::TestTask.create do |t|
+  t.test_globs = ["test/**/*_test.rb"]
+end
 
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new do |t|
-  t.options = ["-A"]
-end
+RuboCop::RakeTask.new
 
 desc "Run tapioca compilers"
 task :tapioca do
@@ -21,4 +21,4 @@ task :sorbet do
   sh "bundle exec srb tc"
 end
 
-task default: %i[rubocop sorbet spec]
+task default: %i[rubocop:autocorrect_all sorbet test]

data/activerecord-ejection_seat.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/activerecord-ejection_seat/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "activerecord-ejection_seat"
+  spec.version = ActiveRecord::EjectionSeat::VERSION
+  spec.authors = ["Max VelDink"]
+  spec.email = ["maxveldink@gmail.com"]
+
+  spec.summary = "Eject from an ActiveRecord model to a Sorbet T::Struct, or buckle back in."
+  spec.description = "When working with ActiveRecord models, sometimes you want to eject to a simpler, safer object. \
+                      Enter Sorbet's T::Struct. This gem makes it much easier to target a \
+                      Sorbet T::Struct and eject from an ActiveRecord model into the struct. \
+                      It also allows you to buckle in from a simple struct to a new ActiveRecord model instance."
+  spec.homepage = "https://github.com/maxveldink/activerecord-ejection_seat"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/maxveldink/activerecord-ejection_seat/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", ">= 6.0"
+  spec.add_runtime_dependency "sorbet-runtime"
+end

data/lib/activerecord-ejection_seat/attributes_builder.rb

@@ -0,0 +1,42 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Creates initialization payload for targeted ActiveRecord model
+class AttributesBuilder
+  extend T::Sig
+
+  sig { params(struct: T::Struct, target_model: T.class_of(ActiveRecord::Base)).void }
+  def initialize(struct:, target_model:)
+    @struct = struct
+    @target_model = target_model
+  end
+
+  sig { returns(T::Hash[String, T.untyped]) }
+  def build
+    attrs = struct.serialize
+    props = attrs.keys & target_model.column_names.map { |name| name.delete_suffix("_id") }
+
+    attrs.slice(*props).to_h { |key, value| build_attribute(name: key, value: value) }
+  end
+
+  private
+
+  sig { params(name: String, value: T.untyped).returns(T::Array[T.untyped]) }
+  def build_attribute(name:, value:)
+    if value.is_a?(Hash)
+      association_class = target_model.reflect_on_all_associations.find do |association|
+        association.name.to_s == name
+      end&.klass
+
+      value = association_class&.new(value)
+    end
+
+    [name, value]
+  end
+
+  sig { returns(T::Struct) }
+  attr_reader :struct
+
+  sig { returns(T.class_of(ActiveRecord::Base)) }
+  attr_reader :target_model
+end

data/lib/activerecord-ejection_seat/ejectable.rb

@@ -1,8 +1,6 @@
 # typed: false
 # frozen_string_literal: true
 
-require "active_record"
-
 module ActiveRecord
   module EjectionSeat
     # Defines `#eject` `.buckle` methods for going between ActiveRecord models and Sorbet T::Structs.
@@ -16,10 +14,12 @@ module ActiveRecord
 
       def define_eject_method(klass)
         define_method(:eject) do
-          attrs = attributes.deep_symbolize_keys
-          attribute_props = klass.props.keys & attrs.keys
-
-          klass.new(PropsBuilder.new(attrs.slice(*attribute_props), klass.props).build)
+          klass.new(
+            PropsBuilder.new(
+              model: self,
+              target_struct: klass
+            ).build
+          )
         end
 
         alias_method :to_struct, :eject
@@ -29,10 +29,7 @@ module ActiveRecord
         define_singleton_method(:buckle) do |struct|
           raise ArgumentError if struct.class != klass
 
-          attrs = struct.serialize
-          props = attrs.keys & column_names
-
-          new(attrs.slice(*props))
+          new(AttributesBuilder.new(struct: struct, target_model: self).build)
         end
 
         singleton_class.send :alias_method, :from_struct, :buckle

data/lib/activerecord-ejection_seat/props_builder.rb

@@ -1,44 +1,56 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "sorbet-runtime"
-
 # Creates initialization payload for targeted T::Struct
 class PropsBuilder
   extend T::Sig
 
-  Attributes = T.type_alias { T::Hash[Symbol, T.untyped] }
-
   sig do
     params(
-      attributes_from_model: Attributes,
-      target_props: Attributes
+      model: ActiveRecord::Base,
+      target_struct: T.class_of(T::Struct)
     ).void
   end
-  def initialize(attributes_from_model, target_props)
-    @attributes_from_model = attributes_from_model
-    @target_props = target_props
+  def initialize(model:, target_struct:)
+    @model = model
+    @target_struct = target_struct
   end
 
-  sig { returns(Attributes) }
+  sig { returns(T::Hash[Symbol, T.untyped]) }
   def build
-    built_props = {}
-
-    attributes_from_model.each do |k, v|
-      prop_type = target_props.dig(k, :type)
+    target_struct.props.keys.each_with_object({}) do |prop_name, returned_props|
+      attribute = model.respond_to?(prop_name) ? build_attribute(prop_name) : nil
 
-      built_props[k] = if prop_type < T::Enum
-                         prop_type.deserialize(v)
-                       else
-                         v
-                       end
+      returned_props[prop_name] = attribute
     end
-
-    built_props
   end
 
   private
 
-  sig { returns(Attributes) }
-  attr_reader :attributes_from_model, :target_props
+  sig { params(prop_name: Symbol).returns(T.untyped) }
+  def build_attribute(prop_name)
+    attribute = model.send(prop_name)
+    prop_type = target_struct.props.dig(prop_name, :type)
+
+    cast_attribute(attribute, prop_type)
+  end
+
+  sig { params(attribute: T.untyped, prop_type: Class).returns(T.untyped) }
+  def cast_attribute(attribute, prop_type)
+    if prop_type < T::Enum
+      prop_type.deserialize(attribute)
+    elsif prop_type < T::Struct
+      prop_type.new(PropsBuilder.new(model: attribute, target_struct: prop_type).build)
+    else
+      attribute
+    end
+  rescue KeyError
+    nil
+  end
+
+  sig { returns(ActiveRecord::Base) }
+  attr_reader :model
+
+  sig { returns(T.class_of(T::Struct)) }
+  attr_reader :target_struct
 end

data/lib/activerecord-ejection_seat/version.rb

@@ -1,8 +1,8 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 module ActiveRecord
   module EjectionSeat
-    VERSION = "0.2.0"
+    VERSION = "0.3.1"
   end
 end

data/lib/activerecord-ejection_seat.rb

@@ -1,12 +1,15 @@
 # rubocop:disable Naming/FileName
 # rubocop:enable Naming/FileName
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
+require "active_record"
+require "sorbet-runtime"
+require "active_support/lazy_load_hooks"
+
 require_relative "activerecord-ejection_seat/version"
 require_relative "activerecord-ejection_seat/props_builder"
-
-require "active_support/lazy_load_hooks"
+require_relative "activerecord-ejection_seat/attributes_builder"
 
 ActiveSupport.on_load(:active_record) do
   require "activerecord-ejection_seat/ejectable"