activerecord-ejection_seat 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a394852fa247c21ef30d77eb67ea89b0efed860b14ddabc2e08e82d4a2673f
-  data.tar.gz: 40a97e34b9db820ff71daafd3161d6ee35249fde15d366dd4fc7957cf41fe2c6
+  metadata.gz: ec011864f722a24abd09c60e4dbfd8c53e1a41a2922ef6827a527f3992d5b941
+  data.tar.gz: ea35286dccfb37c99279b6ffe6403fd20ee72c8a488103bdaa4386e7f6c8b205
 SHA512:
-  metadata.gz: 03e11c26d5afa8e43ff424d03a5eb5a47772fc13fa938068cf390c06c7b65869ffb1c3c84273a2f3d90ce1af06edd79ab8e5b48891a0016fe0b3527de11efc90
-  data.tar.gz: da16079ff6cdcec598cf0205eb0ad448b08704658f403be35975573045b1855414540a83a3876da793790bac1c83b16ef3362a1f99bfca3a8596b13dced2f93a
+  metadata.gz: a2dfb9277f769f3e9296a5388459e02acfa98ae0697009e3e8587dbaed774d45ec059652a7ffdf61c5a2a36c62b309e32fa10b834f20a8e84d145fc3c6f78dda
+  data.tar.gz: b39ccda5b3aa68a6d63f9be7959f70daf7a8e262f67d0b4afbf9bd250c1f1cb42f25d28592b5223ccd46857548a2ce7936d061bc9f0b62030bbe870b03e7d5c3

data/.rubocop.yml

@@ -1,6 +1,7 @@
 require:
   - rubocop-rake
   - rubocop-rspec
+  - rubocop-sorbet
 
 AllCops:
   NewCops: enable

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-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 "rspec"
   gem "sorbet-runtime"
   gem "sorbet-struct-comparable"
   gem "sqlite3"
+
+  gem "debug"
 end

data/Gemfile.lock

@@ -3,86 +3,150 @@ PATH
   specs:
     activerecord-ejection_seat (0.1.0)
       activerecord (>= 5.2)
+      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)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       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)
+      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.16.3)
+    netrc (0.11.0)
     parallel (1.22.1)
-    parser (3.1.2.0)
+    parser (3.1.3.0)
       ast (~> 2.4.1)
+    prettier_print (1.1.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)
+    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.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.31.2)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.41.0)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.1.2.1)
       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.23.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.19.1)
+    rubocop-ast (1.24.0)
       parser (>= 3.1.1.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    rubocop-rspec (2.12.1)
-      rubocop (~> 1.31)
+    rubocop-rspec (2.16.0)
+      rubocop (~> 1.33)
+    rubocop-sorbet (0.6.11)
+      rubocop (>= 0.90.0)
+    ruby-lsp (0.3.7)
+      language_server-protocol (~> 3.17.0)
+      sorbet-runtime
+      syntax_tree (>= 4.0.2, < 5.0.0)
     ruby-progressbar (1.11.0)
-    sorbet-runtime (0.5.10187)
+    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-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.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)
+      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.3.0)
+    unparser (0.6.5)
+      diff-lcs (~> 1.3)
+      parser (>= 3.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+    yard-sorbet (0.7.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
+  rake
+  rspec
+  rubocop
   rubocop-rake
   rubocop-rspec
+  rubocop-sorbet
+  ruby-lsp
+  sorbet
   sorbet-runtime
   sorbet-struct-comparable
+  spoom
   sqlite3
+  tapioca
 
 BUNDLED WITH
-   2.3.16
+   2.3.26

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:

data/Rakefile

@@ -7,6 +7,18 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "rubocop/rake_task"
 
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new do |t|
+  t.options = ["-A"]
+end
 
-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 sorbet spec]

data/lib/activerecord-ejection_seat/ejectable.rb

@@ -1,3 +1,4 @@
+# typed: false
 # frozen_string_literal: true
 
 require "active_record"
@@ -18,7 +19,7 @@ module ActiveRecord
           attrs = attributes.deep_symbolize_keys
           attribute_props = klass.props.keys & attrs.keys
 
-          klass.new(attrs.slice(*attribute_props))
+          klass.new(PropsBuilder.new(attrs.slice(*attribute_props), klass.props).build)
         end
 
         alias_method :to_struct, :eject

data/lib/activerecord-ejection_seat/props_builder.rb

@@ -0,0 +1,44 @@
+# 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
+    ).void
+  end
+  def initialize(attributes_from_model, target_props)
+    @attributes_from_model = attributes_from_model
+    @target_props = target_props
+  end
+
+  sig { returns(Attributes) }
+  def build
+    built_props = {}
+
+    attributes_from_model.each do |k, v|
+      prop_type = target_props.dig(k, :type)
+
+      built_props[k] = if prop_type < T::Enum
+                         prop_type.deserialize(v)
+                       else
+                         v
+                       end
+    end
+
+    built_props
+  end
+
+  private
+
+  sig { returns(Attributes) }
+  attr_reader :attributes_from_model, :target_props
+end

data/lib/activerecord-ejection_seat/version.rb

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

data/lib/activerecord-ejection_seat.rb

@@ -1,11 +1,13 @@
 # rubocop:disable Naming/FileName
+# rubocop:enable Naming/FileName
+# typed: false
 # frozen_string_literal: true
 
 require_relative "activerecord-ejection_seat/version"
+require_relative "activerecord-ejection_seat/props_builder"
 
 require "active_support/lazy_load_hooks"
 
 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