localio-simonz 0.0.21.pre.2

data/lib/localio/locfile.rb

@@ -0,0 +1,65 @@
+require 'localio/module'
+
+class Locfile
+
+  # Specify the target platform for the localizables
+  #
+  # possible values
+  # :android, :ios, :rails, :json
+  dsl_accessor :platform_name, :platform_options
+
+  # Specifies the filesystem path where the generated files will be
+  dsl_accessor :output_path
+
+  # Specifies the format for the keys in the localizable file
+  #
+  # :smart - choose the formatting depending on the platform's best practices. This is the best option for multiplatform apps.
+  # :camel_case - camel case formatting (ie thisKindOfKeys)
+  # :snake_case - snake case formatting (ie this_kind_of_keys)
+  # :none - no formatting done, the keys will be used as
+  dsl_accessor :formatting
+
+  # Specify a filter that we can use for keys. It would work as "put everything except what matches with this key"
+  dsl_accessor :except
+
+  # Specify a filter that we can use for keys. It would work as "put only what matches with this key"
+  dsl_accessor :only
+
+  # Defined using 'source' ideally
+  dsl_accessor :source_service, :source_options
+
+  def initialize
+    @platform_name = nil
+    @platform_options = nil
+    @source_service = :google_drive
+    @source_path = nil
+    @source_options = nil
+    @output_path = './out/'
+    @formatting = :smart
+  end
+
+  # Defines the platform
+  #
+  # service : any of the supported ones (see above)
+  # options : hash with extra options, view documentation for the different services
+  def platform(name, options = {})
+    @platform_name = name
+    @platform_options = options
+  end
+
+  # Defines the service storing the translations
+  #
+  # service : can be :google_drive, :xls
+  # options : hash with extra options, view documentation for the different services
+  def source(service, options = {})
+    @source_service = service
+    @source_options = options
+  end
+
+  def self.load(filename)
+    dsl = new
+    dsl.instance_eval(File.read(filename), filename)
+    dsl
+  end
+
+end

data/lib/localio/module.rb

@@ -0,0 +1,15 @@
+class Module
+  def dsl_accessor(*symbols)
+    symbols.each { |sym|
+      class_eval %{
+        def #{sym}(*val)
+          if val.empty?
+            @#{sym}
+          else
+            @#{sym} = val.size == 1 ? val[0] : val
+          end
+        end
+      }
+    }
+  end
+end

data/lib/localio/processor.rb

@@ -0,0 +1,18 @@
+require 'localio/processors/google_drive_processor'
+require 'localio/processors/xls_processor'
+require 'localio/processors/xlsx_processor'
+
+module Processor
+  def self.load_localizables(platform_options, service, options)
+    case service
+      when :google_drive
+        GoogleDriveProcessor.load_localizables platform_options, options
+      when :xls
+        XlsProcessor.load_localizables platform_options, options
+      when :xlsx
+        XlsxProcessor.load_localizables platform_options, options
+      else
+        raise ArgumentError, 'Unsupported service! Try with :google_drive, :xlsx or :xls in the source argument'
+    end
+  end
+end

data/lib/localio/processors/google_drive_processor.rb

@@ -0,0 +1,105 @@
+require 'google_drive'
+require 'localio/term'
+
+class GoogleDriveProcessor
+
+  def self.load_localizables(platform_options, options)
+
+    # Parameter validations
+    spreadsheet = options[:spreadsheet]
+    raise ArgumentError, ':spreadsheet required for Google Drive source!' if spreadsheet.nil?
+
+    override_default = nil
+    override_default = platform_options[:override_default] unless platform_options.nil? or platform_options[:override_default].nil?
+
+    # Log in and get spreadsheet
+    puts 'Logging in to Google Drive...'
+    begin
+      token_file = options[:token_file] || '.localio_google_drive_token.json'
+      session = GoogleDrive.saved_session(token_file, nil, options[:client_id], options[:client_secret])
+    rescue => e
+      raise 'Couldn\'t access Google Drive. Check your client id and secret'
+    end
+    puts 'Logged in!'
+
+    matching_spreadsheets = []
+    session.spreadsheets.each do |s|
+      matching_spreadsheets << s if s.title.include? spreadsheet
+      matching_spreadsheets << s if s.key == spreadsheet
+    end
+
+    case matching_spreadsheets.count
+      when 1
+        puts 'Spreadsheet found. Analyzing...'
+      when 0
+        abort "Unable to find any spreadsheet matching your criteria: #{spreadsheet}"
+      else
+        abort 'More than one match found. You have to be more specific!'
+    end
+
+
+    # TODO we could pass a :page_index in the options hash and get that worksheet instead, defaulting to zero?
+    worksheet = matching_spreadsheets[0].worksheets[0]
+    raise 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
+
+    # At this point we have the worksheet, so we want to store all the key / values
+    first_valid_row_index = nil
+    last_valid_row_index = nil
+
+    for row in 1..worksheet.max_rows
+      first_valid_row_index = row if worksheet[row, 1].downcase == '[key]'
+      last_valid_row_index = row if worksheet[row, 1].downcase == '[end]'
+    end
+
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
+    raise IndexError, 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
+
+    languages = Hash.new('languages')
+    default_language = nil
+
+    for column in 2..worksheet.max_cols
+      col_all = worksheet[first_valid_row_index, column]
+      col_all.each_line(' ') do |col_text|
+        default_language = col_text.downcase.gsub('*','') if col_text.include? '*'
+        languages.store col_text.downcase.gsub('*',''), column unless col_text.to_s == ''
+      end
+    end
+
+    abort 'There are no language columns in the worksheet' if languages.count == 0
+
+    default_language = languages[0] if default_language.to_s == ''
+    default_language = override_default unless override_default.nil?
+
+    puts "Languages detected: #{languages.keys.join(', ')} -- using #{default_language} as default."
+
+    puts 'Building terminology in memory...'
+
+    terms = []
+    first_term_row = first_valid_row_index+1
+    last_term_row = last_valid_row_index-1
+
+    for row in first_term_row..last_term_row
+      key = worksheet[row, 1]
+      unless key.to_s == ''
+        term = Term.new(key)
+        languages.each do |lang, column_index|
+          term_text = worksheet[row, column_index]
+          term.values.store lang, term_text
+        end
+        terms << term
+      end
+    end
+
+    puts 'Loaded!'
+
+    # Return the array of terms, languages and default language
+    res = Hash.new
+    res[:segments] = terms
+    res[:languages] = languages
+    res[:default_language] = default_language
+
+    res
+  end
+
+end

data/lib/localio/processors/xls_processor.rb

@@ -0,0 +1,84 @@
+require 'spreadsheet'
+require 'localio/term'
+
+class XlsProcessor
+
+  def self.load_localizables(platform_options, options)
+
+    # Parameter validations
+    path = options[:path]
+    raise ArgumentError, ':path attribute is missing from the source, and it is required for xls spreadsheets' if path.nil?
+
+    override_default = nil
+    override_default = platform_options[:override_default] unless platform_options.nil? or platform_options[:override_default].nil?
+
+    Spreadsheet.client_encoding = 'UTF-8'
+
+    book = Spreadsheet.open path
+
+    # TODO we could pass a :page_index in the options hash and get that worksheet instead, defaulting to zero?
+    worksheet = book.worksheet 0
+    raise 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
+
+    # At this point we have the worksheet, so we want to store all the key / values
+    first_valid_row_index = nil
+    last_valid_row_index = nil
+
+    for row in 0..worksheet.row_count
+      first_valid_row_index = row if worksheet[row, 0].to_s.downcase == '[key]'
+      last_valid_row_index = row if worksheet[row, 0].to_s.downcase == '[end]'
+    end
+
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
+    raise IndexError, 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
+
+    languages = Hash.new('languages')
+    default_language = nil
+
+    for column in 1..worksheet.column_count
+      col_all = worksheet[first_valid_row_index, column].to_s
+      col_all.each_line(' ') do |col_text|
+        default_language = col_text.downcase.gsub('*','') if col_text.include? '*'
+        languages.store col_text.downcase.gsub('*',''), column unless col_text.to_s == ''
+      end
+    end
+
+    raise 'There are no language columns in the worksheet' if languages.count == 0
+
+    default_language = languages[0] if default_language.to_s == ''
+    default_language = override_default unless override_default.nil?
+
+    puts "Languages detected: #{languages.keys.join(', ')} -- using #{default_language} as default."
+
+    puts 'Building terminology in memory...'
+
+    terms = []
+    first_term_row = first_valid_row_index+1
+    last_term_row = last_valid_row_index-1
+
+    for row in first_term_row..last_term_row
+      key = worksheet[row, 0]
+      unless key.to_s == ''
+        term = Term.new(key)
+        languages.each do |lang, column_index|
+          term_text = worksheet[row, column_index]
+          term.values.store lang, term_text
+        end
+        terms << term
+      end
+    end
+
+    puts 'Loaded!'
+
+    # Return the array of terms, languages and default language
+    res = Hash.new
+    res[:segments] = terms
+    res[:languages] = languages
+    res[:default_language] = default_language
+
+    res
+
+  end
+
+end

data/lib/localio/processors/xlsx_processor.rb

@@ -0,0 +1,82 @@
+require 'simple_xlsx_reader'
+require 'localio/term'
+
+class XlsxProcessor
+
+  def self.load_localizables(platform_options, options)
+
+    # Parameter validations
+    path = options[:path]
+    raise ArgumentError, ':path attribute is missing from the source, and it is required for xlsx spreadsheets' if path.nil?
+
+    override_default = nil
+    override_default = platform_options[:override_default] unless platform_options.nil? or platform_options[:override_default].nil?
+
+    book = SimpleXlsxReader.open path
+
+    # TODO we could pass a :page_index in the options hash and get that worksheet instead, defaulting to zero?
+    worksheet = book.sheets.first
+    raise 'Unable to retrieve the first worksheet from the spreadsheet. Are there any pages?' if worksheet.nil?
+
+    # At this point we have the worksheet, so we want to store all the key / values
+    first_valid_row_index = nil
+    last_valid_row_index = nil
+        
+    for row in 1..worksheet.rows.count-1
+      first_valid_row_index = row if worksheet.rows[row][0].to_s.downcase == '[key]'
+      last_valid_row_index = row if worksheet.rows[row][0].to_s.downcase == '[end]'
+    end
+    
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the worksheet' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the worksheet' if last_valid_row_index.nil?
+    raise IndexError, 'Invalid format: [end] must not be before [key] in the A column' if first_valid_row_index > last_valid_row_index
+
+    languages = Hash.new('languages')
+    default_language = nil
+    
+    for column in 1..worksheet.rows[first_valid_row_index].count-1
+      col_all = worksheet.rows[first_valid_row_index][column].to_s
+      col_all.each_line(' ') do |col_text|
+        default_language = col_text.downcase.gsub('*','') if col_text.include? '*'
+        languages.store col_text.downcase.gsub('*',''), column unless col_text.to_s == ''
+      end
+    end
+    
+    raise 'There are no language columns in the worksheet' if languages.count == 0
+
+    default_language = languages[0] if default_language.to_s == ''
+    default_language = override_default unless override_default.nil?
+
+    puts "Languages detected: #{languages.keys.join(', ')} -- using #{default_language} as default."
+
+    puts 'Building terminology in memory...'
+
+    terms = []
+    first_term_row = first_valid_row_index+1
+    last_term_row = last_valid_row_index-1
+
+    for row in first_term_row..last_term_row
+      key = worksheet.rows[row][0]
+      unless key.to_s == ''
+        term = Term.new(key)
+        languages.each do |lang, column_index|
+          term_text = worksheet.rows[row][column_index]
+          term.values.store lang, term_text
+        end
+        terms << term
+      end
+    end
+
+    puts 'Loaded!'
+
+    # Return the array of terms, languages and default language
+    res = Hash.new
+    res[:segments] = terms
+    res[:languages] = languages
+    res[:default_language] = default_language
+
+    res
+
+  end
+
+end

data/lib/localio/segment.rb

@@ -0,0 +1,14 @@
+class Segment
+
+  attr_accessor :key, :translation, :language
+
+  def initialize(key, translation, language)
+    @key = key
+    @translation = translation.replace_escaped
+    @language = language
+  end
+
+  def is_comment?
+    @key == nil
+  end
+end

data/lib/localio/segments_list_holder.rb

@@ -0,0 +1,12 @@
+class SegmentsListHolder
+  attr_accessor :segments, :language
+
+  def initialize(language)
+    @segments = []
+    @language = language
+  end
+
+  def get_binding
+    binding
+  end
+end

data/lib/localio/string_helper.rb

@@ -0,0 +1,64 @@
+require 'rexml/text'
+
+class String
+  def self.colorize(text, color_code)
+    "\e[#{color_code}m#{text}\e[0m"
+  end
+
+  def cyan
+    self.class.colorize(self, 36)
+  end
+
+  def green
+    self.class.colorize(self, 32)
+  end
+
+  def yellow
+    self.class.colorize(self, 33)
+  end
+
+  def red
+    self.class.colorize(self, 31)
+  end
+
+  def underscore
+    self.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+        gsub(/([a-z\d])([A-Z])/, '\1_\2').
+        tr("-", "_").
+        downcase
+  end
+
+  def strip_tag
+    self.gsub(/^[\[][a-z][\]]/, '')
+  end
+
+  def space_to_underscore
+    self.gsub(' ', '_')
+  end
+  
+  def replace_escaped
+    self.gsub("`+", "+").gsub("`=","=").gsub("\\+", "+").gsub("\\=","=")
+  end
+
+  def camel_case
+    return self if self !~ /_/ && self =~ /[A-Z]+.*/
+    split('_').map{|e| e.capitalize}.join
+  end
+
+  def uncapitalize
+    self[0, 1].downcase + self[1..-1]
+  end
+
+  def blank?
+    respond_to?(:empty?) ? empty? : !self
+  end
+
+  def escape_xml
+    REXML::Text.normalize(self)
+  end
+
+  def escape_newline_and_tab
+    self.gsub(/\n/, '\n').gsub(/\t/, '\t')
+  end
+end