translatomatic 0.1.2 → 0.1.3

data/lib/translatomatic/resource_file/yaml.rb

@@ -1,116 +1,94 @@
-require 'yaml'
-
-module Translatomatic::ResourceFile
-  # YAML resource file
-  # @see http://www.yaml.org/
-  class YAML < Base
-
-    # (see Translatomatic::ResourceFile::Base.extensions)
-    def self.extensions
-      %w{yml yaml}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#initialize)
-    def initialize(path, locale = nil)
-      super(path, locale)
-      @valid = true
-      @data = {}
-      @properties = @path.exist? ? read : {}
-    end
-
-    # (see Translatomatic::ResourceFile::Base#locale_path)
-    # @note localization files in rails use the following file name
-    #   convention: config/locales/en.yml.
-    def locale_path(locale)
-      if path.to_s.match(/config\/locales\/[-\w]+.yml$/)
-        # rails style
-        filename = locale.to_s + path.extname
-        path.dirname + filename
-      else
-        super(locale)
-      end
-    end
-
-    # (see Translatomatic::ResourceFile::Base#set)
-    def set(key, value)
-      super(key, value)
-
-      hash = @data
-      path = key.to_s.split(/\./)
-      last_key = path.pop
-      path.each { |i| hash = (hash[i] ||= {}) }
-      hash[last_key] = value
-    end
-
-    # (see Translatomatic::ResourceFile::Base#save)
-    def save(target = path, options = {})
-      if @data
-        data = @data
-        data = data.transform_keys { locale.language } if ruby_i18n?
-        out = data.to_yaml
-        out.sub!(/^---\n/m, '')
-        out = comment(created_by) + "\n" + out unless options[:no_created_by]
-        target.write(out)
-      end
-    end
-
-    # (see Translatomatic::ResourceFile::Base#supports_variable_interpolation?)
-    def supports_variable_interpolation?
-      true
-    end
-
-    # (see Translatomatic::ResourceFile::Base#create_variable)
-    def create_variable(name)
-      return "%{#{name}}"
-    end
-
-    # (see Translatomatic::ResourceFile::Base#variable_regex)
-    def variable_regex
-      /\%\s*\{.*?\}/
-    end
-
-    private
-
-    # true if this resource file looks like a ruby i18n data file.
-    def ruby_i18n?
-      if @data && @data.length == 1
-        lang = @data.keys[0]
-        Translatomatic::Locale.new(lang).valid?
-      end
-    end
-
-    def comment(text)
-      "# #{text}\n"
-    end
-
-    def read
-      begin
-        @data = ::YAML.load_file(@path) || {}
-        flatten_data(@data)
-      rescue Exception => e
-        log.error t("resource.error", message: e.message)
-        @valid = false
-        {}
-      end
-    end
-
-    def flatten_data(data)
-      result = {}
-      unless data.kind_of?(Hash)
-        @valid = false
-        return {}
-      end
-      data.each do |key, value|
-        if value.kind_of?(Hash)
-          children = flatten_data(value)
-          children.each do |ck, cv|
-            result[key + "." + ck] = cv
-          end
-        else
-          result[key] = value
-        end
-      end
-      result
-    end
-  end
-end
+require 'yaml'
+
+module Translatomatic::ResourceFile
+  # YAML resource file
+  # @see http://www.yaml.org/
+  class YAML < Base
+
+    # (see Translatomatic::ResourceFile::Base.extensions)
+    def self.extensions
+      %w{yml yaml}
+    end
+
+    # (see Translatomatic::ResourceFile::Base.is_key_value?)
+    def self.is_key_value?
+      true
+    end
+
+    # (see Translatomatic::ResourceFile::Base.supports_variable_interpolation?)
+    def self.supports_variable_interpolation?
+      true
+    end
+
+    # (see Translatomatic::ResourceFile::Base#locale_path)
+    # @note localization files in rails use the following file name
+    #   convention: config/locales/en.yml.
+    def locale_path(locale)
+      if path.to_s.match(/config\/locales\/[-\w]+.yml$/)
+        # rails style
+        filename = locale.to_s + path.extname
+        path.dirname + filename
+      else
+        super(locale)
+      end
+    end
+
+    # (see Translatomatic::ResourceFile::Base#set)
+    def set(key, value)
+      super(key, value)
+
+      hash = @data
+      path = key.to_s.split(/\./)
+      last_key = path.pop
+      path.each { |i| hash = (hash[i] ||= {}) }
+      hash[last_key] = value
+    end
+
+    # (see Translatomatic::ResourceFile::Base#save)
+    def save(target = path, options = {})
+      if @data
+        data = @data
+        data = data.transform_keys { locale.language } if ruby_i18n?
+        out = data.to_yaml
+        out.sub!(/^---\n/m, '')
+        out = comment(created_by) + "\n" + out unless options[:no_created_by]
+        target.write(out)
+      end
+    end
+
+    # (see Translatomatic::ResourceFile::Base#create_variable)
+    def create_variable(name)
+      return "%{#{name}}"
+    end
+
+    # (see Translatomatic::ResourceFile::Base#variable_regex)
+    def variable_regex
+      /\%\s*\{.*?\}/
+    end
+
+    private
+
+    def init
+      # yaml data
+      @data = {}
+    end
+
+    def load
+      @data = ::YAML.load_file(path.to_s) || {}
+      @properties = flatten(@data)
+    end
+
+    # true if this resource file looks like a ruby i18n data file.
+    def ruby_i18n?
+      if @data && @data.length == 1
+        lang = @data.keys[0]
+        Translatomatic::Locale.new(lang).valid?
+      end
+    end
+
+    def comment(text)
+      "# #{text}\n"
+    end
+
+  end
+end

data/lib/translatomatic/resource_file.rb

@@ -1,78 +1,87 @@
-
-module Translatomatic
-  # Provides methods to create resource files of various types.
-  module ResourceFile
-    class << self
-      include Translatomatic::Util
-    end
-
-    # Load a resource file. If locale is not specified, the locale of the
-    # file will be determined from the filename, or else the current default
-    # locale will be used.
-    # @param path [String] Path to the resource file
-    # @param locale [String] Locale of the resource file
-    # @return [Translatomatic::ResourceFile::Base] The resource file, or nil
-    #   if the file type is unsupported.
-    def self.load(path, locale = nil)
-      path = path.kind_of?(Pathname) ? path : Pathname.new(path)
-      modules.each do |mod|
-        # match on entire filename to support extensions containing locales
-        if extension_match(mod, path)
-          log.debug(t("resource.loading", file: path,
-            name: mod.name.demodulize))
-          file = mod.new(path, locale)
-          return file if file.valid?
-        end
-      end
-      nil
-    end
-
-    # Find all resource files under the given directory. Follows symlinks.
-    # @param path [String, Pathname] The path to search from
-    # @return [Array<Translatomatic::ResourceFile>] Resource files found
-    def self.find(path, options = {})
-      files = []
-      include_dot_directories = options[:include_dot_directories]
-      path = Pathname.new(path) unless path.kind_of?(Pathname)
-      path.find do |file|
-        if !include_dot_directories && file.basename.to_s[0] == ?.
-          Find.prune
-        else
-          resource = load(file)
-          files << resource if resource
-        end
-      end
-      files
-    end
-
-    # Find all configured resource file classes
-    # @return [Array<Class>] Available resource file classes
-    def self.modules
-      self.constants.map { |c| self.const_get(c) }.select do |klass|
-        klass.is_a?(Class) && klass != Base
-      end
-    end
-
-    private
-
-    def self.extension_match(mod, path)
-      filename = path.basename.to_s.downcase
-      mod.extensions.each do |extension|
-        # don't match end of line in case file has locale extension
-        return true if filename.match(/\.#{extension}/)
-      end
-      false
-    end
-  end
-end
-
-require 'translatomatic/resource_file/base'
-require 'translatomatic/resource_file/yaml'
-require 'translatomatic/resource_file/properties'
-require 'translatomatic/resource_file/text'
-require 'translatomatic/resource_file/xml'
-require 'translatomatic/resource_file/html'
-require 'translatomatic/resource_file/markdown'
-require 'translatomatic/resource_file/xcode_strings'
-require 'translatomatic/resource_file/plist'
-require 'translatomatic/resource_file/resw'
+
+module Translatomatic
+  # Provides methods to create resource files of various types.
+  module ResourceFile
+    class << self
+      include Translatomatic::Util
+    end
+
+    # Load a resource file. If locale is not specified, the locale of the
+    # file will be determined from the filename, or else the current default
+    # locale will be used.
+    # @param path [String] Path to the resource file
+    # @param locale [String] Locale of the resource file
+    # @return [Translatomatic::ResourceFile::Base] The resource file, or nil
+    #   if the file type is unsupported.
+    def self.load(path, locale = nil)
+      path = path.kind_of?(Pathname) ? path : Pathname.new(path)
+      types_for_path(path).each do |klass|
+        log.debug(t("file.loading", file: path, name: klass.name.demodulize))
+        return klass.new(path, locale: locale)
+      end
+      nil
+    end
+
+    # Create a new resource file
+    def self.create(path, locale = nil)
+      klass = const_get(klass_name)
+      klass.new
+    end
+
+    # Find all resource files under the given directory. Follows symlinks.
+    # @param path [String, Pathname] The path to search from
+    # @return [Array<Translatomatic::ResourceFile>] Resource files found
+    def self.find(path, options = {})
+      files = []
+      include_dot_directories = options[:include_dot_directories]
+      path = Pathname.new(path) unless path.kind_of?(Pathname)
+      path.find do |file|
+        if !include_dot_directories && file.basename.to_s[0] == ?.
+          Find.prune
+        else
+          resource = load(file)
+          files << resource if resource
+        end
+      end
+      files
+    end
+
+    # Find all configured resource file classes
+    # @return [Array<Class>] Available resource file classes
+    def self.types
+      @types ||= self.constants.map { |c| self.const_get(c) }.select do |klass|
+        klass.is_a?(Class) && klass != Base
+      end
+    end
+
+    private
+
+    # find classes that can load the given path by file extension
+    def self.types_for_path(path)
+      path = path.kind_of?(Pathname) ? path : Pathname.new(path)
+      types.select { |klass| klass.enabled? && extension_match(klass, path) }
+    end
+
+    def self.extension_match(klass, path)
+      filename = path.basename.to_s.downcase
+      klass.extensions.each do |extension|
+        # don't match end of line in case file has locale extension
+        return true if filename.match(/\.#{extension}/)
+      end
+      false
+    end
+  end
+end
+
+require 'translatomatic/resource_file/base'
+require 'translatomatic/resource_file/yaml'
+require 'translatomatic/resource_file/properties'
+require 'translatomatic/resource_file/text'
+require 'translatomatic/resource_file/xml'
+require 'translatomatic/resource_file/html'
+require 'translatomatic/resource_file/markdown'
+require 'translatomatic/resource_file/xcode_strings'
+require 'translatomatic/resource_file/plist'
+require 'translatomatic/resource_file/resw'
+require 'translatomatic/resource_file/subtitle'
+require 'translatomatic/resource_file/csv'