i18n_flow 0.1.0

data/spec/lib/i18n_flow/validator/symmetry_spec.rb

@@ -0,0 +1,511 @@
+require 'i18n_flow/validator/symmetry'
+require 'i18n_flow/validator/errors'
+
+describe I18nFlow::Validator::Symmetry do
+  let(:validator) { I18nFlow::Validator::Symmetry.new(nil, nil) }
+
+  describe '#validate' do
+    it 'should pass if the given trees are completely the same' do
+      ast_1 = parse_yaml(<<-YAML)['en']
+      en:
+        key_1: text_1
+        foo:
+          key_2: text_2
+      YAML
+      ast_2 = parse_yaml(<<-YAML)['ja']
+      ja:
+        key_1: text_1
+        foo:
+          key_2: text_2
+      YAML
+
+      allow(validator).to receive(:ast_1).and_return(ast_1)
+      allow(validator).to receive(:ast_2).and_return(ast_2)
+      validator.validate!
+
+      expect(validator.errors).to eq([])
+    end
+
+    context 'asymmetric key' do
+      it 'should detect' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_3: text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::MissingKeyError.new('ja.key_2'),
+          I18nFlow::Validator::ExtraKeyError.new('ja.key_3'),
+        ])
+      end
+
+      it 'should detect on nested node' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          foo:
+            key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          foo:
+            key_3: text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::MissingKeyError.new('ja.foo.key_2'),
+          I18nFlow::Validator::ExtraKeyError.new('ja.foo.key_3'),
+        ])
+      end
+
+      it 'should suppress an error on the ignored node (value)' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_3: !ignore:key text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::MissingKeyError.new('ja.key_2'),
+        ])
+      end
+
+      it 'should suppress an error on the ignored node (map)' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          foo:
+            key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          foo: !ignore:key
+            key_3: text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+    end
+
+    context 'type mismatch' do
+      it 'should detect' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2:
+            one: text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::InvalidTypeError.new('ja.key_2'),
+        ])
+      end
+
+      it 'should detect on nested node' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          foo:
+            key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          foo:
+            key_2:
+              one: text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::InvalidTypeError.new('ja.foo.key_2'),
+        ])
+      end
+
+      it 'suppress an error on the ignored node' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: !ignore:key
+            one: text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'suppress an error on the ignored node (outer map)' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          foo:
+            key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          foo: !ignore:key
+            key_2:
+              one: text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+    end
+
+    context '!only tag' do
+      it 'should pass if the asymmetric node is tagged with its locale (value)' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: text_2
+          key_3: !only:ja text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should pass if the asymmetric node is tagged with its locale (map)' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: text_2
+          key_3: !only:ja
+            one: text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should pass if the symmetric node is tagged with both locales' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: !only:en,ja text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: !only:en,ja text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should fail if the symmetric node is tagged with an one-side locale' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: !only:ja text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::InvalidLocaleError.new('en.key_2', expect: ['ja'], actual: 'en'),
+        ])
+      end
+
+      it 'should fail if the asymmetric node is tagged with a different locale' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: text_2
+          key_3: !only:en
+            one: text_3
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::InvalidLocaleError.new('ja.key_3', expect: ['en'], actual: 'ja'),
+        ])
+      end
+
+      it 'should fail if the symmetric node is tagged with a different locale' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: !only:en text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::InvalidLocaleError.new('ja.key_2', expect: ['en'], actual: 'ja'),
+        ])
+      end
+    end
+
+    context '!todo tag' do
+      it 'should pass if the value is marked as todo' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: !todo text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should fail if the tag is on a non-value node' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          foo: !todo
+            key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          foo: !todo
+            key_2: text_2
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          # en.foo is ignored,
+          I18nFlow::Validator::InvalidTodoError.new('ja.foo'),
+        ])
+      end
+
+      it 'should fail if texts are different' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: text_2
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: text_1
+          key_2: !todo text_9
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::TodoContentError.new('ja.key_2', expect: 'text_2', actual: 'text_9'),
+        ])
+      end
+    end
+
+    context 'args' do
+      it 'should pass if the arguments are exclusive and exhaustive' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: '%{arg_1} %{arg_2}'
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: '%{arg_1} %{arg_2}'
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should be insensitive of the order of arguments' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: '%{arg_1} %{arg_2}'
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: '%{arg_2} %{arg_1}'
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should be insensitive of the duplicate of arguments' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: '%{arg_1} %{arg_1}'
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: '%{arg_1}'
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should ignore confusing args' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: 'foo %%{arg_1}'
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: 'foo'
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+
+      it 'should detect unbalanced arguments' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: 'foo %{arg_1}'
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: 'foo %{arg_2}'
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([
+          I18nFlow::Validator::AsymmetricArgsError.new('ja.key_1',
+            expect: ['arg_1'],
+            actual: ['arg_2'],
+          )
+        ])
+      end
+
+      it 'should suppress an error on the ignored node' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: 'foo %{arg_1}'
+        YAML
+        ast_2 = parse_yaml(<<-YAML)['ja']
+        ja:
+          key_1: !ignore:args 'foo %{arg_2}'
+        YAML
+
+        allow(validator).to receive(:ast_1).and_return(ast_1)
+        allow(validator).to receive(:ast_2).and_return(ast_2)
+        validator.validate!
+
+        expect(validator.errors).to eq([])
+      end
+    end
+  end
+end

data/spec/lib/i18n_flow/yaml_ast_proxy/node_spec.rb

@@ -0,0 +1,151 @@
+require 'psych'
+require 'i18n_flow/yaml_ast_proxy'
+
+describe I18nFlow::YamlAstProxy::Node do
+  describe '#merge!' do
+    it 'should merge mappings' do
+      ast_1 = parse_yaml(<<-YAML)
+      map:
+        foo_1: 'foo_1'
+        bar: 'bar_1'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      map:
+        foo_2: 'foo_2'
+        bar: 'bar_2'
+      YAML
+      result = parse_yaml(<<-YAML)
+      map:
+        foo_1: 'foo_1'
+        bar: 'bar_2'
+        foo_2: 'foo_2'
+      YAML
+
+      ast_1['map'].merge!(ast_2['map'])
+
+      expect(ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should merge sequences' do
+      ast_1 = parse_yaml(<<-YAML)
+      seq:
+        - 'seq_1_1'
+        - 'seq_1_2'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      seq:
+        - 'seq_2_1'
+        - 'seq_2_2'
+      YAML
+      result = parse_yaml(<<-YAML)
+      seq:
+        - 'seq_1_1'
+        - 'seq_1_2'
+        - 'seq_2_1'
+        - 'seq_2_2'
+      YAML
+
+      ast_1['seq'].merge!(ast_2['seq'])
+
+      expect(ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should merge nested mappings' do
+      ast_1 = parse_yaml(<<-YAML)
+      en:
+        map:
+          foo_1: 'foo_1'
+          bar: 'bar_1'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        map:
+          foo_2: 'foo_2'
+          bar: 'bar_2'
+        map_2:
+          baz_2: 'baz_2'
+      YAML
+      result = parse_yaml(<<-YAML)
+      en:
+        map:
+          foo_1: 'foo_1'
+          bar: 'bar_2'
+          foo_2: 'foo_2'
+        map_2:
+          baz_2: 'baz_2'
+      YAML
+
+      ast_1['en'].merge!(ast_2['en'])
+
+      expect(ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should merge nested sequences' do
+      ast_1 = parse_yaml(<<-YAML)
+      en:
+        seq:
+          - 'foo_1_1'
+          - 'foo_1_2'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        seq:
+          - 'foo_2_1'
+          - 'foo_2_2'
+      YAML
+      result = parse_yaml(<<-YAML)
+      en:
+        seq:
+          - 'foo_1_1'
+          - 'foo_1_2'
+          - 'foo_2_1'
+          - 'foo_2_2'
+      YAML
+
+      ast_1['en'].merge!(ast_2['en'])
+
+      expect(ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should merge root' do
+      ast_1 = parse_yaml(<<-YAML)
+      en:
+        map:
+          foo_1: 'foo_1'
+          bar: 'bar_1'
+          seq:
+            - 'foo_1_1'
+            - 'foo_1_2'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        map:
+          foo_2: 'foo_2'
+          bar: 'bar_2'
+          seq:
+            - 'foo_2_1'
+            - 'foo_2_2'
+        map_2:
+          baz_2: 'baz_2'
+      YAML
+      result = parse_yaml(<<-YAML)
+      en:
+        map:
+          foo_1: 'foo_1'
+          bar: 'bar_2'
+          seq:
+            - 'foo_1_1'
+            - 'foo_1_2'
+            - 'foo_2_1'
+            - 'foo_2_2'
+          foo_2: 'foo_2'
+        map_2:
+          baz_2: 'baz_2'
+      YAML
+
+      ast_1.merge!(ast_2)
+
+      expect(ast_1.to_yaml).to eq(result.to_yaml)
+    end
+  end
+end

data/spec/lib/i18n_flow_spec.rb

@@ -0,0 +1,21 @@
+require 'i18n_flow/configuration'
+
+describe I18nFlow do
+  describe '.config' do
+    it 'should return an instance of Configuration' do
+      expect {
+        expect(I18nFlow.config).to be_a(I18nFlow::Configuration)
+      }.not_to raise_error
+    end
+  end
+
+  describe '.configure' do
+    it 'should change option values inside a block' do
+      expect {
+        I18nFlow.configure do |config|
+          expect(config).to be_a(I18nFlow::Configuration)
+        end
+      }.not_to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'i18n_flow'
+require 'rspec'
+require 'fakefs/spec_helpers'
+require 'pry'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+Pry.config.history.should_load = false
+Pry.config.history.should_save = false
+
+RSpec.configure do |config|
+  config.include FakeFS::SpecHelpers
+  config.include UtilMacro
+end