i18n-cocoa 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1eb0526aedea5961090b2d46dd620bf93c8ecab
-  data.tar.gz: 4b7051aece56792387f818b966d5db3a67979438
+  metadata.gz: 6f1db96f338cb21a8c6508b5dfd2fafd5c361c45
+  data.tar.gz: 9b2796a5325d819a1ab4c6a81fd2e7bbcb6fe35e
 SHA512:
-  metadata.gz: cd10d236fa6d9fe5f6a66ce8887fa5052bfa0a40dda202e923466b92b783d346580f6734eef308663b69d7b689141018d3ad18f440a1631e3cac1a4f28e8ae7e
-  data.tar.gz: 8f995eb12b31fb268ab60d7d27cda0816de7778f0e7ab45af513e18046b78e139140177c89b291271a751da7617c5398c46f56f5c942e34b70f6f17709f3f9dc
+  metadata.gz: 3797e915cc12f784c986eaff184a44bfa356c1933bca3bf5e58f610033d4fdf331a9aaf6ed1c11c79dadb1466252cd5da7ec07124fd103488a72cdc0be70cb86
+  data.tar.gz: 63bc6068a590970076a1af00ab7eb5c4d0ad6137715e514debdc798fbe305d5fb11c631491c1e300ca5048e683ec19b38fbdde04be973f59facbdce64f6d0f81

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Hirohisa Kawasaki, Shiya Keita
+Copyright (c) 2015 Hirohisa Kawasaki, Keita Shiya
 
 MIT License
 

data/README.md

@@ -1,4 +1,4 @@
-i18n::Cocoa
+i18n::Cocoa [![Gem-version](https://img.shields.io/gem/v/i18n-cocoa.svg)](https://rubygems.org/gems/i18n-cocoa) [![Gem-downloads](https://img.shields.io/gem/dt/i18n-cocoa.svg)](https://rubygems.org/gems/i18n-cocoa) [![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/hirohisa/i18n-cocoa/blob/master/LICENSE)
 ===========
 
 i18n-cocoa manages translation and localization with analysis, for iOS, OSX.
@@ -60,8 +60,9 @@ 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
+- [x] Find to unused localized keys in files and strip them from these files
+- [x] Documentation
+- [ ] Find unused localized keys in files per language
 - [ ] Comprehensive Unit Test Coverage
 
 Contributing

data/lib/i18n/cocoa/finder.rb

@@ -5,8 +5,13 @@ module I18n
 
     class Finder
 
+      # search files and scan code class
+      #
+      # default setting, it scan macro format is 'NSLocalizedString' in current directory.
+      #
+      # @param [hash]     attributes are settings data about file path, marco ...more.
       def initialize attributes
-        config = default_config.update attributes
+        config = _default_config.update attributes
         @localized_macro_string = config[:localized_macro_string]
         @method_file_paths = []
         @localized_file_paths = []
@@ -14,13 +19,10 @@ module I18n
         _search_file_paths File.absolute_path(config[:search_path])
       end
 
-      def default_config
-        {
-          :localized_macro_string => 'NSLocalizedString',
-          :search_path            => '.'
-        }
-      end
-
+      # validate localization
+      #
+      # @return [bool]    result for validation, success is true, failure is false
+      # @return [array]   failure issues for localization
       def ensure_localization
         failure_issues = []
 
@@ -38,8 +40,10 @@ module I18n
         [failure_issues.count == 0, failure_issues]
       end
 
+      # use localized key but key doesnt exist in strings file
+      #
+      # @return [array]   unused keys that are not include code in project, exist in localized strings file
       def find_unused_localization
-        # use localized key but key doesnt exist in strings file
         used_keys = _get_used_localized_keys_from_method_files
         localized_keys = _get_localized_keys_from_strings_files
 
@@ -48,13 +52,26 @@ module I18n
         unused_keys
       end
 
+      # remove localized keys from localized strings file
+      #
+      # @param [array]    keys are localized keys for removing from strings file
+      # @return [bool]    true when finish to run
       def delete_localization_keys keys
         for file_path in @localized_file_paths do
           _rewrite_strings_file file_path, keys
         end
+
+        true
       end
 
       private
+      def _default_config
+        {
+          :localized_macro_string => 'NSLocalizedString',
+          :search_path            => '.'
+        }
+      end
+
       def _search_file_paths directory_path
         Dir::foreach(directory_path) do |f|
           current_file_path = "#{directory_path}/#{f}"

data/lib/i18n/cocoa/utils.rb

@@ -2,7 +2,11 @@ module I18n
   module Cocoa
 
     class Issue
-      attr_reader :description, :values
+      # @return [string]    set information
+      attr_reader :description
+
+      # @return [array]     set problem's data
+      attr_reader :values
 
       def initialize description, values
         @description = description

data/lib/i18n/cocoa/version.rb

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

data/lib/i18n/cocoa.rb

@@ -7,23 +7,46 @@ require "i18n/cocoa/finder"
 module I18n
   module Cocoa
 
+    # validate localization and strip unused keys
+    #
+    # @param [hash]     attributes if you want to change from default attributes
+    # default attributes
+    #   :localized_macro_string => 'NSLocalizedString',
+    #   :search_path            => '.'
+    #
+    # @return [bool]    true when finish to run with success
     def self.health attributes = {}
       finder = Finder.new(attributes)
-      finder.ensure_localization
+      result, issues = finder.ensure_localization
+      return false unless result
 
       unused_keys = finder.find_unused_localization
       finder.delete_localization_keys unless unused_keys.empty?
+
+      true
     end
 
+    # find unused keys from localized strings files
+    #
+    # @param [hash]     attributes if you want to change from default attributes
+    # @return [array]    unused keys that are not include code in project, exist in localized strings file
     def self.unused attributes = {}
       finder = Finder.new(attributes)
-      finder.find_unused_localization
+      unused_keys = finder.find_unused_localization
+
+      unused_keys
     end
 
+    # find unused keys and strip them  from localized strings files
+    #
+    # @param [hash]     attributes if you want to change from default attributes
+    # @return [bool]    true when finish to run with success
     def self.remove_unused attributes = {}
       finder = Finder.new(attributes)
       unused_keys = finder.find_unused_localization
       finder.delete_localization_keys unless unused_keys.empty?
+
+      true
     end
 
   end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: i18n-cocoa
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Hirohisa Kawasaki
-- Shiya Keita
+- Keita Shiya
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,3 +96,4 @@ summary: Manage translation and localization
 test_files:
 - spec/i18n/cocoa_spec.rb
 - spec/spec_helper.rb
+has_rdoc: