sax-machine 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d70f53b72ae5d965a51b002434716f68b7d6dd80
-  data.tar.gz: a96da94d49a82ace8f74778aae5fe7b1e7ff2067
+  metadata.gz: fbab8ba0a044c67b908e367534220284eb66be82
+  data.tar.gz: fed3ba53ea5a6736e7ea66c7ec8165e619117e14
 SHA512:
-  metadata.gz: 618645fdf96799bf57df46b97c1e0244a933137085f1162c72735822b79a38c7b8c4fe7e3e73c7aba95611f36bc84bb91199af3e294faa924c18edc5b7fe0228
-  data.tar.gz: 7c0700b3c34bcd6812294cc67dc3571a35f4b4957a9aa2cef485aa15ab56292041ec1df056ebe861a5410cdcdb666041d85167aa00da43a45e92e0eb25bfbe6e
+  metadata.gz: 893aea24b7264ba1306b010f117fb06583e0bc9d70c2d4f6fa87ca955048276ae1f1cfbb1d237f9e06c3f391a799ded075048de6b5b0494efe3e5ae9e88b060b
+  data.tar.gz: 90348f313389a5a7d9d058624e81bc13b7833968cb94ca1442b21b29cdffa65ae438265f365da9623c4cc4f65664006fac7c4b6832486dffe85476d8b27078aa

data/.travis.yml

@@ -4,6 +4,7 @@ rvm:
   - 1.9.3
   - 2.0
   - 2.1
+  - 2.2
   - jruby-1.7
   - rbx-2
   - ruby-head
@@ -24,6 +25,8 @@ matrix:
     - env: HANDLER="ox"
       rvm: jruby-head
   allow_failures:
+    - env: HANDLER="oga"
+      rvm: jruby-1.7
     - rvm: rbx-2
     - rvm: ruby-head
     - rvm: jruby-head

data/HISTORY.md

@@ -1,5 +1,11 @@
 # HEAD
 
+# 1.3.0
+
+* Improve block modifiers to support all config options
+* Make block modifiers run in instance context
+* Make all handlers support IO as a input
+
 # 1.2.0
 
 * Add support for blocks as value modifiers [[#61](https://github.com/pauldix/sax-machine/pull/61)]

data/README.md

@@ -81,6 +81,8 @@ end
 class Atom
   include SAXMachine
   # Use block to modify the returned value
+  # Blocks are working with pretty much everything,
+  # except for `elements` with `class` attribute
   element :title do |title|
     title.strip
   end

data/lib/sax-machine/handlers/sax_abstract_handler.rb

@@ -12,7 +12,7 @@ module SAXMachine
       end
     end
 
-    def sax_parse(xml_text)
+    def sax_parse(xml_input)
       raise NotImplementedError
     end
 

data/lib/sax-machine/handlers/sax_nokogiri_handler.rb

@@ -5,9 +5,9 @@ module SAXMachine
   class SAXNokogiriHandler < Nokogiri::XML::SAX::Document
     include SAXAbstractHandler
 
-    def sax_parse(xml_text)
+    def sax_parse(xml_input)
       parser = Nokogiri::XML::SAX::Parser.new(self)
-      parser.parse(xml_text) do |ctx|
+      parser.parse(xml_input) do |ctx|
         ctx.replace_entities = true
       end
     end

data/lib/sax-machine/handlers/sax_oga_handler.rb

@@ -9,8 +9,8 @@ module SAXMachine
       _initialize(*args)
     end
 
-    def sax_parse(xml_text)
-      Oga.sax_parse_xml(self, xml_text)
+    def sax_parse(xml_input)
+      Oga.sax_parse_xml(self, xml_input)
     end
 
     def on_element(namespace, name, attrs)

data/lib/sax-machine/handlers/sax_ox_handler.rb

@@ -10,8 +10,11 @@ module SAXMachine
       _reset_element
     end
 
-    def sax_parse(xml_text)
-      Ox.sax_parse(self, StringIO.new(xml_text),
+    def sax_parse(xml_input)
+      # Ox requires input to be streamable
+      xml_input = StringIO.new(xml_input) if xml_input.is_a?(String)
+
+      Ox.sax_parse(self, xml_input,
         symbolize: false,
         convert_special: true,
         skip: :skip_return,

data/lib/sax-machine/sax_configure.rb

@@ -14,8 +14,8 @@ module SAXMachine
     clazz.extend LightWeightSaxMachine
     clazz.sax_config = extended_clazz.sax_config
 
-    (class << clazz;self;end).send(:define_method, :parse) do |xml_text|
-      extended_clazz.parse(xml_text)
+    (class << clazz;self;end).send(:define_method, :parse) do |xml_input|
+      extended_clazz.parse(xml_input)
     end
   end
 

data/lib/sax-machine/sax_document.rb

@@ -4,11 +4,11 @@ module SAXMachine
     base.extend(ClassMethods)
   end
 
-  def parse(xml_text, on_error = nil, on_warning = nil)
+  def parse(xml_input, on_error = nil, on_warning = nil)
     handler_klass = SAXMachine.const_get("SAX#{SAXMachine.handler.capitalize}Handler")
 
     handler = handler_klass.new(self, on_error, on_warning)
-    handler.sax_parse(xml_text)
+    handler.sax_parse(xml_input)
 
     self
   end
@@ -51,16 +51,46 @@ module SAXMachine
       create_attr(real_name, &block)
     end
 
-    def value(name, options = {})
+    def value(name, options = {}, &block)
       real_name = (options[:as] ||= name).to_s
       sax_config.add_top_level_element_value(self.class.to_s, options.merge(name: name))
-      create_attr(real_name)
+      create_attr(real_name, &block)
     end
 
-    def ancestor(name, options = {})
+    def ancestor(name, options = {}, &block)
       real_name = (options[:as] ||= name).to_s
       sax_config.add_ancestor(name, options)
-      create_attr(real_name)
+      create_attr(real_name, &block)
+    end
+
+    def elements(name, options = {}, &block)
+      real_name = (options[:as] ||= name).to_s
+
+      if options[:class]
+        sax_config.add_collection_element(name, options)
+      else
+        if block_given?
+          define_method("add_#{real_name}") do |value|
+            send(real_name).send(:<<, instance_exec(value, &block))
+          end
+        else
+          define_method("add_#{real_name}") do |value|
+            send(real_name).send(:<<, value)
+          end
+        end
+
+        sax_config.add_top_level_element(name, options.merge(collection: true))
+      end
+
+      if !method_defined?(real_name)
+        class_eval <<-SRC
+          def #{real_name}
+            @#{real_name} ||= []
+          end
+        SRC
+      end
+
+      attr_writer(options[:as]) unless method_defined?("#{options[:as]}=")
     end
 
     def columns
@@ -83,31 +113,6 @@ module SAXMachine
       columns.map { |e| e.column }
     end
 
-    def elements(name, options = {})
-      options[:as] ||= name
-
-      if options[:class]
-        sax_config.add_collection_element(name, options)
-      else
-        class_eval <<-SRC
-          def add_#{options[:as]}(value)
-            #{options[:as]} << value
-          end
-        SRC
-        sax_config.add_top_level_element(name, options.merge(collection: true))
-      end
-
-      if !method_defined?(options[:as].to_s)
-        class_eval <<-SRC
-          def #{options[:as]}
-            @#{options[:as]} ||= []
-          end
-        SRC
-      end
-
-      attr_writer(options[:as]) unless method_defined?("#{options[:as]}=")
-    end
-
     def sax_config
       @sax_config ||= SAXConfig.new
     end
@@ -121,7 +126,7 @@ module SAXMachine
       if !method_defined?("#{real_name}=")
         if block_given?
           define_method("#{real_name}=") do |value|
-             instance_variable_set("@#{real_name}", (yield value))
+            instance_variable_set("@#{real_name}", instance_exec(value, &block))
           end
         else
           attr_writer(real_name)

data/lib/sax-machine/version.rb

@@ -1,3 +1,3 @@
 module SAXMachine
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/spec/sax-machine/sax_document_spec.rb

@@ -221,36 +221,68 @@ describe "SAXMachine" do
 
       describe "the block" do
         before do
-          @klass = Class.new do
+          class ElementBlockParser
+            include SAXMachine
+
+            ancestor :parent do |parent|
+              parent.class.to_s
+            end
+
+            value :text do |text|
+              text.downcase
+            end
+          end
+
+          class BlockParser
             include SAXMachine
 
             element :title do |title|
               "#{title}!!!"
             end
 
+            element :scope do |scope|
+              "#{title} #{scope}"
+            end
+
             attribute :id do |id|
               id.to_i
             end
 
-            element :link, value: :foo do |link|
-              link.downcase
+            element :nested, class: ElementBlockParser
+            elements :message, as: :messages do |message|
+              "#{message}!"
             end
           end
         end
 
+        it "has instance as a block context" do
+          document = BlockParser.parse("<root><title>SAX</title><scope>something</scope></root>")
+          expect(document.scope).to eq("SAX!!! something")
+        end
+
         it "uses block for element" do
-          document = @klass.parse("<title>SAX</title>")
+          document = BlockParser.parse("<title>SAX</title>")
           expect(document.title).to eq("SAX!!!")
         end
 
         it 'uses block for attribute' do
-          document = @klass.parse("<title id='345'>SAX</title>")
+          document = BlockParser.parse("<title id='345'>SAX</title>")
           expect(document.id).to eq(345)
         end
 
-        it "uses block for attribute value" do
-          document = @klass.parse("<link foo='tEst'>hello</link>")
-          expect(document.link).to eq("test")
+        it "uses block for value" do
+          document = BlockParser.parse("<title><nested>tEst</nested></title>")
+          expect(document.nested.text).to eq("test")
+        end
+
+        it "uses block for ancestor" do
+          document = BlockParser.parse("<title><nested>SAX</nested></title>")
+          expect(document.nested.parent).to eq("BlockParser")
+        end
+
+        it "uses block for elements" do
+          document = BlockParser.parse("<title><message>hi</message><message>world</message></title>")
+          expect(document.messages).to eq(["hi!", "world!"])
         end
       end
     end
@@ -1040,4 +1072,21 @@ describe "SAXMachine" do
       expect(@warnings.uniq.size).to eq(0)
     end
   end
+
+  describe "with io as a input" do
+    before do
+      @io = StringIO.new('<item id="1"><title>sweet</title></item>')
+
+      class IoParser
+        include SAXMachine
+        element :title
+      end
+
+      @item = ItemElement5.parse(@io)
+    end
+
+    it "parses" do
+      expect(@item.title).to eq("sweet")
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sax-machine
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Paul Dix
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-23 00:00:00.000000000 Z
+date: 2015-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec