xml_convert 0.0.1 → 0.1.0

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jeremy Redburn
+Copyright (c) 2012 Social Ceramics Inc.
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # XmlConvert
 
-TODO: Write a gem description
+XmlConvert is a Ruby implementation of the [.NET XmlConvert class](http://msdn.microsoft.com/en-us/library/e2104c2x.aspx). It encodes and decodes XML names, giving you an easy way to create NCName-compliant names from arbitrary strings.
 
 ## Installation
 
@@ -18,7 +18,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Encoding
+
+Encode a name:
+
+```ruby
+encoded_name = XmlConvert.encode_name("My Name") # "My_x0020_Name"
+```
+
+Encode a local name, escaping colons as well:
+
+```ruby
+encoded_name = XmlConvert.encode_local_name("Foo: Bar") # "Foo_x003a__x0020_Bar"
+```
+
+### Decoding
+
+Any of the above [Encoding examples](#encoding) can be reversed with `XmlConvert.decode_name(name)`.
 
 ## Contributing
 

data/lib/xml_convert/version.rb

@@ -1,3 +1,3 @@
 module XmlConvert
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/xml_convert.rb

@@ -1,28 +1,42 @@
 require "xml_convert/version"
 
 module XmlConvert
-  
+
+  # Converts an encoded XML name to its original form.
+  #
+  # @example XmlConvert.decode_name('Order_x0020_Details') #=> 'Order Details'
+  #
+  # @param [String] name the name to be decoded.
+  # @return [String] the decoded name.
+  def self.decode_name(name)
+    return name if name.nil? || name.length == 0
+
+    pos = name.index('_')
+    return name if pos.nil? || pos + 6 >= name.length
+
+    return name if name[pos+1] != 'x' || name[pos+6] != '_'
+
+    name.slice(0, pos) << try_decoding(name[pos+1..-1])
+  end  
+
   # Converts the name to a valid XML name.
   #
   # @example XmlConvert.encode_name('Order Details') #=> 'Order_x0020_Details'
   #
   # @param [String] name the name to be encoded.
-  # @return [String, nil] the encoded name or nil if the name cannot be
-  #   converted to a string.
+  # @return [String] the encoded name.
   def self.encode_name(name)
     return name if name.nil? || name.length == 0
 
-    encoded_name = ""
-    name.chars.each_with_index do |c, i|
-      if is_invalid?(c, encoded_name == "")
-        encoded_name << "_x#{'%04x' % c.ord}_"
+    name.chars.each_with_index.reduce("") do |memo, (c, i)|
+      if is_invalid?(c, memo == "")
+        memo << "_x#{'%04x' % c.ord}_"
       elsif c == '_' && i+6 < name.length && name[i+1] == 'x' && name[i+6] == '_'
-        encoded_name << '_x005f_'
+        memo << '_x005f_'
       else
-        encoded_name << c
+        memo << c
       end
     end
-    encoded_name
   end
 
   # Converts the name to a valid XML local name.
@@ -38,6 +52,20 @@ module XmlConvert
 
   private
 
+  def self.try_decoding(string)
+    return string if string.nil? || string.length < 6
+
+    ord = string[1..4].hex
+
+    if ord == 0
+      string[0] << decode_name(string[1..-1])
+    elsif string.length == 6
+      ord.chr
+    else
+      ord.chr << decode_name(string[6..-1])
+    end
+  end
+
   def self.is_invalid?(char, is_first_letter)
     !self.is_valid?(char, is_first_letter)
   end
@@ -52,36 +80,44 @@ module XmlConvert
   #                   [#x3001-#xD7FF] | [#xF900-#xFDCF] | [#xFDF0-#xFFFD] |
   #                   [#x10000-#xEFFFF]
   def self.is_name_start_char?(char)
-    ord = char.ord
-
-    (ord == ':'.ord)                          ||
-    (ord >= 'A'.ord     && ord <= 'Z'.ord)    ||
-    (ord == '_'.ord)                          ||
-    (ord >= 'a'.ord     && ord <= 'z'.ord)    ||
-    (ord >= 'C0'.hex    && ord <= 'D6'.hex)   ||
-    (ord >= 'D8'.hex    && ord <= 'F6'.hex)   ||
-    (ord >= 'F8'.hex    && ord <= '2FF'.hex)  ||
-    (ord >= '370'.hex   && ord <= '37D'.hex)  ||
-    (ord >= '37F'.hex   && ord <= '1FFF'.hex) ||
-    (ord >= '200C'.hex  && ord <= '200D'.hex) ||
-    (ord >= '2070'.hex  && ord <= '218F'.hex) ||
-    (ord >= '2C00'.hex  && ord <= '2FEF'.hex) ||
-    (ord >= '3001'.hex  && ord <= 'D7FF'.hex) ||
-    (ord >= 'F900'.hex  && ord <= 'FDCF'.hex) ||
-    (ord >= 'FDFO'.hex  && ord <= 'FFFD'.hex) ||
-    (ord >= '10000'.hex && ord <= 'EFFFF'.hex)
+    case char.ord
+    when     ':'.ord,
+             'A'.ord ..     'Z'.ord,
+             '_'.ord,
+             'a'.ord ..     'z'.ord,
+            'C0'.hex ..    'D6'.hex,
+            'D8'.hex ..    'F6'.hex,
+            'F8'.hex ..   '2FF'.hex,
+           '370'.hex ..   '37D'.hex,
+           '37F'.hex ..  '1FFF'.hex,
+          '200C'.hex ..  '200D'.hex,
+          '2070'.hex ..  '218F'.hex,
+          '2C00'.hex ..  '2FEF'.hex,
+          '3001'.hex ..  'D7FF'.hex,
+          'F900'.hex ..  'FDCF'.hex,
+          'FDFO'.hex ..  'FFFD'.hex,
+         '10000'.hex .. 'EFFFF'.hex
+      true
+    else
+      false
+    end
   end
 
   # NameChar ::= NameStartChar | "-" | "." | [0-9] | #xB7 | [#x0300-#x036F] |
   #              [#x203F-#x2040]
   def self.is_name_char?(char)
-    ord = char.ord
-
-    is_name_start_char?(char)               ||
-    (ord == '-'.ord)   || (ord == '.'.ord)  ||
-    (ord >= '0'.ord    && ord <= '9'.ord)   ||
-    (ord == 'B7'.hex)                       ||
-    (ord >= '300'.hex  && ord <= '36F'.hex) ||
-    (ord >= '203F'.hex && ord <= '2040'.hex)
+    return true if is_name_start_char?(char)
+
+    case char.ord
+    when    '-'.ord,
+            '.'.ord,
+            '0'.ord ..    '9'.ord,
+           'B7'.hex,
+          '300'.hex ..  '36F'.hex,
+         '203F'.hex .. '2040'.hex
+      true
+    else
+      false
+    end
   end
 end

data/spec/xml_convert_spec.rb

@@ -2,12 +2,34 @@ require "spec_helper"
 
 describe "XmlConvert" do
 
-  describe ".encode_name" do
+  describe ".decode_name" do
     it "returns nil when argument is nil" do
+      XmlConvert.decode_name(nil).should eq nil
+    end
+
+    it "returns the empty string when name is an empty string" do
+      XmlConvert.decode_name("").should eq ""
+    end
+
+    it "unescapes a single space" do
+      XmlConvert.decode_name("_x0020_").should eq " "
+    end
+
+    it "unescapes spaces" do
+      XmlConvert.decode_name("Order_x0020_Details").should eq "Order Details"
+    end
+
+    it "does not unescape leading underscores" do
+      XmlConvert.decode_name("_Test").should eq "_Test"
+    end
+  end
+
+  describe ".encode_name" do
+    it "returns nil when name is nil" do
       XmlConvert.encode_name(nil).should eq nil
     end
 
-    it "returns the empty string when argument is an empty string" do
+    it "returns the empty string when name is an empty string" do
       XmlConvert.encode_name("").should eq ""
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xml_convert
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 957471371544989854
+      hash: 4323374162532717687
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 957471371544989854
+      hash: 4323374162532717687
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24