class_docu_shower 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGFkMzgxMzYwZGY5OTYxMmYzZjRkMzVhYmJlMGM0MWFjZDc0YjYwZA==
+  data.tar.gz: !binary |-
+    M2MyOTc1YzdkN2Y4OTZiMmE0MmUzYmIyOGViMjhjMzIxZjZkNzQ1OQ==
+SHA512:
+  metadata.gz: !binary |-
+    MzRkZTVjNjNiMzQyODdlMjg0NmFmNDc4NDdmZWNhZTk2N2VhNjg1MGIyYTU3
+    MWI1YzkzZWM3NmE3M2IzMGU2ODA3YTkxZmM0MWI5OTJjOGRjZTNiYmE5Yjlh
+    MjY2ZmU1OGY1MTg5ZjgyMjA4ODk2Yzg5OTk0Yzk2NGFhOTA3NGI=
+  data.tar.gz: !binary |-
+    MDM4N2RiNGZmNmQ5NTJiYzBiY2FiNThjMmMyYTEyZDQyZTU4ZTdlNGRlMTYw
+    MWI1YmUyMzNmOGYyYjhhZDA2NDUzYWZkOTMxYjk1YzQyNmVjYTg2Mzk0Yzg5
+    NDdlYzliNDRhOGYwNjgxM2ExOTkzYTMzY2EwMDFkNWEzYTE2OWE=

data/USAGE.md

@@ -0,0 +1,10 @@
+= Usage of this Library
+
+== Requiring it
+
+  require 'class_docu_shower'
+
+== Using it in a project
+
+  ClassDocuShower.new("some_file_here.rb")
+

data/class_docu_shower.gemspec

@@ -0,0 +1,35 @@
+# =========================================================================== #
+# Gemspec for Project ClassDocuShower.
+# =========================================================================== #
+Gem::Specification.new { |s|
+
+  s.name        = 'class_docu_shower'
+  s.version     = '1.0.0'
+  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 class_docu_shower
+  EOF
+  
+  s.extra_rdoc_files = %w()
+  
+  s.authors     = ['Robert A. Heiler']
+  s.email       = 'shevegen@gmail.com'
+  s.files       = Dir['**/*']
+  s.files      << 'USAGE.md'
+  s.license     = 'GPL 2'
+  s.required_ruby_version = '>= 1.8.7'
+  s.homepage    = 'http://rubygems.org/gems/class_docu_shower'
+  s.rubygems_version = '2.1.11'
+  s.add_dependency 'colours', '>= 0.0.12'
+  s.add_dependency 'opn', '>= 1.0.0'
+  s.add_dependency 'usher', '>= 0.0.6'
+
+}

data/lib/class_docu_shower/class_docu_shower.rb

@@ -0,0 +1,91 @@
+#!/System/Executables/ruby -w
+# Encoding: ASCII-8BIT
+# =========================================================================== #
+# This file will extract the comment from a class and return a
+# string about the docu. That comment must be padded inside lines 
+# with '# ===' lines, like this file here.
+#
+# Usage example:
+#   ClassDocuShower.new('file_location_comes_in_here')
+# =========================================================================== #
+require 'pp'
+require 'colours'
+require 'opn'
+require 'usher'
+
+class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
+
+  include Colours
+
+  attr_reader :file
+
+  DEFAULT_FILE = '/Users/x/DATA/PROGRAMMING_LANGUAGES/RUBY/SRC/TOOLS/show_available_users.rb'
+
+  def initialize(i = nil, run_already = true)
+    reset
+    set_file(i)
+    if run_already.is_a? Hash # Intercept hash here.
+      if run_already.has_key? :verbose
+        @be_verbose = run_already[:verbose]
+        run_already = true
+      end
+    elsif run_already == :silent
+      be_silent
+      run_already = true
+    end
+    run if run_already
+  end
+  def reset # (reset tag)
+    @be_verbose = true
+    @usher = Usher.new
+    @usher.allow_n_changes = 1
+  end
+  def be_silent; @be_verbose = false; end
+  def set_file(i = DEFAULT_FILE)
+    i = i[0] if i.is_a? Array
+    i = DEFAULT_FILE if i.nil?
+    i = i.to_s.dup if i
+    @file = i
+  end
+  def read_in_file
+    if File.exist? @file
+      @data = File.readlines(@file)
+    else # We should report.
+      opn; e 'We could not find a file at '+@file+','
+      opn; e 'thus can not check whether it has an documentation.'
+    end
+  end
+  def process_dataset
+    @data.each {|entry|
+      if entry.include? '# ==='
+        @usher.toggle
+      else
+        @usher << entry.delete('#').lstrip
+      end
+    }
+    @result = @usher._
+  end
+  def show_result
+    if @be_verbose # We will be chatty here.
+      opn; e 'From the file '+sfile(@file)+' we '
+      opn; e 'can show this result:'
+    end 
+    show_the_result
+  end
+  def show_the_result
+    e @result
+  end
+  def process
+    read_in_file
+    process_dataset
+  end
+  def run # (run tag)
+    process
+    show_result
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  ClassDocuShower.new(ARGV, :silent)
+end # cdocu

data/lib/class_docu_shower.rb

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

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: class_docu_shower
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.12
+- !ruby/object:Gem::Dependency
+  name: opn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: usher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+description: ! '    This library is called class_docu_shower
+
+'
+email: shevegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- USAGE.md
+- class_docu_shower.gemspec
+- lib/class_docu_shower.rb
+- lib/class_docu_shower/class_docu_shower.rb
+homepage: http://rubygems.org/gems/class_docu_shower
+licenses:
+- GPL 2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+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: ! '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: []