localio 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 37ebfdfd8bd72c867b84d975ce1f069db365fabf
-  data.tar.gz: d758c6f63079a4e3ff4c7b7e1b29dfdc93932054
+  metadata.gz: 557ff500076f77cf2d3a1c650b62892d60e92b32
+  data.tar.gz: 6d59d95e89c9d8d76cf66caebf6beb8ca5f925ca
 SHA512:
-  metadata.gz: 3ebb579abcb7071d11e5daac7df6d00c6ff85773908557067a0abaad63558c6cb8f15247813dc1f60581404a4c8e246ae4fdaeea99ed9e47b2a866f357f1f0ce
-  data.tar.gz: bd43ae7b036b857c47e8965ee4e5b0358d5162d4c3aa558d60d76f1c97a96f95e2260ffcc536621ec04744626391e8f6940901092dfdc987fa7d47aa03cad552
+  metadata.gz: 1b2feb3cc3c969f72c3ba540c83f7b38ffd81dee6499737203febc72d4e9e1a2ad4718d92a9ad6fa3e046ba951a9af653d521bab9d05aea2aa6966fb9810aa33
+  data.tar.gz: fb6bdeeb00d8586974bbebcf7a55cd809e30c9db623a11b4fe086de2a20f19817f1d9b6d54a5b6310e9ff26770fe074daa61209566c366b09ee09fac398de5da

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
 
-You have to create a custom file, Locfile, similar to Rakefile or Gemfile, with some information for this to work. Also you must have some spreadsheet with a particular format, either in Google Drive or in Excel (XLS or XLSX) format.
+You have to create a custom file, Locfile, similar to Rakefile or Gemfile, with some information for this to work. Also you must have some spreadsheet with a particular format, either in Google Drive, CSV files or in Excel (XLS or XLSX) format.
 
 In your Locfile directory you can then execute
 
@@ -45,12 +45,10 @@ A minimal `Locfile` example could be:
 ````ruby
 platform :ios
 
-output_path 'out/'
+output_path 'my_output_path/'
 
 source :xlsx,
        :path => 'my_translations.xlsx'
-
-formatting :smart # This is optional, formatting :smart is used by default.
 ````
 
 This would connect localio to your Google Drive and process the spreadsheet with title "[Localizables] My Project!".
@@ -128,11 +126,28 @@ Setting it up is a bit of a pain, although it is only required the first time an
 5. Select again the third option, **Installed Application**, and in the platform selector select the last one, **Others**.
 6. You will have all the necessary information in the next screen: Client ID and Client Secret.
 
-After doing all this, you are ready to add `:client_id` and `:client_secret` fields to your Locfile `source`.
+After doing all this, you are ready to add `:client_id` and `:client_secret` fields to your Locfile `source`. It will look somewhat like this at this stage:
+
+```ruby
+source :google_drive,
+       :spreadsheet => '[Localizables] My Project',
+       :client_id => 'XXXXXXXXX-XXXXXXXX.apps.googleusercontent.com',
+       :client_secret => 'asdFFGGhjKlzxcvbnm'
+```
 
 Then, the first time you run it, you will be prompted to follow some instructions. You will be asked to open a website, where you will be prompted for permission to use the Drive API. After you allow it, you will be given an authorization code, which you will have to paste in your terminal screen when prompted.
 
-After all this is done, you will be given in the `:access_token` in the output. Just add it to the `source` parameters, as you did with the id and secret before, and that's it. Hopefully you won't happen to repeat any of these steps for a long time.
+After all this is done, you will be given in the `:access_token` in the output. Just add it to the `source` parameters, as you did with the id and secret before, and that's it. It will look now like this:
+
+```ruby
+source :google_drive,
+       :spreadsheet => '[Localizables] My Project',
+       :client_id => 'XXXXXXXXX-XXXXXXXX.apps.googleusercontent.com',
+       :client_secret => 'asdFFGGhjKlzxcvbnm',
+       :access_token => 'ya29.RAEXXxxxxsadsadajsdhasuidhakjsdhkajhsduiahsduiasd89a8912'
+```
+
+When the Locfile contains the `:access_token`, all the login in process for generating localizables will be automatic and won't require your attention. The parameters for `:client_id` and `:client_secret` are not really needed anymore, although you could leave them there if you want.
 
 **NOTE** As it is a very bad practice to put your sensitive information in a plain file, specially when you would want to upload your project to some repository, it is **VERY RECOMMENDED** that you use environment variables in here. Ruby syntax is accepted so you can use `ENV['CLIENT_SECRET']`, `ENV['CLIENT_ID']` and `ENV['ACCESS_TOKEN']` in here.
 
@@ -180,6 +195,23 @@ source :xlsx,
        :path => 'YourExcelFileWithTranslations.xlsx'
 ````
 
+##### CSV
+
+`source :csv` will use a local CSV file. In the parameter's hash you should specify a `:path`.
+
+Option                      | Description
+----------------------------|-------------------------------------------------------------------------
+`:path`                     | (Req.) Path for your CSV file.
+`:column_separator`         | By default it is ',', but you can change it with this parameter
+
+In this example we specify tabs as separators for translation columns. The `:column_separator` is not needed if the separator is a comma and could be removed.
+
+````ruby
+source :csv,
+       :path => 'YourCSVTranslations.csv',
+       :column_separator => '\t'
+````
+
 #### Key formatters
 
 If you don't specify a formatter for keys, :smart will be used.

data/lib/localio/processor.rb

@@ -1,6 +1,7 @@
 require 'localio/processors/google_drive_processor'
 require 'localio/processors/xls_processor'
 require 'localio/processors/xlsx_processor'
+require 'localio/processors/csv_processor'
 
 module Processor
   def self.load_localizables(platform_options, service, options)
@@ -11,8 +12,10 @@ module Processor
         XlsProcessor.load_localizables platform_options, options
       when :xlsx
         XlsxProcessor.load_localizables platform_options, options
+      when :csv
+        CsvProcessor.load_localizables platform_options, options
       else
-        raise ArgumentError, 'Unsupported service! Try with :google_drive, :xlsx or :xls in the source argument'
+        raise ArgumentError, 'Unsupported service! Try with :google_drive, :csv, :xlsx or :xls in the source argument'
     end
   end
 end

data/lib/localio/processors/csv_processor.rb

@@ -0,0 +1,81 @@
+require 'csv'
+require 'localio/term'
+
+class CsvProcessor
+
+  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 CSV spreadsheets' if path.nil?
+
+    override_default = nil
+    override_default = platform_options[:override_default] unless platform_options.nil? or platform_options[:override_default].nil?
+
+    # , is the default separator; we only set this if we specified a different separator
+    separator = options[:column_separator] ||= ','
+
+    csv_file = CSV.read path, col_sep: separator
+
+    # 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..csv_file.length-1
+      first_valid_row_index = row if csv_file[row][0].to_s.downcase == '[key]'
+      last_valid_row_index = row if csv_file[row][0].to_s.downcase == '[end]'
+    end
+
+    raise IndexError, 'Invalid format: Could not find any [key] keyword in the A column of the CSV file' if first_valid_row_index.nil?
+    raise IndexError, 'Invalid format: Could not find any [end] keyword in the A column of the CSV file' 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..csv_file[first_valid_row_index].count-1
+      col_all = csv_file[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 CSV file' 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 = csv_file[row][0]
+      unless key.to_s == ''
+        term = Term.new(key)
+        languages.each do |lang, column_index|
+          term_text = csv_file[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/version.rb

@@ -1,3 +1,3 @@
 module Localio
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: localio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nacho Lopez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -145,6 +145,7 @@ files:
 - lib/localio/locfile.rb
 - lib/localio/module.rb
 - lib/localio/processor.rb
+- lib/localio/processors/csv_processor.rb
 - lib/localio/processors/google_drive_processor.rb
 - lib/localio/processors/xls_processor.rb
 - lib/localio/processors/xlsx_processor.rb