steep-picoruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86e760b6bf31ec9ddc4b5f2d9d7b5cf59c7739bcf27d1492c4bf227dd2642072
+  data.tar.gz: ece76834cb7d7c6cff20b03ba3ae6054c81c73675fb745e0f0d01c0017cbe71a
+SHA512:
+  metadata.gz: a0241d499f8714dd265c132c397db1c3811ca5f52e80f15d8956c751c18161b903ee6d235c60b10016511bfcc53e14a071cf640ab4055ea40cf1d38075798d07
+  data.tar.gz: 8bfa5443f41cda24c320d59ca2528d5abb2a64d7097fffd38045d0e4d3713655d9b3788b3adb90be2dc83921595791e017d20526bbc42c2bcd15465f98c6581c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Masataka Pocke Kuwabara
+
+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,138 @@
+# Steep::PicoRuby
+
+A Steep extension to load RBS files for PicoRuby gems.
+
+This gem supports introducing Steep into an application written in PicoRuby.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add steep-picoruby
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install steep-picoruby
+```
+
+## Usage
+
+This gem adds `picoruby_library` method for `Steepfile`.
+
+It requires the [picoruby/picoruby](https://github.com/picoruby/picoruby) repository and a build config file that determines what gems your application depends on.
+Execute the following commands if you haven't downloaded the PicoRuby repository yet.
+
+```console
+$ mkdir lib
+$ git clone --recurse-submodules https://github.com/picoruby/picoruby lib/picoruby
+```
+
+```ruby
+# Steepfile
+
+require 'steep/picoruby'
+
+target :lib do
+  picoruby_library(
+    target: 'my_app',
+    picoruby_root: 'path/to/picoruby/picoruby',
+    build_config: 'path/to/your/build_config/my_app.rb',
+  )
+
+  # General type checking settings
+  check 'mrblib'
+  signature 'sig'
+end
+```
+
+The arguments of `picoruby_library`:
+
+| name | type | description | default |
+| --- | --- | --- | --- |
+| `target` | `String | Array[String]` | The build name defined in the build config file | All existing targets |
+| `picoruby_root` | `String | Pathname` | The file path of PicoRuby repository | `"lib/picoruby"` |
+| `build_config`  | `String | Pathname | Array[String | Pathname]` | The file path of your build config | `Pathname.glob("build_config/*.rb")` |
+
+## Examples
+
+These examples require that PicoRuby repository is cloned into `lib/picoruby/`.
+
+### For app on R2P2
+
+```ruby
+# Steepfile
+
+require 'steep/picoruby'
+
+target :lib do
+  picoruby_library(
+    target: 'r2p2-picoruby-pico2',
+    build_config: 'lib/picoruby/build_config/r2p2-picoruby-pico2.rb',
+  )
+
+  # General type checking settings
+  check 'mrblib'
+  signature 'sig'
+end
+```
+
+You need to change the setting if your app assumes a different environment, such as FemtoRuby or Pico W.
+
+### Several targets
+
+You can use several RBS environments. For example: application code and test code.
+
+This example requires the following `build_config` files.
+
+```console
+$ cat build_config/my-app.rb
+MRuby::CrossBuild.new("my-app") do |conf|
+  # ...
+end
+
+$ cat build_config/picotest-host.rb
+MRuby::Build.new do |conf|
+  # ...
+end
+```
+
+```ruby
+# Steepfile
+
+require 'steep/picoruby'
+
+target :lib do
+  # It only loads type signatures for application code
+  picoruby_library target: 'my_app'
+
+  signature "sig"
+  check 'mrblib'
+end
+
+target :test do
+  # It loads both dependencies of app and test.
+  picoruby_library
+
+  signature "sig"
+  check 'test'
+end
+```
+
+Note that if you specify `picoruby_library target: 'host'`, it loads RBS files only for test dependencies. But it does not work well in most cases because RBS files under `sig/` depend on gems that the test dependencies do not include.
+
+## 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/pocke/steep-picoruby.
+
+## 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/steep/picoruby/dependency_checker.rb

@@ -0,0 +1,37 @@
+# This file is evaluated in a separated environment from Steep.
+# Therefore it does NOT loaded by `require 'picoruby/steep'`.
+
+stdout = $stdout.dup
+$stdout.reopen File::NULL
+
+require "rake"
+require 'json'
+
+picoruby_root = ARGV[0] or raise
+config_paths  = ARGV[1..]
+
+MRUBY_ROOT = File.expand_path(picoruby_root)
+$LOAD_PATH << "#{MRUBY_ROOT}/lib"
+
+require "mruby/core_ext"
+require "mruby/build"
+require "picoruby/build"
+
+MRUBY_CONFIG = MRuby::Build.mruby_config_path
+load MRUBY_CONFIG
+
+config_paths.each do |path|
+  load path
+end
+
+MRuby.each_target do
+  gems.each(&:setup)
+  gems.check self
+end
+
+map = MRuby.each_target.to_h do |t|
+  [t.name, t.gems.map { |g| g.dir }]
+end
+
+$stdout.reopen stdout
+puts JSON.generate(map)

data/lib/steep/picoruby/library_options_ext.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Steep
+  module PicoRuby
+    module LibraryOptionsExt
+      NONE = Object.new.freeze
+
+      def picoruby_library(picoruby_root: 'lib/picoruby', build_config: NONE, target: NONE)
+        pwd = Pathname.pwd
+
+        if build_config == NONE
+          build_config = pwd.glob('build_config/*.rb')
+        end
+        build_config = Array(build_config).map(&:to_s)
+        raise "No build_config exists" if build_config.empty?
+
+        out, err, st = Open3.capture3('ruby', DEPENDENCY_CHECKER_PATH, picoruby_root.to_s, *build_config)
+        raise "dependency checker failed.\n\n#{out}\n\n#{err}" unless st.success?
+
+        hash = JSON.parse(out)
+        keys = target == NONE ? hash.keys : Array(target)
+        unless (not_exists = keys - hash.keys).empty?
+          raise "#{not_exists.join(',')} are unknown targets. target should be in #{hash.keys.join(',')}"
+        end
+        paths = keys
+          .flat_map { |key| hash[key] }.uniq
+          .map { |path|
+            path = Pathname(path) / 'sig/'
+            path.relative_path_from(pwd)
+          }
+        paths.each do |path|
+          signature path.to_s if path.exist?
+        end
+      end
+    end
+  end
+end

data/lib/steep/picoruby/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Steep
+  module PicoRuby
+    VERSION = "0.1.0"
+  end
+end

data/lib/steep/picoruby.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'open3'
+require 'pathname'
+require 'json'
+require 'steep'
+
+require_relative "picoruby/version"
+require_relative "picoruby/library_options_ext"
+
+module Steep
+  module PicoRuby
+    DEPENDENCY_CHECKER_PATH = File.join(__dir__, 'picoruby/dependency_checker.rb')
+  end
+end
+
+Steep::Project::DSL::LibraryOptions.include Steep::PicoRuby::LibraryOptionsExt

data/sig/steep/picoruby.rbs

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

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: steep-picoruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masataka Pocke Kuwabara
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Load PicoRuby libraries from Steep
+email:
+- kuwabara@pocke.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/steep/picoruby.rb
+- lib/steep/picoruby/dependency_checker.rb
+- lib/steep/picoruby/library_options_ext.rb
+- lib/steep/picoruby/version.rb
+- sig/steep/picoruby.rbs
+homepage: https://github.com/pocke/steep-picoruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pocke/steep-picoruby
+  source_code_uri: https://github.com/pocke/steep-picoruby
+  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: 4.0.3
+specification_version: 4
+summary: Load PicoRuby libraries from Steep
+test_files: []