claret 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86c0a750f84fc7c9b43896cc1b8129671d96e0de433fe99a8ee2b5097ade93e6
+  data.tar.gz: 6a08e47f63d6e7bdbba114a9192be6551f13ac308aef419061731c3bab220068
+SHA512:
+  metadata.gz: 2e9f2009d9b790f0ffc76f33490bec46274a26a024d9a56497c1c5e7db9732718b2dd279b92e7f6ad89418582cbf5a41f3f7bc7d2383bc73029e0636aad25fd9
+  data.tar.gz: 2f4ad49a1046554c5072d6e6264bf2daeb4d3630f5a8be7573405a81d3574388410826541f73e2579e149606b96817c3be6280ddf33b2bb1173af0a8c3dfcff6

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-27
+
+- Initial release of experiment, only supports some of the final syntax.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at stevegeek@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Stephen Ierodiaconou
+
+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,218 @@
+# claret
+
+Ruby + RBS = claret
+
+```ruby
+# examples/hello_world.rb
+
+class HelloWorld
+  def initialize(String @name = "world")
+  end
+
+  def say_it_to(String name = @name, (Integer | Float) age = (1 + 2))
+    puts "Hello #{name}! You are #{age} years old."
+  end
+end
+
+# 42 should be an Integer or Float
+HelloWorld.new.say_it_to("bob", "42")
+```
+
+```
+$ ./exe/claret start examples/hello_world.rb
+--- steep output ---
+# Type checking files:
+
+............................................................................F........
+
+lib/examples/hello_world.rb:13:32: [error] Cannot pass a value of type `::String` as an argument of type `(::Integer | ::Float)`
+│   ::String <: (::Integer | ::Float)
+│     ::String <: ::Integer
+│       ::Object <: ::Integer
+│         ::BasicObject <: ::Integer
+│
+│ Diagnostic ID: Ruby::ArgumentTypeMismatch
+│
+└ HelloWorld.new.say_it_to("bob", "42")
+                                  ~~~~
+
+Detected 1 problem from 1 file
+--- End steep output ---
+🚨 Something went wrong with steep!
+```
+
+
+### `claret` is:
+
+-   an attempt at creating a typed Ruby syntax that incorporates RBS like types directly into the Ruby source
+-   A CLI too that transpiles the typed Ruby to pure Ruby and an RBS file, thus allowing the existing Ruby runtime and type checker steep to do the heavy lifting
+
+### `claret` aims to be
+
+-   optional: you can type only some parts of your application (similarly to RBS) and mix typed and not typed code
+-   debugging friendly: runtime error source locations will map relatively well to their typed source counterpart
+-   runtime friendly: claret is built with Ruby-next meaning transpilation can happen at runtime too using the ruby-next require hook
+-   escape-able: you can use the CLI to erase the type information and emit the pure Ruby code should you wish to stop using it
+
+### `claret` future directions:
+
+-   build an AST based parser allowing for more accurate transpilation
+-   Ability to also emit Crystal code allowing for the possibility to create single code base Ruby/Crystal projects (assuming you only use language features which are comparable to both languages)
+
+
+
+## Warning: Experimental Tool
+
+Please note that claret is currently an experimental tool, and as such, it is subject to change or may never reach a stable release. The syntax for inline type signatures could also evolve, potentially causing compatibility issues with certain Ruby codebases. Proceed with caution and be prepared for possible adjustments in the future.
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add claret
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install claret
+
+## Usage
+
+```
+claret help
+Commands:
+  claret check [SCRIPT]  # Check the given file for type errors, or all files if none given
+  claret execute SCRIPT  # Run the typed Ruby SCRIPT
+  claret help [COMMAND]  # Describe available commands or one specific command
+  claret remove          # Remove all type annotations from the project
+  claret ruby SCRIPT     # [Alias of 'execute']
+  claret start SCRIPT    # Run type checking and then execute the SCRIPT
+  claret steep [SCRIPT]  # [Alias of 'check']
+
+Options:
+  [--debug], [--no-debug]  
+                           # Default: false
+  [--quiet], [--no-quiet]  
+                           # Default: false
+  [--time], [--no-time]    
+                           # Default: false
+```
+
+## Syntax
+
+
+### Methods
+
+In claret's typed Ruby syntax, types are specified directly before the argument name (optionally enclosed in parentheses). 
+For return types, an arrow (->) is used after the method definition, followed by the type.
+
+Here are a couple of examples to demonstrate this syntax:
+
+```ruby
+def my_method(Integer a, String b = "hi") -> String
+  # method body
+end
+
+def another_method(untyped kwarg1:, (Alice | Bob[String]) kwarg2: nil)
+  # method body, note return type is implicitly untyped
+end
+```
+
+In the first example, `my_method` takes two arguments: an `Integer` named `a`, and a `String` named `b` with a 
+default value of "hi". The method returns a `String`.
+
+The second example, `another_method`, has two keyword arguments: an untyped argument named `kwarg1`, and 
+an argument named `kwarg2` that can be either an instance of class `Alice` or a generic instance of class 
+`Bob` with its type parameter set to `String`. The default value for `kwarg2` is set to nil. 
+No return type means an implicit `untyped` return type.
+
+**Note**:
+
+when specifying method argument types in claret's typed Ruby syntax, you must enclose the type information in
+parentheses if it consists of more than a single simple type. This is especially relevant when creating 
+union types or other complex type constructs.
+
+## Instance Variable Setting Short Hand Syntax
+
+In `claret`'s typed Ruby syntax, you can simplify the process of setting instance variables from method arguments by
+using a shorthand syntax inspired by Crystal lang. By prefixing the argument name with an `@` symbol in the 
+method definition, the corresponding instance variable will be automatically set to the argument value upon 
+method call.
+
+Here's a Box example demonstrating this shorthand syntax:
+
+```ruby
+class Box
+  def initialize(String @item) -> void
+  end
+  attr_reader :item: String
+end
+
+puts Box.new("Hello").item # “Hello”
+```
+
+In this example, we've modified the `initialize` method definition to use the shorthand syntax for setting 
+the `@item` instance variable. By writing `String @item`, we're telling claret the type of `@item`, and to 
+automatically set `@item` to the value passed as an argument when calling the `initialize` method. This 
+eliminates the need for explicitly assigning `@item = item` within the method body.
+
+**Note**:
+
+This syntax will add one or more lines to the start of your `initialize` method and as such will
+change line numbers between the output Ruby and your original typed Ruby source. Thus, your debugging 
+experience will be worse as error source line numbers will not map back to your original typed Ruby source file.
+
+
+## TODO: 
+
+- ivars typing
+- Generics
+
+In claret's typed Ruby syntax, generic types are included after types in a similar manner to RBS. The type parameters are enclosed within square brackets `[ ]` and separated by commas.&#x20;
+
+Here's an example demonstrating the use of generic types:
+
+```ruby
+def process_data(Array[Integer] numbers) -> Hash[String, Integer]
+  # method body
+end
+```
+
+In this example, `process_data` takes an argument named `numbers`, which is an `Array` of `Integer` elements. The method returns a `Hash` with keys of type `String` and values of type `Integer`.
+
+
+Class Definitions with Generics
+
+To define a class with generic types in claret's typed Ruby syntax, include the type parameters after the class name, enclosed within square brackets `[ ]`. Here's an example demonstrating this:
+
+```ruby
+class Box[ItemType]
+  @item: ItemType
+  def initialize(ItemType item) -> void
+    @item = item
+  end
+end
+
+my_box = Box[String].new("Hello")
+```
+
+In this example, we define a `Box` class with a generic type parameter `ItemType`. The instance variable and `initialize` method uses the generic type to ensure that the box can only store and return items of a specific type. When creating an instance of the `Box` class, we specify the desired type within square brackets, as seen with `Box[String].new("Hello")`.
+
+
+## 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]/claret. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/claret/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Claret project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/claret/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# 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 "standard/rake"
+
+task default: %i[test standard]

data/claret.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/claret/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "claret"
+  spec.version = Claret::VERSION
+  spec.authors = ["Stephen Ierodiaconou"]
+  spec.email = ["stevegeek@gmail.com"]
+
+  spec.summary = "A Ruby dialect that includes types in the language. Transpiles to Ruby and RBS."
+  spec.description = "A Ruby dialect that includes types in the language. Transpiles to Ruby and RBS by leveraging the ruby-next and irbs gems. Type checks with steep."
+  spec.homepage = "https://github.com/stevegeek/claret"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/stevegeek/claret"
+  spec.metadata["changelog_uri"] = "https://github.com/stevegeek/claret/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "thor", "~> 1.3"
+  spec.add_dependency "ruby-next", "~> 1.0"
+  spec.add_dependency "steep", "~> 1.6"
+  spec.add_dependency "irbs", "> 0.1", "< 1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/examples/hello_world.rb

@@ -0,0 +1,18 @@
+# examples/hello_world.rb
+
+class HelloWorld
+  def initialize(String @name = "world")
+  end
+
+  def say_it_to(String name = @name, (Integer | Float) age = (1 + 2))
+    puts "Hello #{name}! You are #{age} years old."
+  end
+
+  def test
+    puts "test"
+  end
+end
+
+HelloWorld.new.say_it_to
+
+HelloWorld.new.say_it_to("bob", "42")

data/exe/claret

@@ -0,0 +1,121 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "claret"
+require "thor"
+require "open3"
+
+class ClaretCLI < Thor
+  include Thor::Actions
+
+  option :debug, type: :boolean, default: false
+  option :quiet, type: :boolean, default: false
+  option :verbose, type: :boolean, default: false
+  option :time, type: :boolean, default: false # TODO: add timing to all commands
+  def initialize(*args)
+    super
+  end
+
+  desc "execute SCRIPT", "Run the typed Ruby SCRIPT"
+  def execute(relative_path)
+    # Run command - performs type to @sig comment conversion
+    require "ruby-next/language"
+
+    path = File.expand_path(File.join(Dir.pwd, relative_path))
+    RubyNext::Language.include_patterns << path
+
+    require "ruby-next/language/runtime"
+
+    require path
+  end
+
+  desc "ruby SCRIPT", "[Alias of 'execute']"
+  def ruby(relative_path)
+    invoke :execute, [relative_path]
+  end
+
+  desc "start SCRIPT", "Run type checking and then execute the SCRIPT"
+  def start(relative_path)
+    # Run steep and then run the application
+    invoke :check, [relative_path], options
+    say "\n>Check passed, run now...\n\n" if options[:verbose]
+    # TODO: we have the compiled code in .claret/lib, so we can just run that
+    invoke :execute, [relative_path], options
+  end
+
+  desc "check [SCRIPT]", "Check the given file for type errors, or all files if none given"
+  def check(relative_path = nil)
+    # Check command - include watch mode
+    # Run ruby next and get output files written to disk
+    # run irbs to extract the RBS (or call Irbs::Core (which loads from disk) directly?)
+    # then run steep on extracted RBS
+
+    config = options.transform_keys(&:to_sym)
+    empty_directory ".claret/lib", config
+    empty_directory ".claret/sig", config
+
+    create_file ".claret/Steepfile", config do
+      <<~STEEPFILE
+        D = Steep::Diagnostic
+        target :app do
+          signature "sig"
+          check "lib"
+        end
+      STEEPFILE
+    end
+
+    create_file ".claret/.rbnextrc", config do
+      # Get absolute path to lib/claret/rewriters which is relative to this files path but one level up
+      path = File.expand_path("../lib/claret/rewriters", __dir__)
+      imports = Dir.glob("#{path}/*.rb").map { File.expand_path(_1) }.map { "  --import-rewriter=#{_1}" }.join("\n")
+      <<~RUBY_NEXT
+        nextify: |
+          --min-version=3.2
+          --single-version
+        #{imports}
+          --output=lib
+      RUBY_NEXT
+    end
+
+    inside ".claret", config do
+      input = File.expand_path("../#{relative_path}")
+      output = File.join("lib/", relative_path)
+      run_command("ruby-next", "bundle", "exec", "ruby-next", "nextify", input, "-o", output, "-V", "--no-refine")
+      run_command("irbs", "bundle", "exec", "irbs", output, "-o", "sig/#{File.basename(relative_path, ".rb")}.rbs")
+      run_command("steep", "bundle", "exec", "steep", "check")
+    end
+  end
+
+  desc "steep [SCRIPT]", "[Alias of 'check']"
+  def steep(relative_path = nil)
+    invoke :check, relative_path
+  end
+
+  desc "remove", "Remove all type annotations from the project"
+  def remove
+    # TODO: Remove command - remove all type annotations
+  end
+
+  private
+
+  def run_command(type, *args)
+    options[:debug] && say("Debug enabled for command #{type}.")
+    stdout, status = Open3.capture2({"DEBUG" => "1"}, *args)
+    if status != 0
+      say_output(type, stdout)
+      say_error "🚨 Something went wrong with #{type}!"
+      exit 1
+    else
+      say_output(type, stdout) if options[:debug]
+      say "🤘 all good with #{type}!" if options[:verbose]
+    end
+  end
+
+  def say_output(type, output)
+    say "--- #{type} output ---"
+    say output
+    say "--- End #{type} output ---"
+  end
+end
+
+ClaretCLI.start(ARGV)

data/lib/claret/parsing/parens.rb

@@ -0,0 +1,76 @@
+module Claret
+  module Parsing
+    class Parens
+      def initialize(scanner)
+        @scanner = scanner
+      end
+
+      attr_reader :scanner
+
+      def parse
+        reset_parse_result
+        reset_buffer
+
+        continue_parsing = true
+        until scanner.eos? || continue_parsing == :stop
+          continue_parsing = handle_next_character
+        end
+
+        # Add anything remaining in current to result (ie after last closing parens)
+        append_buffer_to_result_if_not_empty unless continue_parsing == :stop
+        @result
+      end
+
+      def reset
+        reset_parse_result
+        reset_buffer
+        scanner.reset
+      end
+
+      private
+
+      def handle_next_character
+        case scanner.peek(1)
+        when "("
+          consume_and_append_buffer
+          parse_next
+        when ")"
+          consume_and_append_buffer
+          :stop
+        when ","
+          consume_and_append_buffer
+          parse_next
+        else
+          # append any other characters to current buffer
+          @current_buffer << scanner.getch
+        end
+      end
+
+      def consume_and_append_buffer
+        scanner.getch # consume the current character
+        append_buffer_to_result_if_not_empty
+      end
+
+      def parse_next
+        # recursive call for next argument when opening parens encountered. At every comma we also add to stack,
+        # which lets us know when we're at the end of an arg.
+        @result << Parens.new(scanner).parse
+      end
+
+      def append_buffer_to_result_if_not_empty
+        stripped = @current_buffer.strip
+        separator = stripped.empty?
+        @result << stripped unless separator
+        reset_buffer
+      end
+
+      def reset_parse_result
+        @result = []
+      end
+
+      def reset_buffer
+        @current_buffer = ""
+      end
+    end
+  end
+end

data/lib/claret/rewriters/1_method_def_rewriter.rb

@@ -0,0 +1,85 @@
+require "strscan"
+
+require_relative "../utils/logging"
+require_relative "../parsing/parens"
+
+module Claret
+  module Rewriters
+    class MethodDefRewriter < RubyNext::Language::Rewriters::Text
+      include ::Claret::Utils::Logging
+
+      NAME = "claret-positional-arg-type"
+      SYNTAX_PROBE = "def foo(String a, (Integer | String) b, customType c, ivarType @ivar)"
+      MIN_SUPPORTED_VERSION = Gem::Version.new(RubyNext::NEXT_VERSION)
+
+      def safe_rewrite(source)
+        modified_source = source.dup
+
+        source.scan(/(def\s+[\w_]+)(.*)$/).each do |method_def_match|
+          debug "> Method def match: #{method_def_match.inspect}"
+          matched_def = method_def_match.join
+          scanner = StringScanner.new matched_def
+          stack = Claret::Parsing::Parens.new(scanner).parse
+
+          # TODO: we still need to handle return values
+          if stack.size < 2
+            add_sig_comment(modified_source, method_def_match, [])
+            next
+          end
+
+          debug "> Parsed arguments:"
+          debug stack.inspect
+
+          types = stack.last.map do |arg_def|
+            debug "> Arg def: #{arg_def}"
+
+            to_replace, type, arg = if arg_def.is_a?(String) && arg_def.match?(/[\w_]+\s+[\w_@=]+\s*/)
+              optional = arg_def.include?("=")
+              arg_def = arg_def.split("=").first
+              debug "> Arg def simple: #{arg_def}"
+
+              type, arg = arg_def.squeeze(" ").strip.split(" ")
+              type_for_sig = optional ? "?(#{type})" : type
+              [arg_def, type_for_sig, arg]
+            elsif arg_def.is_a?(Array)
+              # TODO: handle nested parens in type
+              type = arg_def.first.first
+              arg = arg_def[1]
+              optional = arg.include?("=")
+              type_for_sig = optional ? "?(#{type})" : type
+              [/\(\s*#{Regexp.escape(type)}\s*\)\s*#{Regexp.escape(arg)}/, type_for_sig, arg]
+            else
+              raise "Unexpected arg def: #{arg_def}"
+            end
+
+            debug "> Replace: #{to_replace} -- (Type: #{type}, Arg: #{arg})"
+
+            modified_source.gsub!(to_replace, arg)
+            type
+          end
+
+          # Mark file dirty
+          context.track! self
+
+          # TODO: handle return type
+          add_sig_comment(modified_source, method_def_match, types)
+        end
+
+        modified_source
+      end
+
+      private
+
+      def add_sig_comment(source, method_def_match, types)
+        method = method_def_match.first
+        sig_comment = "# @sig (#{types.join(", ")}) -> void"
+        debug "> Add sig comment to '#{method}': #{sig_comment}"
+        # Ensure to capture whole of line and add comment at end
+        source.gsub!(/#{method}(.*)$/, "#{method}\\1 #{sig_comment}")
+      end
+    end
+  end
+end
+
+# Add the rewriter to the list of rewriters
+RubyNext::Language.rewriters << Claret::Rewriters::MethodDefRewriter

data/lib/claret/rewriters/2_method_arg_ivar_rewriter.rb

@@ -0,0 +1,73 @@
+require "strscan"
+
+require_relative "../utils/logging"
+require_relative "../parsing/parens"
+
+module Claret
+  module Rewriters
+    class MethodArgIvarRewriter < RubyNext::Language::Rewriters::Text
+      include ::Claret::Utils::Logging
+
+      NAME = "claret-ivar-arg"
+      # Must be run after the MethodDefRewriter
+      SYNTAX_PROBE = "def foo(@a, @b, @c = :foo)"
+      MIN_SUPPORTED_VERSION = Gem::Version.new(RubyNext::NEXT_VERSION)
+
+      def safe_rewrite(source)
+        modified_source = source.dup
+
+        source.scan(/(def\s+[\w_]+\s*)([^#]*)/).each do |method_def_match|
+          debug "> Method def match: #{method_def_match.inspect}"
+
+          method_def_match = method_def_match.join
+          scanner = StringScanner.new method_def_match
+          stack = Claret::Parsing::Parens.new(scanner).parse
+
+          next if stack.size < 2
+
+          debug "> Parsing arguments:"
+          debug stack.inspect
+
+          ivars_lines = stack.last.map do |arg_def|
+            debug "> Arg def: #{arg_def}"
+            arg_str = if arg_def.is_a?(String)
+              arg_def = arg_def.strip
+              if arg_def[0] == "@"
+                debug "> ivar def: #{arg_def}"
+                arg_def[1..-1]
+              end
+            elsif arg_def.is_a?(Array) && arg_def.first
+              arg_def = arg_def.first.strip
+              if arg_def[0] == "@"
+                debug "> ivar def: #{arg_def}"
+                arg_def.first[1..-1]
+              end
+            end
+            next unless arg_str
+            arg_name = arg_str.match(/[\w_]+/).to_s
+
+            debug "> Set: @#{arg_name}"
+
+            modified_source.gsub!(arg_def, arg_def[1..-1])
+            method_def_match.gsub!(arg_def, arg_def[1..-1])
+            "@#{arg_name} = #{arg_name}"
+          end
+
+          ivars_lines.compact!
+
+          # Mark file dirty
+          context.track! self
+
+          debug "> Add setters: #{ivars_lines.join("\n")}"
+          # Ensure to capture whole of line inc comments and then add ivar lines at end
+          modified_source.gsub!(/#{Regexp.escape(method_def_match)}(.*)$/, "#{method_def_match}\\1#{ivars_lines.map { "\n#{_1}" }.join}")
+        end
+
+        modified_source
+      end
+    end
+  end
+end
+
+# Add the rewriter to the list of rewriters
+RubyNext::Language.rewriters << Claret::Rewriters::MethodArgIvarRewriter

data/lib/claret/utils/logging.rb

@@ -0,0 +1,19 @@
+require "logger"
+
+module Claret
+  module Utils
+    module Logging
+      def say(msg)
+        logger.info("#{self.class.name} > #{msg}")
+      end
+
+      def debug(msg)
+        logger.debug("#{self.class.name} > #{msg}")
+      end
+
+      def logger
+        @logger ||= ::Logger.new($stdout, level: ENV.fetch("DEBUG", "").empty? ? Logger::INFO : Logger::DEBUG)
+      end
+    end
+  end
+end

data/lib/claret/version.rb

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

data/lib/claret.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative "claret/version"
+
+require "ruby-next/language"
+require "ruby-next/language/rewriters/text"
+
+require_relative "claret/utils/logging"
+require_relative "claret/parsing/parens"
+require_relative "claret/rewriters/1_method_def_rewriter"
+require_relative "claret/rewriters/2_method_arg_ivar_rewriter"
+
+module Claret
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/claret.rbs

@@ -0,0 +1,4 @@
+module Claret
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: claret
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Ierodiaconou
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: ruby-next
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: steep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: irbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A Ruby dialect that includes types in the language. Transpiles to Ruby
+  and RBS by leveraging the ruby-next and irbs gems. Type checks with steep.
+email:
+- stevegeek@gmail.com
+executables:
+- claret
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- claret.gemspec
+- examples/hello_world.rb
+- exe/claret
+- lib/claret.rb
+- lib/claret/parsing/parens.rb
+- lib/claret/rewriters/1_method_def_rewriter.rb
+- lib/claret/rewriters/2_method_arg_ivar_rewriter.rb
+- lib/claret/utils/logging.rb
+- lib/claret/version.rb
+- sig/claret.rbs
+homepage: https://github.com/stevegeek/claret
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/stevegeek/claret
+  source_code_uri: https://github.com/stevegeek/claret
+  changelog_uri: https://github.com/stevegeek/claret/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.20
+signing_key:
+specification_version: 4
+summary: A Ruby dialect that includes types in the language. Transpiles to Ruby and
+  RBS.
+test_files: []