class ClassDocuShower

# File lib/class_docu_shower/class_docu_shower.rb, line 282
def self.[](i)
  ClassDocuShower.new(i)
end

# File lib/class_docu_shower/class_docu_shower.rb, line 56
def initialize(
    i           = nil,
    run_already = true
  )
  be_silent
  reset
  set_files(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
  else
    case run_already
    when :silent
      be_silent
      run_already = true
    when :no_colours
      @use_colours = false
      run_already = true
    end
  end
  if block_given?
    yielded = yield
    case yielded
    when :do_not_report_the_filename
      @report_the_filename = false
    end
  end
  run if run_already
end

# File lib/class_docu_shower/class_docu_shower.rb, line 123
def be_silent
  @be_verbose = false
end

# File lib/class_docu_shower/class_docu_shower.rb, line 116
def be_verbose
  @be_verbose = true
end

# File lib/class_docu_shower/class_docu_shower.rb, line 130
def file?
  @file.to_s
end

# File lib/class_docu_shower/class_docu_shower.rb, line 191
def files?
  @files
end

# File lib/class_docu_shower/colours.rb, line 26
def lightblue(i)
  ::Colours.lightblue(i)
end

# File lib/class_docu_shower/colours.rb, line 12
def orange(i)
  ::Colours.orange(i)
end

# File lib/class_docu_shower/class_docu_shower.rb, line 208
def process
  @files.each {|file|
    show_file_header(file)
    read_in_file(file)
    process_dataset
    show_result
    e
  }
end

# File lib/class_docu_shower/class_docu_shower.rb, line 221
def process_dataset
  reset_usher_object
  if @data
    @data.each {|entry| # @data is an Array.
      if entry.include? FORBIDDEN_CHARACTERS # Reject leading '# ===' parts.
        @usher.toggle if @usher
      else
        # ================================================================= #
        # Else add the entry. We should not use .lstrip on it because
        # that way we can preserve the original indent.
        # ================================================================= #
        entry.delete!('#') # .lstrip
        if use_colours? and Object.const_defined?(:Colours)
          if entry.start_with? ' ==='
            entry = orange(entry)
          elsif entry.include? 'Usage examples:'
            entry = lightblue(entry)
          end
        end
        @usher << entry if @usher
      end
    }
    @result = @usher._ if @usher
  end
end

# File lib/class_docu_shower/class_docu_shower.rb, line 153
def read_in_file(this_file = @file)
  if File.exist? this_file
    @data = File.readlines(this_file, :encoding => ENCODING_TO_USE)
  else # We should report.
    result = 'We could not find a file at '+sfile(this_file)+','
    result = Colours.remove_colours(result) unless use_colours?
    opn; e result
    result = 'thus can not check whether it has an documentation.'
    result = Colours.remove_colours(result) unless use_colours?
    opn; e result
  end
end

# File lib/class_docu_shower/class_docu_shower.rb, line 91
def reset
  @data   = nil
  if Object.const_defined? :Usher
    @usher = Usher.new
  else
    @usher = nil
  end
  @result = nil
  @use_colours = true
  @report_the_filename = true
end

# File lib/class_docu_shower/class_docu_shower.rb, line 106
def reset_usher_object
  if @usher
    @usher.reset
    @usher.allow_n_changes = 1
  end
end

# File lib/class_docu_shower/class_docu_shower.rb, line 169
def result?
  @result
end

# File lib/class_docu_shower/class_docu_shower.rb, line 275
def run
  process
end

# File lib/class_docu_shower/class_docu_shower.rb, line 250
def set_files(i = DEFAULT_FILE)
  i = DEFAULT_FILE if i.nil?
  # i = i.to_s.dup if i
  i = [i] unless i.is_a? Array # Must always be an Array.
  i.flatten! # But keep it flattened.
  @files = i
end

# File lib/class_docu_shower/class_docu_shower.rb, line 198
def sfile(i = '')
  i = Colours.sfile(i) if use_colours?
  return i
end

# File lib/class_docu_shower/class_docu_shower.rb, line 264
def show_file_header(i)
  if @report_the_filename#
    result = 'From file '+sfile(i)+':'+N+N
    result = Colours.remove_colours(result) unless use_colours?
    e result
  end
end

# File lib/class_docu_shower/class_docu_shower.rb, line 176
def show_result
  if @be_verbose # We will be chatty here, aka, verbose.
    result = 'From the file '+sfile(file?)+' we '
    result = Colours.remove_colours(result) unless use_colours?
    opn; e result
    result = 'can show this result:'
    result = Colours.remove_colours(result) unless use_colours?
    opn; e result
  end 
  show_the_result
end

# File lib/class_docu_shower/class_docu_shower.rb, line 137
def show_the_result
  e @result if result?
end

# File lib/class_docu_shower/colours.rb, line 19
def slateblue(i)
  ::Colours.slateblue(i)
end

# File lib/class_docu_shower/class_docu_shower.rb, line 144
def use_colours?
  @use_colours
end