activerecord-ejection_seat 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a394852fa247c21ef30d77eb67ea89b0efed860b14ddabc2e08e82d4a2673f
-  data.tar.gz: 40a97e34b9db820ff71daafd3161d6ee35249fde15d366dd4fc7957cf41fe2c6
+  metadata.gz: f8cb74f8d55bb740891ac604fbb974cbbc78ce7e01bd67eb739a01cd4cdae756
+  data.tar.gz: c14a4d5a2382acda29d63c3a77bbf0e4080eff154e3b6cccfb4b91aa13b120e1
 SHA512:
-  metadata.gz: 03e11c26d5afa8e43ff424d03a5eb5a47772fc13fa938068cf390c06c7b65869ffb1c3c84273a2f3d90ce1af06edd79ab8e5b48891a0016fe0b3527de11efc90
-  data.tar.gz: da16079ff6cdcec598cf0205eb0ad448b08704658f403be35975573045b1855414540a83a3876da793790bac1c83b16ef3362a1f99bfca3a8596b13dced2f93a
+  metadata.gz: e4f736acf5cf15bab547d35f2cf4c21963a6a188029df0c23f59dbbbc900ef7474f0de67013ccac7afa853d832f5fb839e0503019b37a90a2508cab7ce0def55
+  data.tar.gz: 787f28eaa9428fbe03e6d48be126d591af896da66e4a360c250e9d9b70ae9d3a03505f66134b53e6ba8be927cbced95b52fd12d2e8a288e582a9189618d307e6

data/.rubocop.yml

@@ -1,10 +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
@@ -16,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.0

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.0

data/Gemfile

@@ -6,15 +6,23 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "rake", "~> 13.0"
-  gem "rubocop", "~> 1.21"
+  gem "rake"
+  gem "rubocop"
+  gem "rubocop-minitest"
   gem "rubocop-rake"
-  gem "rubocop-rspec"
+  gem "rubocop-sorbet"
+  gem "sorbet"
+  gem "spoom", require: false
+  gem "tapioca", require: false
+
+  gem "ruby-lsp"
 end
 
 group :development, :test do
-  gem "rspec", "~> 3.0"
+  gem "minitest"
   gem "sorbet-runtime"
   gem "sorbet-struct-comparable"
   gem "sqlite3"
+
+  gem "debug"
 end

data/Gemfile.lock

@@ -1,88 +1,139 @@
 PATH
   remote: .
   specs:
-    activerecord-ejection_seat (0.1.0)
-      activerecord (>= 5.2)
+    activerecord-ejection_seat (0.3.0)
+      activerecord (>= 6.0)
+      sorbet-runtime
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
+    activemodel (7.0.4.1)
+      activesupport (= 7.0.4.1)
+    activerecord (7.0.4.1)
+      activemodel (= 7.0.4.1)
+      activesupport (= 7.0.4.1)
+    activesupport (7.0.4.1)
       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.1)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
     diff-lcs (1.5.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    minitest (5.16.2)
+    io-console (0.6.0)
+    irb (1.6.2)
+      reline (>= 0.3.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    minitest (5.17.0)
+    netrc (0.11.0)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
+    prettier_print (1.2.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    rbi (0.0.16)
+      ast
+      parser (>= 2.6.4.0)
+      sorbet-runtime (>= 0.5.9204)
+      unparser
+    regexp_parser (2.6.1)
+    reline (0.3.2)
+      io-console (~> 0.5)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.31.2)
+    rubocop (1.43.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      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.18.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.19.1)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
+    rubocop-minitest (0.26.1)
+      rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-sorbet (0.6.11)
+      rubocop (>= 0.90.0)
+    ruby-lsp (0.3.8)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 5.0.0, < 6)
     ruby-progressbar (1.11.0)
-    sorbet-runtime (0.5.10187)
+    sorbet (0.5.10626)
+      sorbet-static (= 0.5.10626)
+    sorbet-runtime (0.5.10626)
+    sorbet-static (0.5.10626-universal-darwin-21)
+    sorbet-static (0.5.10626-universal-darwin-22)
+    sorbet-static (0.5.10626-x86_64-linux)
+    sorbet-static-and-runtime (0.5.10626)
+      sorbet (= 0.5.10626)
+      sorbet-runtime (= 0.5.10626)
     sorbet-struct-comparable (1.3.0)
       sorbet-runtime (>= 0.5)
-    sqlite3 (1.4.4)
-    tzinfo (2.0.4)
+    spoom (1.1.15)
+      sorbet (>= 0.5.10187)
+      sorbet-runtime (>= 0.5.9204)
+      thor (>= 0.19.2)
+    sqlite3 (1.6.0-arm64-darwin)
+    sqlite3 (1.6.0-x86_64-linux)
+    syntax_tree (5.2.0)
+      prettier_print (>= 1.2.0)
+    tapioca (0.10.5)
+      bundler (>= 1.17.3)
+      netrc (>= 0.11.0)
+      parallel (>= 1.21.0)
+      rbi (~> 0.0.0, >= 0.0.16)
+      sorbet-static-and-runtime (>= 0.5.10187)
+      spoom (~> 1.1.0, >= 1.1.11)
+      thor (>= 1.2.0)
+      yard-sorbet
+    thor (1.2.1)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
+    unicode-display_width (2.4.2)
+    unparser (0.6.7)
+      diff-lcs (~> 1.3)
+      parser (>= 3.2.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.8.0)
+      sorbet-runtime (>= 0.5)
+      yard (>= 0.9)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
   activerecord-ejection_seat!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-  rubocop (~> 1.21)
+  debug
+  minitest
+  rake
+  rubocop
+  rubocop-minitest
   rubocop-rake
-  rubocop-rspec
+  rubocop-sorbet
+  ruby-lsp
+  sorbet
   sorbet-runtime
   sorbet-struct-comparable
+  spoom
   sqlite3
+  tapioca
 
 BUNDLED WITH
-   2.3.16
+   2.4.4

data/README.md

@@ -1,9 +1,13 @@
 # ActiveRecord::EjectionSeat
 
+[![IMAGE ALT TEXT](https://img.youtube.com/vi/HfCY-bkVJKM/0.jpg)](http://www.youtube.com/watch?v=HfCY-bkVJKM "Introduction to activerecord-ejection_seat")
+
 ## ActiveRecord <=> T::Struct
 
 Sometimes, you want to convert from an `ActiveRecord` model to something more akin to a simple data class. Enter [Sorbet's `T::Struct`](https://sorbet.org/docs/tstruct). This gem helps to eject out of bulky `ActiveRecord` models (or buckle into them) and work with simple `T::Struct`'s in the rest of your app.
 
+For more information about the "why" behind this gem, check out [this post](https://maxveld.ink/ejecting-out-of-an-orm/).
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -16,13 +20,21 @@ 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 and a `role` enum column. Another way to express this would be a `User` type that is a simple, typed struct.
 
 ```ruby
 module Types
+  class UserRoles < T::Enum
+    enums do
+      Admin = new("admin")
+      Member = new("member")
+    end
+  end
+
   class User < T::Struct
     const :name, String
     const :age, Integer
+    const :role, UserRoles
   end
 end
 ```
@@ -31,6 +43,8 @@ In our model, we can specify an ejection to this type.
 
 ```ruby
 class User
+  enum :role, { admin: "admin", member: "member" }
+
   ejects_to Types::User
 end
 ```
@@ -38,17 +52,17 @@ 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
+User.new(name: "Max", age: 28, role: "admin").eject
+# => Types::User(name: "Max", age: 28, role: Types::UserRoles::Admin)
+User.new(name: "Max", age: 28, role: "admin").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)
 User.buckle(user_struct)
-# => User(name: "Max", age: 28)
+# => User(name: "Max", age: 28, role: "admin")
 User.from_struct(user_struct) # alias
 ```
 

data/Rakefile

@@ -1,12 +1,24 @@
 # 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
 
-task default: %i[rubocop spec]
+desc "Run tapioca compilers"
+task :tapioca do
+  sh "bin/tapioca gem"
+end
+
+desc "Run Sorbet typechecker"
+task :sorbet do
+  sh "bundle exec srb tc"
+end
+
+task default: %i[rubocop:autocorrect_all sorbet test]

data/activerecord-ejection_seat.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
                       It also allows you to buckle in from a simple struct to a new ActiveRecord model instance."
   spec.homepage = "https://github.com/AudaciousAardvark/activerecord-ejection_seat"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["rubygems_mfa_required"] = "true"
@@ -35,5 +35,6 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activerecord", ">= 5.2"
+  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,7 +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.
@@ -15,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(attrs.slice(*attribute_props))
+          klass.new(
+            PropsBuilder.new(
+              model: self,
+              target_struct: klass
+            ).build
+          )
         end
 
         alias_method :to_struct, :eject
@@ -28,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

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+# Creates initialization payload for targeted T::Struct
+class PropsBuilder
+  extend T::Sig
+
+  sig do
+    params(
+      model: ActiveRecord::Base,
+      target_struct: T.class_of(T::Struct)
+    ).void
+  end
+  def initialize(model:, target_struct:)
+    @model = model
+    @target_struct = target_struct
+  end
+
+  sig { returns(T::Hash[Symbol, T.untyped]) }
+  def build
+    target_struct.props.keys.each_with_object({}) do |prop_name, returned_props|
+      attribute = model.respond_to?(prop_name) ? build_attribute(prop_name) : nil
+
+      returned_props[prop_name] = attribute
+    end
+  end
+
+  private
+
+  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,7 +1,8 @@
+# typed: strict
 # frozen_string_literal: true
 
 module ActiveRecord
   module EjectionSeat
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/activerecord-ejection_seat.rb

@@ -1,11 +1,16 @@
 # rubocop:disable Naming/FileName
+# rubocop:enable Naming/FileName
+# typed: strict
 # frozen_string_literal: true
 
-require_relative "activerecord-ejection_seat/version"
-
+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_relative "activerecord-ejection_seat/attributes_builder"
+
 ActiveSupport.on_load(:active_record) do
   require "activerecord-ejection_seat/ejectable"
 end
-# rubocop:enable Naming/FileName

data/sorbet/config

@@ -0,0 +1,3 @@
+--dir
+.
+--ignore=vendor/

data/sorbet/rbi/annotations/activerecord.rbi

@@ -0,0 +1,18 @@
+# typed: strict
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
+
+class ActiveRecord::Schema
+  sig { params(info: T::Hash[T.untyped, T.untyped], blk: T.proc.bind(ActiveRecord::Schema).void).void }
+  def self.define(info = nil, &blk); end
+end
+
+class ActiveRecord::Migration
+  # @shim: Methods on migration are delegated to `SchemaStatements` using `method_missing`
+  include ActiveRecord::ConnectionAdapters::SchemaStatements
+
+  # @shim: Methods on migration are delegated to `DatabaseaStatements` using `method_missing`
+  include ActiveRecord::ConnectionAdapters::DatabaseStatements
+end

data/sorbet/rbi/annotations/activesupport.rbi

@@ -0,0 +1,52 @@
+# typed: strict
+
+# DO NOT EDIT MANUALLY
+# This file was pulled from a central RBI files repository.
+# Please run `bin/tapioca annotations` to update it.
+
+module ActiveSupport::Testing::Declarative
+  sig { params(name: String, block: T.proc.bind(T.untyped).void).void }
+  def test(name, &block); end
+end
+
+class ActiveSupport::EnvironmentInquirer
+  sig { returns(T::Boolean) }
+  def development?; end
+
+  sig { returns(T::Boolean) }
+  def production?; end
+
+  sig { returns(T::Boolean) }
+  def test?; end
+
+  # @method_missing: delegated to String through ActiveSupport::StringInquirer
+  sig { returns(T::Boolean) }
+  def staging?; end
+end
+
+module ActiveSupport::Testing::SetupAndTeardown::ClassMethods
+  sig { params(args: T.untyped, block: T.nilable(T.proc.bind(T.untyped).void)).void }
+  def setup(*args, &block); end
+
+  sig { params(args: T.untyped, block: T.nilable(T.proc.bind(T.untyped).void)).void }
+  def teardown(*args, &block); end
+end
+
+class ActiveSupport::TestCase
+  sig { params(args: T.untyped, block: T.nilable(T.proc.bind(T.attached_class).void)).void }
+  def self.setup(*args, &block); end
+
+  sig { params(args: T.untyped, block: T.nilable(T.proc.bind(T.attached_class).void)).void }
+  def self.teardown(*args, &block); end
+
+  sig { params(name: String, block: T.proc.bind(T.attached_class).void).void }
+  def self.test(name, &block); end
+end
+
+class Object
+  sig { returns(T::Boolean) }
+  def blank?; end
+
+  sig { returns(T::Boolean) }
+  def present?; end
+end