jp_strings_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f2e5360d873e7e539abffef78140079257ffea65
+  data.tar.gz: 4ba1d251bdbfe1a5e8e86cdbcab382c8e5a98d17
+SHA512:
+  metadata.gz: 5bc8c4b53fac9f884f5f6f2e97c1a46f457ee9e17d675abfb25700e1419b40543a9e55a40d16e41aa6acfa28d0ec64ab2231947bf9f2e7e0f90a9747db7d1443
+  data.tar.gz: d6aa0d57c77b6439f2168af5be016c6339d2a8a81e49d4ec9b7c24b93ac032378f1f9bd004a814962926fcf9d2b827c43aa94c6d6185cbb169b9d89d3d2a3801

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

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 jp_strings_finder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Hirofumi Wakasugi
+
+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,71 @@
+# jp_strings_finder
+
+jp_strings_finder is an i18n util for your Japanese project which expected to get translated to other languages.
+
+It searchs for Japanese strings in a directory or a file and reports the results like:
+
+```
+$ jp_strings_finder app/
+
++--------------------------------------------+------+------------------------------------------------+
+| File                                       | Type | Strings                                        |
++--------------------------------------------+------+------------------------------------------------+
+| controllers/books_controller.rb            | RUBY | 本を書いました                                 |
++--------------------------------------------+------+------------------------------------------------+
+| views/books/index.slim                     | SLIM | 本の一覧ですほげ                               |
+|                                            |      | 次のページを見る                               |
++--------------------------------------------+------+------------------------------------------------+
+There are 3 Japanese strings in 2 files
+```
+
+jp_strings_finder currently supports the below file types:
+
+- Ruby (`.rb`)
+- ERB (`.erb`)
+- Slim (`.slim`)
+
+It fails with status code `-1` when at least 1 Japanese string is found, so it can also be used in your test.
+
+## Usage
+
+### Specifying a single file
+
+Specifying a single file searchs for Japanese strings in the file:
+
+```
+$ jp_strings_finder app/views/books/index.slim
+```
+
+### Specifying a directory
+
+Specifying a directory recursively searchs for Japanese strings in the directory:
+
+```
+$ jp_strings_finder app/views/
+```
+
+In both cases, files with not supported filetype are ignore with the below message:
+
+```
+Unsupported filetype [app/views/books/books.csv]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jp_strings_finder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jp_strings_finder
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jp_strings_finder"
+
+# 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/exe/jp_strings_finder

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require "colorize"
+require "jp_strings_finder"
+
+def find_in_file(file_path)
+  file_path = File.expand_path(file_path)
+  begin
+    strings = JpStringsFinder.find_in(file_path)
+  rescue => e
+    STDERR.puts e.message.colorize(:red)
+    return
+  end
+
+  unless strings.empty?
+    {
+      file: file_path,
+      type: JpStringsFinder::FiletypeDetector.new(file_path).filetype, #TODO: directly access to inner class is not preffered
+      strings: strings
+    }
+  end
+end
+
+def find_in_directory(dir_path)
+  dir_path = File.expand_path(dir_path)
+  results = []
+  Dir.glob(File.join(dir_path, "/**/*")) do |file_path|
+    next if File.directory?(file_path)
+    results << find_in_file(file_path)
+  end
+  results
+end
+
+path = ARGV[0]
+
+results =
+  if File.directory?(path)
+    find_in_directory(path).compact
+  elsif File.file?(path)
+    [find_in_file(path)].compact
+  else
+    raise "[#{path}] is not found"
+  end
+
+if results.empty?
+  STDERR.puts "Yay! There is no Japanese string exists in your app codes!".colorize(:green)
+  exit 0
+else
+  JpStringsFinder::Printer.new(results.compact).print_table
+  exit 1
+end

data/jp_strings_finder.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jp_strings_finder/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "jp_strings_finder"
+  spec.version       = JpStringsFinder::VERSION
+  spec.authors       = ["Hirofumi Wakasugi"]
+  spec.email         = ["baenej@gmail.com"]
+
+  spec.summary       = "Find string literals using Japanese chanracters in them"
+  spec.description   = "Find string literals using Japanese chanracters in them"
+  spec.homepage      = "https://github.com/5t111111/jp_strings_finder.git"
+  spec.license       = "MIT"
+
+  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_runtime_dependency "colorize", "~> 0.8"
+  spec.add_runtime_dependency "terminal-table", "~> 1.8"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "tapp"
+  spec.add_development_dependency "awesome_print"
+end

data/lib/jp_strings_finder.rb

@@ -0,0 +1,9 @@
+require "jp_strings_finder/version"
+require "jp_strings_finder/finder"
+require "jp_strings_finder/printer"
+
+module JpStringsFinder
+  def self.find_in(file_path)
+    Finder.new(file_path).find
+  end
+end

data/lib/jp_strings_finder/erb_finder.rb

@@ -0,0 +1,15 @@
+module JpStringsFinder
+  class ERBFinder
+    attr_reader :src
+
+    def initialize(src)
+      @src = src
+    end
+
+    # Very very rough implementation for the moment...
+    def find
+      src.split("\n")
+    end
+  end
+end
+

data/lib/jp_strings_finder/filetype_detector.rb

@@ -0,0 +1,19 @@
+module JpStringsFinder
+  class FiletypeDetector
+    attr_reader :filetype
+
+    def initialize(file_path)
+      @filetype =
+        case File.extname(file_path)
+        when ".rb"
+          :ruby
+        when ".erb"
+          :erb
+        when ".slim"
+          :slim
+        else
+          raise "Unsupported filetype [#{file_path}]"
+        end
+    end
+  end
+end

data/lib/jp_strings_finder/finder.rb

@@ -0,0 +1,39 @@
+require "jp_strings_finder/filetype_detector"
+require "jp_strings_finder/ruby_finder"
+require "jp_strings_finder/erb_finder"
+require "jp_strings_finder/slim_finder"
+require "jp_strings_finder/japanese_detector"
+
+module JpStringsFinder
+  class Finder
+    attr_reader :file_path, :filetype
+
+    def initialize(file_path)
+      @file_path = file_path
+      @filetype = FiletypeDetector.new(file_path).filetype
+    end
+
+    def find
+      File.open(file_path) do |f|
+        finder = filetype_specific_finder.new(f.read)
+        finder.find.select do |str|
+          JapaneseDetector.contain_japanese?(str)
+        end
+      end
+    end
+
+    private
+
+    def filetype_specific_finder
+      @filetype_specific_finder ||=
+        case filetype
+        when :ruby
+          RubyFinder
+        when :erb
+          ERBFinder
+        when :slim
+          SlimFinder
+        end
+    end
+  end
+end

data/lib/jp_strings_finder/japanese_detector.rb

@@ -0,0 +1,8 @@
+module JpStringsFinder
+  class JapaneseDetector
+    def self.contain_japanese?(str)
+      jp_pattern = /[\p{Han}\p{Hiragana}\p{Katakana}，．、。ー・]+/
+      str.match(jp_pattern)
+    end
+  end
+end

data/lib/jp_strings_finder/printer.rb

@@ -0,0 +1,38 @@
+require "pathname"
+require "terminal-table"
+require "colorize"
+
+module JpStringsFinder
+  class Printer
+    attr_reader :list
+
+    def initialize(list)
+      @list = list
+    end
+
+    def print_table
+      table = Terminal::Table.new do |t|
+        t.headings = ['File', 'Type', 'Strings']
+        list.each_with_index do |hash, index|
+          t.add_row(
+            [
+              to_relative_path(Dir.pwd, hash[:file]),
+              hash[:type].upcase,
+              hash[:strings].join("\n")
+            ]
+          )
+          t.add_separator unless index == list.count - 1
+        end
+      end
+      puts table
+      strings_count = list.inject(0) { |acc, elem| acc + elem[:strings].count }
+      STDERR.puts "There are #{strings_count} Japanese strings in #{list.count} files".colorize(:yellow)
+    end
+
+    private
+
+    def to_relative_path(root, path)
+      Pathname.new(path).relative_path_from(Pathname.new(root)).to_s
+    end
+  end
+end

data/lib/jp_strings_finder/ruby_finder.rb

@@ -0,0 +1,30 @@
+require 'ripper'
+
+module JpStringsFinder
+  class RubyFinder
+    class RipperCustom < Ripper
+      attr_reader :strings
+
+      def initialize(src)
+        super(src)
+        @strings = []
+      end
+
+      def on_tstring_content(str)
+        @strings << str
+      end
+    end
+
+    attr_reader :src
+
+    def initialize(src)
+      @src = src
+    end
+
+    def find
+      ripper = RipperCustom.new(src)
+      ripper.parse
+      ripper.strings
+    end
+  end
+end

data/lib/jp_strings_finder/slim_finder.rb

@@ -0,0 +1,14 @@
+module JpStringsFinder
+  class SlimFinder
+    attr_reader :src
+
+    def initialize(src)
+      @src = src
+    end
+
+    # Very very rough implementation for the moment...
+    def find
+      src.split("\n")
+    end
+  end
+end

data/lib/jp_strings_finder/version.rb

@@ -0,0 +1,3 @@
+module JpStringsFinder
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: jp_strings_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hirofumi Wakasugi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-18 00:00:00.000000000 Z
+dependencies:
+- !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: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: pry-byebug
+  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: tapp
+  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: awesome_print
+  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: Find string literals using Japanese chanracters in them
+email:
+- baenej@gmail.com
+executables:
+- jp_strings_finder
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/jp_strings_finder
+- jp_strings_finder.gemspec
+- lib/jp_strings_finder.rb
+- lib/jp_strings_finder/erb_finder.rb
+- lib/jp_strings_finder/filetype_detector.rb
+- lib/jp_strings_finder/finder.rb
+- lib/jp_strings_finder/japanese_detector.rb
+- lib/jp_strings_finder/printer.rb
+- lib/jp_strings_finder/ruby_finder.rb
+- lib/jp_strings_finder/slim_finder.rb
+- lib/jp_strings_finder/version.rb
+homepage: https://github.com/5t111111/jp_strings_finder.git
+licenses:
+- MIT
+metadata: {}
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Find string literals using Japanese chanracters in them
+test_files: []