abroad 4.4.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c7d8c0c7ebd22afaf330d5780b47f5ff06562d4
-  data.tar.gz: 04edfad7c29a9e50f7b48fdbfee57242d629f13e
+  metadata.gz: 5348d2c2cb1364b7537eff619d098424e7a75b59
+  data.tar.gz: 0e81e30e065c6cd40e1f9388e55cdf15336aec38
 SHA512:
-  metadata.gz: 607324c7da61ef85f86e860e5ab453228e9e50c0f5a3df830796aac6f08299f8309bf2ac182657a7d1dd5f7dd07210b6ce86ecf8c8e028cc686e1b1fb3125989
-  data.tar.gz: 7a14bcc1639c089b0c995c22a21026991bc4783334428750b68ce857870cb93403a618ab4324f7e67d478f5ee71421e45e459e8c1cf836627bbc1671c32e11af
+  metadata.gz: f91182af853c8dc4a173138c9edf9910a91da23495d6bfbc1c6a618611c0471de1b9e4c9e6254b3d0886ba20ac93c373499f6993668837382842d8d394c8ba59
+  data.tar.gz: ad1c5ccbdd511ef917b1aac506cb6dfea7adc42f0fe90b3043f9c1524f256d157cfd0d53581ee9c549eb82239b720ec5b859a79fb2d2c386b738923e554fc37b

data/lib/abroad.rb

@@ -7,11 +7,13 @@ module Abroad
   Extractors.register('yaml/rails', Extractors::Yaml::RailsExtractor)
   Extractors.register('yaml/dotted-key', Extractors::Yaml::DottedKeyExtractor)
   Extractors.register('json/key-value', Extractors::Json::KeyValueExtractor)
+  Extractors.register('json/dotted-key', Extractors::Json::DottedKeyExtractor)
   Extractors.register('xml/android', Extractors::Xml::AndroidExtractor)
   Extractors.register('txt/lines', Extractors::Txt::LinesExtractor)
 
   Serializers.register('yaml/rails', Serializers::Yaml::RailsSerializer)
   Serializers.register('json/key-value', Serializers::Json::KeyValueSerializer)
+  Serializers.register('json/dotted-key', Serializers::Json::DottedKeySerializer)
   Serializers.register('xml/android', Serializers::Xml::AndroidSerializer)
   Serializers.register('txt/lines', Serializers::Txt::LinesSerializer)
 

data/lib/abroad/extractors/json.rb

@@ -1,8 +1,9 @@
 module Abroad
   module Extractors
     module Json
-      autoload :KeyValueExtractor, 'abroad/extractors/json/key_value_extractor'
       autoload :JsonExtractor,     'abroad/extractors/json/json_extractor'
+      autoload :KeyValueExtractor, 'abroad/extractors/json/key_value_extractor'
+      autoload :DottedKeyExtractor,   'abroad/extractors/json/dotted_key_extractor'
     end
   end
 end

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

@@ -0,0 +1,64 @@
+require 'json/stream'
+
+module Abroad
+  module Extractors
+    module Json
+
+      class DottedKeyExtractor < JsonExtractor
+
+        private
+
+        def each_entry
+          key = []
+          nesting_stack = []
+
+          parser = ::JSON::Stream::Parser.new.tap do |parser|
+            parser.key { |k| key.push(k) }
+
+            parser.value do |val|
+              yield key.join('.'), val
+
+              case nesting_stack.last
+                when :object
+                  key.pop
+
+                when :array
+                  key[-1] += 1
+              end
+            end
+
+            parser.start_array do
+              nesting_stack.push(:array)
+              key.push(0)
+            end
+
+            parser.end_array do
+              nesting_stack.pop
+              key.pop
+
+              if nesting_stack.last == :object
+                key.pop
+              else
+                key[-1] += 1
+              end
+            end
+
+            parser.start_object do
+              nesting_stack.push(:object)
+            end
+
+            parser.end_object do
+              nesting_stack.pop
+              key.pop
+            end
+          end
+
+          parser << stream.read
+        rescue ::JSON::Stream::ParserError => e
+          raise Abroad::SyntaxError, "Syntax error in json: #{e.message}"
+        end
+
+      end
+    end
+  end
+end

data/lib/abroad/serializers/json.rb

@@ -3,6 +3,7 @@ module Abroad
     module Json
       autoload :JsonSerializer, 'abroad/serializers/json/json_serializer'
       autoload :KeyValueSerializer, 'abroad/serializers/json/key_value_serializer'
+      autoload :DottedKeySerializer, 'abroad/serializers/json/dotted_key_serializer'
     end
   end
 end

data/lib/abroad/serializers/json/dotted_key_serializer.rb

@@ -0,0 +1,106 @@
+module Abroad
+  module Serializers
+    module Json
+
+      class DottedKeySerializer < JsonSerializer
+        attr_reader :trie
+
+        def initialize(stream, locale, options = {})
+          super
+          @trie = Abroad::Serializers::Trie.new
+        end
+
+        def write_key_value(key, value)
+          trie.add(key.split('.'), encode(value))
+        end
+
+        def flush
+          write_node(trie.root, nil)
+          writer.flush
+          stream.flush
+        end
+
+        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 write_node(node, parent_key)
+          if node
+            if node.has_children?
+              if children_are_sequence?(node)
+                write_sequence(node, parent_key)
+              else
+                write_object(node, parent_key)
+              end
+            elsif node.has_value?
+              write_value(node, parent_key)
+            end
+          else
+            write_value(node, parent_key)
+          end
+        end
+
+        def write_value(node, parent_key)
+          value = node ? node.value : ''
+
+          if writer.in_object?
+            writer.write_key_value(parent_key, value)
+          else
+            writer.write_element(value)
+          end
+        end
+
+        def write_object(node, parent_key)
+          if writer.in_object?
+            writer.write_object(parent_key)
+          else
+            writer.write_object
+          end
+
+          node.each_child do |key, child|
+            write_node(child, key)
+          end
+
+          writer.close_object
+        end
+
+        def write_sequence(node, parent_key)
+          if writer.in_object?
+            writer.write_sequence(parent_key)
+          else
+            writer.write_sequence
+          end
+
+          generate_sequence(node).each do |element|
+            write_node(element, nil)
+          end
+
+          writer.close_sequence
+        end
+
+        def children_are_sequence?(node)
+          node.children.all? { |key, _| key =~ /\A[\d]+\z/ }
+        end
+
+        def generate_sequence(node)
+          keys = node.children.keys.map(&:to_i)
+          keys.each_with_object(Array.new(keys.max)) do |idx, arr|
+            arr[idx] = node.children[idx.to_s]
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/abroad/serializers/json/key_value_serializer.rb

@@ -25,7 +25,7 @@ module Abroad
         private
 
         def write_options
-          @write_options = { before: before_text, between: between_text }
+          @write_options ||= { before: before_text, between: between_text }
         end
 
         def before_text

data/lib/abroad/version.rb

@@ -1,3 +1,3 @@
 module Abroad
-  VERSION = '4.4.0'
+  VERSION = '4.5.0'
 end

data/spec/extractors/json/fixtures.yml

@@ -20,3 +20,32 @@
       string: cool string
     - key: jelly.beans
       string: popcorn
+:json/dotted-key:
+  nested_basic.json:
+    - key: foo.bar
+      string: baz
+    - key: hello
+      string: cool string
+    - key: jelly.beans
+      string: popcorn
+    - key: jelly.and.delicious
+      string: red vines
+  nested_arrays.json:
+    - key: array1.0
+      string: first
+    - key: array1.1
+      string: second
+    - key: array1.2
+      string: third
+    - key: arrayObj.array2.0
+      string: fourth
+    - key: arrayObj.array2.1
+      string: fifth
+    - key: jelly.beans
+      string: popcorn
+    - key: arrayOfArrays.0.0
+      string: abc
+    - key: arrayOfArrays.0.1
+      string: def
+    - key: arrayOfArrays.1
+      string: ghi

data/spec/extractors/json/fixtures/nested_arrays.json

@@ -0,0 +1,10 @@
+{
+  "array1": ["first", "second", "third"],
+  "arrayObj": {
+    "array2": ["fourth", "fifth"]
+  },
+  "jelly": {
+    "beans": "popcorn"
+  },
+  "arrayOfArrays": [["abc", "def"], "ghi"]
+}

data/spec/extractors/json/fixtures/nested_basic.json

@@ -0,0 +1,12 @@
+{
+  "hello": "cool string",
+  "foo": {
+    "bar": "baz"
+  },
+  "jelly": {
+    "beans": "popcorn",
+    "and": {
+      "delicious": "red vines"
+    }
+  }
+}

data/spec/serializers/json/dotted_key_serializer_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+include Abroad::Serializers
+
+describe Json::DottedKeySerializer do
+  let(:stream) { StringIO.new }
+  let(:locale) { 'fr-FR' }
+
+  let(:serializer) do
+    Json::DottedKeySerializer.new(stream, locale)
+  end
+
+  def serialize
+    yield
+    serializer.flush
+    stream.string
+  end
+
+  it 'writes key/value pairs' do
+    result = serialize do
+      serializer.write_key_value('com.foo.bar', 'baz')
+    end
+
+    expect(result).to eq("{\"com\":{\"foo\":{\"bar\":\"baz\"}}}")
+  end
+end

data/spec/spec_helper.rb

@@ -37,6 +37,8 @@ RSpec.configure do |config|
                 expected_phrase['key'] == actual_key
               end
 
+              next unless expected_string_index
+
               expected_phrase = expected_phrases[expected_string_index]
               expect(expected_phrase).to_not be_nil
               expect(expected_phrase['string']).to eq(actual_string)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abroad
 version: !ruby/object:Gem::Version
-  version: 4.4.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-27 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -113,6 +113,7 @@ files:
 - lib/abroad/extractors.rb
 - lib/abroad/extractors/extractor.rb
 - lib/abroad/extractors/json.rb
+- lib/abroad/extractors/json/dotted_key_extractor.rb
 - lib/abroad/extractors/json/json_extractor.rb
 - lib/abroad/extractors/json/key_value_extractor.rb
 - lib/abroad/extractors/txt.rb
@@ -128,6 +129,7 @@ files:
 - lib/abroad/extractors/yaml/yaml_extractor.rb
 - lib/abroad/serializers.rb
 - lib/abroad/serializers/json.rb
+- lib/abroad/serializers/json/dotted_key_serializer.rb
 - lib/abroad/serializers/json/json_serializer.rb
 - lib/abroad/serializers/json/key_value_serializer.rb
 - lib/abroad/serializers/serializer.rb
@@ -148,6 +150,8 @@ files:
 - spec/extractors/json/fixtures.yml
 - spec/extractors/json/fixtures/arrays.json
 - spec/extractors/json/fixtures/basic.json
+- spec/extractors/json/fixtures/nested_arrays.json
+- spec/extractors/json/fixtures/nested_basic.json
 - spec/extractors/json/fixtures/objects.json
 - spec/extractors/json/json_extractor_spec.rb
 - spec/extractors/txt/lines_extractor_spec.rb
@@ -172,6 +176,7 @@ files:
 - spec/extractors/yaml/fixtures/short.yml
 - spec/extractors/yaml/jruby_compat_spec.rb
 - spec/extractors/yaml/yaml_extractor_spec.rb
+- spec/serializers/json/dotted_key_serializer_spec.rb
 - spec/serializers/json/key_value_serializer_spec.rb
 - spec/serializers/txt/lines_serializer_spec.rb
 - spec/serializers/xml/android_serializer_spec.rb
@@ -196,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.4.5.5
 signing_key: 
 specification_version: 4
 summary: A set of parsers and serializers for dealing with localization file formats.