referral 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5cdd1a3baacf145aeb660dbbcdc09a25a42514ae5b6fef5b1d7dc8edd111f0a
-  data.tar.gz: b70e542db5e9a56623c2234ced091c083d15cc086068b4626efd1e90417ba1c8
+  metadata.gz: fbff70f9e9188e6af17f3bc5be2c2f144a3fce7eaf48dcb3cd67f7a860073ebc
+  data.tar.gz: f3b4e46e334bf865d84f517efc1b30d662f807eb27e02a44cd00bdc20619ba7d
 SHA512:
-  metadata.gz: 2a654ca517d2add99189f286c81ee79cb0925b776be195245bd18405e72184be1b1f885aa131c5a32d9bf286d4971ed31d95bfbaf407dfb2a11927c979f56221
-  data.tar.gz: 551e07877e433de2027d547cf8e20f9ddd26b63fcc41949e39fe395ccbca0b74fe882c344a45a7d4072190b76495b9be406073793af3e55536523b0d0e63b8c0
+  metadata.gz: de81b47bd2e9fbc0858d086e86b37429bd35be1bc6f6b54133c81bb014ea77e52cb3e47a01c28105042e21b3777dd3b7b613181f959660633af2f78a80c09d13
+  data.tar.gz: c450251c20c43d50d48f557ea18a7160cd1fb65dd38419a62f9d513b433361a150f848daa1992f52eb65b3f12e0839955afb502251b4ff7b41dce31ed4d7cf5f

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.3', '3.4', '4.0']
+
+    steps:
+    - uses: actions/checkout@v7
+      with:
+        fetch-depth: 0
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.standard.yml

@@ -1,3 +1,4 @@
+ruby_version: 2.7.0
 ignore:
   - "test/fixture/**/*"
 

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.0.6
+
+- Fixed `Token#id` output on Ruby 3.4+: Ruby 3.4 changed `Hash#inspect`'s
+  format, which had silently changed the `id` column's output (and the
+  sort order it ties into) on those newer versions. `id` now matches
+  what Ruby 2.7-3.3 have always produced.

data/Gemfile

@@ -1,3 +1,7 @@
 source "https://rubygems.org"
 
 gemspec
+
+gem "rake"
+gem "minitest"
+gem "standard"

data/Gemfile.lock

@@ -1,42 +1,66 @@
 PATH
   remote: .
   specs:
-    referral (0.0.5)
+    referral (0.0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
-    psych (3.1.0)
-    rainbow (3.0.0)
-    rake (12.3.2)
-    rubocop (0.67.2)
-      jaro_winkler (~> 1.5.1)
+    ast (2.4.3)
+    json (2.21.2)
+    language_server-protocol (3.17.0.6)
+    lint_roller (1.1.0)
+    minitest (5.26.1)
+    parallel (1.28.0)
+    parser (3.3.12.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.9.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.4.2)
+    regexp_parser (2.12.0)
+    rexml (3.4.4)
+    rubocop (1.64.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      psych (>= 3.1.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.6)
-    ruby-progressbar (1.10.1)
-    standard (0.0.41)
-      rubocop (~> 0.67.1)
-    unicode-display_width (1.5.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.50.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.37.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.64.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    unicode-display_width (2.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17.3)
-  minitest (~> 5.0)
-  rake (~> 12.3)
+  minitest
+  rake
   referral!
   standard
 
 BUNDLED WITH
-   1.17.3
+   2.4.22

data/lib/referral/ensures_working_ruby.rb

@@ -4,7 +4,8 @@ module Referral
   class EnsuresWorkingRuby
     def call
       major, minor = RUBY_VERSION.split(".").map(&:to_i)
-      unless major >= 3 || (major == 2 && minor >= 6)
+      supported = major >= 3 || (major == 2 && minor >= 6)
+      unless supported
         warn <<-ERROR.gsub(/^ {10}/, "")
           Error: referral must be run with Ruby 2.6 or later, but this is #{RUBY_VERSION}.
                  You can often analyze older Ruby code by running this CLI with a newer

data/lib/referral/filters_tokens.rb

@@ -45,7 +45,7 @@ module Referral
       else
         token.arity.to_i == arity.to_i
       end
-    },
+    }
   }
   class FiltersTokens
     def call(tokens, options)

data/lib/referral/prints_results.rb

@@ -45,7 +45,7 @@ module Referral
     },
     arity: ->(token) {
       token.arity
-    },
+    }
 
   }
 

data/lib/referral/scans_tokens.rb

@@ -31,7 +31,7 @@ module Referral
 
         if (token = @translates_node_to_token.call(node, parent, file))
           @tokenizes_identifiers.call(node, token)
-          [token, *find_tokens(node.children[1..-1], token, file)]
+          [token, *find_tokens(node.children[1..], token, file)]
         else
           find_tokens(node.children, parent, file)
         end

data/lib/referral/sorts_tokens.rb

@@ -13,7 +13,7 @@ module Referral
         names = token.scope_and_names.map { |fq| fq.name.to_s }
         [
           *names.fill("", names.size...max_length),
-          token.file, token.line, token.column, token.id,
+          token.file, token.line, token.column, token.id
         ]
       }
     },
@@ -21,7 +21,7 @@ module Referral
       tokens.sort_by do |token|
         [
           GitStore.time(token.file, token.line).to_i,
-          token.file, token.line, token.column, token.id,
+          token.file, token.line, token.column, token.id
         ]
       end
     },
@@ -29,10 +29,10 @@ module Referral
       tokens.sort_by { |token|
         [
           -1 * GitStore.time(token.file, token.line).to_i,
-          token.file, token.line, token.column, token.id,
+          token.file, token.line, token.column, token.id
         ]
       }
-    },
+    }
   }
   class SortsTokens
     def call(tokens, options)

data/lib/referral/token_types.rb

@@ -5,7 +5,7 @@ module Referral
     double_colon: "::",
     dot: ".",
     hash: "#",
-    tilde: "~",
+    tilde: "~"
   }
   TOKEN_TYPES = {
     module: Value::NodeType.new(
@@ -15,7 +15,7 @@ module Referral
       token_type: :definition,
       reverse_identifiers: false,
       good_parent: true,
-      name_finder: ->(node) { nil }
+      name_finder: ->(node) {}
     ),
     class: Value::NodeType.new(
       name: :class,
@@ -24,7 +24,7 @@ module Referral
       token_type: :definition,
       reverse_identifiers: false,
       good_parent: true,
-      name_finder: ->(node) { nil }
+      name_finder: ->(node) {}
     ),
     constant_def: Value::NodeType.new(
       name: :constant_declaration,
@@ -183,6 +183,6 @@ module Referral
       reverse_identifiers: true,
       good_parent: false,
       name_finder: ->(node) { node.children[0] }
-    ),
+    )
   }
 end

data/lib/referral/tokenizes_identifiers.rb

@@ -25,7 +25,7 @@ module Referral
 
       [
         *find_names(node.children.first, parent),
-        @translates_node_to_token.call(node, parent, parent.file),
+        @translates_node_to_token.call(node, parent, parent.file)
       ].compact
     end
   end

data/lib/referral/value/options.rb

@@ -19,7 +19,6 @@ module Referral
       :delimiter,
       keyword_init: true
     )
-
       def self.default(overrides = {})
         DEFAULT.merge({files: Dir["**/*.rb"]}.merge(overrides))
       end
@@ -29,7 +28,7 @@ module Referral
         delimiter: " ",
         include_unnamed: false,
         sort: "file",
-        print_headers: false,
+        print_headers: false
       ).freeze
 
       def merge(new_opts)

data/lib/referral/value/token.rb

@@ -6,11 +6,10 @@ module Referral
       :name, :identifiers, :node_type, :parent, :file, :line, :column, :arity,
       keyword_init: true
     )
-
       def scope_and_names
         [
           *parent&.scope_and_names,
-          *literal_name_tokens,
+          *literal_name_tokens
         ].compact
       end
 
@@ -36,7 +35,7 @@ module Referral
       def full_name_tokens
         [
           *(include_parents_in_full_name? ? parent&.scope_and_names : []),
-          *literal_name_tokens,
+          *literal_name_tokens
         ].compact
       end
 
@@ -57,11 +56,16 @@ module Referral
       end
 
       def id
-        Digest::SHA1.hexdigest(to_h.merge(
+        h = to_h.merge(
           parent: nil,
           identifiers: identifiers&.map(&:id),
           node_type: node_type.name
-        ).inspect)[0..6]
+        )
+        # Hand-rolled instead of Hash#inspect: Ruby 3.4 changed that format
+        # (`:key=>value` -> `key: value`), which would change `id` output
+        # depending on which Ruby version generated it.
+        serialized = "{#{h.map { |k, v| "#{k.inspect}=>#{v.inspect}" }.join(", ")}}"
+        Digest::SHA1.hexdigest(serialized)[0..6]
       end
 
       protected

data/lib/referral/version.rb

@@ -1,3 +1,3 @@
 module Referral
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/referral.rb

@@ -2,11 +2,11 @@ require "referral/version"
 require "referral/error"
 
 module Referral
-  def self.run(*args, **kwargs, &blk)
+  def self.run(...)
     require "referral/ensures_working_ruby"
     Referral::EnsuresWorkingRuby.new.call
 
     require "referral/runner"
-    Runner.new.call(*args, **kwargs, &blk)
+    Runner.new.call(...)
   end
 end

data/referral.gemspec

@@ -3,27 +3,23 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "referral/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "referral"
-  spec.version       = Referral::VERSION
-  spec.authors       = ["Justin Searls"]
-  spec.email         = ["searls@gmail.com"]
+  spec.name = "referral"
+  spec.version = Referral::VERSION
+  spec.authors = ["Justin Searls"]
+  spec.email = ["searls@gmail.com"]
 
-  spec.summary       = "Scan for definitions and references in your Ruby code."
-  spec.homepage      = "https://github.com/testdouble/referral"
-  spec.license       = "MIT"
+  spec.summary = "Scan for definitions and references in your Ruby code."
+  spec.homepage = "https://github.com/testdouble/referral"
+  spec.license = "MIT"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.17.3"
-  spec.add_development_dependency "rake", "~> 12.3"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "standard"
 end

metadata

@@ -1,72 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: referral
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Justin Searls
-autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-19 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.17.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.17.3
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.3'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: standard
-  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: 
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 email:
 - searls@gmail.com
 executables:
@@ -74,9 +16,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".standard.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -114,7 +57,6 @@ licenses:
 metadata:
   homepage_uri: https://github.com/testdouble/referral
   source_code_uri: https://github.com/testdouble/referral
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -122,15 +64,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Scan for definitions and references in your Ruby code.
 test_files: []

data/.circleci/config.yml

@@ -1,32 +0,0 @@
-# Ruby CircleCI 2.0 configuration file
-#
-# Check https://circleci.com/docs/2.0/language-ruby/ for more details
-#
-version: 2
-jobs:
-  build:
-    docker:
-      - image: circleci/ruby:2.6
-
-    working_directory: ~/repo
-
-    steps:
-      - checkout
-
-      - restore_cache:
-          keys:
-            - v1-dependencies-{{ checksum "Gemfile.lock" }}
-            - v1-dependencies-
-
-      - run:
-          name: install dependencies
-          command: |
-            bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-      - save_cache:
-          paths:
-            - ./vendor/bundle
-          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-      - run: bundle exec rake
-