smartling_xcode 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a28e04a4e2341fca2af30b77383428cdec69c30
+  data.tar.gz: d779c2b54abb8997a8b1c70121752ca37668af11
+SHA512:
+  metadata.gz: a62c2cda9df56c354e8508b0424b86df7027531c14c4b10402f3317112cd2cf0c1923b264344b9f57b827ca06dfa6f4f8cf4daf831992201dd09f3c539e45fde
+  data.tar.gz: ed1724e98b35eb5c8c9cccce40cc9ec903d843471f118ee74ea3b4310f4b2a9f3f4f8e3d42abac1a4d2ac7b69a7d22fdbcbc9b1bee0a6b1334393dd464598df1

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+/pkg/
+Gemfile.lock

data/CONTRIBUTE.md

@@ -0,0 +1,23 @@
+# SmartlingXcode
+
+To experiment with the code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+    $ gem install smartling_xcode
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Smartling/api-sdk-xcode.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smartling_xcode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Emilien Huet
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,21 @@
+Smartling utility to extract strings from an Xcode project and add them to a Smartling project.
+
+# Installation
+```
+$ gem install smartling_xcode
+```
+
+# Usage
+```
+smartling_xcode command [project path]
+smartling_xcode -h/--help
+smartling_xcode -v/--version
+```
+
+# Commands
+* `init` Configure the current folder with Smartling project credentials to be able to push strings.
+* `extract` Extract all strings from the Xcode project and print out the list of .strings files.
+* `push` Extract all strings from the Xcode project and send them to your Smartling project.
+
+# Options
+`[project path]` Specify a path for the Xcode project. Uses the first .xcodeproj file in the current directory by default.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "smartling_xcode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/smartling_xcode

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+
+require "smartling_xcode"
+
+# Parse options
+USAGE = <<ENDUSAGE
+Smartling utility to extract strings from an Xcode project and add them to a Smartling project.
+Version #{SmartlingXcode::VERSION}
+
+  Usage:
+    smartling_xcode command [project path]
+    smartling_xcode -h/--help
+    smartling_xcode -v/--version
+
+  Commands:
+    init        Configure the current folder with Smartling project credentials to be able to push strings.
+    extract     Extract all strings from the Xcode project and print out the list of .strings files.
+    push        Extract all strings from the Xcode project and send them to your Smartling project.
+
+  Options:
+    [project path]  Specify a path for the Xcode project. Uses the first .xcodeproj file in the current directory by default.
+
+ENDUSAGE
+
+# Parse CLI arguments
+project_path = nil
+command = nil
+ARGV.each do |arg|
+    case arg
+    # Flags
+    when '-v', '--version'
+        puts "smartling_xcode version #{SmartlingXcode::VERSION}"
+        Kernel.exit(0)
+    when '-h', '--help'
+        puts USAGE
+        Kernel.exit(0)
+
+    # Commands
+    when 'init', 'extract', 'push'  then command = arg
+    
+    else
+        if command.nil?
+            Kernel.abort(USAGE)
+        else 
+            project_path = arg
+        end
+    end
+end
+
+result = SmartlingXcode.execute(command, project_path)
+if result != 0
+    Kernel.abort(USAGE)
+end

data/lib/smartling_xcode/backend.rb

@@ -0,0 +1,86 @@
+require 'smartling'
+require 'json'
+
+module SmartlingXcode
+    CREDFILE = './.smartling.json'
+
+    def self.requestCredentials
+        # Check for existing credentials
+        if File.exist?(CREDFILE)
+            puts "Credentials found in this directory. Overwrite? (y/N)"
+            confirm = STDIN.gets.chomp
+            case confirm
+            when 'y', 'Y'
+                # Continue
+            else
+                Kernel.abort("⚠️  Init cancelled")  
+            end
+        end
+
+        # Prompt for credentials
+        puts "Smartling API Key:"
+        api_key = STDIN.gets.chomp
+
+        puts "Smartling Project ID:"
+        project_id = STDIN.gets.chomp
+
+        # Dummy request to validate creds
+        puts "Validating credentials..."
+        begin
+            sl = Smartling::File.new(:apiKey => api_key, :projectId => project_id)
+            res = sl.list
+        rescue
+            Kernel.abort("⚠️  Invalid credentials")
+        end
+
+        File.open(CREDFILE, "w") do |f|
+            f.write({api_key: api_key, project_id: project_id}.to_json)
+            puts "Credentials saved"
+        end
+    end
+
+    def self.loadCredentials
+        if File.exist?(CREDFILE)
+            file = File.read(CREDFILE)
+            creds = JSON.parse(file)
+            if creds['api_key'].nil? || creds['project_id'].nil?
+                Kernel.abort("⚠️  Invalid credentials") 
+            else
+                return creds
+            end
+        else
+            Kernel.abort("⚠️  Credentials not found. Please run smartling_xcode init.")
+        end
+    end
+
+    def self.pushStringsFromFiles(files, creds)
+        sl = Smartling::File.new(:apiKey => creds['api_key'], :projectId => creds['project_id'])        
+        files.each do |f|
+            # Check if file exists
+            if !File.exist?(f)
+                next
+            end
+
+            # Check if file contains at least one string
+            file = File.open(f)
+            line = file.read.scrub.tr("\000", '').gsub(/\s+/, "")
+            if !line.include?('=')
+                puts "No strings in #{f}"
+                next
+            end
+
+            # Upload
+            begin
+                res = sl.upload(f, f.split('/').last, "ios")
+                if res 
+                    puts "Uploaded #{res['stringCount']} strings from #{f}"
+                end
+            rescue Exception => e
+                puts "⚠️  Upload failed for #{f}"
+                if e.message
+                    puts e.message
+                end
+            end
+        end
+    end
+end

data/lib/smartling_xcode/version.rb

@@ -0,0 +1,3 @@
+module SmartlingXcode
+  VERSION = "0.1.1"
+end

data/lib/smartling_xcode/xcode.rb

@@ -0,0 +1,57 @@
+require 'xcodeproj'
+
+module SmartlingXcode
+    def self.openProject(path)
+        # Get .xcodeproj path
+        if path.nil?
+            project_file = Dir.entries('./').select {|f| f.end_with?(".xcodeproj") }.first
+            path = "./#{project_file}"
+        end
+
+        if !path.nil? && File.exist?(path)
+            # Open project
+            begin
+                project = Xcodeproj::Project.open(path)
+            rescue
+                Kernel.abort("⚠️  Failed to open project file")
+            end    
+
+            return project
+        else
+            Kernel.abort("⚠️  No .xcodeproj file found")
+        end
+    end
+
+    # Returns true if the file is from Base localization or unlocalized
+    def self.fromBase(path)
+        if path.include?('.lproj')
+            return path.include?('Base.lproj')
+        else 
+            return true
+        end
+    end
+
+    def self.extract(project)
+        strings_files = []
+
+        # Loop on IB files from Base localization
+        project.files.select{|f| 
+            f.path.end_with?(".xib", ".storyboard") && fromBase(f.path)
+        }.each do |f|
+            output_name = f.path.gsub(/[\/\.]/, '_')
+            output_path = "/tmp/#{output_name}.strings"
+            puts "Extracting strings from #{f.path} into #{output_path}"
+            Kernel.system("ibtool --generate-strings-file \"#{output_path}\" \"#{f.real_path}\"")
+            strings_files.push(output_path)
+        end
+
+        # Loop on .strings files
+        project.files.select{|f| 
+            f.path.end_with?(".strings") && fromBase(f.path)    
+        }.each do |f|
+            strings_files.push(f.real_path)
+        end
+
+        return strings_files
+    end
+end

data/lib/smartling_xcode.rb

@@ -0,0 +1,27 @@
+require "smartling_xcode/xcode"
+require "smartling_xcode/backend"
+require "smartling_xcode/version"
+
+module SmartlingXcode
+    def self.execute(command, project_path)
+        # Execute commands
+        case command
+        when 'init'
+            requestCredentials
+            return 0
+        when 'extract'
+            files = extract openProject project_path
+            puts "\nOutput:"
+            puts files
+            return 0
+        when 'push'
+            creds = loadCredentials
+            files = extract openProject project_path
+            pushStringsFromFiles(files, creds)
+            puts "\nYour files are now available in the Files section of your Smartling project."
+            return 0
+        else 
+            return 1
+        end
+    end
+end

data/smartling_xcode.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smartling_xcode/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smartling_xcode"
+  spec.version       = SmartlingXcode::VERSION
+  spec.authors       = ["Emilien Huet"]
+  spec.email         = ["ehuet@smartling.com"]
+
+  spec.summary       = %q{Smartling utility to extract strings from an Xcode project and add them to a Smartling project.}
+  spec.homepage      = "https://github.com/Smartling/api-sdk-xcode"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files`.split($\)
+  spec.bindir        = "bin"
+  spec.executables   = ["smartling_xcode"]
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "xcodeproj", ">= 1.1"
+  spec.add_dependency "json", ">= 1.8.1"
+  spec.add_dependency "smartling", ">= 1.0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: smartling_xcode
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Emilien Huet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xcodeproj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+- !ruby/object:Gem::Dependency
+  name: smartling
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- ehuet@smartling.com
+executables:
+- smartling_xcode
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CONTRIBUTE.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/smartling_xcode
+- lib/smartling_xcode.rb
+- lib/smartling_xcode/backend.rb
+- lib/smartling_xcode/version.rb
+- lib/smartling_xcode/xcode.rb
+- smartling_xcode.gemspec
+homepage: https://github.com/Smartling/api-sdk-xcode
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Smartling utility to extract strings from an Xcode project and add them to
+  a Smartling project.
+test_files: []