rbr 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc590b6d8db926ac5205740e3efc3251a2064e8e77e743e0ffb9fe2bd61c2e0b
-  data.tar.gz: 2fa0ec5a1ff805126928d983f5881af49e24f1aa7dc9a299470481e1414a300c
+  metadata.gz: 8b7d0b6b8d0cf90f5663842f750f2a54aca82bbeac46ab4ba6c542889a1dea98
+  data.tar.gz: f54146ad71167e7dd56d4038457c7388f130e67d539c179490f5ee773b642e1a
 SHA512:
-  metadata.gz: e199c6351622d34f292ea65045ee34730ca7e13812f33a2d408012f4e2e1093993ce65b4896345c154cbac5256b3e698c54b74d9f59111693c1e24a58b6c406d
-  data.tar.gz: 8a0770f82f24932bb8072d7413e024205282c7345fe9a82fea40b05310e3609946803ff7ced7be4c1154b53bc47e1472062898d642d4ffdda2ea1883e241c44a
+  metadata.gz: ab183917580958f97adfbd4e2144f501561c16eb4e330f0c0c806f33407d6402cb3fe87cc85f393f3083ab35dc975cb2ed6e5636cdc430b0b47c5e01ed2e11f3
+  data.tar.gz: 2cf02448bf77d5c58f8f7f6d68067085ec424d723d7a5515254ba50975e687b2f19681f65a30a1b8fa717b9a2ac392ea2ec2a0bbe0fca73662186f877581355c

data/README.md

@@ -1,87 +1,87 @@
 # Rbr
 
-Rbr is a code search tool that parses Ruby code so you can query over certain semantic
-constructs.
+Rbr is a code search tool that parses Ruby code so you can query over certain semantic constructs.
+
+This differs from a file contents search (like grep) in that rbr understands Ruby grammar. This allows you to search your codebase for, say, every place that a method is called without matching the method definition or other occurrences of the method name.
 
 ## Usage examples
 
-assignment to an lvalue named `@author`
+- Find all assignments to an lvalue named `@author`, but not any other references to that variable.
 
-```sh
-$ rbr assignment :@author test/fixtures/book.rb
-test/fixtures/book.rb:5: @author = author
-```
+    ```sh
+    $ rbr assignment :@author test/fixtures/book.rb
+    test/fixtures/book.rb:5: @author = author
+    ```
 
-int or float with value `5`
+- Find any int or float with value `5`, but not any strings or comments that contain 5.
 
-```sh
-$ rbr number 5 test/fixtures/book.rb
-test/fixtures/book.rb:12: 5
-```
+    ```sh
+    $ rbr number 5 test/fixtures/book.rb
+    test/fixtures/book.rb:12: 5
+    ```
 
-string matching the pattern `/ring/`
+- Find all strings matching the pattern `/ring/`.
 
-```sh
-$ rbr string ring test/fixtures/book.rb
-test/fixtures/book.rb:13: "a string!"
-```
+    ```sh
+    $ rbr string ring test/fixtures/book.rb
+    test/fixtures/book.rb:13: "a string!"
+    ```
 
-literal (int, float, or string) with the value `5`
+- Find all literals (int, float, or string) with the value `5`.
 
-```sh
-$ rbr literal 5 test/fixtures/book.rb
-test/fixtures/book.rb:12: 5
-test/fixtures/book.rb:49: "5"
-```
+    ```sh
+    $ rbr literal 5 test/fixtures/book.rb
+    test/fixtures/book.rb:12: 5
+    test/fixtures/book.rb:49: "5"
+    ```
 
-comment matching the pattern `/great/`
+- Find all comments matching the pattern `/great/`, but not any uncommented Ruby code.
 
-```sh
-$ rbr comment great test/fixtures/book.rb
-test/fixtures/book.rb:1: # This is a great class
-```
+    ```sh
+    $ rbr comment great test/fixtures/book.rb
+    test/fixtures/book.rb:1: # This is a great class
+    ```
 
-call of a method named `great_method`
+- Find all calls of a method named `great_method`, but not the definition or any other appearances of that identifier.
 
-```sh
-$ rbr method_call :great_method test/fixtures/book.rb
-test/fixtures/book.rb:27: book.great_method
-test/fixtures/book.rb:50: book.send(:great_method)
-```
+    ```sh
+    $ rbr method_call :great_method test/fixtures/book.rb
+    test/fixtures/book.rb:27: book.great_method
+    test/fixtures/book.rb:50: book.send(:great_method)
+    ```
 
-statement that updates an ActiveRecord model attribute named `title`
+- Find all statements that update an ActiveRecord model attribute named `title`.
 
-```sh
-$ rbr ar_update :title test/fixtures/book.rb
-test/fixtures/book.rb:21: book.title = "Great Title"
-test/fixtures/book.rb:27: book.update!(title: "Great Title")
-test/fixtures/book.rb:31: book.send(:update_column, :title, "Great Title")
-```
+    ```sh
+    $ rbr ar_update :title test/fixtures/book.rb
+    test/fixtures/book.rb:21: book.title = "Great Title"
+    test/fixtures/book.rb:27: book.update!(title: "Great Title")
+    test/fixtures/book.rb:31: book.send(:update_column, :title, "Great Title")
+    ```
 
-rbr is the wrong tool for the following situations:
+### rbr is the *wrong tool* for the following situations:
 
-appearance of the string "author" in the source
+- Find all appearance of "author" in a codebase.
 
-```sh
-$ grep "author"
-```
+    ```sh
+    $ grep "author"
+    ```
 
-symbol named :author
+- Find all occurrences of the symbol `:author`. Symbols are easy to match in Ruby syntax, so you can use grep.
 
-```sh
-$ grep ":author"
-```
+    ```sh
+    $ grep ":author\b"
+    ```
 
-definition of any function named "publish"
+- Find the definition of any function named `publish`. Definitions are easy to match in Ruby syntax, so you can use grep.
 
-```sh
-$ grep "def publish"
-```
+    ```sh
+    $ grep "def publish\b"
+    ```
 
 ## Installation
 
-Rbr is intended to be used as a command-line program. Install the executable `rbr`
-with:
+Rbr is intended to be used as a command-line program. Install the executable `rbr` with:
 
 ```
 gem install rbr
@@ -89,18 +89,12 @@ gem install rbr
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies. Then,
-run `rake test` to run the tests or `bundle exec rbr` to run the local copy.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests or `bundle exec rbr` to run the local copy.
 
 ## License
 
-This program is free software: you can redistribute it and/or modify it under the
-terms of the GNU General Public License as published by the Free Software Foundation,
-either version 3 of the License, or (at your option) any later version.
+This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
-This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
-without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
-PURPOSE. See the GNU General Public License for more details.
+This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License along with this
-program. If not, see <https://www.gnu.org/licenses/>.
+You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.

data/lib/rbr/matchers.rb

@@ -77,7 +77,7 @@ module Rbr
       return false unless hash_arg.is_a?(Node)
 
       hash_arg.children.any? do |child|
-        child.is_a?(Node) && child.children[0].value == name
+        child.is_a?(Node) && child.type == :pair && child.children[0].value == name
       end
     end
 

data/lib/rbr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rbr
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbr
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Eddie Lebow
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser