i18n_checker 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23733a725ec850046a4c27be2c3b0456a24d2497
-  data.tar.gz: 17f373338bc76782d3eaa2ae29ccef8dd0b409c9
+  metadata.gz: 0b3dfa7d91d83ae12f4fac222f03b586b233ff51
+  data.tar.gz: 05deb6f41ac172a7c94d72391b248acef04b41e8
 SHA512:
-  metadata.gz: 7c8d90d81e4df2de391d6a73cf5467ab254b44552c18a1e893b58ac269cf1f3f6cca7a84ae01a0f6aaf254355f4960a07dbb3a463495d56787974d8399249fc6
-  data.tar.gz: 0b4e66c6b101937433c3e57ecd90d9f95340df3c815d6febcdf16c2705fb718e0ebd9c7e3c2838470ca4ed3d10fa416000c8bbd1b1f9b5c8f38225567f9e81fc
+  metadata.gz: e3f14b54918d9781c5767ee4c879dbb4cf25e2786dea4ed4951cbbb8bb4c9a205e328700f4f0daa519d61d02b50381abd52498679e55c205a190146037f970b5
+  data.tar.gz: 7b13bdb096146bb7dca8a9e575f83f736002f5e078669c6d64232a4d466ade9c54e61f1fb8468ceea4f40dbe568333c2f9c3bbe9b7ca417fe761e6e8b096fe82

data/Gemfile.lock

@@ -1,14 +1,16 @@
 PATH
   remote: .
   specs:
-    i18n_checker (0.1.3)
+    i18n_checker (0.2.0)
       colorator (~> 1.1.0)
       haml_parser (~> 0.4)
+      parser
 
 GEM
   remote: https://rubygems.org/
   specs:
     ansi (1.5.0)
+    ast (2.3.0)
     colorator (1.1.0)
     coveralls (0.8.19)
       json (>= 1.8, < 3)
@@ -21,6 +23,8 @@ GEM
     haml_parser (0.4.1)
     hirb (0.7.3)
     json (2.0.3)
+    parser (2.4.0.0)
+      ast (~> 2.2)
     rake (10.5.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)

data/README.md

@@ -7,7 +7,10 @@
 
 This gem provides a **Rake task** to check translation file mistakes and translated text references from template files etc.
 
-In the current version you can check the translation text reference from Haml's template file.
+Current version supports Ruby source code, Haml template file.
+
+* Ruby source
+* Haml template
 
 ## Basic usage
 
@@ -17,8 +20,9 @@ Add the following tasks to your **Rakefile**.
 require 'i18n_checker/rake_task'
 
 I18nChecker::RakeTask.new do |task|
-  task.locale_file_paths = FileList['spec/fixtures/locales/**'] # locale file paths
-  task.haml_template_paths = FileList['spec/fixtures/*'] # haml template paths
+  task.template_paths = FileList['app/views/*'] # haml templates
+  task.locale_file_paths = FileList['config/locales/*'] # locale file paths
+paths
 end
 ```
 

data/Rakefile

@@ -5,8 +5,8 @@ require 'i18n_checker/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
 I18nChecker::RakeTask.new do |task|
+  task.template_paths = FileList['spec/fixtures/haml/*', 'spec/fixtures/ruby/*']
   task.locale_file_paths = FileList['spec/fixtures/locales/**']
-  task.haml_template_paths = FileList['spec/fixtures/*']
 end
 
 task :default => :spec

data/i18n-checker.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = I18nChecker::VERSION
   spec.authors       = ["holyshared"]
   spec.email         = ["holy.shared.design@gmail.com"]
-  spec.summary       = "i18n checker for haml"
-  spec.description   = "It parses the haml template and checks the validity of the language file"
+  spec.summary       = "Verification of translation of Ruby source and Haml template"
+  spec.description   = "Verification of translation of Ruby source and Haml template"
   spec.homepage      = "https://github.com/holyshared/i18n-checker"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.add_dependency 'haml_parser', '~> 0.4'
   spec.add_dependency 'colorator', '~> 1.1.0'
+  spec.add_dependency 'parser'
   spec.add_development_dependency 'bundler','~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'

data/lib/i18n_checker/collectible.rb

@@ -0,0 +1,11 @@
+module I18nChecker
+  module Collectible
+    def collect(file)
+    end
+
+    def collect_all(files)
+      texts = files.map { |file| collect(file) }
+      texts.reduce { |texts, n| texts.concat(n) }
+    end
+  end
+end

data/lib/i18n_checker/locale/collector/haml.rb

@@ -0,0 +1,51 @@
+require 'haml_parser'
+require 'haml_parser/parser'
+require 'i18n_checker/collectible'
+require 'i18n_checker/locale/texts'
+
+module I18nChecker
+  module Locale
+    module Collector
+      class Haml
+        include I18nChecker::Collectible
+
+        def collect(template_file)
+          template = read_template_file(template_file)
+          parser = HamlParser::Parser.new(filename: template_file)
+          I18nChecker::Locale::Texts.new(collect_locale_texts(parser.call(template)))
+        end
+
+        private
+
+        def read_template_file(template_file)
+          ::File.open(template_file, &:read)
+        end
+
+        def collect_locale_texts(ast)
+          locale_texts = []
+          locale_texts << collect_locale_text(ast)
+          return unless ast.respond_to?(:children)
+          locale_texts << ast.children.map { |child| collect_locale_texts(child) }
+          locale_texts.flatten.compact
+        end
+
+        def collect_locale_text(ast)
+          return locale_text_from_script(ast) if ast.kind_of?(HamlParser::Ast::Script)
+          return unless ast.respond_to?(:oneline_child)
+          return unless ast.oneline_child.kind_of?(HamlParser::Ast::Script)
+          locale_text_from_script(ast.oneline_child)
+        end
+
+        def locale_text_from_script(script_node)
+          return unless translate_script = script_node.script.match(/^t\(\'+(.+)\'+\)$/)
+          I18nChecker::Locale::Text.new(
+            file: script_node.filename,
+            line: script_node.lineno,
+            column: 0, # FIXME: collect from source file
+            text: translate_script[1]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/i18n_checker/locale/collector/ruby.rb

@@ -0,0 +1,38 @@
+require 'parser'
+require 'parser/current'
+require 'i18n_checker/collectible'
+require 'i18n_checker/locale/texts'
+require 'i18n_checker/locale/text_processor'
+
+module I18nChecker
+  module Locale
+    module Collector
+      class Ruby
+        include I18nChecker::Collectible
+
+        def collect(source_file)
+          I18nChecker::Locale::Texts.new(process(source_file))
+        end
+
+        private
+
+        def buffer_of(source_file)
+          source_buffer = Parser::Source::Buffer.new('(string)')
+          source_buffer.source = ::File.read(source_file)
+          source_buffer
+        end
+
+        def parse_source(source_file)
+          parser = Parser::CurrentRuby.new
+          parser.parse(buffer_of(source_file))
+        end
+
+        def process(source_file)
+          processor = I18nChecker::Locale::TextProcessor.new(file: source_file)
+          processor.process(parse_source(source_file))
+          processor.locale_texts
+        end
+      end
+    end
+  end
+end

data/lib/i18n_checker/locale/collector.rb

@@ -0,0 +1,2 @@
+require 'i18n_checker/locale/collector/haml'
+require 'i18n_checker/locale/collector/ruby'

data/lib/i18n_checker/locale/{locale_file.rb → file.rb}

@@ -2,7 +2,7 @@ require 'yaml'
 
 module I18nChecker
   module Locale
-    class LocaleFile
+    class File
       attr_reader :lang, :locale_texts
 
       class << self
@@ -10,7 +10,7 @@ module I18nChecker
           new(YAML.load(s))
         end
         def load_yaml_file(yaml_file)
-          load_yaml(File.open(yaml_file, &:read))
+          load_yaml(::File.open(yaml_file, &:read))
         end
       end
 

data/lib/i18n_checker/locale/{locale_files.rb → files.rb}

@@ -1,18 +1,21 @@
+require 'forwardable'
+
 module I18nChecker
   module Locale
-    class LocaleFiles
+    class Files
+      extend Forwardable
+
       include Enumerable
 
+      def_delegators :locale_files, :size, :each
+
       def initialize(locale_files = [])
         @locale_files = locale_files
       end
 
-      def each(&block)
-        locale_files.each(&block)
-      end
-
       def delete_if(&block)
         locale_files.delete_if(&block)
+        self
       end
 
       private

data/lib/i18n_checker/locale/text.rb

@@ -0,0 +1,14 @@
+module I18nChecker
+  module Locale
+    class Text
+      attr_reader :file, :text, :line, :column
+
+      def initialize(file:, text:, line:, column:)
+        @file = file
+        @text = text
+        @line = line
+        @column = column
+      end
+    end
+  end
+end

data/lib/i18n_checker/locale/text_processor.rb

@@ -0,0 +1,28 @@
+require 'parser'
+require 'parser/current'
+
+module I18nChecker
+  module Locale
+    class TextProcessor < Parser::AST::Processor
+      attr_reader :file, :locale_texts
+
+      def initialize(file:, locale_texts: [])
+        @file = file
+        @locale_texts = locale_texts
+      end
+
+      def on_send(node)
+        receiver_node, method_name, *arg_nodes = *node
+        return super(node) unless method_name == :t
+        arg_node = arg_nodes.first
+        locale_texts << I18nChecker::Locale::Text.new(
+          file: file,
+          line: arg_node.loc.line,
+          column: arg_node.loc.column + 1,
+          text: arg_node.children.first
+        )
+        super(node)
+      end
+    end
+  end
+end

data/lib/i18n_checker/{haml/locale_texts.rb → locale/texts.rb}

@@ -1,21 +1,29 @@
+require 'forwardable'
+require 'i18n_checker/locale/text'
+
 module I18nChecker
-  module Haml
-    class LocaleTexts
+  module Locale
+    class Texts
+      extend Forwardable
+
       include Enumerable
 
+      def_delegators :texts, :size, :each
+
       def initialize(texts = [])
         @texts = texts
       end
 
-      def each(&block)
-        texts.each(&block)
-      end
-
       def concat(texts)
         @texts.concat(texts.to_a)
         self
       end
 
+      def uniq!
+        @texts.uniq!
+        self
+      end
+
       def ==(other)
         @texts == other.to_a
       end
@@ -30,3 +38,4 @@ module I18nChecker
     end
   end
 end
+

data/lib/i18n_checker/locale.rb

@@ -1,13 +1,34 @@
 require "i18n_checker/locale/key_path"
-require "i18n_checker/locale/locale_file"
-require "i18n_checker/locale/locale_files"
+require "i18n_checker/locale/file"
+require "i18n_checker/locale/files"
+require "i18n_checker/locale/collector"
 
 module I18nChecker
   module Locale
     module Methods
       def load_of(locale_files)
-        loaded_locale_files = locale_files.map { |locale_file| I18nChecker::Locale::LocaleFile.load_yaml_file(locale_file) }
-        LocaleFiles.new(loaded_locale_files)
+        loaded_locale_files = locale_files.map { |locale_file| I18nChecker::Locale::File.load_yaml_file(locale_file) }
+        Files.new(loaded_locale_files)
+      end
+
+      def texts_of(resources)
+        files = resources.delete_if { |resource| ::File.directory?(resource) }.to_a
+        grouped_files = files.group_by { |file| ::File.extname(file) }
+        grouped_locale_texts = grouped_files.map do |k, v|
+          text_collector_of(k).collect_all(v)
+        end
+        grouped_locale_texts.reduce { |locale_texts, n| locale_texts.concat(n) }.uniq!
+      end
+
+      def text_collector_of(file_extname)
+        case file_extname
+        when '.haml'
+          I18nChecker::Locale::Collector::Haml.new
+        when '.rb'
+          I18nChecker::Locale::Collector::Ruby.new
+        else
+          raise StandardError, "not support #{extname} file" # FIXME: throw custom error!!
+        end
       end
     end
     extend Methods

data/lib/i18n_checker/locale_text_not_found_checker.rb

@@ -4,13 +4,14 @@ require "i18n_checker/detector/detected_result"
 
 module I18nChecker
   class LocaleTextNotFoundChecker
-    def initialize(locale_texts: [], reporter:)
+    def initialize(locale_texts: [], locale_files: [], reporter:)
       @reporter = reporter
       @locale_texts = locale_texts
+      @locale_files = locale_files
     end
 
-    def check(locale_files = [])
-      not_found_detector = I18nChecker::Detector::LocaleTextNotFound.new(locale_files)
+    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
     end

data/lib/i18n_checker/rake_task.rb

@@ -1,21 +1,20 @@
 require 'rake'
 require 'rake/tasklib'
 require 'i18n_checker/locale'
-require 'i18n_checker/haml'
 require 'i18n_checker/reporter'
 require "i18n_checker/locale_text_not_found_checker"
 
 module I18nChecker
   class RakeTask < ::Rake::TaskLib
     attr_accessor :name
+    attr_accessor :template_paths
     attr_accessor :locale_file_paths
-    attr_accessor :haml_template_paths
     attr_accessor :logger
 
     def initialize(name = :locale_check)
       @name = name
-      @haml_template_paths = FileList['./app/views/*']
-      @locale_file_paths = FileList['./locales/*']
+      @template_paths = FileList['app/views/*']
+      @locale_file_paths = FileList['config/locales/*']
       @logger = Logger.new(STDOUT)
       @logger.formatter = proc {|severity, datetime, progname, message|
         "#{message}\n"
@@ -33,14 +32,15 @@ module I18nChecker
 
     def run_task
       reporter = I18nChecker::Reporter::DefaultReporter.new(logger: logger)
+      locale_texts = I18nChecker::Locale.texts_of(template_paths)
       locale_files = I18nChecker::Locale.load_of(locale_file_paths)
-      locale_texts = I18nChecker::Haml.collect_locale_text_of(haml_template_paths)
 
       checker = I18nChecker::LocaleTextNotFoundChecker.new(
         reporter: reporter,
-        locale_texts: locale_texts
+        locale_texts: locale_texts,
+        locale_files: locale_files
       )
-      checker.check(locale_files)
+      checker.check
     end
   end
 end

data/lib/i18n_checker/version.rb

@@ -1,3 +1,3 @@
 module I18nChecker
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/lib/i18n_checker.rb

@@ -1,12 +1,15 @@
 require "i18n_checker/version"
 require "i18n_checker/rake_task"
-require "i18n_checker/haml/locale_text"
-require "i18n_checker/haml/locale_texts"
-require "i18n_checker/haml/locale_text_collector"
+require "i18n_checker/collectible"
 require "i18n_checker/locale"
+require "i18n_checker/locale/text_processor"
+require "i18n_checker/locale/collector/haml"
+require "i18n_checker/locale/collector/ruby"
+require "i18n_checker/locale/text"
+require "i18n_checker/locale/texts"
 require "i18n_checker/locale/key_path"
-require "i18n_checker/locale/locale_file"
-require "i18n_checker/locale/locale_files"
+require "i18n_checker/locale/file"
+require "i18n_checker/locale/files"
 require "i18n_checker/detector/locale_text_not_found"
 require "i18n_checker/detector/locale_text_result"
 require "i18n_checker/detector/detected_result"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n_checker
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - holyshared
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-11 00:00:00.000000000 Z
+date: 2017-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml_parser
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,7 +136,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: It parses the haml template and checks the validity of the language file
+description: Verification of translation of Ruby source and Haml template
 email:
 - holy.shared.design@gmail.com
 executables: []
@@ -140,20 +154,21 @@ files:
 - README.md
 - Rakefile
 - i18n-checker.gemspec
-- lib/.DS_Store
 - lib/i18n_checker.rb
-- lib/i18n_checker/.DS_Store
+- 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/locale_text_result.rb
-- lib/i18n_checker/haml.rb
-- lib/i18n_checker/haml/locale_text.rb
-- lib/i18n_checker/haml/locale_text_collector.rb
-- lib/i18n_checker/haml/locale_texts.rb
 - lib/i18n_checker/locale.rb
+- lib/i18n_checker/locale/collector.rb
+- lib/i18n_checker/locale/collector/haml.rb
+- lib/i18n_checker/locale/collector/ruby.rb
+- lib/i18n_checker/locale/file.rb
+- lib/i18n_checker/locale/files.rb
 - lib/i18n_checker/locale/key_path.rb
-- lib/i18n_checker/locale/locale_file.rb
-- lib/i18n_checker/locale/locale_files.rb
+- 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/rake_task.rb
 - lib/i18n_checker/reporter.rb
@@ -180,8 +195,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
-summary: i18n checker for haml
+summary: Verification of translation of Ruby source and Haml template
 test_files: []

data/lib/i18n_checker/haml/locale_text.rb

@@ -1,13 +0,0 @@
-module I18nChecker
-  module Haml
-    class LocaleText
-      attr_reader :file, :text, :line
-
-      def initialize(file:, text:, line:)
-        @file = file
-        @text = text
-        @line = line
-      end
-    end
-  end
-end

data/lib/i18n_checker/haml/locale_text_collector.rb

@@ -1,44 +0,0 @@
-require 'haml_parser'
-require 'haml_parser/parser'
-
-module I18nChecker
-  module Haml
-    class LocaleTextCollector
-      def collect(template_file)
-        template = read_template_file(template_file)
-        parser = HamlParser::Parser.new(filename: template_file)
-        LocaleTexts.new(collect_locale_texts(parser.call(template)))
-      end
-
-      private
-
-      def read_template_file(template_file)
-        File.open(template_file, &:read)
-      end
-
-      def collect_locale_texts(ast)
-        locale_texts = []
-        locale_texts << collect_locale_text(ast)
-        return unless ast.respond_to?(:children)
-        locale_texts << ast.children.map { |child| collect_locale_texts(child) }
-        locale_texts.flatten.compact
-      end
-
-      def collect_locale_text(ast)
-        return locale_text_from_script(ast) if ast.kind_of?(HamlParser::Ast::Script)
-        return unless ast.respond_to?(:oneline_child)
-        return unless ast.oneline_child.kind_of?(HamlParser::Ast::Script)
-        locale_text_from_script(ast.oneline_child)
-      end
-
-      def locale_text_from_script(script_node)
-        return unless translate_script = script_node.script.match(/^t\(\'+(.+)\'+\)$/)
-        I18nChecker::Haml::LocaleText.new(
-          file: script_node.filename,
-          line: script_node.lineno,
-          text: translate_script[1]
-        )
-      end
-    end
-  end
-end

data/lib/i18n_checker/haml.rb

@@ -1,21 +0,0 @@
-require "i18n_checker/haml/locale_text"
-require "i18n_checker/haml/locale_texts"
-require "i18n_checker/haml/locale_text_collector"
-
-module I18nChecker
-  module Haml
-    module Methods
-      def collect_locale_text_of(files)
-        collector = I18nChecker::Haml::LocaleTextCollector.new
-        locale_texts = I18nChecker::Haml::LocaleTexts.new
-
-        haml_files = files.delete_if { |file| File.directory?(file) }.to_a
-        haml_files.each do |haml_file|
-          locale_texts.concat(collector.collect(haml_file))
-        end
-        locale_texts
-      end
-    end
-    extend Methods
-  end
-end