show_rdoc_docu 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8731a9bdeb1789e2382b6459bda4a6bed3e3873518d6fe7a2a4cf5a9021c5c13
+  data.tar.gz: 1ac88cf30f62a61fcf5a016e7ecf75b38442481e7efb42b65e9654340be330fa
+SHA512:
+  metadata.gz: c5eac7426066038fc25ecebb517c439cfd075cba8ed75ad21175aa4c81333fddfc1b0fb67c86c58ed3e8b91ebbb1d26420006ebb68b61e5dc3ffc8edd506739b
+  data.tar.gz: 140662d71146d88bd1619d9dda0a0229fecdd790f68a1617b78cc710e627258175bd71b466576307b4952e65fe54c0f75f692eb8d8af552d3f98483c575d2bf2

data/lib/show_rdoc_docu.rb

@@ -0,0 +1 @@
+require 'show_rdoc_docu/show_rdoc_docu.rb'

data/lib/show_rdoc_docu/show_rdoc_docu.rb

@@ -0,0 +1,142 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === ShowRdocDocu
+#
+# Use this class to show rdoc documentation.
+#
+# It will be stored in @result.
+#
+# Usage example:
+#
+#   require 'show_rdoc_docu'
+#   ShowRdocDocu.new(ARGV)
+#
+# =========================================================================== #
+# require 'show_rdoc_docu'
+# =========================================================================== #
+require 'rdoc'
+require 'stringio'
+require 'show_rdoc_docu/version/version.rb'
+
+class ShowRdocDocu # === ShowRdocDocu
+
+  begin
+    require 'colours'
+    include Colours
+  rescue LoadError; end
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      format_type = '--format=markdown',
+      run_already = true
+    )
+    reset
+    set_input(i)
+    @format_type = format_type # << '--format=ansi' # => ["-T", "--format=ansi"]
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    @found_a_result = true
+    @be_verbose     = true
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === found_a_result?
+  # ========================================================================= #
+  def found_a_result?
+    @found_a_result
+  end; alias found_result? found_a_result? # === found_result?
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = nil)
+    i = 'Array#push' if i.nil?
+    i = 'Array#push' if i.empty?
+    i = i.first if i.is_a? Array
+    @input = i
+  end
+
+  # ========================================================================= #
+  # === restore_stdout
+  # ========================================================================= #
+  def restore_stdout
+    $stdout = STDOUT
+  end
+
+  # ========================================================================= #
+  # === show_result
+  #
+  # Simply output the result.
+  # ========================================================================= #
+  def show_result
+    e result # This is the string output.
+  end; alias report        show_result # === report
+       alias report_result show_result # === report_result
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @result
+  end; alias result result? # === result
+
+  # ========================================================================= #
+  # === result=
+  # ========================================================================= #
+  def result=(i)
+    @result = i
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = %w( -T )
+    _ << @format_type
+    # ======================================================================= #
+    # Next we delegate into RDoc::RI::Driver.process_args 
+    # ======================================================================= #
+    hash = RDoc::RI::Driver.process_args(_) # This hash can be passed to Driver.new
+    rdoc_driver = RDoc::RI::Driver.new(hash)
+    rdoc_driver.use_stdout = true
+    @result = ''.dup # We push the output into this instance variable.
+    $stdout = StringIO.new(@result) # Snatch all std-output.
+    begin # Must rescue here.
+      # @input is a String such as: "String#[]"
+      _dataset = rdoc_driver.display_method(@input) # This will return a Fixnum.
+    rescue RDoc::RI::Driver::NotFoundError
+      if be_verbose?
+        opn; e 'We did not find anything about `'+simp(@input)+'`.'
+      end
+      @found_a_result = false
+    end
+    restore_stdout # And restore stdout again.
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  _ = ShowRdocDocu.new(ARGV)
+  _.show_result
+end # showrdocdocu Dir.chdir

data/lib/show_rdoc_docu/version/version.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'show_rdoc_docu/version/version.rb'
+# =========================================================================== #
+class ShowRdocDocu
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.0.11'
+
+end

data/show_rdoc_docu.gemspec

@@ -0,0 +1,50 @@
+# =========================================================================== #
+# Gemspec for Project ShowRdocDocu.
+# =========================================================================== #
+require 'show_rdoc_docu'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'show_rdoc_docu'
+  s.version = ShowRdocDocu::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+
+  s.summary = <<-EOF
+
+    If you have specific suggestions to make this gem more
+    useful for others, please drop me an email at:
+
+      shevegen@gmail.com
+
+    Thank you.
+
+  EOF
+
+  s.description = <<-EOF
+
+    This library is called show_rdoc_docu.
+
+  EOF
+
+  s.extra_rdoc_files = %w()
+  
+  s.authors    = ['Robert A. Heiler']
+  s.email      = 'shevegen@gmail.com'
+  s.files      = Dir['**/*']
+  if File.exist? 'USAGE.md'
+    s.files     << 'USAGE.md'
+  end
+  s.license    = 'GPL-2.0'
+  s.homepage   = 'https://rubygems.org/gems/show_rdoc_docu'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies for the project:
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+
+}

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: show_rdoc_docu
+version: !ruby/object:Gem::Version
+  version: 0.0.11
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  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'
+- !ruby/object:Gem::Dependency
+  name: opn
+  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: |2+
+
+      This library is called show_rdoc_docu.
+
+email: shevegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/show_rdoc_docu.rb
+- lib/show_rdoc_docu/show_rdoc_docu.rb
+- lib/show_rdoc_docu/version/version.rb
+- show_rdoc_docu.gemspec
+homepage: https://rubygems.org/gems/show_rdoc_docu
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.4
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: 'If you have specific suggestions to make this gem more useful for others,
+  please drop me an email at:  shevegen@gmail.com  Thank you.'
+test_files: []