enhance_module 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b42420b1bdad023c55ee134a235222b91ef59047beff9400b50c655ae3ce9c5
+  data.tar.gz: 5b525c55d013c21f9858a733723ae73d45587c5cb5a2edcdfabddf00d0114b67
+SHA512:
+  metadata.gz: fe7feec8977b7f9be052797fd8e7b4fb6fac01bbccab4dbf66bda667f523bd9f443f3e2389bb7828a8965eecf642e7f1cd767d7a8ed83da4314f2a50d52de249
+  data.tar.gz: b453a287ead76bf33f44443893b51bcb711f7832ed69879688f7ce0db01354913c540ff8929eda736f141e69b4fea17edb7eb29e10ce863f713506b971e0ca09

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-15
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 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,99 @@
+# EnhanceModule
+
+This gem adds a typed, sorbet-friendly way of extending object instances with modules.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add enhance_module
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install enhance_module
+
+
+## Motivation
+
+Ruby supports extending objects with methods from modules.
+It's one of the most unique and cool features of Ruby.
+
+```rb
+module Foo
+    def foo = "foo!"
+end
+
+obj = Object.new
+obj.extend(Foo)
+obj.foo #=> foo!
+```
+
+Unfortunately [sorbet](https://sorbet.org/) does not support this feature.
+Its type system in unable to fathom what is going on when an object is extended.
+
+```rb
+# typed: true
+
+module Foo
+    extend T::Sig
+
+    sig { void }
+    def foo = "foo!"
+end
+
+obj = Object.new
+obj.extend(Foo)
+obj.foo #! Method `foo` does not exist on `Object`
+```
+
+## Usage
+
+This gem adds a new sorbet-friendly way of extending objects.
+
+```rb
+# typed: true
+
+require 'enhance_module'
+
+module Foo
+    extend T::Sig
+
+    # boilerplate that needs to be added
+    # to your module to make it support
+    # extending objects
+    class << self
+        include EnhanceModule
+        has_attached_class! { { fixed: Foo } }
+    end
+
+    # define your methods
+    sig { void }
+    def foo = "foo!"
+end
+
+obj = Object.new
+# works the same as `obj.extend(Foo)`
+# but sorbet understands it
+extended_obj = Foo.enhance(obj)
+extended_obj.foo # ok!
+
+T.reveal_type(extended_obj) # T.all(Foo, Object)
+```
+
+The new `Foo.enhance` method works like `extend` and
+returns an intersection type that consists of the argument's class
+and the module that is being extended.
+
+## 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/enhance_module.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/enhance_module/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EnhanceModule
+  VERSION = "0.1.0"
+end

data/lib/enhance_module.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+# typed: true
+
+require "sorbet-runtime"
+require_relative "enhance_module/version"
+
+# This module can be included in the singleton class of a module
+# to make it able to extend objects in a typed, sorbet-friendly way.
+#
+#     require "enhance_module"
+#
+#     module MyModule
+#       class << self
+#         include EnhanceModule
+#         has_attached_class! { { fixed: MyModule } }
+#       end
+#
+#       sig { void }
+#       def my_module_method; end
+#     end
+#
+#     class MyClass
+#       extend T::Sig
+#
+#       sig { void }
+#       def my_class_method; end
+#     end
+#
+#     obj = MyClass.new
+#     obj.my_class_method # ok!
+#
+#     # extend the object with `MyModule`
+#     extended_obj = MyModule.enhance(obj)
+#     extended_obj.my_class_method  # ok!
+#     extended_obj.my_module_method # ok!
+#
+module EnhanceModule
+  extend T::Sig
+  extend T::Generic
+  has_attached_class!
+
+  sig do
+    type_parameters(:T)
+      .params(obj: T.type_parameter(:T))
+      .returns(T.all(T.attached_class, T.type_parameter(:T)))
+  end
+  def enhance(obj)
+    T.unsafe(obj).extend(self)
+  end
+
+  module ClassMethods
+    include T::Sig
+    include T::Generic
+  end
+  mixes_in_class_methods(ClassMethods)
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: enhance_module
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mateusz Drewniak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-15 00:00:00.000000000 Z
+dependencies:
+- !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: This gem adds a sorbet-friendly way of extending object instances with
+  modules.
+email:
+- matmg24@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/enhance_module.rb
+- lib/enhance_module/version.rb
+homepage: https://github.com/Verseth/ruby-enhance_module
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Verseth/ruby-enhance_module
+  source_code_uri: https://github.com/Verseth/ruby-enhance_module
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.15
+signing_key:
+specification_version: 4
+summary: This gem adds a sorbet-friendly way of extending object instances with modules.
+test_files: []