translatomatic 0.1.3 → 0.2.0

data/db/migrate/201712170000_initial.rb

@@ -8,7 +8,7 @@ class Initial < ActiveRecord::Migration[4.2] # :nodoc:
       t.timestamps
     end
 
-    add_index :locales, [:language, :script, :region], unique: true
+    add_index :locales, %i[language script region], unique: true
 
     create_table :texts do |t|
       t.belongs_to :locale, index: true, null: false
@@ -17,9 +17,8 @@ class Initial < ActiveRecord::Migration[4.2] # :nodoc:
       }
       t.text       :value, null: false
       t.boolean    :shared, null: false, default: false, index: true
-      t.string     :translator
+      t.string     :provider
       t.timestamps
     end
-
   end
 end

data/lib/translatomatic.rb

@@ -1,52 +1,67 @@
-require 'i18n'
-require 'rails-i18n'
-require 'i18n_data'
+# gem :rchardet19, provided_by: :rchardet
+# titlekit has rchardet19 dependency, but we don't want that.
+dependency = Gem::Dependency.new('rchardet19')
+specs = dependency.matching_specs
+if specs
+  path = File.join(specs[0].full_gem_path, 'lib')
+  $LOAD_PATH.delete(path)
+end
 
 require 'pathname'
 require 'active_support/core_ext/hash'
-require 'active_support/dependencies/autoload'
+require 'rchardet'
 
 # Module containing all of the translation goodness
 module Translatomatic
+  class << self
+    attr_writer :logger
+    attr_writer :config
 
-  # @return [Translatomatic::Config] configuration
-  def self.config
-    @config ||= Translatomatic::Config.new
-  end
-
-  private
+    # @return [Logger] Translatomatic logger instance
+    def logger
+      @logger ||= Translatomatic::Logger.new
+    end
 
-  def self.init_i18n(lib_path)
-    locale_path = File.join(File.dirname(lib_path), "..", "config", "locales")
-    I18n.load_path += Dir[File.join(locale_path, "**", "*.yml")]
+    # @return [Translatomatic::Config] Configuration settings
+    def config
+      @config ||= Translatomatic::Config::Settings.new
+    end
   end
 end
 
-begin
-  Translatomatic.init_i18n(__FILE__)
-end
-
 require 'translatomatic/version'
-require 'translatomatic/option'
-require 'translatomatic/define_options'
 require 'translatomatic/locale'
-require 'translatomatic/string'
-require 'translatomatic/translation'
+require 'translatomatic/slurp'
+require 'translatomatic/i18n'
 require 'translatomatic/util'
+require 'translatomatic/option'
+require 'translatomatic/define_options'
+require 'translatomatic/flattenation'
+require 'translatomatic/string_batcher'
+require 'translatomatic/path_utils'
+require 'translatomatic/string_escaping'
+require 'translatomatic/text'
+require 'translatomatic/text_collection'
+require 'translatomatic/retry_executor'
 require 'translatomatic/version'
 require 'translatomatic/logger'
+require 'translatomatic/type_cast'
 require 'translatomatic/config'
 require 'translatomatic/database'
+require 'translatomatic/translation'
 require 'translatomatic/escaped_unicode'
 require 'translatomatic/model'
+require 'translatomatic/metadata'
 require 'translatomatic/resource_file'
-require 'translatomatic/http_request'
+require 'translatomatic/http'
 require 'translatomatic/converter'
-require 'translatomatic/translator'
-require 'translatomatic/translation_result'
-require 'translatomatic/translation_stats'
+require 'translatomatic/provider'
 require 'translatomatic/file_translator'
 require 'translatomatic/extractor'
 require 'translatomatic/progress_updater'
 require 'translatomatic/tmx'
+require 'translatomatic/translator'
 require 'translatomatic/cli'
+
+# monkey patches
+Thor::Option.prepend Translatomatic::CLI::ThorPatch::NoNo

data/lib/translatomatic/cli.rb

@@ -1,5 +1,9 @@
-module Translatomatic::CLI; end
+module Translatomatic
+  # Command line functions
+  module CLI; end
+end
 
+require 'translatomatic/cli/thor'
 require 'translatomatic/cli/common_options'
 require 'translatomatic/cli/base'
 require 'translatomatic/cli/translate'

data/lib/translatomatic/cli/base.rb

@@ -1,81 +1,84 @@
 require 'thor'
+require 'rainbow'
 
-module Translatomatic::CLI
-  # Base class for command line interface classes
-  class Base < Thor
+module Translatomatic
+  module CLI
+    # Base class for command line interface classes
+    class Base < Thor
+      private
 
-    private
+      include Translatomatic::Util
+      include Translatomatic::DefineOptions
 
-    include Translatomatic::Util
-    include Translatomatic::DefineOptions
+      # creates thor options
+      class << self
+        private
 
-    # creates thor options
-    def self.thor_options(klass, object)
-      Translatomatic::Option.options_from_object(object).each do |option|
-        next if option.hidden
-        klass.method_option option.name, option.to_thor
+        def thor_options(klass, object)
+          Translatomatic::Option.options_from_object(object).each do |option|
+            next if option.hidden
+            name = option.name.to_s.dasherize
+            klass.method_option name, option.to_thor
+          end
+        end
       end
-    end
-
-    def parse_list(list, default = [])
-      # use the default list if the list is empty
-      list = default if list.nil? || list.empty?
-      list = [list] unless list.kind_of?(Array)
-      # split list entries on ','
-      list.compact.collect { |i| i.split(/[, ]/) }.flatten.compact
-    end
 
-    # run the give code block, display exceptions.
-    # return true if the code ran without exceptions
-    def run
-      begin
-        merge_options_and_config
-        @dry_run = cli_option(:dry_run)
-        conf.logger.level = Logger::DEBUG if cli_option(:debug)
-        log.info(t("cli.dry_run")) if @dry_run
+      def parse_list(list, default = [])
+        # use the default list if the list is empty
+        list = default if list.nil? || list.empty?
+        list = [list] unless list.is_a?(Array)
+        # split list entries on ','
+        list.compact.collect { |i| i.split(/[, ]/) }.flatten.compact
+      end
 
+      # run the give code block, display exceptions.
+      def run
+        Translatomatic.config = create_config
+        @dry_run = conf.get(:dry_run)
+        log.level = ::Logger::DEBUG if conf.get(:debug)
+        log.info(t('cli.dry_run')) if @dry_run
         yield
-        true
       rescue Interrupt
-        puts "\n" + t("cli.aborted")
-        false
-      rescue Exception => e
+        puts "\n" + t('cli.aborted')
+      rescue StandardError => e
+        handle_run_error(e)
+      end
+
+      def create_config
+        Translatomatic::Config::Settings.new(runtime: options)
+      end
+
+      def handle_run_error(e)
         finish_log
         log.error(e.message)
         log.debug(e.backtrace.join("\n"))
-        raise e if ENV["TEST"] # reraise exceptions in test
-        false
+        raise e if ENV['TEST'] # reraise exceptions in test
       end
-    end
 
-    def finish_log
-      conf.logger.finish if conf.logger.respond_to?(:finish)
-    end
-
-    def conf
-      Translatomatic.config
-    end
+      def finish_log
+        log.finish if log.respond_to?(:finish)
+      end
 
-    # get an option value
-    def cli_option(key)
-      @options[key]
-    end
+      def conf
+        Translatomatic.config
+      end
 
-    # create @options from options and config
-    def merge_options_and_config
-      # start with command line options
-      @options = options.transform_keys { |i| i.to_sym }
-      # fill missing entries with config values
-      Translatomatic::Config.options.each do |option|
-        unless @options.include?(option.name)
-          @options[option.name] = conf.get(option.name)
+      def rainbow
+        @rainbow ||= begin
+          rainbow = Rainbow.new
+          rainbow.enabled = !conf.get(:no_wank)
+          rainbow
         end
       end
-    end
 
-    def empty_array?(value)
-      value.kind_of?(Array) && value.empty?
-    end
+      def empty_array?(value)
+        value.is_a?(Array) && value.empty?
+      end
 
+      def add_table_heading(rows, headings)
+        underscores = headings.collect { |i| i.gsub(/\w/, '=') }
+        [headings, underscores] + rows
+      end
+    end
   end
 end

data/lib/translatomatic/cli/common_options.rb

@@ -1,14 +1,17 @@
-module Translatomatic::CLI
-  # Defines options common to all command line methods
-  class CommonOptions
-    private
-    include Translatomatic::DefineOptions
-    include Translatomatic::Util
-
-    define_options(
-      { name: :debug, type: :boolean, default: false, desc: t("cli.debug") },
-      { name: :wank, type: :boolean, default: true, desc: t("cli.wank") },
-    )
+module Translatomatic
+  module CLI
+    # Defines options common to all command line methods
+    class CommonOptions
+      include Translatomatic::DefineOptions
+      include Translatomatic::Util
 
+      define_option :debug, type: :boolean, default: false,
+                            desc: t('cli.debug'), command_line_only: true
+      define_option :no_wank, type: :boolean, default: false,
+                              desc: t('cli.no_wank')
+      define_option :dry_run, type: :boolean, aliases: '-n',
+                              desc: t('cli.dry_run'),
+                              command_line_only: true
+    end
   end
 end

data/lib/translatomatic/cli/config.rb

@@ -1,110 +1,115 @@
-module Translatomatic::CLI
-  # Configuration functions for the command line interface
-  class Config < Base
+module Translatomatic
+  module CLI
+    # Configuration functions for the command line interface
+    class Config < Base
+      define_option :user, type: :boolean,
+                           desc: t('cli.config.user'),
+                           command_line_only: true
+      define_option :project, type: :boolean,
+                              desc: t('cli.config.project'),
+                              command_line_only: true
+      define_option :for_file, type: :path,
+                               desc: t('cli.config.for_file'),
+                               command_line_only: true
 
-    define_options(
-      { name: :context, type: :string, aliases: "-c",
-        desc: t("cli.config.context"),
-        enum: Translatomatic::Config::CONTEXTS,
-        command_line_only: true
-      },
-    )
+      desc 'set key value', t('cli.config.set')
+      thor_options(self, Translatomatic::CLI::CommonOptions)
+      thor_options(self, Translatomatic::CLI::Config)
+      # Change a configuration setting
+      # @param key [String] configuration key
+      # @param value [String] new value for the configuration
+      # @return [String] the new value
+      def set(key, *value)
+        run { conf.set(key, value, config_params) }
+      end
 
-    desc "set key value", t("cli.config.set")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    thor_options(self, Translatomatic::CLI::Config)
-    # Change a configuration setting
-    # @param key [String] configuration key
-    # @param value [String] new value for the configuration
-    # @return [String] the new value
-    def set(key, *value)
-      run { conf.set(key, value, cli_option(:context)) }
-    end
+      desc 'unset key', t('cli.config.unset')
+      thor_options(self, Translatomatic::CLI::CommonOptions)
+      thor_options(self, Translatomatic::CLI::Config)
+      # Remove a configuration setting
+      # @param key [String] configuration key to remove
+      # @return [void]
+      def unset(key)
+        run { conf.unset(key, config_params) }
+      end
 
-    desc "remove key", t("cli.config.remove")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    thor_options(self, Translatomatic::CLI::Config)
-    # Remove a configuration setting
-    # @param key [String] configuration key to remove
-    # @return [void]
-    def remove(key)
-      run { conf.remove(key, cli_option(:context)) }
-    end
+      desc 'add key value', t('cli.config.add')
+      thor_options(self, Translatomatic::CLI::CommonOptions)
+      thor_options(self, Translatomatic::CLI::Config)
+      # Add a configuration setting to a list
+      # @param key [String] configuration key
+      # @param value [String] value to add
+      # @return [String] the new value
+      def add(key, *value)
+        run { conf.add(key, value, config_params) }
+      end
 
-    desc "list", t("cli.config.list")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    thor_options(self, Translatomatic::CLI::Config)
-    # List current configuration settings
-    def list
-      run do
-        print_config_table(columns: [:key, :value],
-          context: cli_option(:context),
-          skip_blanks: true
-        )
+      desc 'subtract key value', t('cli.config.subtract')
+      thor_options(self, Translatomatic::CLI::CommonOptions)
+      thor_options(self, Translatomatic::CLI::Config)
+      # Remove a configuration setting from a list
+      # @param key [String] configuration key
+      # @param value [String] value to remove
+      # @return [void]
+      def subtract(key, value)
+        run { conf.subtract(key, value, config_params) }
       end
-    end
 
-    desc "describe", t("cli.config.describe")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    thor_options(self, Translatomatic::CLI::Config)
-    # Describe available configuration settings
-    def describe
-      run do
-        print_config_table(columns: [:key, :type, :desc])
+      desc 'list', t('cli.config.list')
+      thor_options(self, Translatomatic::CLI::CommonOptions)
+      thor_options(self, Translatomatic::CLI::Config)
+      option :skip_blanks, type: :boolean, desc: 'Skip blank values'
+      # List current configuration settings
+      def list
+        run do
+          print_config_table(columns: %i[key value], skip_blanks: true)
+        end
       end
-    end
 
-    private
+      desc 'describe', t('cli.config.describe')
+      thor_options(self, Translatomatic::CLI::CommonOptions)
+      thor_options(self, Translatomatic::CLI::Config)
+      # Describe available configuration settings
+      def describe
+        run do
+          print_config_table(columns: %i[key type desc])
+        end
+      end
 
-    CONFIG_HEADING_MAP = {
-      key: t("cli.config.name"),
-      type: t("cli.config.type"),
-      value: t("cli.config.value"),
-      desc: t("cli.config.desc"),
-    }
+      private
 
-    def print_config_table(options)
-      columns = options[:columns]
-      context = options[:context]
-      rows = []
+      def config_params
+        { location: config_location, for_file: options['for-file'] }
+      end
 
-      if context
-        puts t("cli.config.context_configuration", context: context)
-      else
-        puts t("cli.config.configuration")
+      def config_location
+        if options[:user]
+          :user
+        elsif options[:project]
+          :project
+        end
       end
-      puts
-      Translatomatic::Config.options.each do |option|
-        key = option.name.to_s
-        next if option.command_line_only
-        next if options[:skip_blanks] && !conf.include?(key, context)
-        value = conf.get(key, context)
-        data = []
-        columns.each do |column|
-          data << case column
-          when :key
-            key
-          when :value
-            value.nil? ? "-" : value
-          when :type
-            t("config.types.#{option.type}")
-          when :desc
-            option.description
-          end
+
+      def print_config_table(params)
+        display_options = options.merge(params).merge(config_params)
+        display = Translatomatic::Config::Display.new(display_options)
+        puts config_table_intro + "\n"
+        rows = display.config_table_body
+        if rows.empty?
+          puts t('cli.config.no_config')
+        else
+          print_table(rows)
         end
-        rows << data
+        puts
       end
 
-      if rows.empty?
-        puts t("cli.config.no_config")
-      else
-        rows.sort_by { |i| i[0] }
-        headings = columns.collect { |i| CONFIG_HEADING_MAP[i] }
-        rows.unshift headings.collect { |i| i.gsub(/\w/, '=') }
-        rows.unshift headings
-        print_table(rows, indent: 2)
+      def config_table_intro
+        if (location = config_location)
+          t('cli.config.location_configuration', location: location)
+        else
+          t('cli.config.configuration')
+        end
       end
-      puts
     end
   end
 end