haml_i18n_lint 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5baf9d78c58e54ef28dc02d47853a0ad5cc47e48
-  data.tar.gz: 663f20d241cc959ac781f1128d6c63fe430e8fea
+  metadata.gz: 39727a8149db51ef830a77e981f889ffafe595e4
+  data.tar.gz: ca228553e73a66d68b0e73ac2dee226f754fa7e8
 SHA512:
-  metadata.gz: 0cc2d75ab100f45eea52c2f74af8d72d2924259d552a3b559f9adb13c67215d29c622d82d8723e427caaa34fb25ebf8886872e6766490d0e4ea1c945a9e0bbb3
-  data.tar.gz: 0cd123a39fee2444e314af5d651b5cbaedc7c99f147486d01a0e49f7651273287e8d5f1629ed74679c66a803d5f83103244813951c8617f760b8b76cdc7be596
+  metadata.gz: e4ed255dac1812a7dfaca0e92f15f688ae389028b4470462e173efc4609732dc774d3d36022df107a604117f5a2be67d1ae6ea9caa235149f25eef392403409d
+  data.tar.gz: 8b18fd3d44b73d9499625179d6dd29a7dc87bf7e538f82e361b377374579c7e7a2bac5a36f2e3d684bca4e326178caba9a002a80c07e7a1b408ab4985ce4560e

data/README.md

@@ -33,36 +33,7 @@ Or install it yourself as:
     -c, --config=FILE                configuration file
     -f, --files=PATTERN              pattern to find Haml template files, default: -f '**/*.haml'
 
-The configuration file sample:
-
-    # You can override Config#need_i18n? that returns the content in Haml template need i18n or not.
-    def need_i18n?(content)
-      # the default behaviours is ignore white spaces and digits
-      /^[\s]+$/ !~ content && /\p{Alpha}/ =~ content
-    end
-
-    # You can override Config#report in configuration file
-    # to customize output format or send result to other location.
-    #
-    # The default output format is like following:
-    #
-    # $ haml_i18n_lint
-    # test/fixtures/hi.html.haml:4
-    # 3:    %head
-    # 4:      %title Hi
-    # 5:    %body
-    #
-    # For example, to use short format:
-    def report(result)
-      result.matched_nodes.each do |node|
-        puts "#{result.filename}:#{node.line}"
-      end
-    end
-
-    # You can override Config#files for complex file pattern.
-    def files
-      Dir['**/*.haml'].reject { |path| path.start_with?('app/assets/') || path.start_with?('node_modules') }
-    end
+The configuration file examples are in the `examples` directory.
 
 ## Development
 

data/examples/output_yaml.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+
+def report(result_set)
+  t = {}
+  result_set.each_with_object(t['en'] = {}) do |result, t|
+    keys = result.filename.gsub(%r{^app/views/}, '').gsub(/(\.html)?\.haml$/, '').split('/')
+    t = keys.inject(t) { |t, key| t[key] ||= {} }
+    key = "L#{result.node.line}"
+    unless t.key?(key)
+      t[key] = result.text
+      next
+    end
+    key << "-1"
+    key.next! while t.key?(key)
+    t[key] = result.text
+  end
+  puts t.to_yaml
+end

data/examples/react.rb

@@ -0,0 +1,7 @@
+def ignore_methods
+  super + %w(react_component)
+end
+
+def ignore_keys
+  super + %w(tag)
+end

data/examples/sample.rb

@@ -0,0 +1,28 @@
+# You can override Config#need_i18n? that returns the content in Haml template need i18n or not.
+def need_i18n?(content)
+  # the default behaviours is ignore white spaces and digits
+  /^[\s]+$/ !~ content && /\p{Alpha}/ =~ content
+end
+
+# You can override Config#report in configuration file
+# to customize output format or send result to other location.
+#
+# The default output format is like following:
+#
+# $ haml_i18n_lint
+# test/fixtures/hi.html.haml:4
+# 3:    %head
+# 4:      %title Hi
+# 5:    %body
+#
+# For example, to use short format:
+def report(result)
+  result.each do |r|
+    puts "%30s\t%s" % ["#{r.filename}:#{r.node.line}", r.text]
+  end
+end
+
+# You can override Config#files for complex file pattern.
+def files
+  Dir['**/*.haml'].reject { |path| path.start_with?('app/assets/') || path.start_with?('node_modules') }
+end

data/examples/total_num.rb

@@ -0,0 +1,9 @@
+result_count = 0
+define_method(:report) do |result_set|
+  result_count += result_set.count
+  super(result_set)
+end
+
+at_exit do
+  puts "Total: #{result_count}"
+end

data/haml_i18n_lint.gemspec

@@ -8,8 +8,6 @@ Gem::Specification.new do |spec|
   spec.version       = HamlI18nLint::VERSION
   spec.authors       = ["Seiei Miyagi"]
   spec.email         = ["hanachin@gmail.com"]
-  spec.cert_chain    = ["certs/hanachin.pem"]
-  spec.signing_key   = File.expand_path("~/.ssh/gem-private_key.pem")
 
   spec.summary       = "find out not translated yet plain text from your Haml template"
   spec.homepage      = "https://github.com/okinawarb/haml_i18n_lint"

data/lib/haml_i18n_lint/config.rb

@@ -19,13 +19,15 @@ module HamlI18nLint
 
     # Output the formatted result
     #
-    # @param result [Linter::Result] the lint result
-    def report(result)
-      print '.' and return if result.success?
+    # @param result [Linter::ResultSet] the lint result
+    def report(result_set)
+      print '.' and return if result_set.success?
 
       puts
-      file = File.readlines(result.filename)
-      result.matched_nodes.each do |node|
+      files = Hash.new { |h, k| h[k] = File.readlines(k) }
+      result_set.each do |result|
+        file = files[result.filename]
+        node = result.node
         puts "#{result.filename}:#{node.line}"
         puts "#{node.line-1}:  #{file[node.line - 2]}" if file[node.line - 2] && !(node.line - 2).negative?
         puts "#{node.line}:  #{file[node.line - 1]}"

data/lib/haml_i18n_lint/linter/compiler_extension.rb

@@ -4,36 +4,41 @@ module HamlI18nLint
 
       def compile_script
         super
-        lint_add_matched_node(@node) if script_need_i18n?(@node.value[:text])
+        lint_script(@node.value[:text])
       end
 
       def compile_plain
         super
-        lint_add_matched_node(@node) if lint_config.need_i18n?(@node.value[:text])
+        text = @node.value[:text]
+        lint_add(text) if lint_config.need_i18n?(text)
       end
 
       def lint_attributes_hashes
         @node.value[:attributes_hashes]
       end
 
-      def lint_attribute_need_i18n?
-        attributes_hashes = lint_attributes_hashes
-        attributes_hashes.any? do |attributes_hash|
-          script_need_i18n?("{#{attributes_hash}}")
+      def lint_attributes
+        lint_attributes_hashes.any? do |attributes_hash|
+          lint_script("{#{attributes_hash}}")
         end
       end
 
       def compile_tag
         super
         if @node.value[:parse]
-          lint_add_matched_node(@node) if script_need_i18n?(@node.value[:value])
-
+          lint_script(@node.value[:value])
         else
-          lint_add_matched_node(@node) if lint_config.need_i18n?(@node.value[:value])
+          value = @node.value[:value]
+          lint_add(value) if lint_config.need_i18n?(value)
         end
-        lint_add_matched_node(@node) if lint_config.need_i18n?(@node.value.dig(:attributes, 'placeholder') || "")
-        lint_add_matched_node(@node) if lint_config.need_i18n?(@node.value.dig(:attributes, 'value') || "")
-        lint_add_matched_node(@node) if lint_attribute_need_i18n?
+
+        placeholder = @node.value.dig(:attributes, 'placeholder') || ""
+        lint_add(placeholder) if lint_config.need_i18n?(placeholder)
+
+        value = @node.value.dig(:attributes, 'value') || ""
+        lint_add(value) if lint_config.need_i18n?(value)
+
+        lint_attributes
       end
 
       private
@@ -101,7 +106,7 @@ module HamlI18nLint
         lint_command?(sexp, m) || lint_fcall?(sexp, m) || lint_call?(sexp, m)
       end
 
-      def script_need_i18n?(script)
+      def lint_script(script)
         script = script.dup
         if Ripper.lex(script.rstrip).any? { |(_, on_kw, kw_do)| on_kw == :on_kw && kw_do == "do" }
           script << "\nend\n"
@@ -127,7 +132,7 @@ module HamlI18nLint
 
         walk.(sexp)
 
-        string_literal_found
+        lint_add(script) if string_literal_found
       end
 
     end

data/lib/haml_i18n_lint/linter.rb

@@ -6,17 +6,42 @@ module HamlI18nLint
     # Raised if failed to parse the attributes hash
     class AttributesParseError < StandardError; end
 
-    # The lint result of the file
-    class Result < Struct.new(:filename, :matched_nodes)
-      # @!attribute [r] matched_nodes
-      #   @return [Array<Haml::Parser::ParseNode>] the nodes that needs i18n.
-
+    # The lint result
+    class Result < Struct.new(:filename, :node, :text)
       # @!attribute [r] filename
       #   @return [String] name of the linted file
 
+      # @!attribute [r] node
+      #   @return [Haml::Parser::ParseNode] the node that needs i18n.
+
+      # @!attribute [r] text
+      #   @return [String] the text that needs i18n.
+    end
+
+    # The lint results
+    class ResultSet
+      include Enumerable
+
+      # @param filename [String]
+      def initialize
+        @results = []
+      end
+
+      # @param result [Result] the result
+      def add_result(result)
+        @results << result
+      end
+
+      # @yield [result] Gives each result to a block.
+      def each
+        @results.each do |r|
+          yield r
+        end
+      end
+
       # @return [true, false] passed lint or not.
       def success?
-        matched_nodes.empty?
+        count.zero?
       end
     end
 
@@ -30,7 +55,7 @@ module HamlI18nLint
     #
     # @param filename [String] the filename
     # @param template [String] the Haml template
-    # @return [Linter::Result] the result of lint
+    # @return [Linter::ResultSet] the result of lint
     # @raise [Linter::AttributesParseError] if failed to parse attributes hash in the template.
     def lint(filename:, template:)
       haml_options = ::Haml::Options.new
@@ -39,7 +64,6 @@ module HamlI18nLint
       compiler(haml_options).compile(node)
     end
 
-
     private
 
     def parse(haml_options, template)
@@ -52,7 +76,7 @@ module HamlI18nLint
 
     def compiler(haml_options)
       config = @config
-      result = Result.new(haml_options[:filename], [])
+      result_set = ResultSet.new
 
       ext = compiler_extension
       compiler_result_extension = Module.new do
@@ -60,7 +84,7 @@ module HamlI18nLint
 
         define_method(:compile) do |node|
           super(node)
-          result
+          result_set
         end
 
         private
@@ -69,8 +93,8 @@ module HamlI18nLint
           config
         end
 
-        define_method(:lint_add_matched_node) do |node|
-          result.matched_nodes << node
+        define_method(:lint_add) do |text|
+          result_set.add_result(Result.new(haml_options[:filename], @node, text))
         end
       end
 

data/lib/haml_i18n_lint/version.rb

@@ -1,3 +1,3 @@
 module HamlI18nLint
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haml_i18n_lint
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Seiei Miyagi
 autorequire: 
 bindir: exe
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhoYW5h
-  Y2hpbjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTE3MDUwNDE0NDYxOVoXDTE4MDUwNDE0NDYxOVowPzERMA8GA1UEAwwIaGFu
-  YWNoaW4xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAN03A8Jvk7k0aVLmIHrj
-  soZLOppADifbdH+FoXUfWXFeu9x/hq8UsuMyTuSF6oNZRihzk7yakKBcv8B44wc2
-  Kfui97h+UOqBib5oPZOrJjW34dSfnHgdsPskZRK1yvMW0X88q7K+9iBT78Xpkf40
-  XkDh7mEyA0sC25n8BBTg3HpPMNXtQazR0UrtSH/Uyu2t7Sy4QQVKFYfVdfITfMoG
-  i7X/2cXs0ao6dLOK8H1lodxZ+2Dc5UQCrerVXKvVjAgZhJIN7qgbpAfuc+KFpGhq
-  pvkFaoOJ/NCg54DDiJYhZMm2X3NtjRRE3Ujt4bwO6vVlr5aPU2/vPCvsiyF1PmO+
-  a+UCAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFMug
-  kMbzYl73rLFxRlmgKeNAiSZjMB0GA1UdEQQWMBSBEmhhbmFjaGluQGdtYWlsLmNv
-  bTAdBgNVHRIEFjAUgRJoYW5hY2hpbkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-  ggEBAFBV/OUPBF6DhEe/Q1bojFYwRdLI+JbDAoH97GRuBzKokbW7a4k5EGMw4aLx
-  RXH75W+vmsG1z/RE7lpD+T7Uf+ZuGwCIhFsGiZBcbBbinz4MEsqjGwu2/OPOgbYK
-  alk+o48ier71CaSsfz83hSAzklJ7g6BocJCWROXuVzX9eCw7YB3F4xNzdw8HxHkA
-  WbyMQMURxOX5Em9t+EgSU9Odx0tJgnhygUSdTJknavnpaZUa2odWS4+wagh8nXxS
-  +zDzgwp9Z4A8i47ioz1YEGIkQhDKZeGQznwkht0zsrtswEAiOisL5uJDtWvQiwt6
-  a9nBgrpUm8NHrucdUDtMYjixgmU=
-  -----END CERTIFICATE-----
-date: 2017-05-06 00:00:00.000000000 Z
+cert_chain: []
+date: 2017-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: haml
@@ -135,6 +113,10 @@ files:
 - bin/console
 - bin/setup
 - certs/hanachin.pem
+- examples/output_yaml.rb
+- examples/react.rb
+- examples/sample.rb
+- examples/total_num.rb
 - exe/haml_i18n_lint
 - gemfiles/haml_4.gemfile
 - gemfiles/haml_5.gemfile

metadata.gz.sig

@@ -1 +0,0 @@
-eL�'XU�*�e��ˠ�0������m-x�4�
�kQ�yw[���N3Տ>F����h�LO�vX*����$���L�Kz`	��{@�(�eH	���_�Y���j����r�?���z�P>�����l�>��õ�ߧ���C_Q��ƫ�\�Y�p(�9V�#�y?z3���k������ ����sJ
1=����W�8Y����>|Qc�0�`�ΖRr�����j���݌1�^%�R66Ə��q�Y��s,
t����