ruby_speech 0.3.2 → 0.3.3

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.3.3
+  * Allow `SSML::Element.import` and `GRXML::Element.import` to take a string as well as a Nokogiri::XML::Node
+  * Allow importing GRXML/SSML documents via their respective modules (eg `RubySpeech::GRXML.import '<grammar ... />'`)
+
 # 0.3.2
   * Fix inheriting an `SSML::Speak`'s language. Previously an imported `<speak/>` would end up with a `lang` attribute in addition to `xml:lang`, and `xml:lang` would have the default value (`en-US`). This required a Niceogiri dependency update.
 

data/lib/ruby_speech.rb

@@ -10,6 +10,7 @@ module RubySpeech
 
   autoload :Version
 
+  autoload :GenericElement
   autoload :SSML
   autoload :GRXML
   autoload :XML

data/lib/ruby_speech/generic_element.rb

@@ -0,0 +1,111 @@
+require 'active_support/core_ext/class/attribute'
+
+module RubySpeech
+  module GenericElement
+
+    def self.included(klass)
+      klass.class_attribute :registered_ns, :registered_name
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      @@registrations = {}
+
+      # Register a new stanza class to a name and/or namespace
+      #
+      # This registers a namespace that is used when looking
+      # up the class name of the object to instantiate when a new
+      # stanza is received
+      #
+      # @param [#to_s] name the name of the node
+      #
+      def register(name)
+        self.registered_name = name.to_s
+        self.registered_ns = namespace
+        @@registrations[[self.registered_name, self.registered_ns]] = self
+      end
+
+      # Find the class to use given the name and namespace of a stanza
+      #
+      # @param [#to_s] name the name to lookup
+      #
+      # @return [Class, nil] the class appropriate for the name
+      def class_from_registration(name)
+        @@registrations[[name.to_s, namespace]]
+      end
+
+      # Import an XML::Node to the appropriate class
+      #
+      # Looks up the class the node should be then creates it based on the
+      # elements of the XML::Node
+      # @param [XML::Node] node the node to import
+      # @return the appropriate object based on the node name and namespace
+      def import(node)
+        node = Nokogiri::XML.parse(node, nil, nil, Nokogiri::XML::ParseOptions::NOBLANKS).root unless node.is_a?(Nokogiri::XML::Node)
+        return node.content if node.is_a?(Nokogiri::XML::Text)
+        klass = class_from_registration(node.element_name)
+        if klass && klass != self
+          klass.import node
+        else
+          new.inherit node
+        end
+      end
+
+      def new(element_name, atts = {}, &block)
+        blk_proc = lambda do |new_node|
+          atts.each_pair { |k, v| new_node.send :"#{k}=", v }
+          block_return = new_node.instance_eval &block if block_given?
+          new_node << new_node.encode_special_chars(block_return) if block_return.is_a?(String)
+        end
+
+        case RUBY_VERSION.split('.')[0,2].join.to_i
+        when 18
+          super(element_name).tap do |n|
+            blk_proc[n]
+          end
+        else
+          super(element_name) do |n|
+            blk_proc[n]
+          end
+        end
+      end
+    end
+
+    def children
+      super.map { |c| self.class.import c }
+    end
+
+    def embed(other)
+      case other
+      when String
+        self << encode_special_chars(other)
+      when self.class.root_element
+        other.children.each do |child|
+          self << child
+        end
+      when self.class.module::Element
+        self << other
+      else
+        raise ArgumentError, "Can only embed a String or an SSML element"
+      end
+    end
+
+    def method_missing(method_name, *args, &block)
+      const_name = method_name.to_s.sub('ssml', '').titleize.gsub(' ', '')
+      const = self.class.module.const_get const_name
+      if const && self.class::VALID_CHILD_TYPES.include?(const)
+        if const == String
+          self << encode_special_chars(args.first)
+        else
+          self << const.new(*args, &block)
+        end
+      else
+        super
+      end
+    end
+
+    def eql?(o, *args)
+      super o, :content, :children, *args
+    end
+  end # Element
+end # RubySpeech

data/lib/ruby_speech/grxml.rb

@@ -21,5 +21,9 @@ module RubySpeech
         grammar << block_return if block_return.is_a?(String)
       end
     end
+
+    def self.import(other)
+      Element.import other
+    end
   end # GRXML
 end # RubySpeech

data/lib/ruby_speech/grxml/element.rb

@@ -3,116 +3,19 @@ require 'active_support/core_ext/class/attribute'
 module RubySpeech
   module GRXML
     class Element < Niceogiri::XML::Node
-      @@registrations = {}
-
-      class_attribute :registered_ns, :registered_name
-
-      # Register a new stanza class to a name and/or namespace
-      #
-      # This registers a namespace that is used when looking
-      # up the class name of the object to instantiate when a new
-      # stanza is received
-      #
-      # @param [#to_s] name the name of the node
-      #
-      def self.register(name)
-        self.registered_name = name.to_s
-        self.registered_ns = GRXML_NAMESPACE
-        @@registrations[[self.registered_name, self.registered_ns]] = self
-      end
-
-      # Find the class to use given the name and namespace of a stanza
-      #
-      # @param [#to_s] name the name to lookup
-      #
-      # @return [Class, nil] the class appropriate for the name
-      def self.class_from_registration(name)
-        @@registrations[[name.to_s, GRXML_NAMESPACE]]
-      end
-
-      # Import an XML::Node to the appropriate class
-      #
-      # Looks up the class the node should be then creates it based on the
-      # elements of the XML::Node
-      # @param [XML::Node] node the node to import
-      # @return the appropriate object based on the node name and namespace
-      def self.import(node)
-        return node.content if node.is_a?(Nokogiri::XML::Text)
-        klass = class_from_registration(node.element_name)
-        if klass && klass != self
-          klass.import node
-        else
-          new.inherit node
-        end
-      end
-
-      # Inherit the attributes and children of an XML::Node
-      #
-      # @param [XML::Node] node the node to inherit
-      # @return [self]
-      def inherit(node)
-        inherit_attrs node.attributes
-        node.children.each do |c|
-          self << c.dup
-        end
-        self
-      end
-
-      def self.new(element_name, atts = {}, &block)
-        blk_proc = lambda do |new_node|
-          atts.each_pair { |k, v| new_node.send :"#{k}=", v }
-          block_return = new_node.instance_eval &block if block_given?
-          new_node << new_node.encode_special_chars(block_return) if block_return.is_a?(String)
-        end
-
-        case RUBY_VERSION.split('.')[0,2].join.to_i
-        when 18
-          super(element_name).tap do |n|
-            blk_proc[n]
-          end
-        else
-          super(element_name) do |n|
-            blk_proc[n]
-          end
-        end
+      def self.namespace
+        GRXML_NAMESPACE
       end
 
-      def children
-        super.map { |c| Element.import c }
+      def self.root_element
+        Grammar
       end
 
-      def embed(other)
-        case other
-        when String
-          self << encode_special_chars(other)
-        when Grammar
-          other.children.each do |child|
-            self << child
-          end
-        when Element
-          self << other
-        else
-          raise ArgumentError, "Can only embed a String or an GRXML element"
-        end
+      def self.module
+        GRXML
       end
 
-      def method_missing(method_name, *args, &block)
-        const_name = method_name.to_s.sub('ssml', '').titleize.gsub(' ', '')
-        const = GRXML.const_get const_name
-        if const && self.class::VALID_CHILD_TYPES.include?(const)
-          if const == String
-            self << encode_special_chars(args.first)
-          else
-            self << const.new(*args, &block)
-          end
-        else
-          super
-        end
-      end
-
-      def eql?(o, *args)
-        super o, :content, :children, *args
-      end
+      include GenericElement
     end # Element
   end # GRXML
 end # RubySpeech

data/lib/ruby_speech/ssml.rb

@@ -21,5 +21,9 @@ module RubySpeech
         speak << block_return if block_return.is_a?(String)
       end
     end
+
+    def self.import(other)
+      Element.import other
+    end
   end # SSML
 end # RubySpeech

data/lib/ruby_speech/ssml/element.rb

@@ -3,104 +3,19 @@ require 'active_support/core_ext/class/attribute'
 module RubySpeech
   module SSML
     class Element < Niceogiri::XML::Node
-      @@registrations = {}
-
-      class_attribute :registered_ns, :registered_name
-
-      # Register a new stanza class to a name and/or namespace
-      #
-      # This registers a namespace that is used when looking
-      # up the class name of the object to instantiate when a new
-      # stanza is received
-      #
-      # @param [#to_s] name the name of the node
-      #
-      def self.register(name)
-        self.registered_name = name.to_s
-        self.registered_ns = SSML_NAMESPACE
-        @@registrations[[self.registered_name, self.registered_ns]] = self
-      end
-
-      # Find the class to use given the name and namespace of a stanza
-      #
-      # @param [#to_s] name the name to lookup
-      #
-      # @return [Class, nil] the class appropriate for the name
-      def self.class_from_registration(name)
-        @@registrations[[name.to_s, SSML_NAMESPACE]]
-      end
-
-      # Import an XML::Node to the appropriate class
-      #
-      # Looks up the class the node should be then creates it based on the
-      # elements of the XML::Node
-      # @param [XML::Node] node the node to import
-      # @return the appropriate object based on the node name and namespace
-      def self.import(node)
-        return node.content if node.is_a?(Nokogiri::XML::Text)
-        klass = class_from_registration(node.element_name)
-        if klass && klass != self
-          klass.import node
-        else
-          new.inherit node
-        end
+      def self.namespace
+        SSML_NAMESPACE
       end
 
-      def self.new(element_name, atts = {}, &block)
-        blk_proc = lambda do |new_node|
-          atts.each_pair { |k, v| new_node.send :"#{k}=", v }
-          block_return = new_node.instance_eval &block if block_given?
-          new_node << new_node.encode_special_chars(block_return) if block_return.is_a?(String)
-        end
-
-        case RUBY_VERSION.split('.')[0,2].join.to_i
-        when 18
-          super(element_name).tap do |n|
-            blk_proc[n]
-          end
-        else
-          super(element_name) do |n|
-            blk_proc[n]
-          end
-        end
-      end
-
-      def children
-        super.map { |c| Element.import c }
+      def self.root_element
+        Speak
       end
 
-      def embed(other)
-        case other
-        when String
-          self << encode_special_chars(other)
-        when Speak
-          other.children.each do |child|
-            self << child
-          end
-        when Element
-          self << other
-        else
-          raise ArgumentError, "Can only embed a String or an SSML element"
-        end
+      def self.module
+        SSML
       end
 
-      def method_missing(method_name, *args, &block)
-        const_name = method_name.to_s.sub('ssml', '').titleize.gsub(' ', '')
-        const = SSML.const_get const_name
-        if const && self.class::VALID_CHILD_TYPES.include?(const)
-          if const == String
-            self << encode_special_chars(args.first)
-          else
-            self << const.new(*args, &block)
-          end
-        else
-          super
-        end
-      end
-
-      def eql?(o, *args)
-        super o, :content, :children, *args
-      end
+      include GenericElement
     end # Element
   end # SSML
 end # RubySpeech

data/lib/ruby_speech/version.rb

@@ -1,3 +1,3 @@
 module RubySpeech
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

data/spec/ruby_speech/grxml_spec.rb

@@ -229,7 +229,7 @@ module RubySpeech
           GRXML::Grammar.new.tap { |doc| doc << rule }.to_s
         end
 
-        let(:import) { GRXML::Element.import parse_xml(document).root }
+        let(:import) { GRXML.import document }
 
         subject { import }
 

data/spec/ruby_speech/ssml_spec.rb

@@ -238,7 +238,7 @@ module RubySpeech
         SSML::Speak.new.tap { |doc| doc << voice }.to_s
       end
 
-      let(:import) { SSML::Element.import parse_xml(document).root }
+      let(:import) { SSML.import document }
 
       subject { import }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_speech
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000 Z
+date: 2011-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceogiri
-  requirement: &2151824760 !ruby/object:Gem::Requirement
+  requirement: &2157143800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.1.1
   type: :runtime
   prerelease: false
-  version_requirements: *2151824760
+  version_requirements: *2157143800
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2151804040 !ruby/object:Gem::Requirement
+  requirement: &2157143180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *2151804040
+  version_requirements: *2157143180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2151801800 !ruby/object:Gem::Requirement
+  requirement: &2157142500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *2151801800
+  version_requirements: *2157142500
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2151800400 !ruby/object:Gem::Requirement
+  requirement: &2157141800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *2151800400
+  version_requirements: *2157141800
 - !ruby/object:Gem::Dependency
   name: ci_reporter
-  requirement: &2151798240 !ruby/object:Gem::Requirement
+  requirement: &2157141220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.6.3
   type: :development
   prerelease: false
-  version_requirements: *2151798240
+  version_requirements: *2157141220
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: &2151811840 !ruby/object:Gem::Requirement
+  requirement: &2157140600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *2151811840
+  version_requirements: *2157140600
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2151809800 !ruby/object:Gem::Requirement
+  requirement: &2157140000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151809800
+  version_requirements: *2157140000
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2151808000 !ruby/object:Gem::Requirement
+  requirement: &2157139300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151808000
+  version_requirements: *2157139300
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2151806660 !ruby/object:Gem::Requirement
+  requirement: &2157138760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151806660
+  version_requirements: *2157138760
 description: Prepare SSML and GRXML documents with ease
 email:
 - ben@langfeld.me
@@ -131,6 +131,7 @@ files:
 - assets/synthesis.xsd
 - assets/xml.xsd
 - lib/ruby_speech.rb
+- lib/ruby_speech/generic_element.rb
 - lib/ruby_speech/grxml.rb
 - lib/ruby_speech/grxml/element.rb
 - lib/ruby_speech/grxml/grammar.rb
@@ -183,12 +184,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3968593317999839588
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -3968593317999839588
 requirements: []
 rubyforge_project: ruby_speech
 rubygems_version: 1.8.10