stringer 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - rbx-18mode
+  - rbx-19mode
+  - 1.8.7

data/Gemfile

@@ -0,0 +1,25 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stringer.gemspec
+gemspec
+
+group :development do
+  # An IRB alternative and runtime developer console
+  # [pry](http://pry.github.com)
+  gem 'pry', '~> 0.9.10'
+end
+
+group :test do
+  # Adding rake for Travis.
+  gem 'rake'
+
+  # minitest provides a complete suite of testing facilities...
+  # [minitest](https://github.com/seattlerb/minitest)
+  gem 'minitest', '~> 3.3.0'
+
+  # Adds color to your MiniTest output
+  gem "minitest-rg", "~> 1.0.0"
+
+  # [mocha](http://gofreerange.com/mocha/docs)
+  gem 'mocha', '~> 0.12.2'
+end

data/LICENSE.txt

@@ -0,0 +1,7 @@
+THE BEER-WARE LICENSE (Revision 42):
+
+<pjaspers> wrote this file. As long as you retain this notice you can
+do whatever you want with this stuff. If we meet some day, and you
+think this stuff is worth it, you can buy me a beer in return.
+
+Piet Jaspers

data/README.md

@@ -0,0 +1,60 @@
+# Stringer
+
+Stringer takes the sting out of `genstrings`, by making it not overwriting your `Localizations.strings` file each time you run `genstrings`.
+
+It wraps `genstrings` and adds some basic merging capabilities (add and remove keys).
+
+## Why?
+
+When you run `genstrings` it goes through each of your specified `.m` files, looks for `NSLocalizedString`, parses out the key and comment, adds it to a Localizable.strings file.
+
+Downside to this utility: it completely overwrites any changes you make to the `Localizations.strings` file (or if you give it the `-a` flag, it will at least append).
+
+That's where `stringer` comes in, makes `genstrings` suck less.
+
+## Installation
+
+The easiest way to use `stringer` at the moment is to add a `Gemfile` to the root of your project and add `stringer` to it, like so:
+
+    gem 'stringer'
+
+Then execute:
+
+    $ bundle
+
+Now you can create a Rakefile, and add these lines:
+
+    require "stringer"
+
+    desc "Run genstrings to update the Localizable.strings files"
+    task :localize do
+      %w(en fr nl).each do |locale|
+        Stringer.run(locale)
+      end
+    end
+
+Now you can update your `Localizations.strings` file by running:
+
+    rake localize
+
+Which will output something like this:
+
+    Generating en.lproj
+     - Added 3 keys (die.tijd;duvels;piet...)
+     - Removed 1 key (dotter...)
+
+## The future
+
+`0.2.0`: Add a bin, so the Rake-file shenanigans are no longer necessary.
+
+`0.3.0`: Ditch the dependency `genstrings` and fetch strings ourselves.
+
+...
+
+`1.0.0`: Installed by default on OSX TomCat
+
+## Contributing
+
+Fork it! Improve it! Test it! Rewrite it! (technology)
+
+[![Build Status](https://secure.travis-ci.org/pjaspers/stringer.png?branch=master)](http://travis-ci.org/pjaspers/stringer)

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc 'Run the specs'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'specs'
+  t.pattern = 'specs/**/*_spec.rb'
+  t.verbose = true
+end
+
+task :default => :test
+
+desc "Open an pry session with Stringer loaded"
+task :console do
+  sh "pry -I lib -r stringer.rb"
+end

data/lib/stringer.rb

@@ -0,0 +1,11 @@
+require "stringer/version"
+require "stringer/strings_file"
+require "stringer/processor"
+
+module Stringer
+
+  def self.run(locale, options = {})
+    Stringer::Processor.new(locale, options).run
+  end
+
+end

data/lib/stringer/processor.rb

@@ -0,0 +1,90 @@
+module Stringer
+  class Processor
+
+    # The Processor will be doing the genstringing part of the
+    # operation.
+    #
+    # Possible options:
+    #
+    #    - file_folder  : Folder where `genstrings` should look for
+    #                     .m files. It searches this recursively.
+    #    - genstrings   : Location of the genstrings command
+    #    - lproj_parent : Path to folder containing the `<locale>.lproj`
+    #
+    def initialize(locale, options = {})
+      options       = default_options.merge(options)
+      @locale       = locale
+      @files_folder = options[:files_folder]
+      @genstrings   = options[:genstrings]
+      @lproj_parent = options[:lproj_parent]
+    end
+
+    # Some sensible defaults in a hash
+    def default_options
+      {
+        :lproj_parent => dir_path_for_dir_with_same_name_as_parent_dir,
+        :files_folder => dir_path_for_dir_with_same_name_as_parent_dir,
+        :genstrings => "/usr/bin/genstrings"
+      }
+    end
+
+    # If standard Xcode template is used, this is the dir where most
+    # files will be. For a project created with name "Something"
+    #
+    #      Something:
+    #        Something:
+    #          en.lproj/
+    #          *.m
+    #
+    # Returns the path
+    def dir_path_for_dir_with_same_name_as_parent_dir
+      current_dir_path = File.dirname(__FILE__)
+      current_dir_name = File.basename(current_dir_path)
+      File.join(current_dir_path, current_dir_name)
+    end
+
+    def genstrings_command
+      "#{@genstrings} -q -o #{lproj_folder} #{files.join(" ")}"
+    end
+
+    # Returns an array of all files needed to be processed.
+    def files
+      `find #{@files_folder} -name \*.m`.split("\n")
+    end
+
+    def run
+      log("Generating #{@locale}.lproj")
+      original_file = StringsFile.new(strings_file_path)
+      if system(genstrings_command)
+        new_file = StringsFile.new(strings_file_path)
+        added_keys, removed_keys = original_file.apply(new_file)
+        show_changes(added_keys, "Added")
+        show_changes(removed_keys, "Removed")
+      end
+      original_file.write!
+    end
+
+    def lproj_folder
+      File.join(@lproj_parent, "#{@locale}.lproj")
+    end
+
+    def strings_file_path
+      "#{lproj_folder}/Localizable.strings"
+    end
+
+    def log(message)
+      puts message
+    end
+
+    def show_changes(keys, string)
+      number = keys.count
+      if number == 1
+        string = " - #{string} #{number} key"
+      else
+        string = " - #{string} #{number} keys"
+      end
+      string << " (#{keys.join(";")[0..50]}...)" unless number == 0
+      log string
+    end
+  end
+end

data/lib/stringer/strings_file.rb

@@ -0,0 +1,70 @@
+module Stringer
+  class StringsFile
+    attr_accessor :lines
+
+    def initialize(path)
+      check_for_file(path)
+      @path = path
+      @lines = fetch_lines_at(path)
+    end
+
+    def check_for_file(path)
+      raise "No Localisations found at #{path}" unless File.exist?(path)
+    end
+
+    def fetch_lines_at(path)
+      IO.readlines(path, mode:"rb:UTF-16LE").collect do |l|
+        l.encode("UTF-8").gsub("\uFEFF", "")
+      end
+    end
+
+    def comment_lines
+      @lines.select{|l| l =~ /^\/\*/ }
+    end
+
+    def translation_lines
+      @lines.select{|l| l =~ /^"/}
+    end
+
+    def comments
+      @comments ||= comment_lines.collect do |line|
+        line.gsub("/*", "").gsub("*/", "").strip
+      end
+    end
+
+    def translation_hash
+      return @translation_hash if @translation_hash
+
+      @translation_hash = translation_lines.inject({}) do |r,line|
+        r[key_from_line(line)] = value_from_line(line)
+        r
+      end
+    end
+
+    def key_from_line(line)
+      line.split("=").first.gsub("\"", "").strip
+    end
+
+    def value_from_line(line)
+      line.split("=").last.strip.gsub(";", "").gsub("\"", "")
+    end
+
+    def apply(other_string_file)
+      removed_keys = translation_hash.keys - other_string_file.translation_hash.keys
+      added_keys = other_string_file.translation_hash.keys - translation_hash.keys
+      @translation_hash = other_string_file.translation_hash.merge(translation_hash)
+      removed_keys.each {|k| @translation_hash.delete(k)}
+      [added_keys, removed_keys]
+    end
+
+    def write!
+      File.open(@path, "wb:UTF-16LE") do |file|
+        file.write("\uFEFF")
+        file.write("/* Generated */\n")
+        translation_hash.each do |key, value|
+          file.puts "\"#{key}\" = \"#{value}\";"
+        end
+      end
+    end
+  end
+end

data/lib/stringer/version.rb

@@ -0,0 +1,3 @@
+module Stringer
+  VERSION = "0.0.1"
+end

data/specs/helper.rb

@@ -0,0 +1,17 @@
+require "minitest/autorun"
+require "mocha"
+
+begin
+  # [turn](http://rubygems.org/gems/turn)
+  require 'turn/autorun'
+rescue LoadError
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'stringer'
+
+def locale_file_path
+    File.join(File.dirname(__FILE__), "Localizable.strings")
+end

data/specs/processor_spec.rb

@@ -0,0 +1,21 @@
+require "helper"
+
+describe Stringer::Processor do
+
+  describe "creating the genstrings command" do
+
+    it "should use sensible defaults if no options given" do
+      Stringer::Processor.any_instance.stubs(:dir_path_for_dir_with_same_name_as_parent_dir).returns("path")
+      processor = Stringer::Processor.new("nl")
+      processor.stubs(:files).returns(["file_a"])
+      processor.genstrings_command.must_equal("/usr/bin/genstrings -q -o path/nl.lproj file_a")
+    end
+
+    it "should use the supplied options" do
+      processor = Stringer::Processor.new("nl", :files_folder => "files", :lproj_parent => "lproj_parent", :genstrings => "/opt/bin/genstrings")
+      processor.stubs(:files).returns(["file_a"])
+      processor.genstrings_command.must_equal("/opt/bin/genstrings -q -o lproj_parent/nl.lproj file_a")
+    end
+
+  end
+end

data/specs/string_file_spec.rb

@@ -0,0 +1,35 @@
+require "helper"
+
+describe Stringer::StringsFile do
+
+  it "should have loaded the lines from the file" do
+    file = Stringer::StringsFile.new(locale_file_path)
+    file.lines.wont_be_empty
+  end
+
+  it "should raise if no file found" do
+    -> {Stringer::StringsFile.new("404")}.must_raise RuntimeError
+  end
+
+  describe "transforming file to strings" do
+    before do
+      lines = ["/* A comment */",
+               "\"a.key\" = \"Translated Key\";\n"]
+      Stringer::StringsFile.any_instance.expects(:fetch_lines_at).with("path").returns(lines)
+      Stringer::StringsFile.any_instance.stubs(:check_for_file).with("path").returns(nil)
+      @file = Stringer::StringsFile.new("path")
+    end
+
+    it "should have transformed the comments" do
+      @file.comments.first.must_equal("A comment")
+    end
+
+    it "should have extracted the keys" do
+      @file.translation_hash["a.key"].wont_be_nil
+    end
+
+    it "should have extracted the value" do
+      @file.translation_hash["a.key"].must_equal "Translated Key"
+    end
+  end
+end

data/specs/stringer_spec.rb

@@ -0,0 +1,11 @@
+require "helper"
+
+describe Stringer do
+
+  it "should tell the processor to run :)" do
+    proc = mock("Stringer::Processor")
+    proc.expects(:run)
+    Stringer::Processor.expects(:new).with("en", {}).returns(proc)
+    Stringer.run("en")
+  end
+end

data/stringer.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stringer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stringer"
+  gem.version       = Stringer::VERSION
+  gem.authors       = ["pjaspers"]
+  gem.email         = ["piet@jaspe.rs"]
+  gem.description   = %q{Stringer: a wrapper for genstrings}
+  gem.summary       = %q{Stringer adds merging capabilities to genstrings}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|specs|features)/})
+  gem.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: stringer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- pjaspers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-02 00:00:00.000000000 Z
+dependencies: []
+description: ! 'Stringer: a wrapper for genstrings'
+email:
+- piet@jaspe.rs
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stringer.rb
+- lib/stringer/processor.rb
+- lib/stringer/strings_file.rb
+- lib/stringer/version.rb
+- specs/Localizable.strings
+- specs/helper.rb
+- specs/processor_spec.rb
+- specs/string_file_spec.rb
+- specs/stringer_spec.rb
+- stringer.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1114274200452902360
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1114274200452902360
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Stringer adds merging capabilities to genstrings
+test_files:
+- specs/Localizable.strings
+- specs/helper.rb
+- specs/processor_spec.rb
+- specs/string_file_spec.rb
+- specs/stringer_spec.rb