i18n-cocoa 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 211d87eb1540d27dba3ed74c5f3ab0489f84893b
-  data.tar.gz: 611f40a2e50f1d4dac3e3a49f6c32a3054cef3b2
+  metadata.gz: a1eb0526aedea5961090b2d46dd620bf93c8ecab
+  data.tar.gz: 4b7051aece56792387f818b966d5db3a67979438
 SHA512:
-  metadata.gz: ed78a710294ff7db0633e4fa9dcb7ab1c059568f668e489ecaac88a34909492683837078d0c7d0e1f233d4347b08ee30019efda481c55c5e607ba20b62a086c2
-  data.tar.gz: 520c45d09e3e65ed2c3baef4e9efcb1f49c5745a855381a7ea515166dabeca34639277d4a1a192ca7becac33327d045512a81e0dd59b96c6d5cd323ffcd59cfe
+  metadata.gz: cd10d236fa6d9fe5f6a66ce8887fa5052bfa0a40dda202e923466b92b783d346580f6734eef308663b69d7b689141018d3ad18f440a1631e3cac1a4f28e8ae7e
+  data.tar.gz: 8f995eb12b31fb268ab60d7d27cda0816de7778f0e7ab45af513e18046b78e139140177c89b291271a751da7617c5398c46f56f5c942e34b70f6f17709f3f9dc

data/README.md

@@ -1,7 +1,13 @@
-I18n::Cocoa
+i18n::Cocoa
 ===========
 
-Manage translation and localization with static analysis, for iOS, OSX
+i18n-cocoa manages translation and localization with analysis, for iOS, OSX.
+It helps you find to missing and unused localized strings in file.
+
+Support languages
+----------
+
+Objective-C, Objective-C++, Swift
 
 Installation
 ----------
@@ -23,19 +29,39 @@ Or install it yourself as:
 Usage
 ----------
 
-**Check health**
+### Check health
+
+`I18n::Cocoa.health` checks if any keys are missing or not used:
 ```ruby
+require 'i18n/cocoa'
+
+success, failure_issues = I18n::Cocoa.health
+```
+
+**Custom macro and specify directory**
+```ruby
+require 'i18n/cocoa'
 
 attributes = {:localized_macro_string => 'LocalizedString', :search_path => 'iOSProject'}
 success, failure_issues = I18n::Cocoa.health attributes
+```
+
+### Remove unused keys
 
+`I18n::Cocoa.remove_unused` remove unused keys from `.strings` file if any keys are not used:
+```ruby
+require 'i18n/cocoa'
+
+success, failure_issues = I18n::Cocoa.remove_unused
 ```
 
+
 Features
 ----------
 
 - [x] Ensure to not forget to add localized string literal with key in `.strings` files
 - [x] Find to unused localizaed key in files and strip them from these files
+- [ ] Output documentation
 - [ ] Comprehensive Unit Test Coverage
 
 Contributing

data/lib/i18n/cocoa.rb

@@ -8,18 +8,22 @@ module I18n
   module Cocoa
 
     def self.health attributes = {}
-      finder = Finder.new(config.update attributes)
+      finder = Finder.new(attributes)
       finder.ensure_localization
 
       unused_keys = finder.find_unused_localization
       finder.delete_localization_keys unless unused_keys.empty?
     end
 
-    def self.config
-      {
-        :localized_macro_string => 'NSLocalizedString',
-        :search_path            => '.'
-      }
+    def self.unused attributes = {}
+      finder = Finder.new(attributes)
+      finder.find_unused_localization
+    end
+
+    def self.remove_unused attributes = {}
+      finder = Finder.new(attributes)
+      unused_keys = finder.find_unused_localization
+      finder.delete_localization_keys unless unused_keys.empty?
     end
 
   end

data/lib/i18n/cocoa/finder.rb

@@ -6,11 +6,19 @@ module I18n
     class Finder
 
       def initialize attributes
-        @localized_macro_string = attributes[:localized_macro_string]
+        config = default_config.update attributes
+        @localized_macro_string = config[:localized_macro_string]
         @method_file_paths = []
         @localized_file_paths = []
 
-        _search_file_paths File.absolute_path(attributes[:search_path])
+        _search_file_paths File.absolute_path(config[:search_path])
+      end
+
+      def default_config
+        {
+          :localized_macro_string => 'NSLocalizedString',
+          :search_path            => '.'
+        }
       end
 
       def ensure_localization

data/lib/i18n/cocoa/version.rb

@@ -2,6 +2,6 @@
 
 module I18n
   module Cocoa
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: i18n-cocoa
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Hirohisa Kawasaki
@@ -69,7 +69,7 @@ files:
 - spec/spec_helper.rb
 - README.md
 - LICENSE
-homepage: ''
+homepage: https://github.com/hirohisa/i18n-cocoa
 licenses:
 - MIT
 metadata: {}