i18n_yaml_editor 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59360f083d7e5071393e6605905f034df8340f64
+  data.tar.gz: 422e871b2b24a8061dc75f12721478e6c3e9c4a7
+SHA512:
+  metadata.gz: 469c35174ee3ad8f52526830da4ed069fbdb5e4ad37de79dc770d0a5daaf58efc351c98b4e1622f85e24f64a283af1b49f1b49a4d87aa82c49e71e96ef15a436
+  data.tar.gz: e50602ce147daf56bb1837c13678670e86dc46e5848b2cc6824293bb267e4d5ac4b8036579f3c6204836c174aa8dd2e9fc75c798ce1a8ac10841b5cb75067cec

data/README.md

@@ -0,0 +1,60 @@
+# I18n Yaml Editor
+
+[![Build Status](https://travis-ci.org/Sage/i18n_yaml_editor.svg?branch=master)](https://travis-ci.org/Sage/i18n_yaml_editor) [![Maintainability](https://api.codeclimate.com/v1/badges/f71fb2039dd7d50eb90d/maintainability)](https://codeclimate.com/github/Sage/i18n_yaml_editor/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/f71fb2039dd7d50eb90d/test_coverage)](https://codeclimate.com/github/Sage/i18n_yaml_editor/test_coverage) [![Documentation Status](http://inch-ci.org/github/Sage/i18n_yaml_editor.svg?branch=master)](http://inch-ci.org/github/Sage/i18n_yaml_editor) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Sage/i18n_yaml_editor/blob/master/LICENSE) [![Dependency Status](https://gemnasium.com/badges/github.com/Sage/i18n_yaml_editor.svg)](https://gemnasium.com/github.com/Sage/i18n_yaml_editor)
+
+I18n Yaml Editor is based on [IYE](https://github.com/firmafon/iye).
+I18n Yaml Editor makes it easy to translate your Rails I18N files and keep them up to date.
+It uses YAML files directly, so you don't need to keep a separate database in sync.
+This has several benefits:
+
+* Branching and diffing is trivial
+* It does not alter the workflow for developers etc., whom can continue editing the
+  YAML files directly
+* If your YAML files are organized in subfolders, this structure is kept intact
+
+![I18n Yaml Editor](https://cloud.githubusercontent.com/assets/1446195/10295880/1f829dd6-6bc4-11e5-9a08-bb79d9864bdb.png)
+
+## Prerequisites
+
+You need to understand a few things about I18n Yaml Editor for it to make sense, mainly:
+
+* I18n Yaml Editor does not create new keys - keys must exist for at least one locale in the YAML files
+* I18n Yaml Editor does not create new locales - at least one key must exist for each locale in the YAML files
+
+## Workflow
+
+1. Install I18n Yaml Editor:
+
+        $ git clone git@github.com:Sage/i18n_yaml_editor.git
+        $ cd i18n_yaml_editor
+        $ gem build i18n_yaml_editor.gemspec
+        $ gem install i18n_yaml_editor-1.3.1.gem
+
+2. The `i18n_yaml_editor` executable is now available, use it wherever you want.
+
+        $ i18n_yaml_editor path/to/i18n/locales [port]
+
+    At this point I18n Yaml Editor loads all translation keys for all locales, and creates any
+    keys that might be missing for existing locales, the default port is 5050
+
+3. Point browser at [http://localhost:5050](http://localhost:5050)
+4. Make changes and press 'Save' - each time you do this, all the keys will be
+   written to their original YAML files.
+5. Review your changes before committing files, e.g. by using `git diff`.
+
+## Development
+
+### Getting started
+        $ git clone git@github.com:Sage/i18n_yaml_editor.git
+        $ cd i18n_yaml_editor
+        $ gem install bundler
+        $ bundle install
+        $ SIMPLE_COV=true bundle exec guard
+
+
+## License
+
+This gem is available as open source under the terms of the
+[MIT licence](LICENSE).
+
+Copyright (c) 2018 Sage Group Plc. All rights reserved.

data/Rakefile

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'capture_io/capture_io'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.pattern = 'test/**/test_*.rb'
+end
+
+# Mixin
+module RuboCop
+  # Mixin
+  class RakeTask
+    private
+
+    def run_cli(verbose, options)
+      require 'rubocop'
+
+      cli = CLI.new
+      puts "\033[1;33m# Running RuboCop...\033[0m" if verbose
+      result = cli.run(options)
+      failed = result.nonzero? && fail_on_error
+      abort("\033[0;31mRuboCop failed!\033[0m\n") if failed
+      puts "\033[0;32mRuboCop passed\033[0m\n\n\n"
+    end
+  end
+end
+
+desc 'Run RuboCop'
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Generate documentation in doc/ and check documentation coverage'
+task :yardoc do
+  require 'yard'
+  puts "\n\033[1;33m# Running Yardoc...\033[0m"
+  yard = `yard stats --list-undoc --compact`
+  if yard =~ /Undocumented Objects/
+    puts yard
+    puts "\033[0;31mYardoc failed - documentation coverage < 100%\033[0m\n"
+    exit 1
+  else
+    puts yard.each_line.to_a[0..-2]
+    puts "\033[0;32mYardoc passed - 100.00% documented\033[0m\n\n\n"
+  end
+end
+
+task :coverage do
+  puts "\033[1;33m# Running Minitest...\033[0m"
+  out, = capture_io do
+    puts `bundle exec rake test`
+  end
+  puts out
+  err = /\d+ tests, \d+ assertions, (\d+) failures, (\d+) errors, \d+ skips/
+  unless out.scan(err).flatten.map(&:to_i).reduce(&:+).zero?
+    puts "\n\033[0;31mMinitest failed\033[0m\n"
+    exit 1
+  end
+
+  if out.lines.last =~ /LOC \(100\.0%\) covered/ ||
+     out.lines[-2] =~ /Coverage is at 100\.0%/
+    puts "\033[0;32mMinitest passed - 100.00% covered\033[0m\n\n"
+  else
+    puts "\n\033[0;31mMinitest failed - Code coverage < 100%\033[0m\n"
+    exit 1
+  end
+end
+
+task default: %i[coverage yardoc rubocop] do
+  puts "\033[0;32mYAY! - I18n Yaml Editor test suite passed\033[0m\n\n"
+end

data/bin/i18n_yaml_editor

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'i18n_yaml_editor'
+
+i18n_yaml_editor = I18nYamlEditor::App.new(*ARGV)
+i18n_yaml_editor.start

data/i18n_yaml_editor.gemspec

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |s|
+  s.name     = 'i18n_yaml_editor'
+  s.version  = '2.0.0'
+  s.date     = '2015-10-07'
+  s.summary  = 'I18n Yaml Editor'
+  s.email    = 'wolfgang.teuber@sage.com'
+  s.homepage = 'http://github.com/Sage/i18n_yaml_editor'
+  s.description = 'I18n Yaml Editor'
+  s.authors = ['Harry Vangberg', 'Wolfgang Teuber']
+  s.executables << 'i18n_yaml_editor'
+  s.files = [
+    'README.md',
+    'Rakefile',
+    'i18n_yaml_editor.gemspec',
+    'bin/i18n_yaml_editor',
+    'lib/i18n_yaml_editor.rb',
+    'lib/i18n_yaml_editor/app.rb',
+    'lib/i18n_yaml_editor/category.rb',
+    'lib/i18n_yaml_editor/core_ext.rb',
+    'lib/i18n_yaml_editor/key.rb',
+    'lib/i18n_yaml_editor/store.rb',
+    'lib/i18n_yaml_editor/filter.rb',
+    'lib/i18n_yaml_editor/update.rb',
+    'lib/i18n_yaml_editor/cast.rb',
+    'lib/i18n_yaml_editor/transformation.rb',
+    'lib/i18n_yaml_editor/translation.rb',
+    'lib/i18n_yaml_editor/web.rb',
+    'views/categories.html.erb',
+    'views/debug.html.erb',
+    'views/layout.erb',
+    'views/translations.html.erb'
+  ]
+  s.test_files = [
+    'test/test_helper.rb',
+    'test/unit/test_app.rb',
+    'test/unit/test_category.rb',
+    'test/unit/test_key.rb',
+    'test/unit/test_store.rb',
+    'test/unit/test_transformation.rb',
+    'test/unit/test_translation.rb'
+  ]
+  s.add_dependency 'activesupport', '>= 4.0.2'
+  s.add_dependency 'cuba', '>= 3'
+  s.add_dependency 'psych', '>= 1.3.4'
+  s.add_dependency 'tilt', '>= 1.3'
+
+  s.add_development_dependency 'awesome_print'
+  s.add_development_dependency 'cane'
+  s.add_development_dependency 'flay'
+  s.add_development_dependency 'flog'
+  s.add_development_dependency 'github-markup'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency 'guard-rubocop'
+  s.add_development_dependency 'inch'
+  s.add_development_dependency 'minitest-line'
+  s.add_development_dependency 'minitest-reporters'
+  s.add_development_dependency 'pry-byebug'
+  s.add_development_dependency 'pry-doc'
+  s.add_development_dependency 'rack-test'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'redcarpet'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'yard'
+end
+# rubocop:enable Metrics/BlockLength

data/lib/i18n_yaml_editor/app.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'psych'
+require 'yaml'
+require 'active_support/all'
+
+require 'i18n_yaml_editor/web'
+require 'i18n_yaml_editor/store'
+require 'i18n_yaml_editor/core_ext'
+
+module I18nYamlEditor
+  # App provides I18n Yaml Editor's top-level functionality:
+  #   * Starting I18n Yaml Editor
+  #   * Loading Translation files
+  #   * Saving Translation files
+  class App
+    attr_accessor :store
+
+    def initialize(path, port = 5050)
+      @path = File.expand_path(path)
+      @port = port || 5050
+      @store = Store.new
+      I18nYamlEditor.app = self
+    end
+
+    # Starts I18n Yaml Editor server
+    def start
+      raise "File #{@path} not found." unless File.exist?(@path)
+      $stdout.puts " * Loading translations from #{@path}"
+      load_translations
+
+      $stdout.puts ' * Creating missing translations'
+      store.create_missing_keys
+
+      $stdout.puts " * Starting I18n Yaml Editor at port #{@port}"
+      Rack::Server.start app: Web, Port: @port
+    end
+
+    # Loads translations from a given path
+    def load_translations
+      files = if File.directory?(@path)
+                Dir[@path + '/**/*.yml']
+              elsif File.file?(@path)
+                detect_list_or_file @path
+              else
+                # rubocop:disable Style/StderrPuts
+                $stderr.puts 'No valid translation file given'
+                # rubocop:enable Style/StderrPuts
+                []
+              end
+      update_store files
+    end
+
+    # Write the given translations to the appropriate YAML file
+    # example translations:
+    # {"en.day_names"=>"Mon\r\nTue", "en.session.new.password"=>"Password"}
+    def save_translations(translations)
+      store.update(translations)
+      changes = files(translations: translations)
+      changes.each do |file, yaml|
+        File.open(file, 'w', encoding: 'utf-8') do |f|
+          f.puts normalize(yaml)
+        end
+      end
+    end
+
+    private
+
+    # Enables I18n Yaml Editor to deal with inputs that reference a file list or
+    # a single translation file
+    def detect_list_or_file(path)
+      file = YAML.load_file(path)
+      file.is_a?(Hash) ? [path] : File.read(path).split
+    end
+
+    def update_store(files)
+      files.each do |file|
+        if File.exist?(file)
+          yaml = YAML.load_file(file)
+          store.from_yaml(yaml, file)
+        end
+      end
+    end
+
+    def files(translations: {})
+      store.to_yaml.select do |_, i18n_hash|
+        translations.keys.any? do |i18n_key|
+          key_in_i18n_hash? i18n_key, i18n_hash
+        end
+      end
+    end
+
+    def key_in_i18n_hash?(i18n_key, i18n_hash)
+      !i18n_key.split('.').inject(i18n_hash) do |hash, k|
+        begin
+          hash[k]
+        rescue StandardError
+          {}
+        end
+      end.nil?
+    end
+
+    def normalize(yaml)
+      i18n_yaml = yaml.with_indifferent_access.to_hash.to_yaml
+      i18n_yaml_lines = i18n_yaml.split(/\n/).reject { |e| e == '' }[1..-1]
+      normalize_empty_lines(i18n_yaml_lines) * "\n"
+    end
+
+    def normalize_empty_lines(i18n_yaml_lines)
+      yaml_ary = []
+      i18n_yaml_lines.each_with_index do |line, idx|
+        yaml_ary << line
+        yaml_ary << '' if add_empty_line?(i18n_yaml_lines, line, idx)
+      end
+      yaml_ary
+    end
+
+    def add_empty_line?(process, line, idx)
+      return if process[idx + 1].nil?
+      this_line_spcs = line[/\A\s*/].length
+      next_line_spcs = process[idx + 1][/\A\s*/].length
+      this_line_spcs - next_line_spcs > 2
+    end
+  end
+end

data/lib/i18n_yaml_editor/cast.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module I18nYamlEditor
+  # Transformation provides
+  module Cast
+    # Lists all supported types of conversions
+    TYPES = %i[numeric boolean array].freeze
+
+    # Contains a check method for each supported type
+    CHECK = {
+      numeric: ->(klass) { klass < Numeric },
+      boolean: ->(klass) { [TrueClass, FalseClass].include?(klass) },
+      array: ->(klass) { klass == Array }
+    }.freeze
+
+    # Contains a conversion method for each supported type
+    CONVERT = {
+      numeric: lambda do |value|
+                 num = BigDecimal(value)
+                 num.frac.zero? ? num.to_i : num.to_f
+               end,
+      boolean: ->(value) { value.casecmp('true').zero? },
+      array: ->(value) { value.split("\r\n") }
+    }.freeze
+
+    # Converts a given value to a specific data type
+    def cast(klass, value)
+      TYPES.each do |type|
+        return CONVERT[type].call(value) if CHECK[type].call(klass)
+      end
+      value.to_s # String, blank
+    end
+  end
+end

data/lib/i18n_yaml_editor/category.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module I18nYamlEditor
+  # This is a category
+  class Category
+    attr_accessor :name, :keys
+
+    def initialize(attributes = {})
+      @name = attributes[:name]
+      @keys = Set.new
+    end
+
+    # Adds a given key to this category's list of keys
+    # @param key [Key] key to be added to this category's list of keys
+    def add_key(key)
+      keys.add(key)
+    end
+
+    # Checks and returns if all keys are complete
+    # @return [true, false]
+    def complete?
+      keys.all?(&:complete?)
+    end
+  end
+end

data/lib/i18n_yaml_editor/core_ext.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Extend Hash with sort_by_key method
+class Hash
+  # Sorts entries alphabetically by key
+  def sort_by_key(recursive = false, &block)
+    keys.sort(&block).each_with_object({}) do |key, seed|
+      seed[key] = self[key]
+      if recursive && seed[key].is_a?(Hash)
+        seed[key] = seed[key].sort_by_key(true, &block)
+      end
+    end
+  end
+end

data/lib/i18n_yaml_editor/filter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module I18nYamlEditor
+  # Transformation provides
+  module Filter
+    # Selects keys from this store according to the given filter options
+    def filter_keys(options = {})
+      filters = filters(options)
+      keys.select { |_, key| filters.all? { |filter| filter.call(key) } }
+    end
+
+    private
+
+    def filters(options)
+      list = []
+      list << key_filter(options) if options.key?(:key)
+      list << complete_filter(options) if options.key?(:complete)
+      list << empty_filter(options) if options.key?(:empty)
+      list << text_filter(options) if options.key?(:text)
+      list
+    end
+
+    def key_filter(options)
+      ->(k) { k.name =~ options[:key] }
+    end
+
+    def complete_filter(options)
+      ->(k) { k.complete? == options[:complete] }
+    end
+
+    def empty_filter(options)
+      ->(k) { k.empty? == options[:empty] }
+    end
+
+    def text_filter(options)
+      ->(k) { k.translations.any? { |t| t.text =~ options[:text] } }
+    end
+  end
+end

data/lib/i18n_yaml_editor/key.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'set'
+
+module I18nYamlEditor
+  # This is a key
+  class Key
+    attr_accessor :name, :translations
+
+    def initialize(attributes = {})
+      @name = attributes[:name]
+      @translations = Set.new
+    end
+
+    # Adds a translation to this key's list of translations
+    def add_translation(translation)
+      translations.add(translation)
+    end
+
+    # This key's category
+    def category
+      @category ||= name.split('.').first
+    end
+
+    def complete?
+      translations.all? { |t| t.text.to_s !~ /\A\s*\z/ } || empty?
+    end
+
+    def empty?
+      translations.all? { |t| t.text.to_s =~ /\A\s*\z/ }
+    end
+  end
+end

data/lib/i18n_yaml_editor/store.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require 'set'
+require 'pathname'
+
+require 'i18n_yaml_editor/transformation'
+require 'i18n_yaml_editor/filter'
+require 'i18n_yaml_editor/update'
+require 'i18n_yaml_editor/category'
+require 'i18n_yaml_editor/key'
+require 'i18n_yaml_editor/translation'
+
+module I18nYamlEditor
+  # Raised when translation entries have the same key
+  class DuplicateTranslationError < StandardError; end
+
+  # Store keeps all i18n data
+  class Store
+    include Transformation
+    include Filter
+    include Update
+
+    attr_accessor :categories, :keys, :translations, :locales
+
+    def initialize
+      @categories = {}
+      @keys = {}
+      @translations = {}
+      @locales = Set.new
+    end
+
+    # Adds a given translation to the store
+    def add_translation(translation)
+      check_duplication! translation
+
+      translations[translation.name] = translation
+
+      locales.add(translation.locale)
+      key = init_key(translation)
+      init_category(key)
+    end
+
+    # Generates a new key with the given translation
+    def init_key(translation)
+      key = (keys[translation.key] ||= Key.new(name: translation.key))
+      key.add_translation(translation)
+      key
+    end
+
+    # Generates a new category with the given key
+    def init_category(key)
+      category = (categories[key.category] ||= Category.new(name: key.category))
+      category.add_key(key)
+    end
+
+    # Adds a key to this store
+    def add_key(key)
+      keys[key.name] = key
+    end
+
+    # Creates all keys for each locale that doesn't have all keys from all
+    # other locales
+    def create_missing_keys
+      keys.each do |_name, key|
+        missing_locales = locales - key.translations.map(&:locale)
+        missing_locales.each do |locale|
+          translation = key.translations.first
+          name = "#{locale}.#{key.name}"
+          path = translation_path locale, translation
+          add_translation(Translation.new(name: name, file: path))
+        end
+      end
+    end
+
+    # Adds a translation for every entry in a given yaml hash
+    def from_yaml(yaml, file = nil)
+      translations = flatten_hash(yaml)
+      translations.each do |name, text|
+        translation = Translation.new(name: name, text: text, file: file)
+        add_translation(translation)
+      end
+    end
+
+    # Returns a hash with the structure of a i18n
+    def to_yaml
+      result = {}
+      files = translations.values.group_by(&:file)
+      files.each do |file, translations|
+        file_result = {}
+        translations.each do |translation|
+          file_result[translation.name] = translation.text
+        end
+        result[file] = nest_hash(file_result)
+      end
+      result
+    end
+
+    private
+
+    def translation_path(locale, translation)
+      translation.file.gsub(/(.*)[A-z]{2}(\.yml)\z/, "\\1#{locale}\\2")
+    end
+
+    def check_duplication!(translation)
+      existing = translations[translation.name]
+      return unless existing
+      error_message = error_message(translation, existing)
+      raise DuplicateTranslationError, error_message
+    end
+
+    def error_message(translation, existing)
+      "#{translation.name} detected in #{translation.file} and #{existing.file}"
+    end
+  end
+end

data/lib/i18n_yaml_editor/transformation.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module I18nYamlEditor
+  # Raised when nesting of I18n keys to a Hash fails
+  class TransformationError < StandardError; end
+
+  # Transformation provides
+  module Transformation
+    # Public: Converts a deep hash to one level by generating new keys
+    #         by joining the previous key path to the value with a '.'
+    #
+    # hash      - The original Hash.
+    # namespace - An optional namespace, default: [].
+    # tree      - An optional tree to add values to, default: {}.
+    #
+    # Examples
+    #   flatten_hash({da: {session: { login: 'Log ind', logout: 'Log ud' }}})
+    #   # => {"da.session.login"=>"Log ind", "da.session.logout"=>"Log ud"}
+    #
+    # Returns the generated Hash.
+    def flatten_hash(hash, namespace = [], tree = {})
+      hash.each do |key, value|
+        child_ns = namespace.dup << key
+        if value.is_a?(Hash)
+          flatten_hash value, child_ns, tree
+        else
+          tree[child_ns.join('.')] = value
+        end
+      end
+      tree
+    end
+    module_function :flatten_hash
+
+    # Public: Converts a flat hash with key path to the value joined
+    #         with a '.' to a one level Hash, it's the reverse of flatten_hash
+    #
+    # hash - Hash with keys that represent the path to the value in the new Hash
+    #
+    # Examples
+    #  nest_hash({"da.session.login"=>"Log ind", "da.session.logout"=>"Log ud"})
+    #  # => {"da"=>{"session"=>{"login"=>"Log ind", "logout"=>"Log ud"}}}
+    #
+    # Returns the generated Hash.
+    def nest_hash(hash)
+      result = {}
+      hash.each do |key, value|
+        begin
+          nest_key result, key, value
+        rescue StandardError
+          raise TransformationError,
+                "Failed to nest key: #{key.inspect} with #{value.inspect}"
+        end
+      end
+      result
+    end
+    module_function :nest_hash
+
+    private
+
+    # Recursively nests point-separated keys from a string in a hash and
+    # assigns the given value to this new hash entry
+    def nest_key(result, key, value)
+      sub_result = result
+      keys = key.split('.')
+      keys.each_with_index do |k, idx|
+        if keys.size - 1 == idx
+          sub_result[k] = value
+        else
+          sub_result = (sub_result[k] ||= {})
+        end
+      end
+    end
+    module_function :nest_key
+  end
+end