structured_log 0.9.0

data/readme_files/logs/array.xml

@@ -0,0 +1,10 @@
+<log>
+  <each_with_index name='my_array' class='Array'>
+    <![CDATA[
+     0 foo
+     1 bar
+     2 baz
+     3 bat
+]]>
+  </each_with_index>
+</log>

data/readme_files/logs/attributes.xml

@@ -0,0 +1,7 @@
+<log>
+  <section name='with_attributes' a='0' b='1'>
+    <comment>
+      This section has attributes a and b.
+    </comment>
+  </section>
+</log>

data/readme_files/logs/cdata.xml

@@ -0,0 +1,12 @@
+<log>
+  <![CDATA[
+Method put_cdata puts the data verbatim:
+
+* Nothing is added or subtracted.
+* Not even whitespace.
+
+So you can use the method to log a formatted string.
+
+(You'll need to add your own leading and trailing newlines, if desired.)
+]]>
+</log>

data/readme_files/logs/comment.xml

@@ -0,0 +1,5 @@
+<log>
+  <comment>
+    My comment can be any text.
+  </comment>
+</log>

data/readme_files/logs/custom_entry.xml

@@ -0,0 +1,12 @@
+<log>
+  <section name='Without blocks'>
+    <element_with_text>
+      No child elements, just this text.
+    </element_with_text>
+    <element_with_attributes a='0' b='1'/>
+    <element_with_timestamp timestamp='2018-06-09-Sat-11.38.09.357'/>
+    <element_with_data>
+      3.14159
+    </element_with_data>
+  </section>
+</log>

data/readme_files/logs/custom_section.xml

@@ -0,0 +1,14 @@
+<log>
+  <section name='With blocks'>
+    <section_with_children>
+      <child rank='Older'/>
+      <child rank='Younger'/>
+    </section_with_children>
+    <section_with_duration duration_seconds='1.016'>
+      Block contains timed code to be timed.
+    </section_with_duration>
+    <section_with_rescue>
+      Block contains code to be rescued if necessary.
+    </section_with_rescue>
+  </section>
+</log>

data/readme_files/logs/data.xml

@@ -0,0 +1,20 @@
+<log>
+  <data name='my_float' class='Float'>
+    <![CDATA[3.14]]>
+  </data>
+  <data name='my_fixnum' class='Fixnum'>
+    <![CDATA[1066]]>
+  </data>
+  <data name='my_false' class='FalseClass'>
+    <![CDATA[false]]>
+  </data>
+  <data name='my_time' class='Time'>
+    <![CDATA[2018-06-09 11:38:10 -0500]]>
+  </data>
+  <data name='my_exception' class='RuntimeError'>
+    <![CDATA[#<RuntimeError: Oops!>]]>
+  </data>
+  <data name='my_nil' class='NilClass'>
+    <![CDATA[nil]]>
+  </data>
+</log>

data/readme_files/logs/exception.xml

@@ -0,0 +1,14 @@
+<log>
+  <uncaught_exception timestamp='2018-06-09-Sat-11.38.10.967' class='RuntimeError'>
+    <message>
+      Oops!
+    </message>
+    <backtrace>
+      <![CDATA[
+C:/Users/Burdette/Documents/GitHub/structured_log/readme_files/scripts/exception.rb:4:in `block in <main>'
+C:/Ruby22-x64/lib/ruby/gems/2.2.0/gems/structured_log-0.1.0/lib/structured_log.rb:38:in `open'
+C:/Users/Burdette/Documents/GitHub/structured_log/readme_files/scripts/exception.rb:3:in `<main>'
+]]>
+    </backtrace>
+  </uncaught_exception>
+</log>

data/readme_files/logs/hash.xml

@@ -0,0 +1,10 @@
+<log>
+  <each_pair name='my_hash' class='Hash'>
+    <![CDATA[
+a => z
+aa => zz
+aaa => zzz
+aaaa => zzzz
+]]>
+  </each_pair>
+</log>

data/readme_files/logs/potpourri.xml

@@ -0,0 +1,13 @@
+<log>
+  <section name='All together now'>
+    Order does not matter except in aggregating text and attributes.
+    <section name='Potpourri' a='0' b='1' c='2' d='3' timestamp='2018-06-09-Sat-11.38.11.279' duration_seconds='0.000'>
+      This section has a potpourri.3.14159false10662018-06-09 11:38:11
+      -0500#&lt;RuntimeError: Oops!&gt;
+    </section>
+    <section name='Reverse potpourri' timestamp='2018-06-09-Sat-11.38.11.279' c='2' d='3' a='0' b='1' duration_seconds='0.000'>
+      #&lt;RuntimeError: Oops!&gt;2018-06-09 11:38:11 -05001066false3.14159This
+      section has a potpourri.
+    </section>
+  </section>
+</log>

data/readme_files/logs/potpourri_other.xml

@@ -0,0 +1,20 @@
+<log>
+  <section name='Others'>
+    Other values are logged as the string returned by value.inspect.
+    <section name='Log instance of Float'>
+      3.14159
+    </section>
+    <section name='Log instance of FalseClass'>
+      false
+    </section>
+    <section name='Log instance of Fixnum'>
+      1066
+    </section>
+    <section name='Log instance of Time'>
+      2018-06-09 11:38:11 -0500
+    </section>
+    <section name='Log instance of RuntimeError'>
+      #&lt;RuntimeError: Oops!&gt;
+    </section>
+  </section>
+</log>

data/readme_files/logs/potpourri_usual.xml

@@ -0,0 +1,8 @@
+<log>
+  <section name='The usual'>
+    Mixed hash, string, and special symbols are logged as usual.
+    <section name='Potpourri' a='0' b='1' timestamp='2018-06-09-Sat-11.38.11.670' duration_seconds='1.016'>
+      This section has a potpourri.
+    </section>
+  </section>
+</log>

data/readme_files/logs/rescue.xml

@@ -0,0 +1,28 @@
+<log>
+  <section name='Section with rescue'>
+    <comment>
+      This section will terminate because of the failure.
+    </comment>
+    <rescued_exception timestamp='2018-06-09-Sat-11.38.12.889' class='RuntimeError'>
+      <message>
+        This exception will be rescued and logged.
+      </message>
+      <backtrace>
+        <![CDATA[
+C:/Users/Burdette/Documents/GitHub/structured_log/readme_files/scripts/rescue.rb:6:in `block (2 levels) in <main>'
+C:/Ruby22-x64/lib/ruby/gems/2.2.0/gems/structured_log-0.1.0/lib/structured_log.rb:58:in `block in section'
+C:/Ruby22-x64/lib/ruby/gems/2.2.0/gems/structured_log-0.1.0/lib/structured_log.rb:116:in `put_element'
+C:/Ruby22-x64/lib/ruby/gems/2.2.0/gems/structured_log-0.1.0/lib/structured_log.rb:57:in `section'
+C:/Users/Burdette/Documents/GitHub/structured_log/readme_files/scripts/rescue.rb:4:in `block in <main>'
+C:/Ruby22-x64/lib/ruby/gems/2.2.0/gems/structured_log-0.1.0/lib/structured_log.rb:38:in `open'
+C:/Users/Burdette/Documents/GitHub/structured_log/readme_files/scripts/rescue.rb:3:in `<main>'
+]]>
+      </backtrace>
+    </rescued_exception>
+  </section>
+  <section name='Another section'>
+    <comment>
+      This comment will be reached and logged, because of rescue above.
+    </comment>
+  </section>
+</log>

data/readme_files/logs/sections.xml

@@ -0,0 +1,7 @@
+<log>
+  <section name='Outer'>
+    <section name='Mid'>
+      <section name='Inner'/>
+    </section>
+  </section>
+</log>

data/readme_files/logs/text.xml

@@ -0,0 +1,5 @@
+<log>
+  <section name='with_text'>
+    This section has text.
+  </section>
+</log>

data/readme_files/logs/time.xml

@@ -0,0 +1,17 @@
+<log>
+  <section name='Section with timestamp' timestamp='2018-06-09-Sat-11.38.13.373'>
+    <comment>
+      This section has a timestamp.
+    </comment>
+  </section>
+  <section name='Section with duration' duration_seconds='1.016'>
+    <comment>
+      This section has a duration.
+    </comment>
+  </section>
+  <section name='Section with both' timestamp='2018-06-09-Sat-11.38.14.389' duration_seconds='1.000'>
+    <comment>
+      This section has both.
+    </comment>
+  </section>
+</log>

data/readme_files/scripts/array.rb

@@ -0,0 +1,6 @@
+require 'structured_log'
+
+array = %w/foo bar baz bat/
+StructuredLog.open('array.xml') do |log|
+  log.put_array('my_array', array)
+end

data/readme_files/scripts/attributes.rb

@@ -0,0 +1,8 @@
+require 'structured_log'
+
+attributes = {:a => 0, :b => 1}
+StructuredLog.open('attributes.xml') do |log|
+  log.section('with_attributes', attributes) do
+    log.comment('This section has attributes a and b.')
+  end
+end

data/readme_files/scripts/cdata.rb

@@ -0,0 +1,17 @@
+require 'structured_log'
+
+text = <<EOT
+
+Method put_cdata puts the data verbatim:
+
+* Nothing is added or subtracted.
+* Not even whitespace.
+
+So you can use the method to log a formatted string.
+
+(You'll need to add your own leading and trailing newlines, if desired.)
+
+EOT
+StructuredLog.open('cdata.xml') do |log|
+  log.put_cdata(text)
+end

data/readme_files/scripts/comment.rb

@@ -0,0 +1,5 @@
+require 'structured_log'
+
+StructuredLog.open('comment.xml') do |log|
+  log.comment('My comment can be any text.')
+end

data/readme_files/scripts/custom_entry.rb

@@ -0,0 +1,10 @@
+require 'structured_log'
+
+StructuredLog.open('custom_entry.xml') do |log|
+  log.section('Without blocks') do
+    log.put_element('element_with_text', 'No child elements, just this text.')
+    log.put_element('element_with_attributes', {:a => 0, :b => 1})
+    log.put_element('element_with_timestamp', :timestamp)
+    log.put_element('element_with_data', 3.14159)
+  end
+end

data/readme_files/scripts/custom_section.rb

@@ -0,0 +1,15 @@
+require 'structured_log'
+
+StructuredLog.open('custom_section.xml') do |log|
+  log.section('With blocks') do
+    log.put_element('section_with_children') do
+      log.put_element('child', :rank => 'Older')
+      log.put_element('child', :rank => 'Younger')
+    end
+    log.put_element('section_with_duration', :duration, 'Block contains timed code to be timed.') do
+      sleep 1
+    end
+    log.put_element('section_with_rescue', :rescue, 'Block contains code to be rescued if necessary.') do
+    end
+  end
+end

data/readme_files/scripts/data.rb

@@ -0,0 +1,16 @@
+require 'structured_log'
+
+data = {
+    :float => 3.14,
+    :fixnum => 1066,
+    :false => false,
+    :time => Time.new,
+    :exception => RuntimeError.new('Oops!'),
+    :nil => nil,
+}
+StructuredLog.open('data.xml') do |log|
+  data.each_pair do |type, datum|
+    name = "my_#{type}"
+    log.put_data(name, datum)
+  end
+end

data/readme_files/scripts/exception.rb

@@ -0,0 +1,5 @@
+require 'structured_log'
+
+StructuredLog.open('exception.xml') do |log|
+  fail('Oops!')
+end

data/readme_files/scripts/hash.rb

@@ -0,0 +1,11 @@
+require 'structured_log'
+
+hash = {
+    :a => 'z',
+    :aa => 'zz',
+    :aaa => 'zzz',
+    :aaaa => 'zzzz',
+}
+StructuredLog.open('hash.xml') do |log|
+  log.put_hash('my_hash', hash)
+end

data/readme_files/scripts/potpourri.rb

@@ -0,0 +1,20 @@
+require 'structured_log'
+
+attributes = {:a => 0, :b => 1}
+more_attributes = {:c => 2, :d => 3}
+text = 'This section has a potpourri.'
+float = 3.14159
+boolean = false
+fixnum = 1066
+time = Time.new
+exception = RuntimeError.new('Oops!')
+
+StructuredLog.open('potpourri.xml') do |log|
+  log.section('All together now', 'Order does not matter except in aggregating text and attributes.')  do
+    args = [attributes, :rescue, text, float, :duration, more_attributes, boolean, :timestamp, fixnum, time, exception]
+    log.section('Potpourri', *args) do
+    end
+    log.section('Reverse potpourri', *args.reverse) do
+    end
+  end
+end

data/readme_files/scripts/potpourri_other.rb

@@ -0,0 +1,17 @@
+require 'structured_log'
+
+float = 3.14159
+boolean = false
+fixnum = 1066
+time = Time.new
+exception = RuntimeError.new('Oops!')
+
+StructuredLog.open('potpourri_other.xml') do |log|
+  log.section('Others', 'Other values are logged as the string returned by value.inspect.')do
+    [float, boolean, fixnum, time, exception].each do |value|
+      element_name = "Log instance of #{value.class}"
+      log.section(element_name, value) do
+      end
+    end
+  end
+end

data/readme_files/scripts/potpourri_usual.rb

@@ -0,0 +1,12 @@
+require 'structured_log'
+
+attributes = {:a => 0, :b => 1}
+text = 'This section has a potpourri.'
+
+StructuredLog.open('potpourri_usual.xml') do |log|
+  log.section('The usual', 'Mixed hash, string, and special symbols are logged as usual.') do
+    log.section('Potpourri', attributes, text, :timestamp, :duration, :rescue) do
+      sleep 1
+    end
+  end
+end

data/readme_files/scripts/rescue.rb

@@ -0,0 +1,12 @@
+require 'structured_log'
+
+StructuredLog.open('rescue.xml') do |log|
+  log.section('Section with rescue', :rescue) do
+    log.comment('This section will terminate because of the failure.')
+    fail 'This exception will be rescued and logged.'
+    log.comment('This comment will not be reached.')
+  end
+  log.section('Another section') do
+    log.comment('This comment will be reached and logged, because of rescue above.')
+  end
+end

data/readme_files/scripts/sections.rb

@@ -0,0 +1,17 @@
+require 'structured_log'
+
+StructuredLog.open('sections.xml') do |log|
+  # Any code can be here.
+  log.section('Outer') do
+    # Any code can be here.
+    log.section('Mid') do
+      # Any code can be here.
+      log.section('Inner') do
+        # Any code can be here.
+      end
+      # Any code can be here.
+    end
+    # Any code can be here.
+  end
+  # Any code can be here.
+end

data/readme_files/scripts/text.rb

@@ -0,0 +1,8 @@
+require 'structured_log'
+
+text = 'This section has text.'
+StructuredLog.open('text.xml') do |log|
+  log.section('with_text', text) do
+    # Any code can be here.
+  end
+end

data/readme_files/scripts/time.rb

@@ -0,0 +1,15 @@
+require 'structured_log'
+
+StructuredLog.open('time.xml') do |log|
+  log.section('Section with timestamp', :timestamp) do
+    log.comment('This section has a timestamp.')
+  end
+  log.section('Section with duration', :duration) do
+    log.comment('This section has a duration.')
+    sleep 1
+  end
+  log.section('Section with both', :duration, :timestamp) do
+    log.comment('This section has both.')
+    sleep 1
+  end
+end