lokale 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 36f4dfe95a8d5ab359a7e8e8533a0870316bbb6b
+  data.tar.gz: 3d3fa77a8ab9dbef6d5a1b65f2ef06b0e6ba83f8
+SHA512:
+  metadata.gz: 329c3243dd0410f237bb55a650f102c10d132cf37089f6f177b51894604fd43dc62a8fe5535240f0d3f6aa9962a1ee0069f9b7bd022920e2a1d19b7813097328
+  data.tar.gz: 95eb3e99e7a0356f8efce8b51f78c37453f41dd6f3f6e786009344293247b83a4909fcc9698789a67d63414bcac80160a97766f84870f332dd4c73beeff54d73

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in lokale.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 TODO: Write your name
+
+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,39 @@
+# Lokale
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/lokale`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lokale'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lokale
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/lokale.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lokale"
+
+# 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(__FILE__)

data/bin/lokale

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require 'lokale'
+
+macros = [
+    Lokale::Macro.new("NSLocalizedString", /NSLocalizedString\("(.+?)",\s*comment:\s*"(.*?)"\)/), 
+    Lokale::Macro.new("PluralString", /String.localizedPlural\("(.+?)"/),
+    #LocalizationMacro.new("ObjC String", /NSLocalizedString\("(.*)",\s*(.*)\)/),
+    #LocalizationMacro.new("ObjC Table String", /NSLocalizedStringFromTableInBundle\((.*?),/)
+]
+
+puts Dir.pwd
+agent = Lokale::Agent.new(Dir.pwd, macros)
+reporter = Lokale::Reporter.new(agent)
+reporter.print_summary

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/lib/lokale/version.rb

@@ -0,0 +1,3 @@
+module Lokale
+  VERSION = "0.1.0"
+end

data/lib/lokale.rb

@@ -0,0 +1,280 @@
+# require "lokale/version"
+require "set"
+
+class String
+  def rpadded(count=20)
+    "%-#{count}.#{count}s" % self
+  end
+
+  def lpadded(count=20)
+    "%#{count}.#{count}s" % self
+  end
+
+  def localization_file?
+    File.directory?(self) == false &&
+        (self =~ /\/Pods\//) == nil &&
+        (self =~ /\.bundle\//) == nil &&
+        (self =~ /\/(.{1,8})\.lproj\//)
+  end
+
+  def source_file?
+    (File.directory?(self) == false) && (self =~ /\/Pods\//).nil? && ((self =~ /\.(swift|h|m)$/) != nil)
+  end
+end
+
+module Lokale 
+
+  class LocalizedString    
+    attr_accessor :key, :str, :note, :target
+
+    def initialize(key, str, note, target)
+      @key = key; @str = str; @note = note; @target = target
+    end
+
+    def self.strings_from_file(file_path, lang)
+      regex = /(?:\/* (.+) *\/.*\n)?"(.+)" *= *"(.+)";/
+      File.read(file_path).scan(regex).map { |m| LocalizedString.new(m[1], m[2], m[0], lang) }
+    end
+  end
+
+  #
+
+  class LocalizationFile
+    attr_reader :path, :lang, :name, :type
+    def initialize(file_path)
+      @path = file_path
+
+      File.basename(file_path) =~ /^(.+)\.([^\.]*?)$/
+      @name = $1
+      @type = $2
+
+      file_path =~ /\/(.{1,8})\.lproj\//
+      @lang = $1
+    end
+
+    def self.try_to_read(file_path)
+      return nil unless file_path.localization_file?
+      LocalizationFile.new(file_path)
+    end
+
+    def inspect 
+      "<#{@lang}/#{full_name}>"
+    end
+
+    def full_name
+      "#{@name}.#{@type}"
+    end
+
+    def parsed
+      return @parsed unless @parsed.nil?
+      @parsed = case type
+        when "strings"      then LocalizedString.strings_from_file(@path, @lang)
+        when "stringsdict"  then []
+        else nil
+      end      
+    end
+
+    def repeats
+      return [] if @parsed.nil?
+      keys = @parsed.map(&:key)
+      uniq_keys = keys.to_set
+
+      keys.delete_if do |k|
+        if uniq_keys.include? k
+          uniq_keys.delete k
+          true
+        end
+      end
+    end
+
+    def keys 
+      return nil if parsed.nil?
+      parsed.map(&:key)
+    end
+  end
+
+  #
+
+  class Macro
+    attr_reader :regex, :found_strings, :name
+
+    def initialize(name, regex)
+      @name = name
+      @regex = regex
+      clear_calls
+    end 
+
+    def clear_calls
+      @found_strings = Hash.new { |h, k| h[k] = 0 }
+    end
+
+    def read_from(file)
+      file.scan(@regex) { |m| @found_strings[m] += 1 }
+    end
+
+    def uniq_count
+      @found_strings.size
+    end
+
+    def total_count
+      @found_strings.values.reduce(:+) || 0
+    end
+  end
+
+
+  #
+  #
+  #
+  #
+
+  class Agent
+    attr_reader :proj_path, :macros, :lfiles, :sfiles_proceeded
+
+    def initialize(proj_path, macros)
+      @proj_path = proj_path
+      @macros = macros
+
+      get_localization_files
+      find_all_localization_calls
+    end
+
+    def proj_files 
+      Dir.glob("#{@proj_path}/**/**")
+    end
+
+    def get_localization_files
+      return @lfiles unless @lfiles.nil?
+      @lfiles = proj_files.map { |file| LocalizationFile.try_to_read(file) }.compact
+    end
+
+    def find_all_localization_calls
+      @macros.each { |m| m.clear_calls }
+
+      @sfiles_proceeded = 0
+      proj_files.each do |file| 
+        next unless file.source_file?        
+
+        file_content = File.read(file)
+        @macros.each { |macro| macro.read_from file_content }
+        @sfiles_proceeded += 1
+      end
+    end
+  end
+
+  #
+
+  class Reporter
+    def initialize(agent)
+      @agent = agent
+    end
+
+    def print_summary
+      print_macro_calls_summary
+      print_macro_table
+      print_files_table
+      print_repeats_report
+      print_diferences_report
+    end 
+
+    def print_macro_calls_summary
+      total_macro_calls = @agent.macros.map(&:total_count).reduce(:+)
+      uniq_macro_calls = @agent.macros.map(&:uniq_count).reduce(:+)
+      puts "Found #{total_macro_calls} localization macro calls in #{@agent.sfiles_proceeded} files."
+      puts "Uniq macro calls: #{uniq_macro_calls}"
+      puts
+    end
+
+
+    def print_files_table
+      languages = @agent.lfiles.map { |e| e.lang }.to_set.to_a
+      files = @agent.lfiles.map { |e| e.full_name }.to_set.to_a
+
+      puts "Found #{@agent.lfiles.size} localized files for #{languages.size} languages."
+
+      description_header = "[*]".rpadded(36)
+      languages.each { |l| description_header << l.rpadded(8) }
+      puts description_header
+
+      files.each do |f|
+        description_string = f.rpadded(36)
+        languages.each do |l|
+          lfile = @agent.lfiles.select { |lf| lf.full_name == f && lf.lang == l }
+          description_string << (lfile.empty? ? "-" : lfile[0].parsed.nil? ? "*" : "#{lfile[0].parsed.size}").rpadded(8)
+        end
+        puts description_string
+      end
+      puts
+    end
+
+    def print_macro_table
+      @agent.macros.each do |macro|
+        puts "#{macro.name}:".rpadded(24) + "total: #{macro.total_count}".rpadded(16) + "uniq: #{macro.uniq_count}"
+      end
+      puts
+    end
+
+    def print_repeats_report
+      repeats_repot = ""
+      @agent.lfiles.each do |lf| 
+        repeats = lf.repeats
+        next if repeats.count.zero?
+        repeats_repot << "#{lf.lang}/#{lf.full_name} repeats:\n"
+        repeats_repot << repeats.join("\n")
+        repeats_repot << "\n"
+      end
+
+      if repeats_repot.empty? 
+        puts "Repeats not found."
+        puts
+      else
+        puts repeats_repot
+        puts
+      end
+    end
+
+    def print_diferences_report
+      diferences_repot = ""
+
+      @agent.lfiles.group_by { |f| f.full_name }.each do |file_name, files|
+        base_lang = files.select { |f| f.lang == "Base" }.first.nil? ? "en" : "Base"
+        files = files.select { |f| f.lang != base_lang }
+        all_keys = files.map(&:keys).compact.map(&:to_set)
+        next if all_keys.empty?
+        shared_keys = all_keys.reduce(:&)
+        all_keys.map! { |ks| ks - shared_keys }
+        next if all_keys.map(&:length).reduce(:+).zero?
+
+        diferences_repot << "Excess keys in file \"#{file_name}\":\n"
+        all_keys.zip(files) do |excess_keys, lfile|
+          next if excess_keys.size.zero?
+          diferences_repot << "* #{lfile.lang}: #{excess_keys.size} key(s).\n"
+          excess_keys.each { |k| diferences_repot << "#{k}\n" }
+        end
+        diferences_repot << "\n"
+      end
+
+      if diferences_repot.empty? 
+        puts "Localization files are full."
+        puts
+      else
+        puts "Localization files are not full."
+        puts
+        puts diferences_repot
+        puts
+      end
+    end 
+  end
+end
+
+
+
+# macros = [
+#     Lokale::Macro.new("NSLocalizedString", /NSLocalizedString\("(.+?)",\s*comment:\s*"(.*?)"\)/), 
+#     Lokale::Macro.new("PluralString", /String.localizedPlural\("(.+?)"/),
+#     #LocalizationMacro.new("ObjC String", /NSLocalizedString\("(.*)",\s*(.*)\)/),
+#     #LocalizationMacro.new("ObjC Table String", /NSLocalizedStringFromTableInBundle\((.*?),/)
+# ]
+
+# agent = Lokale::Agent.new("/Users/crysberry/Documents/hand2hand", macros)
+# reporter = Lokale::Reporter.new(agent)
+# reporter.print_summary

data/lokale.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "lokale/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "lokale"
+  spec.version       = Lokale::VERSION
+  spec.authors       = ["Anton Onizhuk"]
+  spec.email         = ["anton.onizhuk@gmail.com"]
+
+  spec.summary       = %q{Lokale is a small tool that inspects localization of Xcode projects.}
+  spec.description   = %q{Write a longer description or delete this line.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing 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 -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ["lokale"]
+  spec.require_paths = ["lib"]
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: lokale
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Onizhuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-18 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- anton.onizhuk@gmail.com
+executables:
+- lokale
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/lokale
+- bin/setup
+- lib/lokale.rb
+- lib/lokale/version.rb
+- lokale.gemspec
+homepage: 
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Lokale is a small tool that inspects localization of Xcode projects.
+test_files: []