scrutinize 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf550ed5c9b1d869f4f069c695689781597ab6a8
+  data.tar.gz: ab23c15b94668a85694be5e2cda6b550f3f8f2d4
+SHA512:
+  metadata.gz: a34f3266961355ce8020f8013d32722e63e833aed7764068c99cba2432109d7ed87ec9f66a5d373ceb36249db0f8ebfb90127ac7fe49432982540fe04a19b6cb
+  data.tar.gz: eb8a279edc898a3188f2430c8c9708e2d5dcb097efc6b89a2e3a9df5af6cc228588f564a4256af080b215b1e7b2882fcdfcf3122d189ee4ce427c21b555e1deb

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,63 @@
+# Scrutinize
+
+Ruby method call searcher.
+
+## Usage
+
+```
+Usage: scrutinize [options] [method_name ...]
+    -t, --targets=MANDATORY          A comma separated list of targets to search for the next set of methods on
+    -m, --methods=MANDATORY          A comma separated list of methods to search for on the last listed set of targets
+    -d, --directory=MANDATORY        The directory to search
+    -c, --config=MANDATORY           A YAML config file to load
+    -r, --ruby-version=MANDATORY     The Ruby version of the files we're searching through
+    -h, --help                       Show this message
+```
+
+### Examples
+
+**Search for calls to `puts` on any target:**
+
+```
+$ scrutinize puts
+./lib/sinatra/base.rb:1136 @env['rack.errors'].puts
+./lib/sinatra/base.rb:1416 $stderr.puts
+./test/integration/app.rb:58 puts
+...
+```
+
+**Search for calls to `puts` with *no* target:**
+
+```
+$ scrutinize -t SCRUTINIZE_NONE puts
+./test/integration/app.rb:58 puts
+```
+
+**Search for calls to `read` or `write` on the `IO` or `File` modules:**
+
+```
+$ scrutinize -t IO,File -m read,binread
+./lib/sinatra/base.rb:1275 IO.binread
+./lib/sinatra/base.rb:1275 IO.read
+./test/encoding_test.rb:13 File.read
+...
+```
+
+**Search for calls to any method on the `IO` or `File` modules:**
+
+```
+$ scrutinize -t IO,File
+./lib/sinatra/base.rb:44 File.fnmatch
+./lib/sinatra/base.rb:1275 IO.read
+./test/integration_helper.rb:26 File.expand_path
+./test/integration_helper.rb:42 IO.popen
+./test/yajl_test.rb:9 File.dirname
+...
+```
+
+## Installation
+
+```
+bundle install
+rake install
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/scrutinize

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'scrutinize'
+require 'optparse'
+require 'yaml'
+
+options      = {'triggers' => [], 'dir' => '.'}
+last_trigger = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: scrutinize [options] [method_name ...]"
+
+  opts.on("-t", "--targets", "=MANDATORY", Array, "A comma separated list of targets to search for the next set of methods on") do |t|
+    if last_trigger['targets']
+      options['triggers'] << last_trigger
+      last_trigger = {}
+    end
+
+    last_trigger['targets'] = t
+  end
+
+  opts.on("-m", "--methods", "=MANDATORY", Array, "A comma separated list of methods to search for on the last listed set of targets") do |m|
+    if last_trigger['methods']
+      options['triggers'] << last_trigger
+      last_trigger = {}
+    end
+
+    last_trigger['methods'] = m
+  end
+
+  opts.on("-d", "--directory", "=MANDATORY", String, "The directory to search") do |d|
+    options['dir'] = d
+  end
+
+  opts.on("-c", "--config", "=MANDATORY", String, "A YAML config file to load") do |c|
+    options.merge! YAML.load File.read c
+  end
+
+  opts.on("-r", "--ruby-version", "=MANDATORY", String, "The Ruby version of the files we're searching through") do |r|
+    options['ruby_version'] = r
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+last_trigger['methods'] = ARGV unless ARGV.empty?
+options['triggers'] << last_trigger
+
+Scrutinize.scan options

data/lib/scrutinize/config.rb

@@ -0,0 +1,110 @@
+require 'scrutinize/trigger'
+
+module Scrutinize
+  class Config
+    KNOWN_VERSIONS = %w(ruby18 ruby19 ruby20 ruby21 ruby22)
+
+    def initialize(opts = {})
+      @options = opts
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+    def files
+      Dir.glob(File.join(@options['dir'], "**/*.rb"))
+    end
+
+    # Public: A Trigger object based on the configured options.
+    #
+    # Returns a Trigger.
+    def trigger
+      @trigger ||= begin
+        trigger = Scrutinize::Trigger.new
+
+        # Trigger configured at top level
+        keys = %w(methods method targets target)
+        unless (@options.keys & keys).empty?
+          trigger.add @options.select { |k,v| keys.include?(k) }
+        end
+
+        # Trigger configured under trigger key
+        trigger.add @options['trigger'] if @options['trigger'].is_a?(Hash)
+
+        # Triggers configured under triggers key
+        if @options['triggers'].is_a? Array
+          @options['triggers'].each { |t| trigger.add t }
+        end
+
+        trigger
+      end
+    end
+
+    # Public: The normalized Ruby version, inferred from RUBY_VERSION and the
+    # configured version.
+    #
+    # Returns a String.
+    def ruby_version
+      @ruby_version ||= begin
+        version = @options['ruby_version'] || RUBY_VERSION
+        normalize_version version
+      end
+    end
+
+    # Public: Set a new Ruby version.
+    #
+    # value - A String Ruby version.
+    #
+    # Returns the normalized value provided.
+    def ruby_version=(value)
+      normalize_version(value).tap do |version|
+        @ruby_version = @options['ruby_version'] = version
+        @ruby_parser = parser_for_version version
+      end
+    end
+
+    # Public: A Parser instance for the configured Ruby version.
+    #
+    # Returns a Parser.
+    def ruby_parser
+      @ruby_parser ||= parser_for_version ruby_version
+    end
+
+    private 
+
+    # Normalize a Ruby version.
+    #
+    # version - A Ruby version String.
+    #
+    # Returns a String.
+    def normalize_version(version)
+      return version if KNOWN_VERSIONS.include?(version)
+
+      case version
+      when /^1\.8\./
+        'ruby18'
+      when /^1\.9\./
+        'ruby19'
+      when /^2\.0\./
+        'ruby20'
+      when /^2\.1\./
+        'ruby21'
+      when /^2\.2\./
+        'ruby22'
+      else
+        raise NotImplementedError
+      end
+    end
+
+    # Get the correct Parser class for a given Ruby version.
+    #
+    # version - A Ruby version String.
+    #
+    # Returns a Parser class.
+    def parser_for_version(version)
+      require "parser/#{version}"
+      Parser.const_get version.capitalize
+    end
+  end
+end

data/lib/scrutinize/processor.rb

@@ -0,0 +1,115 @@
+module Scrutinize
+  class Processor
+    # Process a file with a Trigger.
+    #
+    # Returns nothing.
+    def self.process(file, trigger, parser)
+      new(file, trigger, parser).process
+    end
+
+    # Initialize a Processor instance.
+    #
+    # file - the file to be processed.
+    def initialize(file, trigger, parser)
+      @file    = file
+      @trigger = trigger
+      @parser  = parser
+    end
+
+    # Process the AST of the file.
+    #
+    # Returns nothing.
+    def process
+      process_node ast
+    rescue Parser::SyntaxError
+    end
+
+    # Recurse into an Parser::AST::Node, calling appropriate process functions
+    # for it and its children nodes.
+    #
+    # node - a Parser::AST::Node object.
+    #
+    # Returns nothing.
+    def process_node(node)
+      if node?(node)
+        process_send(node) if node.type == :send
+        node.children.each { |c| process_node c }
+      end
+    end
+
+    # Process a :send Parser::AST::Node. Call any registered handler for the
+    # target/method being invoked.
+    #
+    # node - a Parser::AST::Node object.
+    #
+    # Returns nothing.
+    def process_send(node)
+      target = get_src node.children[0] if node.children[0]
+      target = target.slice(2..-1) if node.children[0] && target.start_with?('::')
+      method = node.children[1]
+
+      if @trigger.match? target, method
+        puts "#{@file}:#{node.loc.line} #{target}#{'.' if target}#{method}"
+      end
+    end
+
+    # Is an object a Parser::AST::Node.
+    #
+    # node - the object to test.
+    #
+    # Returns true/false.
+    def node?(node)
+      node.is_a? Parser::AST::Node
+    end
+
+    # Gets the source code of a given node.
+    #
+    # node - a Parser::AST::Node object.
+    #
+    # Returns a String.
+    def get_src(node)
+      range = node.loc.expression
+
+      # Line numbers start at 1
+      begin_line   = range.begin.line - 1
+      end_line     = range.end.line - 1
+      middle_lines = begin_line + 1 ... end_line - 1
+
+      # Column numbers start at 0
+      begin_column = range.begin.column
+      end_column   = range.end.column
+
+      # Beginning/ending on same line
+      if begin_line == end_line
+        return src_lines[begin_line][begin_column...end_column]
+      end
+
+      lines = []
+      lines << src_lines[begin_line][begin_column..-1]
+      lines += src_lines[middle_lines]
+      lines << src_lines[end_line][0...end_line]
+      lines.join "\n"
+    end
+
+    # The AST of the source code.
+    #
+    # Returns a Parser::AST::Node object.
+    def ast
+      @ast ||= @parser.parse src
+    end
+
+    # The source code, broken up into lines.
+    #
+    # Returns an Array of Strings.
+    def src_lines
+      @src_lines = src.lines.to_a
+    end
+
+    # The source code.
+    #
+    # Returns a String.
+    def src
+      @src ||= File.read @file
+    end
+  end
+end

data/lib/scrutinize/trigger.rb

@@ -0,0 +1,108 @@
+require 'set'
+
+module Scrutinize
+  class Trigger
+    ANY  = Set.new(['SCRUTINIZE_ANY', true, nil])
+    NONE = Set.new(['SCRUTINIZE_NONE', false])
+
+    # Instantiate a new Trigger.
+    #
+    # Returns nothing.
+    def initialize
+      @targets               = Set.new
+      @methods               = Set.new
+      @target_methods        = Set.new
+      @any_target_methods    = Set.new
+      @any_method_targets    = Set.new
+      @any_method_any_target = false
+    end
+
+    # Add targets/methods to the trigger.#
+    #
+    # criteria - A hash of targets/methods
+    #            :targets - An Array of target names to trigger on. Setting to
+    #                       `true` means all targets match. Setting to nil
+    #                       means that only calls without a target match.
+    #            :methods - An Array of method names to trigger on. Setting to
+    #                       `true` means all methods match.
+    #
+    # Returns nothing.
+    def add(criteria = {})
+      # Stop now if we're searching for everything.
+      return if @any_method_any_target
+
+      # Extract targets/methods from criteria
+      targets  = Set.new
+      targets += Array(criteria['targets']) if criteria.key?('targets')
+      targets += Array(criteria['target'])  if criteria.key?('target')
+      targets += [nil] if targets.empty? # Can't do Array(nil)
+
+      methods  = Set.new
+      methods += Array(criteria['methods']) if criteria.key?('methods')
+      methods += Array(criteria['method'])  if criteria.key?('method')
+      methods += [nil] if methods.empty? # Can't do Array(nil)
+
+      any_method = !(ANY & methods).empty?
+      any_target = !(ANY & targets).empty?
+
+      # Stop now if we're searching for everything.
+      if any_target && any_method
+        return @any_method_any_target = true
+      end
+
+      # Don't clean up methods if we're looking for all methods.
+      if !any_method
+        methods.map! &:to_sym
+        methods -= @any_target_methods
+      end
+
+      # Stop now if we're looking for any method.
+      if any_target
+        return @any_target_methods += methods
+      end
+
+      # Clean up targets, preserving no target case.
+      if !(targets & NONE).empty?
+        targets -= NONE
+        targets.map! &:to_sym
+        targets.add nil
+      else
+        targets.map! &:to_str
+      end
+      targets -= @any_method_targets
+
+      # Stop now if we're looking for any target.
+      if any_method
+        return @any_method_targets += targets
+      end
+
+      # Track all the methods/targets we've seen for faster checks.
+      @methods += methods
+      @targets += targets
+
+      # Track each target/method combo.
+      targets.each do |target|
+        methods.each do |method|
+          @target_methods.add [target, method]
+        end
+      end
+    end
+
+    # Checks if a given target/method match the configuration.
+    #
+    # target - A String target name.
+    # method - A Symbol method name.
+    #
+    # Returns boolean.
+    def match?(target, method)
+      @any_method_any_target ||
+      @any_method_targets.include?(target) ||
+      @any_target_methods.include?(method) ||
+      (
+        @targets.include?(target) &&
+        @methods.include?(method) &&
+        @target_methods.include?([target, method])
+      )
+    end
+  end
+end

data/lib/scrutinize/version.rb

@@ -0,0 +1,3 @@
+module Scrutinize
+  VERSION = "0.0.1"
+end

data/lib/scrutinize.rb

@@ -0,0 +1,13 @@
+require 'scrutinize/config'
+require 'scrutinize/processor'
+
+module Scrutinize
+  extend self
+
+  def scan(opts)
+    config = Config.new opts
+    config.files.each do |file|
+      Processor.process(file, config.trigger, config.ruby_parser)
+    end
+  end
+end

data/scrutinize.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+$:.unshift File.expand_path('../lib', __FILE__)
+require 'scrutinize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scrutinize"
+  spec.version       = Scrutinize::VERSION
+  spec.authors       = ["Ben Toews"]
+  spec.email         = ["mastahyeti@gmail.com"]
+  spec.summary       = %q{Ruby method call finder}
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["scrutinize"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "parser", "~> 2.1.9"
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/config_spec.rb

@@ -0,0 +1,80 @@
+require 'scrutinize/config'
+
+describe Scrutinize::Config do
+  describe "with unspecified ruby_version" do
+    subject { Scrutinize::Config.new }
+
+    it "uses RUBY_VERSION" do
+      expected = \
+        case RUBY_VERSION
+        when /^1\.8\./
+          'ruby18'
+        when /^1\.9\./
+          'ruby19'
+        when /^2\.0\./
+          'ruby20'
+        when /^2\.1\./
+          'ruby21'
+        when /^2\.2\./
+          'ruby22'
+        end
+
+      expect(subject.ruby_version).to eq(expected)
+    end
+
+    it "can be set to other versions" do
+      subject.ruby_version = "1.8.7"
+      expect(subject.ruby_version).to eq('ruby18')
+    end
+
+    it "parses crazy versions" do
+      subject.ruby_version = "1.8.7.0.0alpha"
+      expect(subject.ruby_version).to eq('ruby18')
+    end
+
+    it "selects a parser accordingly" do
+      subject.ruby_version = "1.8.7"
+      expect(subject.ruby_parser.to_s).to eq("Parser::Ruby18")
+    end
+
+    it "raises for bad ruby versions" do
+      expect { subject.ruby_version = "9.9.9" }.to raise_error(NotImplementedError)
+    end
+  end
+
+  describe "with specified trigger options" do
+    it "allows target/method at top level of options" do
+      c = Scrutinize::Config.new 'target' => 'File', 'method' => 'read'
+
+      expect(c.trigger.match?('File', :read)).to eq(true)
+      expect(c.trigger.match?('Foo', :read)).to eq(false)
+      expect(c.trigger.match?('File', :foo)).to eq(false)
+    end
+
+    it "allows target/method under trigger key" do
+      c = Scrutinize::Config.new(
+        'trigger' => {
+          'target' => 'File',
+          'method' => 'read'
+        }
+      )
+
+      expect(c.trigger.match?('File', :read)).to eq(true)
+      expect(c.trigger.match?('Foo', :read)).to eq(false)
+      expect(c.trigger.match?('File', :foo)).to eq(false)
+    end
+
+    it "allows target/method under triggers key" do
+      c = Scrutinize::Config.new(
+        'triggers' => [{
+          'target' => 'File',
+          'method' => 'read'
+        }]
+      )
+
+      expect(c.trigger.match?('File', :read)).to eq(true)
+      expect(c.trigger.match?('Foo', :read)).to eq(false)
+      expect(c.trigger.match?('File', :foo)).to eq(false)
+    end
+  end
+end

data/spec/trigger_spec.rb

@@ -0,0 +1,96 @@
+require 'scrutinize/trigger'
+
+describe Scrutinize::Trigger, "#match?" do
+  describe "targets matching any method" do
+    subject do
+      Scrutinize::Trigger.new.tap do |target|
+        target.add 'targets' => %w(File IO)
+      end
+    end
+
+    it "matches any method for the targets" do
+      expect(subject.match?('File', :write)).to eq(true)
+      expect(subject.match?('IO', :read)).to eq(true)
+    end
+
+    it "doesn't match methods for other targets" do
+      expect(subject.match?('Foo', :bar)).to eq(false)
+    end
+  end
+
+  describe "methods matching any target" do
+    subject do
+      Scrutinize::Trigger.new.tap do |target|
+        target.add 'methods' => %w(read write)
+      end
+    end
+
+    it "matches any targets for the methods" do
+      expect(subject.match?('Foo', :write)).to eq(true)
+      expect(subject.match?('Bar', :read)).to eq(true)
+    end
+
+    it "matches nil targets for the method" do
+      expect(subject.match?(nil, :write)).to eq(true)
+    end
+
+    it "doesn't match methods for other targets" do
+      expect(subject.match?('Foo', :bar)).to eq(false)
+    end
+  end
+
+  describe "any target matching any method" do
+    subject do
+      Scrutinize::Trigger.new.tap do |target|
+        target.add 'target' => nil, 'method' => nil
+      end
+    end
+
+    it "matches any method and any target" do
+      expect(subject.match?('Foo', :write)).to eq(true)
+      expect(subject.match?('Bar', :read)).to eq(true)
+    end
+  end
+
+  describe "specific methods and targets" do
+    subject do
+      Scrutinize::Trigger.new.tap do |target|
+        target.add 'target' => 'IO', 'methods' => %w(select read)
+        target.add 'target' => 'File', 'methods' => %w(read write)
+      end
+    end
+
+    it "matches specified methods/targets" do
+      expect(subject.match?('IO', :select)).to eq(true)
+      expect(subject.match?('IO', :read)).to eq(true)
+      expect(subject.match?('File', :read)).to eq(true)
+      expect(subject.match?('File', :write)).to eq(true)
+    end
+
+    it "doesn't match other methods/targets" do
+      expect(subject.match?('File', :select)).to eq(false)
+      expect(subject.match?('IO', :write)).to eq(false)
+      expect(subject.match?('Foo', :bar)).to eq(false)
+    end
+  end
+
+  describe "none target with specific methods" do
+    subject do
+      Scrutinize::Trigger.new.tap do |target|
+        target.add 'target' => false, 'methods' => %w(read)
+      end
+    end
+
+    it "matches specific methods with none target" do
+      expect(subject.match?(nil, :read)).to eq(true)
+    end
+
+    it "doesn't match methods with a target" do
+      expect(subject.match?('IO', :read)).to eq(false)
+    end
+
+    it "doesn't match other methods with none target" do
+      expect(subject.match?(nil, :foo)).to eq(false)
+    end
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: scrutinize
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Toews
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 
+email:
+- mastahyeti@gmail.com
+executables:
+- scrutinize
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/scrutinize
+- lib/scrutinize.rb
+- lib/scrutinize/config.rb
+- lib/scrutinize/processor.rb
+- lib/scrutinize/trigger.rb
+- lib/scrutinize/version.rb
+- scrutinize.gemspec
+- spec/config_spec.rb
+- spec/trigger_spec.rb
+homepage: 
+licenses: []
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Ruby method call finder
+test_files: []