rrg 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b51311e9dcb171ca60d47e533c8f490da8f221d
+  data.tar.gz: c301e1735d5e0fbbabfdec83db759a8dd326e643
+SHA512:
+  metadata.gz: 3938447b673b5f932d31d0afa25cafde4b844c0ea8da2aac0d4e790f598b0e76c3d0c0836e7144a9581cad2b9bb3915ba686a7fe10883a981ce6581dfbb5c2e0
+  data.tar.gz: e0c1b304edc0a4a13834ee4090c8dfc5333592b4301c47210a1ce0e27d17cd88f77d03f0ddb3b5f71c54dc82c98b611ef5939f3147f31bfcfc998ae4196cd27d

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rrg.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Antonio Terceiro
+
+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,27 @@
+# Rrg
+
+TODO: Write a gem description
+
+## Installation
+
+With rubygems:
+
+    $ gem install rrg
+
+## Usage
+
+Just run `rrg` at the root of your project. `rrg` will parse the code inside
+`lib/`, and generate a graph description in the Graphviz format. You can pipe
+the output to Graphviz directly, or store it in a file and process it the
+generate an image.
+
+If you call `rrgv`, it wil automatically process the graph with Graphviz,
+generate a PNG image, and open it with `xdg-open` or `open`.
+
+## Contributing
+
+1. Fork the [project on GitLab](https://gitlab.com/terceiro/rrg)
+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 a new Merge Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+pkg = Gem::Specification.load('rrg.gemspec')
+
+task 'deb:install' => :build do
+  chdir 'pkg' do
+    sh 'gem2deb', '-p', pkg.name, "#{pkg.name}-#{pkg.version}.gem"
+    sh 'sudo', 'dpkg', '-i', "#{pkg.name}_#{pkg.version}-1_all.deb"
+  end
+end

data/bin/rrg

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+
+require 'set'
+require 'tmpdir'
+
+require 'ruby_parser'
+
+#######################################################################
+# Process the code
+#######################################################################
+
+project_files = []
+nodes = Set.new
+requires = []
+
+Dir.chdir 'lib' do
+  Dir.glob('**/*.rb').each do |f|
+    fname = f.sub(/\.rb$/, '')
+    nodes << fname
+    project_files << fname
+    parser = RubyParser.new
+    tree = parser.parse(File.read(f))
+    tree.each do |node|
+      if node[0] == :call and node[2] == :require
+        nodes << node[3][1]
+        requires << [fname, node[3][1]]
+      end
+    end
+  end
+end
+
+
+#######################################################################
+# Decide what to do with the data based in the called program name
+# rrg: output to stdout
+# rrgv: view image directly
+#######################################################################
+
+# TODO refactor this to polymorphism
+if File.basename($PROGRAM_NAME) == 'rrg'
+  output = $stdout
+  view_output = lambda { true } # nothing
+else
+  tmpdir = Dir.mktmpdir
+  image = File.join(tmpdir, 'requires.png')
+  output = IO.popen(['dot', '-Tpng', '-o', image], 'w')
+
+  # FIXME hardcoded list of image viewers for now
+  image_viewer = %w[xdg-open eog gwenview ristretto open].find do |prog|
+    system("which #{prog} >/dev/null 2>&1")
+  end
+
+  unless image_viewer
+    echo "E: could find a suitable image viewer. Please report a bug."
+    exit(1)
+  end
+
+  view_output = lambda do
+    system(image_viewer, image)
+  end
+end
+
+#######################################################################
+# Generate output
+#######################################################################
+
+output.puts 'digraph require_graph {'
+nodes.each do |req|
+  if project_files.include?(req)
+    color = ''
+  else
+    color = ', color="#888a85", fontcolor="#888a85"'
+  end
+  output.puts "  \"#{req}\" [shape=box#{color}];"
+end
+requires.each do |call|
+  output.puts "  \"#{call[0]}\" -> \"#{call[1]}\";"
+end
+output.puts '}'
+output.close
+
+#######################################################################
+# visualize the output
+#######################################################################
+view_output.call

data/bin/rrgv

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+load File.expand_path('../rrg', __FILE__)

data/lib/rrg.rb

@@ -0,0 +1,5 @@
+require "rrg/version"
+
+module Rrg
+  # Your code goes here...
+end

data/lib/rrg/version.rb

@@ -0,0 +1,3 @@
+module Rrg
+  VERSION = "0.1"
+end

data/rrg.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rrg/version'
+
+description = <<DESCRIPTION
+rrg will read the source code of a Ruby project and generate a graph based on
+the require statements in the code, when nodes are the source files and an
+arrow from A to B means that A calls `require 'B'`.
+DESCRIPTION
+
+Gem::Specification.new do |spec|
+  spec.name          = "rrg"
+  spec.version       = Rrg::VERSION
+  spec.authors       = ["Antonio Terceiro"]
+  spec.email         = ["terceiro@softwarelivre.org"]
+  spec.summary       = %q{require graph extractor and viewer for Ruby projects}
+  spec.description   = description
+  spec.homepage      = "https://gitlab.com/terceiro/rrg"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+
+  spec.add_runtime_dependency "ruby_parser"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rrg
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Antonio Terceiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_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'
+description: |
+  rrg will read the source code of a Ruby project and generate a graph based on
+  the require statements in the code, when nodes are the source files and an
+  arrow from A to B means that A calls `require 'B'`.
+email:
+- terceiro@softwarelivre.org
+executables:
+- rrg
+- rrgv
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rrg
+- bin/rrgv
+- lib/rrg.rb
+- lib/rrg/version.rb
+- rrg.gemspec
+homepage: https://gitlab.com/terceiro/rrg
+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.2.2
+signing_key: 
+specification_version: 4
+summary: require graph extractor and viewer for Ruby projects
+test_files: []
+has_rdoc: