call_searcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec09541488a9824d627522654b9c860fc6eb253d1156aa6e689da48013426e08
+  data.tar.gz: 2614c0df4752eb151ac47c9cc0b313c2609a725a78d73e4ef2815461dbeb0f85
+SHA512:
+  metadata.gz: 2bf7befd237982b4a6b2cbc9d985b63dbdd8ab9f0b1ca66cc2a0c5f5c381efe7882740e81dd51b8c84646aea673cfde5cb8c7deb58562b154a389e2fc9a4012c
+  data.tar.gz: 0f6211615e827d2ab58da58c791c2b0acf0875359c159cecea59406d368190f49cfcfc6a30bc0c88963497a4bd4b6e9586715a1b2ad0fb93605f85c5d4da1a79

data/.circleci/config.yml

@@ -0,0 +1,40 @@
+version: 2 # use CircleCI 2.0
+jobs:
+  build:
+    parallelism: 1
+    docker:
+      - image: mtsmfm/ruby-trunk
+        environment:
+          BUNDLE_JOBS: 2
+          BUNDLE_PATH: vendor/bundle
+    steps:
+      - checkout
+      - run:
+          name: Install bundler
+          command: |
+            gem install bundler
+            bundler update --bundler
+      - run:
+          name: Which bundler?
+          command: bundle -v
+      - restore_cache:
+          keys:
+            - bundle-v2-{{ checksum "Gemfile.lock" }}
+            - bundle-v2-
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - save_cache:
+          key: demo-bundle-v2-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run rspec in parallel
+          command: |
+            bundle exec rspec --profile 10 \
+                              --format RspecJunitFormatter \
+                              --out test_results/rspec.xml \
+                              --format progress \
+                              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+      - store_test_results:
+          path: test_results

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    call_searcher (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  call_searcher!
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec_junit_formatter
+
+BUNDLED WITH
+   2.0.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 hkdnet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# CallSearcher
+
+A static analyzer which helps you know where a method is called.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'call_searcher'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install call_searcher
+
+## Usage
+
+```ruby
+require 'call_searcher'
+
+s = CallSearcher::Searcher.new { |e| e.mid == :method_name }
+
+result = s.search_dir(root_dir: 'path/to/your/repo', path: '{app,lib,spec}', github: 'org/repo')
+
+result.each do |e|
+  puts e.github_url
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/hkdnet/call_searcher.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "call_searcher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/call_searcher.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "call_searcher/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "call_searcher"
+  spec.version       = CallSearcher::VERSION
+  spec.authors       = ["hkdnet"]
+  spec.email         = ["satoko.itse@gmail.com"]
+
+  spec.summary       = "ast searcher"
+  spec.homepage      = "https://github.com/hdknet/call_searcher"
+  spec.license       = "MIT"
+
+  # 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('..', __FILE__)) 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"]
+
+  # We need `RubyVM::AbstractSyntaxTree`
+  spec.required_ruby_version = '>= 2.6'
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/docker-compose.yml

@@ -0,0 +1,9 @@
+---
+version: "3"
+services:
+  ruby:
+    image: mtsmfm/ruby-trunk
+    volumes:
+      - ".:/src"
+    working_dir: /src
+    command: ./test.sh

data/lib/call_searcher.rb

@@ -0,0 +1,9 @@
+require "call_searcher/version"
+
+module CallSearcher
+  # Your code goes here...
+end
+
+require 'call_searcher/context'
+require 'call_searcher/method_call'
+require 'call_searcher/searcher'

data/lib/call_searcher/context.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CallSearcher
+  Context = Struct.new(:root_dir, :github, :path, keyword_init: true)
+end

data/lib/call_searcher/method_call.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module CallSearcher
+  class MethodCall
+    attr_reader :node
+
+    def initialize(node:, context:)
+      @node = node
+      @context = context
+    end
+
+    def type
+      @type ||= node.type
+    end
+
+    def receiver
+      case type
+      when :FCALL, :VCALL
+        nil
+      else
+        node.children[0]
+      end
+    end
+
+    def mid
+      case type
+      when :FCALL, :VCALL
+        node.children[0]
+      else
+        node.children[1]
+      end
+    end
+
+    def location
+      "#{@context.path}:#{@node.first_lineno}"
+    end
+
+    def inspect
+      "<#{self.class} #{type}@#{location}>"
+    end
+
+    def github_url
+      if @context.github
+        "https://github.com/#{@context.github}/blob/master/#{relative_path}#L#{@node.first_lineno}"
+      end
+    end
+
+    def relative_path
+      Pathname.new(@context.path).relative_path_from(Pathname.new(@context.root_dir))
+    end
+  end
+end

data/lib/call_searcher/searcher.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module CallSearcher
+  class Searcher
+    def initialize(&blk)
+      @condition = blk || ->(*) { true }
+    end
+
+    def search_dir(root_dir: '.', path:, github: nil)
+      path = File.expand_path(path, root_dir)
+      context = CallSearcher::Context.new(root_dir: root_dir, github: github)
+      Dir.glob(File.join(path, "**", "*.rb")).reduce([]) do |arr, f|
+        if File.file?(f)
+          arr + search(file: f, context: context)
+        end
+      end
+    end
+
+    def search(file:, context: nil)
+      context = context&.dup || CallSearcher::Context.new
+      context.path = file
+
+      ast = RubyVM::AbstractSyntaxTree.parse_file(file)
+
+      filter(ast, context)
+    end
+
+    private
+
+    def filter(node, context)
+      ret = node.children.grep(RubyVM::AbstractSyntaxTree::Node).flat_map do |child|
+        filter(child, context)
+      end
+
+      case node.type
+      when :CALL, :QCALL, :OPCALL, :FCALL, :VCALL
+        method_call = CallSearcher::MethodCall.new(node: node, context: context)
+        if @condition.call(method_call)
+          ret << method_call
+        end
+      else
+        nil
+      end
+
+      ret
+    end
+  end
+end

data/lib/call_searcher/version.rb

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

data/test.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+bundle update --bundler
+
+bundle exec rake spec

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: call_searcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hkdnet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- satoko.itse@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- call_searcher.gemspec
+- docker-compose.yml
+- lib/call_searcher.rb
+- lib/call_searcher/context.rb
+- lib/call_searcher/method_call.rb
+- lib/call_searcher/searcher.rb
+- lib/call_searcher/version.rb
+- test.sh
+homepage: https://github.com/hdknet/call_searcher
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+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: ast searcher
+test_files: []