Skip to content

Commit

Permalink
first commit
Browse files Browse the repository at this point in the history
  • Loading branch information
Yuto Matsukubo committed Aug 12, 2016
0 parents commit 376b6f7
Show file tree
Hide file tree
Showing 16 changed files with 239 additions and 0 deletions.
10 changes: 10 additions & 0 deletions .gitignore
@@ -0,0 +1,10 @@
/.bundle/
/.yardoc
/Gemfile.lock
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
.ruby-version
2 changes: 2 additions & 0 deletions .rspec
@@ -0,0 +1,2 @@
--format documentation
--color
4 changes: 4 additions & 0 deletions .travis.yml
@@ -0,0 +1,4 @@
language: ruby
rvm:
- 2.1.5
before_install: gem install bundler -v 1.10.6
13 changes: 13 additions & 0 deletions CODE_OF_CONDUCT.md
@@ -0,0 +1,13 @@
# Contributor Code of Conduct

As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.

We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
4 changes: 4 additions & 0 deletions Gemfile
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in furiganize.gemspec
gemspec
21 changes: 21 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Yuto Matsukubo

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.
44 changes: 44 additions & 0 deletions README.md
@@ -0,0 +1,44 @@
# Furiganize

Furiganize is replace Kanji to Hiragana. Powered by [Yahoo Furigana Service](http://developer.yahoo.co.jp/webapi/jlp/furigana/v1/furigana.html)

## Installation

```
$ gem install furiganize
```

## Usage

Show help

```
$ furiganize -h
```

Basic usage

```
$ furiganize -a [YOUR_YAHOO_APP_ID] -g 3 -v -h '小学三年生が書いたこの文章は魑魅魍魎' # => 小学三年生が書いたこのぶんしょうはちみもうりょう
```

or, you can use stdin.

```
$ echo '小学三年生が書いたこの文章は魑魅魍魎' | bundle exec exe/furiganize -a [YOUR_YAHOO_APP_ID] -g 3
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec furiganize` to use the gem in this directory, ignoring other installed copies of this gem.

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/[USERNAME]/furiganize. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.


## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
6 changes: 6 additions & 0 deletions Rakefile
@@ -0,0 +1,6 @@
require "bundler/gem_tasks"
require "rspec/core/rake_task"

RSpec::Core::RakeTask.new(:spec)

task :default => :spec
11 changes: 11 additions & 0 deletions bin/console
@@ -0,0 +1,11 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "furiganize"

# 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
7 changes: 7 additions & 0 deletions bin/setup
@@ -0,0 +1,7 @@
#!/bin/bash
set -euo pipefail
IFS=$'\n\t'

bundle install

# Do any other automated setup that you need to do here
44 changes: 44 additions & 0 deletions exe/furiganize
@@ -0,0 +1,44 @@
#!/usr/bin/env ruby

require "furiganize"
require "optparse"

params = ARGV.getopts('vh', 'appid:', 'grade:1')

yahoo_app_id = params["a"] || params["appid"]
grade = params["g"] || params["grade"]
verbose = params["v"]
help = params["h"]

if File.pipe?(STDIN) || File.select([STDIN], [], [], 0) != nil
sentence = STDIN.gets
else
sentence = ARGV[0]
end

if help || (!yahoo_app_id || !grade || !sentence)
puts <<"EOS"
Usage:
Furiganize [Options] sentence
Options
-a, [--appid] # Specified your Yahoo App ID. see also: http://developer.yahoo.co.jp/start/
-g, [--grade] # Specified japan elementary school grade
-v # Verbose
SEE ALSO
http://developer.yahoo.co.jp/webapi/jlp/furigana/v1/furigana.html
EOS
exit
end

if verbose
puts <<"EOS"
yahoo_app_id: #{yahoo_app_id}
grade: #{grade}
sentence: #{sentence}
EOS
end

doc = Furiganize::YahooFuriganaService.new(yahoo_app_id, grade, sentence).fetch
puts doc.css("Word").map {|w| w.at_css("Furigana") || w.at_css("Surface") }.map(&:text).join
36 changes: 36 additions & 0 deletions furiganize.gemspec
@@ -0,0 +1,36 @@
# coding: utf-8
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'furiganize/version'

Gem::Specification.new do |spec|
spec.name = "furiganize"
spec.version = Furiganize::VERSION
spec.authors = ["Yuto Matsukubo"]
spec.email = ["matsukubo@socket.co.jp"]

spec.summary = %q{Replace Kanji to Hiragana poword by yahoo furigana service.}
spec.description = %q{Replace Kanji to Hiragana poword by yahoo furigana service.}
spec.homepage = ""
spec.license = "MIT"

# Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
# delete this section to allow pushing this gem to any host.
if spec.respond_to?(:metadata)
spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
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 { |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_dependency "nokogiri", "~> 1.6.8"

spec.add_development_dependency "bundler", "~> 1.10"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "rspec"
spec.add_development_dependency "pry"
end
21 changes: 21 additions & 0 deletions lib/furiganize.rb
@@ -0,0 +1,21 @@
require "open-uri"
require "nokogiri"
require "furiganize/version"

module Furiganize
class YahooFuriganaService
def initialize(app_id, grade, sentence)
@app_id = app_id
@grade = grade
@sentence = sentence
end

def endpoint
"http://jlp.yahooapis.jp/FuriganaService/V1/furigana?appid=#{@app_id}&grade=#{@grade}&sentence=#{URI.encode(@sentence)}"
end

def fetch
Nokogiri::XML(open(endpoint))
end
end
end
3 changes: 3 additions & 0 deletions lib/furiganize/version.rb
@@ -0,0 +1,3 @@
module Furiganize
VERSION = "0.0.1"
end
11 changes: 11 additions & 0 deletions spec/furiganize_spec.rb
@@ -0,0 +1,11 @@
require 'spec_helper'

describe Furiganize do
it 'has a version number' do
expect(Furiganize::VERSION).not_to be nil
end

it 'does something useful' do
expect(false).to eq(true)
end
end
2 changes: 2 additions & 0 deletions spec/spec_helper.rb
@@ -0,0 +1,2 @@
$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
require 'furiganize'

0 comments on commit 376b6f7

Please sign in to comment.