ast_search 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3657c57448d0aa9c6d91510a7b3e160497fd1fc
+  data.tar.gz: 70259aabe4ba27ec24885b2fa51591323429f68c
+SHA512:
+  metadata.gz: 0c5b19f69f4df44f5b22ffedf8eef8246c010fc0ccaed2f9f2298f8ddfbed08550f1c8ae8e10c908e8d2b7aaa74171e6b0b730e84832ef919bef73eb84a4c27f
+  data.tar.gz: c7550afc554fbb9a6cfc0e7e4715511033174b7b9d592057821bff299633ad9f43bbafd996ecd177db9d17ad66bb6c8f9f3ba63374f86ce5782df8888e013600

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/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.3

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 ast_search.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    ast_search (0.1.0)
+      parser (>= 2.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.0)
+    parser (2.5.1.2)
+      ast (~> 2.4.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.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ast_search!
+  bundler (~> 1.16)
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/LICENSE.txt

@@ -0,0 +1,17 @@
+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,78 @@
+# AstSearch
+
+Ruby code analyzer powered by [parser](https://github.com/whitequark/parser) and [ast](https://github.com/whitequark/ast).
+
+So far the public API is limited to a single function:
+```ruby
+AstSearch.find_external_classes(ruby_source)
+```
+
+It finds references to classes defined outside of the parsed source code, e.g.:
+```
+irb(main):001:0> class Foo
+irb(main):002:1> end
+=> nil
+irb(main):003:0> AstSearch.find_external_classes <<-SRC
+irb(main):004:0" class Bar
+irb(main):005:0"   Foo.hello
+irb(main):006:0" end
+irb(main):007:0" SRC
+=> [Foo]
+```
+
+### Hm, so how can it be useful?
+
+You can build a rake task that scans database migrations for occurrences of model classes.
+In case of a Rails app it would be something like this:
+```ruby
+task find_models_in_migrations: :environment do
+  Dir[Rails.root.join("db/migrate/*.rb")].each do |path|
+    models = AstSearch.find_external_classes(IO.read(path)).select do |klass|
+      kalss != ActiveRecord::Base && klass.ancestors.include?(ActiveRecord::Base)
+    end
+
+    if models.any?
+      puts path
+      models.each { |model| puts model }
+    end
+  end
+end
+```
+
+Though, the idea of looking something up in code is not limited to migrations.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ast_search'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ast_search
+
+## Usage
+
+```ruby
+require "ast_search"
+
+source = IO.read("path/to/source_code.rb")
+
+AstSearch.find_external_classes(source)
+```
+
+## 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/letmein/ast_search.

data/Rakefile

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

data/ast_search.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ast_search/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ast_search"
+  spec.version       = AstSearch::VERSION
+  spec.authors       = ["Yuriy Kharchenko"]
+  spec.email         = ["rm1945@yandex.ru"]
+
+  spec.summary       = %q{Parse Ruby code & search for AST nodes}
+  spec.description   = %q{Parse Ruby code & search for AST nodes}
+  spec.homepage      = "https://github.com/letmein/ast_search"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  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('..', __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"]
+
+  spec.add_dependency "parser", ">= 2.3"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ast_search"
+
+# 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/lib/ast_search.rb

@@ -0,0 +1,24 @@
+require "pry"
+require "parser/current"
+
+require "ast_search/version"
+require "ast_search/name_path"
+require "ast_search/node"
+require "ast_search/queries/class_defs"
+require "ast_search/queries/const_occurrences"
+require "ast_search/queries/external_classes"
+
+module AstSearch
+  def self.parse(src)
+    Parser::CurrentRuby.parse(src)
+  end
+
+  #
+  # Public API
+  #
+
+  def self.find_external_classes(src)
+    ast = parse(src)
+    AstSearch::Queries::ExternalClasses.new.call(ast)
+  end
+end

data/lib/ast_search/name_path.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module AstSearch
+  class NamePath
+    SEPARATOR = "::"
+
+    def self.from_string(str)
+      new(str.split(SEPARATOR))
+    end
+
+    def initialize(path = [])
+      @path = path
+    end
+
+    def +(path_element)
+      new_path = path.dup.push(path_element)
+      NamePath.new(new_path)
+    end
+
+    def eql?(other)
+      to_a == other.to_a
+    end
+
+    def hash
+      path.hash
+    end
+
+    def shift
+      NamePath.new(path[1..-1])
+    end
+
+    def blank?
+      path.size.zero?
+    end
+
+    def to_a
+      path
+    end
+
+    def to_s
+      @_to_s ||= path.join(SEPARATOR)
+    end
+
+    def constantize
+      if to_s.respond_to?(:constantize)
+        # NOTE: ActiveSupport's `constantize` behaves slightly different from `Object.const_get`
+        to_s.constantize
+      else
+        Object.const_get(to_s)
+      end
+    rescue NameError
+      nil
+    end
+
+    private
+
+    attr_reader :path
+  end
+end

data/lib/ast_search/node.rb

@@ -0,0 +1,42 @@
+module AstSearch
+  class Node
+    def initialize(ast)
+      @ast = ast
+    end
+
+    attr_reader :ast
+
+    def const?
+      type == :const
+    end
+
+    def class?
+      type == :class
+    end
+
+    def module?
+      type == :module
+    end
+
+    def name
+      return unless ast.loc.respond_to?(:name)
+      ast.loc.name.source
+    end
+
+    def source
+      ast.loc.expression.source
+    end
+
+    def children
+      return [] unless ast.respond_to?(:children)
+      ast.children
+    end
+
+    private
+
+    def type
+      return nil unless ast.respond_to?(:type)
+      ast.type
+    end
+  end
+end

data/lib/ast_search/queries/class_defs.rb

@@ -0,0 +1,30 @@
+module AstSearch
+  module Queries
+    class ClassDefs
+      def call(ast)
+        traverse(ast, [], NamePath.new).flatten.map(&:to_s)
+      end
+
+      private
+
+      def traverse(ast, result, path)
+        result + process_node(Node.new(ast), result, path)
+      end
+
+      def process_node(node, result, path)
+        if node.module?
+          traverse_children(node, result, path + node.name)
+        elsif node.class?
+          new_path = path + node.name
+          [new_path] + traverse_children(node, result, new_path)
+        else
+          traverse_children(node, result, path)
+        end
+      end
+
+      def traverse_children(node, result, path)
+        node.children.map { |child| traverse(child, result, path) }.flatten
+      end
+    end
+  end
+end

data/lib/ast_search/queries/const_occurrences.rb

@@ -0,0 +1,27 @@
+module AstSearch
+  module Queries
+    class ConstOccurrences
+      def call(ast)
+        traverse(ast, []).compact.uniq
+      end
+
+      private
+
+      def traverse(ast, result)
+        result + process_node(Node.new(ast), result)
+      end
+
+      def process_node(node, result)
+        if node.const?
+          [node.source]
+        else
+          traverse_children(node, result)
+        end
+      end
+
+      def traverse_children(node, result)
+        node.children.map { |child| traverse(child, result) }.flatten
+      end
+    end
+  end
+end

data/lib/ast_search/queries/external_classes.rb

@@ -0,0 +1,32 @@
+module AstSearch
+  module Queries
+    # A class is considered external when it is defined outside of the parsed class.
+    class ExternalClasses
+      def initialize
+        @find_constants = ConstOccurrences.new
+        @find_classes   = ClassDefs.new
+      end
+
+      def call(ast)
+        (referred_constant_names(ast) - internal_class_names(ast))
+          .map(&:constantize).compact.uniq.select { |const| const.is_a?(Class) }
+      end
+
+      private
+
+      attr_reader :find_constants, :find_classes
+
+      def referred_constant_names(ast)
+        find_constants.call(ast).map { |name| to_path(name) }
+      end
+
+      def internal_class_names(ast)
+        find_classes.call(ast).flatten.slice(1..-1).map { |name| to_path(name).shift }
+      end
+
+      def to_path(str)
+        NamePath.from_string(str)
+      end
+    end
+  end
+end

data/lib/ast_search/version.rb

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

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: ast_search
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuriy Kharchenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: 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: Parse Ruby code & search for AST nodes
+email:
+- rm1945@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ast_search.gemspec
+- bin/console
+- bin/setup
+- lib/ast_search.rb
+- lib/ast_search/name_path.rb
+- lib/ast_search/node.rb
+- lib/ast_search/queries/class_defs.rb
+- lib/ast_search/queries/const_occurrences.rb
+- lib/ast_search/queries/external_classes.rb
+- lib/ast_search/version.rb
+homepage: https://github.com/letmein/ast_search
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Parse Ruby code & search for AST nodes
+test_files: []