abroad 1.0.0

data/spec/abroad_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe Abroad do
+  describe '.extractors' do
+    it 'lists all the registered extractors' do
+      extractors = Abroad.extractors
+      expect(extractors).to be_a(Array)
+      expect(extractors).to include('yaml/rails')
+    end
+  end
+
+  describe '.serializers' do
+    it 'lists all the registered serializers' do
+      serializers = Abroad.serializers
+      expect(serializers).to be_a(Array)
+      expect(serializers).to include('yaml/rails')
+    end
+  end
+
+  describe '.extractor' do
+    it 'retrieves the extractor class by id' do
+      expect(Abroad.extractor('yaml/rails')).to eq(
+        Abroad::Extractors::Yaml::RailsExtractor
+      )
+    end
+  end
+
+  describe '.serializer' do
+    it 'retrieves the serializer class by id' do
+      expect(Abroad.serializer('yaml/rails')).to eq(
+        Abroad::Serializers::Yaml::RailsSerializer
+      )
+    end
+  end
+end

data/spec/extractors/json/fixtures/arrays.json

@@ -0,0 +1,9 @@
+{
+  "array1": ["1", "2", "3"],
+  "arrayObj": {
+    "array2": ["4", "5"]
+  },
+  "hello": "cool string",
+  "foo.bar": "baz",
+  "jelly.beans": "popcorn"
+}

data/spec/extractors/json/fixtures/basic.json

@@ -0,0 +1,5 @@
+{
+  "hello": "cool string",
+  "foo.bar": "baz",
+  "jelly.beans": "popcorn"
+}

data/spec/extractors/json/fixtures/objects.json

@@ -0,0 +1,11 @@
+{
+  "smartling" : {
+    "translate_paths" : ["/*", "/*/*"],
+    "source_key_paths" : ["/{*}"],
+    "variants_enabled" : true,
+    "placeholder_format_custom" : ["%s"]
+  },
+  "hello": "cool string",
+  "foo.bar": "baz",
+  "jelly.beans": "popcorn"
+}

data/spec/extractors/json/fixtures.yml

@@ -0,0 +1,22 @@
+:json/key-value:
+  basic.json:
+    - key: foo.bar
+      string: baz
+    - key: hello
+      string: cool string
+    - key: jelly.beans
+      string: popcorn
+  objects.json:
+    - key: foo.bar
+      string: baz
+    - key: hello
+      string: cool string
+    - key: jelly.beans
+      string: popcorn
+  arrays.json:
+    - key: foo.bar
+      string: baz
+    - key: hello
+      string: cool string
+    - key: jelly.beans
+      string: popcorn

data/spec/extractors/json/json_extractor_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe 'JsonExtractor' do
+  fixture_dir = File.expand_path('./', File.dirname(__FILE__))
+  it_behaves_like 'a fixture-based extractor', fixture_dir, Abroad::Extractors::Json
+end

data/spec/extractors/xml/fixtures/basic_arrays.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <string-array name="captains">
+        <item>Janeway</item>
+        <item>Sisko</item>
+        <item>Picard</item>
+        <item>Kirk</item>
+    </string-array>
+</resources>

data/spec/extractors/xml/fixtures/basic_plurals.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<resources>
+    <plurals name="horses">
+        <item quantity="zero">There are no horses</item>
+        <item quantity="one">There is one horse</item>
+        <item quantity="other">There are %d horses</item>
+    </plurals>
+</resources>

data/spec/extractors/xml/fixtures/basic_strings.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources>
+    <string name="foobar">baz</string>
+    <string name="password_length_too_short">Password is too short</string>
+    <string name="password_length_too_long">Password is too long</string>
+    <string name="password_empty">Please enter your password.</string>
+    <string name="username_empty">Please enter your email address.</string>
+</resources>

data/spec/extractors/xml/fixtures/entities.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources>
+    <string name="states">Alaska &amp; Washington</string>
+</resources>

data/spec/extractors/xml/fixtures/markup.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources>
+    <string name="internal_markup">I <b>have</b> <a href="foo">internal</a> markup</string>
+    <string name="quoted_markup">"I <b>have</b> <a href="foo">quoted</a> markup"</string>
+</resources>

data/spec/extractors/xml/fixtures/newlines.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources>
+    <string name="foobar">baz</string>
+    <string name="password_length_too_short">Password is
+too short</string>
+</resources>

data/spec/extractors/xml/fixtures/quotes.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<resources>
+    <string name="quotes">"I have quotes"</string>
+    <string name="leading_space">" I have a leading space"</string>
+    <string name="internal_quotes">"I have \"internal\" quotes"</string>
+    <string name="apostrophes">That\'s the ticket</string>
+    <string name="apostrophes_in_quotes">"That's the ticket"</string>
+    <string name="escaped_apostrophes_in_quotes">"That\'s the ticket"</string>
+</resources>

data/spec/extractors/xml/fixtures.yml

@@ -0,0 +1,54 @@
+:xml/android:
+  basic_strings.xml:
+    - key: foobar
+      string: baz
+    - key: password_length_too_short
+      string: Password is too short
+    - key: password_length_too_long
+      string: Password is too long
+    - key: password_empty
+      string: Please enter your password.
+    - key: username_empty
+      string: Please enter your email address.
+  basic_arrays.xml:
+    - key: captains.0
+      string: Janeway
+    - key: captains.1
+      string: Sisko
+    - key: captains.2
+      string: Picard
+    - key: captains.3
+      string: Kirk
+  basic_plurals.xml:
+    - key: horses.zero
+      string: There are no horses
+    - key: horses.one
+      string: There is one horse
+    - key: horses.other
+      string: There are %d horses
+  quotes.xml:
+    - key: quotes
+      string: I have quotes
+    - key: leading_space
+      string: " I have a leading space"
+    - key: internal_quotes
+      string: I have "internal" quotes
+    - key: apostrophes
+      string: That's the ticket
+    - key: apostrophes_in_quotes
+      string: That's the ticket
+    - key: escaped_apostrophes_in_quotes
+      string: That's the ticket
+  markup.xml:
+    - key: internal_markup
+      string: I <b>have</b> <a href="foo">internal</a> markup
+    - key: quoted_markup
+      string: I <b>have</b> <a href="foo">quoted</a> markup
+  newlines.xml:
+    - key: foobar
+      string: baz
+    - key: password_length_too_short
+      string: "Password is\ntoo short"
+  entities.xml:
+    - key: states
+      string: "Alaska & Washington"

data/spec/extractors/xml/xml_extractor_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe 'XmlExtractor' do
+  fixture_dir = File.expand_path('./', File.dirname(__FILE__))
+  it_behaves_like 'a fixture-based extractor', fixture_dir, Abroad::Extractors::Xml
+end

data/spec/extractors/yaml/fixtures/arrays.yml

@@ -0,0 +1,9 @@
+en:
+  jobs:
+    benefits:
+      - Benefits to write home about
+      - Stress-free commute
+      - Brand-new gadgets
+    other:
+      - Stay happy and healthy
+      - Playtime anytime

data/spec/extractors/yaml/fixtures/arrays_and_hashes.yml

@@ -0,0 +1,29 @@
+en:
+  jobs:
+    benefits:
+      -
+        title: Benefits to write home about
+        body:
+          - Competitive salaries and bonuses
+          - Medical, dental, vision, and life insurance plans
+      -
+        title: Stress-free commute
+        body:
+          - Downtown SF location right next to BART and MUNI lines
+          - Free cabs and meals for those late nights
+      -
+        title: Brand-new gadgets
+        body:
+          - Pick out a new Mac or PC desktop or laptop
+          - Big monitors, fancy headphones, and more
+      -
+        title: Stay happy and healthy
+        body:
+          - Catered lunches and a pantry with every snack, drink, and Bi-Rite meal
+          - Gym membership at the Sports Club LA (2 blocks from the office)
+      -
+        title: Playtime anytime
+        body:
+          - Unlimited paid time off
+          - A game room with video games, board games, foosball, ping-pong, and shuffleboard
+          - A Culture Team behind office happy hours and Hawai'i holiday parties

data/spec/extractors/yaml/fixtures/invalid_single_quote_escape.yml

@@ -0,0 +1,2 @@
+foo:
+  bar: "baz\'boo"

data/spec/extractors/yaml/fixtures/invalid_single_quote_escape_array.yml

@@ -0,0 +1,3 @@
+foo:
+  bar:
+    - "baz\'boo"

data/spec/extractors/yaml/fixtures/nesting.yml

@@ -0,0 +1,19 @@
+en:
+  activerecord:
+    attributes:
+      user:
+        unique_name: "Username"
+        password: "Password"
+        email_address: "Email address"
+      email_address:
+        address: "Email address"
+      testimonial:
+        original_text: "Your Story"
+    errors:
+      custom:
+        user:
+          uniqueness_of_unique_name: has already been taken
+          password_does_not_match_unique_name: cannot match username
+          cannot_disable_if_full_access: Cannot disable a user who has full access
+          current_password_blank: Please enter your current password
+          current_password_mismatch: The password you entered does not match our records

data/spec/extractors/yaml/fixtures/short.yml

@@ -0,0 +1,2 @@
+foo:
+  bar: baz

data/spec/extractors/yaml/fixtures.yml

@@ -0,0 +1,75 @@
+:yaml/dotted-key:
+  invalid_single_quote_escape_array.yml:
+    - key: foo.bar.0
+      string: baz'boo
+  invalid_single_quote_escape.yml:
+    - key: foo.bar
+      string: baz'boo
+  short.yml:
+    - key: foo.bar
+      string: baz
+  nesting.yml:
+    - key: en.activerecord.attributes.user.unique_name
+      string: Username
+    - key: en.activerecord.attributes.user.password
+      string: Password
+    - key: en.activerecord.attributes.user.email_address
+      string: Email address
+    - key: en.activerecord.attributes.email_address.address
+      string: Email address
+    - key: en.activerecord.attributes.testimonial.original_text
+      string: Your Story
+    - key: en.activerecord.errors.custom.user.uniqueness_of_unique_name
+      string: has already been taken
+    - key: en.activerecord.errors.custom.user.password_does_not_match_unique_name
+      string: cannot match username
+    - key: en.activerecord.errors.custom.user.cannot_disable_if_full_access
+      string: Cannot disable a user who has full access
+    - key: en.activerecord.errors.custom.user.current_password_blank
+      string: Please enter your current password
+    - key: en.activerecord.errors.custom.user.current_password_mismatch
+      string: The password you entered does not match our records
+  arrays.yml:
+    - key: en.jobs.benefits.0
+      string: Benefits to write home about
+    - key: en.jobs.benefits.1
+      string: Stress-free commute
+    - key: en.jobs.benefits.2
+      string: Brand-new gadgets
+    - key: en.jobs.other.0
+      string: Stay happy and healthy
+    - key: en.jobs.other.1
+      string: Playtime anytime
+  arrays_and_hashes.yml:
+    - key: en.jobs.benefits.0.title
+      string: Benefits to write home about
+    - key: en.jobs.benefits.0.body.0
+      string: Competitive salaries and bonuses
+    - key: en.jobs.benefits.0.body.1
+      string: Medical, dental, vision, and life insurance plans
+    - key: en.jobs.benefits.1.title
+      string: Stress-free commute
+    - key: en.jobs.benefits.1.body.0
+      string: Downtown SF location right next to BART and MUNI lines
+    - key: en.jobs.benefits.1.body.1
+      string: Free cabs and meals for those late nights
+    - key: en.jobs.benefits.2.title
+      string: Brand-new gadgets
+    - key: en.jobs.benefits.2.body.0
+      string: Pick out a new Mac or PC desktop or laptop
+    - key: en.jobs.benefits.2.body.1
+      string: Big monitors, fancy headphones, and more
+    - key: en.jobs.benefits.3.title
+      string: Stay happy and healthy
+    - key: en.jobs.benefits.3.body.0
+      string: Catered lunches and a pantry with every snack, drink, and Bi-Rite meal
+    - key: en.jobs.benefits.3.body.1
+      string: Gym membership at the Sports Club LA (2 blocks from the office)
+    - key: en.jobs.benefits.4.title
+      string: Playtime anytime
+    - key: en.jobs.benefits.4.body.0
+      string: Unlimited paid time off
+    - key: en.jobs.benefits.4.body.1
+      string: A game room with video games, board games, foosball, ping-pong, and shuffleboard
+    - key: en.jobs.benefits.4.body.2
+      string: A Culture Team behind office happy hours and Hawai'i holiday parties

data/spec/extractors/yaml/jruby_compat_spec.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+if Abroad.jruby?
+  require 'abroad/extractors/yaml/jruby_compat'
+
+  describe 'JRubyCompat' do
+    let(:compat) { Abroad::Extractors::Yaml::JRubyCompat }
+
+    describe 'clean' do
+      it 'replaces escaped single quotes in key/value pairs' do
+        yaml = "foo:\n" +
+          "  bar: \"baz\\'boo\""
+
+        expect { YAML.load(yaml) }.to raise_error(Psych::SyntaxError)
+        expect(YAML.load(compat.clean(yaml))).to eq({
+          'foo' => { 'bar' => "baz'boo" }
+        })
+      end
+
+      it 'replaces escaped single quotes in array elements' do
+        yaml = "foo:\n" +
+          "  - abc\n" +
+          "  - \"def\\'ghi\""
+
+        expect { YAML.load(yaml) }.to raise_error(Psych::SyntaxError)
+        expect(YAML.load(compat.clean(yaml))).to eq({
+          'foo' => ['abc', "def'ghi"]
+        })
+      end
+
+      it 'does not replace escaped single quotes that occur outside of double quotes' do
+        yaml = "foo:\n" +
+          "  bar: abc\\'def"
+
+        expect { YAML.load(yaml) }.to_not raise_error
+        expect(YAML.load(compat.clean(yaml))).to eq({
+          'foo' => { 'bar' => "abc\\'def" }
+        })
+      end
+
+      it 'does not replace escaped single quotes that occur outside of double quotes in arrays' do
+        yaml = "foo:\n" +
+          "  - def\\'ghi"
+
+        expect { YAML.load(yaml) }.to_not raise_error
+        expect(YAML.load(compat.clean(yaml))).to eq({
+          'foo' => ["def\\'ghi"]
+        })
+      end
+    end
+  end
+end

data/spec/extractors/yaml/yaml_extractor_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+describe 'YamlExtractor' do
+  fixture_dir = File.expand_path('./', File.dirname(__FILE__))
+  it_behaves_like 'a fixture-based extractor', fixture_dir, Abroad::Extractors::Yaml
+end

data/spec/serializers/json/key_value_serializer_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+include Abroad::Serializers
+
+describe Json::KeyValueSerializer do
+  let(:stream) { StringIO.new }
+  let(:locale) { 'fr-FR' }
+
+  let(:serializer) do
+    Json::KeyValueSerializer.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('foo', 'bar')
+    end
+
+    expect(result).to eq('{"foo":"bar"}')
+  end
+end

data/spec/serializers/xml/android_serializer_spec.rb

@@ -0,0 +1,165 @@
+require 'spec_helper'
+require 'yaml'
+
+include Abroad::Serializers
+
+# NOTE: The use of YAML in these specs is only to make writing multi-line
+# indented strings easier to read and write
+describe Xml::AndroidSerializer do
+  let(:stream) { StringIO.new }
+  let(:locale) { 'fr-FR' }
+
+  let(:serializer) do
+    Xml::AndroidSerializer.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('foo', 'bar')
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string name="foo">bar</string>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it 'detects and writes plurals' do
+    result = serialize do
+      serializer.write_key_value('horses.one', 'There is one horse')
+      serializer.write_key_value('horses.other', 'There are %d horses')
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <plurals name="horses">
+                <item quantity="one">There is one horse</item>
+                <item quantity="other">There are %d horses</item>
+            </plurals>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it 'detects and writes arrays in any order' do
+    result = serialize do
+      serializer.write_key_value('captains.1', 'Kirk')
+      serializer.write_key_value('captains.3', 'Sisko')
+      serializer.write_key_value('captains.0', 'Janeway')
+      serializer.write_key_value('captains.2', 'Picard')
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string-array name="captains">
+                <item>Janeway</item>
+                <item>Kirk</item>
+                <item>Picard</item>
+                <item>Sisko</item>
+            </string-array>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it "doesn't escape entities" do
+    result = serialize do
+      serializer.write_key_value('states', "Alaska & Hawai'i")
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string name="states">Alaska &amp; Hawai\\'i</string>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it "doesn't escape html elements" do
+    result = serialize do
+      serializer.write_key_value('captain', "<b>Jean Luc</b> Picard")
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string name="captain"><b>Jean Luc</b> Picard</string>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it 'escapes double quotes' do
+    result = serialize do
+      serializer.write_key_value('wow', 'And I said "cool"')
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string name="wow">And I said \\"cool\\"</string>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it 'escapes double quotes at the beginning of a string' do
+    result = serialize do
+      serializer.write_key_value('wow', '"Elvis" is cool')
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string name="wow">\\"Elvis\\" is cool</string>
+        </resources>
+      EOM
+    ).strip)
+  end
+
+  it 'writes a mixture of all types of string' do
+    result = serialize do
+      serializer.write_key_value('justaplural.many', 'Many plurals')
+      serializer.write_key_value('justanarray.1', 'Second in line')
+      serializer.write_key_value('justanarray.0', 'First in line')
+      serializer.write_key_value('justastring', "I'm very basic")
+      serializer.write_key_value('justaplural.one', 'One plural')
+    end
+
+    expect(result).to eq(YAML.load(<<-EOM
+      |
+        <?xml version="1.0" encoding="UTF-8"?>
+        <resources>
+            <string name="justastring">I\\'m very basic</string>
+            <plurals name="justaplural">
+                <item quantity="many">Many plurals</item>
+                <item quantity="one">One plural</item>
+            </plurals>
+            <string-array name="justanarray">
+                <item>First in line</item>
+                <item>Second in line</item>
+            </string-array>
+        </resources>
+      EOM
+    ).strip)
+  end
+end