audition 0.2.4 → 0.4.0

data/lib/audition/target.rb

@@ -12,6 +12,25 @@ module Audition
       vendor node_modules tmp log coverage pkg .git .bundle
     ].freeze
 
+    # Directories holding the target's tests rather than the code
+    # a production boot loads. The default; `test_dirs` in
+    # .audition.yml replaces it for a project that files them
+    # elsewhere.
+    TEST_DIRS = %w[test spec features].freeze
+
+    # Cargo and Zig build output: full of .so/.dylib artifacts that
+    # are not the extension `require` loads.
+    BUILD_DIRS = %w[target zig-out].freeze
+
+    # What Ruby loads as a native extension (RbConfig DLEXT is
+    # "bundle" on macOS, "so" everywhere else, Windows included).
+    COMPILED = "*.{bundle,so}"
+
+    # Generated type stubs. The extension is the convention; where
+    # the generator writes them is not, so they are found by
+    # extension anywhere in the tree.
+    STUBS = "*.rbi"
+
     # @return [Symbol] one of `:script`, `:gem`, `:rack`, `:rails`,
     #   `:directory`, `:bundle`
     attr_reader :type
@@ -22,6 +41,14 @@ module Audition
     # @return [Array<String>] Ruby files to scan statically
     attr_reader :ruby_files
 
+    # @return [Array<String>] compiled extension files (.bundle/.so)
+    #   shipped with the target; empty for scripts and file lists
+    attr_reader :compiled_files
+
+    # @return [Array<String>] generated type stubs (.rbi) found
+    #   anywhere in the target's tree
+    attr_reader :stub_files
+
     # @return [Hash, nil] dynamic probe entry (`:mode` plus
     #   mode-specific keys), nil for static-only targets
     attr_reader :entry
@@ -43,6 +70,31 @@ module Audition
       end
     end
 
+    # Builds a static-only target from an explicit file list, the
+    # shape git hooks hand over (lefthook's {staged_files},
+    # pre-commit's filename arguments). Config, pragmas, and the
+    # baseline resolve against the working directory, which is the
+    # repository root when a hook manager runs the command.
+    #
+    # @param paths [Array<String>] `.rb`/`.ru` files
+    # @return [Target] type `:files`, no dynamic entry
+    # @raise [Audition::Error] when a path is not a Ruby file
+    def self.for_files(paths)
+      paths.each do |path|
+        unless File.file?(path) && path.end_with?(".rb", ".ru")
+          raise Error, "#{path} is not a Ruby file"
+        end
+      end
+
+      new(
+        type: :files,
+        root: Dir.pwd,
+        ruby_files: paths,
+        entry: nil,
+        stub_files: stubs(Dir.pwd)
+      )
+    end
+
     def self.from_file(path)
       if File.basename(path) == "Gemfile.lock"
         return new(
@@ -60,10 +112,26 @@ module Audition
         type: :script,
         root: File.dirname(path),
         ruby_files: [path],
-        entry: {mode: :script, path: path}
+        # A file inside a Rails root cannot run standalone; the
+        # script probe would report a misleading boot failure, so
+        # such files stay static-only.
+        entry: rails_member?(path) ? nil : {mode: :script, path: path},
+        stub_files: stubs(File.dirname(path))
       )
     end
 
+    def self.rails_member?(path)
+      dir = File.dirname(File.expand_path(path))
+      until dir == (parent = File.dirname(dir))
+        return true if File.file?(
+          File.join(dir, "config", "application.rb")
+        )
+
+        dir = parent
+      end
+      false
+    end
+
     def self.from_directory(dir)
       application_rb = File.join(dir, "config", "application.rb")
       config_ru = File.join(dir, "config.ru")
@@ -80,7 +148,9 @@ module Audition
           type: :directory,
           root: dir,
           ruby_files: glob(dir),
-          entry: nil
+          entry: nil,
+          compiled_files: compiled(dir),
+          stub_files: stubs(dir)
         )
       end
     end
@@ -94,15 +164,21 @@ module Audition
           glob(File.join(spec.full_gem_path, rp))
         end,
         entry: {mode: :require, feature: name,
-                root: spec.full_gem_path}
+                load_paths: spec.full_require_paths,
+                root: spec.full_gem_path},
+        compiled_files: compiled_for(spec),
+        stub_files: stubs(spec.full_gem_path)
       )
     rescue Gem::MissingSpecError
       raise Error,
         "#{name} is not a file, directory, or installed gem"
     end
 
+    # An app's own Ruby is not confined to app/lib/config: local
+    # gems, engines and tests boot into the same process, so the
+    # whole root is scanned.
     def self.rails_target(dir)
-      files = %w[app lib config].flat_map { |d| glob(File.join(dir, d)) }
+      files = glob(dir)
       files << File.join(dir, "config.ru")
       new(
         type: :rails,
@@ -112,7 +188,9 @@ module Audition
           mode: :rails,
           environment: File.join(dir, "config", "environment.rb"),
           root: dir
-        }
+        },
+        compiled_files: compiled(dir),
+        stub_files: stubs(dir)
       )
     end
 
@@ -121,22 +199,31 @@ module Audition
         type: :rack,
         root: dir,
         ruby_files: [config_ru] + glob(dir),
-        entry: {mode: :rack, config_ru: config_ru}
+        entry: {mode: :rack, config_ru: config_ru, root: dir},
+        compiled_files: compiled(dir),
+        stub_files: stubs(dir)
       )
     end
 
+    # Reading require_paths off the gemspec would mean evaluating
+    # it, which the static pass never does; `lib` is the packaging
+    # default, and a gem that keeps its code elsewhere falls back to
+    # the whole checkout rather than scanning nothing.
     def self.gem_dir_target(dir, gemspec)
       lib = File.join(dir, "lib")
+      paths = File.directory?(lib) ? [lib] : [dir]
       new(
         type: :gem,
         root: dir,
-        ruby_files: glob(lib),
+        ruby_files: paths.flat_map { |path| glob(path) },
         entry: {
           mode: :require,
           feature: File.basename(gemspec, ".gemspec"),
-          load_paths: [lib],
+          load_paths: paths,
           root: dir
-        }
+        },
+        compiled_files: compiled(dir),
+        stub_files: stubs(dir)
       )
     end
 
@@ -149,24 +236,70 @@ module Audition
       raw.sub(%r{/+\z}, "")
     end
 
-    def self.glob(dir)
+    def self.glob(dir, pattern = "*.rb", skip: EXCLUDED_DIRS)
       dir = normalize(dir)
-      Dir[File.join(dir, "**", "*.rb")].reject do |path|
+      Dir[File.join(dir, "**", pattern)].reject do |path|
         relative = path.delete_prefix("#{dir}/")
         parts = relative.split("/")
-        parts.any? { |p| EXCLUDED_DIRS.include?(p) || p.start_with?(".") }
+        parts.any? { |p| skip.include?(p) || p.start_with?(".") }
       end.sort
     end
 
+    # Generated type stubs anywhere under a directory.
+    #
+    # @param dir [String]
+    # @return [Array<String>]
+    def self.stubs(dir)
+      glob(dir, STUBS)
+    end
+
+    # macOS debug-symbol bundles (x.bundle.dSYM/...) carry a file
+    # with the extension's name that nothing ever loads.
+    def self.compiled(dir)
+      glob(dir, COMPILED, skip: EXCLUDED_DIRS + BUILD_DIRS).reject do |p|
+        p.split("/").any? { |part| part.end_with?(".dSYM") }
+      end
+    end
+
+    # Compiled extension files of an installed gem. RubyGems builds
+    # a source gem into its extension dir and also copies the result
+    # under lib/, so the same file shows up on two require paths;
+    # keep one per require-relative name.
+    #
+    # @param spec [Gem::Specification]
+    # @return [Array<String>]
+    def self.compiled_for(spec)
+      spec.full_require_paths.flat_map do |rp|
+        compiled(rp).map { |path| [path.delete_prefix("#{rp}/"), path] }
+      end.uniq(&:first).map(&:last)
+    end
+
     private_class_method :from_file, :from_directory, :from_gem_name,
       :rails_target, :rack_target, :gem_dir_target,
-      :glob, :normalize
+      :rails_member?, :glob, :compiled, :normalize
 
-    def initialize(type:, root:, ruby_files:, entry:)
+    def initialize(type:, root:, ruby_files:, entry:,
+      compiled_files: [], stub_files: [])
       @type = type
       @root = root
       @ruby_files = ruby_files
       @entry = entry
+      @compiled_files = compiled_files
+      @stub_files = stub_files
+    end
+
+    # Whether a path is test/spec code rather than code the
+    # production boot loads.
+    #
+    # @param path [String] absolute or root-relative
+    # @param dirs [Array<String>] directory names that hold tests
+    # @return [Boolean]
+    def test_file?(path, dirs: TEST_DIRS)
+      relative = File.expand_path(path, root)
+        .delete_prefix("#{root}/")
+      parts = relative.split("/")
+      parts[0..-2].any? { |p| dirs.include?(p) } ||
+        parts.last.to_s.end_with?("_test.rb", "_spec.rb")
     end
   end
 end

data/lib/audition/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Audition
-  VERSION = "0.2.4"
+  VERSION = "0.4.0"
 end

data/lib/audition.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require_relative "audition/version"
+require_relative "audition/progress"
 require_relative "audition/finding"
 require_relative "audition/target"
 require_relative "audition/static/source_file"
 require_relative "audition/static/literal_classifier"
 require_relative "audition/static/checks"
 require_relative "audition/static/graph_audit"
+require_relative "audition/static/gem_calls"
+require_relative "audition/static/native_extensions"
 require_relative "audition/static/analyzer"
 require_relative "audition/dynamic/prober"
 require_relative "audition/report"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: audition
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Yaroslav Markin
@@ -43,14 +43,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: table_tennis
   requirement: !ruby/object:Gem::Requirement
@@ -102,19 +102,30 @@ files:
 - lib/audition/dynamic/prober.rb
 - lib/audition/finding.rb
 - lib/audition/fixer.rb
+- lib/audition/progress.rb
 - lib/audition/report.rb
+- lib/audition/report/github.rb
+- lib/audition/report/json.rb
+- lib/audition/report/style.rb
+- lib/audition/report/sweep.rb
+- lib/audition/report/text.rb
 - lib/audition/rewriters.rb
 - lib/audition/static/analyzer.rb
 - lib/audition/static/checks.rb
 - lib/audition/static/checks/base.rb
+- lib/audition/static/checks/dependency_class_state.rb
 - lib/audition/static/checks/global_variables.rb
 - lib/audition/static/checks/mutable_constants.rb
 - lib/audition/static/checks/ractor_isolation.rb
 - lib/audition/static/checks/runtime_require.rb
 - lib/audition/static/checks/unsafe_calls.rb
+- lib/audition/static/checks/unshareable_reads.rb
+- lib/audition/static/gem_calls.rb
 - lib/audition/static/graph_audit.rb
 - lib/audition/static/literal_classifier.rb
+- lib/audition/static/native_extensions.rb
 - lib/audition/static/source_file.rb
+- lib/audition/static/work_split.rb
 - lib/audition/target.rb
 - lib/audition/version.rb
 homepage: https://github.com/yaroslav/audition
@@ -137,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.16
+rubygems_version: 4.0.20
 specification_version: 4
 summary: Probe Ruby code for Ractor-readiness
 test_files: []