rbs_macros 0.1.0

data/rbs_collection.lock.yaml

@@ -0,0 +1,60 @@
+---
+path: ".gem_rbs_collection"
+gems:
+- name: abbrev
+  version: '0'
+  source:
+    type: stdlib
+- name: fileutils
+  version: '0'
+  source:
+    type: stdlib
+- name: forwardable
+  version: '0'
+  source:
+    type: stdlib
+- name: json
+  version: '0'
+  source:
+    type: stdlib
+- name: logger
+  version: '0'
+  source:
+    type: stdlib
+- name: minitest
+  version: '0'
+  source:
+    type: stdlib
+- name: monitor
+  version: '0'
+  source:
+    type: stdlib
+- name: mutex_m
+  version: '0'
+  source:
+    type: stdlib
+- name: optparse
+  version: '0'
+  source:
+    type: stdlib
+- name: pathname
+  version: '0'
+  source:
+    type: stdlib
+- name: prism
+  version: 0.24.0
+  source:
+    type: rubygems
+- name: rbs
+  version: 3.4.4
+  source:
+    type: rubygems
+- name: rdoc
+  version: '0'
+  source:
+    type: stdlib
+- name: tsort
+  version: '0'
+  source:
+    type: stdlib
+gemfile_lock_path: Gemfile.lock

data/rbs_collection.yaml

@@ -0,0 +1,24 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+gems:
+  - name: rake
+    ignore: true
+  - name: rubocop
+    ignore: true
+  - name: rubocop-minitest
+    ignore: true
+  - name: steep
+    ignore: true

data/sig/generated/rbs_macros/library_registry.rbs

@@ -0,0 +1,5 @@
+module RbsMacros
+  class LibraryRegistry
+    def self.register_macros: (::String name, ?::Array[untyped] macros) ?{ (::Array[untyped] macros) -> void } -> void
+  end
+end

data/sig/rbs_macros/config.rbs

@@ -0,0 +1,13 @@
+module RbsMacros
+  class Config
+    attr_reader macros: Array[Macro]
+    attr_reader load_dirs: Array[String]
+    attr_reader sigs: Array[String]
+    attr_accessor loader: RBS::EnvironmentLoader
+    attr_accessor use_loader: bool
+    attr_accessor project: AbstractProject
+    attr_accessor output_dir: String
+
+    def initialize: () -> void
+  end
+end

data/sig/rbs_macros/environment.rbs

@@ -0,0 +1,42 @@
+module RbsMacros
+  class Environment
+    attr_reader rbs: RBS::Environment
+    attr_reader object_class: MetaModule
+    attr_reader decls: Array[DeclarationEntry]
+
+    @exact_handlers: Hash[Symbol, Array[^(HandlerParams) -> void]]
+
+    def initialize: () -> void
+
+    def register_handler: (Symbol | String name, ^(HandlerParams) -> void handler) -> void
+
+    def invoke: (HandlerParams params) -> void
+
+    def meta_eval_ruby: (String, filename: String) -> void
+
+    def add_decl: (RBS::AST::Declarations::t | RBS::AST::Members::t decl, mod: MetaModule, file: String) -> void
+
+    def out_files: () -> Array[String]
+
+    class HandlerParams < Data
+      attr_reader env(): Environment
+      attr_reader filename(): String
+      attr_reader receiver(): Object
+      attr_reader name(): Symbol
+      attr_reader positional(): Array[Object]
+      attr_reader keyword(): Hash[Object, Object]
+      attr_reader block(): untyped
+
+      def self.new: (env: Environment, filename: String, receiver: Object, name: Symbol, positional: Array[Object], keyword: Hash[Object, Object], block: untyped) -> instance
+      def initialize: (env: Environment, filename: String, receiver: Object, name: Symbol, positional: Array[Object], keyword: Hash[Object, Object], block: untyped) -> void
+    end
+
+    class DeclarationEntry < Data
+      attr_reader declaration(): RBS::AST::Declarations::t | RBS::AST::Members::t
+      attr_reader mod(): MetaModule
+      attr_reader file(): String
+      def self.new: (declaration: RBS::AST::Declarations::t | RBS::AST::Members::t, mod: MetaModule, file: String) -> instance
+      def initialize: (declaration: RBS::AST::Declarations::t | RBS::AST::Members::t, mod: MetaModule, file: String) -> void
+    end
+  end
+end

data/sig/rbs_macros/exec_ctx.rbs

@@ -0,0 +1,14 @@
+module RbsMacros
+  class ExecCtx < Data
+    attr_reader env: Environment
+    attr_reader filename: String
+    attr_reader self: untyped
+    attr_reader cref: MetaModule
+    attr_reader cref_dynamic: MetaModule
+    attr_reader locals: untyped
+    def self.new: (env: Environment, filename: String, self: untyped, cref: MetaModule, cref_dynamic: MetaModule, locals: untyped) -> instance
+    def initialize: (env: Environment, filename: String, self: untyped, cref: MetaModule, cref_dynamic: MetaModule, locals: untyped) -> void
+
+    def eval_node: (Prism::Node? node) -> untyped
+  end
+end

data/sig/rbs_macros/library_registry.rbs

@@ -0,0 +1,16 @@
+module RbsMacros
+  class LibraryRegistry
+    extend SingleForwardable
+    self.@global: LibraryRegistry
+
+    @libraries: Hash[String, Array[untyped]]
+
+    def initialize: () -> void
+
+    def register_macros: (String name, ?Array[untyped] macros) ?{ (Array[untyped] macros) -> void } -> void
+
+    def lookup_macros: (String name, ?soft_fail: bool) -> Array[untyped]
+
+    def require_library: (String name, ?soft_fail: bool) -> void
+  end
+end

data/sig/rbs_macros/macro.rbs

@@ -0,0 +1,5 @@
+module RbsMacros
+  class Macro
+    def setup: (Environment env) -> void
+  end
+end

data/sig/rbs_macros/macros/forwardable.rbs

@@ -0,0 +1,29 @@
+module RbsMacros
+  module Macros
+    class ForwardableMacros < Macro
+      def meta_def_delegator: (Environment::HandlerParams params) -> void
+      def meta_def_delegators: (Environment::HandlerParams params) -> void
+
+      def method: (:meta_def_delegator) -> ^(Environment::HandlerParams params) -> void
+                | (:meta_def_delegators) -> ^(Environment::HandlerParams params) -> void
+                | ...
+
+      private
+
+      def widened_instance: (RBS::Types::t type, builder: RBS::DefinitionBuilder) -> [RBS::Definition, RBS::Substitution]?
+    end
+
+    class SingleForwardableMacros < Macro
+      def meta_def_delegator: (Environment::HandlerParams params) -> void
+      def meta_def_delegators: (Environment::HandlerParams params) -> void
+
+      def method: (:meta_def_delegator) -> ^(Environment::HandlerParams params) -> void
+        | (:meta_def_delegators) -> ^(Environment::HandlerParams params) -> void
+        | ...
+
+      private
+
+      def widened_instance: (RBS::Types::t type, builder: RBS::DefinitionBuilder) -> [RBS::Definition, RBS::Substitution]?
+    end
+  end
+end

data/sig/rbs_macros/meta_module.rbs

@@ -0,0 +1,29 @@
+module RbsMacros
+  class MetaModule
+    attr_reader env: Environment
+    attr_reader name: String?
+    attr_reader is_class: bool?
+    attr_reader superclass: MetaModule?
+
+    @constants: Hash[Symbol, untyped]
+    @rbs_type: RBS::TypeName
+
+    def initialize: (Environment env, String? name, ?is_class: bool?, ?superclass: MetaModule?) -> void
+
+    def rbs_type: () -> RBS::TypeName
+
+    def class!: () -> void
+    def module!: () -> void
+    def define_module: (Symbol name) -> MetaModule
+
+    def meta_const_set: (Symbol name, untyped value) -> void
+    def meta_const_get: (Symbol name) -> untyped
+    def meta_constants: () -> Array[Symbol]
+
+    private
+
+    def child_module_name: (String? child_name) -> String?
+  end
+
+  class MetaClass = MetaModule
+end

data/sig/rbs_macros/project.rbs

@@ -0,0 +1,22 @@
+module RbsMacros
+  class AbstractProject
+    def glob: (ext: String, include: Array[String], exclude: Array[String]) { (String) -> void } -> void
+            | (ext: String, include: Array[String], exclude: Array[String]) -> Enumerator[String, void]
+
+    def write: (String path, String content) -> void
+
+    def read: (String path) -> String
+  end
+
+  class Project < AbstractProject
+    attr_reader base_dir: Pathname
+
+    def initialize: (?base_dir: Pathname) -> void
+  end
+
+  class FakeProject < AbstractProject
+    @files: Hash[String, String]
+
+    def initialize: () -> void
+  end
+end

data/sig/rbs_macros/version.rbs

@@ -0,0 +1,3 @@
+module RbsMacros
+  VERSION: String
+end

data/sig/rbs_macros.rbs

@@ -0,0 +1,7 @@
+module RbsMacros
+  interface _FS
+    def read: (String path) -> String
+    def write: (String path, String content) -> void
+  end
+  def self.run: () ?{ (Config) -> void } -> void
+end

data/sig-private/test/environment_test.rbs

@@ -0,0 +1,3 @@
+class EnvironmentTest < Minitest::Test
+  def test_eval_simple_class: () -> void
+end

data/sig-private/test/library_registry_test.rbs

@@ -0,0 +1,11 @@
+class LibraryRegistryTest < Minitest::Test
+  def test_register_array: () -> void
+  def test_register_block: () -> void
+  def test_register_empty: () -> void
+  def test_register_multiple: () -> void
+  def test_lookup_missing: () -> void
+  def test_lookup_require: () -> void
+  def test_lookup_require_fail: () -> void
+  def test_lookup_require_no_registration: () -> void
+  def test_lookup_require_soft: () -> void
+end

data/sig-private/test/macros/forwardable_test.rbs

@@ -0,0 +1,7 @@
+class ForwardableTest < Minitest::Test
+  class DummyFS
+    include RbsMacros::_FS
+    @files: Hash[String, String]
+    def initialize: () -> void
+  end
+end

data/sig-private/test/rbs_macros_test.rbs

@@ -0,0 +1,13 @@
+class RbsMacrosTest < Minitest::Test
+  def test_version_number: () -> void
+
+  class DummyFS
+    include RbsMacros::_FS
+    @files: Hash[String, String]
+    def initialize: () -> void
+  end
+
+  class DummyMacro < RbsMacros::Macro
+  end
+end
+

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: rbs_macros
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Wantedly, Inc.
+- Masaki Hara
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: forwardable
+  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: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.24.0
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: |
+  Rubyists love metaprogramming.
+  This tool bridges between RBS and metaprogramming,
+  by allowing you to define a macro,
+  which is then used to generate RBS definitions
+  based on macro invocations."
+email:
+- dev@wantedly.com
+- ackie.h.gmai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_new.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- lib/rbs_macros.rb
+- lib/rbs_macros/config.rb
+- lib/rbs_macros/environment.rb
+- lib/rbs_macros/exec_ctx.rb
+- lib/rbs_macros/library_registry.rb
+- lib/rbs_macros/macro.rb
+- lib/rbs_macros/macros/forwardable.rb
+- lib/rbs_macros/meta_module.rb
+- lib/rbs_macros/project.rb
+- lib/rbs_macros/version.rb
+- rbs_collection.lock.yaml
+- rbs_collection.yaml
+- sig-private/test/environment_test.rbs
+- sig-private/test/library_registry_test.rbs
+- sig-private/test/macros/forwardable_test.rbs
+- sig-private/test/rbs_macros_test.rbs
+- sig/generated/rbs_macros/library_registry.rbs
+- sig/rbs_macros.rbs
+- sig/rbs_macros/config.rbs
+- sig/rbs_macros/environment.rbs
+- sig/rbs_macros/exec_ctx.rbs
+- sig/rbs_macros/library_registry.rbs
+- sig/rbs_macros/macro.rbs
+- sig/rbs_macros/macros/forwardable.rbs
+- sig/rbs_macros/meta_module.rbs
+- sig/rbs_macros/project.rbs
+- sig/rbs_macros/version.rbs
+homepage: https://github.com/wantedly/rbs_macros
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/wantedly/rbs_macros
+  source_code_uri: https://github.com/wantedly/rbs_macros
+  changelog_uri: https://github.com/wantedly/rbs_macros/tree/master/CHANGELOG.md
+post_install_message:
+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.5.3
+signing_key:
+specification_version: 4
+summary: RBS meets metaprogramming
+test_files: []