fame 0.0.1 → 0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaa07dd2ecd76f2cf02be0a769acc8fe9f982a3d
-  data.tar.gz: d7a888bfbd6a93c52037b6088249b8c116abbab1
+  metadata.gz: 6bd4fe738ca58b090d8fcee6570aa4ba9283febe
+  data.tar.gz: e6a6ac82060e519f446919473164734a576e2e17
 SHA512:
-  metadata.gz: 48b11deac64f15a42d05ee456f2e167fc04d352228b6d63e992cfb6c4ac6ad64c34d665826f1a9b09a0db309d94533a7b3140bb7834ddcb0a594ec8e56ffd8ef
-  data.tar.gz: 45064b46d5fb314057bde5b2f0e2452b3b82217ef63659736b164865757dd519c3567bd046ff036d4b14a053c6b3ab57aab3b07cf0e7a71dcffd3a8390b5820d
+  metadata.gz: 4f9b0e39bd970cfa26af894e5bf2c049242ea4206a4e94ab49c2bf3d37e6c2e0484cf73f5f388dd31c124b985b6a948d43ded2d183d577e9dca2206e1c9c9b92
+  data.tar.gz: 21eb7470a2acec758812dc8aa182976045932cf07550e90fa6d7f9c150022f6652a0d12a8a8c9202d824ae78ee7eadbbe1af10827d07987582edb6f056519f36

data/README.md

@@ -1,12 +1,34 @@
-# Fame
+![Fame logo](docs/logo.png)
 
 Delightful localization of .storyboard and .xib files, right within Interface Builder.
+Fame makes it exceptionally easy to enable _specific_ UI elements to be translated and exported to localizable .xliff files.
+
+-----
+
+<p align="center">
+  <a href="#introduction">Introduction</a> &bull;
+  <a href="#fame-features">Fame Features</a> &bull;
+  <a href="#installation">Installation</a> &bull;
+  <a href="#usage">Usage</a>
+</p>
+
+-----
+
+**TL;DR - Get started in less than 50 seconds.**
+
+* Add languages to your Xcode project
+* Add [Fame.swift](platform/Fame.swift) file to your project
+* Open a storyboard or XIB file
+* Enable or disable UI elements that should be localized within attribute inspector
+* run `fame --project /path/to/Example.xcodeproj` from the root of your project
+* Use the generated .xliff files to manage translations
+* 🚀
 
-Fame makes it easy to enable specific Interface Builder elements to be translated and exported to localizable .strings files.
 
 ## Introduction
 
-Compared to localization in code (`NSLocalizedString`), Storyboard and XIB localizations are a tedious task for both developers and translators.
+Compared to localization in code (i.e. `NSLocalizedString`), Storyboard and XIB localizations are a tedious task for both developers and translators.
+Here's why.
 
 #### Static vs. dynamic localization
 
@@ -14,24 +36,29 @@ Storyboard and XIB files usually contain a mixed set of elements with *static* o
 * **Static text**: Elements with fixed localization strings that will never change at runtime
 * **Dynamic text**: Elements that will change their localized text during runtime. For example a label that is populated with data from an API or a status label that is populated using `NSLocalizedString` at runtime.
 
-**Static text elements should be localized using a generated .strings file, dynamic text elements should be ignored during translation.**
+<!-- ![Example of static vs. dynamic (TableViewCell)]() -->
 
-However, Storyboard and XIB .stings files generated by Xcode also contain dynamic text localizations that will always be overridden at runtime. This makes it hard to distinguish between localizations that should be translated and dynamic text that can be safely ignored during translation.
-Its up to the app developers to either manually remove generated localizations that should not be translated, or leave them for the translators to waste their time with.
+**Static text elements should be localized, dynamic text elements should be ignored during translation.**
+
+However, generated Storyboard and XIB translations also contain dynamic text localizations that will always be overridden at runtime. This makes it hard to distinguish between localizations that should be translated and dynamic text that can be safely ignored during translation.
+It's up to the app developers to either manually remove generated localizations that should not be translated, or leave them for the translators to waste their time with.
 
 #### Localization comments
 
 Storyboard and XIB .stings files generated by Xcode **do not provide a useful comment that provides context to the translator**.
 
-```css
-/* Class = "UILabel"; text = "Label"; ObjectID = "Rfi-2u-xEd"; */
-"Rfi-2u-xEd.text" = "Label";
+```xml
+<trans-unit id="si2-WH-Hr5.text">
+  <source>A fancy Label</source>
+  <target>A fancy Label</target>
+  <note>Class = "UILabel"; text = "A fancy Label"; ObjectID = "si2-WH-Hr5";</note> <-- This is not so helpful 🙄
+</trans-unit>
 ```
 
 Translators use this comment to make sure their translation fits into the context it is used in. Its again up to the app developers to either manually search for specific translations and add a comment, or leave let the translators figure out how to find the best translation without context.
 
 
-## Why Fame?
+## Fame Features
 
 Fame solves the above mentioned issues to help developers and translators get the most out of tedious localization tasks.
 
@@ -41,19 +68,22 @@ Fame makes it easy for developers to specify which elements of your Storyboard a
 
 ![Interface Builder Integration](docs/ib_detail.png)
 
-#### Command line interface
+#### Command Line Interface
 
-Using the fame CLI, developers can export .strings files that only contain localizations for elements previously enabled in Interface Builder.
+Using the fame CLI, developers can export .xliff files that only contain localizations for elements previously enabled in Interface Builder. After all files have been translated, the CLI makes it super easy to batch-import the .xliff files back into Xcode.
 
-![gif]()
+![fame CLI](docs/terminal.gif)
 
-#### Generates beautiful .strings files
+#### Generates beautiful .xliff files
 
-Translators only receive the strings that should actually be translated, saving them time (and you potentially lots of money). All generated .strings files also contain each element's name and a useful comment to provide more context by the app developer.
+Translators only receive the strings that should actually be translated, saving them time (and you potentially lots of money). All generated .xliff files also contain each element's name and a useful comment to provide more context by the app developer.
 
-```css
-/* MyViewController.label.text: Explains how to purchase a pro subscription. */
-"Rfi-2u-xEd.text" = "Label";
+```xml
+<trans-unit id="si2-WH-Hr5.text">
+  <source>A fancy Label</source>
+  <target>A fancy Label</target>
+  <note>Explains to the customer how to purchase a pro subscription. Make it catchy.</note> <-- Ahh, much better 😍
+</trans-unit>
 ```
 
 ## Installation
@@ -82,7 +112,7 @@ You should now have a Base Interface Builder file (e.g. `Main.storyboard`) in a
 
 That's it, read on to enable fame for localization.
 
-#### Setup Fame for Interface Builder
+#### Setup [Fame.swift](platform/Fame.swift) Interface Builder integration
 
 In order to enable the Interface Builder integration to specify the elements that should be translated, add the **[Fame.swift](platform/Fame.swift)** file to your Xcode project. To test the Interface Builder integration, open any Interface Builder file in your project, select an element (e.g. a UILabel) and you should see a new section that lets you configure localization for this element in the Attributes inspector.
 
@@ -90,41 +120,56 @@ In order to enable the Interface Builder integration to specify the elements tha
 
 You can now enable localization for each element you want to have translated.
 
-
 ## Usage
 
+### Export
 
-Once all localizable elements have been configured in Interface Builder, you can export the localizable .strings file using the `fame` command line tool.
-
+Once all localizable elements have been configured in Interface Builder, you can export the localizable .xliff file using the `fame` command line tool.
 
 First, make sure to commit all local changes, just to be safe. Then open terminal, navigate to the root folder of your project and run
 
+```bash
+$ fame --project Example.xcodeproj [--ib-file-path] [--output-path]
+```
+
+In a nutshell, the `fame export` command does the following:
+
+* Analyze the given Xcode project file for supported languages
+* Find all .storyboard and .xib files in the `--ib-file-path` (recursively, you may pass a file or folder, defaults to the current directory)
+* Analyze each Interface Builder file and extract the localization settings (set via the [Fame.swift](platform/Fame.swift) integration)
+* Generate the full localizable .xliff file using Apple's `xcodebuild`
+* Filter the `xcodebuild` output based on the analyzed localizable settings
+* Update the generated .xliff with useful comments
+* Save the clean .xliff files to `--output-path` (defaults to the current directory)
+
+Enjoy a little snack 🍉
+
+### Import
+
+To import one or more .xliff files back into Xcode, run
 
 ```bash
-$ fame
+$ fame import --project Example.xcodeproj [--xliff-path]
 ```
 
-In a nutshell, the fame command does the following:
+> Note: The very first import may fail due to limitations in `xcodebuild`, fame will
+> handle the failure gracefully and provide instructions to circumvent this issue.
 
-* Find all .storyboard and .xib files in the current folder (recursively, you can also pass a subpath or file to the fame command)
-* Lookup the localizable settings (you have set in Interface Builder) for each file
-* Generate the full localizable .strings file using Apple's `ibtool`
-* Filter the `ibtool` output based on your licalizable settings
-* Save a new `<NameOfStoryboardOrXIB>.strings` file to the `en.lproj` folder
+In a nutshell, the `fame import` command does the following:
+
+* Find all .xliff files in the `--xliff-path` (defaults to the current directory)
+* Import all found .xliff files using Apple's `xcodebuild`
+
+Enjoy your favorite hot beverage ☕️
 
 ## Contributing
 
-1. Fork it ( https://github.com/aschuch/fame/fork )
+1. Fork it (https://github.com/aschuch/fame/fork)
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-#### TODO
-
-* Incremental updates of .string files (`ibtool --previous-file <OLD .storyboard> --incremental-file YY --localize-incremental`)
-* Write tests with fixtures
-
 ## Contact
 
 Feel free to get in touch.

data/bin/fame

@@ -7,6 +7,8 @@ require 'commander'
 require 'colorize'
 require 'fame/version'
 require 'fame/interface_builder'
+require 'fame/xliff_import'
+require 'fame/xliff_export'
 
 #
 # The Fame CLI
@@ -17,62 +19,58 @@ class FameApplication
   def run
     program :name, 'Fame'
     program :version, Fame::VERSION
-    program :description, 'Replace identifiers within Apple Interface Builder files to use nice keys and descriptions for localization.'
-    default_command :localize
+    program :description, 'Delightful localization of .storyboard and .xib files, right within Interface Builder. The fame CLI exports .xliff files based on the settings provided in Interface Builder files.'
+    default_command :export
 
     #
-    # Default localize command
+    # Import
     #
-    command :localize do |c|
-      c.syntax = 'fame localize [options]'
-      c.description = 'Replaces generated identifiers of the given Interface Builder file(s) and generates .strings files.'
-      c.option '--path STRING', String, 'Path to an interface builder file or a folder that contains interface builder files.'
+    command :import do |c|
+      c.syntax = 'fame import --project /path/to/xcodeproj [options]'
+      c.description = 'Imports all given .xliff files into the given Xcode project.'
+      c.option '--project STRING', String, 'Path to an Xcode project that should be localized'
+      c.option '--xliff-path STRING', String, 'Path to an .xliff file or a folder that contains .xliff files to be imported.'
 
       c.action do |args, options|
-        options.default :path => '.'
+        options.default :xliff_path => '.'
 
-        files = Fame::InterfaceBuilder.determine_ib_files!(options.path)
-        puts "\nFound #{files.count} files to localize.\n".light_black
-
-      	# Generate localizable strings for each file
-      	files.each_with_index do |f, index|
-          puts "(#{index+1}/#{files.count}) #{f}".light_blue
+        # Import .xliff files
+        xliff = Fame::XliffImport.new(options.project)
+        xliff.import(options.xliff_path)
+      end
+    end
 
-      		ib = Fame::InterfaceBuilder.new
+    #
+    # Export
+    #
+    command :export do |c|
+      c.syntax = 'fame export --project /path/to/xcodeproj [options]'
+      c.description = 'Exports all .xliff files for the current Xcode project based on the settings provided in the Interface Builder files (via Fame.swift).'
+      c.option '--project STRING', String, 'Path to an Xcode project that should be localized'
+      c.option '--ib-file-path STRING', String, 'Path to an interface builder file or a folder that contains interface builder files that should be localized.'
+      c.option '--output-path STRING', String, 'Path to a folder where exported .xliff files should be placed.'
 
-      		# Generate new localizable.strings file
-      		strings = ib.generate_localizable_strings(f)
+      c.action do |args, options|
+        options.default :ib_file_path => '.'
+        options.default :output_path => '.'
 
-          if strings.empty?
-      		  puts "✔".green + " (no strings to localize)︎".yellow
-          else
-            FileUtils.mkdir_p(strings_folder(f))
-            File.write(strings_file_path(f), strings)
+        ib_files = Fame::InterfaceBuilder.determine_ib_files!(options.ib_file_path)
+        puts "Found #{ib_files.count} file(s) to localize".light_black
 
-            puts "✔︎".green + " Generated strings file at #{strings_file_path(f)}".black
-          end
+        # Collect IB nodes for each file
+        ib_nodes = ib_files.inject([]) do |all, file|
+          ib = Fame::InterfaceBuilder.new(file)
+          all + ib.nodes
+        end
 
-          puts "-----------------------------------------------------\n".light_black
-      	end
+        # Generate XLIFF translation files
+        xliff = Fame::XliffExport.new(options.project)
+        xliff.export(options.output_path, ib_nodes)
       end
     end
 
     run!
   end
-
-  private
-
-  def strings_folder(path)
-    folder = File.dirname(path)
-    File.join(folder, "..", "en.lproj")
-  end
-
-  def strings_file_path(path)
-    file_name = File.basename(path, File.extname(path))
-    file = File.join(strings_folder(path), "#{file_name}.strings")
-    File.expand_path(file)
-  end
-
 end
 
 # run application

data/lib/fame/interface_builder.rb

@@ -4,136 +4,67 @@ require 'colorize'		# colorful console output
 require_relative 'models'
 
 module Fame
-
-	class InterfaceBuilder
-		# Keypaths to custom runtime attributes (provided by iOS Extenstion, see Fame.swift)
-		LOCALIZATION_ENABLED_KEYPATH = "i18n_enabled".freeze
-		LOCALIZATION_COMMENT_KEYPATH = "i18n_comment".freeze
-
-		# All accepted Interface Builder file types
-		ACCEPTED_FILE_TYPES = [".storyboard", ".xib"].freeze
-
-		#
-		# Initialization
-		#
-		def self.determine_ib_files!(path = ".")
-			raise "The provided file or folder does not exist" unless File.exist? path
-
-			if File.directory?(path)
-				files = Dir.glob(path + "/**/*{#{ACCEPTED_FILE_TYPES.join(',')}}")
-				raise "The provided folder did not contain any interface files (#{ACCEPTED_FILE_TYPES.join(', ')})" unless files.count > 0
-				return files
-			else
-				raise "The provided file is not an interface file (#{ACCEPTED_FILE_TYPES.join(', ')})" unless ACCEPTED_FILE_TYPES.include? File.extname(path)
-				return [path]
-			end
-		end
-
-		#
-		# Generates a .strings file for the Interface Builder file at the given path.
-		# The output only contains elements where localization has been enabled.
-		#
-		def generate_localizable_strings(file)
-			localizable_strings_entries(file)
-				.sort_by! { |e| e.node.vc_name }
-				.map(&:formatted_strings_file_entry)
-				.join("\n\n")
-		end
-
-		private
-
-		#
-		# Generates ibtool output in plist format
-		#
-		def ibtool(file)
-			# 	<dict>
-			# 		<key>6lc-A3-0nG</key>
-			# 		<dict>
-			# 			<key>text</key>
-			# 			<string>Empty localization ID</string>
-			# 		</dict>
-			# 		...
-			# 	</dict>
-			output = `xcrun ibtool #{file} --localizable-strings --localizable-stringarrays`
-			plist = Plist::parse_xml(output)
-			strings = plist['com.apple.ibtool.document.localizable-strings']
-			string_arrays = plist['com.apple.ibtool.document.localizable-stringarrays']
-
-			[strings, string_arrays]
-		end
-
-		#
-		# Returns all XML nodes with a custom localization ID
-		#
-		def nodes(file)
-			storyboard = File.open(file)
-			doc = Nokogiri::XML(storyboard)
-
-			# Grab raw nokogiri nodes that have a localization keypath
-			raw_nodes = doc.xpath("//userDefinedRuntimeAttribute[@keyPath='#{LOCALIZATION_ENABLED_KEYPATH}']")
-
-			# Map raw nodes info to instances of LocalizedNode
-			raw_nodes.map do |node|
-				parent = node.parent.parent 													# i.e. UILabel, UISwitch, etc.
-				vc = parent.xpath("ancestor::viewController")					# the view controller of the element (only available in .storyboard files)
-				element_name = parent.name														# i.e. label, switch
-				original_id = parent['id'] 														# ugly Xcode ID, e.g. F4z-Kg-ni6
-				vc_name = vc.attr('customClass').value rescue nil			# name of custom view controller class
-
-				i18n_enabled = node.parent.xpath("userDefinedRuntimeAttribute[@keyPath='#{LOCALIZATION_ENABLED_KEYPATH}']").attr('value').value == "YES" rescue false
-				i18n_comment = node.parent.xpath("userDefinedRuntimeAttribute[@keyPath='#{LOCALIZATION_COMMENT_KEYPATH}']").attr('value').value rescue nil
-
-				LocalizedNode.new(node, original_id, vc_name, element_name, i18n_enabled, i18n_comment)
-			end
-		end
-
-		#
-		# Returns the localizable strings entries for a given
-		# Interface Builder file.
-		#
-		def localizable_strings_entries(file)
-			# Generate ibtool output
-			strings, string_arrays = ibtool(file)
-
-			# Get nodes for current file
-			nodes = nodes(file)
-
-			# Generate new strings file
-			entries = []
-			nodes.each do |node|
-				next unless node.i18n_enabled
-				unless element = strings[node.original_id] || string_arrays[node.original_id]
-					puts "  ✘ #{node.original_id} (#{node.element_name}): #{node.original_id} not found in ibtool output".red
-					next
-				end
-
-				# A localization may contain more than one element.
-				# e.g. a UITextField has a `text` and a `placeholdertext` localization
-				element.each do |property, value|
-					next if property == "ibExternalUserDefinedRuntimeAttributesLocalizableStrings"
-
-					if value.is_a?(Array)
-						# The localization contains an array of values, e.g. when localizing a UISegmentedControl
-						value.each_with_index do |v, index|
-							p = "#{property}[#{index}]"
-							entry = LocalizableStringsEntry.new(node, p, v)
-							entries << entry
-
-							puts "  ✔︎ #{entry.formatted_info}".green
-						end
-					else
-						# The localization only contains a single value
-						entry = LocalizableStringsEntry.new(node, property, value)
-						entries << entry
-
-						puts "  ✔︎ #{entry.formatted_info}".green
-					end
-
-				end
-			end
-
-			entries
-		end
-
-	end
+  class InterfaceBuilder
+    # Keypaths to custom runtime attributes (provided by iOS Extenstion, see Fame.swift)
+    LOCALIZATION_ENABLED_KEYPATH = "i18n_enabled".freeze
+    LOCALIZATION_COMMENT_KEYPATH = "i18n_comment".freeze
+
+    # All accepted Interface Builder file types
+    ACCEPTED_FILE_TYPES = [".storyboard", ".xib"].freeze
+
+    #
+    # Initializer
+    # @param ib_path The path to an Interface Builder file that should be localized.
+    #
+    def initialize(ib_path)
+      @ib_path = ib_path
+    end
+
+    #
+    # Searches the current Interface Builder file for XML nodes that should be localized.
+    # Localization is only enabled if explicitly set via the fame Interface Builder integration (see Fame.swift file).
+    # @return [Array<LocalizedNode>] An array of LocalizedNode objects that represent the localizable elements of the given Interface Builder file
+    #
+    def nodes
+      ib_file = File.open(@ib_path)
+      doc = Nokogiri::XML(ib_file)
+      ib_file.close
+
+      # Grab raw nokogiri nodes that have a localization keypath
+      raw_nodes = doc.xpath("//userDefinedRuntimeAttribute[@keyPath='#{LOCALIZATION_ENABLED_KEYPATH}']")
+
+      # Map raw nodes info to instances of LocalizedNode
+      raw_nodes.map do |node|
+        parent = node.parent.parent 													# i.e. UILabel, UISwitch, etc.
+        vc = parent.xpath("ancestor::viewController")					# the view controller of the element (only available in .storyboard files)
+        element_name = parent.name														# i.e. label, switch
+        original_id = parent['id'] 														# ugly Xcode ID, e.g. F4z-Kg-ni6
+        vc_name = vc.attr('customClass').value rescue nil			# name of custom view controller class
+
+        i18n_enabled = node.parent.xpath("userDefinedRuntimeAttribute[@keyPath='#{LOCALIZATION_ENABLED_KEYPATH}']").attr('value').value == "YES" rescue false
+        i18n_comment = node.parent.xpath("userDefinedRuntimeAttribute[@keyPath='#{LOCALIZATION_COMMENT_KEYPATH}']").attr('value').value rescue nil
+
+        LocalizedNode.new(node, original_id, vc_name, element_name, i18n_enabled, i18n_comment)
+      end
+    end
+
+    #
+    # Searches the given path for Interface Builder files (.storyboard & .xib) and returns their paths.
+    # @param path The path that should be searched for Interface Builder files.
+    # @return [Array<String>] An array of paths to Interface Builder files.
+    #
+    def self.determine_ib_files!(path)
+      raise "The provided file or folder does not exist" unless File.exist? path
+
+      if File.directory?(path)
+        files = Dir.glob(path + "/**/*{#{ACCEPTED_FILE_TYPES.join(',')}}")
+        raise "The provided folder did not contain any interface files (#{ACCEPTED_FILE_TYPES.join(', ')})" unless files.count > 0
+        return files
+      else
+        raise "The provided file is not an interface file (#{ACCEPTED_FILE_TYPES.join(', ')})" unless ACCEPTED_FILE_TYPES.include? File.extname(path)
+        return [path]
+      end
+    end
+
+  end
 end

data/lib/fame/models.rb

@@ -1,29 +1,15 @@
-
 module Fame
-  
+
   # nokogiri_node = original nokogiri node
   # original_id = F4z-Kg-ni6
   # vc_name = CustomViewController (optional)
   # element_name = label
   # i18n_enabled = true
   # i18n_comment = "Best label ever invented"
-  LocalizedNode = Struct.new(:nokogiri_node, :original_id, :vc_name, :element_name, :i18n_enabled, :i18n_comment)
-
-  # node = LocalizedNode
-  # property = localizable element, e.g. text of a label
-  # value = localizable strings value (i.e. the translation)
-  LocalizableStringsEntry = Struct.new(:node, :property, :value) do
-
-    # The formatted .strings file entry
-    def formatted_strings_file_entry
-      comment = node.i18n_comment || "No comment provided by engineer."
-      key = "#{node.original_id}.#{property}"
-      ["/* #{formatted_info}: #{comment} */", "\"#{key}\" = \"#{value}\";"].join("\n")
-    end
-
-    # The formatted info of this entry
+  LocalizedNode = Struct.new(:nokogiri_node, :original_id, :vc_name, :element_name, :i18n_enabled, :i18n_comment) do
     def formatted_info
-      [node.vc_name, node.element_name, property].compact.join(" ")
+      info = [vc_name, element_name].compact.join(" ")
+      "[#{info}] #{i18n_comment}"
     end
   end
 

data/lib/fame/version.rb

@@ -1,3 +1,3 @@
 module Fame
-  VERSION = "0.0.1"
+  VERSION = "0.1"
 end

data/lib/fame/xcode_project.rb

@@ -0,0 +1,46 @@
+require 'pbxplorer'   # grab localization languages from .xcproj file
+
+module Fame
+  # Handles the Xcode Project that is subject to localization
+  class XcodeProject
+    # All accepted Xcode project file types
+    ACCEPTED_FILE_TYPES = [".xcodeproj"].freeze
+
+    attr_accessor :xcode_proj_path
+
+    #
+    # Initializer
+    # @param xcode_proj_path A path to a .xcodeproj file whose contents should be localized.
+    #
+    def initialize(xcode_proj_path)
+      @xcode_proj_path = xcode_proj_path
+      validate_xcodeproj_path!
+    end
+
+    #
+    # Determines all languages that are used in the current Xcode project.
+    # @return [Array<String>] An array of language codes, representing all languages used in the current Xcode project.
+    #
+    def all_languages
+      project_file = XCProjectFile.new(@xcode_proj_path)
+      project_file.project["knownRegions"].select { |r| r != "Base" }
+    end
+
+    # TODO
+    # def self.determine_xcproj_files!(path = ".")
+    # 	raise "The provided file or folder does not exist" unless File.exist? path
+    # end
+
+    private
+
+    #
+    # Validates the xcodeproj path
+    #
+    def validate_xcodeproj_path!
+      raise "[XcodeProject] No project file provided" unless @xcode_proj_path
+      raise "[XcodeProject] The provided file does not exist" unless File.exist? @xcode_proj_path
+      raise "[XcodeProject] The provided file is not a valid Xcode project (#{ACCEPTED_FILE_TYPES.join(', ')})" unless ACCEPTED_FILE_TYPES.include? File.extname(@xcode_proj_path)
+    end
+
+  end
+end

data/lib/fame/xliff_export.rb

@@ -0,0 +1,126 @@
+require 'nokogiri'		# to rewrite the XLIFF file
+require 'colorize'		# colorful console output
+require_relative 'models'
+require_relative 'xcode_project'
+
+module Fame
+  # Handles import and export of .xliff files
+  class XliffExport
+
+    #
+    # Initializer
+    # @param xcode_proj_path A path to a .xcodeproj file whose contents should be localized.
+    #
+    def initialize(xcode_proj_path)
+      @xcode_proj = XcodeProject.new(xcode_proj_path)
+    end
+
+    #
+    # Exports all .xliff files for the current Xcode project
+    # @param path A path to a folder where exported .xliff files should be placed.
+    # @param ib_nodes An array of `LocalizedNode`s, generated from `InterfaceBuilder.nodes`.
+    #
+    def export(path, ib_nodes)
+      # export localizations
+      export_xliffs(path)
+
+      # update translation units based on the settings provided in Interface Builder
+      # Localizations are only exported if explicitly enabled via the fame Interface Builder integration (see Fame.swift file).
+      update_xliff_translation_units(path, ib_nodes)
+    end
+
+    private
+
+    #
+    # Exports all .xliff files for the current Xcode project to the given path.
+    # @param path A path to a folder where exported .xliff files should be placed.
+    #
+    def export_xliffs(path)
+      # get all languages that should be exported to separate .xliff files
+      languages = @xcode_proj.all_languages
+        .map { |l| "-exportLanguage #{l}" }
+        .join(" ")
+
+      `xcodebuild -exportLocalizations -localizationPath #{path} -project #{@xcode_proj.xcode_proj_path} #{languages}`
+    end
+
+    #
+    # Modifies all .xliff files based on the settings extracted from Interface Builder nodes.
+    #
+    def update_xliff_translation_units(path, ib_nodes)
+      @xcode_proj.all_languages.each do |language|
+        xliff_path = File.join(path, "#{language}.xliff")
+        puts "Updating translation units for #{language}".blue
+
+        # Read XLIFF file
+        raise "File #{xliff_path} does not exist" unless File.exists? xliff_path
+        doc = read_xliff_file(xliff_path)
+
+        # Extract all translation units from the xliff
+        trans_units = doc.xpath('//xmlns:trans-unit')
+
+        # Loop over the Interface Builder nodes and update the xliff file based on their settings
+        ib_nodes.each do |ib_node|
+          # Select nodes connected to original_id
+          units = trans_units.select do |u|
+            u_id = u["id"] rescue ""
+            u_id.start_with?(ib_node.original_id)
+          end
+
+          # Update or remove nodes
+          units.each do |unit|
+            if ib_node.i18n_enabled
+              # Update comment
+              comment = unit.xpath("xmlns:note")
+              comment.children.first.content = ib_node.formatted_info
+            else
+              # Remove translation unit, since it should not be translated
+              unit.remove
+            end
+          end
+
+          # Print status
+          if units.count > 0
+            status = ib_node.i18n_enabled ? "updated".green : "removed".red
+            puts [
+              "  ✔︎".green,
+              "#{units.count} translation unit(s)".black,
+              status,
+              "for".light_black,
+              "#{ib_node.original_id}".black,
+              "#{ib_node.formatted_info}".light_black
+            ].join(" ")
+          end
+        end
+
+        # Write updated XLIFF file to disk
+        write_xliff_file(doc, xliff_path)
+      end
+    end
+
+    #
+    # Reads the document at the given path and parses it into a `Nokogiri` XML doc.
+    # @param path The path the xliff file that should be parsed
+    # @return [Nokogiri::XML] A `Nokogiri` XML document representing the xliff
+    #
+    def read_xliff_file(path)
+      xliff = File.open(path)
+      doc = Nokogiri::XML(xliff)
+      xliff.close
+
+      doc
+    end
+
+    #
+    # Writes the given `Nokogiri` doc to the given path
+    # @param doc A Nokogiri XML document
+    # @param path The path the `doc` should be written to
+    #
+    def write_xliff_file(doc, path)
+      file = File.open(path, "w")
+      doc.write_xml_to(file)
+      file.close
+    end
+
+  end
+end

data/lib/fame/xliff_import.rb

@@ -0,0 +1,83 @@
+require 'colorize'		# colorful console output
+require_relative 'xcode_project'
+
+module Fame
+  # Handles import and export of .xliff files
+  class XliffImport
+    # All accepted XLIFF file types
+    ACCEPTED_FILE_TYPES = [".xliff"].freeze
+
+    #
+    # Initializer
+    # @param xcode_proj_path A path to a .xcodeproj file whose contents should be localized.
+    #
+    def initialize(xcode_proj_path)
+      @xcode_proj = XcodeProject.new(xcode_proj_path)
+    end
+
+    #
+    # Imports all .xliff files at the given path into the current Xcode project
+    # @param path A folder of .xliff files that should be imported into the current Xcode project.
+    #
+    def import(path)
+      xliffs = determine_xliff_files!(path)
+      puts "Found #{xliffs.count} xliff file(s) -> #{xliffs.map { |x| File.basename(x, '.*') }}".light_black
+
+      errors = []
+      xliffs.each_with_index do |xliff, index|
+        language =  File.basename(xliff, '.*')
+        puts "(#{index+1}/#{xliffs.count}) [#{language}] Importing #{xliff}".blue
+
+        # may result in the following error:
+        # xcodebuild: error: Importing localizations from en.xliff will make changes to Example. Import with xcodebuild can only modify existing strings files.
+        output = `xcodebuild -importLocalizations -localizationPath #{xliff} -project #{@xcode_proj.xcode_proj_path} 2>&1`
+        error = output.split("\n").grep(/^xcodebuild: error: Importing localizations/i)
+        errors << error
+      end
+
+      report_result(errors)
+    end
+
+    private
+
+    #
+    # Searches the given path for .xliff files and returns their paths.
+    # @param path The path that should be searched for .xliff files.
+    # @return [Array<String>] An array of paths to .xliff files.
+    #
+    def determine_xliff_files!(path)
+      raise "[XliffImport] The provided file or folder does not exist" unless File.exist? path
+
+      if File.directory?(path)
+        files = Dir.glob(path + "/**/*{#{ACCEPTED_FILE_TYPES.join(',')}}")
+        raise "[XliffImport] The provided folder did not contain any XLIFF files (#{ACCEPTED_FILE_TYPES.join(', ')})" unless files.count > 0
+        return files
+      else
+        raise "[XliffImport] The provided file is not an XLIFF (#{ACCEPTED_FILE_TYPES.join(', ')})" unless ACCEPTED_FILE_TYPES.include? File.extname(path)
+        return [path]
+      end
+    end
+
+    #
+    # Prints the result of the import
+    #
+    def report_result(errors)
+      # handle errors
+      if errors.count > 0
+        puts "\n✘ XLIFF import failed (#{errors.count} error(s))\n".red
+        puts errors
+        help = "\nOoops! xcodebuild cannot import one or more of the provided .xliff file(s) because the necessary .strings files do not exist yet.\n\n" +
+              "Here's how to fix it:\n" +
+              "  1. Open Xcode, select the project root (blue icon)\n" +
+              "  2. Choose Editor > Import Localizations...\n" +
+              "  3. Repeat steps 1 and 2 for every localization\n\n" +
+              "Don't worry, you only have to do this manually once.\n" +
+              "After the initial Xcode import, this command will be able to import your xliff files."
+        puts help.blue
+      else
+        puts "\n✔︎ Done importing XLIFFs\n".green
+      end
+    end
+
+  end
+end

data/lib/fame/xliff_import_old.rb

@@ -0,0 +1,110 @@
+require 'colorize'		# colorful console output
+require_relative 'xcode_project'
+
+module Fame
+  # Handles import and export of .xliff files
+  class XliffImport
+    # All accepted XLIFF file types
+    ACCEPTED_FILE_TYPES = [".xliff"].freeze
+
+    # All required localization files
+    # If these files are not present in their respective .lproj folder
+    # the `xcodebuild -importLocalizations` command will fail
+    REQUIRED_LOCALIZATION_FILES = ["Localizable.strings", "InfoPlist.strings"].freeze
+
+    #
+    # Initializer
+    # @param xcode_proj_path A path to a .xcodeproj file whose contents should be localized.
+    #
+    def initialize(xcode_proj_path)
+      @xcode_proj = XcodeProject.new(xcode_proj_path)
+    end
+
+    #
+    # Imports all .xliff files at the given path into the current Xcode project
+    # @param path A folder of .xliff files that should be imported into the current Xcode project.
+    #
+    def import(path)
+      xliffs = determine_xliff_files!(path)
+      puts "Found #{xliffs.count} xliff file(s) -> #{xliffs.map { |x| File.basename(x, '.*') }}".light_black
+
+      xliffs.each_with_index do |xliff, index|
+        language =  File.basename(xliff, '.*')
+        puts "(#{index+1}/#{xliffs.count}) [#{language}] Importing #{xliff}".blue
+
+        `xcodebuild -importLocalizations -localizationPath #{xliff} -project #{@xcode_proj.xcode_proj_path}`
+      end
+    end
+
+    #
+    # Import of .xliff files using `xcodebuild` may fail in case the appropriate
+    # .strings file do not already exist.
+    # ```
+    # xcodebuild: error: Importing localizations from en.xliff will make changes to Example.
+    # Import with xcodebuild can only modify existing strings files.
+    # Please import with Xcode instead of xcodebuild to make the changes to Example.
+    # ```
+    #
+    # This method creates the missing localization .strings files in order to silence this error.
+    #
+    def create_missing_strings_files
+      # search for Base.lproj folder in project
+      project_root = File.expand_path("..", @xcode_proj.xcode_proj_path)
+      base_lproj = Dir.glob(project_root + "/**/*{Base.lproj}").first # TODO: ask if multiple...
+      raise "There is no Base.lproj folder, please make sure to have a base localization" unless base_lproj
+      lproj_root = File.expand_path("..", base_lproj)
+
+      # collect all names of files that need to be generated in each <language>.lproj folder
+      # TODO: not sure if we should determine the project_root like this or kust use an input param from the cli?
+      ib_file_names = InterfaceBuilder.determine_ib_files!(project_root)
+        .map { |f| File.basename(f, ".*") }
+        .map { |f| "#{f}.strings"}
+      required_files = REQUIRED_LOCALIZATION_FILES + ib_file_names
+
+      # Create <language>.lproj files for all languages
+      @xcode_proj.all_languages.each do |language|
+        # create .lproj folder
+        lproj_folder_path = File.join(lproj_root, "#{language}.lproj")
+        Dir.mkdir(lproj_folder_path) unless File.exists?(lproj_folder_path)
+        puts "Checking for missing .strings files for #{lproj_folder_path}".blue
+
+        required_files.each do |file_name|
+          path = File.join(lproj_folder_path, file_name)
+          exists = File.exists?(path)
+          File.write(path, "") unless exists
+
+          puts "#{file_name}".colorize(exists ? :yellow : :green) + " at #{path}".light_black
+        end
+      end
+
+      # <ib_file>.strings
+      # Localizable.strings
+      # InfoPlist.strings
+
+      # search for Base.lproj
+      # create .lproj folders if needed
+      # create files for each `string_files` entry
+    end
+
+    private
+
+    #
+    # Searches the given path for .xliff files and returns their paths.
+    # @param path The path that should be searched for .xliff files.
+    # @return [Array<String>] An array of paths to .xliff files.
+    #
+    def determine_xliff_files!(path)
+      raise "[XliffImport] The provided file or folder does not exist" unless File.exist? path
+
+      if File.directory?(path)
+        files = Dir.glob(path + "/**/*{#{ACCEPTED_FILE_TYPES.join(',')}}")
+        raise "[XliffImport] The provided folder did not contain any XLIFF files (#{ACCEPTED_FILE_TYPES.join(', ')})" unless files.count > 0
+        return files
+      else
+        raise "[XliffImport] The provided file is not an XLIFF (#{ACCEPTED_FILE_TYPES.join(', ')})" unless ACCEPTED_FILE_TYPES.include? File.extname(path)
+        return [path]
+      end
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fame
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: '0.1'
 platform: ruby
 authors:
 - Alexander Schuch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: pbxplorer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -125,7 +139,11 @@ files:
 - lib/fame/interface_builder.rb
 - lib/fame/models.rb
 - lib/fame/version.rb
-homepage: https://twitter.com/schuchalexander
+- lib/fame/xcode_project.rb
+- lib/fame/xliff_export.rb
+- lib/fame/xliff_import.rb
+- lib/fame/xliff_import_old.rb
+homepage: https://github.com/aschuch/fame
 licenses:
 - MIT
 metadata: {}