lyracyst 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb07368fe2368b27ee37ec8f70d7f2d2a148db91
-  data.tar.gz: 22429d86922fcb5e73fe5a98981923da40e8d46b
+  metadata.gz: 7751d12d85b26befa84563c35152c9275f2603e3
+  data.tar.gz: 719eead3fb8cf83e71643931abf11155ab8d657b
 SHA512:
-  metadata.gz: 500198b5c4ee3a14352f07b62f0efd98f01dc62506fc2e93d9e851278537824a3b16c389afbe3e94d4b3f0999c399615255753755c541d25ff424d6d57ea10ec
-  data.tar.gz: 00aa7522afc18725af26ae6076fe31d4376bb18877e07db6baccaac69e2adced4757103dc675923688b10b11998a6ddc6745c27bb2f68967969380ed5f15a750
+  metadata.gz: 27d43324ff46751095c76d121dfd47956659826c03bae613df1692cd5db92dd5f74a7a3efab892ffba905843999821b8e0f867f7d7a215fc92deaf7e32441e48
+  data.tar.gz: 4113d612eb6cb24ba000e0e23023b15956c46cfc2f059c7a0fa5ea2233e17c4ff27324f44395ab851159bf87d9e744e2f1d9d856aa1eba99fb7c0d99f7a2dd91

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Changelog
 ===
 
+Version **1.0.0** - Subcommands, More options, Onelook
+- Added word info from [Onelook.com](http://www.onelook.com/?c=faq)
+- Added more CLI options
+- Shortened command names and added subcommands
+
+Version 0.0.9 - File export, Urban Dictionary, Code Climate
+- Added definitions from Urban Dictionary
+- Added JSON & XML export
+- Restructured code to improve climate
+
 Version 0.0.8 - Major Improvements
 - The biggest milestone yet!
 - Most Wordnik search functions now work

data/bin/lyracyst

@@ -1,23 +1,25 @@
 #!/usr/bin/env ruby
 # coding: utf-8
-#%w(curb em-synchrony em-http eventmachine excon httpclient httpi net/http/persistent rainbow).map {|lib| require lib}
-#%w(json/ext json/pure multi_json oj yajl).map {|lib| require lib}
-#%w(libxml multi_xml ox rexml/document).map {|lib| require lib}
+# %w(curb em-synchrony em-http eventmachine excon httpclient httpi net/http/persistent rainbow).map { |lib| require lib }
+# %w(json/ext json/pure multi_json oj yajl).map { |lib| require lib }
+# %w(libxml multi_xml ox rexml/document).map { |lib| require lib }
 require 'gli'
+require 'lyracyst/onelook'
 require 'lyracyst/rhymebrain'
 require 'lyracyst/urban'
 require 'lyracyst/version'
 require 'lyracyst/wordnik'
 require 'xml-fu'
-module Lyracyst
 
+# The Lyracyst module handles base functionality.
+module Lyracyst
   HTTPI.log = false
 
   # Optionally sets HTTP adapter with httpi. Supports [:httpclient,
   # :curb, :em_http, :net_http_persistent, :excon, :rack]
   #
   # @param http [Symbol] The http adapter to use. Smart defaults.
-  def self.set_http(http)
+  def self.http(http)
     HTTPI.adapter = http
   end
 
@@ -25,7 +27,7 @@ module Lyracyst
   # :yajl, :json_gem, :json_pure]
   #
   # @param mj [Symbol] The JSON adapter to use. Smart defaults.
-  def self.set_json(mj)
+  def self.json(mj)
     MultiJson.use(mj)
   end
 
@@ -33,7 +35,7 @@ module Lyracyst
   # :libxml, :nokogiri, :rexml]
   #
   # @param mx [Symbol] The XML adapter to use. Smart defaults.
-  def self.set_xml(mx)
+  def self.xml(mx)
     MultiXml.parser = mx
   end
 
@@ -46,6 +48,15 @@ module Lyracyst
     print Rainbow(']').blue.bright
     print Rainbow('|').bright
   end
+
+  # Adds an object to the outfile array.
+  #
+  # @param obj [String] The item to add
+  def self.tofile(obj)
+    if $fmt != nil
+      $tofile.push obj
+    end
+  end
 end
 
 include GLI::App
@@ -53,268 +64,162 @@ program_desc 'A powerful word search tool that fetches definitions, related word
 config_file '.lyracyst.yml'
 version Lyracyst::VERSION
 
-desc 'Force overwrite'
-long_desc 'Overwrites existing JSON & XML files'
-switch [:f,:force]
-
-desc 'HTTP adapter'
-long_desc 'httpclient, curb, em_http, net_http_persistent, excon, rack'
-default_value :net_http_persistent
-arg_name 'http'
-flag [:h,:http]
-
-desc 'JSON adapter'
-long_desc 'oj, yajl, json_gem, json_pure'
-default_value :oj
-arg_name 'json'
-flag [:j,:json]
+flag [:f, :format], :default_value => nil, :arg_name => 'fmt', :desc => 'File format', :long_desc => 'json or xml'
+flag [:h, :http], :default_value => :net_http_persistent, :arg_name => 'http', :desc => 'HTTP adapter', :long_desc => 'httpclient, curb, em_http, net_http_persistent, excon, rack'
+flag [:j, :json], :default_value => :oj, :arg_name => 'json', :desc => 'JSON adapter', :long_desc => 'oj, yajl, json_gem, json_pure'
+flag [:o, :out], :default_value => nil, :arg_name => 'outfile', :desc => 'Output file', :long_desc => 'filename.json or filename.xml'
+flag [:x, :xml], :default_value => :rexml, :arg_name => 'xml', :desc => 'XML adapter', :long_desc => 'ox, libxml, nokogiri, rexml'
+switch [:fo, :force], :default_value => false, :desc => 'Force overwrite', :long_desc => 'Overwrites existing JSON & XML files'
+switch [:v, :verbose], :default_value => false, :desc => 'Prints parameters and options'
 
-desc 'Output file'
-long_desc 'filename.json or filename.xml'
-default_value nil
-arg_name 'outfile'
-flag [:o,:out]
-
-desc 'XML adapter'
-long_desc 'ox, libxml, nokogiri, rexml'
-default_value :rexml
-arg_name 'xml'
-flag [:x,:xml]
-
-desc 'Fetches definitions from Wordnik'
-arg_name 'word'
-command :define do |c|
-  c.desc 'Comma-separated list of parts of speech. See http://developer.wordnik.com/docs.html#!/word/getDefinitions_get_2 for list of parts.'
-  c.default_value nil
-  c.arg_name 'part'
-  c.flag [:p,:part]
-  c.desc "Source dictionary to return definitions from. If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd, wiktionary, webster, century, wordnet"
-  c.default_value 'all'
-  c.arg_name 'defdict'
-  c.flag [:defdict]
-  c.action do |global_options,options,args|
-    # If you have any errors, just raise them
-    # raise "that command made no sense"
-    search = args[0]
-    part = options[:p]
-    params = {limit: 10, increl: false, canon: false, inctags: false}
-    params[:defdict] = options[:defdict]
-    df = Lyracyst::Wordnik::Define.new
-    df.get_def(search, part, params)
+desc 'Wordnik operations'
+arg_name 'wordnik'
+command :wn do |nik|
+  nik.switch :canon, :default_value => false, :desc => 'Use canonical', :long_desc => "If true will try to return the correct word root ('cats' -> 'cat'). If false returns exactly what was requested."
+  nik.flag :limit, :default_value => 5, :arg_name => 'limit', :desc => 'Maximum number of results to return'
+  nik.desc 'Fetch definitions from Wordnik'
+  nik.arg_name 'define'
+  nik.command :def do |define|
+    define.flag :defdict, :default_value => 'all', :arg_name => 'defdict', :desc => "CSV list. Source dictionaries to return definitions from. If 'all' is received, results are returned from all sources. If multiple values are received (e.g. 'century,wiktionary'), results are returned from the first specified dictionary that has definitions. If left blank, results are returned from the first dictionary that has definitions. By default, dictionaries are searched in this order: ahd, wiktionary, webster, century, wordnet"
+    define.flag [:p, :part], :default_value => nil, :arg_name => 'part', :desc => 'Comma-separated list of parts of speech. See http://developer.wordnik.com/docs.html#!/word/getDefinitions_get_2 for list of parts.'
+    define.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon], defdict: options[:defdict], increl: false, inctags: false, limit: options[:limit] }
+      df = Lyracyst::Wordnik::Define.new
+      df.get_def(search, options[:p], params)
+    end
   end
-end
-
-desc 'Fetches examples from Wordnik'
-arg_name 'word'
-command :example do |c|
-  c.desc 'Results to skip'
-  c.default_value 0
-  c.arg_name 'skip'
-  c.flag [:s,:skip]
-  c.desc 'Maximum number of results to return'
-  c.default_value 5
-  c.arg_name 'limit'
-  c.flag [:limit]
-  c.action do |global_options,options,args|
-    search = args[0]
-    skip = options[:s]
-    limit = options[:limit]
-    params = {incdups: false, canon: false}
-    params[:skip] = skip
-    params[:limit] = limit
-    ex = Lyracyst::Wordnik::Example.new
-    ex.get_ex(search, params)
+  nik.desc 'Fetch examples from Wordnik'
+  nik.arg_name 'example'
+  nik.command :ex do |example|
+    example.flag [:s, :skip], :default_value => 0, :arg_name => 'skip', :desc => 'Results to skip'
+    example.switch :incdups, :default_value => false, :desc => 'Show duplicate examples from different sources'
+    example.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon], incdups: options[:incdups], limit: options[:limit], skip: options[:s] }
+      ex = Lyracyst::Wordnik::Example.new
+      ex.get_ex(search, params)
+    end
   end
-end
-
-desc 'Fetches related words from Wordnik'
-arg_name 'word'
-command :relate do |c|
-  c.desc 'Limits the total results per type of relationship type'
-  c.default_value nil
-  c.arg_name 'reltypes'
-  c.flag [:relt]
-  c.desc 'Restrict to the supplied relationship types'
-  c.default_value 10
-  c.arg_name 'rell'
-  c.flag [:rell]
-  c.action do |global_options,options,args|
-    search = args[0]
-    reltypes = options[:relt]
-    rellimit = options[:rell]
-    params = {canon: false}
-    params[:rellimit] = rellimit
-    ex = Lyracyst::Wordnik::Relate.new
-    ex.get_rel(search, params, reltypes)
+  nik.desc 'Fetches related words from Wordnik'
+  nik.arg_name 'relate'
+  nik.command :rel do |relate|
+    relate.flag :relt, :default_value => nil, :arg_name => 'reltypes', :desc => 'Limits the total results per type of relationship type'
+    relate.flag :rell, :default_value => 10, :arg_name => 'rell', :desc => 'Restrict to the supplied relationship types'
+    relate.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon], rellimit: options[:rell] }
+      ex = Lyracyst::Wordnik::Relate.new
+      ex.get_rel(search, params, options[:relt])
+    end
   end
-end
-
-desc 'Fetches pronunciations from Wordnik'
-arg_name 'word'
-command :pronounce do |c|
-  c.desc 'Get from a single dictionary. Valid options: ahd, century, cmu, macmillan, wiktionary, webster, or wordnet'
-  c.default_value nil
-  c.arg_name 'source'
-  c.flag [:src]
-  c.desc 'Text pronunciation type'
-  c.long_desc 'ahd, arpabet, gcide-diacritical, IPA'
-  c.default_value nil
-  c.arg_name 'ptype'
-  c.flag [:pt]
-  c.desc 'Maximum number of results to return'
-  c.default_value 5
-  c.arg_name 'limit'
-  c.flag [:limit]
-  c.action do |global_options,options,args|
-    search = args[0]
-    source = options[:src]
-    ptype = options[:pt]
-    limit = options[:limit]
-    params = {canon: false}
-    params[:source] = source
-    params[:limit] = limit
-    pr = Lyracyst::Wordnik::Pronounce.new
-    pr.get_pro(search, params, ptype)
+  nik.desc 'Fetches pronunciations from Wordnik'
+  nik.arg_name 'pronounce'
+  nik.command :pro do |pronounce|
+    pronounce.flag :src, :default_value => nil, :arg_name => 'source', :desc =>'Get from a single dictionary. Valid options: ahd, century, cmu, macmillan, wiktionary, webster, or wordnet'
+    pronounce.flag :pt, :default_value => nil, :arg_name => 'ptype', :desc => 'Text pronunciation type', :long_desc => 'ahd, arpabet, gcide-diacritical, IPA'
+    pronounce.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon], limit: options[:limit], source: options[:src] }
+      pr = Lyracyst::Wordnik::Pronounce.new
+      pr.get_pro(search, params, options[:pt])
+    end
   end
-end
-
-desc 'Fetches hyphenation and syllable stresses from Wordnik. Primary stress is red, secondary stress is bright white.'
-arg_name 'word'
-command :hyphen do |c|
-  c.desc "Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet."
-  c.default_value nil
-  c.arg_name 'source'
-  c.flag [:src]
-  c.desc 'Maximum number of results to return'
-  c.default_value 5
-  c.arg_name 'limit'
-  c.flag [:limit]
-  c.action do |global_options,options,args|
-    search = args[0]
-    source = options[:src]
-    limit = options[:limit]
-    params = {canon: false}
-    if source != nil then params[:source] = source; end
-    params[:limit] = limit
-    hyph = Lyracyst::Wordnik::Hyphen.new
-    hyph.get_hyph(search, params)
+  nik.desc 'Fetches hyphenation and syllable stresses from Wordnik. Primary stress is red, secondary stress is bright white.'
+  nik.arg_name 'hyphen'
+  nik.command :hyph do |hyphen|
+    hyphen.flag :source, :default_value => nil, :arg_name => 'source', :desc => "Get from a single dictionary. Valid options: ahd, century, wiktionary, webster, and wordnet."
+    hyphen.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon], limit: options[:limit] }
+      if options[:source] != nil then params[:source] = options[:source]; end
+      hyph = Lyracyst::Wordnik::Hyphen.new
+      hyph.get_hyph(search, params)
+    end
   end
-end
-
-desc 'Fetches bi-gram phrases from Wordnik'
-arg_name 'word'
-command :phrase do |c|
-  c.desc 'Maximum number of results to return'
-  c.default_value 10
-  c.arg_name 'limit'
-  c.flag [:limit]
-  c.desc 'Minimum WLMI(weighted mutual info) for the phrase.'
-  c.default_value 13
-  c.arg_name 'wlmi'
-  c.flag [:wlmi]
-  c.action do |global_options,options,args|
-    search = args[0]
-    limit = options[:limit]
-    wlmi = options[:wlmi]
-    params = {canon: false}
-    params[:limit] = limit
-    params[:wlmi] = wlmi
-    phra = Lyracyst::Wordnik::Phrase.new
-    phra.get_phr(search, params)
+  nik.desc 'Fetches bi-gram phrases from Wordnik'
+  nik.arg_name 'phrase'
+  nik.command :phr do |phrase|
+    phrase.flag :wlmi, :default_value => 13, :arg_name => 'wlmi', :desc => 'Minimum WLMI(weighted mutual info) for the phrase.'
+    phrase.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon], limit: options[:limit], wlmi: options[:wlmi] }
+      phra = Lyracyst::Wordnik::Phrase.new
+      phra.get_phr(search, params)
+    end
   end
-end
-
-desc 'Fetches etymologies from Wordnik'
-arg_name 'word'
-command :origin do |c|
-  c.action do |global_options,options,args|
-    search = args[0]
-    params = {canon: false}
-    orig = Lyracyst::Wordnik::Origin.new
-    orig.get_et(search, params)
+  nik.desc 'Fetches etymologies from Wordnik'
+  nik.arg_name 'origin'
+  nik.command :ori do |origin|
+    origin.action do |global_options, options, args|
+      search = args[0]
+      params = { canon: options[:canon] }
+      orig = Lyracyst::Wordnik::Origin.new
+      orig.get_et(search, params)
+    end
   end
 end
 
-desc 'Fetches rhymes from Rhymebrain.com'
-arg_name 'word'
-command :rhyme do |c|
-  c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
-  c.default_value 'en'
-  c.arg_name 'lang'
-  c.flag [:lang]
-  c.desc '(optional) The number of results to return. If you do not include this parameter, RhymeBrain will choose how many words to show based on how many good sounding rhymes there are for the word.'
-  c.default_value nil
-  c.arg_name 'max'
-  c.flag [:max]
-  c.action do |global_options,options,args|
-    search = args[0]
-    lang = options[:lang]
-    max = options[:max]
-    params = {}
-    params[:lang] = lang
-    params[:max] = max
-    rhym = Lyracyst::Rhymebrain::Rhyme.new
-    rhym.get_rhyme(search, params)
+desc 'Rhymebrain operations'
+arg_name 'rhymebrain'
+command :rb do |rb|
+  rb.flag :lang, :default_value => 'en', :arg_name => 'lang', :desc => 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
+  rb.flag :max, :default_value => nil, :arg_name => 'max', :desc => '(optional) The number of results to return. If you do not include this parameter, RhymeBrain will choose how many words to show based on how many good sounding rhymes there are for the word.'
+  rb.desc 'Fetches rhymes from Rhymebrain.com'
+  rb.arg_name 'rhyme'
+  rb.command :rhy do |rhyme|
+    rhyme.action do |global_options, options, args|
+      search = args[0]
+      params = { lang: options[:lang], max: options[:max] }
+      rhym = Lyracyst::Rhymebrain::Rhyme.new
+      rhym.get_rhyme(search, params)
+    end
   end
-end
-
-desc 'Fetches word info from Rhymebrain.com'
-arg_name 'word'
-command :info do |c|
-  c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
-  c.default_value 'en'
-  c.arg_name 'lang'
-  c.flag [:lang]
-  c.desc '(optional) The number of results to return. If you do not include this parameter, RhymeBrain will choose how many words to show based on how many good sounding rhymes there are for the word.'
-  c.default_value nil
-  c.arg_name 'max'
-  c.flag [:max]
-  c.action do |global_options,options,args|
-    search = args[0]
-    lang = options[:lang]
-    max = options[:max]
-    params = {}
-    params[:lang] = lang
-    params[:max] = max
-    info = Lyracyst::Rhymebrain::Info.new
-    info.get_info(search, params)
+  rb.desc 'Fetches word info from Rhymebrain.com'
+  rb.arg_name 'info'
+  rb.command :inf do |info|
+    info.action do |global_options, options, args|
+      search = args[0]
+      params = { lang: options[:lang], max: options[:max] }
+      info = Lyracyst::Rhymebrain::Info.new
+      info.get_info(search, params)
+    end
+  end
+  rb.desc 'Fetches combined words (portmanteaus) from Rhymebrain.com'
+  rb.arg_name 'combine'
+  rb.command :comb do |combine|
+    combine.action do |global_options, options, args|
+      search = args[0]
+      params = { lang: options[:lang], max: options[:max] }
+      port = Lyracyst::Rhymebrain::Combine.new
+      port.get_port(search, params)
+    end
   end
 end
 
-desc 'Fetches combined words (portmanteaus) from Rhymebrain.com'
+desc 'Fetches definitions from Urban Dictionary'
 arg_name 'word'
-  command :combine do |c|
-  c.desc 'ISO639-1 language code (optional). Eg. en, de, es, fr, ru'
-  c.default_value 'en'
-  c.arg_name 'lang'
-  c.flag [:lang]
-  c.desc '(optional) The number of results to return. If you do not include this parameter, RhymeBrain will choose how many words to show based on how many good sounding rhymes there are for the word.'
-  c.default_value nil
-  c.arg_name 'max'
-  c.flag [:max]
-  c.action do |global_options,options,args|
+command :urb do |c|
+  c.action do |global_options, options, args|
     search = args[0]
-    lang = options[:lang]
-    max = options[:max]
-    params = {}
-    params[:lang] = lang
-    params[:max] = max
-    port = Lyracyst::Rhymebrain::Combine.new
-    port.get_port(search, params)
+    ur = Lyracyst::Urban::Define.new
+    ur.get_def(search)
   end
 end
 
-desc 'Fetches definitions from Urban Dictionary'
+desc 'Fetches word info from Onelook'
 arg_name 'word'
-command :urban do |c|
-  c.action do |global_options,options,args|
+command :look do |c|
+  c.switch :source, :default_value => false, :desc => 'Fetches resource links (verbose)'
+  c.action do |global_options, options, args|
     search = args[0]
-    ur = Lyracyst::Urban::Define.new
-    ur.get_def(search)
+    source = options[:source]
+    fe = Lyracyst::Onelook::Fetch.new
+    fe.fetch(search, source)
   end
 end
 
-pre do |global,command,options,args|
+pre do |global, command, options, args|
   # Pre logic here
   # Return true to proceed; false to abort and not call the
   # chosen command
@@ -335,30 +240,27 @@ pre do |global,command,options,args|
   json = global[:j]
   xml = global[:x]
   if http.class != Symbol then http = http.to_sym; end
-  Lyracyst.set_http(http)
+  Lyracyst.http(http)
   if json.class != Symbol then json = json.to_sym; end
-  Lyracyst.set_json(json)
+  Lyracyst.json(json)
   if xml.class != Symbol then xml = xml.to_sym; end
-  Lyracyst.set_xml(xml)
-  label = 'Global options'
-  Lyracyst.label(label)
-  print "➜#{global}➜"
-  label = 'Command'
-  Lyracyst.label(label)
-  print "➜#{command.name}➜"
-  label = 'Command options'
-  Lyracyst.label(label)
-  print "➜#{options}➜"
-  label = 'Args'
-  Lyracyst.label(label)
-  print "➜#{args}➜"
-  label =  'Bootstrapped'
-  Lyracyst.label(label)
-  puts ''
+  Lyracyst.xml(xml)
+  if global[:v]
+    Lyracyst.label('Global options')
+    print "#{global}"
+    Lyracyst.label('Command')
+    print "#{command.name}"
+    Lyracyst.label('Command options')
+    print "#{options}"
+    Lyracyst.label('Args')
+    print "#{args}"
+    Lyracyst.label('Bootstrapped')
+    puts ''
+  end
   true
 end
 
-post do |global,command,options,args|
+post do |global, command, options, args|
   # Post logic here
   # Use skips_post before a command to skip this
   # block on that command only
@@ -415,9 +317,10 @@ post do |global,command,options,args|
       puts Rainbow("Word search was written to #{outfile}.").bright
     end
   end
-  label = 'Shutdown'
-  Lyracyst.label(label)
-  puts ''
+  if global[:v]
+    Lyracyst.label('Shutdown')
+    puts ''
+  end
 end
 
 on_error do |exception|