locraft 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00ea80f567e4b2549c83f9d7c405207eda4d3c23
-  data.tar.gz: 86647c6f7d1980763c6f287aefb7ca220810fc5a
+  metadata.gz: 7cf55e11bdceb1841fb6634cdb0a7c542a007e84
+  data.tar.gz: 77890f235af48f9363d4f4137bf96b39ade76f6d
 SHA512:
-  metadata.gz: 5cbb931ecf45f66c6ce3191b90c51a25344a7b8b27c28b410cf63ecd6fbb805fe71a0f899dec287244ed2387deaa029ea8c08fff6c98472c9f0209a9cb2384c4
-  data.tar.gz: acd5d4ab92d6f3648a7629faa87178a47a7958925687c6a48a7a77856faf131d197aff1d1a6adf92ff87b57b18b072cdab49bcc64a1104cf9707a9e3b7b2f3d7
+  metadata.gz: 7eeb6f98a5128a0e1c841121e71ea079b8f8b0d839bb563ed22e455f1296770a0afa7c7233304c7508ec13fbeb16ddc218fba7c72bbc52b8b788abc83a47706e
+  data.tar.gz: 7e696aee22acb23c0327c507bb046c0d910f2f4ef5b4d549e9107a6d7e795cbddae27d2acf5eff4544e510a9ea7f8affec39a8aab34663f9290fe56a94f82e61

data/bin/locraft

@@ -1,4 +1,4 @@
 #!/usr/bin/env ruby
 
 require File.expand_path('../../lib/locraft', __FILE__)
-Locraft::Runner.start(ARGV)
+Locraft::Runner.start(ARGV)

data/lib/locraft/config.rb

@@ -6,7 +6,6 @@ module Locraft
   class Config
     attr_accessor :langs
     attr_accessor :default_lang
-    attr_accessor :destination_dir
     attr_accessor :gdoc_file
     attr_accessor :gdoc_sheet
     attr_accessor :gdoc_keys_column
@@ -14,17 +13,16 @@ module Locraft
     attr_accessor :dev_lang
     attr_accessor :dev_prefix
     attr_accessor :macro_file
-    attr_accessor :macro_destination_dir
+    attr_accessor :macro_destination
     attr_accessor :strings_basename
+    attr_accessor :strings_destination
     attr_accessor :info_plist_basename
+    attr_accessor :info_plist_destination
 
     # fill automatically in load_from method
     attr_accessor :from_file
 
     def initialize
-      self.info_plist_basename = 'InfoPlist'
-      self.strings_basename = 'Localizable'
-      self.destination_dir = './Localizations'
       self.default_lang = 'English'
       self.gdoc_sheet = 0
       self.gdoc_keys_column = 'Keys'
@@ -32,7 +30,11 @@ module Locraft
       self.dev_lang = OBJC
       self.dev_prefix = 'XYZ'
       self.macro_file = 'LocalizedConstants'
-      self.macro_destination_dir = './'
+      self.macro_destination = './'
+      self.strings_basename = 'Localizable'
+      self.strings_destination = './Localizations'
+      self.info_plist_basename = 'InfoPlist'
+      self.info_plist_destination = './Localizations'
       self.langs = {
         'English' => 'en',
         'Russian' => 'ru'
@@ -45,7 +47,7 @@ module Locraft
       begin
         config = eval(File.read(file), binding, 'config loading problem')
         config.from_file = file
-        return config if Config === config
+        return config if config.is_a? Config
 
         warn "[#{file}] isn't a Locraft::Config, but #{config.class}."
       rescue SyntaxError, StandardError => e
@@ -53,12 +55,16 @@ module Locraft
       end
     end
 
-    def relative_destination_dir
-      File.expand_path('../' + destination_dir, from_file)
+    def relative_strings_destination
+      File.expand_path('../' + strings_destination, from_file)
+    end
+
+    def relative_plist_destination
+      File.expand_path('../' + info_plist_destination, from_file)
     end
 
-    def relative_macro_destination_dir
-      File.expand_path('../' + macro_destination_dir, from_file)
+    def relative_macro_destination
+      File.expand_path('../' + macro_destination, from_file)
     end
 
     def strings_file

data/lib/locraft/constants_generator.rb

@@ -1,35 +1,31 @@
 require_relative 'config'
+require 'fileutils'
 
 module Locraft
   class ConstantsGenerator
+    include FileUtils
+
     OBJC_CONST_TEMPLATE_H = 'extern NSString *const __nonnull %{const};'
     OBJC_CONST_TEMPLATE_M = 'NSString *const %{const} = @"%{key}";'
     SWIFT_CONST_TEMPLATE = 'let %{const}: String = "%{key}"'
 
-    def initialize(config)
+    def initialize(config, localizations)
       @config = config
+      @localizations = localizations
     end
 
     def generate
+      destination_dir = @config.relative_macro_destination
+      mkdir_p destination_dir unless Dir.exist?(destination_dir)
       if @config.dev_lang.equal?(OBJC)
-        write_to("#{@config.relative_macro_destination_dir}/#{files_name}.h", h_file)
-        write_to("#{@config.relative_macro_destination_dir}/#{files_name}.m", m_file)
+        write_to("#{destination_dir}/#{files_name}.h", h_file)
+        write_to("#{destination_dir}/#{files_name}.m", m_file)
       else
-        write_to("#{@config.relative_macro_destination_dir}/#{files_name}.swift", swift_file)
+        write_to("#{destination_dir}/#{files_name}.swift", swift_file)
       end
-
       puts "constants files was created for [#{@config.dev_lang}] language"
     end
 
-    def strings_lines
-      File.readlines(strings_file).select { |l| l =~ /".*"\s*=\s*".*";/ }
-    end
-
-    def strings_file
-      to_add = "#{@config.langs.values.first}.lproj/#{@config.strings_file}"
-      File.join(@config.relative_destination_dir, to_add)
-    end
-
     def write_to(file, content)
       File.open(file, 'w+') do |f|
         f.puts files_header + "\n"
@@ -61,9 +57,8 @@ module Locraft
     end
 
     def constants_keys
-      strings_lines.map do |l|
-        key = l.match(/"(.*)"\s*=/)[1]
-        { key: key, const: constant_from(key) }
+      @localizations.select { |l| l.valid? }.map do |l|
+        { key: l.key, const: constant_from(l.key) }
       end
     end
 

data/lib/locraft/csv_parser.rb

@@ -1,65 +1,31 @@
 require_relative 'config'
+require_relative 'localization'
 require 'csv'
-require 'fileutils'
 
 module Locraft
   class CSVParser
-    include FileUtils
-
     def initialize(config)
       @config = config
     end
 
-    def parse_csv_file_to_strings(csv_file)
-      if File.file?(csv_file)
-        parse_csv_to_strings(File.read(csv_file))
-      else
-        warn "CSVParser ERROR: there is no such a csv_file [#{csv_file}]"
-      end
-    end
-
-    def parse_csv_to_strings(csv_body)
-      rows = csv_rows(csv_body)
-      @config.langs.keys.each do |lang|
-        lproj_dir = mkdir_for_lang(lang)
-        localizable_file = "#{lproj_dir}/#{@config.strings_file}"
-        File.write(localizable_file, parse_rows_for_lang(rows, lang))
-      end
-    end
-
     def csv_rows(body)
       csv = CSV.new(body, headers: true)
       csv.to_a.map(&:to_hash)
     end
 
-    # return strings file content
-    def parse_rows_for_lang(rows, lang)
-      content = ''
-      rows.each do |row|
-        hash = row_hash(row, lang)
-        unless hash[:key].nil?
-          content += '/* %{comment} */' % hash unless hash[:comment].nil?
-          content += %(\n"%{key}" = "%{value}";\n\n) % hash
-        end
+    # return localizations hash like #{ 'Lang' => [array of localizations] }
+    def parse_csv(csv_body)
+      rows = csv_rows(csv_body)
+      localizations_hash = {}
+      @config.langs.keys.each do |lang|
+        localizations_hash[lang] = parse_rows_for_lang(rows, lang)
       end
-      content
+      localizations_hash
     end
 
-    def row_hash(row, lang)
-      value = row[lang] || row[@config.default_lang]
-      key = row[@config.gdoc_keys_column] || row[@config.default_lang]
-      comment = row[@config.gdoc_comments_column]
-      {
-        comment: comment&.strip,
-        value: value&.strip,
-        key: key&.strip
-      }
-    end
-
-    def mkdir_for_lang(lang)
-      lproj_dir = "#{@config.relative_destination_dir}/#{@config.langs[lang]}.lproj"
-      mkdir_p lproj_dir unless Dir.exist?(lproj_dir)
-      lproj_dir
+    # return localizations array
+    def parse_rows_for_lang(rows, lang)
+      rows.map { |row| Localization.load_with_csv_row(row, @config, lang) }
     end
   end
 end

data/lib/locraft/extractor.rb

@@ -2,6 +2,7 @@ require_relative 'config'
 require_relative 'csv_parser'
 require_relative 'info_plist_generator'
 require_relative 'constants_generator'
+require_relative 'strings_generator'
 require_relative 'google_drive_wrapper'
 
 module Locraft
@@ -11,16 +12,29 @@ module Locraft
     end
 
     def extract
-      # generate localized strings files
-      csv_file = GoogleDriveWrapper.new(@config).export_worksheet
+      csv = GoogleDriveWrapper.new(@config).export_worksheet_csv
       csv_parser = CSVParser.new(@config)
-      csv_parser.parse_csv_file_to_strings(csv_file)
+      localizations_hash = csv_parser.parse_csv(csv)
+      if localizations_hash[@config.default_lang].nil?
+        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)
+      StringsGenerator.new(@config, localizations_hash).generate
+    end
 
-      # generate .plist files
-      InfoPlistGenerator.new(@config).generate
+    def generate_info_plist(localizations_hash)
+      InfoPlistGenerator.new(@config, localizations_hash).generate
+    end
 
-      # generate constants
-      ConstantsGenerator.new(@config).generate
+    def generate_constant(localizations_hash)
+      localizations = localizations_hash[@config.default_lang]
+      ConstantsGenerator.new(@config, localizations).generate
     end
   end
 end

data/lib/locraft/google_drive_wrapper.rb

@@ -14,8 +14,8 @@ module Locraft
     end
 
     def authenticate
-      mkdir_p @config.relative_destination_dir unless Dir.exist?(@config.relative_destination_dir)
-      token_file = File.join(@config.relative_destination_dir, SESSION_TOKEN_FILE)
+      mkdir_p @config.relative_strings_destination unless Dir.exist?(@config.relative_strings_destination)
+      token_file = File.join(@config.relative_strings_destination, SESSION_TOKEN_FILE)
       @session = GoogleDrive.saved_session(token_file)
     end
 
@@ -24,18 +24,28 @@ module Locraft
       @session.spreadsheet_by_title(name)
     end
 
-    # return exported file path
+    # return worksheet
     def export_worksheet
       worksheets = doc_named(@config.gdoc_file).worksheets
       if worksheets.count > @config.gdoc_sheet
-        sheet = worksheets[@config.gdoc_sheet]
-        file = File.join(@config.relative_destination_dir, EXPORTED_CSV_FILE)
-        File.delete(file) if File.exist?(file)
-        sheet.export_as_file(file)
-        file
+        worksheets[@config.gdoc_sheet]
       else
         warn 'gdrive_wrapper worksheet export error: sheet number in config out of bounds!'
       end
     end
+
+    # return exported worksheet file path
+    def export_worksheet_file
+      sheet = export_worksheet
+      file = File.join(@config.relative_strings_destination, EXPORTED_CSV_FILE)
+      File.delete(file) if File.exist?(file)
+      sheet.export_as_file(file)
+    end
+
+    # return worksheet as string in csv format
+    def export_worksheet_csv
+      worksheet = export_worksheet
+      worksheet.export_as_string
+    end
   end
 end

data/lib/locraft/info_plist_generator.rb

@@ -1,28 +1,32 @@
 require_relative 'config'
+require_relative 'localization'
+require 'fileutils'
 
 module Locraft
   class InfoPlistGenerator
-    def initialize(config)
+    include FileUtils
+
+    def initialize(config, localizations_hash)
       @config = config
+      @localizations_hash = localizations_hash
     end
 
     def generate
-      dir = @config.relative_destination_dir
-      folders = Dir.entries(dir).select { |d| d =~ /.+(.lproj)/ }.map { |d| File.join(dir, d) }
-      folders.each { |f| generate_info_plist_in_lproj(f) }
-    end
-
-    def generate_info_plist_in_lproj(folder)
-      localizable_file = File.join(folder, @config.strings_file.to_s)
-      info_file = File.join(folder, @config.info_plist_file.to_s)
-      File.write(info_file, info_plist_from(localizable_file))
-
-      puts "- #{info_file} created"
+      @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
     end
 
-    def info_plist_from(localizable_file)
-      filter = /"(?:NS|CF).*"\s*=\s*"[^;]*";/
-      File.read(localizable_file).scan(filter).join("\n")
+    def info_plist_with(localizations)
+      filter = /(NS|CF).*/
+      localizations.select { |l| l.key =~ filter }.map(&:to_line).join("\n")
     end
   end
 end

data/lib/locraft/localization.rb

@@ -0,0 +1,30 @@
+module Locraft
+  class Localization
+    attr_accessor :language
+    attr_accessor :comment
+    attr_accessor :key
+    attr_accessor :value
+
+    def self.load_with_csv_row(row, config, lang)
+      localization = Localization.new
+      localization.language = lang
+      localization.comment = row[config.gdoc_comments_column]&.strip
+      localization.key = (row[config.gdoc_keys_column] || row[config.default_lang])&.strip
+      localization.value = (row[lang] || row[config.default_lang])&.strip
+      localization
+    end
+
+    def valid?
+      !(key.nil? or value.nil?)
+    end
+
+    def to_line
+      content = ''
+      if valid?
+        content += "/* #{comment} */" unless comment.nil?
+        content += %(\n"#{key}" = "#{value}";\n)
+      end
+      content
+    end
+  end
+end

data/lib/locraft/resources/sample_locraft.config

@@ -12,7 +12,6 @@ Locraft::Config.new do |conf|
       'Russian' => 'ru'
   } # default: {'English' => 'en', 'Russian' => 'ru'}
 
-  conf.destination_dir = './Localizations' # strings destination directory related to this file, default: './Localizations'
   conf.default_lang = 'English' # default: 'English'
   conf.gdoc_sheet = 0 # default: 0
   conf.gdoc_keys_column = 'Keys' # default: 'Keys'
@@ -20,7 +19,9 @@ Locraft::Config.new do |conf|
   conf.dev_prefix = 'XYZ' # default: 'XYZ'
   conf.dev_lang = OBJC # OBJC or SWIFT, default: OBJC
   conf.macro_file = 'LocalizedConstants' # default: 'LocalizedConstants'
-  conf.macro_destination_dir = './' # default: './'
+  conf.macro_destination = './' # default: './'
   conf.strings_basename = 'Localizable' # default: 'Localizable'
+  conf.strings_destination = './Localizations' # strings destination directory related to this file, default: './Localizations'
   conf.info_plist_basename = 'InfoPlist' # default: 'InfoPlist'
+  conf.info_plist_destination = './Localizations' # info plist destination directory related to this file, default: './Localizations'
 end

data/lib/locraft/strings_generator.rb

@@ -0,0 +1,31 @@
+require_relative 'config'
+require_relative 'localization'
+require 'fileutils'
+
+module Locraft
+  class StringsGenerator
+    include FileUtils
+
+    def initialize(config, localizations_hash)
+      @config = config
+      @localizations_hash = localizations_hash
+    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}"
+        mkdir_p destination_dir unless Dir.exist?(destination_dir)
+        File.open(file, 'w+') do |f|
+          f.puts strings_file_with(localizations)
+        end
+        puts "strings file generated: [#{file}]"
+      end
+    end
+
+    def strings_file_with(localizations)
+      localizations.select { |l| l.valid? }.map(&:to_line).join("\n")
+    end
+  end
+end

data/lib/locraft.rb

@@ -1,6 +1,8 @@
 require_relative 'locraft/config'
+require_relative 'locraft/localization'
 require_relative 'locraft/initializer'
 require_relative 'locraft/runner'
 require_relative 'locraft/extractor'
 require_relative 'locraft/info_plist_generator'
 require_relative 'locraft/constants_generator'
+require_relative 'locraft/strings_generator'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locraft
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - sroik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-06 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google_drive
@@ -97,9 +97,11 @@ files:
 - lib/locraft/google_drive_wrapper.rb
 - lib/locraft/info_plist_generator.rb
 - lib/locraft/initializer.rb
+- lib/locraft/localization.rb
 - lib/locraft/resources/constants_files_header.txt
 - lib/locraft/resources/sample_locraft.config
 - lib/locraft/runner.rb
+- lib/locraft/strings_generator.rb
 homepage: https://github.com/app-craft/locraft
 licenses:
 - MIT