nm 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: d389b30bc53c3293e4e428b9126c64838124a270d3f535ce360ca3cf984466537f2707a2c149b8ae3d1cbcb231f685a24af6b5ed41f12f0a2b22b7d207f2db09
+  data.tar.gz: 9be9ce99e660a80fe20d6e034de82511081b9ad00cf30dbd0b879ff2ec0ebb671279f30611572ffc00e7be77bea456af5d09b1108147f63a9e2c4d7da4e4d461
+SHA1: 
+  metadata.gz: 6e4b7a81896c762b7c9dea9b642f4eb3c4137967
+  data.tar.gz: 579835a684d21fde132b8ab12bd0423381629f44

data/Gemfile

@@ -4,6 +4,9 @@ gemspec
 
 gem 'rake'
 gem 'pry'
+gem "whysoslow"
+
+gem 'rabl'
 
 platform :rbx do
   gem 'rubysl'

data/README.md

@@ -1,13 +1,13 @@
 # Nm
 
-JSON/BSON data structure template system.  Named for its two template methods: "node" and "map".
+Data templating system.  Named for its two main markup methods: "node" and "map".  Designed to template data objects for JSON/BSON/whatever/etc serialization.
 
 ## Usage
 
 Template:
 
 ```ruby
-# in views/slideshow.json.nm
+# in /path/to/views/slideshow.json.nm
 
 node 'slideshow' do
   node 'start_slide', start_slide
@@ -23,35 +23,115 @@ node 'slideshow' do
 end
 ```
 
+Render:
+
+```ruby
+require 'nm'
+source = Nm::Source.new('/path/to/views')
+source.render('slideshow.json', {
+  :start_slide => 1,
+  :slides => [ ... ] #=> list of slide objects 1, 2 and 3
+})
+```
+
 Output:
 
-```json
-{ "slideshow": {
-    "start_slide": 1,
-    "slides": [
-      { "id":    "slide-1",
-        "title": "Slide 1",
-        "thumb": "//path/to/slide-1-thumb.jpg",
-        "image": "//path/to/slide-1-image.jpg",
-        "url":   "//path/to/slide-1-url",
+```ruby
+{ "slideshow" => {
+    "start_slide" => 1,
+    "slides" => [
+      { "id"    => "slide-1",
+        "title" => "Slide 1",
+        "thumb" => "//path/to/slide-1-thumb.jpg",
+        "image" => "//path/to/slide-1-image.jpg",
+        "url"   => "//path/to/slide-1-url",
       },
-      { "id":    "slide-2",
-        "title": "Slide 2",
-        "thumb": "//path/to/slide-2-thumb.jpg",
-        "image": "//path/to/slide-2-image.jpg",
-        "url":   "//path/to/slide-2-url",
+      { "id"    => "slide-2",
+        "title" => "Slide 2",
+        "thumb" => "//path/to/slide-2-thumb.jpg",
+        "image" => "//path/to/slide-2-image.jpg",
+        "url"   => "//path/to/slide-2-url",
       },
-      { "id":    "slide-3",
-        "title": "Slide 3",
-        "thumb": "//path/to/slide-3-thumb.jpg",
-        "image": "//path/to/slide-3-image.jpg",
-        "url":   "//path/to/slide-3-url",
+      { "id"    => "slide-3",
+        "title" => "Slide 3",
+        "thumb" => "//path/to/slide-3-thumb.jpg",
+        "image" => "//path/to/slide-3-image.jpg",
+        "url"   => "//path/to/slide-3-url",
       }
     ]
   }
 }
 ```
 
+## Notes
+
+### Render Format
+
+Rendering templates returns a data object (`::Hash` or `::Array`).  To serialize, bring in your favorite JSON/BSON/whatever serializer and pass the rendered object to it.
+
+### Markup Methods
+
+There are two main markup methods:
+
+* `node`: create a named attribute on a hash object
+* `map`: create a list object mapped from a given list
+
+### Partials
+
+**Note**: using partials negatively impacts template rendering performance.
+
+(from example above)
+
+```ruby
+# in /path/to/views/slideshow.json.nm
+
+node 'slideshow' do
+  node 'start_slide', start_slide
+  node 'slides' do
+    map slides do |slide|
+      partial 'slide.json', :slide => slide
+    end
+  end
+end
+
+# in /path/to/views/_slide.json.nm
+
+node 'id',    slide.id
+node 'title', slide.title
+node 'image', slide.image_url
+node 'thumb', slide.thumb_url
+node 'url',   slide.url
+```
+
+This will render the same output as above.
+
+### Markup Aliases
+
+If you find you need to use a local named `node` or `map`, these markup methods are aliased as
+`n`, `_node`, `m`, and `_map` respectively.  Any combination of aliases is valid:
+
+```ruby
+node 'slideshow' do
+  n 'start_slide', start_slide
+  _node 'slides' do
+    _map slides do |slide|
+      _node 'id',    slide.id
+      node  'title', slide.title
+      _node 'image', slide.image_url
+      node  'thumb', slide.thumb_url
+      _node 'url',   slide.url
+    end
+    m other_slides do |slide|
+      node  'id',    slide.id
+      _node 'title', slide.title
+      node  'image', slide.image_url
+      _node 'thumb', slide.thumb_url
+      node  'url',   slide.url
+    end
+  end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/bench/_slide.nm

@@ -0,0 +1,5 @@
+node 'id',    slide.id
+node 'title', slide.title
+node 'image', slide.image_url
+node 'thumb', slide.thumb_url
+node 'url',   slide.url

data/bench/logger.rb

@@ -0,0 +1,36 @@
+require 'bench/runner'
+
+module NmBench
+
+  class Logger
+
+    def initialize(file_path)
+      @file = File.open(file_path, 'w')
+      @ios = [@file, $stdout]
+      yield self
+      @file.close
+    end
+
+    def method_missing(meth, *args, &block)
+      @ios.each do |io|
+        io.respond_to?(meth.to_s) ? io.send(meth.to_s, *args, &block) : super
+      end
+    end
+
+    def respond_to?(*args)
+      @ios.first.respond_to?(args.first.to_s) ? true : super
+    end
+
+    def run_template(runner, name, *args)
+      GC.disable
+
+      Runner.run(runner, name, self, *args)
+      self.puts
+
+      GC.enable
+      GC.start
+    end
+
+  end
+
+end

data/bench/results/nm.txt

@@ -0,0 +1,30 @@
+Nm slideshow: 1 times
+---------------------
+whysoslow? ..
+
+mem @ start             41 MB                   ??
+mem @ finish            41 MB                   +   0 MB,   0%
+
+         user     system   total    real
+time     0.0 ms   0.0 ms   0.0 ms   5.086 ms
+
+Nm slideshow: 10 times
+----------------------
+whysoslow? ..
+
+mem @ start             41 MB                   ??
+mem @ finish            54 MB                   +  13 MB,  32%
+
+          user      system    total     real
+time      40.0 ms   0.0 ms    40.0 ms   39.215 ms
+
+Nm slideshow: 100 times
+-----------------------
+whysoslow? ..
+
+mem @ start             54 MB                   ??
+mem @ finish            212 MB                  + 158 MB, 294%
+
+           user       system     total      real
+time       320.0 ms   60.0 ms    380.0 ms   379.717 ms
+

data/bench/results/nm_partials.txt

@@ -0,0 +1,30 @@
+Nm slideshow_partials: 1 times
+------------------------------
+whysoslow? ..
+
+mem @ start             41 MB                   ??
+mem @ finish            41 MB                   +   0 MB,   0%
+
+          user      system    total     real
+time      20.0 ms   0.0 ms    20.0 ms   20.947 ms
+
+Nm slideshow_partials: 10 times
+-------------------------------
+whysoslow? ..
+
+mem @ start             41 MB                   ??
+mem @ finish            74 MB                   +  33 MB,  81%
+
+           user       system     total      real
+time       170.0 ms   30.0 ms    200.0 ms   196.232 ms
+
+Nm slideshow_partials: 100 times
+--------------------------------
+whysoslow? ..
+
+mem @ start             50 MB                   ??
+mem @ finish            531 MB                  + 480 MB, 952%
+
+            user        system      total       real
+time        1640.0 ms   310.0 ms    1950.0 ms   1944.464 ms
+

data/bench/results/nm_re_source.txt

@@ -0,0 +1,30 @@
+Nm slideshow: 1 times
+---------------------
+whysoslow? ..
+
+mem @ start             41 MB                   ??
+mem @ finish            41 MB                   +   0 MB,   0%
+
+         user     system   total    real
+time     0.0 ms   0.0 ms   0.0 ms   6.727 ms
+
+Nm slideshow: 10 times
+----------------------
+whysoslow? ..
+
+mem @ start             41 MB                   ??
+mem @ finish            51 MB                   +  10 MB,  23%
+
+          user      system    total     real
+time      40.0 ms   10.0 ms   50.0 ms   40.104 ms
+
+Nm slideshow: 100 times
+-----------------------
+whysoslow? ..
+
+mem @ start             50 MB                   ??
+mem @ finish            209 MB                  + 159 MB, 320%
+
+           user       system     total      real
+time       310.0 ms   60.0 ms    370.0 ms   376.581 ms
+

data/bench/results/rabl.txt

@@ -0,0 +1,30 @@
+RABL slideshow: 1 times
+-----------------------
+whysoslow? ..
+
+mem @ start             40 MB                   ??
+mem @ finish            40 MB                   +   0 MB,   0%
+
+          user      system    total     real
+time      10.0 ms   0.0 ms    10.0 ms   18.029 ms
+
+RABL slideshow: 10 times
+------------------------
+whysoslow? ..
+
+mem @ start             40 MB                   ??
+mem @ finish            85 MB                   +  45 MB, 112%
+
+           user       system     total      real
+time       170.0 ms   20.0 ms    190.0 ms   193.534 ms
+
+RABL slideshow: 100 times
+-------------------------
+whysoslow? ..
+
+mem @ start             69 MB                   ??
+mem @ finish            458 MB                  + 389 MB, 565%
+
+            user        system      total       real
+time        1530.0 ms   190.0 ms    1720.0 ms   1720.782 ms
+

data/bench/runner.rb

@@ -0,0 +1,84 @@
+require 'whysoslow'
+require 'rabl'
+require 'nm'
+
+require 'bench/template'
+
+module NmBench
+
+  class Runner
+
+    attr_reader :result
+
+    RUNNERS = {}
+
+    def self.run(runner, *args)
+      RUNNERS[runner].new(*args).run
+    end
+
+    def initialize(printer_io, title, num_times, &run_proc)
+      @proc = proc do
+        num_times.times do
+          run_proc.call
+        end
+      end
+
+      @printer = Whysoslow::DefaultPrinter.new(printer_io, {
+        :title => "#{title}: #{num_times} times",
+        :verbose => true
+      })
+      @runner = Whysoslow::Runner.new(@printer)
+    end
+
+    def run
+      @runner.run &@proc
+    end
+
+  end
+
+  class RablRunner < Runner
+
+    RUNNERS[:rabl] = self
+
+    def initialize(template_name, printer_io, num_times = 10)
+      template = Template.find(template_name)
+      super(printer_io, "RABL #{template.name}", num_times) do
+        out = Rabl::Renderer.new(template.name, nil, {
+          :view_path => File.expand_path('..', __FILE__),
+          :locals    => template.locals,
+          :format    => 'hash'
+        }).render
+      end
+    end
+
+  end
+
+  class NmRunner < Runner
+
+    RUNNERS[:nm] = self
+
+    def initialize(template_name, printer_io, num_times = 10)
+      template = Template.find(template_name)
+      source = Nm::Source.new(File.expand_path('..', __FILE__))
+      super(printer_io, "Nm #{template.name}", num_times) do
+        out = source.render(template.name, template.locals)
+      end
+    end
+
+  end
+
+  class NmReSourceRunner < Runner
+
+    RUNNERS[:nm_re_source] = self
+
+    def initialize(template_name, printer_io, num_times = 10)
+      template = Template.find(template_name)
+      super(printer_io, "Nm #{template.name}", num_times) do
+        source = Nm::Source.new(File.expand_path('..', __FILE__))
+        out = source.render(template.name, template.locals)
+      end
+    end
+
+  end
+
+end

data/bench/slideshow.nm

@@ -0,0 +1,12 @@
+node 'slideshow' do
+  node 'start_slide', view.start_slide
+  node 'slides' do
+    map view.slides do |slide|
+      node 'id',    slide.id
+      node 'image', slide.image_url
+      node 'thumb', slide.thumb_url
+      node 'title', slide.title
+      node 'url',   slide.url
+    end
+  end
+end

data/bench/slideshow.rabl

@@ -0,0 +1,5 @@
+object locals[:view].slideshow => :slideshow
+attributes :start_slide
+child(:slides, :object_root => false, :root => :slides){
+  attributes :id, :title, :url, :image, :thumb
+}

data/bench/slideshow.rb

@@ -0,0 +1,47 @@
+require 'assert/factory'
+require 'bench/template'
+
+module NmBench
+
+  class SlideshowTemplate < Template
+
+    TEMPLATES[:slideshow] = self
+
+    def initialize
+      @name = 'slideshow'
+      @locals = { :view => View.new }
+    end
+
+    class View
+      attr_reader :start_slide, :slides
+
+      def initialize
+        @slides = (1..100).map{ |n| Slide.new(n) }
+        @start_slide = @slides.first.id
+      end
+
+      # for RABL template syntax needs
+      def slideshow
+        self
+      end
+    end
+
+    class Slide
+      attr_reader :id, :image_url, :thumb_url, :title, :url
+
+      def initialize(n)
+        @id = Assert::Factory.integer
+        @image_url = Assert::Factory.url
+        @thumb_url = Assert::Factory.url
+        @title = "Slide #{n}"
+        @url = Assert::Factory.url
+      end
+
+      # for RABL syntax needs
+      alias_method :image, :image_url
+      alias_method :thumb, :thumb_url
+    end
+
+  end
+
+end