abroad 4.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89386cbcccef7a58f59510df50bd148a1759b244
-  data.tar.gz: da9806a5703f00406080302a111b3142b7f4b74c
+  metadata.gz: dadd8e40a0bd722140b69e9afc49eae5aa28f28e
+  data.tar.gz: f204d17dffbc54735c6255765e675e809bc0cd29
 SHA512:
-  metadata.gz: fcb3fca5ae80ac040aaed3863f916dc244d638bd573d33dea66ddf8ce861ec2747304e6d33eebad7aa24891dc89193d9a9c1a21a5e76e5ddab14e8a80f7256ca
-  data.tar.gz: cb5ec47a06195eeba1edaa71f40dedf54048ae90c54ecb82d5ceb9432ccd68cb4902d2bbc31619b8c49ea00a1f6aa94b4e0425509b53ceed34b1bf70e52cfdfc
+  metadata.gz: bca09d5714337ed9456c3dfa774d3ba63287114a4e8d2a6403dfcf0f71267902f9dcdf76840537b9be98231c6bac86a19342f27dd495977a0636021d2ab09c1d
+  data.tar.gz: 63b5cc4df1bef7e34f0501932b22c5e7c54f90e13be4738d9b6664848310e8daf3e653c90c1c099968a2922c08110ad4f237ad07e1c360129814d84284ef1b6a

data/lib/abroad/extractors/extractor.rb

@@ -23,8 +23,8 @@ module Abroad
           from_stream(StringIO.new(string), &block)
         end
 
-        def open(file, &block)
-          from_stream(File.open(file, 'r'), &block)
+        def open(file, mode = 'r', &block)
+          from_stream(File.open(file, mode), &block)
         end
       end
 
@@ -32,7 +32,7 @@ module Abroad
         @stream = stream
       end
 
-      def extract_each
+      def extract_each(options = {})
         raise NotImplementedError,
           'expected to be implemented in derived classes'
       end

data/lib/abroad/extractors/json/json_extractor.rb

@@ -3,11 +3,11 @@ module Abroad
     module Json
 
       class JsonExtractor < Extractor
-        def extract_each(&block)
+        def extract_each(options = {}, &block)
           if block_given?
             each_entry(&block)
           else
-            to_enum(__method__)
+            to_enum(__method__, options)
           end
         end
       end

data/lib/abroad/extractors/xml/xml_extractor.rb

@@ -5,11 +5,11 @@ module Abroad
     module Xml
 
       class XmlExtractor < Extractor
-        def extract_each(&block)
+        def extract_each(options = {}, &block)
           if block_given?
             each_entry(&block)
           else
-            to_enum(__method__)
+            to_enum(__method__, options)
           end
         end
 

data/lib/abroad/extractors/yaml/dotted_key_extractor.rb

@@ -3,26 +3,30 @@ module Abroad
     module Yaml
 
       class DottedKeyExtractor < YamlExtractor
-        def extract_each(&block)
+        def extract_each(options = {}, &block)
           if block_given?
-            walk(parse, [], &block)
+            walk(parse, [], options, &block)
           else
-            to_enum(__method__)
+            to_enum(__method__, options)
           end
         end
 
         private
 
-        def walk(obj, cur_path, &block)
+        def walk(obj, cur_path, options, &block)
           case obj
             when Hash
               obj.each_pair do |key, val|
                 segment = is_numeric?(key) ? "'#{key}'" : key
-                walk(val, cur_path + [segment], &block)
+                walk(val, cur_path + [segment], options, &block)
               end
             when Array
-              obj.each_with_index do |val, idx|
-                walk(val, cur_path + [idx.to_s], &block)
+              if options[:preserve_arrays]
+                yield scrub_path(cur_path).join('.'), obj
+              else
+                obj.each_with_index do |val, idx|
+                  walk(val, cur_path + [idx.to_s], options, &block)
+                end
               end
             else
               yield scrub_path(cur_path).join('.'), obj

data/lib/abroad/serializers/serializer.rb

@@ -19,8 +19,8 @@ module Abroad
           end
         end
 
-        def open(file, locale, &block)
-          from_stream(File.open(file), locale, &block)
+        def open(file, locale, mode = 'r', &block)
+          from_stream(File.open(file, mode), locale, &block)
         end
       end
 

data/lib/abroad/serializers/yaml/rails_serializer.rb

@@ -16,8 +16,7 @@ module Abroad
 
         def write_key_value(key, value)
           key_parts = split_key(key)
-          encoded_value = value.encode(encoding) if value
-          trie.add(key_parts, encoded_value)
+          trie.add(key_parts, encode(value))
         end
 
         def flush
@@ -29,6 +28,19 @@ module Abroad
 
         private
 
+        def encode(value)
+          case value
+            when Array
+              value.map { |elem| encode(elem) }
+            else
+              if value.respond_to?(:encode)
+                value.encode(encoding)
+              else
+                value
+              end
+          end
+        end
+
         def split_key(key)
           # Doesn't allow dots to come before spaces or at the end of the key.
           # Uses regex negative lookahead, that's what the (?!) sections are.
@@ -67,8 +79,17 @@ module Abroad
         def write_value(node, parent_key)
           value = (node ? node.value : '') || ''
 
+          case value
+            when Array
+              write_array_value(parent_key, value)
+            else
+              write_textual_value(parent_key, value)
+          end
+        end
+
+        def coerce(value)
           # coerce numeric values
-          value = case value
+          case value
             when /\A\d+\z/
               value.to_i
             when /\A\d+\.\d+\z/
@@ -76,6 +97,10 @@ module Abroad
             else
               value
           end
+        end
+
+        def write_textual_value(parent_key, value)
+          value = coerce(value)
 
           if writer.in_map?
             writer.write_key_value(parent_key, value)
@@ -84,6 +109,17 @@ module Abroad
           end
         end
 
+        def write_array_value(parent_key, elements)
+          # we should _always_ be in a map, but just in case...
+          writer.write_sequence(parent_key) if writer.in_map?
+
+          elements.each do |element|
+            writer.write_element(coerce(element))
+          end
+
+          writer.close_sequence
+        end
+
         def write_map(node, parent_key)
           if writer.in_map?
             writer.write_map(parent_key)

data/lib/abroad/version.rb

@@ -1,3 +1,3 @@
 module Abroad
-  VERSION = '4.0.3'
+  VERSION = '4.1.0'
 end

data/spec/extractors/yaml/dotted_key_extractor_spec.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+describe Abroad::Extractors::Yaml::DottedKeyExtractor do
+  it 'preserves arrays as single values when asked' do
+    content = YAML.dump(foo: { bar: %w(a b c) })
+    extractor = Abroad::Extractors::Yaml::DottedKeyExtractor.from_string(content)
+    enum = extractor.extract_each(preserve_arrays: true)
+
+    phrases = enum.with_object({}) do |(key, value), ret|
+      ret[key] = value
+    end
+
+    expect(phrases).to eq(
+      'foo.bar' => %w(a b c)
+    )
+  end
+end

data/spec/serializers/yaml/rails_serializer_spec.rb

@@ -1,12 +1,10 @@
 require 'spec_helper'
 
-include Abroad::Serializers
-
-describe Yaml::RailsSerializer do
+describe Abroad::Serializers::Yaml::RailsSerializer do
   let(:stream) { StringIO.new }
   let(:locale) { 'fr' }
   let(:serializer) do
-    Yaml::RailsSerializer.new(stream, locale)
+    Abroad::Serializers::Yaml::RailsSerializer.new(stream, locale)
   end
 
   def serialize
@@ -133,6 +131,16 @@ describe Yaml::RailsSerializer do
     })
   end
 
+  it 'writes successfully if given an array object instead of a string' do
+    result = serialize do
+      serializer.write_key_value('foo.bar', %w(a b c))
+    end
+
+    expect(result).to eq({
+      'fr' => { 'foo' => { 'bar' => %w(a b c) } }
+    })
+  end
+
   it 'does not write arrays for sequential but non-numeric keys' do
     result = serialize do
       serializer.write_key_value('foo.bar1', 'b')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abroad
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -147,6 +147,7 @@ files:
 - spec/extractors/xml/fixtures/newlines.xml
 - spec/extractors/xml/fixtures/quotes.xml
 - spec/extractors/xml/xml_extractor_spec.rb
+- spec/extractors/yaml/dotted_key_extractor_spec.rb
 - spec/extractors/yaml/fixtures.yml
 - spec/extractors/yaml/fixtures/arrays.yml
 - spec/extractors/yaml/fixtures/arrays_and_hashes.yml