xml_convert 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.yardopts

@@ -0,0 +1,4 @@
+--markup markdown
+--readme README.md
+--charset utf-8
+'lib/**/*.rb'

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in xml_convert.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy Redburn
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# XmlConvert
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'xml_convert'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install xml_convert
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb', 'README.md']
+end
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/xml_convert/version.rb

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

data/lib/xml_convert.rb

@@ -0,0 +1,87 @@
+require "xml_convert/version"
+
+module XmlConvert
+  
+  # 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.
+  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}_"
+      elsif c == '_' && i+6 < name.length && name[i+1] == 'x' && name[i+6] == '_'
+        encoded_name << '_x005f_'
+      else
+        encoded_name << c
+      end
+    end
+    encoded_name
+  end
+
+  # Converts the name to a valid XML local name.
+  #
+  # @example (see .encode_name)
+  # @example XmlConvert.encode_local_name('a:b') #=> 'a_x003a_b'
+  #
+  # @param (see .encode_name)
+  # @return (see .encode_name)
+  def self.encode_local_name(name)
+    encode_name(name).gsub(':', '_x003a_')
+  end
+
+  private
+
+  def self.is_invalid?(char, is_first_letter)
+    !self.is_valid?(char, is_first_letter)
+  end
+
+  def self.is_valid?(char, is_first_letter)
+    is_first_letter ? is_name_start_char?(char) : is_name_char?(char)
+  end
+
+  # NameStartChar ::= ":" | [A-Z] | "_" | [a-z] | [#xC0-#xD6] | [#xD8-#xF6] |
+  #                   [#xF8-#x2FF] | [#x370-#x37D] | [#x37F-#x1FFF] |
+  #                   [#x200C-#x200D] | [#x2070-#x218F] | [#x2C00-#x2FEF] |
+  #                   [#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)
+  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)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+$LOAD_PATH << File.join(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'rspec'
+require 'rspec/autorun'
+
+require 'xml_convert'
+
+Dir["spec/support/**/*.rb"].each { |f| require File.expand_path(f) }

data/spec/xml_convert_spec.rb

@@ -0,0 +1,40 @@
+require "spec_helper"
+
+describe "XmlConvert" do
+
+  describe ".encode_name" do
+    it "returns nil when argument is nil" do
+      XmlConvert.encode_name(nil).should eq nil
+    end
+
+    it "returns the empty string when argument is an empty string" do
+      XmlConvert.encode_name("").should eq ""
+    end
+
+    it "does not escape underscores when no escaping is required" do
+      XmlConvert.encode_name("Order_Details").should eq "Order_Details"
+    end
+
+    it "escapes spaces" do
+      XmlConvert.encode_name("Order Details").should eq "Order_x0020_Details"
+    end
+
+    it "escapes characters that could be an escape sequence" do
+      XmlConvert.encode_name("Order_x0020_").should eq "Order_x005f_x0020_"
+    end
+
+    it "escapes periods as first letter" do
+      XmlConvert.encode_name(".Order").should eq "_x002e_Order"
+    end
+
+    it "does not escape colons" do
+      XmlConvert.encode_name("a:b").should eq "a:b"
+    end
+  end
+
+  describe ".encode_local_name" do
+    it "escapes colons" do
+      XmlConvert.encode_local_name("a:b").should eq "a_x003a_b"
+    end
+  end
+end

data/xml_convert.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'xml_convert/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "xml_convert"
+  gem.version       = XmlConvert::VERSION
+  gem.authors       = ["Jeremy Redburn"]
+  gem.email         = ["jredburn@salsify.com"]
+  gem.description   = %q{xml_convert provides utility methods for encoding and
+                          decoding XML names.}
+  gem.summary       = %q{xml_convert provides utility methods for encoding and
+                          decoding XML names.}
+  gem.homepage      = "https://github.com/socialceramics/xml_convert"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency("rake")
+  gem.add_development_dependency("yard")
+  gem.add_development_dependency("redcarpet")
+  gem.add_development_dependency("rspec")
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: xml_convert
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Redburn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "xml_convert provides utility methods for encoding and\n                          decoding
+  XML names."
+email:
+- jredburn@salsify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/xml_convert.rb
+- lib/xml_convert/version.rb
+- spec/spec_helper.rb
+- spec/xml_convert_spec.rb
+- xml_convert.gemspec
+homepage: https://github.com/socialceramics/xml_convert
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 957471371544989854
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 957471371544989854
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: xml_convert provides utility methods for encoding and decoding XML names.
+test_files:
+- spec/spec_helper.rb
+- spec/xml_convert_spec.rb
+has_rdoc: