i18n_yaml_editor 2.0.0

data/lib/i18n_yaml_editor/translation.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module I18nYamlEditor
+  # A Translation holds information about its name, file and text
+  class Translation
+    attr_accessor :name, :file, :text
+
+    def initialize(attributes = {})
+      @name, @file, @text = attributes.values_at(:name, :file, :text)
+    end
+
+    # This translation's key
+    def key
+      @key ||= name.split('.')[1..-1].join('.')
+    end
+
+    # This translation's locale
+    def locale
+      @locale ||= name.split('.').first
+    end
+  end
+end

data/lib/i18n_yaml_editor/update.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'i18n_yaml_editor/cast'
+
+module I18nYamlEditor
+  # Provides update functionality for Store
+  module Update
+    include Cast
+
+    # Update translations in store
+    def update(new_translations)
+      translations_in_store = translations.values.group_by(&:key)
+
+      new_translations.each do |name, text|
+        if translations[name]
+          update_translation(name, text, translations_in_store)
+        else
+          # rubocop:disable Style/StderrPuts
+          $stderr.puts 'Translation not found'
+          # rubocop:enable Style/StderrPuts
+          next
+        end
+      end
+    end
+
+    private
+
+    def update_array(obj, name, text)
+      klasses = obj.map(&:class).uniq!
+      return unless klasses.length < 2
+      translations[name].text = []
+      cast(Array, text).each do |item|
+        translations[name].text << cast(klasses[0], item)
+      end
+    end
+
+    def update_with_type(obj, name, text)
+      data_type = obj.class
+      data_type = String if data_type == NilClass
+      if data_type == Array
+        update_array(obj, name, text)
+      else
+        translations[name].text = cast(data_type, text)
+      end
+    end
+
+    def update_translation(name, text, translations_in_store)
+      objs = translations_in_store[translations[name].key].map(&:text)
+      obj = objs.find { |t| t.present? || t == false }
+      update_with_type(obj, name, text)
+    end
+  end
+end

data/lib/i18n_yaml_editor/web.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'cuba'
+require 'cuba/render'
+require 'bigdecimal'
+
+module I18nYamlEditor
+  # The frontend rendering engine
+  class Web < Cuba
+    plugin Cuba::Render
+
+    settings[:render][:template_engine] = 'erb'
+    settings[:render][:views] = File.expand_path(
+      File.join(File.dirname(__FILE__), '..', '..', 'views')
+    )
+
+    use Rack::ShowExceptions
+
+    # Reads global App instance
+    def app
+      I18nYamlEditor.app
+    end
+
+    define do
+      on get, root do
+        on param('filters') do |filters|
+          opts = {}
+          opts[:key] = /#{filters["key"]}/ unless filters['key'].to_s.empty?
+          opts[:text] = /#{filters["text"]}/i unless filters['text'].to_s.empty?
+          opts[:complete] = false if filters['incomplete'] == 'on'
+          opts[:empty] = true if filters['empty'] == 'on'
+
+          keys = app.store.filter_keys(opts)
+
+          res.write view('translations.html', keys: keys, filters: filters)
+        end
+
+        on default do
+          categories = app.store.categories.sort
+          res.write view('categories.html', categories: categories, filters: {})
+        end
+      end
+
+      on post, 'update' do
+        translations = req['translations']
+        app.save_translations(translations) if translations
+
+        url = Rack::Utils.build_nested_query(filters: req['filters'])
+        res.redirect "/?#{url}"
+      end
+
+      on get, 'debug' do
+        res.write partial('debug.html',
+                          translations: app.store.translations.values)
+      end
+    end
+  end
+end

data/lib/i18n_yaml_editor.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# I18n Yaml Editor
+module I18nYamlEditor
+  class << self
+    attr_accessor :app
+  end
+end
+
+require 'i18n_yaml_editor/app'
+require 'i18n_yaml_editor/category'
+require 'i18n_yaml_editor/key'
+require 'i18n_yaml_editor/store'
+require 'i18n_yaml_editor/transformation'
+require 'i18n_yaml_editor/translation'
+require 'i18n_yaml_editor/web'

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$VERBOSE = nil
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter '/test'
+end
+
+require 'minitest/autorun'
+require 'minitest/hell'
+require 'minitest/reporters'
+require 'rack/test'
+require 'i18n_yaml_editor'
+
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(color: true)]
+
+module Minitest
+  class Test
+    include I18nYamlEditor
+    parallelize_me!
+  end
+end

data/test/unit/test_app.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'i18n_yaml_editor/app'
+
+class TestApp < Minitest::Test
+  def test_save_translations
+    Dir.mktmpdir do |dir|
+      FileUtils.copy './example/session.en.yml', dir
+      @app = App.new(dir)
+      @app.load_translations
+      @app.save_translations('en.session.create.logged_in' => 'Test123')
+      assert_match(/logged_in: Test123\n/, File.read(dir + '/session.en.yml'))
+    end
+  end
+
+  def test_save_translations_empty
+    Dir.mktmpdir do |dir|
+      FileUtils.copy './example/session.en.yml', dir
+      @app = App.new(dir)
+      @app.load_translations
+      assert_output('', "Translation not found\n") do
+        @app.save_translations('does.not.exist' => 'foo')
+      end
+    end
+  end
+
+  def test_save_translations_array
+    Dir.mktmpdir do |dir|
+      FileUtils.copy './example/da.yml', dir
+      @app = App.new(dir)
+      @app.load_translations
+      @app.save_translations('da.day_names' => "Test1\r\nTest2")
+      assert_match(/- Test2\n/, File.read(dir + '/da.yml'))
+    end
+  end
+
+  def test_save_translations_boolean
+    Dir.mktmpdir do |dir|
+      FileUtils.copy './example/session.en.yml', dir
+      @app = App.new(dir)
+      @app.load_translations
+      @app.save_translations('en.numbers.use_local_format' => 'false')
+      assert_match(/use_local_format: false\n/,
+                   File.read(dir + '/session.en.yml'))
+    end
+  end
+
+  def test_save_translations_number
+    Dir.mktmpdir do |dir|
+      FileUtils.copy './example/session.en.yml', dir
+      @app = App.new(dir)
+      @app.load_translations
+      @app.save_translations('en.numbers.precision' => '10')
+      assert_match(/precision: 10\n/, File.read(dir + '/session.en.yml'))
+    end
+  end
+end

data/test/unit/test_category.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'i18n_yaml_editor/category'
+
+class TestCategory < Minitest::Test
+  def setup
+    @category = Category.new(name: 'test')
+    @key = Minitest::Mock.new([0])
+  end
+
+  def test_init_name
+    assert_equal('test', @category.name)
+  end
+
+  def test_init_keys
+    assert_empty(@category.keys)
+  end
+
+  def test_add_key
+    @category.add_key(@key)
+    assert_includes(@category.keys, @key)
+  end
+
+  def test_is_complete
+    @category.add_key(@key)
+    @key.expect :complete?, true
+    assert @category.complete?
+  end
+
+  def test_is_not_complete
+    @key.expect :complete?, true
+    @category.add_key(@key)
+
+    @key2 = Minitest::Mock.new([1])
+    @key2.expect :complete?, false
+    @category.add_key(@key2)
+
+    assert !@category.complete?
+  end
+end

data/test/unit/test_key.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'i18n_yaml_editor/key'
+
+class TestKey < Minitest::Test
+  def test_category
+    key = Key.new(name: 'session.login')
+    assert_equal 'session', key.category
+  end
+
+  def test_complete_with_text_for_all_translations
+    key = Key.new(name: 'session.login')
+    key.add_translation Translation.new(name: 'da.session.login',
+                                        text: 'Log ind')
+    key.add_translation Translation.new(name: 'en.session.login',
+                                        text: 'Sign in')
+
+    assert key.complete?
+  end
+
+  def test_complete_with_no_texts
+    key = Key.new(name: 'session.login')
+    key.add_translation Translation.new(name: 'da.session.login')
+    key.add_translation Translation.new(name: 'en.session.login')
+
+    assert key.complete?
+  end
+
+  def test_not_complete_without_text_for_some_translations
+    key = Key.new(name: 'session.login')
+    key.add_translation Translation.new(name: 'da.session.login',
+                                        text: 'Log ind')
+    key.add_translation Translation.new(name: 'en.session.login')
+
+    assert_equal false, key.complete?
+  end
+
+  def test_emptycomplete_with_no_texts
+    key = Key.new(name: 'session.login')
+    key.add_translation Translation.new(name: 'da.session.login')
+    key.add_translation Translation.new(name: 'en.session.login')
+
+    assert key.empty?
+  end
+end

data/test/unit/test_store.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'unit/test_store_data'
+require 'i18n_yaml_editor/store'
+
+class TestStore < Minitest::Test
+  include TestStoreData
+
+  attr_accessor :input, :expected_yaml
+
+  TEST_DATA = {
+    '/tmp/session.da.yml' => {
+      da: { session: { login: 'Log ind', logout: 'Log ud' } }
+    },
+    '/tmp/session.en.yml' => {
+      en: { session: { login: 'Sign in' } }
+    },
+    '/tmp/da.yml' => {
+      da: { app_name: 'Oversætter' }
+    }
+  }.freeze
+
+  def initialize(*)
+    self.input = {
+      da: { session: { login: 'Log ind' } }
+    }
+
+    self.expected_yaml = TEST_DATA.with_indifferent_access
+    super
+  end
+
+  def test_add_translations_store_translations
+    store = Store.new
+    translation = Translation.new(name: 'da.session.login')
+
+    store.add_translation(translation)
+
+    assert_equal 1, store.translations.size
+    assert_equal translation, store.translations[translation.name]
+  end
+
+  def test_add_translations_store_keys
+    store = Store.new
+    translation = Translation.new(name: 'da.session.login')
+
+    store.add_translation(translation)
+
+    assert_equal 1, store.keys.size
+    assert_equal [translation].to_set, store.keys['session.login'].translations
+  end
+
+  def test_add_translations_store_categories
+    store = Store.new
+    translation = Translation.new(name: 'da.session.login')
+
+    store.add_translation(translation)
+
+    assert_equal 1, store.categories.size
+    assert_equal %w[session.login], store.categories['session'].keys.map(&:name)
+  end
+
+  def test_add_translations_store_locales
+    store = Store.new
+    translation = Translation.new(name: 'da.session.login')
+
+    store.add_translation(translation)
+
+    assert_equal 1, store.locales.size
+    assert_equal %w[da], store.locales.to_a
+  end
+
+  def test_add_duplicate_translation
+    store = Store.new
+    t1 = Translation.new(name: 'da.session.login')
+    t2 = Translation.new(name: 'da.session.login')
+    store.add_translation(t1)
+
+    assert_raises(DuplicateTranslationError) do
+      store.add_translation(t2)
+    end
+  end
+
+  def test_create_missing_translations
+    store = init_test_store_0
+
+    store.create_missing_keys
+
+    assert(translation = store.translations['en.session.login'])
+    assert_equal 'en.session.login', translation.name
+    assert_equal '/tmp/session.en.yml', translation.file
+    assert_nil translation.text
+  end
+
+  def test_create_missing_translations_in_top_level_file
+    store = init_test_store_1
+
+    store.create_missing_keys
+
+    assert(translation = store.translations['en.app_name'])
+    assert_equal 'en.app_name', translation.name
+    assert_equal '/tmp/en.yml', translation.file
+    assert_nil translation.text
+  end
+
+  def test_from_yaml
+    store = Store.new
+
+    store.from_yaml(input)
+
+    assert_equal 1, store.translations.size
+    translation = store.translations['da.session.login']
+    assert_equal 'da.session.login', translation.name
+    assert_equal 'Log ind', translation.text
+  end
+
+  def test_to_yaml
+    store = Store.new
+    [{ name: 'da.session.login', text: 'Log ind', file: '/tmp/session.da.yml' },
+     { name: 'en.session.login', text: 'Sign in', file: '/tmp/session.en.yml' },
+     { name: 'da.session.logout', text: 'Log ud', file: '/tmp/session.da.yml' },
+     { name: 'da.app_name', text: 'Oversætter',
+       file: '/tmp/da.yml' }].each do |translation|
+      store.add_translation Translation.new(translation)
+    end
+
+    assert_equal @expected_yaml, store.to_yaml
+  end
+end

data/test/unit/test_transformation.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'i18n_yaml_editor/transformation'
+
+class TestTransformation < Minitest::Test
+  I18N_HASH = {
+    'da.session.login' => 'Log ind',
+    'da.session.logout' => 'Log ud',
+    'en.session.login' => 'Log in',
+    'en.session.logout' => 'Log out'
+  }.freeze
+
+  def test_flatten_hash
+    input = {
+      da: {
+        session: { login: 'Log ind', logout: 'Log ud' }
+      },
+      en: {
+        session: { login: 'Log in', logout: 'Log out' }
+      }
+    }
+
+    assert_equal I18N_HASH, Transformation.flatten_hash(input)
+  end
+
+  def test_nest_hash
+    expected = {
+      da: {
+        session: { login: 'Log ind', logout: 'Log ud' }
+      },
+      en: {
+        session: { login: 'Log in', logout: 'Log out' }
+      }
+    }.with_indifferent_access
+
+    assert_equal expected, Transformation.nest_hash(I18N_HASH)
+  end
+
+  def test_nest_hash_transformation_error
+    assert_raises(TransformationError) do
+      Transformation.nest_hash(error: 'value')
+    end
+  end
+end

data/test/unit/test_translation.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'i18n_yaml_editor/translation'
+
+class TestTranslation < Minitest::Test
+  def test_key
+    translation = Translation.new(name: 'da.session.login')
+    assert_equal 'session.login', translation.key
+  end
+
+  def test_locale
+    translation = Translation.new(name: 'da.session.login')
+    assert_equal 'da', translation.locale
+  end
+end

data/views/categories.html.erb

@@ -0,0 +1,9 @@
+<table class="categories" cellspacing="0">
+  <% categories.each do |name, category| %>
+    <tr class="category <%= "incomplete" unless category.complete? %>">
+      <td class="key">
+        <a class="text" href="/?filters[key]=<%= Rack::Utils.escape("^#{category.name}") %>"><%= category.name %></a>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/views/debug.html.erb

@@ -0,0 +1,9 @@
+<html>
+  <body>
+    <pre>
+<% translations.each do |translation| %>
+ <%= Rack::Utils.escape_html(translation.inspect) %>
+<% end %>
+    </pre>
+  </body>
+</html>