rigortype 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1264f9aa0f9dfc20f74b28ee7302166c43e0b0c6ba7b30b0cf85b39b42020eb7
+  data.tar.gz: a324faeb0b6d0b2d87bfd2517c1712cd1511afcd2579d7659f4864a1a7451032
+SHA512:
+  metadata.gz: ca91af212669aa5f62e32c4475b907dd36b1d4dc425ff2ad48f39c1962919bc3e6a7a246eac4b7138bd318c00f9fa9b4f8054612b3b64dee86d8b83b58bbaf36
+  data.tar.gz: 462e42c61867f6b933d70590aeb4ee52476d8ae1f4e034727d0e4df5928cc4706a4634535813f757de1f5da01bf19ff64e09204d63a31c72c9382fe2be5a831d

data/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

data/README.md

@@ -0,0 +1,152 @@
+# Rigor
+
+Rigor is a static analyzer for Ruby that aims to provide modern,
+inference-first type checking without adding type annotations or
+runtime dependencies to application code.
+
+This first preview ships a usable end-to-end pipeline: parse Ruby
+with Prism, build a flow-sensitive type-inference engine
+(`Rigor::Scope#type_of`), drive a project-aware RBS environment,
+and surface diagnostics through a small `rigor check` rule
+catalogue.
+
+## Status
+
+The current branch (`impl/scope-type-of`) is a **first preview**.
+The engine recognises the bulk of canonical Ruby surface — local
+variables, ivars / cvars / globals (intra- and cross-method), self
+typing, lexical constant lookup, predicate narrowing
+(`is_a?` / `==` / `===` / `case`-`when`), block parameter binding,
+closure escape, Tuple / HashShape carriers, and more. See
+[docs/CURRENT_WORK.md](docs/CURRENT_WORK.md) for the full slice
+trail.
+
+## Requirements
+
+- Nix with the `nix-command` and `flakes` features available.
+- Ruby 4.0.x and Bundler 4.x, provided by the Flake development
+  shell.
+
+## Setup
+
+```sh
+nix --extra-experimental-features 'nix-command flakes' develop --command bundle install
+nix --extra-experimental-features 'nix-command flakes' develop --command bundle exec rake
+```
+
+For interactive development, enter the Flake shell first:
+
+```sh
+nix --extra-experimental-features 'nix-command flakes' develop
+```
+
+## Quick Start
+
+Inside the Flake shell:
+
+```sh
+# Show available subcommands.
+bundle exec exe/rigor help
+
+# Print the inferred type at FILE:LINE:COL.
+bundle exec exe/rigor type-of lib/rigor/scope.rb:55:9
+
+# Report Scope#type_of coverage across a tree.
+bundle exec exe/rigor type-scan lib
+
+# Diagnose unknown methods and wrong-arity calls on typed receivers.
+bundle exec exe/rigor check lib
+
+# Write a starter .rigor.yml.
+bundle exec exe/rigor init
+```
+
+### Example diagnostics
+
+`rigor check` reports the canonical type-check signals it can
+prove against the loaded RBS environment:
+
+```sh
+$ cat /tmp/demo.rb
+"hello".no_such_method        # bug: undefined method
+[1, 2, 3].rotate(1, 2)        # bug: wrong number of arguments
+
+$ bundle exec exe/rigor check /tmp/demo.rb
+/tmp/demo.rb:1:9: error: undefined method `no_such_method' for "hello"
+/tmp/demo.rb:2:11: error: wrong number of arguments to `rotate' on Array (given 2, expected 0..1)
+```
+
+The rule catalogue is intentionally narrow: a diagnostic fires
+only when the receiver type is statically known and the method
+set on that class is enumerable through RBS or in-source `def` /
+`define_method` discovery. Implicit-self calls, dynamic
+receivers, and constant-decl alias classes (e.g. `YAML` → `Psych`)
+are skipped to avoid false positives.
+
+## What works
+
+The first preview engine resolves:
+
+- **Local / instance / class / global variables** — intra-method
+  bindings (`@x = 1; @x`), cross-method ivar / cvar accumulators
+  (`def init; @x = 1; end; def get; @x; end`), program-wide
+  globals.
+- **Compound writes** — `||=`, `&&=`, `+=` and friends thread
+  through scope for every variable kind.
+- **`self` typing** — class- and method-body boundaries inject
+  `Singleton[T]` / `Nominal[T]`; implicit-self call dispatch
+  routes through the enclosing class's RBS.
+- **Constant lookup** — lexical walk against `scope.self_type`,
+  RBS-core, common stdlib (`pathname`, `optparse`, `json`,
+  `yaml`, ...), the `prism` and `rbs` gems' RBS, in-source
+  class discovery, and in-source constant value tracking
+  (`BUCKETS = [:a, :b, :c]; BUCKETS.first` → `Constant[:a]`).
+- **Predicate narrowing** — truthiness, `nil?`, `is_a?` /
+  `kind_of?` / `instance_of?`, finite-literal equality,
+  case-equality (`===`) for Class / Module / Range / Regexp,
+  `case` / `when` integration.
+- **Blocks** — parameter binding (incl. destructuring + numbered
+  parameters), block-return-type uplift through generic methods
+  (`Array#map { |n| n.to_s }` → `Array[String]`), closure escape
+  classification, captured-local invalidation on escaping blocks.
+- **Tuple / HashShape carriers** — shape-aware element access,
+  range / start-length slices, closed / open / required / optional
+  policies threaded through `Acceptance`.
+- **`rigor check` first-preview rules** — undefined method on
+  typed receiver, wrong number of positional arguments. Both
+  consult RBS plus in-source `def` / `define_method` discovery so
+  reopened classes do not produce false positives.
+
+See [docs/CURRENT_WORK.md](docs/CURRENT_WORK.md) for the canonical
+status snapshot, [docs/internal-spec/inference-engine.md](docs/internal-spec/inference-engine.md)
+for the engine contract, and [docs/adr/](docs/adr/) for the
+decision records.
+
+## Project layout
+
+- `lib/rigor` — runtime library, type model, inference engine, CLI.
+- `lib/rigor/analysis` — `Runner`, `CheckRules`, `Diagnostic`,
+  `FactStore`.
+- `lib/rigor/inference` — `Scope`-driven typers, dispatchers, and
+  narrowing.
+- `sig` — RBS signatures for Rigor itself.
+- `spec` — RSpec test suite (830+ examples).
+- `docs/adr` — architecture decision records.
+- `docs/internal-spec` — engine contracts.
+- `docs/type-specification` — type-language semantics.
+
+## Roadmap past first preview
+
+In rough priority order (see CURRENT_WORK.md for details):
+
+1. More `rigor check` rules (nil-call, type-incompatible writes,
+   unbound locals).
+2. `RBS::Extended` effect plumbing (`%a{rigor:v1:pure}`,
+   mutation / escape / call-timing effects).
+3. Diagnostic publication for `FallbackTracer` events.
+4. Plugin contribution layer.
+
+## License
+
+Rigor is licensed under the Mozilla Public License Version 2.0.
+See [LICENSE](LICENSE).

data/exe/rigor

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __dir__)
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require "rigor/cli"
+
+exit Rigor::CLI.start(ARGV)