conjugatefr 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1ad90db94e0593104ac13b95934ca3dad75baad
-  data.tar.gz: 4dee619f6237b8c630ae0842453edb700e5caa1c
+  metadata.gz: 87362c4221617c2625e90c78bda16876536213a7
+  data.tar.gz: 83c504e5139117a9ca1a7ca5c5ae7676ad4c14a6
 SHA512:
-  metadata.gz: f5244c013d501d89cd5e2f94266d795b5188c7b361d361adb80cbf8951e6709faf32c33fb8e519c12a2d7989060b20d4529c87725f0ea76760fdd7fb0eca364a
-  data.tar.gz: 55b6a637272e69fde927807252fe9d45213f094209f2dffe4e057a7c6931bc5b8dc31b5562847883392b2124fe6189af0c1c13a9b118bb1f8bff281afbb7d3de
+  metadata.gz: 271d9ea391997af2de123c736747babea7df9fbee0363bc7724ca2ead3a54fccd98d591517b359e25889c1efa22cf49a8748f7f8c51a2d19c8dd11f37afd6162
+  data.tar.gz: e6f2145bbcf1b1adb7064c769b576241f618efeab29298fa7d41c9c79e7b47bee07436cff142aca902bad4f2dc421fbcc6a5fa4d426efc75c5db71bf21f9c2ee

data/bin/conjugatefr

@@ -10,12 +10,10 @@ options = {
   "renderer" => "Human",
 }
 
-cfr = ConjugateFR.new
-
 OptionParser.new do |opts|
   opts.banner = "Usage: #{$0} [options] [verbs]"
   opts.program_name = "ConjugateFR"
-  opts.version = "1.0.0"
+  opts.version = "1.0.1"
   opts.on "-R", "--require PATH", "Require PATH before running." do |path|
     require path
   end
@@ -51,5 +49,4 @@ unless renderer
   exit -1
 end
 
-cfr.setRenderer renderer
-cfr.go ARGV
+conjugateFR ARGV, renderer

data/lib/conjugatefr.rb

@@ -2,71 +2,77 @@ require 'open-uri'
 require 'nokogiri'
 require 'conjugatefr/renderers'
 
-class ConjugateFR
-  def setRenderer (renderer)
-    @renderer = renderer
-  end
-  def go (query)
-    # cpwords - Copy/Pasted words list from the website.
-    cpwords = "accroître	acheter	acquérir	acquiescer
-    alléger	aller	apercevoir	appeler
-    apprendre	arguer	arrêter	asseoir
-    astreindre	avoir	battre	boire
-    bouillir	briller	céder	changer
-    chanter	circoncire	commencer	compléter
-    conclure	conduire	confire	confondre
-    connaître	construire	coudre	courir
-    craindre	créer	croire	croître
-    cueillir	défaillir	déléguer	dépecer
-    devoir	dire	disséquer	dissoudre
-    distinguer	distraire	dormir	écrire
-    employer	ennuyer	enseigner	entendre
-    envoyer	espérer	essayer	essuyer
-    être	faire	falloir	finir
-    fuir	geler	grasseyer	interdire
-    interpeller	jeter	joindre	lancer
-    lever	lire	louer	luire
-    manger	marquer	maudire	mener
-    mentir	mettre	mordre	moudre
-    mouiller	mourir	mouvoir	naître
-    naviguer	nettoyer	nuire	offrir
-    oublier	ouvrir	pallier	paraître
-    partir	payer	peindre	peler
-    perdre	peser	plaire	pleuvoir
-    pourvoir	pouvoir	prendre	prévoir
-    prier	promouvoir	rapiécer	recevoir
-    régner	remuer	répandre	répondre
-    résoudre	réveiller	rire	rompre
-    savoir	semer	sentir	servir
-    signer	sortir	souffrir	suffire
-    suivre	surseoir	taire	tenir
-    tomber	tordre	traire	travailler
-    tressaillir	vaincre	valoir	vendre
-    venir	vêtir	vivre	voir
-    vouloir"
+# Conjugates French Verbs
+# @param query [Array] The query list. Can be null, in which presets are used.
+# @param renderer [Renderer] The Renderer to use.
+def conjugateFR (query, renderer)
+  # cpwords - Copy/Pasted words list from the website.
+  cpwords = "accroître	acheter	acquérir	acquiescer
+  alléger	aller	apercevoir	appeler
+  apprendre	arguer	arrêter	asseoir
+  astreindre	avoir	battre	boire
+  bouillir	briller	céder	changer
+  chanter	circoncire	commencer	compléter
+  conclure	conduire	confire	confondre
+  connaître	construire	coudre	courir
+  craindre	créer	croire	croître
+  cueillir	défaillir	déléguer	dépecer
+  devoir	dire	disséquer	dissoudre
+  distinguer	distraire	dormir	écrire
+  employer	ennuyer	enseigner	entendre
+  envoyer	espérer	essayer	essuyer
+  être	faire	falloir	finir
+  fuir	geler	grasseyer	interdire
+  interpeller	jeter	joindre	lancer
+  lever	lire	louer	luire
+  manger	marquer	maudire	mener
+  mentir	mettre	mordre	moudre
+  mouiller	mourir	mouvoir	naître
+  naviguer	nettoyer	nuire	offrir
+  oublier	ouvrir	pallier	paraître
+  partir	payer	peindre	peler
+  perdre	peser	plaire	pleuvoir
+  pourvoir	pouvoir	prendre	prévoir
+  prier	promouvoir	rapiécer	recevoir
+  régner	remuer	répandre	répondre
+  résoudre	réveiller	rire	rompre
+  savoir	semer	sentir	servir
+  signer	sortir	souffrir	suffire
+  suivre	surseoir	taire	tenir
+  tomber	tordre	traire	travailler
+  tressaillir	vaincre	valoir	vendre
+  venir	vêtir	vivre	voir
+  vouloir"
 
-    # Generate word arrays from above list.
-    words = cpwords.gsub(/[ \t\n]+/, " ").split " "
+  # Generate word arrays from above list.
+  words = cpwords.gsub(/[ \t\n]+/, " ").split " "
 
-    toqry = if query.empty?
-      words
-    else
-      query
-    end
+  # Fall back to presets
+  toqry = if query.empty?
+    words
+  else
+    query
+  end
 
-    toqry_filtered = toqry.map { |word| word.gsub(/[êé]/, "e").gsub /î/, "i" }
+  # Filter out all of the accented words.
+  toqry_filtered = toqry.map { |word| word.gsub(/[êé]/, "e").gsub /î/, "i" }
 
-    @renderer.pre
+  # Render pre-word content.
+  renderer.pre
 
-    toqry_filtered.each_with_index do |word, index|
-      open "http://conjf.cactus2000.de/showverb.en.php?verb=#{word}" do |page|
-        doc = Nokogiri::HTML page
-        arr = doc.css("td [width='50%']").css("div").to_s.gsub(/.*?<div>/im, "").split("<br>")
-        arr.pop
-        @renderer.word toqry[index], arr
-      end
-    end
+  # Query each word.
+  toqry_filtered.each_with_index do |word, index|
+    open "http://conjf.cactus2000.de/showverb.en.php?verb=#{word}" do |page|
+      # Split the conjugations into an array.
+      doc = Nokogiri::HTML page
+      arr = doc.css("td [width='50%']").css("div").to_s.gsub(/.*?<div>/im, "").split("<br>")
+      arr.pop
 
-    @renderer.post
+      # Render this word.
+      renderer.word toqry[index], arr
+    end
   end
+
+  # Render post-word content.
+  renderer.post
 end

data/lib/conjugatefr/renderers.rb

@@ -1,13 +1,29 @@
 # Ruby ConjugateFR Renderers - Part of Ruby ConjugateFR.
 # I, htmlguy, hereby release this work into the public domain.
 
+# Renders conjugated french verbs.
+# (see conjugateFR)
 class Renderer
+  # Prints content to go before the conjugations.
   def pre; end
+  # Prints a verb and it's conjugations.
+  # @param name [String] The verb.
+  # @param words [Array] An array of conjugations.
   def word (name, words); end
+  # Prints content to go after the conjugations.
   def post; end
+  # The description of this renderer.
+  # For example: +Renders in the example format.+
+  # @return [String] the description.
   def description; ""; end
 end
 
+# A renderer in a human-readable format.
+# Output looks like:
+#   == someverb ==
+#  someconjugation
+#  someconjugation
+#  etc...
 class HumanRenderer < Renderer
   def word (name, words)
     puts "\n == #{name} == "
@@ -18,6 +34,9 @@ class HumanRenderer < Renderer
   def description; "Renders in a nice, human-readable format."; end
 end
 
+# A renderer template for rendering in a delimitered table format.
+# (see CSVRenderer)
+# (see TSVRenderer)
 class DelimitedTableRenderer < Renderer
   def initialize; @s = ""; end
   def pre
@@ -32,16 +51,29 @@ class DelimitedTableRenderer < Renderer
   end
 end
 
+# A renderer in the comma-separated value format.
+# Output looks like:
+#  Word,Je,Tu,Il/Elle/On,Nous,Vous,Ils/Elles
+#  someverb,conj1,conj2,conj3,conj4,conj5,conj6
 class CSVRenderer < DelimitedTableRenderer
   def initialize; @s = ","; end
   def description; "Renders in the Comma Separated Value (CSV) format."; end
 end
 
+# A renderer in the tab-separated value format.
+# Output looks like (w/ 4-space tab):
+#  Word    Je  Tu  Il/Elle/On  Nous    Vous    Ils/Elles
+#  someverb    conj1   conj2   conj3   conj4   conj5   conj6
 class TSVRenderer < DelimitedTableRenderer
   def initialize; @s = "\t"; end
   def description; "Renders in the Tab Separated Value (TSV) format."; end
 end
 
+# A renderer in the markdown table syntax.
+# Output looks like:
+#  |Word|Je|Tu|Il/Elle/On|Nous|Vous|Ils/Elles
+#  |---|---|---|---|---|---|---
+#  |someverb|conj1|conj2|conj3|conj4|conj5|conj6
 class MDTableRenderer < Renderer
   def pre
     puts "|Word|Je|Tu|Il/Elle/On|Nous|Vous|Ils/Elles"
@@ -57,6 +89,7 @@ class MDTableRenderer < Renderer
   def description; "Renders in Markdown's table syntax."; end
 end
 
+# Renders verbs in the form of a count of how many there are.
 class CounterRenderer < Renderer
   def initialize; @count = 0; end
   def word (name, words)
@@ -68,6 +101,9 @@ class CounterRenderer < Renderer
   def description; "Renders out a count of how many words are listed."; end
 end
 
+# A global list of renderers, with each one assigned to it's human-readable
+# name.
+# Used for programs like the CLI.
 $renderers = {
   "Human" => HumanRenderer.new,
   "CSV" => CSVRenderer.new,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: conjugatefr
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - htmlguy
@@ -10,7 +10,23 @@ bindir: bin
 cert_chain: []
 date: 2015-09-16 00:00:00.000000000 Z
 dependencies: []
-description: A simple program to conjugate french verbs.
+description: "\n  A simple program and library to conjugate french verbs.\n  Parses
+  responses to requests to an online reference site.\n\n  == Executable\n  ConjugateFR
+  comes with the executable binary +conjugatefr+.\n  To view information about it's
+  supported arguments, run\n   conjugatefr --help\n\n  == Custom Renderers\n  To make
+  a custom renderer, just type\n   require conjugatefr/renderer\n  and then make a
+  class that extends +Renderer+.\n  An example is as follows:\n\n    require 'conjugatefr/renderer'\n
+  \   class ExampleRenderer < Renderer\n      def pre\n        puts \"This goes before
+  the words.\"\n      end\n      def word (name, words)\n        print \"#{name}:\"\n
+  \       words.each do |word|\n          print \" #{word}\"\n        end\n      end\n
+  \     def post\n        puts \"This goes after the words.\"\n      end\n      def
+  description; \"Renders an example format.\"; end\n    end\n    # Add to the Renderers
+  list (For CLI and other programs that use it.)\n    $renderers[\"Example\"] = ExampleRenderer.new\n
+  \ To try this out, save it as +erend.rb+ and then run:\n    conjugatefr -R ./erend.rb
+  -r Example\n  It will produce the output:\n    This goes before the words.\n    someword:
+  someconjugation etc etc\n    ... (more words will be here)\n    This goes after
+  the words.\n\n  == The Library\n  The library can be included with +require conjugatefr+.
+  It includes the\n  +ConjugateFR+ class.\n  "
 email: htmlguy@pdum.xyz
 executables:
 - conjugatefr