mangrove 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5d153e07f630102b67bf06ae910d39fd063ec6d29237ad555f33b5068837a54
+  data.tar.gz: 002d2fbd0168c3b0fcac8effea4455918a6a8845d124d8303e480accb2f5d634
+SHA512:
+  metadata.gz: 26c16d1c8e83204252284f47381e6e9d9a517ba8a4b0b84ccbf65f645b0cc42f7fb3331e90a216b2490549bb409e0dc08e7942b15897bb9e9f1020f75a4ec130
+  data.tar.gz: 2f52b60822834d12e1c669b34088223f57bcc575b5bf2a9adf9bc25286a91e8e2e456d71415e1ee0e947455cebc1beacd8f079e296148cf13fbfa09b7aa20f25

data/.rubocop.yml

@@ -0,0 +1,42 @@
+---
+
+AllCops:
+  TargetRubyVersion: 3.2
+
+Layout/FirstArrayElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Naming/VariableNumber:
+  EnforcedStyle: snake_case
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kazzix
+
+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,54 @@
+# Mangrove
+Mangrove provides utility types to use with Sorbet
+
+## Features
+Most features are not implemented.
+
+- [x] Option Type (Partially Implemented)
+  - [x] Auto propagation like Rust's `?` (formerly `try!`)
+- [x] Result Type (Partially Implemented)
+  - [x] Auto propagation like Rust's `?` (formerly `try!`)
+- [ ] Builder type (Not implemented)
+  - [ ] Auto Implementation
+
+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/mangrove`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Commands
+```
+bundle exec tapioca init
+bundle exec tapioca gems
+bundle exec tapioca dsl
+bundle exec tapioca check-shims
+bundle exec tapioca init
+bundle exec rspec -f d
+bundle exec rubocop -DESP
+bundle exec srb typecheck
+bundle exec ordinare --check
+bundle exec ruboclean
+```
+
+## 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/[USERNAME]/mangrove.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :check do
+  system("bundle exec ordinare --check") &&
+    system("bundle exec rubocop -DESP") &&
+    system("bundle exec tapioca check-shims") &&
+    system("bundle exec srb typecheck") &&
+    system("bundle exec rspec -f d")
+end
+
+task default: :check

data/lib/mangrove/control_flow/control_signal.rb

@@ -0,0 +1,16 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Mangrove
+  module ControlFlow
+    module ControlSignal
+      extend T::Sig
+      extend T::Helpers
+
+      interface!
+
+      sig { abstract.returns(T.untyped) }
+      def inner_value; end
+    end
+  end
+end

data/lib/mangrove/control_flow/rewriter.rb

@@ -0,0 +1,152 @@
+# typed: true
+# frozen_string_literal: true
+
+require "parser"
+require "parser/current"
+require "unparser"
+require "method_source"
+require "sorbet-runtime"
+
+module Mangrove
+  module ControlFlow
+    class << self
+      extend T::Sig
+
+      sig { params(method_to_be_rewritten: T.any(Method, UnboundMethod)).returns(String) }
+      def impl!(method_to_be_rewritten)
+        filename, line_number = method_to_be_rewritten.source_location
+
+        source = method_to_be_rewritten.source
+        ast = Parser::CurrentRuby.parse(source)
+        source_buffer = Parser::Source::Buffer.new("#{filename}:#{line_number}", source:)
+        rewriter = Rewriter.new
+        rewriter.rewrite(source_buffer, ast)
+      end
+    end
+
+    class Rewriter < Parser::TreeRewriter
+      CONTROL_SIGNAL = Mangrove::ControlFlow::ControlSignal
+
+      def on_def(node)
+        indent = node.location.expression.begin.column
+        code = Unparser.unparse(with_rescue(node))
+        indented_code = code.lines.map.with_index { |line, index| index.zero? ? line : (" " * indent) + line }
+        replace(node.location.expression, indented_code)
+      end
+
+      def on_defs(node)
+        indent = node.location.expression.begin.column
+        code = Unparser.unparse(with_rescue(node))
+        indented_code = code.lines.map.with_index { |line, index| index.zero? ? line : (" " * indent) + line }
+        replace(node.location.expression, indented_code)
+      end
+
+      def on_block(node)
+        indent = node.location.expression.begin.column
+        code = Unparser.unparse(with_rescue(node))
+        indented_code = code.lines.map.with_index { |line, index| index.zero? ? line : (" " * indent) + line }
+        replace(node.location.expression, indented_code)
+      end
+
+      private
+
+      def rescue_node(body)
+        ::Parser::AST::Node.new(:rescue, [
+          body,
+          nil
+        ])
+      end
+
+      def add_rescue_node(parent)
+        children = parent.children.dup
+        # nilの場合はblockをこちらで包む必要がある
+        # nilではない場合はすでに包まれているのでこちらで包む必要はない
+        method_body_index = children.length - 1
+        method_body = children[method_body_index]
+
+        children[method_body_index] = rescue_node(method_body)
+        parent.updated(nil, children)
+      end
+
+      def use_rescue_node(parent)
+        children = parent.children.dup
+
+        rescue_index = children.find_index { _1.respond_to?(:type) && _1.type == :rescue }
+
+        rescue_node_on_ast = children[rescue_index]
+        updated_rescue_node_on_ast = insert_rescue_body_node(rescue_node_on_ast)
+        children[rescue_index] = updated_rescue_node_on_ast
+
+        parent.updated(nil, children)
+      end
+
+      def insert_rescue_body_node(rescue_node)
+        rescue_node_children = rescue_node.children.dup
+        rescue_body_node_index = rescue_node_children.find_index { _1.respond_to?(:type) && _1.type == :resbody }
+
+        # when rescue is newly inserted
+        if rescue_body_node_index.nil?
+          rescue_body_node_index = rescue_node_children.length - 1
+        end
+
+        rescue_node_children.insert(rescue_body_node_index, rescue_body_node)
+        rescue_node.updated(nil, rescue_node_children)
+      end
+
+      def use_ensure_node(ensure_node)
+        # ensureのchildrenの最後から2番目（最後のrescue）に追加する
+
+        ensure_node_children = ensure_node.children.dup
+
+        rescue_index = ensure_node_children.find_index { _1.respond_to?(:type) && _1.type == :rescue }
+
+        if rescue_index.nil?
+          ensure_node = add_rescue_node(ensure_node)
+        end
+
+        use_rescue_node(ensure_node)
+      end
+
+      def with_rescue(parent)
+        children = parent.children.dup
+        ensure_index = children.find_index { _1.respond_to?(:type) && _1.type == :ensure }
+
+        if ensure_index.nil?
+          rescue_index = children.find_index { _1.respond_to?(:type) && _1.type == :rescue }
+
+          if rescue_index.nil?
+            parent = add_rescue_node(parent)
+          end
+
+          use_rescue_node(parent)
+        else
+          updated_ensure_node = use_ensure_node(children[ensure_index])
+          children[ensure_index] = updated_ensure_node
+          parent.updated(nil, children)
+        end
+      end
+
+      def rescue_body_node
+        control_flow = StandardError
+
+        ::Parser::AST::Node.new(:resbody, [
+          ::Parser::AST::Node.new(:array, [
+            ::Parser::AST::Node.new(:const, [nil, control_flow.to_s])
+          ]),
+          ::Parser::AST::Node.new(:lvasgn, [:exception]),
+          ::Parser::AST::Node.new(:send, [
+            ::Parser::AST::Node.new(:const, [
+              ::Parser::AST::Node.new(:const, [
+                nil,
+                :Result
+              ]),
+              :Err
+            ]),
+            :new,
+            ::Parser::AST::Node.new(:lvar, [:exception])
+          ])
+        ])
+      end
+    end
+  end
+end

data/lib/mangrove/control_flow.rb

@@ -0,0 +1,84 @@
+# typed: true
+# frozen_string_literal: true
+
+require_relative "control_flow/control_signal"
+require_relative "control_flow/rewriter"
+
+module Mangrove
+  # Mangrove::ControlFlow
+  module ControlFlow
+    # Mangrove::ControlFlow::Handler
+    module Handler
+      extend T::Sig
+      extend T::Helpers
+
+      interface!
+
+      # Mangrove::ControlFlow::ClassMethods
+      module ClassMethods
+        extend T::Sig
+        extend T::Helpers
+
+        abstract!
+
+        def singleton_method_added(method_name)
+          T.bind(self, T.all(ClassMethods, Module))
+
+          super
+
+          unless @__inside_mangrove_control_flow
+            original_method = method(method_name)
+
+            wrap_original_method_to_handle_flow_control_exception(original_method)
+          end
+        end
+
+        def method_added(method_name)
+          T.bind(self, T.all(ClassMethods, Module))
+
+          super
+
+          unless @__inside_mangrove_control_flow
+            original_method = instance_method(method_name)
+
+            wrap_original_method_to_handle_flow_control_exception(original_method)
+          end
+        end
+
+        sig { params(signal: ControlFlow::ControlSignal).void }
+        def handle_flow_control_exception(signal)
+          signal.inner_value
+        end
+
+        sig { params(original_method: T.any(Method, UnboundMethod)).void }
+        def wrap_original_method_to_handle_flow_control_exception(original_method)
+          T.bind(self, T.class_of(Kernel))
+
+          @__mangrove_flow_controlled_method_names ||= T.let(
+            {},
+            T.nilable(T::Hash[Symbol, T::Set[Symbol]])
+          )
+
+          @__mangrove_flow_controlled_method_names[name.to_s.intern] ||= T.let(Set.new, T::Set[Symbol])
+
+          return if T.cast(@__mangrove_flow_controlled_method_names[name.to_s.intern], T::Set[Symbol]).include?(original_method.name)
+
+          begin
+            @__inside_mangrove_control_flow = T.let(true, T.nilable(T::Boolean))
+
+            class_eval(Mangrove::ControlFlow.impl!(original_method))
+          ensure
+            @__inside_mangrove_control_flow = false
+          end
+
+          T.cast(@__mangrove_flow_controlled_method_names[name.to_s.intern], T::Set[Symbol]) << original_method.name
+        end
+
+        sig { returns(T.nilable(T::Hash[Symbol, T::Set[Symbol]])) }
+        attr_reader :__mangrove_flow_controlled_method_names
+      end
+
+      mixes_in_class_methods(ClassMethods)
+    end
+  end
+end

data/lib/mangrove/interfaces.rb

@@ -0,0 +1,8 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Mangrove
+  module Interfaces
+    require_relative "interfaces/control_signal"
+  end
+end

data/lib/mangrove/mangrove.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+# ==============================================================================
+# sorbet - tapioca - compilers - enumerize
+# ==============================================================================
+require "tapioca/dsl"
+require "sorbet-runtime"
+require "mangrove/control_flow"
+
+::Method.prepend(T::CompatibilityPatches::MethodExtensions)
+
+module Tapioca
+  module Compilers
+    class Enumerize < Tapioca::Dsl::Compiler
+      extend T::Sig
+
+      ConstantType = type_member { { fixed: T.class_of(::Mangrove::ControlFlow::Handler) } }
+
+      sig { override.returns(T::Enumerable[Module]) }
+      def self.gather_constants
+        all_classes.find_all { |c| c < ::Mangrove::ControlFlow::Handler }
+      end
+
+      sig { override.void }
+      def decorate
+        root.create_path(constant) do |klass|
+          # constant.instance_variable_get(:@__mangrove_flow_controlled_method_names).each do |method_name|
+          #   klass.create_method(method_name, parameters: [create_rest_param("args", type: "T.untyped")], return_type: "T.untyped")
+          # end
+        end
+      end
+    end
+  end
+end

data/lib/mangrove/option/control_signal.rb

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "mangrove/control_flow/control_signal"
+
+module Mangrove
+  module Option
+    class ControlSignal < StandardError
+      extend T::Sig
+
+      include Mangrove::ControlFlow::ControlSignal
+
+      sig { params(inner_value: T.untyped).void }
+      def initialize(inner_value)
+        @inner_value = inner_value
+        super
+      end
+
+      sig { override.params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when ControlSignal
+          other.inner_value == inner_value
+        else
+          false
+        end
+      end
+
+      sig { override.returns(T.untyped) }
+      attr_reader :inner_value
+    end
+  end
+end

data/lib/mangrove/option.rb

@@ -0,0 +1,134 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "option/control_signal"
+require_relative "result"
+
+module Mangrove
+  # Option is a type that represents either some value (`Some`) or no value (`None`).
+  module Option
+    extend T::Sig
+    extend T::Generic
+    extend T::Helpers
+
+    include Kernel
+
+    sealed!
+    interface!
+
+    InnerType = type_member
+
+    # Option::Some
+    class Some
+      extend T::Sig
+      extend T::Generic
+      extend T::Helpers
+
+      include Option
+
+      InnerType = type_member
+
+      sig { params(inner: InnerType).void }
+      def initialize(inner)
+        @inner = T.let(inner, InnerType)
+      end
+
+      sig { override.params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when Option::Some
+          other.instance_variable_get(:@inner) == @inner
+        when Option::None
+          false
+        else
+          # T.absurd(other)
+          false
+        end
+      end
+
+      sig { override.returns(InnerType) }
+      def unwrap!
+        @inner
+      end
+
+      sig { override.params(_message: String).returns(InnerType) }
+      def expect!(_message)
+        @inner
+      end
+
+      sig { override.params(block: T.proc.params(inner: InnerType).returns(Option[InnerType])).returns(Option[InnerType]) }
+      def map_some(&block)
+        block.call(@inner)
+      end
+
+      sig { override.params(_block: T.proc.returns(Option[InnerType])).returns(Option::Some[InnerType]) }
+      def map_none(&_block)
+        self
+      end
+
+      private
+
+      sig { returns(InnerType) }
+      attr_reader :inner
+    end
+
+    # Option::None
+    class None
+      extend T::Sig
+      extend T::Generic
+      extend T::Helpers
+
+      include Option
+
+      InnerType = type_member
+
+      sig { override.params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when Option::Some
+          false
+        when Option::None
+          true
+        else
+          false
+          # T.absurd(other)
+        end
+      end
+
+      sig { override.returns(InnerType) }
+      def unwrap!
+        raise Option::ControlSignal, Result::Err.new("called `Option#unwrap!` on an `None` value: #{self}")
+      end
+
+      sig { override.params(message: String).returns(InnerType) }
+      def expect!(message)
+        raise Option::ControlSignal, Result::Err.new(message)
+      end
+
+      sig { override.params(_block: T.proc.params(inner: InnerType).returns(Option[InnerType])).returns(Option::None[InnerType]) }
+      def map_some(&_block)
+        self
+      end
+
+      sig { override.params(block: T.proc.returns(Option[InnerType])).returns(Option[InnerType]) }
+      def map_none(&block)
+        block.call
+      end
+    end
+
+    sig { abstract.params(other: BasicObject).returns(T::Boolean) }
+    def ==(other); end
+
+    sig { abstract.returns(InnerType) }
+    def unwrap!; end
+
+    sig { abstract.params(message: String).returns(InnerType) }
+    def expect!(message); end
+
+    sig { abstract.params(block: T.proc.params(inner: InnerType).returns(Option[InnerType])).returns(Option[InnerType]) }
+    def map_some(&block); end
+
+    sig { abstract.params(block: T.proc.returns(Option[InnerType])).returns(Option[InnerType]) }
+    def map_none(&block); end
+  end
+end

data/lib/mangrove/result/control_signal.rb

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "mangrove/control_flow/control_signal"
+
+module Mangrove
+  module Result
+    class ControlSignal < StandardError
+      extend T::Sig
+
+      include Mangrove::ControlFlow::ControlSignal
+
+      sig { params(inner_value: T.untyped).void }
+      def initialize(inner_value)
+        @inner_value = inner_value
+        super
+      end
+
+      sig { override.params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when ControlSignal
+          other.inner_value == inner_value
+        else
+          false
+        end
+      end
+
+      sig { override.returns(T.untyped) }
+      attr_reader :inner_value
+    end
+  end
+end