Class: Docgenerator::Rubycode::CodeTest

Inherits:
Object
  • Object
show all
Defined in:
lib/docgenerator/packages/rubycode4doc.rb

Overview

Basic Idea:

  • Execute ruby code line by line

  • Show result per line

Defined Under Namespace

Classes: Code_line, MyIO

Constant Summary collapse

@@all = 
{}

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, code = '') ⇒ CodeTest

Get some executable ruby code and analyse it. If a name is given, it is stored for later reuse (see CodeTest[])



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 36

def initialize( name, code = '' )
  @name = name
  if @@all[@name]
    raise "Double definition of CodeTest #{name.inspect}"
  else
    @@all[@name] = self
  end if name
  #Keep binding for code execution

  @bind = binding
  #Collection of all coding lines (elements are Code_line-struct)

  @codelines  = []
  code.split(/\n/).each{|c|
    self << c
  }
end

Class Method Details

.[](name) ⇒ Object

Get the code fragment



187
188
189
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 187

def self.[](name)
  @@all[name]
end

.mk_document(title) ⇒ Object

Build a Document with required head-definitions (usepackage…)



194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 194

def self.mk_document( title )
  doc = Document.new(
    :title => title
  )
  doc.head  << element(:usepackage,{ }, 'listings').cr
  doc.head  << element(:usepackage,{ }, 'color').cr
  doc.head  << element(:lstloadlanguages,{}, 'ruby' ).cr
  doc.head  << element(:lstset,  {
                      :language => 'ruby',
                      :commentstyle  => '\ccolor{blue}',
                    } ).cr
  return doc
end

Instance Method Details

#<<(c) ⇒ Object

Add one coding line. -Each line is executed, -The result of the line is added to #result -The output is added to #output

Restrictions: -One line, one command (only last command returns its result)



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 60

def << ( c )
  #fixme: command mit Strings "#...

  command, comment = c.chomp.split(/#/, 2 )
  #~ if comment

    #~ puts '--'*10 + 'comment'

    #~ puts c.chomp

    #~ puts command

    #~ puts comment.inspect

  #~ end

  begin
  $stdout = output = MyIO.new
  codeline = Code_line.new( c.chomp, @codelines.size + 1, eval(c, @bind) )
  rescue SyntaxError
    $stdout = STDOUT
    DOCGENERATOR_LOGGER.error("CodeTest #{@name}: Syntax Error with: '#{c}'") if DOCGENERATOR_LOGGER.error?
    return
  end
  $stdout = STDOUT
  codeline.outputtab  = []
  if output.size > 0
    codeline.output    = output.inspect
    codeline.outputtab  = output.split("\n")
  end      
  codeline.comment  = comment
  @codelines  << codeline
end

#code ⇒ Object

Get code



143
144
145
146
147
148
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 143

def code()
  element(:lstlisting,{  :numbers => 'left',
                  :numberstyle  => '\tiny',
                  :class => 'rubycode',
                }, @codelines.map{|codeline| codeline.code}.join("\n")).cR
end

#code_evaluation(max = @codelines.map{|f|f.code.size}.max + 3) ⇒ Object

Get code and results in a verbatim env. The comments starts after the column max. (default: longest code line + 3 )

Example:

1 + 1

becomes

1 + 1   #2

fixme: define scope, from-to line



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 114

def code_evaluation( max = @codelines.map{|f|f.code.size}.max  + 3 )
  evaluated_code  = []
  @codelines.each{|codeline|
    #Prepare coding line with result of the line if not done before

    evaluated_line  = "%-#{max}s" %  [ codeline.code ]
    if codeline.result or codeline.output
      evaluated_line  << " # "
    end
    if codeline.result
      evaluated_line  << '-> %-10s' % [ codeline.result ]
    end
    if codeline.output
      evaluated_line  << '=> %-10s' % [ codeline.output ]
    end
    evaluated_code << evaluated_line
  }
  evaluated_code.join("\n")
end

#code_evaluation_lstlisting(max = @codelines.map{|f|f.code.size}.max + 3) ⇒ Object

Get code and results in a lstlistings environment.



134
135
136
137
138
139
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 134

def code_evaluation_lstlisting( max = @codelines.map{|f|f.code.size}.max  + 3 )
  element(:lstlisting,{  :numbers => 'left',
                  :numberstyle  => '\tiny',
                  :class => 'rubycode_with_result',
                }, self.code_evaluation( max) ).cR
end

#code_in_tab ⇒ Object

return tabular with code, result and output.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 152

def code_in_tab()
  #~ element(:verbatim,{}, @code)

    #~ puts 'tabularx mag kein verbatim'

  #~ tabular = element(:tabularx, {  

          #~ :columndescription => 'lXllXX', 

          #~ :width  => '\\textwidth',

  tabular = element(:tabular, {  
          :columndescription => 'lp{3cm}llp{3cm}', 
          :columns => 5, 
          :border => 1,
        }).Cr
    tabular << row = element(:row).cr.hline
    row << element(:col, {}, 'No' )
    row << element(:col, {}, 'Code' )
    row << element(:col, {}, 'Result' )
    row << element(:col, {}, 'Output' )
    row << element(:col, {}, 'Output2' )
  @codelines.each{|c|
    tabular << row = element(:row).cr
    row << element(:col, {}, c.line_number )
    if c.code.include?("\n")
      row << element(:col, {}, element(:lstlisting,{:class => 'rubycode' }, ["\n", c.code])  ).Cr
    else
      row << element(:col, {}, element(:lstinline,{:class => 'rubycode' }, c.code)  )
    end
    row << element(:col, {}, c.result  )
    row << element(:col, {}, c.output ? element(:verb,{ :class => 'ruby_result_string' }, c.output) : nil )
    #~ row << element(:col, {}, c.outputtab.map{|i| [i, element(:br)]}.flatten[0..-2] )

    row << element(:col, {}, element(:verbatim,{:class => 'ruby_result'}, c.outputtab.join("\n") ) )
  }
  tabular
end

#output ⇒ Object

Get ‘plain’ output



95
96
97
98
99
100
101
102
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 95

def output()
  output  = []
  @codelines.each{|codeline|
    #~ output << codeline.output

    output << codeline.outputtab
  }
  output.join("\n")
end

#sourcecode ⇒ Object

Get ‘plain’ sourcecode



87
88
89
90
91
92
93
 
# File 'lib/docgenerator/packages/rubycode4doc.rb', line 87

def sourcecode()
  code  = []
  @codelines.each{|codeline|
    code << codeline.code
  }
  code.join("\n")
end