gyoku 0.3.1 → 0.4.0

data/README.md

@@ -37,6 +37,17 @@ Conventions
 * These conventions are also applied to the return value of objects responding to :call
 * All other objects are converted to Strings using :to_s
 
+Symbols are converted to lowerCamelCase?
+----------------------------------------
+
+That's the default. But you can use one of the other conversion formulas:
+
+    Gyoku.convert_symbols_to :camelcase  # or one of [:none, :lower_camelcase]
+
+or even define you own one:
+
+    Gyoku.convert_symbols_to { |key| key.upcase }
+
 Special characters
 ------------------
 

data/Rakefile

@@ -1,11 +1,9 @@
 require "bundler"
 Bundler::GemHelper.install_tasks
 
-task :default => :spec
-
 begin
   require "yard"
-  
+
   YARD::Rake::YardocTask.new do |t|
     t.files = ["README.md", "lib/**/*.rb"]
   end
@@ -16,7 +14,7 @@ end
 
 begin
   require "metric_fu"
-  
+
   MetricFu::Configuration.run do |c|
     c.metrics = [:churn, :flog, :flay, :reek, :roodi, :saikuro] # :rcov seems to be broken
     c.graphs = [:flog, :flay, :reek, :roodi]
@@ -30,7 +28,7 @@ end
 
 begin
   require "rspec/core/rake_task"
-  
+
   RSpec::Core::RakeTask.new do |t|
     t.pattern = "spec/**/*_spec.rb"
     t.rspec_opts = %w(-fd -c)
@@ -40,3 +38,6 @@ rescue LoadError
     abort "Run 'gem install rspec' to be able to run specs"
   end
 end
+
+task :default => :spec
+task :test => :spec

data/lib/gyoku.rb

@@ -2,10 +2,22 @@ require "gyoku/version"
 require "gyoku/hash"
 
 module Gyoku
+  class << self
 
-  # Translates a given +hash+ with +options+ to XML.
-  def self.xml(hash, options = {})
-    Hash.to_xml hash, options
-  end
+    # Translates a given +hash+ with +options+ to XML.
+    def xml(hash, options = {})
+      Hash.to_xml hash, options
+    end
+
+    # Yields this object for configuration.
+    def configure
+      yield self
+    end
 
+    # Sets the formula for converting Symbol keys.
+    def convert_symbols_to(formula = nil, &block)
+      XMLKey.symbol_converter = formula ? formula : block
+    end
+
+  end
 end

data/lib/gyoku/array.rb

@@ -1,13 +1,10 @@
 require "builder"
 
 require "gyoku/hash"
-require "gyoku/xml_key"
 require "gyoku/xml_value"
 
 module Gyoku
   class Array
-    extend XMLKey
-    extend XMLValue
 
     # Translates a given +array+ to XML. Accepts the XML +key+ to add the elements to,
     # whether to +escape_xml+ and an optional Hash of +attributes+.
@@ -16,7 +13,7 @@ module Gyoku
         case item
           when ::Hash   then xml.tag!(key, attrs) { xml << Hash.to_xml(item) }
           when NilClass then xml.tag!(key, "xsi:nil" => "true")
-          else               xml.tag!(key, attrs) { xml << to_xml_value(item, escape_xml) }
+          else               xml.tag!(key, attrs) { xml << XMLValue.create(item, escape_xml) }
         end
       end
     end

data/lib/gyoku/core_ext/string.rb

@@ -4,11 +4,12 @@ module Gyoku
 
       # Returns the String in lowerCamelCase.
       def lower_camelcase
-        str = dup
-        str.gsub!(/\/(.?)/) { "::#{$1.upcase}" }
-        str.gsub!(/(?:_+|-+)([a-z])/) { $1.upcase }
-        str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
-        str
+        self[0].chr.downcase + self.camelcase[1..-1]
+      end
+
+      # Returns the String in CamelCase.
+      def camelcase
+        self.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
       end
 
     end

data/lib/gyoku/hash.rb

@@ -6,22 +6,20 @@ require "gyoku/xml_value"
 
 module Gyoku
   class Hash
-    extend XMLKey
-    extend XMLValue
 
     # Translates a given +hash+ with +options+ to XML.
     def self.to_xml(hash, options = {})
       iterate_with_xml hash do |xml, key, value, attributes|
         self_closing = key.to_s[-1, 1] == "/"
         escape_xml = key.to_s[-1, 1] != "!"
-        xml_key = to_xml_key key, options
+        xml_key = XMLKey.create key, options
 
         case
           when ::Array === value  then xml << Array.to_xml(value, xml_key, escape_xml, attributes)
           when ::Hash === value   then xml.tag!(xml_key, attributes) { xml << Hash.to_xml(value, options) }
           when self_closing       then xml.tag!(xml_key, attributes)
           when NilClass === value then xml.tag!(xml_key, "xsi:nil" => "true")
-          else                         xml.tag!(xml_key, attributes) { xml << to_xml_value(value, escape_xml) }
+          else                         xml.tag!(xml_key, attributes) { xml << XMLValue.create(value, escape_xml) }
         end
       end
     end

data/lib/gyoku/version.rb

@@ -1,5 +1,5 @@
 module Gyoku
 
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 
 end

data/lib/gyoku/xml_key.rb

@@ -2,39 +2,61 @@ require "gyoku/core_ext/string"
 
 module Gyoku
   module XMLKey
+    class << self
+
+      FORMULAS = {
+        :lower_camelcase => lambda { |key| key.lower_camelcase },
+        :camelcase       => lambda { |key| key.camelcase },
+        :none            => lambda { |key| key }
+      }
+
+      # Converts a given +object+ with +options+ to an XML key.
+      def create(key, options = {})
+        xml_key = chop_special_characters key.to_s
+
+        if unqualify?(xml_key)
+          xml_key = xml_key.split(":").last
+        elsif qualify?(options) && !xml_key.include?(":")
+          xml_key = "#{options[:namespace]}:#{xml_key}"
+        end
+
+        case key
+          when Symbol then symbol_converter.call(xml_key)
+          else             xml_key
+        end
+      end
 
-    # Converts a given +object+ with +options+ to an XML key.
-    def to_xml_key(key, options = {})
-      xml_key = chop_special_characters key.to_s
-
-      if unqualify?(xml_key)
-        xml_key = xml_key.split(":").last
-      elsif qualify?(options) && !xml_key.include?(":")
-        xml_key = "#{options[:namespace]}:#{xml_key}"
+      # Returns the formula for converting Symbol keys.
+      def symbol_converter
+        @symbol_converter ||= FORMULAS[:lower_camelcase]
       end
 
-      case key
-        when Symbol then xml_key.lower_camelcase
-        else             xml_key
+      # Sets the +formula+ for converting Symbol keys.
+      # Accepts one of +FORMULAS+ of an object responding to <tt>:call</tt>.
+      def symbol_converter=(formula)
+        formula = FORMULAS[formula] unless formula.respond_to? :call
+        raise ArgumentError, "Invalid symbol_converter formula" unless formula
+
+        @symbol_converter = formula
       end
-    end
 
-  private
+    private
 
-    # Chops special characters from the end of a given +string+.
-    def chop_special_characters(string)
-      ["!", "/"].include?(string[-1, 1]) ? string.chop : string
-    end
+      # Chops special characters from the end of a given +string+.
+      def chop_special_characters(string)
+        ["!", "/"].include?(string[-1, 1]) ? string.chop : string
+      end
 
-    # Returns whether to remove the namespace from a given +key+.
-    def unqualify?(key)
-      key[0, 1] == ":"
-    end
+      # Returns whether to remove the namespace from a given +key+.
+      def unqualify?(key)
+        key[0, 1] == ":"
+      end
 
-    # Returns whether to namespace all keys (elementFormDefault).
-    def qualify?(options)
-      options[:element_form_default] == :qualified && options[:namespace]
-    end
+      # Returns whether to namespace all keys (elementFormDefault).
+      def qualify?(options)
+        options[:element_form_default] == :qualified && options[:namespace]
+      end
 
+    end
   end
 end

data/lib/gyoku/xml_value.rb

@@ -2,24 +2,26 @@ require "cgi"
 
 module Gyoku
   module XMLValue
+    class << self
 
-    # xs:dateTime format.
-    XS_DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S%Z"
+      # xs:dateTime format.
+      XS_DATETIME_FORMAT = "%Y-%m-%dT%H:%M:%S%Z"
 
-    # Converts a given +object+ to an XML value.
-    def to_xml_value(object, escape_xml = true)
-      if DateTime === object
-        object.strftime XS_DATETIME_FORMAT
-      elsif String === object
-        escape_xml ? CGI.escapeHTML(object) : object
-      elsif object.respond_to?(:to_datetime)
-        to_xml_value object.to_datetime
-      elsif object.respond_to?(:call)
-        to_xml_value object.call
-      else
-        object.to_s
+      # Converts a given +object+ to an XML value.
+      def create(object, escape_xml = true)
+        if DateTime === object
+          object.strftime XS_DATETIME_FORMAT
+        elsif String === object
+          escape_xml ? CGI.escapeHTML(object) : object
+        elsif object.respond_to?(:to_datetime)
+          create object.to_datetime
+        elsif object.respond_to?(:call)
+          create object.call
+        else
+          object.to_s
+        end
       end
-    end
 
+    end
   end
 end

data/spec/gyoku/core_ext/string_spec.rb

@@ -8,4 +8,10 @@ describe String do
     end
   end
 
+  describe "#camelcase" do
+    it "converts a snakecase String to CamelCase" do
+      "camel_case".camelcase.should == "CamelCase"
+    end
+  end
+
 end

data/spec/gyoku/xml_key_spec.rb

@@ -1,37 +1,68 @@
 require "spec_helper"
 
 describe Gyoku::XMLKey do
-  include Gyoku::XMLKey
 
-  describe "#to_xml_key" do
+  describe ".create" do
     it "should remove exclamation marks from the end of a String" do
-      to_xml_key("value!").should == "value"
+      create("value!").should == "value"
     end
 
     it "should remove forward slashes from the end of a String" do
-      to_xml_key("self-closing/").should == "self-closing"
+      create("self-closing/").should == "self-closing"
     end
 
     it "should not convert snake_case Strings" do
-      to_xml_key("lower_camel_case").should == "lower_camel_case"
+      create("lower_camel_case").should == "lower_camel_case"
     end
 
     it "should convert snake_case Symbols to lowerCamelCase Strings" do
-      to_xml_key(:lower_camel_case).should == "lowerCamelCase"
-      to_xml_key(:lower_camel_case!).should == "lowerCamelCase"
+      create(:lower_camel_case).should == "lowerCamelCase"
+      create(:lower_camel_case!).should == "lowerCamelCase"
     end
 
     context "with :element_form_default set to :qualified and a :namespace" do
       it "should add the given namespace" do
-        key = to_xml_key :qualify, :element_form_default => :qualified, :namespace => :v1
+        key = create :qualify, :element_form_default => :qualified, :namespace => :v1
         key.should == "v1:qualify"
       end
 
       it "should not add the given namespace if the key starts with a colon" do
-        key = to_xml_key ":qualify", :element_form_default => :qualified, :namespace => :v1
+        key = create ":qualify", :element_form_default => :qualified, :namespace => :v1
         key.should == "qualify"
       end
     end
   end
 
+  describe ".symbol_converter" do
+    after { Gyoku::XMLKey.symbol_converter = :lower_camelcase }  #reset
+
+    it "should return the default lower_camelcase converter" do
+      Gyoku::XMLKey.symbol_converter.call("snake_case").should == "snakeCase"
+    end
+
+    it "should accept :lower_camelcase" do
+      Gyoku::XMLKey.symbol_converter = :lower_camelcase
+      Gyoku::XMLKey.create(:snake_case).should == "snakeCase"
+    end
+
+    it "should accept :camelcase" do
+      Gyoku::XMLKey.symbol_converter = :camelcase
+      Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
+    end
+
+    it "should accept :none" do
+      Gyoku::XMLKey.symbol_converter = :none
+      Gyoku::XMLKey.create(:snake_Case).should == "snake_Case"
+    end
+
+    it "should allow to set a custom converter" do
+      Gyoku::XMLKey.symbol_converter = Proc.new { |key| key.upcase }
+      Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
+    end
+  end
+
+  def create(key, options = {})
+    Gyoku::XMLKey.create key, options
+  end
+
 end

data/spec/gyoku/xml_value_spec.rb

@@ -1,27 +1,26 @@
 require "spec_helper"
 
 describe Gyoku::XMLValue do
-  include Gyoku::XMLValue
 
   let(:datetime) { DateTime.new 2012, 03, 22, 16, 22, 33 }
   let(:datetime_string) { "2012-03-22T16:22:33+00:00" }
-  
-  describe "#to_xml_value" do
+
+  describe ".create" do
     context "for DateTime objects" do
       it "should return an xs:dateTime compliant String" do
-        to_xml_value(datetime).should == datetime_string
+        create(datetime).should == datetime_string
       end
     end
 
     it "should return the String value and escape special characters" do
-      to_xml_value("string").should == "string"
-      to_xml_value("<tag>").should == "&lt;tag&gt;"
-      to_xml_value("at&t").should == "at&amp;t"
-      to_xml_value('"quotes"').should == "&quot;quotes&quot;"
+      create("string").should == "string"
+      create("<tag>").should == "&lt;tag&gt;"
+      create("at&t").should == "at&amp;t"
+      create('"quotes"').should == "&quot;quotes&quot;"
     end
 
     it "should just return the String value without escaping special characters" do
-      to_xml_value("<tag>", false).should == "<tag>"
+      create("<tag>", false).should == "<tag>"
     end
 
     it "should return an xs:dateTime compliant String for Objects responding to #to_datetime" do
@@ -30,17 +29,21 @@ describe Gyoku::XMLValue do
         DateTime.new 2012, 03, 22, 16, 22, 33
       end
 
-      to_xml_value(singleton).should == "2012-03-22T16:22:33+00:00"
+      create(singleton).should == "2012-03-22T16:22:33+00:00"
     end
 
     it "should #call Proc objects and convert their return value" do
       object = lambda { DateTime.new 2012, 03, 22, 16, 22, 33 }
-      to_xml_value(object).should == "2012-03-22T16:22:33+00:00"
+      create(object).should == "2012-03-22T16:22:33+00:00"
     end
 
     it "should call #to_s unless the Object responds to #to_datetime" do
-      to_xml_value("value").should == "value"
+      create("value").should == "value"
     end
   end
 
+  def create(object, escape_xml = true)
+    Gyoku::XMLValue.create object, escape_xml
+  end
+
 end

data/spec/gyoku_spec.rb

@@ -9,4 +9,24 @@ describe Gyoku do
     end
   end
 
+  describe ".configure" do
+    it "should yield the Gyoku module" do
+      Gyoku.configure { |config| config.should respond_to(:convert_symbols_to) }
+    end
+  end
+
+  describe ".convert_symbols_to" do
+    after { Gyoku.convert_symbols_to(:lower_camelcase) }  # reset
+
+    it "should accept a predefined formula" do
+      Gyoku.convert_symbols_to(:camelcase)
+      Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
+    end
+
+    it "should accept a block" do
+      Gyoku.convert_symbols_to { |key| key.upcase }
+      Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
+    end
+  end
+
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gyoku
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-26 00:00:00 +01:00
+date: 2011-04-05 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gemtest
 - .gitignore
 - .rspec
 - Gemfile
@@ -140,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: gyoku
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: Converts Ruby Hashes to XML