dict 0.2.3 → 0.2.4

data/README.md

@@ -1,2 +1,13 @@
 # dict [![Build Status](https://secure.travis-ci.org/Ragnarson/dict-gem.png?branch=master)](http://travis-ci.org/Ragnarson/dict-gem)
 CLI and backend for dict - an open source dictionary aggregator.
+
+## Usage ##
+To search for `WORD`:
+
+    dict WORD [OPTIONS]
+
+### Available options ###
+
+  - `-h` or `--help` - displays help message
+  - `-t` or `--time` - used to set timeout in seconds. Default value: 300
+  - `-d` or `--dict` - used to select desired dictionary

data/lib/dict/version.rb

@@ -1,3 +1,3 @@
 module Dict
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/lib/dict/wiktionary.rb

@@ -7,17 +7,10 @@ WIKI_URL = 'http://en.wiktionary.org/wiki/'
 
 module Dict
   class Wiktionary < Dictionary
-    # Return a Dict::Result object
+  
+    # Returns an Dict::Result object
 	  def translate
-      url_pl = "http://en.wiktionary.org/w/index.php?title=#{@word}&action=edit"
-      url_en = "http://pl.wiktionary.org/w/index.php?title=#{@word}&action=edit"
-      
-      content = get_html(url_pl).css('textarea#wpTextbox1').first
-      if polish?(get_html(url_pl).css('textarea#wpTextbox1').first)
-        get_translations(get_html(url_pl).css('textarea#wpTextbox1').first)
-      else
-        get_translations(get_html(url_en).css('textarea#wpTextbox1').first.content, false)
-      end
+      translations.each { |item| @result.add_translation(@result.term, item) }
       
       @result
     end 
@@ -30,33 +23,43 @@ module Dict
     
     private
     def polish?(content)
-       return true if /==Polish==/i.match(content)
-       false
+      ! /==Polish==/i.match(content).nil?
     end
 
-    def get_translations(content, polish = true)
-      if polish
-        translations = /Noun[^\{]+\{\{(?:head\|pl|pl\-noun)[^#]+#\s*\[\[([^\n]+)/.match(content)
-        translations = (translations && translations[1].gsub(/\[|\]/,'').split(', ')) || []
-        translations.each { |item| @result.add_translation(@result.term, item) }
+    # Returns an array containing translations.
+    def translations
+      url_pl = "http://en.wiktionary.org/w/index.php?title=#{@word}&action=edit"
+      url_en = "http://pl.wiktionary.org/w/index.php?title=#{@word}&action=edit"
+      
+      content_pl = get_html(url_pl).css('textarea#wpTextbox1').first
+      if polish?(content_pl)
+        extract_polish_translations(content_pl)
       else
-        translations_block = /angielski(?:.|\n)+\{\{znaczenia\}\}(.|\n)+(?:\{\{odmiana){1,}/.match(content)
-        return unless translations_block.instance_of?(MatchData)
-        translations_block = translations_block[0].gsub(/odmiana(.|\n)+$/,'')
-        translations = translations_block.scan(/:\s*\(\d\.?\d?\)\s*([^\n]+)/)
-        translations.map! do |translation|
-          translation[0].gsub(/\[|\]|\{\{[^\}]+\}\}|'/,'').strip
-        end
-        translations.delete_if do |item|
-          item.empty?
-        end
-        translations ||= []
-        translations.each { |item| @result.add_translation(@result.term, item) }
+        extract_english_translations(get_html(url_en).css('textarea#wpTextbox1').first.content)
       end
     end
     
-    def get_examples(content, polish = true)
-      # todo
+    # Returns an array containing polish translations.
+    def extract_polish_translations(content)
+      translations = /Noun[^\{]+\{\{(?:head\|pl|pl\-noun)[^#]+#\s*\[\[([^\n]+)/.match(content)
+      translations = (translations && translations[1].gsub(/\[|\]/,'').split(', ')) || []
+    end
+    
+    # Returns an array containing english translations.
+    def extract_english_translations(content)
+      translations_block = /język\s+angielski(?:.|\n)+\{\{znaczenia\}\}(.|\n)+(?:\{\{odmiana){1,}/.match(content)
+      return [] unless translations_block.instance_of?(MatchData)
+      translations_block = translations_block[0].gsub(/odmiana(.|\n)+$/,'')
+      translations = translations_block.scan(/:\s*\(\d\.?\d?\)\s*([^\n]+)/)
+      translations.map! do |translation|
+        translation[0].gsub(/\[|\]|\{\{[^\}]+\}\}|'|<.*/,'').strip
+      end
+      translations.delete_if(&:empty?)
+      translations ||= []
+    end
+    
+    def get_examples(content)
+      
     end
   end
 end

data/spec/dict/lib_dict_cli_runner_spec.rb

@@ -1,4 +1,6 @@
 # -*- coding: utf-8 -*
+
+require_relative './vcr_setup'
 require 'dict/cli/runner'
 
 describe "parameters_valid?" do
@@ -34,17 +36,21 @@ end
 
 describe "get_translations" do
   it "should return results from wiktionary and dictpl for word 'słowik'" do
-    stub_const("ARGV", ["słowik"])
-    runner = Dict::CLI::Runner.new
-    opts = runner.parse_parameters
-    runner.get_translations(opts, "słowik").should == {"wiktionary"=>{"słowik"=>["nightingale"]}, "dictpl"=>{"słowik"=>["nightingale"], "słowik białobrewy; Luscinia indicus; Tarsiger indicus (gatunek ptaka)"=>["white-browed bush-robin"], "słowik białosterny; Luscinia pectoralis (gatunek ptaka)"=>["Himalayan rubythroat", "white-tailed rubythroat"], "słowik chiński; pekińczyk żółty; Leiothrix lutea"=>["Pekin robin", "red-billed leiothrix"], "słowik chiński; pekińczyk żółty; pekińczyk koralodzioby; Leiothrix lutea"=>["Peking robin"], "słowik czarnogardły; Luscinia obscura"=>["black-throated blue robin"], "słowik himalajski; Luscinia brunnea (gatunek ptaka)"=>["Indian blue chat", "Indian blue robin"], "słowik modry; Luscinia cyane"=>["Siberian blue robin"], "słowik obrożny; Luscinia johnstoniae; Tarsiger johnstoniae (gatunek ptaka)"=>["collared bush-robin"]}}
+    VCR.use_cassette('translations_slownik_cassette') do      
+      stub_const("ARGV", ["słowik"])
+      runner = Dict::CLI::Runner.new
+      opts = runner.parse_parameters
+      runner.get_translations(opts, "słowik").should == {"wiktionary"=>{"słowik"=>["nightingale"]}, "dictpl"=>{"słowik"=>["nightingale"], "słowik białobrewy; Luscinia indicus; Tarsiger indicus (gatunek ptaka)"=>["white-browed bush-robin"], "słowik białosterny; Luscinia pectoralis (gatunek ptaka)"=>["Himalayan rubythroat", "white-tailed rubythroat"], "słowik chiński; pekińczyk żółty; Leiothrix lutea"=>["Pekin robin", "red-billed leiothrix"], "słowik chiński; pekińczyk żółty; pekińczyk koralodzioby; Leiothrix lutea"=>["Peking robin"], "słowik czarnogardły; Luscinia obscura"=>["black-throated blue robin"], "słowik himalajski; Luscinia brunnea (gatunek ptaka)"=>["Indian blue chat", "Indian blue robin"], "słowik modry; Luscinia cyane"=>["Siberian blue robin"], "słowik obrożny; Luscinia johnstoniae; Tarsiger johnstoniae (gatunek ptaka)"=>["collared bush-robin"]}}
+    end 
   end
 
   it "should return results from selected dictionary for word 'słowik'" do
-    stub_const("ARGV", ["słowik", "-d", "dictpl"])
-    runner = Dict::CLI::Runner.new
-    opts = runner.parse_parameters
-    runner.get_translations(opts, "słowik").should == {"słowik"=>["nightingale"], "słowik białobrewy; Luscinia indicus; Tarsiger indicus (gatunek ptaka)"=>["white-browed bush-robin"], "słowik białosterny; Luscinia pectoralis (gatunek ptaka)"=>["Himalayan rubythroat", "white-tailed rubythroat"], "słowik chiński; pekińczyk żółty; Leiothrix lutea"=>["Pekin robin", "red-billed leiothrix"], "słowik chiński; pekińczyk żółty; pekińczyk koralodzioby; Leiothrix lutea"=>["Peking robin"], "słowik czarnogardły; Luscinia obscura"=>["black-throated blue robin"], "słowik himalajski; Luscinia brunnea (gatunek ptaka)"=>["Indian blue chat", "Indian blue robin"], "słowik modry; Luscinia cyane"=>["Siberian blue robin"], "słowik obrożny; Luscinia johnstoniae; Tarsiger johnstoniae (gatunek ptaka)"=>["collared bush-robin"]}
+    VCR.use_cassette('translations_slownik_cassette') do      
+      stub_const("ARGV", ["słowik", "-d", "dictpl"])
+      runner = Dict::CLI::Runner.new
+      opts = runner.parse_parameters
+      runner.get_translations(opts, "słowik").should == {"słowik"=>["nightingale"], "słowik białobrewy; Luscinia indicus; Tarsiger indicus (gatunek ptaka)"=>["white-browed bush-robin"], "słowik białosterny; Luscinia pectoralis (gatunek ptaka)"=>["Himalayan rubythroat", "white-tailed rubythroat"], "słowik chiński; pekińczyk żółty; Leiothrix lutea"=>["Pekin robin", "red-billed leiothrix"], "słowik chiński; pekińczyk żółty; pekińczyk koralodzioby; Leiothrix lutea"=>["Peking robin"], "słowik czarnogardły; Luscinia obscura"=>["black-throated blue robin"], "słowik himalajski; Luscinia brunnea (gatunek ptaka)"=>["Indian blue chat", "Indian blue robin"], "słowik modry; Luscinia cyane"=>["Siberian blue robin"], "słowik obrożny; Luscinia johnstoniae; Tarsiger johnstoniae (gatunek ptaka)"=>["collared bush-robin"]}
+    end 
   end
 
   it "should return timeout message for word słowik and -t 5" do

data/spec/dict/lib_dict_spec.rb

@@ -12,10 +12,25 @@ describe Dict do
 
   it "should return array of available services, which contains wiktionary and dictpl" do        
     Dict.available_dictionaries.should == ['wiktionary', 'dictpl']
-  end
-  
+  end  
  
-  
+  it "should return hash with translations from all dictionaries" do       
+    wiktionary = stub(:translate => stub(:translations => {'WORD' => 'WIKTIONARY_RESULTS'}))
+    Dict::Wiktionary.should_receive(:new).with('WORD').and_return(wiktionary)    
+    
+    dictpl = stub(:translate =>{'WORD' => 'DICTPL_RESULTS'})
+    Dict::Dictpl.should_receive(:new).with('WORD').and_return(dictpl)
+       
+    results = Dict::get_all_dictionaries_translations('WORD')
+    results.should == {'dictpl' => {'WORD' => 'DICTPL_RESULTS'}, 'wiktionary' => {'WORD' => 'WIKTIONARY_RESULTS'}}    
+  end
+
+  it "should return whatever Wiktionary returns embedded in a hash" do
+    wiktionary = stub(:translate => stub( :translations => 'WIKTIONARY_RESULTS'))
+    Dict::Wiktionary.should_receive(:new).with('WORD').and_return(wiktionary)
+    Dict.get_single_dictionary_translations('WORD', 'wiktionary').should == 'WIKTIONARY_RESULTS'
+  end
+
   it "should return whatever Dictpl returns embedded in a hash" do
     dictpl = stub(:translate => 'DICTPL_RESULTS')
     Dict::Dictpl.should_receive(:new).with('WORD').and_return(dictpl)

data/spec/dict/lib_dictpl_spec.rb

@@ -10,7 +10,7 @@ describe Dict::Dictpl do
   end
   
   it "should return array with translations for 'krowa'" do
-    VCR.use_cassette('translations_krowa_cassette') do
+    VCR.use_cassette('dictpl_translations_krowa_cassette') do
 	  d = Dict::Dictpl.new("krowa")
 	  d.translate
 	  d.translations.should be_a(Array)
@@ -19,7 +19,7 @@ describe Dict::Dictpl do
   end
   
   it "should return array with examples for 'krowa'" do
-    VCR.use_cassette('examples_krowa_cassette') do
+    VCR.use_cassette('dictpl_examples_krowa_cassette') do
 	  d = Dict::Dictpl.new("krowa")
 	  d.translate
       d.examples.should be_a(Array)
@@ -28,7 +28,7 @@ describe Dict::Dictpl do
   end
     
   it "should return array with translations for 'samochód'" do
-    VCR.use_cassette('translations_samochod_cassette') do
+    VCR.use_cassette('dictpl_samochod_cassette') do
       d = Dict::Dictpl.new('samochód')
       d.translate
       d.translations.should be_a(Array)
@@ -37,7 +37,7 @@ describe Dict::Dictpl do
   end
   
   it "should return array with examples for 'samochód'" do
-    VCR.use_cassette('examples_samochod_cassette') do
+    VCR.use_cassette('dictpl_samochod_cassette') do
       d = Dict::Dictpl.new('samochód')
       d.translate
       d.examples.should be_a(Array)
@@ -46,7 +46,7 @@ describe Dict::Dictpl do
   end
 
   it "should return a hash from array of paired values" do
-    VCR.use_cassette('paired_value_samochod_cassette') do
+    VCR.use_cassette('dictpl_samochod_cassette') do
       d = Dict::Dictpl.new('samochód')
       d.make_hash_results(d.translate).should be_a(Hash)
     end

data/spec/dict/lib_wiktionary_spec.rb

@@ -1,30 +1,43 @@
 # -*- encoding: utf-8 -*
 
+require_relative './vcr_setup'
 require 'dict/wiktionary'
 
 describe Dict::Wiktionary do
 
   it "should raise no given word exception" do
-    expect { Dict::Wiktionary.new }.to raise_error ArgumentError
+    expect { Dict::Wiktionary.new }.to raise_error ArgumentError    
   end
 
   it "should return an two element array of translations of word samochód containing [\"car\",\"automobile\"]" do
-    w = Dict::Wiktionary.new('samochód').translate
-    w.translations.should == {"samochód"=>["car", "automobile"]}
+    VCR.use_cassette('wiktionary_translations_samochod_cassette') do
+	  w = Dict::Wiktionary.new("samochód").translate
+	  w.translations.should ==  {"samochód"=>["car", "automobile"]}	  
+    end 
   end
 
   it "should return a hash with translations" do
-    w = Dict::Wiktionary.new('samochód').translate
-    w.translations.should be_a(Hash)
+    VCR.use_cassette('wiktionary_translations_samochod_cassette') do
+	  w = Dict::Wiktionary.new("samochód").translate
+	  w.translations.should be_a(Hash)
+    end 
   end
 
-  it "should return a Resut object" do
-    w = Dict::Wiktionary.new('samochód').translate
-    w.should be_a(Dict::Result)
+  it "should return a Result object" do
+    VCR.use_cassette('wiktionary_translations_samochod_cassette') do
+	  w = Dict::Wiktionary.new("samochód").translate
+	  w.should be_a(Dict::Result)
+    end 
   end
   
   it "should return translation from english to polish for word 'field'" do
-    result = Dict::Wiktionary.new('field').translate.translations
-    result.should eq({"field"=>["pole", "pole (magnetyczne, elektryczne, sił, itp.)", "pole (skalarne, wektorowe, itp.)", "ciało (liczb rzeczywistych, zespolonych, itp.)", "wystawić (drużynę)", "odpowiadać (na pytania)", "polowy", "polny"]})
+    VCR.use_cassette('wiktionary_translations_field_cassette') do
+	  w = Dict::Wiktionary.new("field").translate.translations
+	  w.should eq({"field"=>["pole", "pole (magnetyczne, elektryczne, sił, itp.)", "pole (skalarne, wektorowe, itp.)", "ciało (liczb rzeczywistych, zespolonych, itp.)", "wystawić (drużynę)", "odpowiadać (na pytania)", "polowy", "polny"]})
+    end 
+  end
+  
+  it "should remove html tags from translations of 'dragon' word" do
+    Dict::Wiktionary.new("dragon").translate.translations.should eq({'dragon' => ['smok']})
   end
 end