rdot 1.0.4

data/.yardopts

@@ -0,0 +1,9 @@
+--no-cache
+--hide-void-return
+--private
+--no-private
+--plugin yard-is-monkey
+--title 'RDot: GraphViz class diagrams for Ruby'
+lib/**/*.rb
+- *.md
+

data/README.md

@@ -0,0 +1,152 @@
+# RDot — GraphViz diagrams for Ruby classes
+
+[![endorse](https://api.coderwall.com/shikhalev/endorsecount.png)](https://coderwall.com/shikhalev)
+
+## About
+
+<img src="https://raw.github.com/shikhalev/rdot/master/share/img/rdot.png" align="right" />
+
+* Author: [Ivan Shikhalev](https://github.com/shikhalev)
+* License: [GNU GPL](http://www.gnu.org/copyleft/gpl.html)
+* [Project](https://github.com/shikhalev/rdot) @ [GitHub.com](https://github.com/)
+* [Gem](https://rubygems.org/gems/rdot) @ [RubyGems.org](https://rubygems.org)
+* [Documentation](http://rubydoc.info/github/shikhalev/rdot/frames/)
+@ [RubyDoc.info](http://rubydoc.info/)
+
+### Versions
+
+* For Ruby 1.9.2 and later:
+  * 1.1.x — testing
+  * [1.0.x — stable](https://github.com/shikhalev/rdot/tree/fixes)
+  * 0.10.x (0.10.10.3 latest) — pre-1.0
+* For Ruby 1.8.7:
+  * [0.9.x (0.9.4 latest)](https://github.com/shikhalev/rdot/tree/v0.9.4)
+
+## Command-line help
+    Usage: rdot [options] <libs>
+
+    Note:
+        --                               Stop options parsing, rest of line treated
+                                           as <libs>.
+                                         If it's a FIRST argument, the 'optparse'
+                                           should not be loaded (include config
+                                           files), no options will be parsed, all
+                                           values will be default. And we can make
+                                           graph of 'optparse'.
+    Config files:
+        /etc/rdotopts
+        ~/.config/rdotopts
+        ./.rdotopts
+
+    Service options:
+        -h, --help                       Show short help and exit.
+        -?, --usage                      Show usage info and exit.
+        -B, --about                      Show about string and exit.
+        -A, --author                     Show author and contact info and exit.
+        -L, --license                    Show info about license and exit.
+        -V, --version                    Show version number and exit.
+        -I, --info=[info]                Show some information and exit.
+                                         Argument may be comma-separated set of:
+                                           about, author, license, usage, version;
+                                         or one of presets:
+                                           help = about + usage,
+                                           info (or no argument) =
+                                                        about + author + license,
+                                           all = about + author + license + usage.
+
+        -o, --output=[file]              File for output instead STDOUT.
+                                           'rdot.dot' if empty.
+            --stdout                     Reset output to STDOUT.
+
+    Data options:
+        -p, --preload=libs               Comma-separated list of preloading
+                                           libraries which must be hidden.
+        -i, --load, --input=libs         Comma-separated list of libraries
+                                           which must be loaded and visualized.
+        -l, --libs, --search-path=paths  Comma-separated list of paths where search
+                                           for libs by load and preload.
+
+        -e, --[no-]exclude-classes=list  Comma-separated list of classes which
+                                           should be ignored with their descendants.
+        -xlist,                          Comma-separated list of modules which
+            --[no-]exclude-namespaces      should be ignored with their namespace.
+                                         RDot, Gem, Errno & OptionParser by default,
+                                           use '--no-exclude-namespaces' to reset.
+            --[no-]exclude-files=list    Comma-separated list of files & wildcards
+                                           their methods should by ingnored.
+                                         Currect RDot location excluding by default,
+                                           use '--no-exclude-files' to reset.
+        -c, --[no-]filter-classes=list   Comma separated list of classes which only
+                                           should be visualized (with descendants).
+        -nlist,                          Comma-separated list of modules which only
+            --[no-]filter-namespaces       should be visualized (with nested).
+            --[no-]filter-global         Filter classes and modules only in global
+                                           namespace.
+            --[no-]filter-files=list     Comma-separated list of files & wildcards
+                                           their methods only should by processed.
+
+    Diagram options:
+        -C, --[no-]hide-constants        Ignore constants in classes & modules.
+        -M, --[no-]hide-methods          Ignore methods & attributes.
+        -G, --[no-]hide-arguments        Don't show methods' arguments.
+        -X, --[no-]hide-included         Don't show 'include' links.
+        -E, --[no-]hide-extended         Don't show 'extend' links.
+        -N, --[no-]hide-nested           Don't show nesting links
+
+        -S, --[no-]show-private          Show private & protected methods.
+        -s, --[no-]show-protected        Show protected methods.
+        -P, --[no-]show-preloaded        Show preloaded classes & modules.
+
+            --[no-]select-attributes     Show attributes with access rights
+                                           instead getters & setters as methods.
+                                         True by default.
+
+    Graph options:
+        -T, --title=title                Graph title.
+                                           'RDot Graph' by default.
+
+            --title-font=name            Font name for the graph title.
+                                           'sans-serif' by default.
+            --title-size=size            Font size for the graph title (pt).
+                                           24 by default.
+            --font=name                  Font name for main text.
+                                           'monospace' by default.
+            --font-size=size             Font size for main text (pt).
+                                           9 by default.
+    Colors:
+      May be RGB value or name from X11 scheme,
+      see http://graphviz.org/content/color-names#x11.
+            --color-class=color          Background color of class title.
+                                           #BBFFBB by default.
+            --color-class-preloaded=color
+                                         Background color of preloaded class title.
+                                           #CCEECC by default.
+            --color-class-core=color     Background color of core class title.
+                                           #DDFF99 by default.
+            --color-exception=color      Background color of exception title.
+                                           #FFBBBB by default.
+            --color-exception-preloaded=color
+                                         Background color of preloaded exception
+                                           title.
+                                           #EECCCC by default.
+            --color-exception-core=color Background color of core exception title.
+                                           #FFDD99 by default.
+            --color-module=color         Background color of module title.
+                                           #BBBBFF by default.
+            --color-module-preloaded=color
+                                         Background color of preloaded module title.
+                                           #CCCCEE by default.
+            --color-module-core=color    Background color of core module title.
+                                           #DDDDFF by default.
+            --color-protected=color      Background color for protected methods.
+                                           #EEEEEE by default.
+            --color-private=color        Background color for private methods.
+                                           #DDDDDD by default.
+            --color-inherited=color      Color for inheritance links.
+                                           #0000FF by default.
+            --color-included=color       Color for 'include' links.
+                                           #00AAFF by default.
+            --color-extended=color       Color for 'extend' links.
+                                           #AA00FF by default.
+            --color-nested=color         Color for nesting links.
+                                           #EEEEEE by default.

data/bin/rdot

@@ -0,0 +1,531 @@
+#!/usr/bin/ruby
+# encoding: utf-8
+
+require 'is/monkey/sandbox'
+require 'rdot'
+
+options = {
+  :output => $stdout,
+  :preload => [],
+  :load => [],
+  :exclude_classes => [],
+  :exclude_namespaces => [RDot, Gem, Errno],
+  :exclude_files => [RDot.method(:dot).source_location[0], __FILE__],
+  :select_attributes => true
+}
+
+def hi str
+  if $stdout.stat.chardev?
+    "\e[1m#{str}\e[0m"
+  else
+    str
+  end
+end
+
+title = <<-TXT
+#{hi("RDot v#{RDot::VERSION}:")} GraphViz class diagrams for Ruby
+    http://github.com/shikhalev/rdot
+TXT
+
+usage = <<-TXT
+#{hi('Usage:')} rdot [options] <libs>
+TXT
+
+author = <<-TXT
+#{hi('Author:')} Ivan Shikhalev <shikhalev@gmail.com>
+    http://github.com/shikhalev
+TXT
+
+license = <<-TXT
+#{hi('License:')} GNU GPL (General Public License)
+    http://gnu.org/licenses/gpl.html
+TXT
+
+if ARGV[0] == '--'
+
+  ARGV.shift
+  options[:load] += ARGV
+
+else
+
+  require 'optparse'
+
+  options[:exclude_namespaces] << OptionParser
+
+  opts = OptionParser.new(usage) do |o|
+
+    o.separator ''
+    o.separator hi('Note:')
+    o.separator '    --                               ' +
+        'Stop options parsing, rest of line treated'
+    o.separator '                                     ' +
+        '  as <libs>.'
+    o.separator '                                     ' +
+        'If it\'s a FIRST argument, the \'optparse\''
+    o.separator '                                     ' +
+        '  should not be loaded (include config'
+    o.separator '                                     ' +
+        '  files), no options will be parsed, all'
+    o.separator '                                     ' +
+        '  values will be default. And we can make'
+    o.separator '                                     ' +
+        '  graph of \'optparse\'.'
+    o.separator hi('Config files:')
+    o.separator '    /etc/rdotopts'
+    o.separator '    ~/.config/rdotopts'
+    o.separator '    ./.rdotopts'
+
+    o.separator ''
+    o.separator hi('Service options:')
+
+    o.on '-h', '--help', 'Show short help and exit.' do
+      puts title
+      puts
+      puts opts.help
+      exit 0
+    end
+
+    o.on '-?', '--usage', 'Show usage info and exit.' do
+      puts opts.help
+      exit 0
+    end
+
+    o.on '-B', '--about', 'Show about string and exit.' do
+      puts title
+      exit 0
+    end
+
+    o.on '-A', '--author', 'Show author and contact info and exit.' do
+      puts author
+      exit 0
+    end
+
+    o.on '-L', '--license', 'Show info about license and exit.' do
+      puts license
+      exit 0
+    end
+
+    o.on '-V', '--version', 'Show version number and exit.' do
+      puts RDot::VERSION
+      exit 0
+    end
+
+    o.on '-I', '--info', '=[info]', Array,
+        'Show some information and exit.',
+        'Argument may be comma-separated set of:',
+        '  about, author, license, usage, version;',
+        'or one of presets:',
+        '  help = about + usage,',
+        '  info (or no argument) =',
+        '               about + author + license,',
+        '  all = about + author + license + usage.' do |value|
+      if value == nil || value == []
+        value = ['info']
+      end
+      case value[0]
+      when 'help'
+        value = ['about', 'usage']
+      when 'info'
+        value = ['about', 'author', 'license']
+      when 'all'
+        value = ['about', 'author', 'license', 'usage']
+      when 'version'
+        puts RDot::VERSION
+        exit 0
+      end
+      if value.include? 'about'
+        puts title
+        if value.include?('author') || value.include?('license') ||
+                                                      value.include?('usage')
+          puts
+        end
+      end
+      if value.include? 'author'
+        puts author
+        if value.include?('usage') && ! value.include?('license')
+          puts
+        end
+      end
+      if value.include? 'license'
+        puts license
+        if value.include?('usage')
+          puts
+        end
+      end
+      if value.include? 'usage'
+        puts opts.help
+      end
+      exit 0
+    end
+
+    o.separator ''
+
+    o.on '-o', '--output', '=[file]', String,
+        'File for output instead STDOUT.',
+        '  \'rdot.dot\' if empty.' do |value|
+      if value == nil
+        value = 'rdot.dot'
+      end
+      options[:output] = File.open value, 'w'
+    end
+
+    o.on '--stdout', 'Reset output to STDOUT.'
+
+    o.separator ''
+    o.separator hi('Data options:')
+
+    o.on '-p', '--preload', '=libs', Array,
+        'Comma-separated list of preloading',
+        '  libraries which must be hidden.' do |value|
+      options[:preload] += value
+    end
+
+    o.on '-i', '--load', '--input', '=libs', Array,
+        'Comma-separated list of libraries',
+        '  which must be loaded and visualized.' do |value|
+      options[:load] += value
+    end
+
+    o.on '-l', '--libs', '--search-path', '=paths', Array,
+                 'Comma-separated list of paths where search',
+                 '  for libs by load and preload.' do |value|
+      $:.push *(value.map { |d| File.expand_path(d) })
+    end
+
+    o.separator ''
+
+    o.on '-e', '--[no-]exclude-classes', '=list', Array,
+                 'Comma-separated list of classes which',
+                 '  should be ignored with their descendants.' do |value|
+      if ! value
+        options[:exclude_classes] = []
+      else
+        value.each do |v|
+          c = sandbox { eval v }
+          if Class === c
+            options[:exclude_classes] << c
+          end
+        end
+      end
+    end
+
+    o.on '-x', '--[no-]exclude-namespaces', '=list', Array,
+        'Comma-separated list of modules which',
+        '  should be ignored with their namespace.',
+        'RDot, Gem, Errno & OptionParser by default,',
+        '  use \'--no-exclude-namespaces\' to reset.' do |value|
+      if ! value
+        options[:exclude_namespaces] = []
+      else
+        value.each do |v|
+          m = sandbox { eval v }
+          if Module === m
+            options[:exclude_namespaces] << m
+          end
+        end
+      end
+    end
+
+    o.on '--[no-]exclude-files', '=list', Array,
+        'Comma-separated list of files & wildcards',
+        '  their methods should by ingnored.',
+        'Currect RDot location excluding by default,',
+        '  use \'--no-exclude-files\' to reset.' do |value|
+      if ! value
+        options[:exclude_files] = []
+      else
+        value.each do |v|
+          options[:exclude_files] += Dir[v]
+        end
+      end
+    end
+
+    o.on '-c', '--[no-]filter-classes', '=list', Array,
+        'Comma separated list of classes which only',
+        '  should be visualized (with descendants).' do |value|
+      if ! value
+        options.delete :filter_classes
+      else
+        options[:filter_classes] ||= []
+        value.each do |v|
+          c = sandbox { eval v }
+          if Class === c
+            options[:filter_classes] << c
+          end
+        end
+      end
+    end
+
+    o.on '-n', '--[no-]filter-namespaces', '=list', Array,
+        'Comma-separated list of modules which only',
+        '  should be visualized (with nested).' do |value|
+      if ! value
+        options.delete :filter_namespaces
+      else
+        options[:filter_namespaces] ||= []
+        value.each do |v|
+          m = sandbox { eval v }
+          if Module === m
+            options[:filter_namespaces] << m
+          end
+        end
+      end
+    end
+
+    o.on '--[no-]filter-global', TrueClass,
+        'Filter classes and modules only in global',
+        '  namespace.' do |value|
+      options[:filter_global] = value
+    end
+
+    o.on '--[no-]filter-files', '=list', Array,
+        'Comma-separated list of files & wildcards',
+        '  their methods only should by processed.' do |value|
+      if ! value
+        options.delete :filter_files
+      else
+        options[:filter_files] ||= []
+        value.each do |v|
+          options[:filter_files] += Dir[v]
+        end
+      end
+    end
+
+    o.separator ''
+    o.separator hi('Diagram options:')
+
+    o.on '-C', '--[no-]hide-constants', TrueClass,
+        'Ignore constants in classes & modules.' do |value|
+      options[:hide_constants] = value
+    end
+
+    o.on '-M', '--[no-]hide-methods', TrueClass,
+        'Ignore methods & attributes.' do |value|
+      options[:hide_methods] = value
+    end
+
+    o.on '-G', '--[no-]hide-arguments', TrueClass,
+        'Don\'t show methods\' arguments.' do |value|
+      options[:hide_arguments] = value
+    end
+
+    o.on '-X', '--[no-]hide-included', TrueClass,
+        'Don\'t show \'include\' links.' do |value|
+      options[:hide_included] = value
+    end
+
+    o.on '-E', '--[no-]hide-extended', TrueClass,
+        'Don\'t show \'extend\' links.' do |value|
+      options[:hide_extended] = value
+    end
+
+    o.on '-N', '--[no-]hide-nested', TrueClass,
+        'Don\'t show nesting links' do |value|
+      options[:hide_nested] = value
+    end
+
+    o.separator ''
+
+    o.on '-S', '--[no-]show-private', TrueClass,
+        'Show private & protected methods.' do |value|
+      options[:show_private] = value
+      if value
+        options[:show_protected] = value
+      end
+    end
+
+    o.on '-s', '--[no-]show-protected', TrueClass,
+        'Show protected methods.' do |value|
+      options[:show_protected] = value
+    end
+
+    o.on '-P', '--[no-]show-preloaded', TrueClass,
+        'Show preloaded classes & modules.' do |value|
+      options[:show_preloaded] = value
+    end
+
+    o.separator ''
+
+    o.on '--[no-]select-attributes', TrueClass,
+        'Show attributes with access rights',
+        '  instead getters & setters as methods.',
+        'True by default.' do |value|
+      options[:select_attributes] = value
+    end
+
+    o.separator ''
+    o.separator hi('Graph options:')
+
+    o.on '-T', '--title', '=title', String, 'Graph title.',
+        "  '#{RDot::defaults[:graph_label]}' by default." do |value|
+      options[:graph_label] = value
+    end
+
+    o.separator ''
+
+    o.on '--title-font', '=name', String,
+        'Font name for the graph title.',
+        "  '#{RDot::defaults[:graph_fontname]}' by default." do |value|
+      options[:graph_fontname] = value
+    end
+
+    o.on '--title-size', '=size', Numeric,
+        'Font size for the graph title (pt).',
+        "  #{RDot::defaults[:graph_fontsize]} by default." do |value|
+      options[:graph_fontsize] = value
+    end
+
+    o.on '--font', '=name', String, 'Font name for main text.',
+        "  '#{RDot::defaults[:node_fontname]}' by default." do |value|
+      options[:node_fontname] = value
+    end
+
+    o.on '--font-size', '=size', Numeric, 'Font size for main text (pt).',
+        "  #{RDot::defaults[:node_fontsize]} by default." do |value|
+      options[:node_fontsize] = value
+    end
+
+    o.separator "Colors:\n" +
+        '  May by RGB value or name from X11 scheme,' + "\n" +
+        '  see http://graphviz.org/content/color-names#x11.'
+
+    o.on '--color-class', '=color', String, 'Background color of class title.',
+        "  #{RDot::defaults[:color_class]} by default." do |value|
+      options[:color_class] = value
+    end
+
+    o.on '--color-class-preloaded', '=color', String,
+        'Background color of preloaded class title.',
+        "  #{RDot::defaults[:color_class_preloaded]} by default." do |value|
+      options[:color_class_preloaded] = value
+    end
+
+    o.on '--color-class-core', '=color', String,
+        'Background color of core class title.',
+        "  #{RDot::defaults[:color_class_core]} by default." do |value|
+      options[:color_class_core] = value
+    end
+
+    o.on '--color-exception', '=color', String,
+        'Background color of exception title.',
+        "  #{RDot::defaults[:color_exception]} by default." do |value|
+      options[:color_exception] = value
+    end
+
+    o.on '--color-exception-preloaded', '=color', String,
+        'Background color of preloaded exception', '  title.',
+        "  #{RDot::defaults[:color_exception_preloaded]} by default." do |value|
+      options[:color_exception_preloaded] = value
+    end
+
+    o.on '--color-exception-core', '=color', String,
+        'Background color of core exception title.',
+        "  #{RDot::defaults[:color_exception_core]} by default." do |value|
+      options[:color_exception_core] = value
+    end
+
+    o.on '--color-module', '=color', String, 'Background color of module title.',
+        "  #{RDot::defaults[:color_module]} by default." do |value|
+      options[:color_module] = value
+    end
+
+    o.on '--color-module-preloaded', '=color', String,
+        'Background color of preloaded module title.',
+        "  #{RDot::defaults[:color_module_preloaded]} by default." do |value|
+      options[:color_module_preloaded] = value
+    end
+
+    o.on '--color-module-core', '=color', String,
+        'Background color of core module title.',
+        "  #{RDot::defaults[:color_module_core]} by default." do |value|
+      options[:color_module_core] = value
+    end
+
+    o.on '--color-protected', '=color', String,
+        'Background color for protected methods.',
+        "  #{RDot::defaults[:color_protected]} by default." do |value|
+      options[:color_protected] = value
+    end
+
+    o.on '--color-private', '=color', String,
+        'Background color for private methods.',
+        "  #{RDot::defaults[:color_private]} by default." do |value|
+      options[:color_private] = value
+    end
+
+    o.on '--color-inherited', '=color', String,
+        'Color for inheritance links.',
+        "  #{RDot::defaults[:color_inherited]} by default." do |value|
+      options[:color_inherited] = value
+    end
+
+    o.on '--color-included', '=color', String,
+        'Color for \'include\' links.',
+        "  #{RDot::defaults[:color_included]} by default." do |value|
+      options[:color_included] = value
+    end
+
+    o.on '--color-extended', '=color', String,
+        'Color for \'extend\' links.',
+        "  #{RDot::defaults[:color_extended]} by default." do |value|
+      options[:color_extended] = value
+    end
+
+    o.on '--color-nested', '=color', String,
+        'Color for nesting links.',
+        "  #{RDot::defaults[:color_nested]} by default." do |value|
+      options[:color_nested] = value
+    end
+
+  end
+
+  begin
+    [
+      '/etc/rdotopts',
+      File.expand_path('~/.config/rdotopts'),
+      File.expand_path('./.rdotopts')
+    ].each do |f|
+      if File.exists? f
+        opts.load f
+      end
+    end
+  rescue
+    raise 'Error while processing options file.'
+  end
+
+  begin
+    options[:load] += opts.parse ARGV
+  rescue
+    raise 'Error while processing command line.'
+  end
+
+  if options[:load].include?('optparse')
+    options[:exclude_namespaces].delete OptionParser
+  end
+
+end
+
+if options[:load].include?('rdot')
+  options[:exclude_namespaces].delete RDot
+  options[:exclude_files].delete RDot.method(:dot).source_location[0]
+end
+
+if options[:preload]
+  options[:preload].each do |l|
+    require l
+  end
+end
+
+pre = RDot.snapshot options
+
+if options[:load]
+  options[:load].each do |l|
+    require l
+  end
+end
+
+post = RDot.snapshot options
+
+delta = RDot.diff post, pre, options
+
+options[:output].puts RDot.dot(delta, options)