abroad 4.1.3 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f814fbe28b3a7cc583852c28b409cb1af6fae4d
-  data.tar.gz: 1e3a91d89598201db9b378884caabda6bca16918
+  metadata.gz: 0fe36cd26c80451ce1514284dd1d4948797e8a95
+  data.tar.gz: c1645f6188fc0494a51153bfb2a06ca4220b697f
 SHA512:
-  metadata.gz: ed65796bcf2919b65b0379899a5b09e37be18fa5a510344a83b6eb3e11ddb2b9734a58578ce4f248a037208ea437596899f4d7b8b53cf427d7b19a9d9b77bf35
-  data.tar.gz: 57f8ef7d24417e3bc58c3271452a35a4d744bd81ae453539d66324c58cf77e9b3ea5337e74f05683eb632ca99fd9f58b38f93ed7e42ab816ff6d2e72db674b39
+  metadata.gz: 9995680ee6439cad5c4d6086fa3efde9fcd9b12ffc2c8cf410d97aa5a6dca9539b0bcd49e1c66dd444045bed8c413098f90fa43dc205968e8588b5bd07ac7c5d
+  data.tar.gz: e6609ea0b1c92ba0130db811f359e7aa48daf9659e787340bb671d952b0720fe1e25361c2690e2a425d7b32f41bc96d636cd50b2521037f0bdc8a75863dd09bf

data/lib/abroad.rb

@@ -8,10 +8,12 @@ module Abroad
   Extractors.register('yaml/dotted-key', Extractors::Yaml::DottedKeyExtractor)
   Extractors.register('json/key-value', Extractors::Json::KeyValueExtractor)
   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('xml/android', Serializers::Xml::AndroidSerializer)
+  Serializers.register('txt/lines', Serializers::Txt::LinesSerializer)
 
   class << self
     def extractors

data/lib/abroad/extractors.rb

@@ -2,6 +2,7 @@ module Abroad
   module Extractors
     autoload :Extractor, 'abroad/extractors/extractor'
     autoload :Json,      'abroad/extractors/json'
+    autoload :Txt,       'abroad/extractors/txt'
     autoload :Xml,       'abroad/extractors/xml'
     autoload :Yaml,      'abroad/extractors/yaml'
 

data/lib/abroad/extractors/txt.rb

@@ -0,0 +1,8 @@
+module Abroad
+  module Extractors
+    module Txt
+      autoload :LinesExtractor, 'abroad/extractors/txt/lines_extractor'
+      autoload :TxtExtractor,   'abroad/extractors/txt/txt_extractor'
+    end
+  end
+end

data/lib/abroad/extractors/txt/lines_extractor.rb

@@ -0,0 +1,22 @@
+require 'json/stream'
+
+module Abroad
+  module Extractors
+    module Txt
+
+      class LinesExtractor < TxtExtractor
+        private
+
+        def each_entry
+          return to_enum(__method__) unless block_given?
+
+          stream.each_line.with_index do |line, idx|
+            # keys should always be strings
+            yield idx.to_s, line.chomp
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/abroad/extractors/txt/txt_extractor.rb

@@ -0,0 +1,17 @@
+module Abroad
+  module Extractors
+    module Txt
+
+      class TxtExtractor < Extractor
+        def extract_each(options = {}, &block)
+          if block_given?
+            each_entry(&block)
+          else
+            to_enum(__method__, options)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/abroad/serializers.rb

@@ -2,6 +2,7 @@ module Abroad
   module Serializers
     autoload :Json,       'abroad/serializers/json'
     autoload :Serializer, 'abroad/serializers/serializer'
+    autoload :Txt,        'abroad/serializers/txt'
     autoload :Trie,       'abroad/serializers/trie'
     autoload :Xml,        'abroad/serializers/xml'
     autoload :Yaml,       'abroad/serializers/yaml'

data/lib/abroad/serializers/txt.rb

@@ -0,0 +1,8 @@
+module Abroad
+  module Serializers
+    module Txt
+      autoload :TxtSerializer,   'abroad/serializers/txt/txt_serializer'
+      autoload :LinesSerializer, 'abroad/serializers/txt/lines_serializer'
+    end
+  end
+end

data/lib/abroad/serializers/txt/lines_serializer.rb

@@ -0,0 +1,52 @@
+module Abroad
+  module Serializers
+    module Txt
+
+      class LinesSerializer < TxtSerializer
+        DEFAULT_NEWLINE_SEPARATOR = "\n"
+
+        attr_reader :newline_separator, :lines
+
+        def initialize(stream, locale, options = {})
+          @newline_separator = options.fetch(:newline_separator, DEFAULT_NEWLINE_SEPARATOR)
+          @lines = []
+          super
+        end
+
+        def write_key_value(key, value)
+          unless valid_key?(key)
+            raise KeyError, "'#{key}' is not a valid key"
+          end
+
+          add_line(key, value)
+        end
+
+        def flush
+          stream.write(lines.join(newline_separator))
+          super
+        end
+
+        private
+
+        def add_line(key, value)
+          key = parse_key(key)
+
+          if key >= lines.size
+            lines.concat(Array.new(key - lines.size + 1) { '' })
+          end
+
+          lines[key] = value
+        end
+
+        def parse_key(key)
+          key.to_i
+        end
+
+        def valid_key?(key)
+          !!(key =~ /[\d]+/)
+        end
+      end
+
+    end
+  end
+end

data/lib/abroad/serializers/txt/txt_serializer.rb

@@ -0,0 +1,15 @@
+require 'stringio'
+
+module Abroad
+  module Serializers
+    module Txt
+
+      class TxtSerializer < Serializer
+        def write_raw(text)
+          stream.write(text)
+        end
+      end
+
+    end
+  end
+end

data/lib/abroad/version.rb

@@ -1,3 +1,3 @@
 module Abroad
-  VERSION = '4.1.3'
+  VERSION = '4.2.0'
 end

data/spec/extractors/txt/lines_extractor_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+include Abroad::Extractors
+
+describe Txt::LinesExtractor do
+  it 'extracts text into lines' do
+    text = outdent(%Q(
+      foo
+
+      bar
+
+      baz
+      boo
+    ))
+
+    strings = described_class.from_string(text).extract_each.to_a
+
+    expect(strings).to eq([
+      ['0', 'foo'], ['1', ''],    ['2', 'bar'],
+      ['3', ''],    ['4', 'baz'], ['5', 'boo']
+    ])
+  end
+end

data/spec/serializers/txt/lines_serializer_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+include Abroad::Serializers
+
+describe Txt::LinesSerializer do
+  let(:stream) { StringIO.new }
+  let(:locale) { 'en' }
+  let(:serializer) { described_class.from_stream(stream, locale) }
+
+  it 'writes key/value pairs' do
+    serializer.write_key_value('2', 'foo')
+    serializer.write_key_value('3', 'bar')
+    serializer.write_key_value('5', 'baz')
+
+    serializer.close
+    expect(stream.string).to eq(outdent(%Q(
+
+
+      foo
+      bar
+
+      baz
+    )).rstrip)
+  end
+
+  it 'raises an error if given a non-numeric key' do
+    expect { serializer.write_key_value('abc', 'def') }.to(
+      raise_error(KeyError)
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -4,10 +4,19 @@ require 'rspec'
 require 'abroad'
 require 'yaml'
 
-RSpec.configure do |config|
-  def camelize(str)
-    str.gsub(/(^\w|[-_]\w)/) { $1[-1].upcase }
+module SpecHelpers
+  def outdent(str)
+    # The special YAML pipe operator treats the text that follows as literal,
+    # and includes newlines, tabs, and spaces. It also strips leading tabs and
+    # spaces. This means you can include a fully indented bit of, say, source
+    # code in your source code, and it will give you back a string with all the
+    # indentation preserved (but without any leading indentation).
+    YAML.load("|#{str}")
   end
+end
+
+RSpec.configure do |config|
+  config.include(SpecHelpers)
 
   shared_examples 'a fixture-based extractor' do |dir, namespace|
     fixture_manifest = YAML.load_file(File.join(dir, 'fixtures.yml'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abroad
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.2.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-10 00:00:00.000000000 Z
+date: 2016-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: htmlentities
@@ -109,6 +109,9 @@ files:
 - lib/abroad/extractors/json.rb
 - lib/abroad/extractors/json/json_extractor.rb
 - lib/abroad/extractors/json/key_value_extractor.rb
+- lib/abroad/extractors/txt.rb
+- lib/abroad/extractors/txt/lines_extractor.rb
+- lib/abroad/extractors/txt/txt_extractor.rb
 - lib/abroad/extractors/xml.rb
 - lib/abroad/extractors/xml/android_extractor.rb
 - lib/abroad/extractors/xml/xml_extractor.rb
@@ -123,6 +126,9 @@ files:
 - lib/abroad/serializers/json/key_value_serializer.rb
 - lib/abroad/serializers/serializer.rb
 - lib/abroad/serializers/trie.rb
+- lib/abroad/serializers/txt.rb
+- lib/abroad/serializers/txt/lines_serializer.rb
+- lib/abroad/serializers/txt/txt_serializer.rb
 - lib/abroad/serializers/xml.rb
 - lib/abroad/serializers/xml/android_serializer.rb
 - lib/abroad/serializers/xml/xml_serializer.rb
@@ -138,6 +144,7 @@ files:
 - spec/extractors/json/fixtures/basic.json
 - spec/extractors/json/fixtures/objects.json
 - spec/extractors/json/json_extractor_spec.rb
+- spec/extractors/txt/lines_extractor_spec.rb
 - spec/extractors/xml/fixtures.yml
 - spec/extractors/xml/fixtures/basic_arrays.xml
 - spec/extractors/xml/fixtures/basic_plurals.xml
@@ -159,6 +166,7 @@ files:
 - spec/extractors/yaml/jruby_compat_spec.rb
 - spec/extractors/yaml/yaml_extractor_spec.rb
 - spec/serializers/json/key_value_serializer_spec.rb
+- spec/serializers/txt/lines_serializer_spec.rb
 - spec/serializers/xml/android_serializer_spec.rb
 - spec/serializers/yaml/rails_serializer_spec.rb
 - spec/spec_helper.rb
@@ -181,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: A set of parsers and serializers for dealing with localization file formats.