typeprof-task 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca7e7b06a15856ddbdbe3c053f22c6fba15977a1963894f0b2c13670fe7cafbc
+  data.tar.gz: e381df67d8c5ecb97a4eacbbc90f8cf087d80ed1e66e3eef380172ca501f0473
+SHA512:
+  metadata.gz: fd9775e23baf707b461c3bbe7c6aa985961c66fa9ebbed6ad54254dfc936792cfdbf6734e6346f6c9c6c54490f1d8c9ccd86e650f2d4d2df3b46358aa645169a
+  data.tar.gz: 69b3537d307837adc1cc13a75dc3af79a3f81d66739b74220ca31bb0001af27b59cf7a9bfd38f95e8569020d4dadc9d400e6b88d586d3a115db67123b7d05f5b

data/.document

@@ -0,0 +1,4 @@
+README.md
+CHANGELOG.md
+LICENSE
+lib

data/.rdoc_options

@@ -0,0 +1 @@
+main_page: README.md

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,7 @@
+# TypeProf Task change log
+
+## Unreleased
+
+## 0.1.0 - 2024-12-31
+
+* Initial release

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 gemmaro
+
+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,44 @@
+# TypeProf::Task
+
+Rake interface for TypeProf.
+
+TypeProf Task is a Rake task library for TypeProf.  It defines tasks to
+analyze Ruby source codes (and generate RBS files).
+
+## Installation
+
+Install the gem and add to the application's `Gemfile` by executing:
+
+``` shell
+bundle add typeprof-task
+```
+
+If Bundler is not being used to manage dependencies, install the gem by executing:
+
+``` shell
+gem install typeprof-task
+```
+
+## Usage
+
+Add below to your `Rakefile` and run `rake typeprof`.  Please refer to the API
+documentation for options.
+
+```ruby
+require "typeprof/task"
+
+TypeProf::Task.new
+```
+
+## 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 the library file, 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.

data/Rakefile

@@ -0,0 +1,16 @@
+# 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 "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/typeprof/task.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require "typeprof"
+require "rake/tasklib"
+require "set"
+
+module TypeProf
+  class Task < Rake::TaskLib
+    VERSION = "0.1.0"
+
+    # Target files.  By default, files under one of the require paths.
+    attr_writer :files
+
+    # Output file path.  <tt>sig/GEM_NAME.gen.rbs</tt> by default.  See also
+    # TypeProf's <tt>-o</tt> option.
+    attr_writer :outfile
+
+    # Unspecified by default.  See also TypeProf's <tt>--quiet</tt> option.
+    attr_writer :quiet
+
+    # None by default.  See also TypeProf's <tt>-I</tt> option.
+    attr_writer :include
+
+    # None by default.  See also TypeProf's <tt>-r</tt> option.
+    attr_writer :require
+
+    # None by default.  See also TypeProf's <tt>--collection</tt> option.
+    attr_writer :collection
+
+    # None by default.  See also TypeProf's <tt>--include-dir</tt> option.
+    attr_writer :include_dir
+
+    # None by default.  See also TypeProf's <tt>--exclude-dir</tt> option.
+    attr_writer :exclude_dir
+
+    # Unspecified by default.  See also TypeProf's <tt>--exclude-untyped</tt>
+    # option.
+    attr_writer :exclude_untyped
+
+    # Unspecified by default.  See also TypeProf's
+    # <tt>--show-typeprof-version</tt> option.
+    attr_writer :show_version
+
+    # Unspecified by default.  See also TypeProf's <tt>--show-errors</tt> (or
+    # <tt>--verbose</tt>) option.
+    attr_writer :show_errors
+
+    # Unspecified by default.  See also TypeProf's <tt>--show-untyped</tt>
+    # option.
+    attr_writer :show_untyped
+
+    # Unspecified by default.  See also TypeProf's
+    # <tt>--show-parameter-names</tt> option.
+    attr_writer :show_parameter_names
+
+    # Unspecified by default.  See also TypeProf's
+    # <tt>--show-source-locations</tt> option.
+    attr_writer :show_source_locations
+
+    # Unspecified by default.  See also TypeProf's <tt>--max-second</tt>
+    # option.
+    attr_writer :max_second
+
+    # Unspecified by default.  See also TypeProf's <tt>--max-iteration</tt>
+    # option.
+    attr_writer :max_iteration
+
+    # Unspecified by default.  See also TypeProf's <tt>--stub-execution</tt>
+    # option.
+    attr_writer :stub_execution
+
+    # Unspecified by default.  See also TypeProf's <tt>--type-depth-limit</tt>
+    # option.
+    attr_writer :type_depth_limit
+
+    # Unspecified by default.  See also TypeProf's
+    # <tt>--union_width_limit</tt> option.
+    attr_writer :union_width_limit
+
+    def initialize(name = :typeprof)
+      # TODO: Support multiple gemspecs and custom path options
+      Dir["*.gemspec"] => [gemspec]
+      spec = Gem::Specification.load(gemspec)
+
+      @files = spec.lib_files
+      @outfile = File.join("sig", "#{spec.name}.gen.rbs")
+      @include = Set.new
+      @require = Set.new
+      @collection = Set.new
+      @include_dir = Set.new
+      @exclude_dir = Set.new
+
+      block_given? and yield self
+
+      options = ["-o", @outfile]
+      @quiet and options << "--quiet"
+      options.concat(@include.flat_map { |dir| ["-I", dir] })
+      options.concat(@require.flat_map { |gem| ["-r", gem] })
+      options.concat(@collection.flat_map { |conf| ["--collection", conf] })
+      options.concat(@include_dir.flat_map { |dir| ["--include-dir", dir] })
+      options.concat(@exclude_dir.flat_map { |dir| ["--exclude-dir", dir] })
+      @exclude_untyped and options << "--exclude-untyped"
+
+      if instance_variable_defined?(:@show_version)
+        if @show_version
+          options << "--show-typeprof-version"
+        else
+          options << "--no-show-typeprof-version"
+        end
+      end
+
+      if instance_variable_defined?(:@show_errors)
+        if @show_errors
+          options << "--show-errors"
+        else
+          options << "--no-show-errors"
+        end
+      end
+
+      if instance_variable_defined?(:@show_untyped)
+        if @show_untyped
+          options << "--show-untyped"
+        else
+          options << "--no-show-untyped"
+        end
+      end
+
+      if instance_variable_defined?(:@show_parameter_names)
+        if @show_parameter_names
+          options << "--show-parameter-names"
+        else
+          options << "--no-show-parameter-names"
+        end
+      end
+
+      if instance_variable_defined?(:@show_source_locations)
+        if @show_source_locations
+          options << "--show-source-locations"
+        else
+          options << "--no-show-source-locations"
+        end
+      end
+
+      @max_second and options.push("--max-second", @max_second)
+      @max_iteration and options.push("--max-iteration", @max_iteration)
+
+      if instance_variable_defined?(:@stub_execution)
+        if @stub_execution
+          options << "--stub-execution"
+        else
+          options << "--no-stub-execution"
+        end
+      end
+
+      @type_depth_limit and options.push("--type-depth-limit", @type_depth_limit)
+      @union_width_limit and options.push("--union-width-limit", @union_width_limit)
+
+      outdir = File.dirname(@outfile)
+
+      desc "Analyze types for Ruby code"
+      task name => outdir do
+        config = TypeProf::CLI.parse([*options, *@files])
+        TypeProf.analyze(config)
+      end
+
+      directory outdir
+    end
+  end
+end

data/sig/typeprof/task.rbs

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: typeprof-task
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gemmaro
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typeprof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.21.3
+- !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'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: TypeProf Task is a Rake task library for TypeProf.
+email:
+- gemmaro.dev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".rdoc_options"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/typeprof/task.rb
+- sig/typeprof/task.rbs
+homepage: https://git.disroot.org/gemmaro/typeprof-task
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  bug_tracker_uri: https://git.disroot.org/gemmaro/typeprof-task/issues
+  changelog_uri: https://git.disroot.org/gemmaro/typeprof-task/src/branch/main/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/typeprof-task
+  homepage_uri: https://git.disroot.org/gemmaro/typeprof-task
+  source_code_uri: https://git.disroot.org/gemmaro/typeprof-task
+  wiki_uri: https://git.disroot.org/gemmaro/typeprof-task/wiki
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.4
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: TypeProf for Rake task
+test_files: []