referral 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b444d6e3e344bd102380397e714039e2b72834f1f2f6c1023837fa097d215ee
-  data.tar.gz: 46c19b9d8deccaeb7fd1e6489b765fddce2e039bd09790d7a952de429c87b36d
+  metadata.gz: c5cdd1a3baacf145aeb660dbbcdc09a25a42514ae5b6fef5b1d7dc8edd111f0a
+  data.tar.gz: b70e542db5e9a56623c2234ced091c083d15cc086068b4626efd1e90417ba1c8
 SHA512:
-  metadata.gz: 75394674def26ffe7236d85d5c8bb1bef4af3b10d752cfb4e7a1c544f75730bdd16b1e53054351e2bcf36935ce4dca8339797f32c186965c5b6b6b51773eecce
-  data.tar.gz: 4d9d68316c18f98ca8f42694bc661e2e7aa1a3549eae2757707c5745240bf23884a0800a2922765482a02e0a531da5ad354d0fcc56419d18a6bffd749b91cc2e
+  metadata.gz: 2a654ca517d2add99189f286c81ee79cb0925b776be195245bd18405e72184be1b1f885aa131c5a32d9bf286d4971ed31d95bfbaf407dfb2a11927c979f56221
+  data.tar.gz: 551e07877e433de2027d547cf8e20f9ddd26b63fcc41949e39fe395ccbca0b74fe882c344a45a7d4072190b76495b9be406073793af3e55536523b0d0e63b8c0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    referral (0.0.4)
+    referral (0.0.5)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -204,6 +204,23 @@ app/lib/presents_review_result.rb:60:2: 2019-06-02T02:38:01Z   def item_result(s
 
 `find` couldn't have told me that (I don't think)!
 
+### Recipe:  Find calls that have more than 1 argument
+
+[Recently I was upgrading the i18n gem](http://blog.testdouble.com/posts/2019-10-15-lets-hash-this-out/) and came across some bugs introduced by [this change](https://github.com/ruby-i18n/i18n/commit/5eeaad7fb35f9a30f654e3bdeb6933daa7fd421d#diff-14d9864ac07456d554843dc2a3b174a4L179). To fix the issue, I started looking at all the places `I18n.t` was called from:
+
+```
+referral --type call --exact-name I18n.t -c location,source
+```
+
+Unfortunately, this produces 250+ false positives because the predominant usage was to pass a single argument to `t`. Only calls with more than 1 argument are affected by this change. `--pattern` doesn't work very well in this codebase, because calls to `t` with multiple arguments are more likely to be multiline.
+
+```
+referral --type call --exact-name I18n.t --arity 2+ -c location,source,arity
+```
+
+This produced 27 results I could quickly skim through.
+
+
 ## Options
 
 Referral provides a lot of options. The help output of `referral --help` will
@@ -219,6 +236,7 @@ Usage: referral [options] files
         --scope [SCOPE]              Scope(s) in which to filter (e.g. Hastack#hide)
     -p, --pattern [PATTERN]          Regex pattern to filter
     -t, --type [TYPES]               Include only certain types. See Referral::TOKEN_TYPES.
+        --arity [ARITY]              Number of arguments to a method call.  (e.g. 2+)
         --include-unnamed            Include reference without identifiers (default: false)
     -s, --sort {file,scope}          (default: file). See Referral::SORT_FUNCTIONS
         --print-headers              Print header names (default: false)
@@ -231,6 +249,11 @@ A few things to note:
 * Each of `--name`, `--exact-name`, `--full-name`, `--scope`, `--type`, and `--columns`
   accept comma-separated arrays (e.g. `--name foo,bar,baz`)
 
+* `--arity` accepts a number with an optional `+` or `-`.
+  *  `--arity 0`  Match calls with 0 arguments
+  *  `--arity 1+` Match calls with 1 or more arguments
+  *  `--arity 1-` Match calls with 1 or fewer arguments
+
 * You can browse available sort functions [in
   Referral::SORT_FUNCTIONS](/lib/referral/sorts_tokens.rb) for use with
   `--sort`. Each key is the name to be specified on the command line. (If you're
@@ -255,6 +278,45 @@ A few things to note:
   the result set twice: once when parsing the AST, and again when printing
   results
 
+## Running with Ruby version managers
+
+Referral requires Ruby version >= 2.6, but your codebase may be running on something
+older.  You have a few options for using `referral`.  You could 1) change your project's
+ruby while you run `referral` and then change it back, but this seems cumbersome and
+likely to cause annoyance.  There are better ways.
+
+## Run from outside your project's working directory
+
+If you `cd ..` from your project's working directory (assuming in that context
+you are running Ruby 2.6.x), you can run `referral` commands on your codebase by passing
+the path to that codebase to referral:
+
+```
+$ referral MyAwesomeProject/
+```
+
+This works for many of `referrals` features, but isn't ideal when it comes to git;
+columns like `git_sha`, `git_author` or `git_commit_at` will show empty results.
+
+## Running with `rbenv`
+
+If you're using `rbenv`, you _could_ temporarily switch your project's ruby to 2.6.x,
+but you'd have to remember to switch it back again before running any of the code in
+the project.  To instantaneously switch to 2.6 and then back again (after the `referral`
+command finishes), do this (from your `MyAwsomeProject` directory):
+
+```
+$ RBENV_VERSION=2.6.3 referral
+```
+
+## Running with RVM
+
+The corresponding way to do this with `rvm` would be:
+
+```
+$ rvm 2.6.3 do referral
+```
+
 ## Code of Conduct
 
 This project follows Test Double's [code of

data/lib/referral/filters_tokens.rb

@@ -35,6 +35,17 @@ module Referral
         true
       end
     },
+    arity: ->(token, arity) {
+      if token.arity.nil?
+        false
+      elsif arity.end_with? "+"
+        token.arity.to_i >= arity.to_i
+      elsif arity.end_with? "-"
+        token.arity.to_i <= arity.to_i
+      else
+        token.arity.to_i == arity.to_i
+      end
+    },
   }
   class FiltersTokens
     def call(tokens, options)

data/lib/referral/parses_options.rb

@@ -25,6 +25,7 @@ module Referral
         op.on("--scope [SCOPE]", Array, "Scope(s) in which to filter (e.g. Hastack#hide)")
         op.on("-p", "--pattern [PATTERN]", Regexp, "Regex pattern to filter")
         op.on("-t", "--type [TYPES]", Array, "Include only certain types. See Referral::TOKEN_TYPES.")
+        op.on("--arity [ARITY]", "Number of arguments to a method call.  (e.g. 2+)")
         op.on("--include-unnamed", TrueClass, "Include reference without identifiers (default: false)")
         op.on("-s", "--sort {file,scope}", "(default: file). See Referral::SORT_FUNCTIONS")
         op.on("--print-headers", TrueClass, "Print header names (default: false)")

data/lib/referral/prints_results.rb

@@ -43,6 +43,9 @@ module Referral
     git_commit_at: ->(token) {
       GitStore.time(token.file, token.line)&.utc&.iso8601
     },
+    arity: ->(token) {
+      token.arity
+    },
 
   }
 

data/lib/referral/token_types.rb

@@ -108,7 +108,8 @@ module Referral
       token_type: :reference,
       reverse_identifiers: true,
       good_parent: true,
-      name_finder: ->(node) { node.children[1] }
+      name_finder: ->(node) { node.children[1] },
+      arity_finder: ->(node) { node.children.last&.children&.compact&.count || 0 }
     ),
     function_call: Value::NodeType.new(
       name: :function_call,
@@ -117,7 +118,8 @@ module Referral
       token_type: :reference,
       reverse_identifiers: true,
       good_parent: false,
-      name_finder: ->(node) { node.children[0] }
+      name_finder: ->(node) { node.children[0] },
+      arity_finder: ->(node) { node.children.last&.children&.compact&.count || 0 }
     ),
     local_var: Value::NodeType.new(
       name: :local_var,

data/lib/referral/translates_node_to_token.rb

@@ -12,7 +12,8 @@ module Referral
         parent: parent,
         file: file,
         line: node.first_lineno,
-        column: node.first_column
+        column: node.first_column,
+        arity: type&.arity_finder&.call(node)
       )
     end
   end

data/lib/referral/value/node_type.rb

@@ -8,6 +8,7 @@ module Referral
       :token_type,
       :reverse_identifiers,
       :good_parent,
+      :arity_finder,
       keyword_init: true
     )
     end

data/lib/referral/value/options.rb

@@ -10,6 +10,7 @@ module Referral
       :pattern,
       :type,
       :include_unnamed,
+      :arity,
       # Sorting
       :sort,
       # Printing

data/lib/referral/value/token.rb

@@ -3,7 +3,7 @@ require "digest/sha1"
 module Referral
   module Value
     class Token < Struct.new(
-      :name, :identifiers, :node_type, :parent, :file, :line, :column,
+      :name, :identifiers, :node_type, :parent, :file, :line, :column, :arity,
       keyword_init: true
     )
 

data/lib/referral/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: referral
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Justin Searls
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler