rd 0.0.1

data/README.md

@@ -0,0 +1,42 @@
+RD cli tool
+===========
+
+The rd is tiny cli tool for ruby 1.9 kernel classes documenation.
+
+Uses http://ruby-doc.org/ as data source.
+
+Usage
+-----
+
+    $ rd list
+        Will output all the kernel classes data retrieving is available for.
+
+    $ rd :class_name
+        Will output all the class methods and class includes such as additional modules.
+        Example:
+            $ rd exception
+            will output:
+                Exception
+                    methods
+                        • ==
+                        • backtrace
+                        • exception
+                        • inspect
+                        • message
+                        • new
+                        • set_backtrace
+                        • to_s
+            
+    $ rd :class_name :method
+        Will output method interface definition and method description (if available).
+        Example:
+            $ rd exception to_s
+            will output:
+                Exception
+                    method
+                        to_s
+                    interface
+                        • exception.to_s   →  string
+                    description
+
+                Returns exception‘s message (or the name of the exception if no message is set).

data/bin/rd

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'rklass')
+
+begin
+  raise "No search data given. Skiped." if ARGV.size == 0
+  rk = RKlass.new(ARGV)
+  puts rk.cout
+rescue => e
+  puts "Execution error: #{e.message}"
+  exit 1
+end

data/lib/rklass.rb

@@ -0,0 +1,124 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'net/http'
+require 'nokogiri'
+require 'open-uri'
+require 'rainbow'
+
+class RKlass
+
+  KLASSES = [
+    "ARGF", "ArgumentError", "Array", "BasicObject", "Bignum", "Binding", "Class", "Comparable", 
+    "Complex", "Continuation", "Data", "Dir", "EOFError", "Encoding", "Encoding/Converter", "Encoding/ConverterNotFoundError", 
+    "Encoding/InvalidByteSequenceError", "Encoding/UndefinedConversionError", "EncodingError", "Enumerable", 
+    "Enumerator", "Enumerator/Generator", "Enumerator/Yielder", "Errno", "Exception", "FalseClass", "Fiber", 
+    "FiberError", "File", "File/Constants", "File/Stat", "FileTest", "Fixnum", "Float", "FloatDomainError", 
+    "GC", "GC/Profiler", "Hash", "IO", "IO/WaitReadable", "IO/WaitWritable", "IOError", "IndexError", "Integer", 
+    "Interrupt", "Kernel", "KeyError", "LoadError", "LocalJumpError", "Marshal", "MatchData", "Math", "Math/DomainError", "Method", 
+    "Module", "Mutex", "NameError", "NameError/message", "NilClass", "NoMemoryError", "NoMethodError", "NotImplementedError", 
+    "Numeric", "Object", "ObjectSpace", "Proc", "Process", "Process/GID", "Process/Status", "Process/Sys", 
+    "Process/UID", "Random", "Range", "RangeError", "Rational", "Regexp", "RegexpError", "RubyVM", "RubyVM/Env", 
+    "RuntimeError", "ScriptError", "SecurityError", "Signal", "Signal", "SignalException", "StandardError", 
+    "StopIteration", "String", "Struct", "Symbol", "SyntaxError", "SystemCallError", "SystemExit", "SystemStackError", 
+    "Thread", "ThreadError", "ThreadGroup", "Time", "TrueClass", "TypeError", "UnboundMethod", "ZeroDivisionError", "fatal"
+  ]
+
+  class Formatter
+
+    class << self
+
+      def cout(data)
+        format_branch(data).join("\n")
+      end
+
+      def inherit(str)
+        "    #{str}"
+      end
+
+      def point(str)
+        "#{'•'.color(:red)} #{str.color(:cyan)}"
+      end
+
+      def format_branch(branch)
+        lines = []
+        if branch.is_a? Hash
+          branch.each_pair do |k, v|
+            lines << k.to_s.color(:magenta)
+            format_branch(v).each do |l|
+              lines << inherit(l)
+            end
+          end
+        elsif branch.is_a? Array
+          branch.each do |e|
+            lines << point(e)
+          end
+        else
+          lines << branch
+        end
+        lines
+      end
+
+    end
+  end
+
+  def initialize(data)
+      @search = data.first
+      raise "No class entry found: #{@search}." if !KLASSES.include?(@search) && !KLASSES.include?(@search.capitalize) && !self.respond_to?(@search.to_sym)
+      @method = data[1] if data.size > 1
+  end
+
+  def cout
+    if self.respond_to?(@search.to_sym)
+      Formatter.cout(self.send(@search.to_sym))
+    else
+      klass = @search
+      klass = klass.capitalize if !KLASSES.include?(klass)
+      doc = Nokogiri::HTML(open("http://ruby-doc.org/core/classes/#{klass}.html"))
+      methods = {}
+      includes = []
+      doc.css('#method-list div.name-list a').each do |method_link|
+        method_name = method_link.content.to_s
+        href = method_link['href'].sub('#', '')
+        method_heading = ''
+        method_descr = ''
+        method_examples = ''
+        doc.css('#method-' + href).each do |l|
+          l.css('div.method-heading span.method-name').each do |span|
+            method_heading = span.content.to_s.split(/<br>|\n/)
+          end
+          l.css('div.method-description p, div.method-description pre').each do |p|
+            method_descr += p.content.to_s.gsub(/<.+?>(.+)?<\/.+?>/, '\1')
+          end
+        end
+        methods[method_name] = {
+          :interface => method_heading,
+          :description => method_descr
+          # :examples => method_examples
+        }
+      end
+      doc.css('#includes-list a').each do |incl|
+        includes << incl.content.to_s
+      end
+
+      data = {}
+
+      if (@method.nil?)
+        data[:methods] = methods.keys if methods.size > 0
+        data[:includes] = includes if includes.size > 0
+      else
+        raise "No method named '#{@method}' found for class #{klass}." if methods[@method].nil?
+        data[:method] = @method
+        [:interface, :description].each do |sub|
+          data[sub] = methods[@method][sub]
+        end
+      end
+
+      Formatter.cout({ klass => data })
+    end
+  end
+
+  def list
+    { :available_classes => KLASSES }
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: rd
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- 4pcbr
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-07 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rainbow
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: ruby kernel classes documentation cli tool
+email: i4pcbr@gmail.com
+executables: 
+- rd
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- bin/rd
+- lib/rklass.rb
+has_rdoc: true
+homepage: https://github.com/4pcbr/rd
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: ruby kernel classes documentation cli tool
+test_files: []
+