class_docu_shower 1.0.1 → 1.0.3

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    YjUwM2QwODFhMGY0YzAwZWVlYTNhMjNmZjY2N2JhNTViYjdiYTZjNA==
-  data.tar.gz: !binary |-
-    ZGY2ZWQ1ODY0YjIyYTMzZDg1NjZlZjExMTM1ZjljZGE2YjI3NTRiNw==
+SHA1:
+  metadata.gz: 706a06d9164f89d3cf5a600bdbc0e1eb65bb839f
+  data.tar.gz: 6c58b78d9404c2e5e0983a983befcd6fe1196a96
 SHA512:
-  metadata.gz: !binary |-
-    MzZiNWFjNWI0NTFjMjI2NTEzODFmZDIyYmM3NTU2NGVhNzEyMGIyM2VlMDBk
-    ZDdjM2FiNjA0OWU1OTRhMDc1ODQzNzYxOGY5MTc0MGUwM2I2NmY5YjYyNTVh
-    NWNjZGJlODE4MWQ1MmMyOGQ5N2NlZGFlYTk1YWJjNzgzN2QwMjU=
-  data.tar.gz: !binary |-
-    ZmExNWMxNzdmNmRmYzgzNTMzOTljNDdlZWYxNzFiNmMyNTcxMzIxZDVlOWYw
-    ODY0OTE2NjMyZjQwMjRlZDgxMTcyNDk3OWVlZmNhNmM1YjNjZmZlMTY3NzAw
-    MTZjYzEwOTIwNjM2YTI1NjczZGNjZmIzNTMyNjg0N2Q5NGEwOTQ=
+  metadata.gz: a85869271e95c374ecdc4cf39cf2d9c19f141068d92c47d9e0da93930452682c46041b73fc487541af2da247293c8e8fa193c649cfb270130b0db08f3cd489c5
+  data.tar.gz: 445e7ac50e3b53e8413835c35413b87f145aabc6814404bb1b7125a5562cb8d8c32d2e29107292876f7f7223a009606d5b77d0e11699ac778bbee66e29441758

data/class_docu_shower.gemspec

@@ -4,29 +4,57 @@
 Gem::Specification.new { |s|
 
   s.name        = 'class_docu_shower'
-  s.version     = '1.0.1'
+  s.version     = '1.0.3'
   s.date        = Time.now.strftime('%Y-%m-%d')
   
   s.summary = <<-EOF
+  
+    It will display the header of a .rb file in question.
+    For this to properly function, you should use 3 =
+    followed by the name of the class, and delimited
+    in # ===== entries.
+    
+    Example:
+    
+    === Menu
+
     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
+
+    This library is called class_docu_shower.
+    
+    It will display the header of a .rb file in question.
+    For this to properly function, you should use 3 =
+    followed by the name of the class, and delimited
+    in # ===== entries.
+    
+    Example:
+    
+    === Menu
+
+    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.extra_rdoc_files = %w()
+  s.extra_rdoc_files = %w( USAGE.md )
   
   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.required_ruby_version = '>= 1.9.2'
   s.homepage    = 'http://rubygems.org/gems/class_docu_shower'
+
   s.rubygems_version = '2.1.11'
 
   s.add_dependency 'colours', '>= 0.0.12'

data/lib/class_docu_shower/class_docu_shower.rb

@@ -1,6 +1,8 @@
 #!/System/Executables/ruby -w
 # Encoding: ASCII-8BIT
 # =========================================================================== #
+# === ClassDocuShower
+#
 # 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.
@@ -17,14 +19,18 @@ class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
 
   include Colours
 
-  attr_reader :file
+  attr_reader :files
 
   DEFAULT_FILE = '/Users/x/DATA/PROGRAMMING_LANGUAGES/RUBY/SRC/TOOLS/show_available_users.rb'
   FORBIDDEN_CHARACTERS = '# ===='
 
-  def initialize(i = nil, run_already = true)
+  def initialize(
+      i = nil,
+      run_already = true
+    )
+    be_silent
     reset
-    set_file(i)
+    set_files(i)
     if run_already.is_a? Hash # Intercept hash here.
       if run_already.has_key? :verbose
         @be_verbose = run_already[:verbose]
@@ -37,36 +43,31 @@ class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
     run if run_already
   end
   def reset # (reset tag)
-    be_silent
+    @data  = nil
     @usher = Usher.new
+  end
+  def reset_usher_object
+    @usher.reset
     @usher.allow_n_changes = 1
   end
   def be_verbose; @be_verbose = true; end
   def be_silent;  @be_verbose = false; end
-  def set_file(i = DEFAULT_FILE)
-    i = i[0] if i.is_a? Array
+  def set_files(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
+    # i = i.to_s.dup if i
+    i = [i] unless i.is_a? Array # Must always be an Array.
+    i = i.flatten # But keep it flattened.
+    @files = i
   end
-  def read_in_file
-    if File.exist? @file
-      @data = File.readlines(@file)
+  def read_in_file(this_file = @file)
+    if File.exist? this_file
+      @data = File.readlines(this_file)
     else # We should report.
-      opn; e 'We could not find a file at '+@file+','
+      opn; e 'We could not find a file at '+sfile(this_file)+','
       opn; e 'thus can not check whether it has an documentation.'
     end
   end
-  def process_dataset
-    @data.each {|entry|
-      if entry.include? FORBIDDEN_CHARACTERS
-        @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 '
@@ -77,13 +78,34 @@ class ClassDocuShower # require 'class_docu_shower'; ClassDocuShower.new
   def show_the_result
     e @result
   end
+  def process_dataset
+    reset_usher_object
+    @data.each {|entry| # @data is an Array.
+      if entry.include? FORBIDDEN_CHARACTERS
+        @usher.toggle
+      else
+        # Else add the entry. We should not use .lstrip
+        # on it because that way we can preserve
+        # indent.
+        @usher << entry.delete('#') # .lstrip
+      end
+    }
+    @result = @usher._
+  end
+  def show_file_header(i)
+    e 'From file '+sfile(i)+':'+N+N
+  end
   def process
-    read_in_file
-    process_dataset
+    @files.each {|file|
+      show_file_header(file)
+      read_in_file(file)
+      process_dataset
+      show_result
+      e
+    }
   end
   def run # (run tag)
     process
-    show_result
   end
 
 end

metadata

@@ -1,64 +1,68 @@
 --- !ruby/object:Gem::Specification
 name: class_docu_shower
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Robert A. Heiler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-08 00:00:00.000000000 Z
+date: 2014-04-16 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
-
-'
+description: "\n    This library is called class_docu_shower.\n    \n    It will display
+  the header of a .rb file in question.\n    For this to properly function, you should
+  use 3 =\n    followed by the name of the class, and delimited\n    in # ===== entries.\n
+  \   \n    Example:\n    \n    === Menu\n\n    If you have specific suggestions to
+  make this gem more\n    useful for others, please drop me an email at:\n      shevegen@gmail.com\n
+  \   Thank you.\n\n"
 email: shevegen@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- USAGE.md
 files:
 - USAGE.md
 - class_docu_shower.gemspec
@@ -74,12 +78,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -87,6 +91,10 @@ 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.'
+summary: 'It will display the header of a .rb file in question. For this to properly
+  function, you should use 3 = followed by the name of the class, and delimited in
+  # ===== entries.  Example:  === Menu  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: []
+has_rdoc: