cwyckoff-babel_icious 0.0.4.6 → 0.0.4.7

data/README.rdoc

@@ -62,14 +62,62 @@ if the value at "foo/bar" is empty or nil, "foo/bar" will not be translated.  Ad
 will only translate if the value at "foo/bar" begins with a capital "M".
 
 
-=== Translation
+== Customized mappings
 
-Finally, when you want to translate the mappings, simply call:
+=== .to
 
- Babelicious::Mapper.translate(:foo, source)
+If your target mapping is conditional, you may use the .to method which takes a block
 
-passing the tag for the mapping and the actual source you want to translate from.
+   m.from("foo/bar").to do |value|
+     if(value == "baz")
+       "value/is/baz"
+     else
+       "value/is/something/else"
+     end
+   end
 
+Note that the .to method must be used in conjunction with .from, which takes a simple string for the source mapping.
 
 
-  
+=== .customize
+
+If you have a complex mapping and need to customize it in some way, use the .customize method and pass it a block.  The block yields the source object for you to manipulate.  Let's say you're mapping xml to a hash where the xml source looks like:
+
+  <event><progress><statuses><status><code>Foo</code><message>Bar</message></status></statuses></progress></event>
+
+You need to map statuses so that the output looks like [{"name" => "Foo", "text" => "Bar"}].  Here's how you could customize your mapping:
+
+  m.map(:from => "event/progress/statuses", :to => "event/status_code").customize do |node|
+    res = []
+    node.elements.map {|nd| res << {"name" => nd.child_content("code"), "text" => nd.child_content("message")}
+    res
+  end
+
+This mapping would produce:
+
+  {"event" => {"status_code" => [{"name" => "Foo", "text" => "Bar"}]}}
+
+A more common use case is concatenation of nested xml nodes.  Given the following xml:
+
+  <event><institutions><institution>FOO</institution><institution>BAR</institution><institution>BAZ</institution></institutions></event>
+
+You could easily concatentate institutions with the following mapping:
+
+  m.map(:from => "event/institutions", :to => "event/concatenated_institutions").customize do |node|
+    node.concatenate_children("|")
+  end
+
+which would produce
+
+  {"event" => {"concatenated_institutions" => "FOO|BAR|BAZ"}}
+
+(note: 'concatentate' is a convenience method I've added to the libxml XML::Node object)
+
+
+== Translation
+
+Finally, when you want to translate the mappings, simply call:
+
+ Babelicious::Mapper.translate(:foo, source)
+
+passing the tag for the mapping and the actual source you want to translate from.

data/lib/babel_icious/core_ext/libxml_node.rb

@@ -15,6 +15,12 @@ module BabeliciousNodeHacks
     child_arr(child).first.name
   end
   
+  def elements
+    e = []
+    self.each_element {|elem| e << elem}
+    e
+  end
+  
   private
   
   def child_arr(child)

data/lib/babel_icious/map_factory.rb

@@ -8,7 +8,7 @@ module Babelicious
         eval("Babelicious::#{direction[:from].to_s.capitalize}Map").new(PathTranslator.new(opts[:from]), opts)
       end
 
-      def target(direction, opts={}, &block)
+      def target(direction, opts={})
         eval("Babelicious::#{direction[:to].to_s.capitalize}Map").new(PathTranslator.new(opts[:to]), opts)
       end
 

data/lib/babel_icious/mapper.rb

@@ -21,6 +21,11 @@ module Babelicious
       def direction(dir={})
         current_target_mapper.direction = @direction = dir
       end
+
+      def from(from_str=nil)
+        current_target_mapper.register_from(from_str)
+        self
+      end
       
       def map(opts={})
         current_target_mapper.register_mapping(opts)
@@ -35,6 +40,11 @@ module Babelicious
         @mapped_targets, @direction = nil, {}
       end
 
+      def to(&block)
+        current_target_mapper.register_to(&block)
+        self
+      end
+      
       def translate(key=nil, source=nil)
         raise MapperError, "No target mapper exists for key #{key}" unless mappings.has_key?(key)
         

data/lib/babel_icious/mappers/base_map.rb

@@ -1,7 +1,8 @@
 module Babelicious
   
   class BaseMap
-    
+    attr_reader :opts, :path_translator
+
     def map_from(output, source_value)
       if map_condition?
           map_output(output, source_value) if map_condition.is_satisfied_by(source_value)

data/lib/babel_icious/mappers/hash_map.rb

@@ -29,11 +29,7 @@ module Babelicious
       end
     end
 
-    private
-    
-    def source_element(source, element)
-      source[element.to_sym] || source[element.to_s]
-    end
+    protected
 
     def map_output(hash_output, source_value)
       catch :no_value do
@@ -46,6 +42,12 @@ module Babelicious
         end
       end 
     end 
+
+    private
+    
+    def source_element(source, element)
+      source[element.to_sym] || source[element.to_s]
+    end
     
     def map_source_value(source_value)
       if(@customized_map)

data/lib/babel_icious/mappers/xml_map.rb

@@ -30,7 +30,7 @@ module Babelicious
       end
     end
 
-    private
+    protected
     
     def map_output(xml_output, source_value)
       @index = @path_translator.last_index
@@ -43,6 +43,8 @@ module Babelicious
       end 
     end
     
+    private
+
     def populate_nodes(xml_output)
       return if @index == 0
 
@@ -64,7 +66,6 @@ module Babelicious
       if xml_output.root.nil?
         xml_output.root = XML::Node.new(@path_translator[0])
       end 
-
     end
     
     def update_node?(xml_output, source_value)

data/lib/babel_icious/path_translator.rb

@@ -5,8 +5,7 @@ module Babelicious
     include Enumerable
     
     def initialize(untranslated_path)
-      @full_path = untranslated_path
-      @parsed_path = translate(untranslated_path)
+      set_path(untranslated_path)
     end
 
     def [](index)
@@ -25,6 +24,11 @@ module Babelicious
       @parsed_path.last
     end
     
+    def set_path(untranslated_path)
+      @full_path = untranslated_path
+      @parsed_path = translate(untranslated_path)
+    end 
+
     def size
       @parsed_path.size
     end

data/lib/babel_icious/target_mapper.rb

@@ -23,7 +23,7 @@ module Babelicious
         filtered_source = source_element.class.filter_source(source) if filtered_source.nil?
         
         source_value = source_element.value_from(filtered_source)
-        target_element.map_from(target, source_value)
+        process_target(target, target_element, source_value)
       end
       target
     end
@@ -36,6 +36,20 @@ module Babelicious
       @mappings.last[1].register_customized(&block)
     end
     
+    def register_from(from_str)
+      raise TargetMapperError, "Please specify a source mapping" if from_str.nil?
+      source = MapFactory.source(@direction, {:from => from_str})
+
+      @mappings << [source]
+    end
+
+    def register_to(&block)
+      raise TargetMapperError, "You must call the .from method before customizing the .to method (e.g., m.from(\"foo\").to {|value| ...}" unless @mappings.last
+
+      target = MapFactory.target(@direction, {:to => '', :to_proc => block})
+      @mappings.last << target
+    end
+
     def register_mapping(opts={})
       raise TargetMapperError, "Both :from and :to keys must be set (e.g., {:from => \"foo/bar\", :to => \"bar/foo\")" unless (opts[:from] && opts[:to])
       target = MapFactory.target(@direction, opts)
@@ -47,6 +61,17 @@ module Babelicious
     def reset
       @mappings, @direction = [], nil
     end
+
+    private
+
+    def process_target(target, target_element, source_value)
+      if(target_element.opts[:to_proc])
+        target_element.path_translator.set_path(target_element.opts[:to_proc].call(source_value))
+        target_element.map_from(target, source_value)
+      else 
+        target_element.map_from(target, source_value)
+      end 
+    end 
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cwyckoff-babel_icious
 version: !ruby/object:Gem::Version 
-  version: 0.0.4.6
+  version: 0.0.4.7
 platform: ruby
 authors: 
 - Chris Wyckoff
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-24 00:00:00 -07:00
+date: 2009-05-14 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency