class_notes 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c438fdb093ecd7108e075de06c7a4f6c909fe9c6
-  data.tar.gz: e24bbe368325884d3c242283a7265cb5ce966baa
+  metadata.gz: c086793af4a6d967fc3d39cf4da4e267507e72ae
+  data.tar.gz: ed62bbe8a97d9e8d096c153643f299a729c5cbf9
 SHA512:
-  metadata.gz: 0e981e9ef4763017560efc5d3ee7f6dea94131ce76e9e53bbb921450c85167b11ce6fedc9399cb8cb37a31dda4eeabeb74551138f30736a4a59c00bb1288de50
-  data.tar.gz: 030f1a10b8bf78c85c350b712baf8e9608a491727c74762189e05fda660deac3b00100fc8d4a0a1c6b6e501690fed1ed874b06e89f2913e63882e77b4fd02f45
+  metadata.gz: 147ac4547ec928963ae8288fd8c607cc42cf61ef23e8629906cd6e4456559df3e95f340771aa7b2a41b0c781fe940aa07f4d06108f41a688f3eaa016f028beb1
+  data.tar.gz: e881a25cb665bc54417a04245e5ca847b2f4b46ae3683c29056b4a7b71c6318c7d6c822da5c7aa6c37fb73a0a8a195a2355370b85bd51f1c1fe0bd69157adfc3

data/README.md

@@ -1,5 +1,5 @@
 # class_notes
-[![Gem Version](https://badge.fury.io/rb/class_notes.svg)](https://badge.fury.io/rb/class_notes)
+[![Gem Version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=rb&type=6&v=2.0.0&x2=0)](https://rubygems.org/gems/class_notes)
 
 make your classes take notes
 
@@ -35,3 +35,5 @@ puts notebook.notes # =>
 #    {:args=>{:a=>"1", :b=>"2", :c=>"3", :d=>"4"}, :result=>10}
 #  {}
 ```
+## docs:
+http://www.rubydoc.info/gems/class_notes

data/lib/class_notes.rb

@@ -2,7 +2,7 @@ require_relative 'class_notes/note'
 require_relative 'class_notes/notebook'
 
 module ClassNotes
-  ::Version = [1, 0, 1]
+  self::Version = [2, 0, 0]
 
   ## @brief create a new note taker Proc on parent
   ## @param parent the parent note

data/lib/class_notes/note.rb

@@ -3,7 +3,8 @@ module ClassNotes
   ## @brief      Class for a single step.
   ##
   class Note
-    attr_accessor :title, :data, :children
+    attr_accessor :title, :children
+    attr_reader :args, :results
 
     ##
     ## @brief      makes a new note
@@ -13,10 +14,39 @@ module ClassNotes
     ##
     ## @return     a new note object
     ##
-    def initialize(title:, data:)
-      @children = []
+    def initialize(title:, args:nil, results:nil)
       @title    = title
-      @data     = data
+      self.args=(args) if args
+      self.results=(results) if results
+
+      @children = []
+    end
+
+    def args=(args)
+      @args =
+        if args.length == 1 and args.first.class == Hash
+          normalize(args.first)
+        else
+          normalize(args)
+        end
+    end
+
+    def results=(data)
+      @results=normalize(data)
+    end
+
+    def normalize(data)
+      case data
+      when Hash
+        data.map { |t, v| [t, v.to_s]}.to_h
+      when Array
+        i = -1
+        data.map { |e|
+          [ i+=1 , e.to_s]
+        }.to_h
+      else
+        {0 => "#{data}"}
+      end
     end
 
     ##
@@ -47,16 +77,30 @@ module ClassNotes
       @children.last
     end
 
+    def h_to_s(hash, pre)
+      hash.map { |i, a| pre + "#{i}: #{a}" }.join("\n")
+    end
+
+    def tab(i)
+      "  " * i
+    end
+
     ## @brief render the note as a string
     ## @param indent the indent level of the base string
     ## @return String
-    def to_s(indent=0)
+    def to_s(i=0)
       [
-        "#{"  " * indent}#{title}",
+        tab(i) + "#{title}:",
+        if args and not args.empty?
+          tab(i+1) + "args:\n" + h_to_s(args, tab(i+2))
+        end,
         unless children.empty?
-          children.map { |child| child.to_s(indent+1) }.join("\n")
+          tab(i+1) + "children:\n" +
+          children.map { |child| child.to_s(i+2) }.join("\n")
         end,
-        "#{"  " * (indent+1)}#{data}"
+        if results
+          tab(i+1) + "results:\n" + h_to_s(results, tab(i+2))
+        end
       ].compact.join("\n")
     end
 
@@ -65,8 +109,9 @@ module ClassNotes
     def to_h
       {
         title: title,
+        args: args,
         children: children.empty? ? nil : children.map { |child| child.to_h },
-        data: data
+        results: results
       }.compact
     end
   end

data/lib/class_notes/notebook.rb

@@ -1,6 +1,6 @@
 module ClassNotes
   module Notebook
-    ::WrappedSuffix = "Notebook"
+    self::WrappedSuffix = "Notebook"
 
     ## @brief wrap a class in notes
     ## @param klass the class
@@ -11,15 +11,15 @@ module ClassNotes
 
         attr_reader :notes, :add_note
 
-        def initialize
-          @notes    = ClassNotes::Note.new(title: self.class.to_s, data: {})
+        def initialize(*args, &block)
+          @notes    = ClassNotes::Note.new(title: self.class.to_s)
           @add_note = ClassNotes.note_taker(notes)
           wrap_methods(*self.class.superclass.instance_methods(false))
+          super(*args, &block)
         end
       }
 
-
-      notebook_name = "#{klass.to_s}#{::WrappedSuffix}"
+      notebook_name = "#{klass.name.split("::").last}#{Notebook::WrappedSuffix}"
       Object.const_set notebook_name, notebook
 
       notebook
@@ -32,25 +32,16 @@ module ClassNotes
       meths.each { |meth|
         m = method(meth)
         define_singleton_method(meth) { |*args, &block|
-
           parent    = add_note
-          child     = add_note.({title: meth.to_s, data: {}})
+          child     = add_note.({title: meth.to_s, args: args})
           @add_note = ClassNotes.note_taker(child)
 
-          result    = super(*args, &block)
+          results   = super(*args, &block)
           @add_note = parent
 
-          pretty_args =
-            case args.first
-            when Hash
-              args.first.map { |t, v| [t, v.to_s]}.to_h
-            else
-              args
-            end
-
-          child.data = {args: pretty_args, result: result}
+          child.results = results
 
-          result
+          results
         }
       }
     end

data/test/simple_math.rb

@@ -7,6 +7,10 @@ class SimpleMath
     a + b
   end
 
+  def recurse(i=0)
+    recurse i+1 unless i > 10
+  end
+
   def add_4(a:,b:,c:,d:)
     add(a: add(a: a, b: b), b: add(a: c, b: d) )
   end

data/test/test_class_notes.rb

@@ -26,7 +26,11 @@ class TestClassNotes < Test::Unit::TestCase
     @notebook.add_4(a: 1, b: 2, c: 3, d: 4)
     notes = @notebook.notes
     assert_equal notes.title, "SimpleMathNotebook"
-    assert_equal notes.to_h[:children].first[:children][2][:children].first[:data][:args][1], 7
+  end
+
+  def test_recursion
+    @notebook.recurse
+    puts @notebook.notes
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: class_notes
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - annacrombie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-10 00:00:00.000000000 Z
+date: 2017-09-11 00:00:00.000000000 Z
 dependencies: []
 description: wrap a classes instance methods in logic that keeps track of their actions
 email: stone.tickle@gmail.com