woz 0.2.0 → 0.3.0

data/README.md

@@ -1,6 +1,6 @@
 # Woz
 
-Generate your 'strings' files from an existing 'xls' file so your clients can translate their application by just entering all the value in the xls file. Of course woz will make sure you're able to generate the xls file from the existing strings file.
+Generate your 'strings' files from an existing 'xls' (or 'csv') file so your clients can translate their application by just entering all the value in the xls file. Of course woz will make sure you're able to generate the xls file from the existing strings file.
 
 ## Installation
 
@@ -16,21 +16,38 @@ Generate a configuration file if your not planning to go by the default values:
 
 This will generate a '.wozniak' file in your project directory. This file contains the default values, and you can change them according to your needs.
 
-## Generate xls
+## Export to xls
 
 When you want to generate an xls file from your existing 'strings' files you just have to enter the following command:
 
-    woz xls
+    woz export
 
 Make sure that all the '.lproj' directories are in this directory and that the 'strings' file you specified in the '.wozniak' configuration are inside these '.lproj' directories.
 
 This will generate 1 'xls' file inside this direcory and here you can check out all the used translations.
 
-## Generate strings
+## Export to csv
+
+When you want to generate an csv file from your existing 'strings' files you just have to enter one of the following commands:
+
+    woz export --csv
+    woz export -c
+
+Exporting to csv works the same way as it does for xls.
+
+## Export to xls and csv
+
+You can also export tp both formats:
+
+    woz export --both
+
+This will generate xls and csv files at the same time.
+
+## Import into strings
 
 When you want to do the opposite, that is generate your strings file from an xls file, than you'll just have to run this command:
 
-    woz strings
+    woz import
 
 Make sure the xls in this directory, and that it has the following columns:
     
@@ -53,8 +70,27 @@ There is also a possibility to generate strings files from a xls file located on
     woz strings /an_absolute_directory/the_file.xls
     woz strings ~/an_absolute_directory_inside_your_home_folder/the_file.xls
 
+The same is valid when importing from csv. Only this time you'll have to add '--csv'.
+
+    woz import --csv
+
+When adding a custom filepath, this parameter is not important. Wozniak will check the file type and triest to import from xls or csv, whatever works...
+
+## Todo
+
+This is what I want to implement in the future.
+
+- [ ] Multiple file support.
+
 ## Changelog
 
+### 0.3.0
+
+- Export to CSV
+- Import from CSV
+- Better script naming (now import and export with custom options)
+- Fix import with custom filepath
+
 ### 0.2.0
 
 - Add filename/filepath behind the 'woz strings' command in order to use that xls file for strings generation.

data/bin/woz

@@ -4,17 +4,31 @@ require "thor"
 require "woz"
 
 class WozCommand < Thor
-  desc "xls", "creates a xls with the current strings files."
-  def xls
-    Woz::Builder.generate_xls
+  desc "export", "Export the .strings files to Excel (or force an export to csv)."
+  method_option :both, :type => :boolean, :aliases => "-b", :default => false, :desc => "Force export to CSV and xls."
+  method_option :csv, :type => :boolean, :aliases => "-c", :default => false, :desc => "Force export to CSV instead of the default xls."
+  def export
+    if options[:both]
+      Woz::Builder.generate_csv
+      Woz::Builder.generate_xls
+    elsif options[:csv]
+      Woz::Builder.generate_csv
+    else
+      Woz::Builder.generate_xls
+    end
   end
 
-  desc "strings", "creates the strings files from the available xls file."
-  def strings(filepath=nil)
-    Woz::Builder.generate_strings(filepath)
+  desc "import [FOLDER]", "Generate the .strings files from Excel (or force to import them from csv). Pass the filename (or path) from the csv/xls file you wish to import."
+  method_option :csv, :type => :boolean, :aliases => "-c", :default => false, :desc => "Force import from CSV instead of the default xls."
+  def import(filepath=nil)
+    if File.extname(filepath) == ".xls"
+      Woz::Builder.generate_strings(false, filepath)
+    else
+      Woz::Builder.generate_strings(options[:csv], filepath)
+    end
   end
 
-  desc "setup", "creates the woz configuration file."
+  desc "setup", "Generate the configuration file."
   def setup
     Woz::Builder.init
   end

data/lib/woz/builder.rb

@@ -1,4 +1,5 @@
 require "highline/import"
+require "csv"
 
 require "spreadsheet"
 Spreadsheet.client_encoding = 'UTF-8'
@@ -22,12 +23,20 @@ module Woz
         puts "# woz initialized!"
       end
 
+      def generate_csv
+        generate_translation_csv
+      end
+
       def generate_xls
         generate_translation_xls
       end
 
-      def generate_strings(xls_filepath=nil)
-        generate_translation_strings(xls_filepath)
+      def generate_strings(csv=false, filepath=nil)
+        if csv
+          generate_translation_strings_from_csv(filepath)
+        else
+          generate_translation_strings_from_xls(filepath)
+        end
       end
 
       protected
@@ -44,6 +53,7 @@ module Woz
 # 
 # Woz.configure do |config|
 #   config.xls_filename = "Localizations.xls"
+#   config.csv_filename = "Localizations.csv"
 #   config.strings_filename = "Localizations.strings"
 #   config.ask_confirmation = false
 # end
@@ -81,6 +91,20 @@ TEXT
         language
       end
 
+      def generate_comma_seperated_values path, list
+        CSV.open(path, "wb") do |csv|
+          languages = list.values.map(&:keys).flatten.uniq
+          csv << [KEY_COLUMN, languages].flatten
+          list.each do |key, value|
+            row = [key]
+            languages.each do |language|
+              row << list[key][language]
+            end
+            csv << row
+          end
+        end
+      end
+
       def generate_spreadsheet list
         book  = Spreadsheet::Workbook.new
         sheet = book.create_worksheet
@@ -101,7 +125,7 @@ TEXT
         book
       end
 
-      def generate_translation_xls
+      def generate_translation(type=:xls)
         file = File.join(Dir.pwd, "en.lproj", Woz.config.strings_filename)
         output_dir = get_output_dir(file)
         list = {}
@@ -109,16 +133,28 @@ TEXT
           parse_strings list, File.join(Dir.pwd, entry) if entry.include? ".lproj"
         end
 
-        xls = generate_spreadsheet list
-
-        if !Woz.config.ask_confirmation || ask("! the project's xls file will be overwritten, type 'y' and enter to continue: ") == "y"
-          xls.write(File.join(output_dir, Woz.config.xls_filename))
-          puts "# xls generated at #{File.join(output_dir, Woz.config.xls_filename)}"
+        filename = Woz.config.send("#{type.to_s}_filename")
+        if !Woz.config.ask_confirmation || !File.exists?(filename) || ask("! the project's #{type.to_s} file will be overwritten, type 'y' and enter to continue: ") == "y"
+          if type == :xls
+            content = generate_spreadsheet list
+            content.write(File.join(output_dir, filename))
+          else
+            generate_comma_seperated_values File.join(output_dir, filename), list
+          end
+          puts "# #{type.to_s} generated at #{File.join(output_dir, filename)}"
         else
-          puts "! xls generation canceled"
+          puts "! #{type.to_s} generation canceled"
         end
       end
 
+      def generate_translation_csv
+        generate_translation(:csv)
+      end
+
+      def generate_translation_xls
+        generate_translation(:xls)
+      end
+
       def parse_xls file
         book  = Spreadsheet.open file
         sheet = book.worksheet 0
@@ -140,15 +176,50 @@ TEXT
         list
       end
 
-      def generate_translation_strings(xls_filepath=nil)
+      def parse_csv filepath
+        index = 0
+        languages = []
+        list = {}
+        CSV.foreach(filepath) do |row|
+          if index == 0
+            languages = row.select { |i| i != KEY_COLUMN && i != "" }
+            list = languages.inject({}) do |hash, language| 
+              hash[language] = {}
+              hash
+            end
+          else
+            languages.each_with_index do |language, e|
+              list[language][row[0]] = row[e+1]
+            end
+
+          end
+          index += 1
+        end
+        list
+      end
+
+      def generate_translation_strings_from_xls(xls_filepath=nil)
         filepath = File.expand_path(xls_filepath || Woz.config.xls_filename)
-        puts filepath.inspect
         file = File.join(filepath)
-        output_dir = get_output_dir(File.join(File.expand_path(Woz.config.xls_filename)))
 
         fail "! xls file not found, specify the filename in the .wozniak file" unless File.exists?(file)
 
         list = parse_xls file
+        generate_translation_strings(list)
+      end
+
+      def generate_translation_strings_from_csv(csv_filepath=nil)
+        filepath = File.expand_path(csv_filepath || Woz.config.csv_filename)
+        file = File.join(filepath)
+
+        fail "! csv file not found, specify the filename in the .wozniak file" unless File.exists?(file)
+
+        list = parse_csv filepath
+        generate_translation_strings(list)
+      end
+
+      def generate_translation_strings(list)
+        output_dir = get_output_dir(File.join(File.expand_path(Woz.config.xls_filename)))
         cocoa_array = "#define kLanguages [NSArray arrayWithObjects:"
         cocoa_languages_array = []
         list.keys.compact.each do |language|

data/lib/woz/configuration.rb

@@ -5,6 +5,7 @@ module Woz
     def self.default
       new \
       :xls_filename => "Localizations.xls",
+      :csv_filename => "Localizations.csv",
       :strings_filename => "Localizations.strings",
       :ask_confirmation => false
     end

data/lib/woz/version.rb

@@ -1,3 +1,3 @@
 module Woz
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/example_xcode_project/.wozniak

@@ -4,6 +4,7 @@
 # 
 Woz.configure do |config|
   config.xls_filename = "Localizable.xls"
+  config.csv_filename = "Localizable.csv"
   config.strings_filename = "Localizable.strings"
   config.ask_confirmation = true
 end

data/spec/example_xcode_project/Localizable.csv

@@ -0,0 +1,5 @@
+keys,de,en,fr,nl
+name,MISSING VALUE,name,nom,naam
+beer,biere,MISSING VALUE,bière,bier
+title,MISSING VALUE,title,titre,titel
+fun,Spaß,pleasure,plaisire,plezier

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: woz
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-07 00:00:00.000000000 Z
+date: 2013-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
-  requirement: &70346431276860 !ruby/object:Gem::Requirement
+  requirement: &70294884558340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -21,10 +21,10 @@ dependencies:
         version: 1.6.15
   type: :runtime
   prerelease: false
-  version_requirements: *70346431276860
+  version_requirements: *70294884558340
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70346431276180 !ruby/object:Gem::Requirement
+  requirement: &70294884557840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 0.16.0
   type: :runtime
   prerelease: false
-  version_requirements: *70346431276180
+  version_requirements: *70294884557840
 - !ruby/object:Gem::Dependency
   name: spreadsheet
-  requirement: &70346431275620 !ruby/object:Gem::Requirement
+  requirement: &70294884557380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -43,7 +43,7 @@ dependencies:
         version: 0.7.3
   type: :runtime
   prerelease: false
-  version_requirements: *70346431275620
+  version_requirements: *70294884557380
 description: Generate strings files from an xls and vice versa.
 email:
 - jelle@fousa.be
@@ -63,8 +63,8 @@ files:
 - lib/woz/configuration.rb
 - lib/woz/logger.rb
 - lib/woz/version.rb
-- spec/example_xcode_project/.leorc
 - spec/example_xcode_project/.wozniak
+- spec/example_xcode_project/Localizable.csv
 - spec/example_xcode_project/Localizable.xls
 - spec/example_xcode_project/de.lproj/Localizable.strings
 - spec/example_xcode_project/en.lproj/Localizable.strings
@@ -96,8 +96,8 @@ signing_key:
 specification_version: 3
 summary: Easy strings file generate.
 test_files:
-- spec/example_xcode_project/.leorc
 - spec/example_xcode_project/.wozniak
+- spec/example_xcode_project/Localizable.csv
 - spec/example_xcode_project/Localizable.xls
 - spec/example_xcode_project/de.lproj/Localizable.strings
 - spec/example_xcode_project/en.lproj/Localizable.strings

data/spec/example_xcode_project/.leorc

@@ -1,12 +0,0 @@
-# [Leo](http://github.com/fousa/leo)
-# This file is used by Leo to make exporting to
-# xls or strings even easier.
-# 
-# Leo.configure do |config|
-#   config.xls_name = "Localizable.xls"
-#   config.strings_name = "Localizable.strings"
-#   config.ask_confirmation = false
-# end
-#
-# You can now run `leo xls` to create a translation
-# xls file.