i18n_checker 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e19d1fb49c3cf080cc470ee645bdf19bac8ca955
-  data.tar.gz: f96f63a7b74fe6fa6a002b7520c737610ad4a2c4
+  metadata.gz: 5f5558d107c756fa782ad6a425a9c13189e96fc5
+  data.tar.gz: 321f55bfa86d773d871532ce7c4aab9105e0eb31
 SHA512:
-  metadata.gz: a1d0b632d0049108127d9e34cfb86984edf5475ca6bab05ca623fc5689116edcb4bf69cd0b73b5fd2830cbb58dcb181520fc975f83efe9f1f2ae99b432739d18
-  data.tar.gz: 06c158aad02010d206904d62cacfc729f0d3500ec9f33ab13a5d412be6b1ac79e745635b0de7e215a54bf30f315c5fa954d2f02dd7ec65d8ab163bb3c8b49edb
+  metadata.gz: f83fcce7f6caba897b78d27557090394e69802fd3034ecde81d2dbacafd992b4cbfb464a326535ac16615e9739152085de28b81003b834e685a74de5bd047d1f
+  data.tar.gz: df76434f18429622f5da5680e6b55a9db20d138f61d525d83b2bf6bb361b8415878095ebfde46fd55fd6dca76ccfa24305d065c46d07f209ccec6916a249800d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    i18n_checker (0.5.0)
+    i18n_checker (0.6.0)
       colorator (~> 1.1.0)
       haml_parser (~> 0.4)
       parser
@@ -44,6 +44,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.6.0)
     rspec-support (3.6.0)
+    rspec-temp_dir (1.0.0)
+      rspec (>= 3.0)
     rubocop (0.47.1)
       parser (>= 2.3.3.1, < 3.0)
       powerpack (~> 0.1)
@@ -67,6 +69,7 @@ GEM
     thor (0.19.4)
     tins (1.13.2)
     unicode-display_width (1.1.3)
+    yard (0.9.9)
 
 PLATFORMS
   ruby
@@ -78,8 +81,10 @@ DEPENDENCIES
   onkcop
   rake (~> 10.0)
   rspec
+  rspec-temp_dir
   simplecov
   simplecov-console
+  yard
 
 BUNDLED WITH
    1.14.6

data/README.md

@@ -14,12 +14,18 @@ Current version supports Ruby source code, Haml template file.
 
 ## Basic usage
 
+Detected out of reference text, Delete unused translation text at once.  
 Add the following tasks to your **Rakefile**.
 
 ```ruby
 require 'i18n_checker/rake_task'
 
-I18nChecker::RakeTask::LocaleCheck.new do |task|
+I18nChecker::RakeTask::Check.new do |task|
+  task.source_paths = FileList['app/models/*', 'app/views/*'] # haml templates, ruby sources
+  task.locale_file_paths = FileList['config/locales/*'] # locale file paths
+end
+
+I18nChecker::RakeTask::Clean do |task|
   task.source_paths = FileList['app/models/*', 'app/views/*'] # haml templates, ruby sources
   task.locale_file_paths = FileList['config/locales/*'] # locale file paths
 end
@@ -29,6 +35,47 @@ After that we just execute the task.
 
 ```shell
 bundle exec rake locale_check
+bundle exec rake locale_clean
+```
+
+## Check translation of translated text
+
+Detect translated text references that are broken.  
+It is useful for detecting text that is not in the translation file of a particular language.
+
+```ruby
+require 'i18n_checker/rake_task'
+
+I18nChecker::RakeTask::Check.new do |task|
+  task.source_paths = FileList['app/models/*', 'app/views/*'] # haml templates, ruby sources
+  task.locale_file_paths = FileList['config/locales/*'] # locale file paths
+end
+```
+
+After that we just execute the task.
+
+```shell
+bundle exec rake locale_check
+```
+
+## Delete unused translated text
+
+Using the **locale_clean** task you can delete unused translated text from the file.  
+Since you can delete translated text that you do not use safely, you can reduce the maintenance cost by running it periodically.
+
+```ruby
+require 'i18n_checker/rake_task'
+
+I18nChecker::RakeTask::Clean do |task|
+  task.source_paths = FileList['app/models/*', 'app/views/*'] # haml templates, ruby sources
+  task.locale_file_paths = FileList['config/locales/*'] # locale file paths
+end
+```
+
+After that we just execute the task.
+
+```shell
+bundle exec rake locale_clean
 ```
 
 ## Run the test

data/Rakefile

@@ -1,12 +1,22 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yard'
 require 'i18n_checker/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-I18nChecker::RakeTask::LocaleCheck.new do |task|
+I18nChecker::RakeTask::Check.new do |task|
   task.source_paths = FileList['spec/fixtures/haml/*', 'spec/fixtures/ruby/*']
   task.locale_file_paths = FileList['spec/fixtures/locales/**']
 end
 
+I18nChecker::RakeTask::Clean.new do |task|
+  task.source_paths = FileList['examples/unused/**']
+  task.locale_file_paths = FileList['examples/unused/locales/**']
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
 task :default => :spec

data/examples/unused/example.haml

@@ -0,0 +1 @@
+%p= t('nested.foo')

data/examples/unused/example.rb

@@ -0,0 +1,11 @@
+module Example
+  class Example
+    def foo
+      t('nested.foo')
+    end
+
+    def bar
+      I18n.t('nested.bar')
+    end
+  end
+end

data/examples/unused/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  nested:
+    foo: foo
+    bar: bar
+  nested2:
+    foo: foo
+    bar: bar

data/examples/unused/locales/ja.yml

@@ -0,0 +1,7 @@
+ja:
+  nested:
+    foo: foo
+    bar: bar
+  nested2:
+    foo: foo
+    bar: bar

data/i18n-checker.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
+  spec.metadata['yard.run'] = 'yri'
   spec.add_dependency 'haml_parser', '~> 0.4'
   spec.add_dependency 'colorator', '~> 1.1.0'
   spec.add_dependency 'parser'
@@ -29,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov-console'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'onkcop'
+  spec.add_development_dependency 'rspec-temp_dir'
+  spec.add_development_dependency 'yard'
 end

data/lib/i18n_checker/command/check.rb

@@ -0,0 +1,22 @@
+require 'i18n_checker/not_found/detector'
+require 'i18n_checker/not_found/text'
+require 'i18n_checker/not_found/result'
+
+module I18nChecker
+  module Command
+    class Check
+      def initialize(locale_file_paths: [], source_paths: [], reporter:)
+        @reporter = reporter
+        @locale_texts = I18nChecker::Locale.texts_of(source_paths)
+        @locale_files = I18nChecker::Locale.load_of(locale_file_paths)
+      end
+
+      def check
+        not_found_detector = I18nChecker::NotFound::Detector.new(@locale_files)
+        not_found_result = @locale_texts.detect(not_found_detector)
+        @reporter.report not_found_result
+        yield not_found_result if block_given?
+      end
+    end
+  end
+end

data/lib/i18n_checker/command/clean.rb

@@ -0,0 +1,21 @@
+require 'i18n_checker/unused/detector'
+
+module I18nChecker
+  module Command
+    class Clean
+      def initialize(locale_file_paths: [], source_paths: [], reporter:)
+        @reporter = reporter
+        @locale_texts = I18nChecker::Locale.texts_of(source_paths)
+        @locale_files = I18nChecker::Locale.load_of(locale_file_paths)
+        @unused_detector = I18nChecker::Unused::Detector.new(@locale_files)
+      end
+
+      def run
+        unused_result = @locale_texts.detect(@unused_detector)
+        @reporter.report unused_result
+        unused_result.apply(@locale_files)
+        yield unused_result if block_given?
+      end
+    end
+  end
+end

data/lib/i18n_checker/locale/file.rb

@@ -2,29 +2,71 @@ require 'yaml'
 
 module I18nChecker
   module Locale
+    # Translation file for each language
+    #
+    # @attr_reader [String] file_name Translation file path
+    # @attr_reader [String] lang language
+    # @attr_reader [Hash<String,String>] locale_texts translation texts
     class File
-      attr_reader :lang, :locale_texts
+      attr_reader :file_name, :lang, :locale_texts
 
       class << self
-        def load_yaml(s)
-          new(YAML.load(s))
-        end
-
+        # Read translation file
+        #
+        # @param yaml_file [String] Translation file path
+        # @return [I18nChecker::Locale::File] Translation file
         def load_yaml_file(yaml_file)
-          load_yaml(::File.open(yaml_file, &:read))
+          new(yaml_file, YAML.load(::File.open(yaml_file, &:read)))
         end
       end
 
-      def initialize(locale_texts = {})
+      # Create a translation file
+      #
+      # @param yaml_file [String] Translation file path
+      # @param locale_texts [Hash<String,String>] translation text
+      def initialize(yaml_file, locale_texts = {})
         lang = locale_texts.keys.first
         @lang = lang.to_sym
         @locale_texts = compact_of(locale_texts[lang] || {})
+        @file_name = yaml_file
       end
 
+      # Check for translated text
+      #
+      # @param locale_text [Stirng] Translation text key
+      # @return [Boolean] Returns true if there is translated text
       def include?(locale_text)
         @locale_texts.key?(locale_text.text)
       end
 
+      # Deletes the specified translation text
+      #
+      # @param locale_text [Array<Stirng>] Translation text key
+      # @return [I18nChecker::Locale::File] New translation file
+      def remove_texts(locale_texts)
+        registry = locale_texts.map { |locale_text| [locale_text, true] }.to_h
+
+        current_locale_texts = @locale_texts.dup
+        current_locale_texts.delete_if { |locale_text| registry.key?(locale_text) }
+
+        remain_texts = {}
+        remain_texts[@lang] = current_locale_texts
+
+        self.class.new(file_name, remain_texts)
+      end
+
+      # Save the translation file
+      #
+      # @return [I18nChecker::Locale::File] translation file
+      def save
+        locale = {}
+        locale[@lang.to_s] = tree_of(locale_texts)
+        yaml_file = ::File.open(file_name, 'w')
+        yaml_file.write(YAML.dump(locale))
+        yaml_file.close
+        self
+      end
+
       private
 
         def compact_of(values = {}, path = KeyPath.new)
@@ -40,6 +82,26 @@ module I18nChecker
           end
           result
         end
+
+        def tree_of(values = [])
+          result = {}
+          values.each do |path, value|
+            dest = nil
+            paths = path.split('.')
+            last_key = paths.last
+            paths.pop
+            paths.each do |p|
+              if result.key?(p)
+                dest = result[p]
+              else
+                result[p] = {}
+                dest = result[p]
+              end
+            end
+            dest[last_key] = value
+          end
+          result
+        end
     end
   end
 end

data/lib/i18n_checker/locale/files.rb

@@ -9,10 +9,19 @@ module I18nChecker
 
       def_delegators :locale_files, :size, :each
 
+      # Translation files for each language
+      #
+      # @param locale_files [Array<I18nChecker::Locale::File>]
       def initialize(locale_files = [])
         @locale_files = locale_files
       end
 
+      # Execute the specified block and delete the translation file
+      #
+      # @yield [file] Block to be evaluated
+      # @yieldparam [I18nChecker::Locale::File]
+      # @yieldreturn [Boolean]
+      # @return [I18nChecker::Locale::Files]
       def delete_if(&block)
         locale_files.delete_if(&block)
         self

data/lib/i18n_checker/locale/text.rb

@@ -1,8 +1,20 @@
 module I18nChecker
   module Locale
+    # Translation text referenced from the file
+    #
+    # @attr_reader [String] file File referring to translated text
+    # @attr_reader [String] text Translation text key
+    # @attr_reader [Fixnum] line Line number of file
+    # @attr_reader [Fixnum] column Column number of file
     class Text
       attr_reader :file, :text, :line, :column
 
+      # Create translated text
+      #
+      # @param file [String] File referring to translated text
+      # @param text [String] Translation text key
+      # @param line [Fixnum] Line number of file
+      # @param column [Fixnum] Column number of file
       def initialize(file:, text:, line:, column:)
         @file = file
         @text = text

data/lib/i18n_checker/locale/texts.rb

@@ -3,27 +3,42 @@ require 'i18n_checker/locale/text'
 
 module I18nChecker
   module Locale
+    # List of translated text
+    #
     class Texts
       extend Forwardable
 
       include Enumerable
 
-      def_delegators :texts, :size, :each
+      def_delegators :texts, :size, :each, :select
 
+      # Create list of translated text
+      #
+      # @param texts [Array<I18nChecker::Locale::Text>] List of translated text
       def initialize(texts = [])
         @texts = texts
       end
 
+      # Combine lists of translated texts
+      #
+      # @param texts [Enumerable<I18nChecker::Locale::Text>] List of translated text
+      # @return [I18nChecker::Locale::Texts<I18nChecker::Locale::Text>] Returns the combined receiver itself
       def concat(texts)
         @texts.concat(texts.to_a)
         self
       end
 
+      # Delete translated text duplicates
+      #
+      # @return [I18nChecker::Locale::Texts<I18nChecker::Locale::Text>] Returns the combined receiver itself
       def uniq!
         @texts.uniq!
         self
       end
 
+      # Compare lists of translated texts
+      #
+      # @return [Boolean]
       def ==(other)
         @texts == other.to_a
       end

data/lib/i18n_checker/locale.rb

@@ -6,11 +6,18 @@ require 'i18n_checker/locale/collector'
 module I18nChecker
   module Locale
     module Methods
+      # Read specified translation file
+      #
+      # @return [I18nChecker::Locale::Files]
       def load_of(locale_files)
-        loaded_locale_files = locale_files.map { |locale_file| I18nChecker::Locale::File.load_yaml_file(locale_file) }
+        files = locale_files.delete_if { |resource| ::File.directory?(resource) }.to_a
+        loaded_locale_files = files.map { |locale_file| I18nChecker::Locale::File.load_yaml_file(locale_file) }
         Files.new(loaded_locale_files)
       end
 
+      # Collect translation text from specified file list
+      #
+      # @return [I18nChecker::Locale::Texts]
       def texts_of(resources)
         caches = I18nChecker::Cache::Files.new
 

data/lib/i18n_checker/{detector/locale_text_not_found.rb → not_found/detector.rb}

@@ -1,13 +1,13 @@
 module I18nChecker
-  module Detector
-    class LocaleTextNotFound
+  module NotFound
+    class Detector
       def initialize(locale_files)
         @locale_files = locale_files
       end
 
       def detect(locale_texts)
         results = locale_texts.map { |local_text| detect_not_found(local_text) }
-        DetectedResult.new(results.compact.flatten)
+        Result.new(results.compact.flatten)
       end
 
       private
@@ -16,7 +16,7 @@ module I18nChecker
           locale_files = @locale_files.dup
           locale_files.delete_if { |locale_file| locale_file.include?(locale_text) }
           locale_files.map do |locale_file|
-            TextResult.new(
+            Text.new(
               locale_text: locale_text,
               locale_file: locale_file
             )

data/lib/i18n_checker/not_found/reporter/base.rb

@@ -0,0 +1,17 @@
+require 'logger'
+
+module I18nChecker
+  module NotFound
+    module Reporter
+      class Base
+        def initialize(logger: Logger.new(STDOUT))
+          @logger = logger
+        end
+
+        private
+
+        attr_reader :logger
+      end
+    end
+  end
+end

data/lib/i18n_checker/not_found/reporter/default.rb

@@ -0,0 +1,30 @@
+require 'colorator'
+
+module I18nChecker
+  module NotFound
+    module Reporter
+      class Default < Base
+        CHECK_COMPLETED = 'Translation text checking is complete.'.freeze
+
+        def report(result)
+          return passed if result.empty?
+          failed(result)
+        end
+
+        def passed
+          logger.info CHECK_COMPLETED.green
+          logger.info 'There was no translated text that can not be referenced'.green
+        end
+
+        def failed(result)
+          logger.info CHECK_COMPLETED.red
+          logger.info "There are settings where translated text can not be found\n".red
+          result.locale_texts.each do |locale_text|
+            logger.info locale_text.file.cyan.to_s
+            logger.info "  line:#{locale_text.line}, column:#{locale_text.column} - #{locale_text.lang}.#{locale_text.text}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/i18n_checker/not_found/reporter.rb

@@ -0,0 +1,2 @@
+require 'i18n_checker/not_found/reporter/base'
+require 'i18n_checker/not_found/reporter/default'

data/lib/i18n_checker/{detector/detected_result.rb → not_found/result.rb}

@@ -1,6 +1,6 @@
 module I18nChecker
-  module Detector
-    class DetectedResult
+  module NotFound
+    class Result
       attr_reader :locale_texts
 
       def initialize(locale_texts = [])

data/lib/i18n_checker/{detector/text_result.rb → not_found/text.rb}

@@ -1,8 +1,8 @@
 require 'forwardable'
 
 module I18nChecker
-  module Detector
-    class TextResult
+  module NotFound
+    class Text
       extend Forwardable
 
       def_delegators :locale_file, :lang

data/lib/i18n_checker/rake_task/{locale_check.rb → check.rb}

@@ -2,12 +2,13 @@ require 'rake'
 require 'rake/tasklib'
 require 'i18n_checker/cache'
 require 'i18n_checker/locale'
-require 'i18n_checker/reporter'
-require 'i18n_checker/locale_text_not_found_checker'
+require 'i18n_checker/not_found/reporter/base'
+require 'i18n_checker/not_found/reporter/default'
+require 'i18n_checker/command/check'
 
 module I18nChecker
   module RakeTask
-    class LocaleCheck < ::Rake::TaskLib
+    class Check < ::Rake::TaskLib
       attr_accessor :name
       attr_accessor :reporter
       attr_accessor :source_paths
@@ -22,7 +23,7 @@ module I18nChecker
         @logger.formatter = proc { |_severity, _datetime, _progname, message|
           "#{message}\n"
         }
-        @reporter = I18nChecker::Reporter::DefaultReporter.new(logger: logger)
+        @reporter = I18nChecker::NotFound::Reporter::Default.new(logger: logger)
         yield self if block_given?
         define
       end
@@ -35,12 +36,12 @@ module I18nChecker
         end
 
         def run_task
-          checker = I18nChecker::LocaleTextNotFoundChecker.new(
+          commmand = I18nChecker::Command::Check.new(
             reporter: reporter,
             source_paths: source_paths,
             locale_file_paths: locale_file_paths
           )
-          checker.check do |result|
+          commmand.check do |result|
             exit 1 unless result.empty?
           end
         end

data/lib/i18n_checker/rake_task/clean.rb

@@ -0,0 +1,50 @@
+require 'rake'
+require 'rake/tasklib'
+require 'i18n_checker/cache'
+require 'i18n_checker/locale'
+require 'i18n_checker/unused/detector'
+require 'i18n_checker/unused/reporter/default'
+require 'i18n_checker/command/clean'
+
+module I18nChecker
+  module RakeTask
+    class Clean < ::Rake::TaskLib
+      attr_accessor :name
+      attr_accessor :reporter
+      attr_accessor :source_paths
+      attr_accessor :locale_file_paths
+      attr_accessor :logger
+
+      def initialize(name = :locale_clean)
+        @name = name
+        @source_paths = FileList['app/views/*', 'app/controllers/*', 'app/jobs/*', 'app/models/*', 'app/helpers/*']
+        @locale_file_paths = FileList['config/locales/*']
+        @logger = Logger.new(STDOUT)
+        @logger.formatter = proc { |_severity, _datetime, _progname, message|
+          "#{message}\n"
+        }
+        @reporter = I18nChecker::Unused::Reporter::Default.new(logger: logger)
+        yield self if block_given?
+        define
+      end
+
+      private
+
+        def define
+          desc 'Delete unused translation text.'
+          task(name) { run_task }
+        end
+
+        def run_task
+          command = I18nChecker::Command::Clean.new(
+            reporter: reporter,
+            source_paths: source_paths,
+            locale_file_paths: locale_file_paths
+          )
+          command.run do |result|
+            exit 1 unless result.empty?
+          end
+        end
+    end
+  end
+end

data/lib/i18n_checker/rake_task.rb

@@ -1 +1,2 @@
-require 'i18n_checker/rake_task/locale_check'
+require 'i18n_checker/rake_task/check'
+require 'i18n_checker/rake_task/clean'

data/lib/i18n_checker/unused/detector.rb

@@ -0,0 +1,38 @@
+require 'i18n_checker/unused/text'
+require 'i18n_checker/unused/result'
+
+module I18nChecker
+  module Unused
+    class Detector
+      def initialize(locale_files)
+        @locale_files = locale_files
+      end
+
+      def detect(locale_texts)
+        unused_texts = cleaned_locale_files(locale_texts).map do |locale_file|
+          locale_file.locale_texts.map do |key, _v|
+            I18nChecker::Unused::Text.new(
+              text: key,
+              file: locale_file
+            )
+          end
+        end
+        I18nChecker::Unused::Result.new(unused_texts.compact.flatten)
+      end
+
+      private
+
+        def cleaned_locale_files(locale_texts)
+          remove_locale_texts = used_locale_texts(locale_texts)
+          @locale_files.map { |locale_file| locale_file.remove_texts(remove_locale_texts) }
+        end
+
+        def used_locale_texts(locale_texts)
+          used_locale_texts = locale_texts.dup.select do |locale_text|
+            @locale_files.any? { |locale_file| locale_file.include?(locale_text) }
+          end
+          used_locale_texts.map(&:text)
+        end
+    end
+  end
+end

data/lib/i18n_checker/unused/reporter/base.rb

@@ -0,0 +1,15 @@
+module I18nChecker
+  module Unused
+    module Reporter
+      class Base
+        def initialize(logger: Logger.new(STDOUT))
+          @logger = logger
+        end
+
+        private
+
+          attr_reader :logger
+      end
+    end
+  end
+end

data/lib/i18n_checker/unused/reporter/default.rb

@@ -0,0 +1,37 @@
+require 'i18n_checker/unused/result'
+require 'i18n_checker/unused/result'
+require 'i18n_checker/unused/detector'
+require 'i18n_checker/unused/reporter/base'
+
+module I18nChecker
+  module Unused
+    module Reporter
+      class Default < Base
+        CHECK_COMPLETED = 'Checking of unused translated text is finished.'.freeze
+
+        #
+        # @param unused_result [I18nChecker::Unused::Result]
+        def report(unused_result)
+          return passed if unused_result.empty?
+          failed(unused_result)
+        end
+
+        private
+
+          def passed
+            logger.info CHECK_COMPLETED.green
+            logger.info 'Unused translation text was not found'.green
+          end
+
+          def failed(unused_result)
+            logger.info CHECK_COMPLETED.red
+            logger.info "An unused translation text was found.\n".red
+            unused_result.locale_files.each do |file_name, unused_texts|
+              logger.info file_name.cyan.to_s
+              unused_texts.map { |text| logger.info "  #{text.text}" }
+            end
+          end
+      end
+    end
+  end
+end

data/lib/i18n_checker/unused/reporter.rb

@@ -0,0 +1,2 @@
+require 'i18n_checker/unused/reporter/base'
+require 'i18n_checker/unused/reporter/default'

data/lib/i18n_checker/unused/result.rb

@@ -0,0 +1,44 @@
+module I18nChecker
+  module Unused
+    # Detection result of unused translated text
+    #
+    # @attr_reader [Array<I18nChecker::Unused::Text>] unused_texts
+    # @attr_reader [Hash<String, Array<I18nChecker::Unused::File>>] locale_files
+    class Result
+      attr_reader :unused_texts, :locale_files
+
+      #
+      #
+      # @param unused_texts [Array<I18nChecker::Unused::Text>]
+      def initialize(unused_texts = [])
+        @unused_texts = unused_texts
+        @locale_files = unused_texts.group_by(&:file_name)
+      end
+
+      #
+      #
+      # @return [Boolean]
+      def empty?
+        unused_texts.empty?
+      end
+
+      # Apply the detected unused translated text to the current translation file.
+      # Unused text has been deleted from the translation file.
+      #
+      # @param target_locale_files [Array<I18nChecker::Locale::File>]
+      # @return [Array<I18nChecker::Locale::File>]
+      def apply(target_locale_files)
+        locale_files = target_locale_files.
+                       group_by(&:file_name).
+                       map { |k, v| [k, v.first] }
+
+        cleanup_locale_files = locale_files.map do |file_name, locale_file|
+          return locale_file unless @locale_files.key?(file_name)
+          unused_texts = @locale_files[file_name]
+          locale_file.remove_texts(unused_texts.map(&:text))
+        end
+        cleanup_locale_files.each(&:save)
+      end
+    end
+  end
+end

data/lib/i18n_checker/unused/text.rb

@@ -0,0 +1,18 @@
+require 'forwardable'
+
+module I18nChecker
+  module Unused
+    class Text
+      extend Forwardable
+
+      attr_reader :file, :text
+
+      def_delegators :file, :lang, :file_name
+
+      def initialize(file:, text:)
+        @file = file
+        @text = text
+      end
+    end
+  end
+end

data/lib/i18n_checker/version.rb

@@ -1,3 +1,3 @@
 module I18nChecker
-  VERSION = '0.5.0'.freeze
+  VERSION = '0.6.0'.freeze
 end

data/lib/i18n_checker.rb

@@ -11,12 +11,10 @@ require 'i18n_checker/locale/texts'
 require 'i18n_checker/locale/key_path'
 require 'i18n_checker/locale/file'
 require 'i18n_checker/locale/files'
-require 'i18n_checker/detector/locale_text_not_found'
-require 'i18n_checker/detector/text_result'
-require 'i18n_checker/detector/detected_result'
-require 'i18n_checker/reporter/detect_result_reporter'
-require 'i18n_checker/reporter/default_reporter'
-require 'i18n_checker/locale_text_not_found_checker'
+require 'i18n_checker/unused/detector'
+require 'i18n_checker/unused/reporter'
+require 'i18n_checker/not_found/detector'
+require 'i18n_checker/not_found/reporter'
 
 module I18nChecker
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n_checker
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - holyshared
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-30 00:00:00.000000000 Z
+date: 2017-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml_parser
@@ -150,6 +150,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-temp_dir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Verification of translation of Ruby source and Haml template
 email:
 - holy.shared.design@gmail.com
@@ -168,13 +196,16 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- examples/unused/example.haml
+- examples/unused/example.rb
+- examples/unused/locales/en.yml
+- examples/unused/locales/ja.yml
 - i18n-checker.gemspec
 - lib/i18n_checker.rb
 - lib/i18n_checker/cache.rb
 - lib/i18n_checker/collectible.rb
-- lib/i18n_checker/detector/detected_result.rb
-- lib/i18n_checker/detector/locale_text_not_found.rb
-- lib/i18n_checker/detector/text_result.rb
+- lib/i18n_checker/command/check.rb
+- lib/i18n_checker/command/clean.rb
 - lib/i18n_checker/locale.rb
 - lib/i18n_checker/locale/collector.rb
 - lib/i18n_checker/locale/collector/haml.rb
@@ -185,18 +216,28 @@ files:
 - lib/i18n_checker/locale/text.rb
 - lib/i18n_checker/locale/text_processor.rb
 - lib/i18n_checker/locale/texts.rb
-- lib/i18n_checker/locale_text_not_found_checker.rb
+- lib/i18n_checker/not_found/detector.rb
+- lib/i18n_checker/not_found/reporter.rb
+- lib/i18n_checker/not_found/reporter/base.rb
+- lib/i18n_checker/not_found/reporter/default.rb
+- lib/i18n_checker/not_found/result.rb
+- lib/i18n_checker/not_found/text.rb
 - lib/i18n_checker/rake_task.rb
-- lib/i18n_checker/rake_task/locale_check.rb
-- lib/i18n_checker/reporter.rb
-- lib/i18n_checker/reporter/default_reporter.rb
-- lib/i18n_checker/reporter/detect_result_reporter.rb
+- lib/i18n_checker/rake_task/check.rb
+- lib/i18n_checker/rake_task/clean.rb
+- lib/i18n_checker/unused/detector.rb
+- lib/i18n_checker/unused/reporter.rb
+- lib/i18n_checker/unused/reporter/base.rb
+- lib/i18n_checker/unused/reporter/default.rb
+- lib/i18n_checker/unused/result.rb
+- lib/i18n_checker/unused/text.rb
 - lib/i18n_checker/version.rb
 - screenshot.png
 homepage: https://github.com/holyshared/i18n-checker
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/i18n_checker/locale_text_not_found_checker.rb

@@ -1,20 +0,0 @@
-require 'i18n_checker/detector/locale_text_not_found'
-require 'i18n_checker/detector/text_result'
-require 'i18n_checker/detector/detected_result'
-
-module I18nChecker
-  class LocaleTextNotFoundChecker
-    def initialize(locale_file_paths: [], source_paths: [], reporter:)
-      @reporter = reporter
-      @locale_texts = I18nChecker::Locale.texts_of(source_paths)
-      @locale_files = I18nChecker::Locale.load_of(locale_file_paths)
-    end
-
-    def check
-      not_found_detector = I18nChecker::Detector::LocaleTextNotFound.new(@locale_files)
-      not_found_result = @locale_texts.detect(not_found_detector)
-      @reporter.report not_found_result
-      yield not_found_result if block_given?
-    end
-  end
-end

data/lib/i18n_checker/reporter/default_reporter.rb

@@ -1,28 +0,0 @@
-require 'colorator'
-
-module I18nChecker
-  module Reporter
-    class DefaultReporter < DetectResultReporter
-      CHECK_COMPLETED = 'Translation text checking is complete.'.freeze
-
-      def report(result)
-        return passed if result.empty?
-        failed(result)
-      end
-
-      def passed
-        logger.info CHECK_COMPLETED.green
-        logger.info 'There was no translated text that can not be referenced'.green
-      end
-
-      def failed(result)
-        logger.info CHECK_COMPLETED.red
-        logger.info "There are settings where translated text can not be found\n".red
-        result.locale_texts.each do |locale_text|
-          logger.info locale_text.file.cyan.to_s
-          logger.info "  line:#{locale_text.line}, column:#{locale_text.column} - #{locale_text.lang}.#{locale_text.text}"
-        end
-      end
-    end
-  end
-end

data/lib/i18n_checker/reporter/detect_result_reporter.rb

@@ -1,15 +0,0 @@
-require 'logger'
-
-module I18nChecker
-  module Reporter
-    class DetectResultReporter
-      def initialize(logger: Logger.new(STDOUT))
-        @logger = logger
-      end
-
-      private
-
-        attr_reader :logger
-    end
-  end
-end

data/lib/i18n_checker/reporter.rb

@@ -1,7 +0,0 @@
-require 'i18n_checker/reporter/detect_result_reporter'
-require 'i18n_checker/reporter/default_reporter'
-
-module I18nChecker
-  module Reporter
-  end
-end