csv2strings 0.2.1 → 0.2.2

data/.gitignore

@@ -1,11 +1,27 @@
+# Generated files
 *.csv
 *.strings
 *.lproj
-.rbenv-version
+*.gem
 *~
 *#
-*.gem
-*.sublime-project
 #*#
+
+# Config file
 .csvconverter
-coverage
+
+# SimpleCov
+coverage
+
+# ignore Gemfile.lock as http://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+# this should solve the fastercsv issue
+Gemfile.lock
+
+# Ruby package manager files
+.ruby-version
+.rbenv-version
+.rvmrc
+
+# Sublime Text
+*.sublime-workspace
+*.sublime-project

data/.travis.yml

@@ -1,6 +1,14 @@
 language: ruby
 rvm:
-  - 1.9.3
-  - 1.9.2
-  - 1.8.7
-  - 2.0.0
+- 1.9.3
+- 1.9.2
+- 1.8.7
+- 2.0.0
+deploy:
+  provider: rubygems
+  api_key:
+    secure: Xjq+v+jEU6wK4BtyfnV1elegNcxK6Ah/O99Sn9c2IlkCmJ1wxLBouqzEiSorSJ4IOMa5H2y3gwo5GXOr6Y7d8huyGrPuBeCSGqAmH77wNCIv7G+jnLiYb1sRZbtKcPW2QaN6JF81qDIelwyspMfo6/ug1qN1x323UaxZl7f7nUE=
+  gem: csv2strings
+  on:
+    tags: true
+    repo: netbe/CSV-to-iOS-Localizable.strings-converter

data/Gemfile

@@ -1,4 +1,8 @@
 source "http://rubygems.org"
 
 # Specify your gem's dependencies in teachmehowtomakearubygem.gemspec
-gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false, :platforms => [:ruby_19, :ruby_20]
+end

data/README.md

@@ -1,5 +1,6 @@
 [![Build Status](https://secure.travis-ci.org/netbe/CSV-to-iOS-Localizable.strings-converter.png?branch=master)](http://travis-ci.org/netbe/CSV-to-iOS-Localizable.strings-converter)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/netbe/CSV-to-iOS-Localizable.strings-converter)
+[![Coverage Status](https://coveralls.io/repos/netbe/CSV-to-iOS-Localizable.strings-converter/badge.png)](https://coveralls.io/r/netbe/CSV-to-iOS-Localizable.strings-converter)
 # Introduction
 This script converts a csv file of translations into iOS .strings files and vice-versa.
 
@@ -33,10 +34,6 @@ Edge version can be found on `develop` branch.
 
 Run `bundle install` to install all the dependencies. Tests are done with `Test::Unit` so run `rake test` to run all the test suite.
 
-# Todo
+# Todo & Known issues
 
-See GitHub isssues
-
-# Known issues
-
-None
+See GitHub issues

data/Rakefile

@@ -2,8 +2,10 @@ require 'rake/testtask'
 
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/csvconverter/**/test_*.rb']
+  # t.warning = true
+  t.verbose = true
 end
 
 desc "Run tests"
-task :default => :test
+task :default => :test

data/bin/csv2strings

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path('../../lib/csv2strings_command', __FILE__)
-
+$: << File.expand_path("../lib/", __FILE__)
+require 'csvconverter/commands/csv2strings_command'
 
 CSV2StringsCommand.start

data/bin/strings2csv

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-require File.expand_path('../../lib/strings2csv_command', __FILE__)
-
+$: << File.expand_path("../lib/", __FILE__)
+require 'csvconverter/commands/strings2csv_command'
 
 Strings2CSVCommand.start

data/csv2strings.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'csv2strings'
-  s.version     = '0.2.1'
-  s.date        = '2013-10-15'
+  s.version     = '0.2.2'
+  s.date        = '2013-10-30'
   s.summary     = "CSV to iOS Localizable.strings converter"
   s.description = "ruby script converts a CSV file of translations to Localizable.strings files and vice-versa"
   s.authors     = ["François Benaiteau"]
@@ -14,8 +14,10 @@ Gem::Specification.new do |s|
 
   if RUBY_VERSION < '1.9'
     s.add_dependency "fastercsv"
+    s.add_dependency "nokogiri", "= 1.5.10"
+    s.add_dependency "orderedhash"
   end
-  s.add_dependency "nokogiri", "= 1.5.10"
+
   s.add_dependency "google_drive", '0.3.6'
   s.add_development_dependency "rake"
 

data/lib/csvconverter.rb

@@ -1,16 +1,21 @@
-$: << File.expand_path(File.join(File.dirname(__FILE__)))
-require 'rubygems'
-
 CSVGEM = RUBY_VERSION.match(/^[0-1]\.[0-8]\./) ? 'faster_csv' : 'csv'
 
+if RUBY_VERSION.match(/^[0-1]\.[0-8]\./)
+  require "orderedhash"
+  ORDERED_HASH_CLASS = OrderedHash
+else
+  ORDERED_HASH_CLASS = Hash
+end
+
 begin
 	require CSVGEM
 rescue LoadError
 	puts "Failed to load #{CSVGEM} (ruby #{RUBY_VERSION})"
 	puts "gem install #{CSVGEM}"
-	exit
+	abort
 end
 
 CSVParserClass = CSVGEM == 'csv' ? CSV : FasterCSV
-require "csv2strings/converter"
-require "strings2csv/converter"
+require "csvconverter/csv2strings"
+require "csvconverter/strings2csv"
+require "csvconverter/google_doc"

data/lib/{command.rb → csvconverter/command.rb}

@@ -1,8 +1,5 @@
-$: << File.expand_path(File.join(File.dirname(__FILE__)))
 require 'yaml'
 require 'thor'
-require 'csvconverter'
-require 'google_doc'
 
 class Command < Thor
   include Thor::Actions

data/lib/{csv2strings_command.rb → csvconverter/commands/csv2strings_command.rb}

@@ -1,5 +1,4 @@
-$: << File.expand_path(File.join(File.dirname(__FILE__)))
-require "command"
+require "csvconverter/command"
 class CSV2StringsCommand < Command
   default_task :csv2strings
 
@@ -20,7 +19,7 @@ class CSV2StringsCommand < Command
       help("csv2strings")
       exit
     end
-    
+
     filename ||= options['filename']
     if options['fetch']
       say "Downloading file from Google Drive"
@@ -33,12 +32,12 @@ class CSV2StringsCommand < Command
       help("csv2strings")
       exit
     end
- 
+
     args = options.dup
     args.delete(:langs)
     args.delete(:filename)
-    converter = CSV2Strings::Converter.new(filename, options[:langs], args)
-    say converter.csv_to_dotstrings    
+    converter = CSV2Strings.new(filename, options[:langs], args)
+    say converter.csv_to_dotstrings
   end
 
 end

data/lib/{strings2csv_command.rb → csvconverter/commands/strings2csv_command.rb}

@@ -1,6 +1,4 @@
-$: << File.expand_path(File.join(File.dirname(__FILE__)))
-require "command"
-
+require "csvconverter/command"
 class Strings2CSVCommand < Command
   default_task :strings2csv
 
@@ -15,10 +13,10 @@ class Strings2CSVCommand < Command
     unless options.has_key?('filenames')
       say "No value provided for required options '--filenames'"
       help("strings2csv")
-      exit
+      return
     end
-    converter = Strings2CSV::Converter.new(options)
+    converter = Strings2CSV.new(options)
   	debug_values = converter.dotstrings_to_csv(!options[:dryrun])
-    say debug_values.inspect if options[:dryrun]   
+    say debug_values.inspect if options[:dryrun]
   end
-end
+end

data/lib/csvconverter/csv2strings.rb

@@ -0,0 +1,132 @@
+class CSV2Strings
+	attr_accessor :csv_filename, :output_file
+	attr_accessor :langs, :default_lang
+	attr_accessor :default_path
+	attr_accessor :excluded_states, :state_column, :keys_column
+
+
+	def initialize(filename, langs, args = {})
+		args.merge!({
+		 :excluded_states => [],
+		 :state_column => nil,
+		 :keys_column => 0})
+
+		@csv_filename = filename
+		@langs = langs
+
+		if !@langs.is_a?(Hash) || @langs.size == 0
+			raise "wrong format or/and languages parameter" + @langs.inspect
+		end
+		@output_file = (@langs.size == 1) ? args[:output_file] : nil
+
+		@default_path = args[:default_path].to_s
+		@excluded_states = args[:excluded_states]
+		@state_column = args[:state_column]
+		@keys_column = args[:keys_column]
+		@default_lang = args[:default_lang]
+	end
+
+	def create_file_from_path(file_path)
+		path = File.dirname(file_path)
+		FileUtils.mkdir_p path
+		return File.new(file_path,"w")
+	end
+
+	def process_header(excludedCols, files, row, index)
+		files[index] = []
+		lang_index = row[index]
+
+		# create output files here
+		if @output_file
+			# one single file
+			files[index] << self.create_file_from_path(@output_file)
+		else
+			# create one file for each languages
+			if self.langs[lang_index].is_a?(Array)
+
+				self.langs[lang_index].each do |locale|
+					filename = self.file_path_for_locale(locale)
+					files[index] << self.create_file_from_path(filename)
+				end
+			elsif self.langs[lang_index].is_a?(String)
+				locale = self.langs[lang_index]
+				filename = self.file_path_for_locale(locale)
+				files[index] << self.create_file_from_path(filename)
+			else
+				raise "wrong format or/and languages parameter"
+			end
+
+		end
+	end
+
+	def file_path_for_locale(locale)
+		require 'pathname'
+		Pathname.new(self.default_path) + "#{locale}.lproj" + "Localizable.strings"
+	end
+
+	def process_value(row_value, default_value)
+		value = row_value.nil? ? default_value : row_value
+		value = "" if value.nil?
+		value.gsub!(/\\*\"/, "\\\"") #escape double quotes
+		value.gsub!(/\s*(\n|\\\s*n)\s*/, "\\n") #replace new lines with \n + strip
+		value.gsub!(/%\s+([a-zA-Z@])([^a-zA-Z@]|$)/, "%\\1\\2") #repair string formats ("% d points" etc)
+		value.gsub!(/([^0-9\s\(\{\[^])%/, "\\1 %")
+			value.strip!
+			return value
+		end
+
+	# Convert csv file to multiple Localizable.strings files for each column
+	def csv_to_dotstrings(name = self.csv_filename)
+		files        = {}
+		rowIndex     = 0
+		excludedCols = []
+		defaultCol   = 0
+		nb_translations = 0
+
+		CSVParserClass.foreach(name, :quote_char => '"', :col_sep =>',', :row_sep => :auto) do |row|
+
+			if rowIndex == 0
+				return unless row.count > 1 #check there's at least two columns
+			else
+				next if row == nil or row[self.keys_column].nil? #skip empty lines (or sections)
+			end
+
+			row.size.times do |i|
+				next if excludedCols.include? i
+				if rowIndex == 0 #header
+					# ignore all headers not listed in langs to create files
+					(excludedCols << i and next) unless self.langs.has_key?(row[i])
+					self.process_header(excludedCols, files, row, i)
+					# define defaultCol
+					defaultCol = i if self.default_lang == row[i]
+				elsif !self.state_column || (row[self.state_column].nil? or row[self.state_column] == '' or !self.excluded_states.include? row[self.state_column])
+					# TODO: add option to strip the constant or referenced language
+					key = row[self.keys_column].strip
+					value = self.process_value(row[i], row[defaultCol])
+					# files for a given language, i.e could group english US with english UK.
+					localized_files = files[i]
+					if localized_files
+						localized_files.each do |file|
+							nb_translations += 1
+							file.write "\"#{key}\" = \"#{value}\";\n"
+						end
+					end
+				end
+			end
+			rowIndex += 1
+		end
+		info = "Created #{files.size} files. Content: #{nb_translations} translations\n"
+		info += "List of created files:\n"
+
+		# closing I/O
+		files.each do |key,locale_files|
+			locale_files.each do |file|
+				info += "#{file.path.to_s}\n"
+				file.close
+			end
+		end
+		info
+	end # end of method
+
+end # end of class
+

data/lib/{google_doc.rb → csvconverter/google_doc.rb}

@@ -1,4 +1,13 @@
-require "google_drive"
+# Faraday is a dependency of google_drive, this silents the warning
+# see https://github.com/CocoaPods/CocoaPods/commit/f33f967427b857bf73645fd4d3f19eb05e9be0e0
+# This is to make sure Faraday doesn't warn the user about the `system_timer` gem missing.
+old_warn, $-w = $-w, nil
+begin
+  require "google_drive"
+ensure
+  $-w = old_warn
+end
+
 class GoogleDoc
   attr_accessor :session
 
@@ -11,9 +20,9 @@ class GoogleDoc
     unless @session
       self.authenticate
     end
-    result = @session.file_by_title(requested_filename)   
+    result = @session.file_by_title(requested_filename)
     if result.is_a? Array
-      file = result.first      
+      file = result.first
     else
       file = result
     end
@@ -22,4 +31,4 @@ class GoogleDoc
     return output_filename
   end
 
-end
+end

data/lib/csvconverter/strings2csv.rb

@@ -0,0 +1,96 @@
+class Strings2CSV
+  # default_lang is the the column to refer to if a value is missing
+  # actually default_lang = default_filename
+  attr_accessor :csv_filename, :headers, :filenames, :default_lang
+
+  def initialize(args = {:filenames => []})
+    raise ArgumentError.new("No filenames given") unless args[:filenames]
+    if args[:headers]
+      raise ArgumentError.new("number of headers and files don't match, don't forget the constant column") unless args[:headers].size == (args[:filenames].size + 1)
+    end
+
+    @filenames = args[:filenames]
+
+    @csv_filename = args[:csv_filename] || "translations.csv"
+    @default_lang = args[:default_lang]
+    @headers = args[:headers] || self.default_headers
+  end
+
+  def default_headers
+    headers = ["Variables"]
+    @filenames.each do |fname|
+      headers << fname
+    end
+    headers
+  end
+
+
+  # Load all strings of a given file
+  def load_strings(strings_filename)
+    strings = ORDERED_HASH_CLASS.new
+    File.open(strings_filename, 'r') do |strings_file|
+      strings_file.read.each_line do |line|
+        hash = self.parse_dotstrings_line(line)
+        strings.merge!(hash) if hash
+      end
+    end
+    strings
+  end
+
+  def parse_dotstrings_line(line)
+    line.strip!
+    if (line[0] != ?# and line[0] != ?=)
+      m = line.match(/^[^\"]*\"(.+)\"[^=]+=[^\"]*\"(.*)\";/)
+      return {m[1] => m[2]} unless m.nil?
+    end
+  end
+
+
+  # Convert Localizable.strings files to one CSV file
+  # output: strings hash has filename for keys and the content of csv
+  def dotstrings_to_csv(write_to_file = true)
+    # Parse .strings files
+    strings = {}
+    keys = nil
+    lang_order = []
+
+    @filenames.each do |fname|
+      header = fname
+      strings[header] = load_strings(fname)
+      keys ||= strings[header].keys
+    end
+
+    if(write_to_file)
+      # Create csv file
+      puts "Creating #{@csv_filename}"
+      create_csv_file(keys, strings)
+    else
+      return keys, strings
+    end
+  end
+
+  def basename(file_path)
+    filename = File.basename(file_path)
+    return filename.split('.')[0].to_sym if file_path
+  end
+
+  # Create the resulting file
+  def create_csv_file(keys, strings)
+    raise "csv_filename must not be nil" unless self.csv_filename
+    CSVParserClass.open(self.csv_filename, "wb") do |csv|
+      csv << @headers
+      keys.each do |key|
+        line = [key]
+        default_val = strings[self.default_lang][key] if strings[self.default_lang]
+        @filenames.each do |fname|
+          lang = fname
+          current_val = strings[lang][key]
+          line << ((lang != self.default_lang and current_val == default_val) ? '' : current_val)
+        end
+        csv << line
+      end
+      puts "Done"
+    end
+  end
+
+end