rbr 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0586dc665c13aa156f7997779e6b2eccda40556896ef39b445c6b6d1160cd33a'
-  data.tar.gz: 10413f9d6eab1a7cfa5376b79ec37cbc91984a3915e59a850aced3c6a3515642
+  metadata.gz: 8f991cd863713e0995b19ec6dd66772030342e9af5ef18441ed14afe7c68a24d
+  data.tar.gz: a12bb9d633f5b33dbd78034a26915e4168deefa306d5ec567adf672b02d4cf34
 SHA512:
-  metadata.gz: eb5c7da4463d013eda03ca6243189cbea36ecb5e6b70d5a30ea7e3c02030456bb3dcbe715651d1c18216d6bc120292b2d5e4256abe5349403078d3d5b420d341
-  data.tar.gz: 27730f7b04550f8e11897b685db8f2bea44f3f65ff3402a3adee045b113c185dad1e90399d6d008fda0b60cffe7f6859533f4d5b2edeaa7191c95a3004f12c58
+  metadata.gz: 36c06cff179b606e84e217adfc1233f0fe9b817acb749c780230959445b7585ac6a39ac41e3ddef4a58399935d3ad8602b51fe1d3a5d13e9ea90e7251ff01f68
+  data.tar.gz: 76040e738fb9c97400836106c368eafa9e1a93112622d9f13ef86f77f9cd9d54a477a4bb9f42c7dc5f237c14a99ea4cbe3adfe4d767b354cbd84e3d6a547a80f

data/.rubocop.yml

@@ -1,4 +1,18 @@
 ---
+require:
+  - rubocop-minitest
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6
+  Exclude:
+    - "test/fixtures/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**"
+
 Style/Documentation:
   Exclude:
     - "test/**"

data/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in rbr.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rbr (0.1.0)
+    rbr (0.2.0)
       parser
 
 GEM
@@ -16,7 +16,7 @@ GEM
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (10.5.0)
+    rake (13.0.1)
 
 PLATFORMS
   ruby
@@ -25,7 +25,7 @@ DEPENDENCIES
   bundler (~> 1.17)
   minitest (~> 5.0)
   pry (~> 0.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rbr!
 
 BUNDLED WITH

data/README.md

@@ -1,35 +1,67 @@
 # Rbr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rbr`. To experiment with that code, run `bin/console` for an interactive prompt.
+Rbr is a code search tool that parses Ruby code so you can query over certain semantic
+constructs.
+
+## Usage examples
+
+```sh
+# assignment to an lvalue named `@author`
+$ rbr assignment :@author test/fixtures/book.rb
+5: @author = author
+
+# int or float
+$ rbr number 5 test/fixtures/book.rb
+12: 5
+
+# string
+$ rbr string ring test/fixtures/book.rb
+13: "a string!"
+
+# a literal (int, float, or string)
+$ rbr literal 5 test/fixtures/book.rb
+12: 5
+49: "5"
+
+# comments matching the pattern /great/
+$ rbr comment great test/fixtures/book.rb
+1: # This is a great class
+
+# find all calls of a method named `great_method`
+$ rbr method_call :great_method test/fixtures/book.rb
+27: book.update!(title: "Great Title")
+50: book.send(:update!, title: "Great Title")
+
+# statements that update an ActiveRecord model attribute named `title`
+$ rbr ar_update :title test/fixtures/book.rb
+21: book.title = "Great Title"
+27: book.update!(title: "Great Title")
+31: book.send(:update_column, :title, "Great Title")
+```
 
-TODO: Delete this and the text above, and describe your gem
+rbr is the wrong tool for the following situations:
 
-## Installation
+```sh
+# find any appearance of the string "author" in the source
+$ grep "author"
 
-Add this line to your application's Gemfile:
+# find a symbol named :author
+$ grep ":author"
 
-```ruby
-gem 'rbr'
+# find the definition of any function named "publish"
+$ grep "def publish"
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install rbr
+## Installation
 
-## Usage
+Rbr is intended to be used as a command-line program. Install the executable `rbr`
+with:
 
-TODO: Write usage instructions here
+```
+gem install rbr
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rbr.
+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.

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/TODO

@@ -0,0 +1 @@
+not_str matcher

data/exe/rbr

@@ -5,4 +5,4 @@
 require "parser/current"
 require "rbr/cli"
 
-Rbr::CLI.start
+Rbr::CLI.new.start

data/lib/rbr/cli.rb

@@ -1,29 +1,44 @@
-#!/usr/bin/env ruby
-
 # frozen_string_literal: true
 
 require "parser/current"
-require "rbr/query"
 
-# A semantically-aware code search tool for Ruby
+require "rbr/query"
 
 module Rbr
   class CLI
-    def self.start
-      return unless check_arg_count
+    def initialize
+      check_arg_count
+
+      @matcher = ARGV[0].to_sym
+      @condition = ARGV[1]
+    end
 
-      matcher = ARGV[0].to_sym
-      name = ARGV[1].to_sym
-      root, comments = Parser::CurrentRuby.parse_file_with_comments(ARGV[2])
+    def start
+      filenames.each do |filename|
+        root, comments = Parser::CurrentRuby.parse_file_with_comments(filename)
 
-      nodes = Query.new(matcher => { name: name }).run(root)
+        matching_nodes = Query.new(@matcher, @condition).run(root, comments)
 
-      nodes.each do |node|
-        puts node.pretty_print
+        matching_nodes.each { |node| puts node.pretty_print }
+      rescue EncodingError
+        warn "# Encoding error parsing #{filename}"
       end
     end
 
-    def self.check_arg_count
+    def filenames
+      ARGV[2..].map { |arg| expand_path(arg) }
+               .flatten
+               .select { |filename| File.file?(filename) }
+    end
+
+    def expand_path(path)
+      return [path] if File.file?(path)
+
+      # if path is not a file, then glob all .rb files beneath it
+      Dir.glob("#{path}/**/*.rb")
+    end
+
+    def check_arg_count
       return true if ARGV.count >= 3
 
       warn <<~USAGE

data/lib/rbr/comment_node.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Rbr
+  # Wraps a Parser::Source::Comment object and provides convenience methods
+  class CommentNode
+    def initialize(parser_comment)
+      @parser_comment = parser_comment
+    end
+
+    def expression
+      @parser_comment.loc.expression
+    end
+
+    def pretty_print
+      "#{expression.line}: #{@parser_comment.text}"
+    end
+  end
+end

data/lib/rbr/matchers.rb

@@ -3,71 +3,106 @@
 module Rbr
   # methods for determining if a node matches given conditions
   class Matchers
-    def self.match(node, query)
-      query.map do |matcher, conds|
-        send(matcher, node, conds)
-      end.all?  #TODO any? or all?
+    def self.match(node, matcher, condition)
+      send(matcher, node, condition)
+    end
+
+    # Method call
+    def self.method_call(node, name)
+      name && node.method_call?(name)
     end
 
     # Updating an ActiveRecord model attribute
     def self.ar_update(node, name)
-      attribute_name = conds[:name]
-      matches = if attribute_name
-                  node.children.first == attribute_name
-                else
-                  true # everything matches if no condition
-                end
-
-      node.method_call? &&
-        node.children[1] == :update &&
-        node.children[1].is_a_hash_containing_node(children: [:name])
+      name &&
+        (
+          ar_update_hash(node, name) ||
+          ar_update_positional(node, name) ||
+          ar_update_dynamic_method(node, name) ||
+          ar_update_attributes(node, name) ||
+          ar_update_hash_element(node, name)
+        )
     end
 
     # Assignment to a specified lvalue
-    def self.assignment(node, conds)
-      return false unless node.assignment?
-
-      !conds || node.children.first == conds[:name]
+    def self.assignment(node, name)
+      name &&
+        node.assignment? &&
+        node.value == name
     end
 
     # Node is a literal int, float, or string
-    # TODO rename. Literal?
-    def self.is(node, conds)
-      return false unless node.literal?
+    def self.literal(node, value)
+      number(node, value) || str(node, value)
+    end
 
-      !conds ||
-        # Ruby symbols can't start with a number, so #to_s first
-        node.children.first.to_s.to_sym == conds[:name]
+    # Node is a literal int or float
+    def self.number(node, value)
+      value &&
+        node.number? &&
+        node.value.to_s == value
     end
 
     # Node is a Ruby constant
-    def self.const(node, conds)
-      return false unless node.const?
-
-      !conds || node.children.last == conds[:name]
+    def self.const(node, name)
+      name &&
+        node.const? &&
+        node.children.last == name
     end
 
     # Node is a string
-    def self.str(node, conds)
-      return false unless node.str?
+    def self.str(node, pattern)
+      pattern &&
+        node.str? &&
+        node.any_descendant_matches?(
+          ->(n) { n.is_a?(String) && n.match?(pattern) }
+        )
+    end
+
+    private
 
-      !conds || node.any_child_matches?(
-        ->(n) { n.is_a?(String) && n.match?(conds[:pattern]) }
+    private_class_method def self.ar_update_hash(node, name)
+      return false unless node.method_call?(
+        %i[update update! assign_attributes update_attributes update_attributes!
+           update_columns update_all upsert upsert_all insert insert! insert_all
+           insert_all!]
       )
+
+      hash_arg = if node.children[3]&.type == :hash
+                   node.children[3]
+                 else
+                   node.children[2]
+                 end
+
+      return false unless hash_arg.is_a?(Node)
+
+      hash_arg.children.any? do |child|
+        child.is_a?(Node) && child.children[0].value == name
+      end
     end
 
-    # Node is a comment
-    def self.comment(node, conds)
-      return false unless node.comment?
+    private_class_method def self.ar_update_positional(node, name)
+      return false unless node.method_call?(
+        %i[write_attribute update_attribute update_column]
+      )
 
-      #TODO
+      node.children[2].value == name
     end
 
-    # Anything other than a string
-    def self.not_str(node, conds)
-      return false if node.str?
+    private_class_method def self.ar_update_dynamic_method(node, name)
+      node.method_call?("#{name}=".to_sym)
+    end
+
+    private_class_method def self.ar_update_attributes(node, name)
+      node.method_call?(:attributes=) &&
+      node.children.last.type == :hash &&
+      node.children.last.children.any? do |child|
+        child.is_a?(Node) && child.children[0].value == name
+      end
+    end
 
-      !conds || node.children.last == conds[:name]
+    private_class_method def self.ar_update_hash_element(node, name)
+      node.method_call?(:[]=) && node.children[-2].value == name
     end
   end
 end

data/lib/rbr/node.rb

@@ -12,15 +12,25 @@ module Rbr
     end
 
     def const?
-      :const == @ast_node.type
+      @ast_node.type == :const
     end
 
     def literal?
       %i[int float str].include? @ast_node.type
     end
 
-    def method_call?
-      %i[send csend].include? @ast_node.type
+    def number?
+      %i[int float].include? @ast_node.type
+    end
+
+    def method_call?(names)
+      %i[send csend].include?(@ast_node.type) &&
+        begin
+          names = [names] unless names.is_a?(Array)
+
+          names.include?(children[1]) ||
+            (children[1] == :send && names.include?(children[2].value))
+        end
     end
 
     def nil?
@@ -31,19 +41,37 @@ module Rbr
       %i[str dstr xstr].include? @ast_node.type
     end
 
+    def type
+      @ast_node.type
+    end
+
+    def expression
+      @ast_node.loc.expression
+    end
+
     def children
-      @ast_node.children
+      @ast_node.children.map do |child|
+        if child.is_a?(Parser::AST::Node)
+          Rbr::Node.new(child)
+        else
+          child
+        end
+      end
+    end
+
+    def value
+      @ast_node.children[0]
     end
 
     def pretty_print
-      "#{@ast_node.loc.expression.line}: #{@ast_node.loc.expression.source}"
+      "#{expression.line}: #{expression.source}"
     end
 
     # Call the the proc, passing in this node and all children recursively. Return
     # true if any call evaluates to true.
-    def any_child_matches?(match_proc, root = self)
+    def any_descendant_matches?(match_proc, root = self)
       if root.respond_to?(:children)
-        root.children.any? { |c| any_child_matches?(match_proc, c) }
+        root.children.any? { |c| any_descendant_matches?(match_proc, c) }
       else
         match_proc.call(root)
       end

data/lib/rbr/query.rb

@@ -1,21 +1,38 @@
 # frozen_string_literal: true
 
 require "rbr/matchers"
+require "rbr/comment_node"
 require "rbr/node"
 
 module Rbr
   class Query
-    attr_reader :conditions
+    attr_reader :matcher, :condition
 
-    def initialize(conditions)
-      @conditions = conditions
+    def initialize(matcher, condition)
+      @matcher = matcher
+      @condition = condition
+
+      if matcher == :comment
+        alias run run_comments
+      else
+        alias run run_tree
+
+        if condition.is_a?(String) && condition.start_with?(":")
+          @condition = condition[1..].to_sym
+        end
+      end
+    end
+
+    def run_comments(_node, comments)
+      comments.select { |comment| comment.text.match?(condition) }
+              .map { |comment| CommentNode.new(comment) }
     end
 
-    def run(node)
+    def run_tree(node, _comments = [])
       node = Node.new(node) unless node.is_a?(Node)
       return [] if node.nil?
 
-      node_matches = Matchers.match(node, conditions)
+      node_matches = Matchers.match(node, matcher, condition)
       found_children = node.children.map { |child| run(child) }
 
       (node_matches ? [node] : []) + found_children.flatten

data/lib/rbr/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rbr
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/rbr.gemspec

@@ -31,11 +31,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
 
   spec.add_dependency "parser"
 
   spec.add_development_dependency "bundler", "~> 1.17"
   spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry", "~> 0.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rbr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Eddie Lebow
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-05 00:00:00.000000000 Z
+date: 2020-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 description: 
 email:
 - elebow@users.noreply.github.com
@@ -94,8 +94,10 @@ files:
 - Gemfile.lock
 - README.md
 - Rakefile
+- TODO
 - exe/rbr
 - lib/rbr/cli.rb
+- lib/rbr/comment_node.rb
 - lib/rbr/matchers.rb
 - lib/rbr/node.rb
 - lib/rbr/query.rb
@@ -115,7 +117,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="