translatomatic 0.1.2 → 0.1.3

data/lib/translatomatic/cli/config.rb

@@ -1,81 +1,110 @@
-module Translatomatic::CLI
-  # Configuration functions for the command line interface
-  class Config < Base
-
-    desc "set key value", t("cli.config.set")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    # 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) }
-    end
-
-    desc "remove key", t("cli.config.remove")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    # Remove a configuration setting
-    # @param key [String] configuration key to remove
-    # @return [void]
-    def remove(key)
-      run { conf.remove(key) }
-    end
-
-    desc "list", t("cli.config.list")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    # List current configuration settings
-    def list
-      run do
-        puts t("cli.config.configuration")
-        print_config_table(:key, :value)
-      end
-    end
-
-    desc "describe", t("cli.config.describe")
-    thor_options(self, Translatomatic::CLI::CommonOptions)
-    # Describe available configuration settings
-    def describe
-      run do
-        puts t("cli.config.configuration")
-        print_config_table(:key, :type, :desc)
-      end
-    end
-
-    private
-
-    TABLE_HEADING_MAP = {
-      key: t("cli.config.name"),
-      type: t("cli.config.type"),
-      value: t("cli.config.value"),
-      desc: t("cli.config.desc"),
-    }
-
-    def print_config_table(*columns)
-      puts
-      rows = []
-      rows << columns.collect { |i| TABLE_HEADING_MAP[i] }
-      rows << rows[0].collect { |i| i.gsub(/\w/, '=') }
-      Translatomatic::Config.options.each do |option|
-        key = option.name.to_s
-        data = []
-        columns.each do |column|
-          data << case column
-          when :key
-            key
-          when :value
-            value = conf.get(key)
-            value.nil? ? "-" : value
-          when :type
-            t("config.types.#{option.type}")
-          when :desc
-            option.description
-          end
-        end
-        rows << data
-      end
-      rows.sort_by { |i| i[0] }
-      print_table(rows, indent: 2)
-      puts
-    end
-  end
-end
+module Translatomatic::CLI
+  # Configuration functions for the command line interface
+  class Config < Base
+
+    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, cli_option(:context)) }
+    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 "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
+        )
+      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])
+      end
+    end
+
+    private
+
+    CONFIG_HEADING_MAP = {
+      key: t("cli.config.name"),
+      type: t("cli.config.type"),
+      value: t("cli.config.value"),
+      desc: t("cli.config.desc"),
+    }
+
+    def print_config_table(options)
+      columns = options[:columns]
+      context = options[:context]
+      rows = []
+
+      if context
+        puts t("cli.config.context_configuration", context: context)
+      else
+        puts t("cli.config.configuration")
+      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
+        end
+        rows << data
+      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)
+      end
+      puts
+    end
+  end
+end

data/lib/translatomatic/cli/main.rb

@@ -1,15 +1,16 @@
-# Command line interface to translatomatic
+# Command line interface to translatomatic
 module Translatomatic::CLI
   # Main command line interface
-  class Main < Base
+  class Main < Base
+
+    default_task :translate
 
     begin
-      config = Translatomatic::Config.instance
-      I18n.default_locale = config.default_locale
+      I18n.default_locale = Translatomatic.config.default_locale
     end
-
-    package_name "Translatomatic"
-    map %W[-v --version] => :version
+
+    package_name "Translatomatic"
+    map %W[-v --version] => :version
     map %W[-L --list] => :translators
 
     desc "translate", t("cli.translate.subcommand")
@@ -20,8 +21,8 @@ module Translatomatic::CLI
 
     desc "config", t("cli.config.subcommand")
     subcommand "config", Config
-
-    desc "display file [key...]", t("cli.display_values")
+
+    desc "display file [key...]", t("cli.display_values")
     thor_options(self, Translatomatic::CLI::CommonOptions)
     method_option :locales, type: :string, desc: t("cli.locales_to_display")
     method_option :sentences, type: :boolean, desc: t("cli.display_sentences")
@@ -29,84 +30,96 @@ module Translatomatic::CLI
     # @param file [String] Path to resource file
     # @param keys [Array<String>] Optional list of locales
     # @return [void]
-    def display(file, *keys)
-      run do
-        source = Translatomatic::ResourceFile.load(file)
-        keys = source.properties.keys if keys.empty?
-        display_keys(source, keys)
-
-        # TODO: if locales not specified, determine the list of locales from
+    def display(file, *keys)
+      run do
+        source = Translatomatic::ResourceFile.load(file)
+        keys = source.properties.keys if keys.empty?
+        display_keys(source, keys)
+
+        # TODO: if locales not specified, determine the list of locales from
         # all the files in the resource bundle.
         locales = parse_list(options[:locales])
         locales << Translatomatic::Locale.default.to_s if locales.empty?
         locales.each do |tag|
           locale = locale(tag)
           next if locale == source.locale
-          display_properties(source, keys, locale)
-        end
-      end
-    end
-
+          display_properties(source, keys, locale)
+        end
+      end
+    end
+
     desc "strings file [file...]", t("cli.extract_strings")
     thor_options(self, Translatomatic::CLI::CommonOptions)
     # Extract strings from non-resource files
     # @param files [Array<String>] List of paths to files
-    # @return [void]
-    def strings(*files)
-      run do
-        strings = []
-        files.each do |file|
-          extractor = Translatomatic::Extractor::Base.new(file)
-          strings << extractor.extract
-        end
-        puts strings.join("\n")
-      end
-    end
-
+    # @return [void]
+    def strings(*files)
+      run do
+        strings = []
+        files.each do |file|
+          extractor = Translatomatic::Extractor::Base.new(file)
+          strings << extractor.extract
+        end
+        puts strings.join("\n")
+      end
+    end
+
+    desc "convert source target", t("cli.convert")
+    # Convert a resource file from one format to another
+    # @param source [String] An existing resource file
+    # @param target [String] The name of a target resource file
+    # @return [void]
+    def convert(source, target)
+      run do
+        converter = Translatomatic::Converter.new
+        converter.convert(source, target)
+      end
+    end
+
     desc "services", t("cli.list_backends")
     thor_options(self, Translatomatic::CLI::CommonOptions)
     # List available translator services
-    # @return [void]
-    def services
-      run { puts Translatomatic::Translator.list }
-    end
-
+    # @return [void]
+    def services
+      run { puts Translatomatic::Translator.list }
+    end
+
     desc 'version', t("cli.display_version")
     thor_options(self, Translatomatic::CLI::CommonOptions)
     # Display version number
-    # @return [void]
-    def version
-      puts "Translatomatic v#{Translatomatic::VERSION}"
-    end
-
-    private
-
-    def display_properties(source, keys, locale)
-      path = source.locale_path(locale)
-      if path.exist?
-        resource = Translatomatic::ResourceFile.load(path)
-        display_keys(resource, keys)
-      end
-    end
-
-    def display_keys(source, keys)
+    # @return [void]
+    def version
+      puts "Translatomatic v#{Translatomatic::VERSION}"
+    end
+
+    private
+
+    def display_properties(source, keys, locale)
+      path = source.locale_path(locale)
+      if path.exist?
+        resource = Translatomatic::ResourceFile.load(path)
+        display_keys(resource, keys)
+      end
+    end
+
+    def display_keys(source, keys)
       puts t("cli.file_source", file: source)
-      rows = []
-      keys.each do |key|
-        value = source.get(key)
-        rows << [key + ":", value]
-      end
-      print_table(rows, indent: 2)
-
-      if options[:sentences]
+      rows = []
+      keys.each do |key|
+        value = source.get(key)
+        rows << [key + ":", value]
+      end
+      print_table(rows, indent: 2)
+
+      if options[:sentences]
         puts t("cli.sentences")
-        source.sentences.each do |sentence|
-          puts "- " + sentence.to_s
-        end
-      end
-
-      puts
-    end
-
-  end # class
-end   # module
+        source.sentences.each do |sentence|
+          puts "- " + sentence.to_s
+        end
+      end
+
+      puts
+    end
+
+  end # class
+end   # module

data/lib/translatomatic/cli/translate.rb

@@ -1,16 +1,25 @@
-# Command line interface to translatomatic
+require 'ruby-progressbar'
+
+# Command line interface to translatomatic
 module Translatomatic::CLI
-  # Translation functions for the command line interface
-  class Translate < Base
+  # Translation functions for the command line interface
+  class Translate < Base
+
+    default_task :file
 
     define_options(
       { name: :translator, type: :array, aliases: "-t",
-        desc: t("converter.translator"), enum: Translatomatic::Translator.names
+        desc: t("cli.translate.translator"),
+        enum: Translatomatic::Translator.names
       },
       { name: :source_locale, desc: t("cli.source_locale") },
       { name: :share, desc: t("cli.share"), default: false },
       { name: :target_locales, desc: t("cli.target_locales"),
-        type: :array, hidden: true },
+        type: :array
+      },
+      { name: :source_files, desc: t("cli.source_files"),
+        type: :array
+      },
       )
 
     desc "string text locale...", t("cli.translate.string")
@@ -19,11 +28,13 @@ module Translatomatic::CLI
     thor_options(self, Translatomatic::Translator.modules)
     # Translate a string to target locales
     # @param text [String] String to translate
-    # @param locales [Array<String>] List of target locales
+    # @param locales [Array<String>] List of target locales, can also be set
+    #   with the --target-locales option
     # @return [void]
     def string(text, *locales)
       run do
-        setup_translation(locales)
+        setup_translation
+        determine_target_locales(locales)
 
         puts "(%s) %s" % [@source_locale, text]
         @translators.each do |translator|
@@ -38,109 +49,133 @@ module Translatomatic::CLI
         finish_log
       end
     end
-
-    desc "file filename locale...", t("cli.translate.file")
+
+    desc "file filename locale...", t("cli.translate.file")
     thor_options(self, Translatomatic::CLI::CommonOptions)
     thor_options(self, Translatomatic::CLI::Translate)
-    thor_options(self, Translatomatic::Converter)
+    thor_options(self, Translatomatic::FileTranslator)
     thor_options(self, Translatomatic::Database)
     thor_options(self, Translatomatic::Translator.modules)
     # Translate files to target locales
-    # @param file [String] Resource file to translate
-    # @param locales [Array<String>] List of target locales
+    # @param file [String] Resource file to translate, can also be set
+    #   with the --source-files option.
+    # @param locales [Array<String>] List of target locales, can also be set
+    #   with the --target-locales option
     # @return [void]
-    def file(file, *locales)
-      run do
-        setup_translation(locales)
-
-        # load source file
-        raise t("cli.file_not_found", file: file) unless File.exist?(file)
-        source = Translatomatic::ResourceFile.load(file, @source_locale)
-        raise t("cli.file_unsupported", file: file) unless source
-
-        # set up database
-        Translatomatic::Database.new(options)
-
-        log.debug(t("cli.locales_properties", locales: locales, properties: source.properties.length))
-
-        # set up converter
-        translation_count = calculate_translation_count(source, @target_locales)
-        converter_options = options.merge(
-          translator: @translators,
-          listener: progress_updater(translation_count)
-        )
-        converter = Translatomatic::Converter.new(converter_options)
-
-        # convert source to locale(s) and write files
-        @target_locales.each do |i|
-          to_locale = locale(i)
-          next if to_locale.language == source.locale.language
-          converter.translate_to_file(source, to_locale)
-        end
-
-        log.info converter.stats
-        finish_log
-
-        share_translations(converter) if cli_option(:share)
-      end
-    end
-
-    private
-
-    def setup_translation(locales)
-      log.info(t("cli.dry_run")) if cli_option(:dry_run)
-
-      @target_locales = parse_list(locales, cli_option(:target_locales))
-      @source_locale = determine_source_locale
-      raise t("cli.locales_required") if @target_locales.empty?
-      conf.logger.level = Logger::DEBUG if cli_option(:debug)
-
-      # resolve translators
-      @translators = Translatomatic::Translator.resolve(
-        cli_option(:translator), options
-      )
-    end
-
-    def determine_source_locale
-      cli_option(:source_locale) || conf.default_locale
-    end
-
-    def calculate_translation_count(source, locales)
-      source.sentences.length * locales.length
-    end
-
-    def share_translations(converter)
-      return if converter.db_translations.empty?
-
-      tmx = Translatomatic::TMX::Document.from_texts(converter.db_translations)
-      available = Translatomatic::Translator.available(options)
-      available.each do |translator|
-        if translator.respond_to?(:upload)
+    def file(file = nil, *locales)
+      run do
+        setup_translation
+        determine_target_locales(locales)
+
+        # check source file(s) exist and they can be loaded
+        source_files = parse_list(cli_option(:source_files), file)
+        source_files.each do |source_file|
+          path = source_path(source_file)
+          raise t("file.not_found", file: path) unless File.exist?(path)
+          source = Translatomatic::ResourceFile.load(path, @source_locale)
+          raise t("file.unsupported", file: path) unless source
+        end
+
+        # set up database
+        Translatomatic::Database.new(options)
+
+        # set up file translatiln
+        translation_count = calculate_translation_count(source_files, @target_locales)
+        ft_options = options.merge(
+          translator: @translators,
+          listener: progress_updater(translation_count)
+        )
+        ft = Translatomatic::FileTranslator.new(ft_options)
+
+        source_files.each do |path|
+          # read source file
+          source = Translatomatic::ResourceFile.load(path, @source_locale)
+
+          # convert source to locale(s) and write files
+          @target_locales.each do |i|
+            to_locale = locale(i)
+            next if to_locale.language == source.locale.language
+            ft.translate_to_file(source, to_locale)
+          end
+        end
+
+        log.info ft.stats
+        finish_log
+
+        share_translations(ft) if cli_option(:share)
+      end
+    end
+
+    private
+
+    def setup_translation
+      @source_locale = determine_source_locale
+      # resolve translators
+      @translators = Translatomatic::Translator.resolve(
+        cli_option(:translator), options
+      )
+    end
+
+    def determine_target_locales(locales)
+      @target_locales = parse_list(locales, cli_option(:target_locales))
+      raise t("cli.locales_required") if @target_locales.empty?
+    end
+
+    def determine_source_locale
+      cli_option(:source_locale) || conf.default_locale
+    end
+
+    def calculate_translation_count(source_files, locales)
+      count = 0
+      source_files.each do |file|
+        source = Translatomatic::ResourceFile.load(file, @source_locale)
+        count += source.sentences.length * locales.length
+      end
+      count
+    end
+
+    def share_translations(ft)
+      return if ft.db_translations.empty?
+
+      tmx = Translatomatic::TMX::Document.from_texts(ft.db_translations)
+      available = Translatomatic::Translator.available(options)
+      available.each do |translator|
+        if translator.respond_to?(:upload)
           log.info(t("cli.uploading_tmx", name: translator.name))
-          translator.upload(tmx)
-        end
-      end
-
-      ActiveRecord::Base.transaction do
-        converter.db_translations.each do |text|
-          text.update(shared: true) if text.is_translated?
-        end
-      end
-    end
-
-    # create a progress bar and progress updater
-    def progress_updater(translation_count)
-      return nil unless cli_option(:wank)
-      # set up progress bar
-      progressbar = ProgressBar.create(
-        title: t("cli.translating"),
-        format: "%t: |%B| %E ",
-        autofinish: false,
-        total: translation_count
-      )
-      conf.logger.progressbar = progressbar
-      Translatomatic::ProgressUpdater.new(progressbar)
-    end
-
-  end # class
-end   # module
+          translator.upload(tmx)
+        end
+      end
+
+      ActiveRecord::Base.transaction do
+        ft.db_translations.each do |text|
+          text.update(shared: true) if text.is_translated?
+        end
+      end
+    end
+
+    # convert the given path to an absolute path if necessary, relative
+    # to project root.
+    def source_path(path)
+      if path.start_with?("~/")
+        # replace ~/ with home directory
+        path = path.sub(/\A~\//, Dir.home + "/")
+      end
+      File.absolute_path(path, conf.project_path)
+    end
+
+    # create a progress bar and progress updater
+    def progress_updater(translation_count)
+      return nil unless cli_option(:wank)
+      # set up progress bar
+      progressbar = ProgressBar.create(
+        title: t("cli.translating"),
+        format: "%t: |%B| %E ",
+        autofinish: false,
+        total: translation_count
+      )
+      conf.logger.progressbar = progressbar
+      Translatomatic::ProgressUpdater.new(progressbar)
+    end
+
+  end # class
+end   # module