romajic 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b77eb341e6897d8f5e51bd6a1c380a4c9ae95243
+  data.tar.gz: 3f2bca42aed7ea22e08d0d2c09f5570d46556fe5
+SHA512:
+  metadata.gz: 616d6c1538e176df4b9f01e05152670dcb11e2743c4811b73724b5242492ad461d01b85f415ebc8f43a33a611da808514725438e3b93ee1110a235a62f00f2e0
+  data.tar.gz: c039283ca877bd0ba472c05f8a457fc0756eb750633b6dd4e0aea0ef4e76453bb0d7220eb124f409e3c553cf4788fdaf15b7a7a0bfcc02c6a88493a67ca721a5

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+Metrics/LineLength:
+  Enabled: false
+
+Style/ConditionalAssignment:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/MutableConstant:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/UnneededPercentQ:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+before_install: gem install bundler -v 1.11.2

data/.yardopts

@@ -0,0 +1,2 @@
+--no-private
+--markup markdown

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in romajic.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 emsk
+
+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 @@
+# Romajic
+
+[![Build Status](https://travis-ci.org/emsk/romajic.svg?branch=master)](https://travis-ci.org/emsk/romajic)
+[![Coverage Status](https://coveralls.io/repos/github/emsk/romajic/badge.svg?branch=master)](https://coveralls.io/github/emsk/romajic)
+[![Code Climate](https://codeclimate.com/github/emsk/romajic/badges/gpa.svg)](https://codeclimate.com/github/emsk/romajic)
+[![Dependency Status](https://gemnasium.com/emsk/romajic.svg)](https://gemnasium.com/emsk/romajic)
+[![Inline docs](http://inch-ci.org/github/emsk/romajic.svg?branch=master)](http://inch-ci.org/github/emsk/romajic)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
+
+Automatic romaji spelling checker for programmer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'romajic'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
+```sh
+$ gem install romajic
+```
+
+## Usage
+
+Give hiragana text:
+
+```sh
+$ romajic search すし
+SUSI -> sushi @ /usr/local/src/Example.java:5
+sushiya -> sushi @ /usr/local/src/example.txt:2
+```
+
+Give romaji text:
+
+```sh
+$ romajic search sushi
+SUSI -> sushi @ /usr/local/src/Example.java:5
+sushiya -> sushi @ /usr/local/src/example.txt:2
+```
+
+## Command Options
+
+| Option | Description |
+| :----- | :---------- |
+| `-e/--exclude-word` | Word to exclude. |
+| `-c/--config` | Path of configuration file. |
+| `-d/--dir` | Path of target directory. |
+| `-E/--extensions` | Comma-separated target extensions. |
+| `-D/--distance` | Levenshtein distance. |
+| `-C/--converter` | Romaji converter, such as `hepburn`, `modified_hepburn`, `traditional_hepburn`, `nihon`, or `kunrei`. |
+
+## Contributing
+
+1. Fork it ( https://github.com/emsk/romajic/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+[MIT](LICENSE.txt)

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 'romajic'
+
+# 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

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/default.yml

@@ -0,0 +1,6 @@
+target_words:
+exclude_words:
+root_dir:
+extensions:
+distance:
+converter:

data/exe/romajic

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require 'romajic'

data/lib/romajic.rb

@@ -0,0 +1,2 @@
+require 'romajic/version'
+require 'romajic/cli'

data/lib/romajic/cli.rb

@@ -0,0 +1,51 @@
+require 'thor'
+require 'romajic/cop'
+
+# Automatic romaji spelling checker
+module Romajic
+
+  # Command-line interface of {Romajic}
+  class CLI < Thor
+    desc 'search WORD', 'Search romaji'
+    option :exclude_word, type: :string, aliases: '-e', banner: 'WORD TO EXCLUDE'
+    option :config, type: :string, aliases: '-c', banner: 'PATH OF THE CONFIGURATION FILE'
+    option :dir, type: :string, aliases: '-d', banner: 'PATH OF TARGET DIRECTORY'
+    option :extensions, type: :string, aliases: '-E', banner: 'COMMA-SEPARATED TARGET EXTENSIONS'
+    option :distance, type: :numeric, aliases: '-D', banner: 'LEVENSHTEIN DISTANCE'
+    option :converter, type: :string, aliases: '-C', banner: 'ROMAJI CONVERTER, e.g. hepburn, modified_hepburn, traditional_hepburn, nihon, or kunrei'
+
+    # Search romaji in the source files
+    #
+    # @param word [String] Target romaji
+    def search(word = nil)
+      cop_options = {}
+
+      cop_options[:word] = word if word
+      cop_options[:exclude_word] = options[:exclude_word] if options[:exclude_word]
+
+      if options[:config]
+        cop_options[:config] = File.expand_path(options[:config])
+      else
+        cop_options[:config] = File.expand_path('../../../default.yml', __FILE__)
+      end
+
+      cop_options[:dir] = options[:dir] if options[:dir]
+      cop_options[:extensions] = options[:extensions] if options[:extensions]
+      cop_options[:distance] = options[:distance] if options[:distance]
+      cop_options[:converter] = options[:converter] if options[:converter]
+
+      cop = Cop.new(cop_options)
+      cop.search
+    end
+
+    desc '-v, --version', 'Print the version'
+    map %w(-v --version) => :version
+
+    # Print the version
+    def version
+      puts "romajic #{Romajic::VERSION}"
+    end
+  end
+
+  CLI.start
+end

data/lib/romajic/config.rb

@@ -0,0 +1,120 @@
+require 'yaml'
+require 'romajify/converter'
+
+module Romajic
+
+  # Configurations for {Cop}
+  class Config
+    HEPBURN_CONVERTERS = %w(hepburn modified_hepburn traditional_hepburn)
+    ALLOWED_CONVERTERS = %w(hepburn nihon kunrei)
+
+    attr_reader :target_words, :exclude_words, :distance
+
+    # Initialize a new Config object
+    #
+    # @param options [Hash] Initialize options
+    # @option options [String] :word Target romaji
+    # @option options [String] :exclude_word Word to exclude
+    # @option options [String] :config Path of the configuration file
+    # @option options [String] :dir Path of target directory
+    # @option options [String] :extensions Comma-separated target extensions
+    # @option options [Integer] :distance Levenshtein distance
+    # @option options [String] :converter Romaji converter
+    def initialize(options)
+      @options = Marshal.load(Marshal.dump(options))
+      set_configs_from_file
+      set_converter
+      set_target_words
+      set_exclude_words
+      set_root_dir
+      set_extensions
+      set_distance
+    end
+
+    # Get the glob pattern of the search target files
+    #
+    # @return [String] Glob pattern
+    def target_file_pattern
+      pattern = "#{@root_dir}/**/*"
+      pattern += ".{#{@extensions.join(',')}}" unless @extensions.nil?
+      pattern
+    end
+
+    # Check if a word is the excluded word
+    #
+    # @param word [String] A word, e.g. class, const
+    # @return [Boolean] True if a word is the excluded word
+    def exclude_word?(word)
+      exclude_words.include?(word)
+    end
+
+    private
+
+    def set_configs_from_file
+      configs = YAML.load_file(@options[:config])
+      @configs = Hash[configs.map { |k, v| [k.to_sym, v] }]
+    end
+
+    def set_converter
+      @converter = @options[:converter] || @configs[:converter] || 'hepburn'
+      set_converter_options
+      @converter = 'hepburn' if hepburn_converter?
+
+      raise "No such converter - #{@converter}" unless allowed_converter?
+    end
+
+    def set_converter_options
+      @converter_options = @converter == 'traditional_hepburn' ? { traditional: true } : {}
+    end
+
+    def hepburn_converter?
+      HEPBURN_CONVERTERS.include?(@converter)
+    end
+
+    def allowed_converter?
+      ALLOWED_CONVERTERS.include?(@converter)
+    end
+
+    def set_target_words
+      if @options[:word]
+        @target_words = [@options[:word]]
+      else
+        @target_words = @configs[:target_words] || []
+      end
+
+      @target_words.map! do |word|
+        word.ascii_only? ? word : Romajify::Converter.public_send(@converter, word, @converter_options)
+      end
+    end
+
+    def set_exclude_words
+      if @options[:exclude_word]
+        @exclude_words = [@options[:exclude_word]]
+      else
+        @exclude_words = @configs[:exclude_words] || []
+      end
+    end
+
+    def set_root_dir
+      if @options[:dir]
+        @root_dir = File.expand_path(@options[:dir])
+      elsif @configs[:root_dir]
+        @root_dir = File.expand_path(@configs[:root_dir], File.dirname(@options[:config]))
+      else
+        @root_dir = File.expand_path('.')
+      end
+    end
+
+    def set_extensions
+      if @options[:extensions]
+        @extensions = @options[:extensions].split(',')
+      else
+        @extensions = @configs[:extensions]
+      end
+    end
+
+    def set_distance
+      @distance = @options[:distance] || @configs[:distance] || 3
+    end
+  end
+end

data/lib/romajic/cop.rb

@@ -0,0 +1,105 @@
+require 'coderay'
+require 'levenshtein'
+require 'romajic/config'
+
+module Romajic
+
+  # Search logic class of {Romajic}
+  class Cop
+    TARGET_KINDS = CodeRay::TokenKinds.keys
+
+    # Initialize a new Cop object
+    #
+    # @param options [Hash] Initialize options
+    # @option options [String] :word Target romaji
+    # @option options [String] :exclude_word Word to exclude
+    # @option options [String] :config Path of the configuration file
+    # @option options [String] :dir Path of target directory
+    # @option options [String] :extensions Comma-separated target extensions
+    # @option options [Integer] :distance Levenshtein distance
+    # @option options [String] :converter Romaji converter
+    def initialize(options)
+      @config = Config.new(options)
+    end
+
+    # Search romaji in the source files
+    def search
+      Dir.glob(@config.target_file_pattern, File::FNM_CASEFOLD).each do |file_path|
+        next if FileTest.directory?(file_path)
+
+        extension = File.extname(file_path).sub(/^./, '').downcase
+
+        if extension.empty?
+          tokens = CodeRay.scan(File.read(file_path), :txt).tokens
+          search_in_plain_text(tokens, file_path)
+        else
+          tokens = CodeRay.scan(File.read(file_path), extension.to_sym).tokens
+          search_in_tokens(tokens, file_path)
+        end
+      end
+
+      nil
+    end
+
+    private
+
+    def search_in_tokens(tokens, file_path)
+      line_number = 1
+
+      tokens.each_slice(2) do |token|
+        text = token[0]
+        kind = token[1]
+        line_number += text.count("\n") if text.is_a?(String)
+
+        next unless target_kind?(kind.to_sym)
+        next if @config.exclude_word?(text.to_s)
+
+        current_word = strip_text(text.to_s)
+
+        next if current_word.empty?
+
+        search_in_words(current_word, file_path, line_number)
+      end
+    end
+
+    def search_in_plain_text(tokens, file_path)
+      text = tokens[0]
+
+      text.each_line.with_index(1) do |line, line_number|
+        line.split.each do |word|
+          next if @config.exclude_word?(word.to_s)
+
+          current_word = strip_text(word.to_s)
+
+          next if current_word.empty?
+
+          search_in_words(current_word, file_path, line_number)
+        end
+      end
+    end
+
+    def target_kind?(kind)
+      TARGET_KINDS.include?(kind)
+    end
+
+    def strip_text(text)
+      text
+        .gsub(/\/|\\|\"|\*/, '')
+        .gsub(/\s+/, ' ')
+        .strip
+    end
+
+    def search_in_words(current_word, file_path, line)
+      @config.target_words.each do |target_word|
+        target_word.downcase!
+        next unless similar?(target_word, current_word.downcase)
+        puts "#{current_word} -> #{target_word} @ #{file_path}:#{line}"
+      end
+    end
+
+    def similar?(target, current)
+      distance = Levenshtein.distance(target, current)
+      1 <= distance && distance <= @config.distance
+    end
+  end
+end

data/lib/romajic/version.rb

@@ -0,0 +1,3 @@
+module Romajic
+  VERSION = '0.1.0'
+end

data/romajic.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'romajic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'romajic'
+  spec.version       = Romajic::VERSION
+  spec.authors       = ['emsk']
+  spec.email         = ['emsk1987@gmail.com']
+
+  spec.summary       = %q{Automatic romaji spelling checker.}
+  spec.description   = %q{Automatic romaji spelling checker. Let's write correct romaji.}
+  spec.homepage      = 'https://github.com/emsk/romajic'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'thor', '~> 0.19'
+  spec.add_runtime_dependency 'coderay', '~> 1.1'
+  spec.add_runtime_dependency 'levenshtein', '~> 0.2'
+  spec.add_runtime_dependency 'romajify', '~> 0.1'
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'simplecov', '~> 0.11'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'redcarpet', '~> 3.3'
+  spec.add_development_dependency 'rubocop', '~> 0.38'
+end

metadata

@@ -0,0 +1,234 @@
+--- !ruby/object:Gem::Specification
+name: romajic
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- emsk
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: coderay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: levenshtein
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: romajify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+description: Automatic romaji spelling checker. Let's write correct romaji.
+email:
+- emsk1987@gmail.com
+executables:
+- romajic
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- default.yml
+- exe/romajic
+- lib/romajic.rb
+- lib/romajic/cli.rb
+- lib/romajic/config.rb
+- lib/romajic/cop.rb
+- lib/romajic/version.rb
+- romajic.gemspec
+homepage: https://github.com/emsk/romajic
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Automatic romaji spelling checker.
+test_files: []
+has_rdoc: