chinese_phrases 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 385202535903afbd57a59323099baddfb624590a772de8221007207cba5ac931
-  data.tar.gz: 8abc3a17a1017b9eb353d92186929f79d41ad80bd6e77f9278ccb783e54110ab
+  metadata.gz: b8aeee89176b66fac20a7d2dc6629c855834a3b3a0aa4faddb8019723bcedadb
+  data.tar.gz: e23c591e951cbaaf28392a0f49311b6245cc0b1939ec60d48a0fcf53c4ded57f
 SHA512:
-  metadata.gz: bc90e621a8bb9dc0435e6113b1010527bc31eb752c8b807981ec898912c9f0c59a0404296d2a41070eca2a934bc8b46cbf943658d90f9dd389109ace2eaaea75
-  data.tar.gz: 243b5a66ab3caa9c20be51daabc907eb7f87df3f0da38ab4ea1519cb04b15d04be96da7abfdc7a8e8bcd86b72fdfcb789a64a4eb209f18fb64c78914d61e28c4
+  metadata.gz: 98ea76736fdbe23adc9c253caf63d59553778fb0ed809b6838fd17c13067e386eb495f46217cec0e0a8d74d1105a1f2b87aefb239d7f7b12367a06c4b167db99
+  data.tar.gz: '049da271d939234b9ce6e4afd96d02e6cafd93d366be9d48532166a2e7f45d463bd1a3c4184b5d88444fc124a71a3a0685513dcc429e5ebb98dcfcf765d62e61'

data/Gemfile

@@ -2,3 +2,4 @@ source 'https://rubygems.org'
 
 gem 'httparty'
 gem 'tradsim'
+gem 'thor'

data/Gemfile.lock

@@ -1,7 +1,6 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (11.0.1)
     httparty (0.17.0)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
@@ -9,14 +8,15 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2019.0331)
     multi_xml (0.6.0)
+    thor (0.20.3)
     tradsim (0.5.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
   httparty
+  thor
   tradsim
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,6 @@
 # ChinesePhrases
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/chinese_phrases`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Converts a csv of Chinese words to a csv of example sentences for use in Anki.
 
 ## Installation
 
@@ -22,7 +20,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+chinese_phrases export input_words.csv
+```
+
+Output will be at `output_phrases.csv`.
+
+By default output will be in traditional Chinese.
+
+```
+chinese_phrases help export
+
+Usage:
+  chinese_phrases export
+
+Options:
+  [--output-file=OUTPUT_FILE]
+  [--max-len=N]
+                               # Default: 15
+  [--max-per=N]
+                               # Default: 10
+  [--page-size=N]
+                               # Default: 100
+  [--trad], [--no-trad]
+                               # Default: true
+
+Output given word csv to phrases csv
+```
 
 ## Development
 
@@ -32,7 +56,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/chinese_phrases. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bendangelo/chinese_phrases. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +64,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the ChinesePhrases project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/chinese_phrases/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the ChinesePhrases project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bendangelo/chinese_phrases/blob/master/CODE_OF_CONDUCT.md).

data/bin/chinese_phrases

@@ -1,5 +1,18 @@
 #!/usr/bin/env ruby
 
 require 'chinese_phrases'
+require 'thor'
 
-ChinesePhrases.run ARGV[0]
+class CLI < Thor
+  option :output_file
+  option :max_len, type: :numeric, default: 15
+  option :max_per, type: :numeric, default: 10
+  option :page_size, type: :numeric, default: 100
+  option :trad, type: :boolean, default: true
+  desc "export", "Output given word csv to phrases csv"
+  def export(name)
+    ChinesePhrases.run name, options
+  end
+end
+
+CLI.start(ARGV)

data/chinese_phrases.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir        = "bin"
+  spec.executables   = ["chinese_phrases"]
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"

data/lib/chinese_phrases.rb

@@ -8,31 +8,33 @@ require "chinese_phrases/version"
 module ChinesePhrases
 
   class << self
-    def run input_file
+    def run input_file, options = {}
       input_index = 0
-      output_file = "output_phrases.csv"
-      to_trad = true
-
-      options = {
-        callback: "jQuery1111013304390430117385_1567195383336",
-        page: 1,
-        page_size: 100,
-        max_length: 15,
-        max_examples: 10
+      output_file = options[:output_file] || "output_phrases.csv"
+      to_trad = options[:trad]
+
+      params = {
+        page: options[:page] || 1, # page to check on source
+        page_size: options[:page_size] || 100, # number of examples from api call
+        max_length: options[:max_len] || 15, # only accept examples length than this
+        max_per: options[:max_per] || 10, # only accept this number of examples
       }
 
       query_list = []
       total_examples = []
 
+      # read input file to create list of words to query
       CSV.foreach(input_file) do |csv|
         query_list << Tradsim::to_sim(csv[input_index])
       end
 
+      # query each word individually and combine to total list
       query_list.each do |q|
-        exs = get_examples q, options
+        exs = get_examples q, params
         total_examples.push *exs
       end
 
+      # output each example to file
       CSV.open(output_file, "w") do |csv|
         total_examples.each do |a|
           example = a["example"]
@@ -41,19 +43,24 @@ module ChinesePhrases
             example = Tradsim::to_trad(example)
           end
 
+          puts "Writing #{a["recentTrslation"]} #{example}"
+
           csv << [a["recentTrslation"], example, a["pinyin"]]
         end
       end
+
+      puts "Wrote #{output_file}"
     end
 
     def get_examples query, params
       query_escaped = CGI::escape query
+      callback = "jQuery1111013304390430117385_1567195383336"
 
-      url = "https://dict.naver.com/linedict/cnen/example/search.dict?callback=#{params[:callback]}&query=#{query_escaped}&page=#{params[:page]}&page_size=#{params[:page_size]}&examType=normal&fieldType=&author=&country=&ql=default&format=json&platform=isPC&_=1567195383337"
+      url = "https://dict.naver.com/linedict/cnen/example/search.dict?callback=#{callback}&query=#{query_escaped}&page=#{params[:page]}&page_size=#{params[:page_size]}&examType=normal&fieldType=&author=&country=&ql=default&format=json&platform=isPC&_=1567195383337"
 
       response = HTTParty.get(url)
 
-      cleaned_resp = response.match("#{params[:callback]}(.*)")[1][1..-2]
+      cleaned_resp = response.match("#{callback}(.*)")[1][1..-2]
       data = JSON.parse cleaned_resp
 
       exampleList = data["exampleList"]
@@ -61,8 +68,8 @@ module ChinesePhrases
       # collect shortest examples
       examples = exampleList.filter { |i| i["example"].length < params[:max_length] }
 
-      if params[:max_examples] > -1
-        examples = examples[0..params[:max_examples] - 1]
+      if params[:max_per] > -1
+        examples = examples[0..params[:max_per] - 1]
       end
 
       examples

data/lib/chinese_phrases/version.rb

@@ -1,3 +1,3 @@
 module ChinesePhrases
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: chinese_phrases
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ben D'Angelo
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2019-08-30 00:00:00.000000000 Z
 dependencies:
@@ -41,7 +41,8 @@ dependencies:
 description: 
 email:
 - ben@bendangelo.me
-executables: []
+executables:
+- chinese_phrases
 extensions: []
 extra_rdoc_files: []
 files:
@@ -57,7 +58,6 @@ files:
 - bin/setup
 - chinese_phrases.gemspec
 - input_words.csv
-- lib/README.md
 - lib/chinese_phrases.rb
 - lib/chinese_phrases/version.rb
 homepage: https://github.com/bendangelo/chinese_phrases

data/lib/README.md

@@ -1,9 +0,0 @@
-# Chinese Phrases
-
-Converts a csv of Chinese words to a csv of example sentences for use in Anki
-
-## Usage
-
-```
-chinese_phrases input_words.csv
-```