gyoku 0.5.0 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 1.0.0 (2012-12-17)
+
+* Refactoring: Removed the global configuration. This should really only affect the
+  `Gyoku.convert_symbols_to` shortcut which was removed as well. If you're using Gyoku
+  with Savon 2.0, there's now an option for that. If you're using Gyoku on itself,
+  you can pass it the `:key_converter` option instead.
+
 ## 0.5.0 (2012-12-15)
 
 Feature: [#19](https://github.com/savonrb/gyoku/pull/19) adds support for explicit XML attributes.

data/README.md

@@ -28,24 +28,13 @@ Gyoku.xml(:lower_camel_case => "key")
 # => "<lowerCamelCase>key</lowerCamelCase>"
 ```
 
-You can change the default conversion formula.
+You can change the default conversion formula to :camelcase, :upcase or :none.
 
 ``` ruby
-Gyoku.convert_symbols_to :camelcase  # or one of [:none, :lower_camelcase, :upcase]
-
-Gyoku.xml(:camel_case => "key")
+Gyoku.xml(:camel_case => "key", :key_converter => :camelcase)
 # => "<CamelCase>key</CamelCase>"
 ```
 
-And you can also define your own formula.
-
-``` ruby
-Gyoku.convert_symbols_to { |key| key.sub(/^prefixed_/, '') }
-
-Gyoku.xml(:prefixed_attribute => "key")
-# => "<attribute>key</attribute>"
-```
-
 Hash key Strings are not converted and may contain namespaces.
 
 ``` ruby

data/lib/gyoku.rb

@@ -2,22 +2,15 @@ require "gyoku/version"
 require "gyoku/hash"
 
 module Gyoku
-  class << self
 
-    # Translates a given +hash+ with +options+ to XML.
-    def xml(hash, options = {})
-      Hash.to_xml hash.dup, 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
+  # Converts a given Hash +key+ with +options+ into an XML tag.
+  def self.xml_tag(key, options = {})
+    XMLKey.create(key, options)
+  end
 
+  # Translates a given +hash+ with +options+ to XML.
+  def self.xml(hash, options = {})
+    Hash.to_xml hash.dup, options
   end
+
 end

data/lib/gyoku/version.rb

@@ -1,5 +1,5 @@
 module Gyoku
 
-  VERSION = "0.5.0"
+  VERSION = "1.0.0"
 
 end

data/lib/gyoku/xml_key.rb

@@ -21,7 +21,7 @@ module Gyoku
           xml_key = xml_key.split(":").last
         end
 
-        xml_key = symbol_converter.call(xml_key) if Symbol === key
+        xml_key = key_converter(options).call(xml_key) if Symbol === key
 
         if !unqualified && qualify?(options) && !xml_key.include?(":")
           xml_key = "#{options[:namespace]}:#{xml_key}"
@@ -30,22 +30,14 @@ module Gyoku
         xml_key
       end
 
-      # Returns the formula for converting Symbol keys.
-      def symbol_converter
-        @symbol_converter ||= FORMULAS[:lower_camelcase]
-      end
-
-      # 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
+    private
 
-        @symbol_converter = formula
+      # Returns the formula for converting Symbol keys.
+      def key_converter(options)
+        key_converter = options[:key_converter] || :lower_camelcase
+        FORMULAS[key_converter]
       end
 
-    private
-
       # Chops special characters from the end of a given +string+.
       def chop_special_characters(string)
         ["!", "/"].include?(string[-1, 1]) ? string.chop : string

data/spec/gyoku/xml_key_spec.rb

@@ -32,51 +32,14 @@ describe Gyoku::XMLKey do
       end
 
       it "adds a given :namespace after converting the key" do
-        Gyoku::XMLKey.symbol_converter = :camelcase
-
-        key = create :username, :element_form_default => :qualified, :namespace => :v1
+        key = create :username, :element_form_default => :qualified, :namespace => :v1, :key_converter => :camelcase
         key.should == "v1:Username"
       end
-
-      after { Gyoku::XMLKey.symbol_converter = :lower_camelcase }  #reset
-    end
-  end
-
-  describe ".symbol_converter" do
-    after { Gyoku::XMLKey.symbol_converter = :lower_camelcase }  #reset
-
-    it "returns the default lower_camelcase converter" do
-      Gyoku::XMLKey.symbol_converter.call("snake_case").should == "snakeCase"
-    end
-
-    it "accepts :lower_camelcase" do
-      Gyoku::XMLKey.symbol_converter = :lower_camelcase
-      Gyoku::XMLKey.create(:snake_case).should == "snakeCase"
-    end
-
-    it "accepts :camelcase" do
-      Gyoku::XMLKey.symbol_converter = :camelcase
-      Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
-    end
-
-    it "accepts :upcase" do
-      Gyoku::XMLKey.symbol_converter = :upcase
-      Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
-    end
-
-    it "accepts :none" do
-      Gyoku::XMLKey.symbol_converter = :none
-      Gyoku::XMLKey.create(:snake_Case).should == "snake_Case"
-    end
-
-    it "allows 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
+    Gyoku::XMLKey.create(key, options)
   end
 
 end

data/spec/gyoku_spec.rb

@@ -2,9 +2,42 @@ require "spec_helper"
 
 describe Gyoku do
 
+  describe ".xml_tag" do
+    it "translates Symbols to lowerCamelCase by default" do
+      tag = Gyoku.xml_tag(:user_name)
+      expect(tag).to eq("userName")
+    end
+
+    it "does not translate Strings" do
+      tag = Gyoku.xml_tag("user_name")
+      expect(tag).to eq("user_name")
+    end
+
+    it "translates Symbols by a given key_converter" do
+      tag = Gyoku.xml_tag(:user_name, :key_converter => :upcase)
+      expect(tag).to eq("USER_NAME")
+    end
+
+    it "does not translates Strings with a given key_converter" do
+      tag = Gyoku.xml_tag("user_name", :key_converter => :upcase)
+      expect(tag).to eq("user_name")
+    end
+  end
+
   describe ".xml" do
     it "translates a given Hash to XML" do
-      Gyoku.xml({ :id => 1 }, :element_form_default => :qualified).should == "<id>1</id>"
+      hash = { :id => 1 }
+      xml = Gyoku.xml(hash, :element_form_default => :qualified)
+
+      xml.should == "<id>1</id>"
+    end
+
+    it "accepts a key_converter for the Hash keys" do
+      hash = { :user_name => "finn", "pass_word" => "secret" }
+      xml = Gyoku.xml(hash, :key_converter => :upcase)
+
+      xml.should include("<USER_NAME>finn</USER_NAME>")
+      xml.should include("<pass_word>secret</pass_word>")
     end
 
     it "does not modify the original Hash" do
@@ -23,24 +56,4 @@ describe Gyoku do
     end
   end
 
-  describe ".configure" do
-    it "yields 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 "accepts a predefined formula" do
-      Gyoku.convert_symbols_to(:camelcase)
-      Gyoku::XMLKey.create(:snake_case).should == "SnakeCase"
-    end
-
-    it "accepts a block" do
-      Gyoku.convert_symbols_to { |key| key.upcase }
-      Gyoku::XMLKey.create(:snake_case).should == "SNAKE_CASE"
-    end
-  end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gyoku
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-15 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3740829974448807903
+      hash: 2627220150066470254
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -109,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3740829974448807903
+      hash: 2627220150066470254
 requirements: []
 rubyforge_project: gyoku
 rubygems_version: 1.8.24