rbr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0586dc665c13aa156f7997779e6b2eccda40556896ef39b445c6b6d1160cd33a'
+  data.tar.gz: 10413f9d6eab1a7cfa5376b79ec37cbc91984a3915e59a850aced3c6a3515642
+SHA512:
+  metadata.gz: eb5c7da4463d013eda03ca6243189cbea36ecb5e6b70d5a30ea7e3c02030456bb3dcbe715651d1c18216d6bc120292b2d5e4256abe5349403078d3d5b420d341
+  data.tar.gz: 27730f7b04550f8e11897b685db8f2bea44f3f65ff3402a3adee045b113c185dad1e90399d6d008fda0b60cffe7f6859533f4d5b2edeaa7191c95a3004f12c58

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/coverage/
+/doc/
+*.gem
+.git/
+/pkg/
+/spec/reports/
+/tmp/
+/.yardoc
+/_yardoc/

data/.rubocop.yml

@@ -0,0 +1,7 @@
+---
+Style/Documentation:
+  Exclude:
+    - "test/**"
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    rbr (0.1.0)
+      parser
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.1)
+    parser (2.7.1.3)
+      ast (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  minitest (~> 5.0)
+  pry (~> 0.0)
+  rake (~> 10.0)
+  rbr!
+
+BUNDLED WITH
+   1.17.2

data/README.md

@@ -0,0 +1,35 @@
+# 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.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rbr'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rbr
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/exe/rbr

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "parser/current"
+require "rbr/cli"
+
+Rbr::CLI.start

data/lib/rbr/cli.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require "parser/current"
+require "rbr/query"
+
+# A semantically-aware code search tool for Ruby
+
+module Rbr
+  class CLI
+    def self.start
+      return unless check_arg_count
+
+      matcher = ARGV[0].to_sym
+      name = ARGV[1].to_sym
+      root, comments = Parser::CurrentRuby.parse_file_with_comments(ARGV[2])
+
+      nodes = Query.new(matcher => { name: name }).run(root)
+
+      nodes.each do |node|
+        puts node.pretty_print
+      end
+    end
+
+    def self.check_arg_count
+      return true if ARGV.count >= 3
+
+      warn <<~USAGE
+        Usage:
+          rbr MATCHER PATTERN FILE
+
+        Examples:
+          # find assignments to lvalue :@author in the file test/book.rb
+          rbr assignment @author test/book.rb
+
+          # find strings matching /Author.*name/ in the file test/book.rb
+          rbr str "Author.*name" test/book.rb
+      USAGE
+
+      false
+    end
+  end
+end

data/lib/rbr/matchers.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+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?
+    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])
+    end
+
+    # Assignment to a specified lvalue
+    def self.assignment(node, conds)
+      return false unless node.assignment?
+
+      !conds || node.children.first == conds[:name]
+    end
+
+    # Node is a literal int, float, or string
+    # TODO rename. Literal?
+    def self.is(node, conds)
+      return false unless node.literal?
+
+      !conds ||
+        # Ruby symbols can't start with a number, so #to_s first
+        node.children.first.to_s.to_sym == conds[:name]
+    end
+
+    # Node is a Ruby constant
+    def self.const(node, conds)
+      return false unless node.const?
+
+      !conds || node.children.last == conds[:name]
+    end
+
+    # Node is a string
+    def self.str(node, conds)
+      return false unless node.str?
+
+      !conds || node.any_child_matches?(
+        ->(n) { n.is_a?(String) && n.match?(conds[:pattern]) }
+      )
+    end
+
+    # Node is a comment
+    def self.comment(node, conds)
+      return false unless node.comment?
+
+      #TODO
+    end
+
+    # Anything other than a string
+    def self.not_str(node, conds)
+      return false if node.str?
+
+      !conds || node.children.last == conds[:name]
+    end
+  end
+end

data/lib/rbr/node.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Rbr
+  # Wraps a Parser::AST::Node object and provides convenience methods
+  class Node
+    def initialize(ast_node)
+      @ast_node = ast_node
+    end
+
+    def assignment?
+      %i[lvasgn ivasgn cvasgn gvasgn casgn masgn].include? @ast_node.type
+    end
+
+    def const?
+      :const == @ast_node.type
+    end
+
+    def literal?
+      %i[int float str].include? @ast_node.type
+    end
+
+    def method_call?
+      %i[send csend].include? @ast_node.type
+    end
+
+    def nil?
+      @ast_node.nil? || !(@ast_node.is_a? Parser::AST::Node)
+    end
+
+    def str?
+      %i[str dstr xstr].include? @ast_node.type
+    end
+
+    def children
+      @ast_node.children
+    end
+
+    def pretty_print
+      "#{@ast_node.loc.expression.line}: #{@ast_node.loc.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)
+      if root.respond_to?(:children)
+        root.children.any? { |c| any_child_matches?(match_proc, c) }
+      else
+        match_proc.call(root)
+      end
+    end
+  end
+end

data/lib/rbr/query.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "rbr/matchers"
+require "rbr/node"
+
+module Rbr
+  class Query
+    attr_reader :conditions
+
+    def initialize(conditions)
+      @conditions = conditions
+    end
+
+    def run(node)
+      node = Node.new(node) unless node.is_a?(Node)
+      return [] if node.nil?
+
+      node_matches = Matchers.match(node, conditions)
+      found_children = node.children.map { |child| run(child) }
+
+      (node_matches ? [node] : []) + found_children.flatten
+    end
+  end
+end

data/lib/rbr/version.rb

@@ -0,0 +1,3 @@
+module Rbr
+  VERSION = "0.1.0"
+end

data/rbr.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rbr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rbr"
+  spec.version       = Rbr::VERSION
+  spec.authors       = ["Eddie Lebow"]
+  spec.email         = ["elebow@users.noreply.github.com"]
+
+  spec.summary       = "Semantically-aware code search tool for Ruby"
+  #spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/elebow/rbr"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/elebow/rbr"
+    spec.metadata["changelog_uri"] = "https://github.com/elebow/rbr/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) 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.require_paths = ["lib"]
+
+  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"
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: rbr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eddie Lebow
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- elebow@users.noreply.github.com
+executables:
+- rbr
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- exe/rbr
+- lib/rbr/cli.rb
+- lib/rbr/matchers.rb
+- lib/rbr/node.rb
+- lib/rbr/query.rb
+- lib/rbr/version.rb
+- rbr.gemspec
+homepage: https://github.com/elebow/rbr
+licenses: []
+metadata:
+  homepage_uri: https://github.com/elebow/rbr
+  source_code_uri: https://github.com/elebow/rbr
+  changelog_uri: https://github.com/elebow/rbr/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Semantically-aware code search tool for Ruby
+test_files: []