private_detective 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b2a4fd2e7baae3f735e10f71e48d5b9536d54831244e36283afaacc028919c5
+  data.tar.gz: 104bfcd621e4fb437c5956f6ac9793ab7116ef8a26ae2927f78deec9ec668d80
+SHA512:
+  metadata.gz: 60038d8884c2bec910a34ebc060265beb5c1068d91b5ae23fc4365dabd0ec766e06e10239021dcb107bd60a7836fe4eaa5cdd33acbd6421b5a28f7258a919859
+  data.tar.gz: 6ee76e06401e130ebde370d1389ff714cabc9a20707bcdb8385d86e73134eea2d7d8159d9e39b0c59371db2a30d6c3b666ad68f13d55a89a78e38490c28064c6

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 2.7.3" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/private_detective.iml" filepath="$PROJECT_DIR$/.idea/private_detective.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/private_detective.iml

@@ -0,0 +1,43 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="byebug (v11.1.3, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="coderay (v1.1.3, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="colorize (v0.8.1, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.3, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="method_source (v1.0.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parallel (v1.23.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="parser (v3.2.2.4, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="pry (v0.14.2, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="pry-byebug (v3.10.1, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.7.3, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.1.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rexml (v3.2.6, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.12.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.12.2, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.12.3, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.12.6, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.12.1, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-ast (v1.30.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.13.0, rbenv: 2.7.3) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="unicode-display_width (v2.5.0, rbenv: 2.7.3) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-01
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in private_detective.gemspec
+gemspec
+
+gem "colorize"
+gem "parser"
+gem "pry-byebug"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    private_detective (0.1.0)
+      colorize (~> 0.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    diff-lcs (1.5.0)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    method_source (1.0.0)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.3)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.58.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  x86_64-darwin-23
+
+DEPENDENCIES
+  colorize
+  parser
+  private_detective!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ross Buddie
+
+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,73 @@
+# Private Detective 🕵️
+## A Ruby gem to analyze method visibility in your Ruby project
+
+## Overview
+
+Private Detective was created to address a common issue in Ruby projects where determining the appropriate visibility for class methods is sometimes overlooked. Often, it is not immediately clear whether a method should be private, protected or public. Private Detective simplifies this process by providing tools to analyze Ruby source code files, helping developers identify and refine the visibility of their methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'private_detective'
+```
+
+and then execute:
+    
+ ```bash
+ $ private_detective
+ ```
+
+## Why did I build this gem?
+
+In real-world scenarios, it is common for public methods to inadvertently expose internal details, or for private methods to be unnecessarily restrictive. This can lead to issues with maintainability, code readability, and overall project health. Private Detective was developed to streamline the identification and rectification of such visibility issues, offering a clearer understanding of method visibility within Ruby projects.
+
+More importantly, it was also a good excuse to look at the inner workings of the Rubocop gem and build a gem of my own exploring the Ruby file parser and to traverse AST nodes.
+
+## How It Works
+
+The Private Detective gem employs the following process to analyze method visibility in your Ruby project:
+
+1. **Iteration Over Project Files:**
+    - The gem iterates over your project files (currently app/models only), inspecting the Ruby source code.
+
+2. **Parsing to AST Nodes:**
+    - Each file is parsed into an Abstract Syntax Tree (AST) node using the `parser` gem.
+
+3. **Traversing the AST:**
+    - The gem traverses the AST nodes to identify class methods and their visibility modifiers: Private, Protected and the default Public.
+
+4. **Visibility Analysis:**
+    - Based on the identified methods and modifiers, Private Detective provides insights into potential issues related to method visibility.
+
+## Example response
+
+```response
+Private Detective found the following Class method information in your project:
+
+Class: Client
+  Method: test_method_rubocop_client, visibility: public
+	Method contents:
+		models/user.rb:10:4 User#test_method_rubocop private [Correctable]
+		models/user.rb:11:4 User#test_private_method_rubocop protected [Correctable]
+  Method: test_additional_method_example, visibility: private
+  Method: test_additional_method_example_2, visibility: private
+
+Class: Prompt
+  Method: message_content, visibility: public
+
+Class: User
+  Method: test_method_rubocop, visibility: private
+  Method: test_private_method_rubocop, visibility: protected
+
+End of report
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rossme/private_detective.
+
+## 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 "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/private_detective

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "parser/current"
+require "colorize"
+require "private_detective"
+
+files = if ARGV.empty?
+          Dir.glob("#{Dir.pwd}/**/app/models/*.rb")
+        else
+          ARGV
+        end
+
+private_detective = PrivateDetective::AnalyzeProject.new(files: files)
+private_detective&.analyze_project
+
+require "irb"
+IRB.start(__FILE__)

data/lib/private_detective/analyze_file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module PrivateDetective
+  class AnalyzeFile
+
+    attr_reader :file_path, :report, :node
+
+    # @param [String] file_path, [Hash] report
+    def initialize(file_path:, report:)
+      @file_path = file_path
+      @report = report
+    end
+
+    # @return [Hash] report
+    def analyze_file
+      @node = Parser::CurrentRuby.parse(File.read(file_path))
+      return unless node.is_a?(Parser::AST::Node)
+
+      analyze_node
+    end
+
+    private
+
+    # @return [Hash] report
+    def analyze_node
+      analyze_node = PrivateDetective::AnalyzeNode.new(node: node, file_path: file_path)
+      analyze_node.process_node
+
+      report.merge!(analyze_node.report)
+    end
+  end
+end

data/lib/private_detective/analyze_node.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module PrivateDetective
+  class AnalyzeNode
+
+    ACCESS_CONTROL_KEYWORDS = %i[public private protected].freeze
+
+    attr_reader :class_details, :super_class, :class_body, :file_path, :report
+
+    # @param [Parser::AST::Node] node, [String] file_path
+    def initialize(node:, file_path: nil)
+      @class_details, @super_class, @class_body = *node
+      @file_path = file_path
+      @report = { class_name => [] }
+    end
+
+    # @return [Hash] report
+    def process_node
+      return unless class_pattern?
+
+      create_report
+    end
+
+    private
+
+    # @return [Hash] report
+    def create_report
+      class_body.children.each do |child_node|
+        next unless def_method?(child_node)
+
+        report[class_name] << build_method_hash(child_node)
+      end
+    end
+
+    # @return [Boolean]
+    def class_pattern?
+      class_name && super_class&.children[1] == :ApplicationRecord && class_body&.type == :begin
+    end
+
+    # @return [Boolean]
+    def def_method?(child_node)
+      child_node&.type == :def
+    end
+
+    # @return [Hash] method name, class name, visibility, on_send, location
+    def build_method_hash(child_node)
+      {
+        file_path: shortened_file_path,
+        class: class_name,
+        method: child_node.children[0],
+        visibility: method_visibility(child_node),
+        on_send: build_send_hash(child_node),
+        location: {
+          location: child_node.location,
+          line: child_node.location.line,
+          column: child_node.location.column,
+          source: child_node.location.expression.source
+        }
+      }
+    end
+
+    # @return [Hash] send_method_hash(send_node)
+    # @example { 0 => { method: :my_user_method, class: :user } }
+    def build_send_hash(child_node)
+      send_hash = {}
+      child_node.children[2].children.each_with_index do |send_node, index|
+        next unless valid_send_node?(send_node)
+
+        send_hash.merge!(index => send_method_hash(send_node))
+      end
+      send_hash
+    end
+
+    # @return [Boolean]
+    def valid_send_node?(send_node)
+      return false unless send_node.is_a?(Parser::AST::Node)
+
+      send_node.type == :send && send_node.children&.first&.type == :const
+    end
+
+    # @return [Hash] method name and class name
+    def send_method_hash(send_node)
+      {
+        method: send_node.children[1],
+        class: send_node.children[0].children[1],
+        location: {
+          location: send_node.location,
+          line: send_node.location.line,
+          column: send_node.location.column,
+          source: send_node.location.expression.source
+        }
+      }
+    end
+
+    # @return [Symbol] visibility
+    # @example :public, :private, :protected
+    def method_visibility(child_node)
+      visibility = :public
+
+      while child_node
+        if child_node.type == :send && ACCESS_CONTROL_KEYWORDS.include?(child_node.children[1])
+          visibility = child_node.children[1]
+          break
+        end
+        child_node = sibling_index(child_node).zero? ? nil : sibling_node(child_node)
+      end
+
+      visibility
+    end
+
+    # @return [Integer] index of child_node in parent_node
+    def sibling_index(child_node)
+      class_body&.children&.index { |sibling| sibling.equal?(child_node) }
+    end
+
+    # @return [Parser::AST::Node] sibling node
+    def sibling_node(child_node)
+      class_body.children[sibling_index(child_node) - 1]
+    end
+
+    # @return [Symbol] class name
+    def class_name
+      @class_name ||= class_details&.children&.last
+    end
+
+    def shortened_file_path
+      @shortened_file_path ||= file_path&.split('/').last(2).join('/')
+    end
+  end
+end

data/lib/private_detective/analyze_project.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PrivateDetective
+
+  class AnalyzeProject
+
+    attr_accessor :files, :report
+
+    # @param [Array] files
+    def initialize(files:)
+      @files = files
+      @report = {}
+    end
+
+    def analyze_project
+      analyze_files
+      filter_report
+      show_report
+
+      # Exit the IRB session after the report is shown
+      exit
+    end
+
+    private
+
+    def analyze_files
+      files.each do |file_path|
+        analyze_file(file_path)
+      end
+    end
+
+    # @return [Hash] report with empty classes and methods removed
+    def filter_report
+      report.delete_if { |_class_name, methods| methods.empty? }
+    end
+
+    # @param [String] file_path
+    def analyze_file(file_path)
+      investigation = PrivateDetective::AnalyzeFile.new(file_path: file_path, report: report)
+      investigation.analyze_file
+    end
+
+    def show_report
+      return puts "No class methods found".colorize(:red) if report.empty?
+
+      PrivateDetective::Report.generate(report: report)
+    end
+  end
+end

data/lib/private_detective/report.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module PrivateDetective
+  class Report
+
+    class << self
+
+      def generate(report:)
+        return puts 'No class methods found'.colorize(:red) if report.empty?
+
+        puts "Private Detective found the following Class method information in your project:\n".colorize(:yellow)
+
+        report.each do |class_name, methods|
+          puts "Class: #{class_name}".colorize(:cyan)
+          methods.each do |method_info|
+            method_name = method_info[:method]
+
+            puts "  Method: #{method_name}, visibility: #{format_visibility(method_info[:visibility])}"
+            on_send_values = method_info[:on_send]
+            next if on_send_values.empty?
+
+            puts "\tMethod contents:"
+            handle_on_send_values(report, method_info)
+          end
+          puts "\n"
+        end
+        puts 'End of report'.colorize(:cyan)
+      end
+
+      def handle_on_send_values(report, method_info)
+        values = method_info[:on_send]
+
+        values.each do |_k, v|
+          method = v[:method]
+          klass = v[:class]
+
+          # find the parent method info
+          method_info = report[klass].find { |m| m[:method] == method }
+          next unless method_info
+
+          puts "\t\t#{method_info[:file_path]}:#{v.dig(:location, :line)}:#{v.dig(:location, :column)} #{klass.to_s.colorize(:cyan)}##{method.to_s.colorize(:cyan)} #{format_visibility(method_info[:visibility], true)}"
+        end
+      end
+
+      def format_visibility(visibility, on_send = false)
+        case visibility
+        when :private
+          visibility.to_s.colorize(:red) + (on_send ? ' [Correctable]'.colorize(:green) : '')
+        when :protected
+          visibility.to_s.colorize(:yellow) + (on_send ? ' [Correctable]'.colorize(:green) : '')
+        else # :public
+          visibility.to_s.colorize(:green)
+        end
+      end
+    end
+  end
+end

data/lib/private_detective/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PrivateDetective
+  VERSION = "0.1.0"
+end

data/lib/private_detective.rb

@@ -0,0 +1,17 @@
+# lib/private_detective.rb
+
+# @example Usage in a Rails project
+# private_detective = PrivateDetective::AnalyzeProject.new
+# private_detective.analyze_project
+
+module PrivateDetective
+  require "parser/current"
+  require "colorize"
+  require_relative "./private_detective/analyze_project"
+  require_relative "./private_detective/analyze_file"
+  require_relative "./private_detective/analyze_node"
+  require_relative "./private_detective/report"
+  require_relative "./private_detective/version"
+
+  class PrivateDetectiveError < StandardError; end
+end

data/private_detective.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/private_detective/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "private_detective"
+  spec.version = PrivateDetective::VERSION
+  spec.authors = ["rossme"]
+  spec.email = ["r.buddie@gmail.com"]
+
+  spec.summary = "Private Detective is a Ruby parser gem that helps you check method visibility."
+  spec.description = "Method visibility is an important part of Ruby's object model. Private Detective helps you check method visibility in your Ruby code."
+  spec.homepage = "https://github.com/rossme/private_detective"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rossme/private_detective"
+  spec.metadata["changelog_uri"] = "https://github.com/rossme/private_detective/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "bin"
+  spec.executables = ["private_detective"]
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  spec.add_dependency "colorize", "~> 0.8.1"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/sig/private_detective.rbs

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

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: private_detective
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rossme
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+description: Method visibility is an important part of Ruby's object model. Private
+  Detective helps you check method visibility in your Ruby code.
+email:
+- r.buddie@gmail.com
+executables:
+- private_detective
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/private_detective.iml"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/private_detective
+- lib/private_detective.rb
+- lib/private_detective/analyze_file.rb
+- lib/private_detective/analyze_node.rb
+- lib/private_detective/analyze_project.rb
+- lib/private_detective/report.rb
+- lib/private_detective/version.rb
+- private_detective.gemspec
+- sig/private_detective.rbs
+homepage: https://github.com/rossme/private_detective
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rossme/private_detective
+  source_code_uri: https://github.com/rossme/private_detective
+  changelog_uri: https://github.com/rossme/private_detective/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Private Detective is a Ruby parser gem that helps you check method visibility.
+test_files: []