factory_bot-sorbet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1898ec9f239b8602216d60173afd23de4c71f844215cd8b76d957bca109f673c
+  data.tar.gz: 68210c2ad005fb35d07ab48db799d2bc2002bc4f46221f74e7ef634f11e8c4dd
+SHA512:
+  metadata.gz: c8186b8d3d1801dabb9ebdd938e115aec1820c17ad03f4d784d58b6664dac6352af5fde674550db9cd9ad43e0b22680dc42816f8c4f7188366eafb82c67a441d
+  data.tar.gz: 61d7685698c68a645bb0d706050d6f12bc9216a864df484eed3598976ed7ab863ea2aef4b2ed7b7ee2ef92d6d69b8255ff156443d60aac95736ab3aee9bf8a33

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+Add changes in new features here. Do not change the gem's version in pull/merge requests.
+
+### Changes
+-
+
+## [0.1.0] - 2025-08-22
+
+[Diff](https://github.com/Verseth/ruby-factory_bot-sorbet/compare/v0.0.0...v0.1.0)
+
+- Initial release

data/LICENSE

@@ -0,0 +1,8 @@
+Copyright 2025 Mateusz Drewniak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,121 @@
+# FactoryBot::Sorbet
+
+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/factory_bot/sorbet`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add factory_bot-sorbet
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install factory_bot-sorbet
+```
+
+## Usage
+
+This gems adds the module `FactoryBot::Sorbet` which contains
+methods for using all your factories in a type-safe way.
+
+### The problem
+
+Given a factory
+
+```rb
+FactoryBot.define do
+  factory :foo, class_name: "Foo" do
+    bar { "BAR!" }
+  end
+end
+```
+
+Using regular FactoryBot you'd use it like so:
+
+```rb
+FactoryBot.create(:foo, baz: 1) #=> #<Foo:0x0000000106021fc8 @bar="BAR!" @baz=1>
+FactoryBot.build(:foo, baz: 2) #=> #<Foo:0x0000000106021fc8 @bar="BAR!" @baz=2>
+FactoryBot.build_stubbed(:foo, baz: 3) #=> #<Foo:0x0000000106021fc8 @bar="BAR!" @baz=3>
+```
+
+This DSL has one problem when used with sorbet. It is impossible to create
+a static signature for `create`, `build`, `build_stubbed` because they
+return a different type each time based on the first argument.
+
+### The solution
+
+This gem defines unique methods for each factory and defines
+static sorbet signatures for them using a Tapioca compiler.
+
+```rb
+FactoryBot::Sorbet.foo(:create, baz: 1) #=> #<Foo:0x0000000106021fc8 @bar="BAR!" @baz=1>
+FactoryBot::Sorbet.foo(:build, baz: 2) #=> #<Foo:0x0000000106021fc8 @bar="BAR!" @baz=2>
+FactoryBot::Sorbet.foo(:build_stubbed, baz: 3) #=> #<Foo:0x0000000106021fc8 @bar="BAR!" @baz=3>
+```
+Tapioca will generate the following RBI file to make Sorbet fully understand the types of your factories.
+
+```rb
+# sorbet/rbi/dsl/factory_bot/sorbet.rbi
+
+# typed: true
+
+# DO NOT EDIT MANUALLY
+# This is an autogenerated file for dynamic methods in `FactoryBot::Sorbet`.
+# Please instead update this file by running `bin/tapioca dsl FactoryBot::Sorbet`.
+
+
+module FactoryBot::Sorbet
+  sig { params(strategy: Symbol, args: T.anything, block: NilClass).returns(Foo) }
+  sig do
+    type_parameters(:R)
+      .params(
+        strategy: Symbol,
+        args: T.anything,
+        block: T.proc.params(arg0: Foo).returns(T.type_parameter(:R))
+      ).returns(T.type_parameter(:R))
+  end
+  def foo(strategy, *args, &block); end
+end
+```
+
+### Test Helpers
+
+If you use Rails/Minitest (or any other test framework) we highly recommend adding a helper methods
+for easier access to your factories.
+
+```rb
+# test/test_helper.rb
+
+require 'factory_bot/sorbet'
+
+class Minitest::Test
+  include FactoryBot::Sorbet::TestHelpers
+end
+```
+
+This will the let you use the shorthand:
+
+```rb
+f.foo(:create)
+```
+
+Instead of:
+
+```rb
+FactoryBot::Sorbet.foo(:create)
+```
+
+## Development
+
+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.
+
+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/Verseth/ruby-factory_bot-sorbet.

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+::Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = ::FileList['test/**/*_test.rb']
+end
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[test]

data/lib/factory_bot/annotations.rbi

@@ -0,0 +1,9 @@
+# typed: true
+# frozen_string_literal: true
+
+module FactoryBot
+  class << self
+    #: (Symbol, *top) ?{ -> void } -> Hash[Symbol, untyped]
+    def attributes_for(name, *args, &block); end
+  end
+end

data/lib/factory_bot/sorbet/override.rb

@@ -0,0 +1,24 @@
+# typed: true
+# frozen_string_literal: true
+
+module FactoryBot
+  module Sorbet
+    # @requires_ancestor: singleton(::FactoryBot::Internal)
+    module Internal
+      def register_factory(factory)
+        factory.names.each do |name|
+          Sorbet.module_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def #{name}(kind, *args, **kwargs, &block)
+              ::FactoryBot.public_send(kind, #{name.inspect}, *args, **kwargs, &block)
+            end
+          RUBY
+        end
+
+        super
+      end
+
+    end
+  end
+
+  Internal.singleton_class.prepend Sorbet::Internal
+end

data/lib/factory_bot/sorbet/version.rb

@@ -0,0 +1,8 @@
+# typed: true
+# frozen_string_literal: true
+
+module FactoryBot
+  module Sorbet
+    VERSION = '0.1.0'
+  end
+end

data/lib/factory_bot/sorbet.rb

@@ -0,0 +1,32 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'factory_bot'
+require 'booleans'
+
+require_relative 'sorbet/version'
+require_relative 'sorbet/override'
+
+module FactoryBot
+  # Main namespace of the `factory_bot-sorbet` gem
+  # that provides support for static typing with sorbet and tapioca to `factory_bot`.
+  module Sorbet
+    extend Sorbet
+
+    # Contains helper methods for tests.
+    # Specifically the `f` method so you can do:
+    #
+    #     f.foo(:create)
+    #
+    # Instead of:
+    #
+    #     FactoryBot::Sorbet.foo(:create)
+    #
+    module TestHelpers
+      #: -> singleton(Sorbet)
+      def f = Sorbet
+    end
+
+    class Error < StandardError; end
+  end
+end

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

@@ -0,0 +1,57 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'factory_bot/sorbet'
+
+module Tapioca
+  module Compilers
+    #: [ConstantType = singleton(::FactoryBot::Sorbet)]
+    class FactoryBot < Tapioca::Dsl::Compiler
+      class << self
+        # @override
+        #: -> T::Enumerable[Module]
+        def gather_constants
+          [::FactoryBot::Sorbet]
+        end
+      end
+
+      # @override
+      #: -> void
+      def decorate
+        root.create_path(constant) do |mod|
+          ::FactoryBot.factories.each do |factory|
+            begin
+              klass = factory.build_class
+            rescue NameError
+              next
+            end
+
+            mod.create_method(factory.name.to_s) do |method|
+              method.add_param('strategy')
+              method.add_rest_param('args')
+              method.add_block_param('block')
+
+              method.add_sig do |sig|
+                sig.add_param('strategy', 'Symbol')
+                sig.add_param('args', 'T.anything')
+                sig.add_param('block', 'NilClass')
+                sig.return_type = klass.to_s
+              end
+
+              method.add_sig do |sig|
+                sig.type_params << 'R'
+                sig.add_param('strategy', 'Symbol')
+                sig.add_param('args', 'T.anything')
+                sig.add_param('block', "T.proc.params(arg0: #{klass}).returns(T.type_parameter(:R))")
+                sig.return_type = 'T.type_parameter(:R)'
+              end
+            end
+
+          end
+        end
+
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: factory_bot-sorbet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: booleans
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: An addon to factory_bot that adds support for static typing with sorbet
+  and tapioca
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/factory_bot/annotations.rbi
+- lib/factory_bot/sorbet.rb
+- lib/factory_bot/sorbet/override.rb
+- lib/factory_bot/sorbet/version.rb
+- lib/tapioca/dsl/compilers/factory_bot.rb
+homepage: https://github.com/Verseth/ruby-factory_bot-sorbet
+licenses: []
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-factory_bot-sorbet
+  source_code_uri: https://github.com/Verseth/ruby-factory_bot-sorbet
+  changelog_uri: https://raw.githubusercontent.com/Verseth/ruby-factory_bot-sorbet/refs/heads/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.7.1
+specification_version: 4
+summary: An addon to factory_bot that adds support for static typing with sorbet and
+  tapioca
+test_files: []