translatomatic 0.1.2 → 0.1.3

data/lib/translatomatic/locale.rb

@@ -1,76 +1,76 @@
-# Represents a locale
-# @see https://en.wikipedia.org/wiki/Locale_(computer_software)
-class Translatomatic::Locale
-
-  # @return [String] ISO 639-1 language
-  attr_reader :language
-
-  # @return [String] ISO 15924 script
-  attr_reader :script
-
-  # @return [String] ISO 3166-1 alpha-2 country code
-  attr_reader :region
-
-  # Parse the given tag
-  # @param tag [String] A string representing a locale
-  # @param validate [boolean] If true, return nil if the locale is invalid
-  # @return [Locale] A locale object
-  def self.parse(tag, validate = true)
-    return nil if tag.nil?
-
-    locale = tag
-    unless tag.kind_of?(Translatomatic::Locale)
-      tag = tag.to_s.gsub(/_/, '-')
-      locale = new(tag)
-    end
-    validate && !locale.valid? ? nil : locale
-  end
-
-  # @return [Locale] the default locale
-  def self.default
-    parse(Translatomatic::Config.instance.default_locale)
-  end
-
-  # @return [Locale] create a new locale object
-  def initialize(tag)
-    data = I18n::Locale::Tag::Rfc4646.tag(tag)
-    if data
-      @language = data.language
-      @script = data.script
-      @region = data.region
-    end
-  end
-
-  # @return true if language is a valid ISO 639-1 language
-  def valid?
-    VALID_LANGUAGES.include?(language)
-  end
-
-  # @return [String] Locale as a string
-  def to_s
-    [language, script, region].compact.join("-")
-  end
-
-  # @param other [Object] Another object
-  # @return [boolean] true if the other object is a {Translatomatic::Locale}
-  #   object and has equal language, script and region.
-  def eql?(other)
-    other.kind_of?(Translatomatic::Locale) && other.hash == hash
-  end
-
-  # (see #eql?)
-  def ==(other)
-    eql?(other)
-  end
-
-  # @!visibility private
-  def hash
-    [language, script, region].hash
-  end
-
-  private
-
-  # list of 2 letter country codes
-  VALID_LANGUAGES = ::I18nData.languages.keys.collect { |i| i.downcase }.sort
-
-end
+# Represents a locale
+# @see https://en.wikipedia.org/wiki/Locale_(computer_software)
+class Translatomatic::Locale
+
+  # @return [String] ISO 639-1 language
+  attr_reader :language
+
+  # @return [String] ISO 15924 script
+  attr_reader :script
+
+  # @return [String] ISO 3166-1 alpha-2 country code
+  attr_reader :region
+
+  # Parse the given tag
+  # @param tag [String] A string representing a locale
+  # @param validate [boolean] If true, return nil if the locale is invalid
+  # @return [Locale] A locale object
+  def self.parse(tag, validate = true)
+    return nil if tag.nil?
+
+    locale = tag
+    unless tag.kind_of?(Translatomatic::Locale)
+      tag = tag.to_s.gsub(/_/, '-')
+      locale = new(tag)
+    end
+    validate && !locale.valid? ? nil : locale
+  end
+
+  # @return [Locale] the default locale
+  def self.default
+    parse(Translatomatic.config.default_locale)
+  end
+
+  # @return [Locale] create a new locale object
+  def initialize(tag)
+    data = I18n::Locale::Tag::Rfc4646.tag(tag)
+    if data
+      @language = data.language
+      @script = data.script
+      @region = data.region
+    end
+  end
+
+  # @return true if language is a valid ISO 639-1 language
+  def valid?
+    VALID_LANGUAGES.include?(language)
+  end
+
+  # @return [String] Locale as a string
+  def to_s
+    [language, script, region].compact.join("-")
+  end
+
+  # @param other [Object] Another object
+  # @return [boolean] true if the other object is a {Translatomatic::Locale}
+  #   object and has equal language, script and region.
+  def eql?(other)
+    other.kind_of?(Translatomatic::Locale) && other.hash == hash
+  end
+
+  # (see #eql?)
+  def ==(other)
+    eql?(other)
+  end
+
+  # @!visibility private
+  def hash
+    [language, script, region].hash
+  end
+
+  private
+
+  # list of 2 letter country codes
+  VALID_LANGUAGES = ::I18nData.languages.keys.collect { |i| i.downcase }.sort
+
+end

data/lib/translatomatic/logger.rb

@@ -1,36 +1,36 @@
 # Logging
 class Translatomatic::Logger
 
-  # @return [ProgressBar] A progress bar
-  attr_accessor :progressbar
+  # @return [ProgressBar] A progress bar
+  attr_accessor :progressbar
+
+  # @return [Translatomatic::Logger] create a new logger instance
+  def initialize
+    @logger = Logger.new(STDOUT)
+    @logger.level = ENV['DEBUG'] ? Logger::DEBUG : Logger::INFO
+    @logger.formatter = proc do |severity, datetime, progname, msg|
+      "#{msg}\n"
+    end
+  end
 
-  # @return [Translatomatic::Logger] create a new logger instance
-  def initialize
-    @logger = Logger.new(STDOUT)
-    @logger.level = ENV['DEBUG'] ? Logger::DEBUG : Logger::INFO
-    @logger.formatter = proc do |severity, datetime, progname, msg|
-      "#{msg}\n"
-    end
-  end
-
   # Called at the end of translatomatic to clear the progress bar.
   def finish
-    @finished ||= begin
+    @finished ||= begin
       @progressbar.finish if @progressbar
       true
-    end
-  end
+    end
+  end
 
-  private
+  private
 
   def method_missing(name, *args)
     handle_logger_method(name, args) if @logger.respond_to?(name)
   end
-
-  def handle_logger_method(name, args)
-    @progressbar.clear if @progressbar
-    @logger.send(name, *args)
-    @progressbar.refresh(force: true) if @progressbar && !@progressbar.stopped?
-  end
-
-end
+
+  def handle_logger_method(name, args)
+    @progressbar.clear if @progressbar
+    @logger.send(name, *args)
+    @progressbar.refresh(force: true) if @progressbar && !@progressbar.stopped?
+  end
+
+end

data/lib/translatomatic/model/locale.rb

@@ -1,25 +1,25 @@
-module Translatomatic
-  module Model
-    # Locale database record.
-    # Used to store translations in the database.
-    class Locale < ActiveRecord::Base
-      has_many :texts, class_name: "Translatomatic::Model::Text"
-      validates_presence_of :language
-      validates_uniqueness_of :language, scope: [:script, :region]
-
-      # Create a locale record from an I18n::Locale::Tag object or string
-      # @return [Translatomatic::Model::Locale] Locale record
-      def self.from_tag(tag)
-        tag = Translatomatic::Locale.parse(tag)
-        find_or_create_by!({
-          language: tag.language, script: tag.script, region: tag.region
-        })
-      end
-
-      # @return [String] Locale as string
-      def to_s
-        [language, script, region].compact.join("-")
-      end
-    end
-  end
-end
+module Translatomatic
+  module Model
+    # Locale database record.
+    # Used to store translations in the database.
+    class Locale < ActiveRecord::Base
+      has_many :texts, class_name: "Translatomatic::Model::Text"
+      validates_presence_of :language
+      validates_uniqueness_of :language, scope: [:script, :region]
+
+      # Create a locale record from an I18n::Locale::Tag object or string
+      # @return [Translatomatic::Model::Locale] Locale record
+      def self.from_tag(tag)
+        tag = Translatomatic::Locale.parse(tag)
+        find_or_create_by!({
+          language: tag.language, script: tag.script, region: tag.region
+        })
+      end
+
+      # @return [String] Locale as string
+      def to_s
+        [language, script, region].compact.join("-")
+      end
+    end
+  end
+end

data/lib/translatomatic/model/text.rb

@@ -1,19 +1,19 @@
-module Translatomatic
-  module Model
-    # Text database record.
-    # Used to store translations in the database.
-    class Text < ActiveRecord::Base
-      belongs_to :locale, class_name: "Translatomatic::Model::Locale"
-      belongs_to :from_text, class_name: "Translatomatic::Model::Text"
-      has_many :translations, class_name: "Translatomatic::Model::Text",
-        foreign_key: :from_text_id, dependent: :delete_all
-
-      validates_presence_of :value
-      validates_presence_of :locale
-
-      def is_translated?
-        !from_text_id.nil?
-      end
-    end
-  end
-end
+module Translatomatic
+  module Model
+    # Text database record.
+    # Used to store translations in the database.
+    class Text < ActiveRecord::Base
+      belongs_to :locale, class_name: "Translatomatic::Model::Locale"
+      belongs_to :from_text, class_name: "Translatomatic::Model::Text"
+      has_many :translations, class_name: "Translatomatic::Model::Text",
+        foreign_key: :from_text_id, dependent: :delete_all
+
+      validates_presence_of :value
+      validates_presence_of :locale
+
+      def is_translated?
+        !from_text_id.nil?
+      end
+    end
+  end
+end

data/lib/translatomatic/model.rb

@@ -1,4 +1,4 @@
-# Contains classes that interface to records in the translatomatic database
+# Contains classes that interface to records in the translatomatic database
 module Translatomatic::Model; end
 
 require 'translatomatic/model/locale'

data/lib/translatomatic/option.rb

@@ -1,4 +1,4 @@
-module Translatomatic
+module Translatomatic
   # Stores details about command line and object constructor options
   class Option
     # @return [String] Name of the option
@@ -7,12 +7,12 @@ module Translatomatic
     # @return [boolean] True if this option is required
     attr_reader :required
 
-    # @return [boolean] If true, the option can be set via an environment
-    #   variable corresponding to the uppercased version of {name}.
-    attr_reader :use_env
+    # @return [String] If set, the name of the environment variable
+    #   that can be used to set this option in the environment.
+    attr_reader :env_name
 
     # @return [String] Description of the option
-    attr_reader :description
+    attr_reader :description
 
     # @return [boolean] If true, the option does not appear on the command line
     #   but it can be used in configuration settings
@@ -25,23 +25,42 @@ module Translatomatic
     # @return [Object] The default value for this option
     attr_reader :default
 
+    # @return [boolean] True if this option can only be set on the command line
+    attr_reader :command_line_only
+
+    # @return [boolean] True if this option can only be set in user context
+    attr_reader :user_context_only
+
     # Create a new option
     # @param data [Hash<Symbol,Object>] Attributes as above
-    # @return [Translatomatic::Option] A new option instance
-    def initialize(data = {})
-      @name = data[:name]
-      @required = data[:required]
-      @use_env = data[:use_env]
+    # @return [Translatomatic::Option] A new option instance
+    def initialize(data = {})
+      @name = data[:name]
+      @required = data[:required]
       @description = data[:desc]
+      @use_env = data[:use_env]
       @hidden = data[:hidden]
+      @type = data[:type] || :string
       @default = data[:default]
-      @type = data[:type] || :string
-      @data = data
-    end
+      @aliases = data[:aliases]
+      @enum = data[:enum]
+      @user_context_only = data[:user_context_only]
+      @command_line_only = data[:command_line_only]
+      @env_name = data[:env_name] || (@use_env ? @name.to_s.upcase : nil)
+    end
 
-    # @return [Hash] Option data as a hash
-    def to_hash
-      @data
+    def to_thor
+      # use internal ',' splitting for array types on command line
+      type = @type == :array ? :string : @type
+
+      { name: @name,
+        required: @required,
+        type: type,
+        desc: @description,
+        default: @default,
+        aliases: @aliases,
+        enum: @enum ? @enum.collect { |i| i.to_s } : nil
+      }
     end
 
     # Retrieve all options from an object or list of objects.
@@ -61,29 +80,6 @@ module Translatomatic
         end
       end
       options
-    end
-  end
-
-  private
-
-  # @!visibility private
-  module DefineOptions
-
-    # @!visibility private
-    module ClassMethods
-      attr_reader :options
-
-      private
-
-      def define_options(*options)
-        @options = options.collect { |i| Translatomatic::Option.new(i) }
-      end
     end
-
-    private
-
-    def self.included(klass)
-      klass.extend(ClassMethods)
-    end
-  end
-end
+  end
+end

data/lib/translatomatic/progress_updater.rb

@@ -1,19 +1,19 @@
-# implements Converter listener
-class Translatomatic::ProgressUpdater
+# implements Converter listener
+class Translatomatic::ProgressUpdater
   # Create a new progress updater
   # @param progressbar [Progressbar] A ruby-progressbar object
-  def initialize(progressbar)
-    @progressbar = progressbar
-  end
-
+  def initialize(progressbar)
+    @progressbar = progressbar
+  end
+
   # @return [Number] the number of translated strings
-  def translated_texts(texts)
+  def translated_texts(texts)
     @progressbar.progress += texts.length
-  end
+  end
 
-  # @return [Number] the number of untranslated strings
-  def untranslated_texts(texts)
+  # @return [Number] the number of untranslated strings
+  def untranslated_texts(texts)
     @progressbar.total -= texts.length
-  end
-
-end
+  end
+
+end