rubyzen-lint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e0bc97dbd17202e4245c3c8c6b1d16f7fcdef64eab20ff96ab835113e21fbd9
+  data.tar.gz: 4fb9b3a30754c283823a44e208bd4de9ca0a035db5733df418ef1e70bd98172d
+SHA512:
+  metadata.gz: c23bf87e539bdda57d28a5b9f0b5fdbbee847a88ce93bf012c92a1c00eaf48fe1f5e2a99bea6a2e070749c2c74451821026f742a2e4e50e12c5395ed4295b870
+  data.tar.gz: 189a609b17528f6d0898defda84762df30273f4607f4e97882d21d255b111d719818adb9148d452c4ff5b9d7c29dbcc5c68749f36d0e96c86740451d096dc778

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,110 @@
+# Rubyzen
+
+Rubyzen is an architectural linter for Ruby that lets you write architectural lint rules as unit tests, inspired by [Konsist](https://github.com/LemonAppDev/konsist) (for Kotlin) and [Harmonize](https://github.com/perrystreetsoftware/Harmonize) (for Swift).
+
+## Architectural linters in the era of AI-generated code
+
+In the era of AI-generated code, architectural flaws and subtle bugs happen faster than ever. AI agents produce code that passes tests and looks reasonable but subtly violates your team's architecture. As more code is produced, faster, it becomes impractical for manual code reviews to catch all these violations.
+
+Architectural lint rules act as deterministic guardrails. They catch the architectural or structural mistakes that AI introduces, such as calling the database from a presenter or performing business logic in a controller, before they get merged. And since they run as unit tests, they provide immediate feedback to the AI agents to fix their own code.
+
+## Why Yet Another Linter?
+
+Traditional linters such as [RuboCop](https://github.com/rubocop/rubocop) require dealing with the raw AST, which has a steep learning curve and makes rules hard to write, read, and maintain. Rubyzen abstracts away the AST details, providing a high-level API that allows developers to write lint rules in a more natural way — the same way we write tests.
+
+## Advantages
+
+- **Readable, Easy-to-Use API:** Rubyzen provides a high-level API to access files, classes, methods, parameters, and more, without having to deal with low-level AST operations.
+
+- **Architectural Enforcement & Documentation:** By writing lint rules as tests, you can use the Given-When-Then style to enforce and document your architecture directly within the codebase.
+
+- **Less Manual Reviews:** With architectural rules automatically enforced, code reviews can focus on complex issues instead of repeating the same architectural feedback.
+
+- **AI-Friendly Feedback Loop:** When lint rules fail, the failure messages tell AI agents exactly what they violated and where, allowing them to self-correct their code.
+
+## Setup
+
+Add Rubyzen to your Gemfile:
+
+```ruby
+gem 'rubyzen-lint', group: :test
+```
+
+Then run `bundle install`.
+
+That's it. Rubyzen auto-discovers your project structure (`app/`, `lib/`, `src/`, `spec/`) from your project root. No environment variables or configuration needed.
+
+## Write your first set of lint rules
+
+Create a spec file anywhere in your project (e.g., `spec/architecture/sample_spec.rb`) and start enforcing your architecture:
+
+```ruby
+require 'rubyzen'
+
+RSpec.describe 'Architecture rules' do
+  let(:project) { Rubyzen::Project.new }
+  let(:controllers) { project.files.with_paths('app/controllers/').classes }
+  let(:presenters) { project.files.with_paths('app/presenters/').classes }
+
+  it 'controllers do not call ActiveRecord directly' do
+    expect(controllers.all_methods.call_sites.with_name('where')).to zen_empty
+  end
+
+  it 'controllers inherit from ApplicationController' do
+    expect(controllers).to zen_true { |c| c.superclass_name == 'ApplicationController' }
+  end
+
+  it 'presenters do not depend on repositories' do
+    expect(presenters.all_methods.call_sites).to zen_false { |cs|
+      cs.receiver&.end_with?('Repository')
+    }
+  end
+end
+```
+
+You can find more sample lint rules in the [`sample_project/spec/`](sample_project/spec/) directory.
+
+## Run your lint rules
+
+```bash
+bundle exec rspec spec/architecture/
+```
+
+## Custom Paths (Optional)
+
+By default, `Rubyzen::Project.new` scans standard directories (`app/`, `lib/`, `src/`, `spec/`) from your project root. You can override this:
+
+```ruby
+# In your spec file — scope to specific directories
+project = Rubyzen::Project.new(['app/models', 'app/controllers'])
+
+# Or in spec/spec_helper.rb — configure globally for all specs
+Rubyzen.configure do |config|
+  config.paths = ['app', 'lib']
+end
+```
+
+## CI Integration
+
+Add a step to your existing CI workflow to run your lint rules automatically when a PR is opened:
+
+```yaml
+- name: Run architecture lint rules
+  run: bundle exec rspec spec/architecture/
+```
+
+## AI Agent Skills
+
+Rubyzen includes agent skills in `.claude/skills/` (also symlinked at `.github/skills/`) that work with both Claude Code and GitHub Copilot:
+
+| Skill | Purpose |
+|---|---|
+| `write-lint-rule` | Write an architectural lint rule using the Rubyzen API |
+| `run-lint-rules` | Run sample project lint rules and verify the violations are detected |
+| `expand-rubyzen` | Add a new Rubyzen API (Declaration + Provider + Collection) |
+| `add-rubyzen-tests` | Write unit tests for Rubyzen's own components |
+| `run-tests` | Run Rubyzen's unit test suite |
+
+## Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on setting up the project, enhancing the API, and adding tests.

data/lib/rubyzen/cache/parse_cache.rb

@@ -0,0 +1,36 @@
+require 'digest'
+
+module Rubyzen
+  module Cache
+    # In-memory cache for parsed AST results, keyed by file path and SHA256 checksum.
+    # Automatically invalidates entries when file contents change.
+    class ParseCache
+      def initialize
+        @cache = {}
+      end
+
+      # Returns the cached result for the given file, or yields to parse and cache it.
+      #
+      # @param file_path [String] absolute path to the file
+      # @yield block that parses the file and returns the result to cache
+      # @return [Object] the cached or freshly parsed result
+      def fetch_or_parse(file_path, &block)
+        checksum = file_checksum(file_path)
+
+        if @cache.key?(file_path) && @cache[file_path][:checksum] == checksum
+          @cache[file_path][:result]
+        else
+          result = block.call
+          @cache[file_path] = { checksum: checksum, result: result }
+          result
+        end
+      end
+
+      private
+
+      def file_checksum(file_path)
+        Digest::SHA256.file(file_path).hexdigest
+      end
+    end
+  end
+end

data/lib/rubyzen/collections/attributes_collection.rb

@@ -0,0 +1,32 @@
+module Rubyzen
+  module Collections
+    # Collection of attribute declarations (attr_reader, attr_writer, attr_accessor).
+    #
+    # @example Ensuring no class uses attr_accessor
+    #   expect(controllers.attributes.accessors).to zen_empty
+    class AttributesCollection < BaseCollection
+      include Rubyzen::Providers::CollectionFilterProvider
+
+      # Returns only +attr_reader+ attributes.
+      #
+      # @return [AttributesCollection]
+      def readers
+        filter(&:reader?)
+      end
+
+      # Returns only +attr_writer+ attributes.
+      #
+      # @return [AttributesCollection]
+      def writers
+        filter(&:writer?)
+      end
+
+      # Returns only +attr_accessor+ attributes.
+      #
+      # @return [AttributesCollection]
+      def accessors
+        filter(&:accessor?)
+      end
+    end
+  end
+end

data/lib/rubyzen/collections/base_collection.rb

@@ -0,0 +1,30 @@
+module Rubyzen
+  module Collections
+    # Base collection class for all Rubyzen collections.
+    # Extends Array and replaces +select+/+reject+ with a single +filter+ method
+    # that preserves the collection subclass type.
+    #
+    # @example Filtering a collection with a block
+    #   controllers.filter { |c| c.name.end_with?('Controller') }
+    class BaseCollection < Array
+      undef_method(:select)
+      undef_method(:reject)
+
+      # Filters elements by the given block, returning a new collection of the same type.
+      #
+      # @yield [element] block that returns truthy to keep the element
+      # @return [BaseCollection] a new collection containing only matching elements
+      # @return [Enumerator] if no block is given
+      def filter
+        return enum_for(:filter) unless block_given?
+
+        result = self.class.new
+        each do |elem|
+          result << elem if yield(elem)
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/rubyzen/collections/blocks_collection.rb

@@ -0,0 +1,27 @@
+module Rubyzen
+  module Collections
+    # Collection of block declarations (do...end / { }) found in files or methods.
+    #
+    # @example Finding blocks passed to a specific method
+    #   project.files.blocks.with_method_name('describe')
+    class BlocksCollection < BaseCollection
+      include Rubyzen::Providers::CollectionFilterProvider
+
+      # Filters blocks by the method name they are passed to.
+      #
+      # @param method_name [String] the method name to match
+      # @return [BlocksCollection]
+      def with_method_name(method_name)
+        filter { |block| block.method_name == method_name }
+      end
+
+      # Returns all call sites found inside every block.
+      #
+      # @return [CallSiteCollection]
+      def call_sites
+        all_call_sites = flat_map(&:call_sites)
+        CallSiteCollection.new(all_call_sites)
+      end
+    end
+  end
+end

data/lib/rubyzen/collections/call_site_collection.rb

@@ -0,0 +1,52 @@
+
+module Rubyzen
+  module Collections
+    # Collection of method call sites found in classes, methods, or blocks.
+    #
+    # @example Ensuring controllers do not call .where directly
+    #   expect(controllers.that { have_call_sites_with_names('.where') }).to zen_empty
+    class CallSiteCollection < BaseCollection
+      include Rubyzen::Providers::CollectionFilterProvider
+
+      # Filters call sites by the receiver expression.
+      #
+      # @param receiver [String] the receiver to match
+      # @return [CallSiteCollection]
+      def with_receiver(receiver)
+        filter { |call_site| call_site.receiver == receiver }
+      end
+
+      # Filters call sites by method name.
+      #
+      # @param name [String] the method name to match
+      # @return [CallSiteCollection]
+      def with_name(name)
+        filter { |call_site| call_site.name == name }
+      end
+
+      # Alias for {#with_name}.
+      #
+      # @param method_name [String] the method name to match
+      # @return [CallSiteCollection]
+      def with_method_name(method_name)
+        with_name(method_name)
+      end
+
+      # Filters call sites that include the given symbol argument.
+      #
+      # @param symbol [Symbol] the symbol argument to match
+      # @return [CallSiteCollection]
+      def with_symbol(symbol)
+        filter { |call_site| call_site.symbols.include?(symbol) }
+      end
+
+      # Filters call sites that include the given keyword argument.
+      #
+      # @param keyword_arg [Symbol] the keyword argument to match
+      # @return [CallSiteCollection]
+      def with_keyword_arg(keyword_arg)
+        filter { |call_site| call_site.keyword_args.include?(keyword_arg) }
+      end
+    end
+  end
+end

data/lib/rubyzen/collections/classes_collection.rb

@@ -0,0 +1,77 @@
+module Rubyzen
+  module Collections
+    # Collection of class declarations with methods for navigating into
+    # child elements (methods, attributes, macros) and filtering by inheritance.
+    #
+    # @example Ensuring controllers inherit from ApplicationController
+    #   expect(controllers.with_parent_prefix('ApplicationController')).not_to zen_empty
+    class ClassesCollection < BaseCollection
+      include Rubyzen::Providers::CollectionFilterProvider
+
+      # Returns all instance and class methods across every class in the collection.
+      #
+      # @return [MethodsCollection]
+      def all_methods
+        instance_plus_class_methods = flat_map { |klass| klass.instance_methods + klass.class_methods }
+        MethodsCollection.new(instance_plus_class_methods)
+      end
+
+      # Returns all attribute declarations across every class.
+      #
+      # @return [AttributesCollection]
+      def attributes
+        all_attributes = flat_map(&:attributes)
+        AttributesCollection.new(all_attributes)
+      end
+
+      # Returns all macro invocations across every class.
+      #
+      # @return [MacrosCollection]
+      def macros
+        all_macros = flat_map(&:macros)
+        MacrosCollection.new(all_macros)
+      end
+
+      # Returns all rescue declarations across every class.
+      #
+      # @return [RescuesCollection]
+      def rescues
+        all_rescues = flat_map(&:rescues)
+        RescuesCollection.new(all_rescues)
+      end
+
+      # Returns all raise declarations across every class.
+      #
+      # @return [RaisesCollection]
+      def raises
+        all_raises = flat_map(&:raises)
+        RaisesCollection.new(all_raises)
+      end
+
+      # Filters classes whose superclass starts with the given prefix.
+      #
+      # @param prefix [String] the superclass name prefix to match
+      # @return [ClassesCollection]
+      def with_parent_prefix(prefix)
+        filter { |klass| klass.superclass_prefix?(prefix) }
+      end
+
+      # Filters classes that contain at least one macro with the given name.
+      #
+      # @param macro_name [String] the macro name to search for
+      # @return [ClassesCollection]
+      def with_macro_name(macro_name)
+        filter { |klass| klass.macros.with_name(macro_name).any? }
+      end
+
+      # Merges two ClassesCollections into a new ClassesCollection.
+      #
+      # @param other [ClassesCollection] the collection to merge
+      # @return [ClassesCollection]
+      def +(other)
+        merged = super(other)
+        self.class.new(merged)
+      end
+    end
+  end
+end

data/lib/rubyzen/collections/constants_collection.rb

@@ -0,0 +1,11 @@
+module Rubyzen
+  module Collections
+    # Collection of constant declarations found in files, classes, or modules.
+    #
+    # @example Filtering constants by name
+    #   project.files.constants.with_name('VERSION')
+    class ConstantsCollection < BaseCollection
+      include Rubyzen::Providers::CollectionFilterProvider
+    end
+  end
+end

data/lib/rubyzen/collections/declaration_collection.rb

@@ -0,0 +1,11 @@
+module Rubyzen
+  module Collections
+    # Generic collection for declaration objects that do not require
+    # specialized filtering methods (e.g., if statements).
+    #
+    # @example Collecting if-statement declarations from methods
+    #   project.files.classes.all_methods.if_statements
+    class DeclarationCollection < BaseCollection
+    end
+  end
+end