i18n_flow 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4537799b78a2246ecd36a0cf9be738dc928e2422
-  data.tar.gz: 1fc6adc2ef94f46a13714829dfbc677cb42778f9
+  metadata.gz: '08d2cf8d25372c57651808089a31dedc34a52f81'
+  data.tar.gz: 2a96774f923502e0dd534c8b632acf4f7e5d232f
 SHA512:
-  metadata.gz: 923ce8ee56eb52fbe275a1c07657c163b8a319c7dc67aec80e9b0f45f6991e44ff43b4c4c04bcce70909c26eac6959fb5f22555a347feb3aaca09223f4eae92a
-  data.tar.gz: 9d84ac662df036e5c2bbd56e3f4d9dda06ceb8e57e60b1b8670f8f01b2c37e6cfb0ce51001970a274722a3507fc4fd6a7ec243a06dcb4401e191d9ce7abf1f12
+  metadata.gz: '03463815dc69ad05dfb2e4b048201441e212a165947a546f4b8e1828b72f32cda5e1f16ab0d335fe9881bc949cfad7a5fa0eb6acf6ebc50a312cfa5d2080b17b'
+  data.tar.gz: 4bd655b11d659a008101bd28f113c65d8d03ea59ab7fe969c1c702e2dabacca9b52c20da33f4e2b4c3981f9b74af73cc87dbc11ae96fa269f2bcfd00fdc7f591

data/.gitignore

@@ -5,3 +5,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+tags

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i18n_flow (0.1.0)
+    i18n_flow (0.2.0)
       psych (>= 3.0)
 
 GEM

data/README.md

@@ -6,7 +6,7 @@ i18n_flow (beta)
 [![Build Status](https://travis-ci.org/creasty/i18n_flow.svg?branch=master)](https://travis-ci.org/creasty/i18n_flow)
 [![License](https://img.shields.io/github/license/creasty/i18n_flow.svg)](./LICENSE)
 
-**Manage translation status in YAML file.**  
+**Manage translation status in YAML file.**<br>
 With an official [tag](http://www.yaml.org/spec/1.2/spec.html#id2784064) feature, `i18n_flow` enables you to annotate status information directly in YAML file.
 
 ![](https://user-images.githubusercontent.com/1695538/36359417-6a976054-155e-11e8-914b-d6a10a8287fc.png)
@@ -23,6 +23,9 @@ Setup
 Add this line to your Gemfile:
 
 ```ruby
+gem 'i18n_flow'
+
+# To use the latest version:
 gem 'i18n_flow', github: 'creasty/i18n_flow'
 ```
 
@@ -61,6 +64,7 @@ Options:
 
 Commands:
     lint       Validate files
+    format     Format and correct errors
     search     Search contents and keys
     copy       Copy translations and mark as todo
     split      Split a file into proper-sized files

data/lib/i18n_flow/cli.rb

@@ -1,22 +1,24 @@
 require_relative 'util'
 
 class I18nFlow::CLI
-  require_relative 'cli/lint_command'
-  require_relative 'cli/split_command'
   require_relative 'cli/copy_command'
-  require_relative 'cli/search_command'
-  require_relative 'cli/version_command'
+  require_relative 'cli/format_command'
   require_relative 'cli/help_command'
+  require_relative 'cli/lint_command'
   require_relative 'cli/read_config_command'
+  require_relative 'cli/search_command'
+  require_relative 'cli/split_command'
+  require_relative 'cli/version_command'
 
   COMMANDS = {
+    'copy'        => CopyCommand,
+    'format'      => FormatCommand,
+    'help'        => HelpCommand,
     'lint'        => LintCommand,
+    'read_config' => ReadConfigCommand,
     'search'      => SearchCommand,
     'split'       => SplitCommand,
-    'copy'        => CopyCommand,
     'version'     => VersionCommand,
-    'help'        => HelpCommand,
-    'read_config' => ReadConfigCommand,
   }
 
   attr_reader :args

data/lib/i18n_flow/cli/copy_command.rb

@@ -2,6 +2,7 @@ require 'psych'
 require_relative 'command_base'
 require_relative '../util'
 require_relative '../parser'
+require_relative '../yaml_ast_proxy'
 
 class I18nFlow::CLI
   class CopyCommand < CommandBase
@@ -12,7 +13,7 @@ class I18nFlow::CLI
 
       parser.parse!
 
-      mark_as_todo(parser.root_proxy)
+      I18nFlow::YamlAstProxy.mark_as_todo(parser.root_proxy)
 
       if locale && first_key_node
         first_key_node.value = locale
@@ -35,11 +36,7 @@ class I18nFlow::CLI
 
     def first_key_node
       return @first_key_node if defined?(@first_key_node)
-      @first_key_node = parser.root_proxy
-        .send(:indexed_object)
-        .node
-        .tap { |n| break unless n.is_a?(Psych::Nodes::Mapping) }
-        &.tap { |n| break n.children.first }
+      @first_key_node = I18nFlow::YamlAstProxy.first_key_node_of(parser.root_proxy)
     end
 
   private
@@ -47,23 +44,5 @@ class I18nFlow::CLI
     def parser
       @parser ||= I18nFlow::Parser.new(File.read(src_file), file_path: src_file)
     end
-
-    def mark_as_todo(ast)
-      if ast.alias?
-        return
-      end
-      if ast.scalar?
-        ast.node.tag = '!todo'
-
-        # https://github.com/ruby/psych/blob/f30b65befa4f0a5a8548d482424a84a2383b0284/ext/psych/yaml/emitter.c#L1187
-        ast.node.plain = ast.node.quoted = false
-
-        return
-      end
-
-      ast.each do |k, v|
-        mark_as_todo(v)
-      end
-    end
   end
 end

data/lib/i18n_flow/cli/format_command.rb

@@ -0,0 +1,57 @@
+require_relative 'command_base'
+require_relative 'color'
+require_relative '../repository'
+require_relative '../formatter'
+require_relative '../corrector'
+
+class I18nFlow::CLI
+  class FormatCommand < CommandBase
+    include I18nFlow::CLI::Color
+
+    def invoke!
+      puts color('==> Correcting', :yellow)
+      repository.asts_by_scope.each do |scope, locale_trees|
+        locale_pairs.each do |(master, slave)|
+          master_tree = locale_trees[master]
+          slave_tree = locale_trees[slave]
+          next unless master_tree && slave_tree
+
+          puts slave_tree.file_path
+          correct(slave_tree, master_tree)
+        end
+      end
+
+      puts
+      puts color('==> Formatting', :yellow)
+      repository.asts_by_path.each do |path, tree|
+        puts path
+
+        format(tree)
+
+        output_path = I18nFlow.config.base_path.join(tree.file_path)
+        File.write(output_path, tree.to_yaml)
+      end
+    end
+
+  private
+
+    def locale_pairs
+      I18nFlow.config.locale_pairs
+    end
+
+    def repository
+      @repository ||= I18nFlow::Repository.new(
+        base_path:     I18nFlow.config.base_path,
+        glob_patterns: I18nFlow.config.glob_patterns,
+      )
+    end
+
+    def correct(slave_tree, master_tree)
+      I18nFlow::Corrector.new(slave_tree, master_tree).correct!
+    end
+
+    def format(tree)
+      I18nFlow::Formatter.new(tree).format!
+    end
+  end
+end

data/lib/i18n_flow/cli/help_command.rb

@@ -15,6 +15,7 @@ Options:
 
 Commands:
     lint       Validate files
+    format     Format and correct errors
     search     Search contents and keys
     copy       Copy translations and mark as todo
     split      Split a file into proper-sized files

data/lib/i18n_flow/cli/lint_command/ascii.erb

@@ -27,9 +27,15 @@
     <%- when I18nFlow::Validator::InvalidTodoError -%>
         Todo cannot be annotated on a mapping/sequence
     <%- when I18nFlow::Validator::TodoContentError -%>
+      <%- if err.inverse -%>
+        It has "!todo" but the content diverges from the foreign file
+        foreign: <%= err.expect %>
+        master:  <%= err.actual %>
+      <%- else -%>
         It has "!todo" but the content diverges from the master file
         master:  <%= err.expect %>
         foreign: <%= err.actual %>
+      <%- end -%>
     <%- when I18nFlow::Validator::InvalidLocaleError -%>
         It has "!only" but the locale is invalid
         valid: [<%= err.expect.join(', ') %>]

data/lib/i18n_flow/cli/lint_command/markdown.erb

@@ -32,9 +32,15 @@ An extra key found
     <%- when I18nFlow::Validator::InvalidTodoError -%>
 Todo cannot be annotated on a mapping/sequence
     <%- when I18nFlow::Validator::TodoContentError -%>
+      <%- if err.inverse -%>
+It has "!todo" but the content diverges from the foreign file
+foreign: <%= err.expect %>
+master:  <%= err.actual %>
+      <%- else -%>
 It has "!todo" but the content diverges from the master file
-master: `<%= err.expect %>`
-foreign: `<%= err.actual %>`
+master:  <%= err.expect %>
+foreign: <%= err.actual %>
+      <%- end -%>
     <%- when I18nFlow::Validator::InvalidLocaleError -%>
 It has "!only" but the locale is invalid
 valid: `[<%= err.expect.join(', ') %>]`

data/lib/i18n_flow/corrector.rb

@@ -0,0 +1,40 @@
+require_relative 'validator/symmetry'
+require_relative 'validator/errors'
+require_relative 'yaml_ast_proxy'
+
+class I18nFlow::Corrector
+  attr_reader :ast_1
+  attr_reader :ast_2
+
+  def initialize(ast_1, ast_2)
+    @ast_1 = ast_1
+    @ast_2 = ast_2
+  end
+
+  def correct!
+    n1, n2 = [ast_1, ast_2]
+      .map { |n| I18nFlow::YamlAstProxy.first_value_node_of(n) }
+      .map { |n| I18nFlow::YamlAstProxy.create(n) }
+
+    errors = I18nFlow::Validator::Symmetry.new(n2, n1)
+      .tap(&:validate!)
+      .errors
+
+    errors.each do |error|
+      case error
+      when I18nFlow::Validator::MissingKeyError
+        src_node = error.src_node.clone
+        I18nFlow::YamlAstProxy.mark_as_todo(src_node)
+        error.dest_node[error.dest_key] = src_node.node
+      when I18nFlow::Validator::ExtraKeyError
+        if error.dest_node.mapping?
+          error.dest_node.delete(error.dest_key)
+        elsif error.dest_node.sequence?
+          error.dest_node.delete_at(error.dest_key)
+        end
+      when I18nFlow::Validator::TodoContentError
+        error.dest_node.node.value = error.src_node.node.value
+      end
+    end
+  end
+end

data/lib/i18n_flow/formatter.rb

@@ -0,0 +1,20 @@
+class I18nFlow::Formatter
+  attr_reader :ast
+
+  def initialize(ast)
+    @ast = ast
+  end
+
+  def format!
+    sort_keys(ast)
+  end
+
+private
+
+  def sort_keys(node)
+    node.sort_keys! if node.mapping?
+    node.each do |_, val|
+      sort_keys(val) if val.mapping?
+    end
+  end
+end

data/lib/i18n_flow/validator/errors.rb

@@ -36,17 +36,34 @@ module I18nFlow::Validator
   end
 
   class MissingKeyError < Error
+    attr_reader :dest_node
+    attr_reader :dest_key
+    attr_reader :src_node
+
     def initialize(key, single: false)
       super(key)
       @single = single
     end
+
+    def set_correction_context(dest_node:, dest_key:, src_node:)
+      @dest_node, @dest_key, @src_node = dest_node, dest_key, src_node
+      self
+    end
   end
 
   class ExtraKeyError < Error
+    attr_reader :dest_node
+    attr_reader :dest_key
+
     def initialize(key, single: false)
       super(key)
       @single = single
     end
+
+    def set_correction_context(dest_node:, dest_key:)
+      @dest_node, @dest_key = dest_node, dest_key
+      self
+    end
   end
 
   class InvalidTodoError < Error
@@ -55,16 +72,25 @@ module I18nFlow::Validator
   class TodoContentError < Error
     attr_reader :expect
     attr_reader :actual
+    attr_reader :dest_node
+    attr_reader :src_node
+    attr_reader :inverse
 
-    def initialize(key, expect:, actual:)
+    def initialize(key, expect:, actual:, inverse:)
       super(key)
       @expect = expect
       @actual = actual
+      @inverse = inverse
     end
 
     def data
       super + [expect, actual]
     end
+
+    def set_correction_context(dest_node:, src_node:)
+      @dest_node, @src_node = dest_node, src_node
+      self
+    end
   end
 
   class InvalidLocaleError < Error

data/lib/i18n_flow/validator/symmetry.rb

@@ -39,7 +39,7 @@ module I18nFlow::Validator
         return
       end
 
-      check_asymmetric_key(n1, n2, t2)&.tap do |err|
+      check_asymmetric_key(n1, n2, t2, key)&.tap do |err|
         errors << err if err
         return
       end
@@ -112,28 +112,35 @@ module I18nFlow::Validator
       InvalidTypeError.new(n2.full_key).set_location(n2)
     end
 
-    def check_asymmetric_key(n1, n2, t2)
+    def check_asymmetric_key(n1, n2, t2, key)
       return false if n1&.ignored_violation == :key || n2&.ignored_violation == :key
       return if n1 && n2
 
       if n1
         full_key = [t2.locale, *n1.scopes.drop(1)].join('.')
-        MissingKeyError.new(full_key).set_location(t2)
+        MissingKeyError.new(full_key)
+          .set_location(t2)
+          .set_correction_context(dest_node: t2, dest_key: key, src_node: n1)
       else
-        ExtraKeyError.new(n2.full_key).set_location(n2)
+        ExtraKeyError.new(n2.full_key)
+          .set_location(n2)
+          .set_correction_context(dest_node: t2, dest_key: key)
       end
     end
 
     def check_todo_tag(n1, n2)
-      return unless n2.marked_as_todo?
-
-      if !n2.scalar?
-        InvalidTodoError.new(n2.full_key).set_location(n2)
-      elsif n2.value != n1.value
-        TodoContentError.new(n2.full_key,
-          expect: n1.value,
-          actual: n2.value,
-        ).set_location(n2)
+      if n1.scalar? && n1.marked_as_todo? && !n2.marked_as_todo? && n2.value != n1.value
+        TodoContentError.new(n1.full_key, expect: n2.value, actual: n1.value, inverse: true)
+          .set_location(n1)
+          .set_correction_context(dest_node: n1, src_node: n2)
+      elsif n2.marked_as_todo?
+        if !n2.scalar?
+          InvalidTodoError.new(n2.full_key).set_location(n2)
+        elsif n2.value != n1.value
+          TodoContentError.new(n2.full_key, expect: n1.value, actual: n2.value, inverse: false)
+            .set_location(n2)
+            .set_correction_context(dest_node: n2, src_node: n1)
+        end
       end
     end
 

data/lib/i18n_flow/version.rb

@@ -1,6 +1,6 @@
 module I18nFlow
   MAJOR    = 0
-  MINOR    = 1
+  MINOR    = 2
   REVISION = 0
 
   VERSION = [MAJOR, MINOR, REVISION].join('.')

data/lib/i18n_flow/yaml_ast_proxy.rb

@@ -54,4 +54,40 @@ module I18nFlow::YamlAstProxy
     stream.children << doc
     create(stream)
   end
+
+  def self.mark_as_todo(ast)
+    if ast.alias?
+      return
+    end
+    if ast.scalar?
+      ast.node.tag = '!todo'
+
+      # https://github.com/ruby/psych/blob/f30b65befa4f0a5a8548d482424a84a2383b0284/ext/psych/yaml/emitter.c#L1187
+      ast.node.plain = ast.node.quoted = false
+
+      return
+    end
+
+    ast.each do |k, v|
+      mark_as_todo(v)
+    end
+  end
+
+  def self.first_key_node_of(node)
+    first_node_of(node, 0)
+  end
+
+  def self.first_value_node_of(node)
+    first_node_of(node, 1)
+  end
+
+private
+
+  def self.first_node_of(node, layout_offset)
+    node
+      .send(:indexed_object)
+      .node
+      .tap { |n| break unless n.is_a?(Psych::Nodes::Mapping) }
+      &.tap { |n| break n.children[layout_offset] }
+  end
 end

data/lib/i18n_flow/yaml_ast_proxy/mapping.rb

@@ -25,6 +25,12 @@ module I18nFlow::YamlAstProxy
     end
     alias []= set
 
+    def delete(key)
+      indexed_object.delete(key)
+      cache.delete(key)
+      synchronize!
+    end
+
     def batch
       @locked = true
       yield
@@ -49,6 +55,14 @@ module I18nFlow::YamlAstProxy
       end
     end
 
+    def sort_keys!
+      @indexed_object = indexed_object
+        .sort_by { |k, v| [v.is_a?(Psych::Nodes::Mapping) ? 1 : 0, k] }
+        .to_h
+      @cache = nil
+      synchronize!
+    end
+
   private
 
     def cache

data/lib/i18n_flow/yaml_ast_proxy/node.rb

@@ -10,7 +10,8 @@ module I18nFlow::YamlAstProxy
     TAG_TODO   = /^!todo(?::([,a-zA-Z_-]+))?$/
     TAG_ONLY   = /^!only(?::([,a-zA-Z_-]+))?$/
 
-    attr_reader :node
+    attr_accessor :node
+    protected :node=
     attr_reader :parent
     attr_reader :scopes
     attr_reader :file_path
@@ -87,6 +88,12 @@ module I18nFlow::YamlAstProxy
       indexed_object.keys
     end
 
+    def clone
+      super.tap do |n|
+        n.node = node.clone
+      end
+    end
+
   private
 
     def identity_data

data/lib/i18n_flow/yaml_ast_proxy/sequence.rb

@@ -2,7 +2,7 @@ require_relative 'node'
 
 module I18nFlow::YamlAstProxy
   class Sequence < Node
-    def_delegators :indexed_object, :==, :<<, :size
+    def_delegators :indexed_object, :==, :<<, :size, :delete_at
 
     def each
       indexed_object.each.with_index do |o, i|

data/spec/lib/i18n_flow/corrector_spec.rb

@@ -0,0 +1,197 @@
+require 'i18n_flow/corrector'
+
+describe I18nFlow::Corrector do
+  def correct_ast(ast_1, ast_2 = nil)
+    I18nFlow::Corrector.new(ast_1, ast_2)
+      .tap(&:correct!)
+  end
+
+  describe '#correct!' do
+    it 'should complement missing keys and mark as !todo' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        alfa: 'a'
+        delta: 'd'
+        echo: 'e'
+        golf: 'g'
+        hotel: 'h'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        alfa: 'A'
+        bravo: 'B'
+        charlie: 'C'
+        delta: 'D'
+        echo: 'E'
+        foxtrot: !only 'F'
+        golf: 'G'
+        hotel: 'H'
+      YAML
+      result = parse_yaml(<<-YAML)
+      es:
+        alfa: 'a'
+        delta: 'd'
+        echo: 'e'
+        golf: 'g'
+        hotel: 'h'
+        bravo: !todo 'B'
+        charlie: !todo 'C'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should complement missing elements in a sequence' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        foo:
+          - 'one'
+          - 'two'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        foo:
+          - 'ONE'
+          - 'TWO'
+          - 'THREE'
+          - !only 'FOUR'
+      YAML
+      result = parse_yaml(<<-YAML)
+      es:
+        foo:
+          - 'one'
+          - 'two'
+          - !todo 'THREE'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should delete extra keys which are not marked as !only' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        alfa: 'a'
+        bravo: 'b'
+        charlie: 'c'
+        delta: 'd'
+        echo: 'e'
+        foxtrot: !only 'f'
+        golf: 'g'
+        hotel: 'h'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        alfa: 'A'
+        bravo: 'B'
+        charlie: 'C'
+        golf: 'G'
+        hotel: 'H'
+      YAML
+      result = parse_yaml(<<-YAML)
+      es:
+        alfa: 'a'
+        bravo: 'b'
+        charlie: 'c'
+        foxtrot: !only 'f'
+        golf: 'g'
+        hotel: 'h'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should delete extra elements in a sequence' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        foo:
+          - 'one'
+          - 'two'
+          - 'three'
+          - !only 'four'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        foo:
+          - 'ONE'
+          - 'TWO'
+      YAML
+      result = parse_yaml(<<-YAML)
+      es:
+        foo:
+          - 'one'
+          - 'two'
+          - !only 'four'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should update translations with !todo according to the source' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        foo: !todo 'outdated'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        foo: 'latest'
+      YAML
+      result = parse_yaml(<<-YAML)
+      es:
+        foo: !todo 'latest'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result.to_yaml)
+    end
+
+    it 'should update translations with !todo (works bidirectionally)' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        foo: 'latest'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        foo: !todo 'outdated'
+      YAML
+      result_1 = parse_yaml(<<-YAML)
+      es:
+        foo: 'latest'
+      YAML
+      result_2 = parse_yaml(<<-YAML)
+      en:
+        foo: !todo 'latest'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result_1.to_yaml)
+      expect(corrected.ast_2.to_yaml).to eq(result_2.to_yaml)
+    end
+
+    it 'should update translations with !todo (synchronize)' do
+      ast_1 = parse_yaml(<<-YAML)
+      es:
+        foo: !todo 'outdated'
+      YAML
+      ast_2 = parse_yaml(<<-YAML)
+      en:
+        foo: !todo 'latest'
+      YAML
+      result_1 = parse_yaml(<<-YAML)
+      es:
+        foo: !todo 'latest'
+      YAML
+      result_2 = parse_yaml(<<-YAML)
+      en:
+        foo: !todo 'latest'
+      YAML
+
+      corrected = correct_ast(ast_1, ast_2)
+      expect(corrected.ast_1.to_yaml).to eq(result_1.to_yaml)
+      expect(corrected.ast_2.to_yaml).to eq(result_2.to_yaml)
+    end
+  end
+end

data/spec/lib/i18n_flow/formatter_spec.rb

@@ -0,0 +1,137 @@
+require 'i18n_flow/formatter'
+
+describe I18nFlow::Formatter do
+  def format_ast(ast)
+    I18nFlow::Formatter.new(ast)
+      .tap(&:format!)
+      .ast
+  end
+
+  describe '#format!' do
+    it 'should remove extra whitespaces' do
+      ast = parse_yaml(<<-YAML)
+      en:
+        alfa: 'A'
+
+        bravo:   'B'
+        charlie: 'C'
+        delta:   'D'
+        echo:    'E'
+        foxtrot: 'F'
+
+        golf: 'G'
+        hotel: 'H'
+      YAML
+      result = parse_yaml(<<-YAML)
+      en:
+        alfa: 'A'
+        bravo: 'B'
+        charlie: 'C'
+        delta: 'D'
+        echo: 'E'
+        foxtrot: 'F'
+        golf: 'G'
+        hotel: 'H'
+      YAML
+
+      formatted = format_ast(ast)
+      expect(formatted.to_yaml).to eq(result.to_yaml)
+    end
+
+    context 'sort keys' do
+      it 'should sort keys' do
+        ast = parse_yaml(<<-YAML)
+        en:
+          echo: 'E'
+          delta: 'D'
+          foxtrot: 'F'
+          alfa: 'A'
+          hotel: 'H'
+          bravo: 'B'
+          charlie: 'C'
+          golf: 'G'
+        YAML
+        result = parse_yaml(<<-YAML)
+        en:
+          alfa: 'A'
+          bravo: 'B'
+          charlie: 'C'
+          delta: 'D'
+          echo: 'E'
+          foxtrot: 'F'
+          golf: 'G'
+          hotel: 'H'
+        YAML
+
+        formatted = format_ast(ast)
+        expect(formatted.to_yaml).to eq(result.to_yaml)
+      end
+
+      it 'should sort keys recursively' do
+        ast = parse_yaml(<<-YAML)
+        en:
+          alfa: 'A'
+          bravo:
+            delta: 'D'
+            charlie: 'C'
+            echo:
+              foxtrot: 'F'
+              hotel: 'H'
+              golf: 'G'
+        YAML
+        result = parse_yaml(<<-YAML)
+        en:
+          alfa: 'A'
+          bravo:
+            charlie: 'C'
+            delta: 'D'
+            echo:
+              foxtrot: 'F'
+              golf: 'G'
+              hotel: 'H'
+        YAML
+
+        formatted = format_ast(ast)
+        expect(formatted.to_yaml).to eq(result.to_yaml)
+      end
+
+      it 'should move mappings at the bottom' do
+        ast = parse_yaml(<<-YAML)
+        en:
+          alfa: 'A'
+          bravo: 'B'
+          charlie:
+            - 'one'
+            - 'two'
+          delta: 'D'
+          echo: 'E'
+          foxtrot:
+            bar: 'bar'
+            foo: 'foo'
+          golf: 'G'
+          hotel:
+            baz: 'baz'
+        YAML
+        result = parse_yaml(<<-YAML)
+        en:
+          alfa: 'A'
+          bravo: 'B'
+          charlie:
+            - 'one'
+            - 'two'
+          delta: 'D'
+          echo: 'E'
+          golf: 'G'
+          foxtrot:
+            bar: 'bar'
+            foo: 'foo'
+          hotel:
+            baz: 'baz'
+        YAML
+
+        formatted = format_ast(ast)
+        expect(formatted.to_yaml).to eq(result.to_yaml)
+      end
+    end
+  end
+end

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

@@ -377,7 +377,7 @@ describe I18nFlow::Validator::Symmetry do
         ])
       end
 
-      it 'should fail if texts are different' do
+      it 'should fail if texts are different from the master' do
         ast_1 = parse_yaml(<<-YAML)['en']
         en:
           key_1: text_1
@@ -394,7 +394,28 @@ describe I18nFlow::Validator::Symmetry do
         validator.validate!
 
         expect(validator.errors).to eq([
-          I18nFlow::Validator::TodoContentError.new('ja.key_2', expect: 'text_2', actual: 'text_9'),
+          I18nFlow::Validator::TodoContentError.new('ja.key_2', expect: 'text_2', actual: 'text_9', inverse: false),
+        ])
+      end
+
+      it 'should fail if texts are different from the foreign' do
+        ast_1 = parse_yaml(<<-YAML)['en']
+        en:
+          key_1: text_1
+          key_2: !todo text_9
+        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::TodoContentError.new('en.key_2', expect: 'text_2', actual: 'text_9', inverse: true),
         ])
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n_flow
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuki Iwanaga
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: psych
@@ -125,6 +125,7 @@ files:
 - lib/i18n_flow/cli/color.rb
 - lib/i18n_flow/cli/command_base.rb
 - lib/i18n_flow/cli/copy_command.rb
+- lib/i18n_flow/cli/format_command.rb
 - lib/i18n_flow/cli/help_command.rb
 - lib/i18n_flow/cli/lint_command.rb
 - lib/i18n_flow/cli/lint_command/ascii.erb
@@ -140,6 +141,8 @@ files:
 - lib/i18n_flow/cli/split_command.rb
 - lib/i18n_flow/cli/version_command.rb
 - lib/i18n_flow/configuration.rb
+- lib/i18n_flow/corrector.rb
+- lib/i18n_flow/formatter.rb
 - lib/i18n_flow/parser.rb
 - lib/i18n_flow/repository.rb
 - lib/i18n_flow/search.rb
@@ -162,6 +165,8 @@ files:
 - spec/lib/i18n_flow/cli/help_command_spec.rb
 - spec/lib/i18n_flow/cli/version_command_spec.rb
 - spec/lib/i18n_flow/configuration_spec.rb
+- spec/lib/i18n_flow/corrector_spec.rb
+- spec/lib/i18n_flow/formatter_spec.rb
 - spec/lib/i18n_flow/repository_spec.rb
 - spec/lib/i18n_flow/splitter/merger_spec.rb
 - spec/lib/i18n_flow/util_spec.rb
@@ -201,6 +206,8 @@ test_files:
 - spec/lib/i18n_flow/cli/help_command_spec.rb
 - spec/lib/i18n_flow/cli/version_command_spec.rb
 - spec/lib/i18n_flow/configuration_spec.rb
+- spec/lib/i18n_flow/corrector_spec.rb
+- spec/lib/i18n_flow/formatter_spec.rb
 - spec/lib/i18n_flow/repository_spec.rb
 - spec/lib/i18n_flow/splitter/merger_spec.rb
 - spec/lib/i18n_flow/util_spec.rb