applyrics 0.0.2 → 0.0.3.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b4ca2e8f98970107cda93dab4aa1319ce15eec97
-  data.tar.gz: e5273c52d624cb091b1d062ee342b03650dbf308
+  metadata.gz: 7f8c09970f5298b306a1f05ff6c89f36fb8db206
+  data.tar.gz: d7226737efbd8949a1e5eaa135809d7a20457251
 SHA512:
-  metadata.gz: 0eb761243e8dbd25564b16d3c5cee3e2aa67834d1adfed9c55ce3c3d33a67286a09502f97aaabe7489388c919740085ef2a110777fa213db121e783586d6443a
-  data.tar.gz: 866a96e777269425eab3eb6750fb747e2572a48b96d2f0db6f4dae668c266517edf28882a76ac74467839c69a513082c5cef041a095831b5ff9d2881a1e4db4b
+  metadata.gz: 9c05ad2a2ee39d8854a7487f96ac1efaa4e70c4f7c828df7a8785a547a43bd430f0d7ca1f6a6eb629009e1cc218e6d03fa3359ac2f8489d2a5e35d1872a92180
+  data.tar.gz: a65d253e07a1cf8a45e2a9362073b9bc7114344321869cf47684583591bf58e3e0488854f62a8f0b4b5f917c091a3f569d4839e4903bf86f898aaece54f0abdb

data/README.md

@@ -8,49 +8,64 @@ Manage your localization with confidence.
 
 ## Disclaimer
 
----
-This software should be considered ***pre-alpha*** and may thus be incomplete and contain bugs.
----
+**This software should be considered _pre-alpha_ and may thus change at any time, be incomplete or contain bugs.**
+
+## Why Applyrics?
+
+Managing translations for mobile projects can be a mess, especially if you are working with multiple platforms.
+iOS projects use key-value \*.strings files, Android use xmls, and variables are defined differently.
+
+*Applyrics* removes these obstacles and lets you manage languages using unified json files.
 
 ## Status
 
 | Feature   | iOS | Android |
 | --------- | --- | --------|
-| init      | :x: | :x:     |
-| rebuild   | :x: | :x:     |
+| extract   | :x: | :x:     |
 | apply     | :x: | :x:     |
-| sync      | :x: | :x:     |
 
 ## Installation
 
 Install using ruby gems:
 
-  sudo gem install applyrics --verbose
+    sudo gem install applyrics --verbose
 
 
 ## Usage
 
-Initialize
-(iOS: :x: Android: :x:)
+Usually you start out by extracting the strings from an existing project into a json file by running the following command in your projects directory:
 
-  applyrics init
+    applyrics extract
 
 
-Rebuild language files
-(iOS: :x: Android: :x:)
+After you've made changes to the translations you can apply those changes to the projects.
+Notice the addition of the *--rebuild* flag. This will ensure that we don't miss any new keys that might have been added.
 
-  applyrics rebuild
+    applyrics apply --rebuild
 
 
-Apply a json language file
+### Global flags
+
+| Flag            | Default | Description                  |
+| --------------- | ------- | ---------------------------- |
+| --verbose       | false   | Output more detailed logs    |
+| --rebuild       | false   | Rebuilds strings from source |
+| --lang CODE     | *All*   | Language to work with        |
+| --project PATH  | "./"    | Path to project              |
+
+
+### Actions
+
+Extract strings from project and create strings.json file
 (iOS: :x: Android: :x:)
 
-    applyrics apply
+    applyrics extract
 
-Sync languages
+
+Apply a json language file
 (iOS: :x: Android: :x:)
 
-  applyrics sync
+    applyrics apply
 
 
 ## License

data/lib/applyrics/cli.rb

@@ -1,5 +1,7 @@
 require 'commander'
+require 'colored'
 require 'applyrics/setup'
+require 'applyrics/languagefile'
 
 module Applyrics
   class CLI
@@ -14,48 +16,80 @@ module Applyrics
       program :version, Applyrics::VERSION
       program :description, Applyrics::DESCRIPTION
       program :help_formatter, :compact
+      global_option '--project PATH', String, 'Path to iOS or Android project'
+      global_option '--[no-]rebuild', TrueClass, 'Rebuild language files from source'
+      global_option '--lang CODE', String, 'Only perform the action for the specified language'
 
       command :init do |c|
         c.syntax = "applyrics init"
-        c.description = "Sets up the project"
+        c.description = "Setup the project for applyrics"
         c.action do |args, options|
-          puts "Not implemented yet... Sorry!"
+          project = Applyrics::Project.new()
+
+          if project.nil?
+            puts "Error"
+          else
+            case project.platform
+            when :ios
+              puts "Located ".green + "iOS".bold.green + " project".green
+            when :android
+              puts "Located ".green + "Android".bold.green + " project".green
+            end
+
+            langs = project.detected_languages
+            puts "Found #{langs.length} languages: #{langs.join(', ')}".green
+            puts ""
+
+            lang_files = project.language_files
+            langs.each do |lang|
+              if !lang_files.key?(lang)
+                puts "[#{lang}] No files detected for language!".yellow
+                next
+              end
+            end
+
+          end
         end
       end
 
-      command :rebuild do |c|
-        c.syntax = "applyrics rebuild"
-        c.description = "Rebuilds language files for your project"
-        c.option '--project STRING', String, 'Path to iOS or Android project'
+      command :extract do |c|
+        c.syntax = "applyrics extract"
+        c.description = "Pull strings from the project into a strings.json file"
+        c.option '--force-split', TrueClass, 'Saves one language file per language instead of a single one for all languages'
         c.action do |args, options|
-          options.default :project => './'
-          puts "rebuilding..."
+          
           project = Applyrics::Project.new()
-          project.rebuild_files()
+          detect_lang = project.detected_languages
+
+          langs = project.string_files()
+
+          puts "Found files for #{langs.length} languages".green
+
+          if options.rebuild
+            puts "Rebuilding...".blue
+            rebuilt = project.rebuild_files()
+            langs = langs.merge(rebuilt)
+            puts "Language \"#{project.default_language}\" is rebuilt from source into #{rebuilt[project.default_language].length} files".blue
+          end
+
+          puts "Writing #{langs.length} languages: #{langs.keys.join(', ')}".green
+
+          file = LanguageFile.new(File.join("./", "strings.json"), langs)
+          file.write
+
         end
       end
 
       command :apply do |c|
         c.syntax = "applyrics apply"
         c.description = "Applies language from a .json file"
-        c.option '--project STRING', String, 'Path to iOS or Android project'
-        c.option '--data STRING', String, 'Path to .json file (Default: lyrics.json)'
+        c.option '--data STRING', String, 'Path to .json file (Default: strings.json)'
         c.action do |args, options|
           options.default :project => './', :data => './lyrics.json'
           puts "Not implemented yet... Sorry!"
         end
       end
 
-      command :sync do |c|
-        c.syntax = "applyrics sync"
-        c.description = "Syncs language from applyrics.io"
-        c.option '--project STRING', String, 'Path to iOS or Android project'
-        c.action do |args, options|
-          options.default :project => './'
-          puts "Not implemented yet... Sorry!"
-        end
-      end
-
       run!
     end
   end

data/lib/applyrics/command.rb

@@ -49,7 +49,7 @@ module Applyrics
         status = $?.exitstatus
         if status != 0
           o = output.join("\n")
-          puts o
+          puts "Status #{status} - #{o}"
         end
 
         return output.join("\n")

data/lib/applyrics/info.rb

@@ -1,4 +1,4 @@
 module Applyrics
-  VERSION = "0.0.2"
+  VERSION = "0.0.3.pre"
   DESCRIPTION = "Handle localization for all your mobile projects"
 end

data/lib/applyrics/languagefile.rb

@@ -0,0 +1,42 @@
+require 'multi_json'
+
+# encoding=utf-8
+module Applyrics
+  class LanguageFile
+
+    def initialize(path, data=nil)
+      @path = path
+      @hash = data
+      if data.nil?
+        read
+      end
+    end
+
+    def [](key)
+      @hash[key]
+    end
+
+    def []=(key, value)
+      @hash[key] = value
+    end
+
+    def language?(key)
+      @hash.key?(key)
+    end
+
+    def languages
+      @hash.keys
+    end
+
+    def read
+      @hash = {}
+      data = File.read(@path)
+      @hash = MultiJson.load(data)
+    end
+
+    def write()
+      File.open(@path, 'w') { |file| file.write(MultiJson.dump(@hash, :pretty => true)) }
+    end
+
+  end
+end

data/lib/applyrics/project.rb

@@ -47,15 +47,33 @@ module Applyrics
       @project.detected_languages()
     end
 
+    def language_files
+      @project.language_files()
+    end
+
+    # @return [String] The language which are the default language in the project
+    def default_language
+      @project.default_language
+    end
+
     # @param [String] the name of the setting to read.
     # @return [String, nil] the value of the setting or nil if not found.
     def platform_project_settings(name)
       @project.platform_project_settings(name)
     end
 
+    # @return [Object, nil] the strings files found in the project
+    def string_files
+      @project.string_files()
+    end
+
     # Rebuild the language files.
     def rebuild_files
       @project.rebuild_files()
     end
+
+    def platform
+      @platform
+    end
   end
 end

data/lib/applyrics/project_ios.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 require 'i18n_data'
 require 'multi_json'
+require 'fileutils'
 require 'applyrics/tools/genstrings'
 require 'applyrics/tools/ibtool'
 require 'applyrics/stringsfile'
@@ -15,22 +16,47 @@ module Applyrics
       end
       @path = path
       @platform_settings = nil
-      @langs = {}
+      @langs = []
+      @default_language = nil
     end
 
     # Return a list of detected languages in the project
     def detected_languages
+      @langs = []
       folder = self.platform_project_settings("SOURCE_ROOT")
-      base_language = I18nData.language_code(self.platform_project_settings("DEVELOPMENT_LANGUAGE")).downcase
       lang_folders = Dir.glob(File.join(folder, "**", "*.lproj"))
       lang_folders.each do |lang_folder|
         lang = /([A-Za-z\-]*?)\.lproj/.match(lang_folder)[1]
-        lang = (lang == "Base" ? base_language : lang)
-        @langs[lang] = lang_folder
+        lang = (lang == "Base" ? default_language : lang)
+        @langs << lang
       end
       return @langs
     end
 
+    def language_files
+      folder = self.platform_project_settings("SOURCE_ROOT") unless !folder.nil?
+      out = {}
+      Dir[File.join(folder, "**","*.strings")].each do |file|
+        lang = /(\w*).lproj/.match(file)[1]
+        lang = (lang == "Base" ? default_language : lang)
+
+        if !out.key?(lang)
+          out[lang] = []
+        end
+
+        out[lang] << file
+      end
+
+      out
+    end
+
+    def default_language
+      if @default_language.nil?
+        @default_language = I18nData.language_code(self.platform_project_settings("DEVELOPMENT_LANGUAGE")).downcase
+      end
+      @default_language
+    end
+
     def platform_project_settings(name)
       if @platform_settings.nil?
         cmd = ["set -o pipefail && xcrun xcodebuild -showBuildSettings"]
@@ -42,9 +68,29 @@ module Applyrics
       return result.split(" = ").last
     end
 
+    def string_files(folder=nil)
+      folder = self.platform_project_settings("SOURCE_ROOT") unless !folder.nil?
+
+      out = {}
+
+      Dir[File.join(folder, "**", "*.lproj", "*.strings")].each do |file|
+        strings = StringsFile.new(file)
+        lang = /(\w*).lproj/.match(file)[1]
+
+        if !out.key?(lang)
+          out[lang] = {}
+        end
+
+        out[lang][File.basename(file)] = strings.hash
+      end
+
+      out
+    end
+
+    # NOTE: This will only rebuild the base language
     def rebuild_files
       folder = self.platform_project_settings("SOURCE_ROOT")
-      tmp_folder = "./.tmp/"
+      tmp_folder = "./tmp/"
 
       if !Dir.exist?(tmp_folder)
         Dir.mkdir(tmp_folder, 0700)
@@ -53,16 +99,18 @@ module Applyrics
       GenStrings.run("#{folder}", tmp_folder)
       IBTool.run("#{folder}", tmp_folder)
 
-      out = {}
+      lang = default_language
+      out = {"#{lang}" => {}}
+      langHash = out["#{lang}"]
+
       Dir[File.join(tmp_folder, "*.strings")].each do |file|
-        puts file
         strings = StringsFile.new(file)
-        out[File.basename(file)] = strings.hash
+        langHash[File.basename(file)] = strings.hash
       end
 
-      File.open(File.join("./", "strings.json"), 'w') { |file| file.write(MultiJson.dump(out, :pretty => true)) }
-
+      FileUtils.remove_dir(tmp_folder)
 
+      out
     end
   end
 end

data/lib/applyrics/stringsfile.rb

@@ -2,9 +2,9 @@
 module Applyrics
   class StringsFile
 
-    def initialize(filename, data=nil)
-      @filename = filename
-      @hash = data.nil? ? {} : data
+    def initialize(path, data=nil)
+      @path = path
+      @hash = data
       if data.nil?
         read
       end
@@ -13,7 +13,7 @@ module Applyrics
     def read
       @hash = {}
       parser = Parser.new(@hash)
-      File.open(@filename, 'rb:utf-16LE:utf-8') { |fd| parser.parse fd }
+      File.open(@path, 'rb:bom|utf-16LE:utf-8') { |fd| parser.parse fd }
       self
     end
 
@@ -44,16 +44,8 @@ module Applyrics
 
       def parse(data)
         @hash.clear
-        found_bad_bytes = false
         data.each_line do |line|
           @line = line.chomp
-          if !found_bad_bytes
-            first_bytes = @line[0..1].bytes.to_a
-            if first_bytes.length == 2 && first_bytes[0] == 255
-              @line = @line[2,@line.length].force_encoding('UTF-8')
-              found_bad_bytes = true
-            end
-          end
 
           case @line
           when @comment_regex

data/lib/applyrics/tools/genstrings.rb

@@ -15,7 +15,7 @@ module Applyrics
         cmd << "-o " + Shellwords.escape("#{output_folder}")
         cmd << Shellwords.join(files(folder))
 
-        puts Command.execute(cmd)
+        Command.execute(cmd)
       end
 
       def files(folder)

data/lib/applyrics/tools/ibtool.rb

@@ -19,7 +19,7 @@ module Applyrics
           cmd << Command.which("ibtool")
           cmd << "--export-strings-file " + Shellwords.escape("#{output_file}")
           cmd << Shellwords.escape("#{file}")
-          puts Command.execute(cmd)
+          Command.execute(cmd)
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: applyrics
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3.pre
 platform: ruby
 authors:
 - Frederik Wallner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-28 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -125,6 +125,7 @@ files:
 - lib/applyrics/command.rb
 - lib/applyrics/environment.rb
 - lib/applyrics/info.rb
+- lib/applyrics/languagefile.rb
 - lib/applyrics/lyricsfile.rb
 - lib/applyrics/project.rb
 - lib/applyrics/project_ios.rb
@@ -141,8 +142,10 @@ files:
 homepage: https://github.com/applyrics/applyrics-gem
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  issue_tracker: https://github.com/applyrics/applyrics-gem/issues
+post_install_message: Thank you for using applyrics! Please keep in mind that this
+  software is in early development, things might break.
 rdoc_options: []
 require_paths:
 - lib
@@ -153,9 +156,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14