rdg 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b4773e86f8072218af847f45bb3fd7144b17280d
+  data.tar.gz: bc71864a750e80a115446322711ace2d9a36684c
+SHA512:
+  metadata.gz: d6194df5a3f39aab8a8d3819e2ec310a24611c53fa15ffc947edf7fec96aa02fa8b5bbad142b84bb228011b1bc65086ddf9e55ac527ed752f9e08cc571073225
+  data.tar.gz: 35e161070ace8d798444f3c857328fde3c5eb785989d7182e1b06a56b0c6c124c3190e3cb6b7e3183ed4cc30d1e39507023d8d5d25ea7512346780d5c05a814a

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+  Exclude:
+    - vendor/*
+
+StringLiterals:
+  Enabled: false
+
+LineLength:
+  Max: 99
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install:
+  - gem update bundler
+addons:
+  code_climate:
+    repo_token: 437cae623819bbf323bd0dbc9e2b857149c9f725841f3825ca55e09f564d8e0a

data/Gemfile

@@ -0,0 +1,5 @@
+ruby "2.2.0"
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rdg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Louis Rose
+
+MIT License
+
+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,25 @@
+# RDG [![Build Status](https://travis-ci.org/mutiny/rdg.png)](https://travis-ci.org/mutiny/rdg) [![Code Climate](https://codeclimate.com/github/mutiny/rdg.png)](https://codeclimate.com/github/mutiny/rdg) [![Dependency Status](https://gemnasium.com/mutiny/rdg.png)](https://gemnasium.com/mutiny/rdg) [![Test Coverage](https://codeclimate.com/github/mutiny/rdg/badges/coverage.svg)](https://codeclimate.com/github/mutiny/rdg)
+
+Dependency analysis for Ruby programs
+
+## Installation
+
+Add these line to your application's Gemfile:
+
+    gem 'rdg'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rdg
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task default: ["test:unit", "test:integration", "style:check"]
+
+namespace :test do
+  RSpec::Core::RakeTask.new(:unit) do |task|
+    task.pattern = "./spec/unit{,/*/**}/*_spec.rb"
+  end
+
+  RSpec::Core::RakeTask.new(:integration) do |task|
+    task.pattern = "./spec/integration{,/*/**}/*_spec.rb"
+  end
+end
+
+namespace :style do
+  require "rubocop/rake_task"
+
+  desc "Run RuboCop on the lib directory"
+  RuboCop::RakeTask.new(:check) do |task|
+    task.options = ["--auto-correct"]
+  end
+end

data/bin/ast

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+require_relative "../lib/rdg/tree/ast"
+
+if ARGV.size == 1
+  RDG::Tree::AST.from_path(ARGV[0]).write_to_graphic_file('png', ARGV[0])
+else
+  puts "ast: expected 1 argument but received #{ARGV.size}"
+  puts "Usage:"
+  puts "  ast path/to/source.rb"
+end

data/lib/rdg/tree/ast.rb

@@ -0,0 +1,66 @@
+require "rgl/adjacency"
+require "rgl/dot"
+require "parser/current"
+require_relative "rgl/pre_order_iterator"
+require_relative "rgl/post_order_iterator"
+
+module RDG
+  module Tree
+    class AST
+      def self.from_path(path, parser = Parser::CurrentRuby)
+        from_source(File.read(path), parser)
+      end
+
+      def self.from_source(source, parser = Parser::CurrentRuby)
+        new(parser.parse(source))
+      end
+
+      def initialize(ast)
+        @graph = ::RGL::DirectedAdjacencyGraph.new
+        import(ast)
+      end
+
+      def pre_order_iterator
+        RGL::PreOrderIterator.new(@graph)
+      end
+
+      def post_order_iterator
+        RGL::PostOrderIterator.new(@graph)
+      end
+
+      def write_to_graphic_file(format = 'png', filename = "ast")
+        @graph.write_to_graphic_file(format, filename)
+      end
+
+      private
+
+      def import(ast)
+        Node.new(ast).tap do |current_node|
+          @graph.add_vertex(current_node)
+
+          current_node.children.each do |child|
+            @graph.add_edge(current_node, import(child))
+          end
+        end
+      end
+
+      class Node
+        def initialize(wrapped)
+          @wrapped = wrapped
+        end
+
+        def children
+          if @wrapped.is_a?(Parser::AST::Node)
+            @wrapped.children
+          else
+            []
+          end
+        end
+
+        def to_s
+          @wrapped.to_s
+        end
+      end
+    end
+  end
+end

data/lib/rdg/tree/rgl/post_order_iterator.rb

@@ -0,0 +1,84 @@
+require "rgl/traversal"
+
+module RDG
+  module Tree
+    module RGL
+      class PostOrderIterator
+        include ::RGL::GraphIterator
+
+        def initialize(tree, root = tree.first)
+          super(tree)
+          @root = root
+          set_to_begin
+        end
+
+        def set_to_begin
+          @visited = Hash.new(false)
+          @stack = []
+          @start = descend(@root)
+          @current = @start
+        end
+
+        def at_beginning?
+          @current == @start
+        end
+
+        def at_end?
+          visited?(@root)
+        end
+
+        def basic_forward
+          @current = descend(@current)
+          visit(@current)
+          @current
+        end
+
+        def basic_backward
+          @current = ascend(@current)
+          unvisit(@current)
+          @current
+        end
+
+        private
+
+        def visit(node)
+          @visited[node.object_id] = true
+        end
+
+        def unvisit(node)
+          @visited[node.object_id] = false
+        end
+
+        def visited?(node)
+          @visited[node.object_id]
+        end
+
+        def descend(node)
+          next_child = graph.each_adjacent(node).detect { |c| !visited?(c) }
+
+          if visited?(node)
+            descend(@stack.pop)
+          elsif next_child.nil?
+            node
+          else
+            @stack.push(node)
+            descend(next_child)
+          end
+        end
+
+        def ascend(node)
+          last_child = graph.each_adjacent(node).select { |c| visited?(c) }.last
+
+          if visited?(node)
+            node
+          elsif last_child.nil?
+            ascend(@stack.pop)
+          else
+            @stack.push(node)
+            last_child
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdg/tree/rgl/pre_order_iterator.rb

@@ -0,0 +1,94 @@
+require "rgl/traversal"
+
+module RDG
+  module Tree
+    module RGL
+      class PreOrderIterator
+        include ::RGL::GraphIterator
+
+        def initialize(tree, root = tree.first)
+          super(tree)
+          @root = root
+          set_to_begin
+        end
+
+        def set_to_begin
+          @visited = Hash.new(false)
+          @stack = []
+          @start = @root
+          @current = @start
+        end
+
+        def at_beginning?
+          @current == @start
+        end
+
+        def at_end?
+          visited?(last_leaf(@root))
+        end
+
+        def basic_forward
+          @current = descend(@current)
+          visit(@current)
+          @current
+        end
+
+        def basic_backward
+          @current = ascend(@current)
+          unvisit(@current)
+          @current
+        end
+
+        private
+
+        def visit(node)
+          @visited[node.object_id] = true
+        end
+
+        def unvisit(node)
+          @visited[node.object_id] = false
+        end
+
+        def visited?(node)
+          @visited[node.object_id]
+        end
+
+        def descend(node)
+          next_child = graph.each_adjacent(node).detect { |c| !visited?(c) }
+
+          if !visited?(node)
+            node
+          elsif next_child.nil?
+            descend(@stack.pop)
+          else
+            @stack.push(node)
+            next_child
+          end
+        end
+
+        def ascend(node)
+          last_child = graph.each_adjacent(node).select { |c| visited?(c) }.last
+
+          if last_child
+            @stack.push(node)
+            ascend(last_child)
+          elsif visited?(node)
+            node
+          else
+            ascend(@stack.pop)
+          end
+        end
+
+        def last_leaf(node)
+          last_child = graph.each_adjacent(node).select { |_c| true }.last
+
+          if last_child.nil?
+            node
+          else
+            last_leaf(last_child)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rdg/version.rb

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

data/rdg.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rdg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rdg"
+  spec.version       = RDG::VERSION
+  spec.authors       = ["Louis Rose"]
+  spec.email         = ["louis.rose@york.ac.uk"]
+  spec.description   = %q{Provides dependency analysis of Ruby programs, including control and data flow analysis.}
+  spec.summary       = %q{Dependency analysis for Ruby programs}
+  spec.homepage      = "https://github.com/mutiny/rdg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "parser", "~> 2.2.0.2"
+  spec.add_runtime_dependency "rgl", "~> 0.5.0"
+  
+  spec.add_development_dependency "bundler", "~> 1.8.0"
+  spec.add_development_dependency "rake", "~> 10.4.2"
+  spec.add_development_dependency "rspec", "~> 3.2.0"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.4.6"
+  spec.add_development_dependency "rubocop", "~> 0.29.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/tree/ast_spec.rb

@@ -0,0 +1,15 @@
+require "rdg/tree/ast"
+
+module RDG
+  module Tree
+    describe AST do
+      subject { AST.from_source("a.b") }
+
+      it "should render Ruby source as an AST" do
+        nodes = subject.pre_order_iterator.map(&:to_s).to_a
+
+        expect(nodes).to eq(["(send ...)", "(send ...)", "", "a", "b"])
+      end
+    end
+  end
+end

data/spec/unit/tree/rgl/post_order_iterator_spec.rb

@@ -0,0 +1,37 @@
+require "rdg/tree/rgl/post_order_iterator"
+require "rgl/adjacency"
+
+module RDG
+  module Tree
+    module RGL
+      describe PostOrderIterator do
+        let(:tree) do
+          ::RGL::DirectedAdjacencyGraph[
+            :f, :b,  #       F
+            :b, :a,  #     /   \
+            :b, :d,  #    B    G
+            :d, :c,  #   / \    \
+            :d, :e,  #  A   D    I
+            :f, :g,  #     / \   /
+            :g, :i,  #    C  E  H
+            :i, :h   #
+          ]
+        end
+        let(:post_order_traversal) { %i(a c e d b h i g f) }
+        subject { PostOrderIterator.new(tree) }
+
+        it "should return a correct post-order traversal" do
+          expect(subject.to_a).to eq(post_order_traversal)
+        end
+
+        it "should return a correct post-order traversal when iterated backwards" do
+          backwards = []
+          subject.set_to_end
+          backwards << subject.basic_backward until subject.at_beginning?
+
+          expect(backwards).to eq(post_order_traversal.reverse)
+        end
+      end
+    end
+  end
+end

data/spec/unit/tree/rgl/pre_order_iterator_spec.rb

@@ -0,0 +1,37 @@
+require "rdg/tree/rgl/pre_order_iterator"
+require "rgl/adjacency"
+
+module RDG
+  module Tree
+    module RGL
+      describe PreOrderIterator do
+        let(:tree) do
+          ::RGL::DirectedAdjacencyGraph[
+            :f, :b,  #       F
+            :b, :a,  #     /   \
+            :b, :d,  #    B    G
+            :d, :c,  #   / \    \
+            :d, :e,  #  A   D    I
+            :f, :g,  #     / \   /
+            :g, :i,  #    C  E  H
+            :i, :h   #
+          ]
+        end
+        let(:pre_order_traversal) { %i(f b a d c e g i h) }
+        subject { PreOrderIterator.new(tree) }
+
+        it "should return a correct pre-order traversal" do
+          expect(subject.to_a).to eq(pre_order_traversal)
+        end
+
+        it "should return a correct pre-order traversal when iterated backwards" do
+          backwards = []
+          subject.set_to_end
+          backwards << subject.basic_backward until subject.at_beginning?
+
+          expect(backwards).to eq(pre_order_traversal.reverse)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: rdg
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Louis Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0.2
+- !ruby/object:Gem::Dependency
+  name: rgl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.29.0
+description: Provides dependency analysis of Ruby programs, including control and
+  data flow analysis.
+email:
+- louis.rose@york.ac.uk
+executables:
+- ast
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ast
+- lib/rdg/tree/ast.rb
+- lib/rdg/tree/rgl/post_order_iterator.rb
+- lib/rdg/tree/rgl/pre_order_iterator.rb
+- lib/rdg/version.rb
+- rdg.gemspec
+- spec/spec_helper.rb
+- spec/unit/tree/ast_spec.rb
+- spec/unit/tree/rgl/post_order_iterator_spec.rb
+- spec/unit/tree/rgl/pre_order_iterator_spec.rb
+homepage: https://github.com/mutiny/rdg
+licenses:
+- MIT
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Dependency analysis for Ruby programs
+test_files:
+- spec/spec_helper.rb
+- spec/unit/tree/ast_spec.rb
+- spec/unit/tree/rgl/post_order_iterator_spec.rb
+- spec/unit/tree/rgl/pre_order_iterator_spec.rb