i18n_extract 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f33f1b8308984c3005aa857ac7e1c02644027b1c6e8ddacc9cc5c4c4f02594e3
+  data.tar.gz: c112e2b679fa2cca77ea56bec0522cadbd41e4485fe78798ce036b068ab21e26
+SHA512:
+  metadata.gz: c2c11d3be73db5d635b9a59ec2740d8fbdacbe3219da2c3a933fce155f0767ea8f609f1e4276faed832815a35c4cb0eff46188bc64a538b7c5a9ac0d0f25e956
+  data.tar.gz: 3c09998892ae1837462701b77398d5ffa4ad10899caaf43e4dbaa35287de158abf105d5683f65feff0135fe23da135dc92f5e3e7d55d16cfe521f2536b7ebd2f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in i18n_extract.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    i18n_extract (1.0.0)
+      better_html (~> 1.0)
+      colorize (~> 0.8)
+      parser (~> 2.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.2.1)
+      activesupport (= 5.2.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    better_html (1.0.11)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
+    builder (3.2.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    erubi (1.7.1)
+    html_tokenizer (0.0.7)
+    i18n (1.1.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    smart_properties (1.13.1)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  i18n_extract!
+  minitest (~> 5)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Marcel Müller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# I18nExtract
+
+This gem adds a new rake task 'i18n-extract:check' to your rails app.
+It then highlights and raises an error when it finds hard-coded strings in your
+views. Whitespace is ignored.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'i18n_extract'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install i18n_extract
+
+## Usage
+
+Simply run:
+
+```sh
+bundle exec rake i18n-extract:check
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec ruby test/erb_files_test.rb` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TheNeikos/i18n_extract.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "i18n_extract"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/i18n_extract.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "i18n_extract/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "i18n_extract"
+  spec.version       = I18nExtract::VERSION
+  spec.authors       = ["Marcel Müller"]
+  spec.email         = ["neikos@neikos.email"]
+
+  spec.summary       = "Extract hardcoded strings from your ERB views."
+  spec.homepage      = "https://github.com/TheNeikos/i18n_extract"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "better_html", "~> 1.0"
+  spec.add_dependency "parser", "~> 2.5"
+  spec.add_dependency "colorize", "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5"
+end

data/lib/i18n_extract/extractor.rb

@@ -0,0 +1,46 @@
+require "ast"
+require "better_html"
+require "better_html/parser"
+require "parser"
+require "i18n_extract/html_iterator"
+
+module I18nExtract
+  class ExtractError < StandardError
+    attr_reader :node
+    def initialize(node, *args)
+      super *args
+      @node = node
+    end
+
+    def message
+      msg = super
+      "#{msg}: #{node.location.to_s}"
+    end
+  end
+
+  class Extractor
+    attr_reader :path
+
+    def initialize path
+      @path = path
+      @buffer = Parser::Source::Buffer.new(@path)
+      @buffer.source = File.read(@path)
+      @parser = BetterHtml::Parser.new(@buffer)
+    end
+
+    def extract
+      children = @parser.ast
+
+      HTMLIterator.descendants(children).reject { |node|
+        node.children.reject{|child| !child.is_a?(String) }.map(&:strip).join('').empty?
+      }.to_a
+    end
+
+    def validate!
+      res = extract
+      res.each do |node|
+        raise ExtractError.new(node, "Found hard coded string") unless node.children.join('').blank?
+      end
+    end
+  end
+end

data/lib/i18n_extract/html_iterator.rb

@@ -0,0 +1,53 @@
+require 'ast'
+
+module I18nExtract
+  class HTMLIterator
+    def initialize(&block)
+      @block = block
+    end
+
+    def traverse(node)
+      return unless node.is_a?(::AST::Node)
+      case node.type
+      when :tag
+        tag_name, children = *node.to_a
+        return if %w(style script).include? tag_name.to_s
+      when :text
+        @block.call(node)
+      end
+      traverse_all(node)
+    end
+
+    def traverse_all(nodes)
+      clean(nodes).each do |node|
+        traverse(node) if node.is_a?(::AST::Node)
+      end
+    end
+
+    def clean(nodes)
+      skip = 0
+      nodes.to_a.reject do |node|
+        next true unless node.is_a?(::AST::Node)
+        if node&.type == :tag
+          solidus, tag_name = *node
+          if %w(style script).include? tag_name.to_a.first
+            if solidus.nil?
+              skip = skip + 1
+            else
+              skip = skip - 1
+            end
+            next true
+          end
+        end
+        skip != 0
+      end
+    end
+
+    def self.descendants(root_node)
+      Enumerator.new do |yielder|
+        t = new() { |node| yielder << node }
+        t.traverse(root_node)
+      end
+    end
+  end
+end

data/lib/i18n_extract/railtie.rb

@@ -0,0 +1,13 @@
+require 'i18n_extract'
+require 'rails'
+
+module I18nExtract
+  class Railtie < Rails::Railtie
+    railtie_name :i18n_extract
+
+    rake_tasks do
+      path = File.expand_path(__dir__)
+      Dir.glob("#{path}/tasks/**/*.rake").each { |f| load f }
+    end
+  end
+end

data/lib/i18n_extract/tasks/check.rake

@@ -0,0 +1,36 @@
+require 'colorize'
+
+namespace :'i18n-extract' do
+  desc "Check views for hard-coded strings"
+  task :check => :environment do
+    root = Rails.root.join('app','views')
+    Dir.glob("#{root}/**/*.html.erb").each do |file|
+      extractor = I18nExtract::Extractor.new(file)
+      extractor.extract.each do |r|
+        puts r.location.to_s.colorize(:red)
+        loc = r.location
+        if loc.stop_line - loc.start_line > 0
+          lines = loc.source_buffer.source_lines
+          start_line = loc.start_line
+          stop_line = loc.stop_line
+          print lines[start_line - 1][0..(loc.start_column - 1)].colorize(:gray)
+          puts lines[start_line - 1][loc.start_column..-1].colorize(:red)
+          lines[start_line...(stop_line - 1)].each do |line|
+            puts line.colorize(:red)
+          end
+          print lines[stop_line - 1][0..(loc.stop_column - 1)].colorize(:red)
+          puts lines[stop_line - 1][(loc.stop_column)..-1].colorize(:gray)
+        else
+          line = loc.source_line
+          print line[0..(loc.start_column - 1)].colorize(:gray)
+          print line[loc.start_column..(loc.stop_column - 1)].colorize(:red)
+          print line[(loc.stop_column)..-1].colorize(:gray)
+          puts
+          puts "#{" " * loc.start_column}#{"^" * (loc.stop_column - loc.start_column)}"
+        end
+        puts
+      end
+    end
+  end
+
+end

data/lib/i18n_extract/version.rb

@@ -0,0 +1,3 @@
+module I18nExtract
+  VERSION = "1.0.0"
+end

data/lib/i18n_extract.rb

@@ -0,0 +1,7 @@
+require "i18n_extract/version"
+require "i18n_extract/extractor"
+
+module I18nExtract
+  require 'i18n_extract/railtie' if defined?(Rails)
+
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: i18n_extract
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcel Müller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: better_html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email:
+- neikos@neikos.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- i18n_extract.gemspec
+- lib/i18n_extract.rb
+- lib/i18n_extract/extractor.rb
+- lib/i18n_extract/html_iterator.rb
+- lib/i18n_extract/railtie.rb
+- lib/i18n_extract/tasks/check.rake
+- lib/i18n_extract/version.rb
+homepage: https://github.com/TheNeikos/i18n_extract
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Extract hardcoded strings from your ERB views.
+test_files: []