ox-builder 0.1.0 → 1.0.1

data/benchmarks/huge.rb

@@ -0,0 +1,25 @@
+require_relative './runner'
+require 'yaml'
+
+Country = Struct.new(:code, :name, :population, :north, :south, :east, :west, :capital, :continent_name)
+data = YAML.load_file('benchmarks/data/countries.yml')['countries']['country'] * 100
+@countries = data.map{ |c| Country.new(*c.values) }
+
+builder_tilt = Tilt.new('benchmarks/templates/large.builder')
+ox_tilt = Tilt.new('benchmarks/templates/large.ox')
+
+# Output is 11M
+
+Benchmark.ips do |x|
+  x.config(time: 60, warmup: 10)
+
+  x.report('builder') do
+    builder_tilt.render(Object.new, { countries: @countries })
+  end
+
+  x.report('ox') do
+    ox_tilt.render(Object.new, { countries: @countries })
+  end
+
+  x.compare!
+end

data/benchmarks/medium.rb

@@ -0,0 +1,27 @@
+require_relative './runner'
+require 'yaml'
+
+Country = Struct.new(:code, :name, :population, :north, :south, :east, :west, :capital, :continent_name)
+data = YAML.load_file('benchmarks/data/countries.yml')['countries']['country']
+@countries = data.map{ |c| Country.new(*c.values) }
+
+builder_tilt = Tilt.new('benchmarks/templates/large.builder')
+ox_tilt = Tilt.new('benchmarks/templates/large.ox')
+
+File.write('ox.xml', builder_tilt.render(Object.new, { countries: @countries }))
+
+# Output is 107K
+
+Benchmark.ips do |x|
+  x.config(time: 20, warmup: 10)
+
+  x.report('builder') do
+    builder_tilt.render(Object.new, { countries: @countries })
+  end
+
+  x.report('ox') do
+    ox_tilt.render(Object.new, { countries: @countries })
+  end
+
+  x.compare!
+end

data/benchmarks/runner.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'benchmark/ips'
+require 'builder'
+require 'tilt'
+require 'ox/builder'

data/benchmarks/small.rb

@@ -0,0 +1,20 @@
+require_relative './runner'
+
+builder_tilt = Tilt.new('benchmarks/templates/small.builder')
+ox_tilt = Tilt.new('benchmarks/templates/small.ox')
+
+# Output is 167 bytes
+
+Benchmark.ips do |x|
+  x.config(time: 10, warmup: 5)
+
+  x.report('builder') do
+    builder_tilt.render
+  end
+
+  x.report('ox') do
+    ox_tilt.render
+  end
+
+  x.compare!
+end

data/benchmarks/templates/large.builder

@@ -0,0 +1,20 @@
+xml.instruct!
+
+xml.countries do
+  countries.each do |country|
+    xml.country do
+      xml.name { xml.cdata!(country.name) }
+      xml.code { xml.cdata!(country.code) }
+      xml.continent { xml.cdata!(country.continent_name) }
+      xml.capital { xml.cdata!(country.capital.to_s) }
+      xml.population country.population
+
+      xml.boundaries do
+        xml.north country.north
+        xml.sourth country.south
+        xml.east country.east
+        xml.west country.west
+      end
+    end
+  end
+end

data/benchmarks/templates/large.ox

@@ -0,0 +1,20 @@
+instruct!
+
+countries do
+  countries.each do |country|
+    country do
+      name { cdata!(country.name) }
+      code { cdata!(country.code) }
+      continent { cdata!(country.continent_name) }
+      capital { cdata!(country.capital) }
+      population country.population
+
+      boundaries do
+        north country.north
+        sourth country.south
+        east country.east
+        west country.west
+      end
+    end
+  end
+end

data/benchmarks/templates/small.builder

@@ -0,0 +1,7 @@
+xml.instruct!
+
+xml.person id: 123 do
+  xml.name { xml.cdata!('John Smith') }
+  xml.age 37
+  xml.nationality 'Canadian'
+end

data/benchmarks/templates/small.ox

@@ -0,0 +1,7 @@
+instruct!
+
+person id: 123 do
+  name { cdata!('John Smith') }
+  age 37
+  nationality 'Canadian'
+end

data/bin/console

@@ -1,6 +1,10 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
+require 'active_support'
+require 'active_support/hash_with_indifferent_access'
+require 'action_view'
+require 'tilt'
 require "ox/builder"
 
 # You can add fixtures and/or initialization code here to make experimenting

data/lib/ox/builder/action_view/template_handler.rb

@@ -0,0 +1,21 @@
+require 'active_support/core_ext/class/attribute'
+require 'action_dispatch/http/mime_type'
+
+module Ox
+  module Builder
+    module ActionView
+      class TemplateHandler
+        class_attribute :default_format
+        self.default_format = Mime::XML
+
+        def call(template)
+          <<-RUBY
+            xml = ::Ox::Builder.build {
+              #{template.source}
+            };xml.to_xml
+          RUBY
+        end
+      end
+    end
+  end
+end

data/lib/ox/builder/dsl.rb

@@ -0,0 +1,42 @@
+module Ox
+  module Builder
+    module DSL
+      def instruct!(*args)
+        attributes = args.last.is_a?(Hash) ? args.pop : { version: '1.0', encoding: 'UTF-8' }
+        name = args.first || :xml
+
+        with_dsl(Ox::Instruct.new(name)) do |instruct|
+          instruct.add_attributes(attributes)
+          node << instruct.node
+        end
+      end
+
+      def cdata!(text)
+        node << Ox::CData.new(text)
+      end
+
+      def comment!(text)
+        node << Ox::Comment.new(text)
+      end
+
+      def doctype!(type)
+        node << Ox::DocType.new(type)
+      end
+
+      def tag!(name, *args, &block)
+        builder = Builder.build(Ox::Element.new(name), &block).tap do |tag|
+          attributes = args.last.is_a?(Hash) ? args.pop : {}
+
+          tag.add_attributes(attributes)
+
+          args.each do |text|
+            text = text.is_a?(Ox::Node) ? text : text.to_s
+            tag.node << text
+          end
+        end
+
+        node << builder.node
+      end
+    end
+  end
+end

data/lib/ox/builder/factory.rb

@@ -0,0 +1,39 @@
+module Ox
+  module Builder
+    class Factory
+      include DSL
+
+      attr_reader :node
+
+      def initialize(node)
+        @node = node
+      end
+
+      def to_s
+        Ox.dump(node)
+      end
+      alias_method :to_xml, :to_s
+
+      def inspect
+        "#<#{self.class.name}:0x#{"%x" % object_id} node=#{node}>"
+      end
+
+      def add_attributes(attributes)
+        attributes.each do |key, val|
+          node[key] = val
+        end
+      end
+
+    protected
+
+      def method_missing(name, *args, &block)
+        name = name[0...-1] if name.to_s.end_with?('!')
+        tag!(name, *args, &block)
+      end
+
+      def with_dsl(obj, &block)
+        Factory.new(obj).tap(&block)
+      end
+    end
+  end
+end

data/lib/ox/builder/fallback_context_proxy.rb

@@ -0,0 +1,30 @@
+module Ox
+  module Builder
+    class FallbackContextProxy < Docile::FallbackContextProxy
+      DSL_METHODS = DSL.instance_methods(false)
+
+      def method_missing(method, *args, &block)
+        # This is somewhat more complicated than the normal FallbackContextProxy provided by
+        # docile. The reason for this is that the Builder has its own method_missing to
+        # allow tags to be defined dynamically, but that can't define a respond_to_missing?
+        # because we don't know what the methods will be until they are accessed.
+        #
+        # Therefore, if the fallback doesn't respond to the method, send it to the receiver
+        # regardless of if it responds to it or not (so that its method_missing can pick it up).
+        #
+        # The next wrinkle is that we need to try the fallback before the receiver or else
+        # nested DSLs lose access to methods defined in the original scope. To handle this
+        # without allowing the core DSL methods to be clobbered, we first check if the method
+        # is a DSL method and if so pass it directly to the receiver.
+
+        if DSL_METHODS.include?(method.to_sym)
+          @__receiver__.__send__(method.to_sym, *args, &block)
+        elsif @__fallback__.respond_to?(method.to_sym)
+          @__fallback__.__send__(method.to_sym, *args, &block)
+        else
+          @__receiver__.__send__(method, *args, &block)
+        end
+      end
+    end
+  end
+end

data/lib/ox/builder/version.rb

@@ -1,5 +1,5 @@
 module Ox
   module Builder
-    VERSION = "0.1.0"
+    VERSION = "1.0.1"
   end
 end

data/lib/ox/builder.rb

@@ -1,7 +1,34 @@
-require "ox/builder/version"
+require 'ox'
+require 'docile'
+require 'ox/builder/version'
+require 'ox/builder/dsl'
+require 'ox/builder/factory'
+require 'ox/builder/fallback_context_proxy'
 
 module Ox
   module Builder
-    # Your code goes here...
+    class << self
+      def build(node = Ox::Document.new, &block)
+        Factory.new(node).tap do |builder|
+          dsl_eval(builder, builder, &block) if block_given?
+        end
+      end
+
+    private
+
+      def dsl_eval(dsl, *args, &block)
+        Docile::Execution.exec_in_proxy_context(dsl, FallbackContextProxy, *args, &block)
+      end
+    end
   end
 end
+
+if defined?(Tilt)
+  require 'tilt/ox_builder_template'
+  Tilt.register Tilt::OxBuilderTemplate, 'ox'
+end
+
+if defined?(ActionView)
+  require 'ox/builder/action_view/template_handler'
+  ActionView::Template.register_template_handler :ox, Ox::Builder::ActionView::TemplateHandler.new
+end

data/lib/tilt/ox_builder_template.rb

@@ -0,0 +1,28 @@
+require 'tilt/template'
+require 'ox/builder'
+
+module Tilt
+  class OxBuilderTemplate < Template
+    self.default_mime_type = 'text/xml'
+
+    def self.engine_initialized?
+      defined? ::Ox::Builder
+    end
+
+    def initialize_engine
+      require_template_library 'ox-builder'
+    end
+
+    def prepare
+      @code =<<-RUBY
+        Ox::Builder.build do
+          #{data}
+        end.to_xml
+      RUBY
+    end
+
+    def precompiled_template(locals)
+      @code
+    end
+  end
+end

data/ox-builder.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.authors       = ["Daniel Vandersluis"]
   gem.email         = ["dvandersluis@selfmgmt.com"]
 
-  gem.summary       = %q{XML Builder for Rails using ox}
+  gem.summary       = %q{DSL for easily building XML documents using ox}
   gem.homepage      = "https://www.github.com/dvandersluis/ox-builder"
   gem.license       = "MIT"
 
@@ -21,4 +21,12 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency "bundler", "~> 1.11"
   gem.add_development_dependency "rake", "~> 10.0"
   gem.add_development_dependency "rspec", "~> 3.0"
+  gem.add_development_dependency 'actionpack', ['~> 3.2']
+  gem.add_development_dependency 'activesupport', ['~> 3.2']
+  gem.add_development_dependency 'tilt', ['~> 1.4']
+  gem.add_development_dependency 'benchmark-ips'
+  gem.add_development_dependency 'builder'
+
+  gem.add_dependency 'ox', ['~> 2.3.0']
+  gem.add_dependency 'docile', ['~> 1.1.5']
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ox-builder
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Daniel Vandersluis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-30 00:00:00.000000000 Z
+date: 2016-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   type: :development
@@ -52,6 +52,104 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.5
 description: 
 email:
 - dvandersluis@selfmgmt.com
@@ -62,14 +160,29 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks/data/countries.yml
+- benchmarks/huge.rb
+- benchmarks/medium.rb
+- benchmarks/runner.rb
+- benchmarks/small.rb
+- benchmarks/templates/large.builder
+- benchmarks/templates/large.ox
+- benchmarks/templates/small.builder
+- benchmarks/templates/small.ox
 - bin/console
 - bin/setup
 - lib/ox/builder.rb
+- lib/ox/builder/action_view/template_handler.rb
+- lib/ox/builder/dsl.rb
+- lib/ox/builder/factory.rb
+- lib/ox/builder/fallback_context_proxy.rb
 - lib/ox/builder/version.rb
+- lib/tilt/ox_builder_template.rb
 - ox-builder.gemspec
 homepage: https://www.github.com/dvandersluis/ox-builder
 licenses:
@@ -94,6 +207,6 @@ rubyforge_project:
 rubygems_version: 2.1.5
 signing_key: 
 specification_version: 4
-summary: XML Builder for Rails using ox
+summary: DSL for easily building XML documents using ox
 test_files: []
 has_rdoc: