locraft 1.6.3 → 1.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b133e3c4682a07fe867920b1563bf10138aaa46a
-  data.tar.gz: 9e12e2fc6da98cebe44c12d292e6a0b07170de6c
+  metadata.gz: c3a26853e9771037414db3fbc19b3b7f66e5d7b1
+  data.tar.gz: 875eff16bec1b32a9aab847690b5d0938c25c924
 SHA512:
-  metadata.gz: 3ba68b5cae89e6acc8853ec89e0b0ad6c8340fe375bda63f4acd6b612e6291cb6d5feff273cb7d1e0abdc5436ef9c64abd93d9e0f2e14ffd3d33e29e7f6e38b9
-  data.tar.gz: 9b2a6f3e51c10469a501cf50a69187e76f74a00996507883a234c2d83084470758d7068c1b79940028c80d12326b828b498f85a65679ff8aa67c9bbe4859b419
+  metadata.gz: 7a38009a9f27c52a9282ba41b506b1705a45f3c700df9e3c767bd1b5bf8caa0403a22da0e13436c662dc40d1d1141786373f4ead5e9e20f4904e0faea85814a7
+  data.tar.gz: dd476e7d00b6774875b42eec7a1c6acce98baf22555436395cbe7486da41077fca2f4f8a3858cbc886cef4ab33d93fc7472c7b33b99a240890581f3fee787d59

data/lib/locraft/csv_parser.rb

@@ -1,5 +1,5 @@
-require_relative 'config'
-require_relative 'localization'
+require_relative 'model/config'
+require_relative 'model/localization'
 require 'csv'
 
 module Locraft

data/lib/locraft/extractor.rb

@@ -1,8 +1,5 @@
-require_relative 'config'
+require_relative 'model/config'
 require_relative 'csv_parser'
-require_relative 'generators/info_plist_generator'
-require_relative 'generators/constants_generator'
-require_relative 'generators/strings_generator'
 require_relative 'google_drive_wrapper'
 
 module Locraft
@@ -19,28 +16,12 @@ module Locraft
         warn 'extract ERROR: no localizations given'
       else
         generate_strings(localizations_hash)
-        generate_info_plist(localizations_hash)
-        generate_constant(localizations_hash)
       end
     end
 
     def generate_strings(localizations_hash)
-      return if @config.strings_destination.nil?
-      StringsGenerator.new(@config, localizations_hash).generate
-    end
-
-    def generate_info_plist(localizations_hash)
-      return if @config.info_plist_destination.nil?
-      InfoPlistGenerator.new(@config, localizations_hash).generate
-    end
-
-    def generate_constant(localizations_hash)
-      return if @config.macro_destination.nil?
-      localizations = localizations_hash[@config.default_lang]
-      if @config.dev_lang.equal? OBJC
-        ObjcConstantsGenerator.new(@config, localizations).generate
-      else
-        SwiftConstantsGenerator.new(@config, localizations).generate
+      @config.strings_generators.each do |generator|
+        generator.generate(localizations_hash)
       end
     end
   end

data/lib/locraft/generators/constants_generator.rb

@@ -1,19 +1,12 @@
-require_relative '../config'
+require_relative '../model/config'
+require_relative '../utils'
+require_relative 'generator'
 require 'fileutils'
 
 module Locraft
-  class ConstantsGenerator
+  class ConstantsGenerator < Generator
     include FileUtils
 
-    def initialize(config, localizations)
-      @config = config
-      @localizations = localizations
-    end
-
-    def generate
-      raise NotImplementedError
-    end
-
     def write_file_content(file, content)
       File.open(file, 'w+') do |f|
         f.puts files_header + "\n"
@@ -25,8 +18,8 @@ module Locraft
       @config.dev_prefix + @config.macro_file
     end
 
-    def constants_keys
-      @localizations.select(&:valid?).map do |l|
+    def constants_keys_with(localizations)
+      localizations.select(&:valid?).map do |l|
         { key: l.key, const: constant_from(l.key) }
       end
     end
@@ -36,11 +29,7 @@ module Locraft
     end
 
     def files_header
-      resource_file('macro_files_header.txt')
-    end
-
-    def resource_file(file)
-      File.read(File.expand_path("../../resources/#{file}", __FILE__))
+      Utils.resource_file('macro_files_header.txt')
     end
   end
 end

data/lib/locraft/generators/generator.rb

@@ -0,0 +1,16 @@
+module Locraft
+  class Generator
+    def initialize(config)
+      @config = config
+    end
+
+    def valid?
+      raise NotImplementedError
+    end
+
+    # @param [{ String => [Localization]}] _ # localizations hash like #{ 'Lang' => [array of localizations] }
+    def generate(_)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/locraft/generators/info_plist_generator.rb

@@ -1,32 +1,25 @@
-require_relative '../config'
-require_relative '../localization'
-require 'fileutils'
+require_relative 'strings_generator'
 
 module Locraft
-  class InfoPlistGenerator
-    include FileUtils
+  class InfoPlistGenerator < StringsGenerator
+    def valid?
+      !@config.relative_plist_destination.nil?
+    end
+
+    def destination_dir_for(lang)
+      "#{@config.relative_plist_destination}/#{lang}.lproj"
+    end
 
-    def initialize(config, localizations_hash)
-      @config = config
-      @localizations_hash = localizations_hash
+    def valid_localization?(l)
+      l.valid? && l.key =~ /^(NS|CF).*/
     end
 
-    def generate
-      @config.langs.each do |lang, val|
-        localizations = @localizations_hash[lang]
-        destination_dir = "#{@config.relative_plist_destination}/#{val}.lproj"
-        file = "#{destination_dir}/#{@config.info_plist_file}"
-        mkdir_p destination_dir unless Dir.exist?(destination_dir)
-        File.open(file, 'w+') do |f|
-          f.puts info_plist_with(localizations)
-        end
-        puts "info plist generated: [#{file}]"
-      end
+    def strings_file
+      @config.info_plist_file
     end
 
-    def info_plist_with(localizations)
-      filter = /(NS|CF).*/
-      localizations.select { |l| l.key =~ filter }.map(&:to_line).join("\n")
+    def broadcast_file_generation(f)
+      puts "info plist strings file generated: [#{f}]"
     end
   end
 end

data/lib/locraft/generators/objc_constants_generator.rb

@@ -5,23 +5,28 @@ module Locraft
     OBJC_CONST_TEMPLATE_H = 'extern NSString *const __nonnull %<const>s;'.freeze
     OBJC_CONST_TEMPLATE_M = 'NSString *const %<const>s = @"%<key>s";'.freeze
 
-    def generate
+    def valid?
+      !@config.relative_macro_destination.nil?
+    end
+
+    def generate(localizations_hash)
+      localizations = localizations_hash[@config.default_lang]
       destination_dir = @config.relative_macro_destination
       mkdir_p destination_dir unless Dir.exist?(destination_dir)
-      write_file_content("#{destination_dir}/#{files_name}.h", h_file)
-      write_file_content("#{destination_dir}/#{files_name}.m", m_file)
+      write_file_content("#{destination_dir}/#{files_name}.h", h_file(localizations))
+      write_file_content("#{destination_dir}/#{files_name}.m", m_file(localizations))
       puts 'constants files was created for [objc] language'
     end
 
-    def m_file
+    def m_file(localizations)
       content = %(#import "#{files_name}.h"\n\n)
-      content += constants_keys.map { |d| OBJC_CONST_TEMPLATE_M % d }.join("\n")
-      resource_file('objc_m_macro_template.txt') % content
+      content += constants_keys_with(localizations).map { |d| OBJC_CONST_TEMPLATE_M % d }.join("\n")
+      Utils.resource_file('objc_m_macro_template.txt') % content
     end
 
-    def h_file
-      content = constants_keys.map { |d| OBJC_CONST_TEMPLATE_H % d }.join("\n")
-      resource_file('objc_h_macro_template.txt') % content
+    def h_file(localizations)
+      content = constants_keys_with(localizations).map { |d| OBJC_CONST_TEMPLATE_H % d }.join("\n")
+      Utils.resource_file('objc_h_macro_template.txt') % content
     end
 
     def constant_from(key)

data/lib/locraft/generators/strings_generator.rb

@@ -1,31 +1,58 @@
-require_relative '../config'
-require_relative '../localization'
+require_relative '../model/config'
+require_relative '../model/localization'
+require_relative '../utils'
+require_relative 'generator'
 require 'fileutils'
 
 module Locraft
-  class StringsGenerator
+  class StringsGenerator < Generator
     include FileUtils
 
-    def initialize(config, localizations_hash)
-      @config = config
-      @localizations_hash = localizations_hash
+    def valid?
+      !@config.relative_strings_destination.nil?
     end
 
-    def generate
-      @config.langs.each do |lang, val|
-        localizations = @localizations_hash[lang]
-        destination_dir = "#{@config.relative_strings_destination}/#{val}.lproj"
-        file = "#{destination_dir}/#{@config.strings_file}"
+    def generate(localizations_hash)
+      @config.langs.each do |lang, lang_code|
+        localizations = localizations_hash[lang].select { |l| valid_localization?(l) }
+        destination_dir = destination_dir_for(lang_code)
+        file = "#{destination_dir}/#{strings_file}"
         mkdir_p destination_dir unless Dir.exist?(destination_dir)
         File.open(file, 'w+') do |f|
-          f.puts strings_file_with(localizations)
+          f.puts file_template % strings_file_content(localizations)
         end
-        puts "strings file generated: [#{file}]"
+        broadcast_file_generation(file)
       end
     end
 
-    def strings_file_with(localizations)
-      localizations.select(&:valid?).map(&:to_line).join("\n")
+    def broadcast_file_generation(f)
+      puts "strings file generated: [#{f}]"
+    end
+
+    def valid_localization?(l)
+      l.valid?
+    end
+
+    def file_template
+      Utils.resource_file('strings_template.txt')
+    end
+
+    def destination_dir_for(lang)
+      "#{@config.relative_strings_destination}/#{lang}.lproj"
+    end
+
+    def strings_file
+      @config.strings_file
+    end
+
+    def strings_file_content(localizations)
+      localizations.select(&:valid?).map { |l| strings_line_with(l) }.join("\n")
+    end
+
+    def strings_line_with(localization)
+      content = ''
+      content += "/* #{localization.comment} */" unless localization.comment.nil?
+      content + %(\n"#{localization.key}" = "#{localization.strict_value}";\n)
     end
   end
 end

data/lib/locraft/generators/swift_constants_generator.rb

@@ -2,16 +2,27 @@ require_relative 'constants_generator'
 
 module Locraft
   class SwiftConstantsGenerator < ConstantsGenerator
-    def generate
+    def valid?
+      !@config.relative_macro_destination.nil?
+    end
+
+    def generate(localizations_hash)
+      if @config.relative_plist_destination.nil?
+        warn 'Skipping objc constants generation. No destination path provided.'
+        return
+      end
+
+      localizations = localizations_hash[@config.default_lang]
       destination_dir = @config.relative_macro_destination
+      file_content = file_content(localizations)
       mkdir_p destination_dir unless Dir.exist?(destination_dir)
-      write_file_content("#{destination_dir}/#{files_name}.swift", file)
+      write_file_content("#{destination_dir}/#{files_name}.swift", file_content)
       puts 'constants files was created for [swift] language'
     end
 
-    def file
-      content = constants_keys.map { |d| const_template % d }.join("\n")
-      resource_file('swift_macro_template.txt') % content
+    def file_content(localizations)
+      content = constants_keys_with(localizations).map { |d| const_template % d }.join("\n")
+      Utils.resource_file('swift_macro_template.txt') % content
     end
 
     def const_template

data/lib/locraft/generators/xml_strings_generator.rb

@@ -0,0 +1,22 @@
+require_relative 'strings_generator'
+
+module Locraft
+  class XMLStringsGenerator < StringsGenerator
+    def file_template
+      Utils.resource_file('xml_strings_template.txt')
+    end
+
+    def destination_dir_for(lang)
+      "#{@config.relative_strings_destination}/values-#{lang}"
+    end
+
+    def strings_line_with(localization)
+      xml_value = localization.strict_value.gsub('%@', '%s')
+      %(<string name="#{localization.key}">#{xml_value}</string>\n)
+    end
+
+    def broadcast_file_generation(f)
+      puts "xml strings file generated: [#{f}]"
+    end
+  end
+end

data/lib/locraft/google_drive_wrapper.rb

@@ -1,4 +1,4 @@
-require_relative 'config'
+require_relative 'model/config'
 require 'google_drive'
 require 'fileutils'
 

data/lib/locraft/{config.rb → model/config.rb}

@@ -1,24 +1,25 @@
 module Locraft
-  STRINGS_EXTENSION = '.strings'.freeze
+  IOS = 'iOS'.freeze
+  ANDROID = 'android'.freeze
+
   SWIFT = 'swift'.freeze
   OBJC = 'objc'.freeze
+  JAVA = 'java'.freeze
+
+  STRINGS_EXT = '.strings'.freeze
+  XML_EXT = '.xml'.freeze
 
   class Config
+    attr_accessor :platform
     attr_accessor :gdoc_file
-    attr_accessor :info_plist_destination
-    attr_accessor :macro_destination
     attr_accessor :strings_destination
+    attr_accessor :strings_basename
     attr_accessor :langs
     attr_accessor :default_lang
     attr_accessor :gdoc_sheet
     attr_accessor :gdoc_keys_column
     attr_accessor :gdoc_comments_column
-    attr_accessor :dev_lang
-    attr_accessor :dev_prefix
     attr_accessor :keys_map
-    attr_accessor :macro_file
-    attr_accessor :strings_basename
-    attr_accessor :info_plist_basename
 
     # fill automatically in load_from method
     attr_accessor :from_file
@@ -28,12 +29,8 @@ module Locraft
       self.gdoc_sheet = 0
       self.gdoc_keys_column = 'Keys'
       self.gdoc_comments_column = 'Comments'
-      self.dev_lang = OBJC
-      self.dev_prefix = 'XYZ'
       self.keys_map = {}
-      self.macro_file = 'LocalizedConstants'
       self.strings_basename = 'Localizable'
-      self.info_plist_basename = 'InfoPlist'
       self.langs = {
         'English' => 'en',
         'Russian' => 'ru'
@@ -62,20 +59,83 @@ module Locraft
       File.expand_path('../' + strings_destination, from_file)
     end
 
+    def strings_file
+      raise NotImplementedError
+    end
+
+    def strings_generators
+      raise NotImplementedError
+    end
+  end
+
+  class IOSConfig < Config
+    attr_accessor :info_plist_destination
+    attr_accessor :info_plist_basename
+    attr_accessor :macro_destination
+    attr_accessor :dev_lang
+    attr_accessor :dev_prefix
+    attr_accessor :keys_map
+    attr_accessor :macro_file
+
+    def initialize
+      super()
+      self.platform = IOS
+      self.dev_lang = OBJC
+      self.dev_prefix = 'XYZ'
+      self.macro_file = 'LocalizedConstants'
+      self.info_plist_basename = 'InfoPlist'
+      yield self if block_given?
+    end
+
     def relative_plist_destination
+      return nil if info_plist_destination.nil?
       File.expand_path('../' + info_plist_destination, from_file)
     end
 
     def relative_macro_destination
+      return nil if macro_destination.nil?
       File.expand_path('../' + macro_destination, from_file)
     end
 
     def strings_file
-      "#{strings_basename}#{STRINGS_EXTENSION}"
+      "#{strings_basename}#{STRINGS_EXT}"
     end
 
     def info_plist_file
-      "#{info_plist_basename}#{STRINGS_EXTENSION}"
+      "#{info_plist_basename}#{STRINGS_EXT}"
+    end
+
+    def strings_generators
+      [StringsGenerator.new(self), info_plist_generator, constants_generator].select(&:valid?)
+    end
+
+    def info_plist_generator
+      InfoPlistGenerator.new(self)
+    end
+
+    def constants_generator
+      if dev_lang == SWIFT
+        SwiftConstantsGenerator.new(self)
+      elsif dev_lang == OBJC
+        ObjcConstantsGenerator.new(self)
+      end
+    end
+  end
+
+  class AndroidConfig < Config
+    def initialize
+      super()
+      self.platform = ANDROID
+      self.strings_basename = 'strings'
+      yield self if block_given?
+    end
+
+    def strings_file
+      "#{strings_basename}#{XML_EXT}"
+    end
+
+    def strings_generators
+      [XMLStringsGenerator.new(self)]
     end
   end
 end

data/lib/locraft/{localization.rb → model/localization.rb}

@@ -19,13 +19,8 @@ module Locraft
       !(key.nil? or value.nil?)
     end
 
-    def to_line
-      content = ''
-      if valid?
-        content += "/* #{comment} */" unless comment.nil?
-        content += %(\n"#{key}" = "#{value.gsub("\n", "\\n") }";\n)
-      end
-      content
+    def strict_value
+      value.gsub("\n", "\\n")
     end
   end
 end

data/lib/locraft/resources/sample_locraft.config

@@ -1,4 +1,4 @@
-Locraft::Config.new do |conf|
+Locraft::IOSConfig.new do |conf|
   ############
   # @!required
   ############

data/lib/locraft/resources/strings_template.txt

@@ -0,0 +1 @@
+%s

data/lib/locraft/resources/xml_strings_template.txt

@@ -0,0 +1,3 @@
+<resources>
+    %s
+</resources>

data/lib/locraft/utils.rb

@@ -0,0 +1,9 @@
+require 'fileutils'
+
+module Locraft
+  module Utils
+    def self.resource_file(file)
+      File.read(File.expand_path("../resources/#{file}", __FILE__))
+    end
+  end
+end

data/lib/locraft/version.rb

@@ -1,3 +1,3 @@
 module Locraft
-  VERSION = '1.6.3'.freeze
+  VERSION = '1.6.4'.freeze
 end

data/lib/locraft.rb

@@ -1,5 +1,5 @@
-require_relative 'locraft/config'
-require_relative 'locraft/localization'
+require_relative 'locraft/model/config'
+require_relative 'locraft/model/localization'
 require_relative 'locraft/initializer'
 require_relative 'locraft/runner'
 require_relative 'locraft/extractor'
@@ -8,3 +8,4 @@ require_relative 'locraft/generators/constants_generator'
 require_relative 'locraft/generators/swift_constants_generator'
 require_relative 'locraft/generators/objc_constants_generator'
 require_relative 'locraft/generators/strings_generator'
+require_relative 'locraft/generators/xml_strings_generator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locraft
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 1.6.4
 platform: ruby
 authors:
 - sroik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-20 00:00:00.000000000 Z
+date: 2018-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -118,23 +118,28 @@ extra_rdoc_files: []
 files:
 - bin/locraft
 - lib/locraft.rb
-- lib/locraft/config.rb
 - lib/locraft/csv_parser.rb
 - lib/locraft/extractor.rb
 - lib/locraft/generators/constants_generator.rb
+- lib/locraft/generators/generator.rb
 - lib/locraft/generators/info_plist_generator.rb
 - lib/locraft/generators/objc_constants_generator.rb
 - lib/locraft/generators/strings_generator.rb
 - lib/locraft/generators/swift_constants_generator.rb
+- lib/locraft/generators/xml_strings_generator.rb
 - lib/locraft/google_drive_wrapper.rb
 - lib/locraft/initializer.rb
-- lib/locraft/localization.rb
+- lib/locraft/model/config.rb
+- lib/locraft/model/localization.rb
 - lib/locraft/resources/macro_files_header.txt
 - lib/locraft/resources/objc_h_macro_template.txt
 - lib/locraft/resources/objc_m_macro_template.txt
 - lib/locraft/resources/sample_locraft.config
+- lib/locraft/resources/strings_template.txt
 - lib/locraft/resources/swift_macro_template.txt
+- lib/locraft/resources/xml_strings_template.txt
 - lib/locraft/runner.rb
+- lib/locraft/utils.rb
 - lib/locraft/version.rb
 homepage: https://github.com/app-craft/locraft
 licenses: