dict 0.2.1 → 0.2.2

data/Gemfile.lock

@@ -8,7 +8,13 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
+    activesupport (3.2.6)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
     diff-lcs (1.1.3)
+    fakeweb (1.3.0)
+    i18n (0.6.0)
+    multi_json (1.3.6)
     nokogiri (1.5.5)
     rake (0.9.2.2)
     rspec (2.11.0)
@@ -20,11 +26,15 @@ GEM
       diff-lcs (~> 1.1.3)
     rspec-mocks (2.11.1)
     slop (3.3.2)
+    vcr (2.2.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activesupport
   dict!
+  fakeweb
   rake
   rspec (~> 2.11)
+  vcr

data/bin/dict

@@ -3,7 +3,5 @@
 
 require 'dict/cli/runner'
 
-opts = Hash.new
-
 runner = Dict::CLI::Runner.new
-runner.run(opts)
+runner.run

data/dict.gemspec

@@ -6,6 +6,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'nokogiri', '~>1.5.5'
   s.add_development_dependency "rspec", "~> 2.11"
   s.add_development_dependency "rake"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "activesupport"
+  s.add_development_dependency "fakeweb"
 
   s.name = %q{dict}
   s.version = Dict::VERSION

data/lib/dict/cli/runner.rb

@@ -12,17 +12,15 @@ module Dict
       end
 
       def parse_parameters
-        available_dictionaries = Dict.available_services.join(', ')
-
         opts = Slop.parse! do
           banner <<-END
-    Usage: dict WORD [OPTIONS]
-    Search WORD in dict, an open source dictionary aggregator.
+Usage: dict WORD [OPTIONS]
+Search WORD in dict, an open source dictionary aggregator.
           END
 
           on '-h', :help, 'Display this help message'
           on '-t', :time=, 'Set timeout in seconds. Default: 300', :as => :int
-          on '-d', :dict=, "Select desired dictionary. Available options: #{available_dictionaries}"
+          on '-d', :dict=, "Select desired dictionary. Available options: #{Dict.available_dictionaries.join(', ')}"
         end
         opts
       end
@@ -39,15 +37,28 @@ module Dict
         "Timeout for the query."
       end
 
-      def run(opts)
+      def expected_argument_description(option)
+        case option
+        when "dict"
+          Dict.available_dictionaries.join(', ')
+        when "time"
+          "number of seconds"
+        else
+          "?"
+        end
+      end
+
+      def run
         begin
           opts = parse_parameters
-        rescue Slop::MissingArgumentError
-          abort("Missing argument")
+        rescue Slop::MissingArgumentError => e
+          incomplete_option = /(.*?) expects an argument/.match(e.to_s)[1]
+          description = expected_argument_description(incomplete_option)
+          abort("Missing argument. Expected: #{description}")
         end
 
         abort(opts.to_s) if opts.help?
-        parameters_valid? or abort("Please enter a word. (-h for help)")
+        abort("Please enter a word. (-h for help)") unless parameters_valid?
 
         puts get_translations(opts, ARGV[0])
       end

data/lib/dict/dict.rb

@@ -2,47 +2,50 @@
 
 require 'dict/wiktionary'
 require 'dict/dictpl'
-require 'json'
+require "yaml"
 
 module Dict
   class << self
+    # returns hash with structure as showed below
+    # { 'DICTIONARY_NAME' => { 'TRANSLATION' => ['EXAMPLE', ...], ... }, ... }
     def get_all_dictionaries_translations(word)
       dictionaries = Hash.new
 
-      available_services.each do |service|
-        dictionaries[service] = get_single_dictionary_translations(word, service)
+      available_dictionaries.each do |dictionary|
+        dictionaries[dictionary] = get_single_dictionary_translations(word, dictionary)
       end
       dictionaries
     end
 
+    # prints translations from all dictionaries
     def print_all_dictionaries_translations(word)
+      available_dictionaries.each do |dictionary|
+        print_single_dictionary_translations(word, dictionary)
+      end
     end
 
-    def get_single_dictionary_translations(word, service)
-      case service
+    # returns hash with structure as showed below
+    # { 'TRANSLATION' => ['EXAMPLE', ...], ... }
+    def get_single_dictionary_translations(word, dictionary)
+      case dictionary
       when 'wiktionary'
-        Wiktionary.new(word, WIKI_URL).translate
+        Wiktionary.new(word).translate
       when 'dictpl'
-        Dictpl.new(word, DICT_URL).translate
+        Dictpl.new(word).translate
       else Dictionary.message
       end
     rescue Dictionary::ConnectError
-      "Couldn't connect to the service."
-    end
-
-    def print_single_dictionary_translations(word, service)
-      obj = get_single_dictionary_translations(word, service)
-      hash = obj.translate
-      hash.each do |k, v|
-        puts "#{k} - #{v}"
-      end
+      "Couldn't connect to the dictionary."
     end
 
-    def to_json(hash)
-      hash.to_json
+    # prints translations from single dictionary
+    def print_single_dictionary_translations(word, dictionary)
+      puts "Word '#{word.upcase}' translations from #{dictionary.upcase} dictionary."
+      puts get_single_dictionary_translations(word, dictionary).to_yaml
     end
 
-    def available_services
+    # returns array of currently available dictionaries
+    def available_dictionaries
       ['wiktionary', 'dictpl']
     end
   end

data/lib/dict/dictionary.rb

@@ -5,13 +5,16 @@ require 'open-uri'
 module Dict
   class Dictionary
     attr_accessor :translations, :examples
-    def initialize(word, url)
+
+    def initialize(word)
       check_arguments(word)
       @translations = []
       @examples = []
-      @uri = URI(URI.escape(url + word.downcase.tr(' ', '_')))
+      @word = word
     end
 
+    # returns hash with structure as showed below
+    # { 'TRANSLATION' => ['EXAMPLE', ...], ... }
     def make_hash_results(arr)
       hash = arr.each_slice(2).inject({}) do |h, (key, value)|
         if h.has_key?(key)
@@ -23,7 +26,13 @@ module Dict
       @translations, @examples = hash.keys, hash.values
       hash
     end
+    
+    # returns an instance of URI::HTTP class
+    def uri(url, word = nil)
+      word == nil ? URI(URI.escape(url)) : URI(URI.escape(url + word.downcase.tr(' ', '_')))
+    end
 
+    # checks if word was given correctly
     def check_arguments(word)
       raise ArgumentError.new("No given word") if word.empty?
     end
@@ -34,6 +43,7 @@ module Dict
 
     class ConnectError < Exception
       attr_reader :original
+
       def initialize(original = $!)
         @original = original
       end

data/lib/dict/dictpl.rb

@@ -7,10 +7,11 @@ DICT_URL = 'http://dict.pl/dict?word='
 
 module Dict
   class Dictpl < Dictionary
-    # Method returns hash with translations as keys and examples of using words as values
+    # returns hash with structure as showed below
+    # { 'TRANSLATION' => ['EXAMPLE', ...], ... }
     def translate
       context_words = []
-      Nokogiri::HTML(open(@uri)).xpath('//td[@class="resWordCol"]/a').each do |node|
+      Nokogiri::HTML(open(uri(DICT_URL, @word))).xpath('//td[@class="resWordCol"]/a').each do |node|
         context_words << node.text
       end
       make_hash_results(context_words)

data/lib/dict/version.rb

@@ -1,3 +1,3 @@
 module Dict
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/dict/wiktionary.rb

@@ -7,12 +7,12 @@ WIKI_URL = 'http://en.wiktionary.org/wiki/'
 
 module Dict
   class Wiktionary < Dictionary
-    # Method returns hash with translations as keys and examples of using words as values
+    # returns hash with structure as showed below
+    # { 'TRANSLATION' => ['EXAMPLE', ...], ... }
     def translate
       context_words = []
-      url = 'http://en.wiktionary.org/wiki/'
-      get_html(@uri).css('p + ol li a').each do |node|
-        get_html(url + node.text.tr(' ', '_')).css('p + ol > li dl dd').each do |example|
+      get_html(uri(WIKI_URL, @word)).css('p + ol li a').each do |node|
+        get_html(uri(WIKI_URL, node.text)).css('p + ol > li dl dd').each do |example|
           context_words << node.text << example.text
         end
       end

data/spec/dict/lib_dict_cli_runner_spec.rb

@@ -0,0 +1,92 @@
+# -*- coding: utf-8 -*
+require 'dict/cli/runner'
+
+describe "parameters_valid?" do
+  it "should return false if ARGV is empty" do
+    stub_const("ARGV", [])
+    runner = Dict::CLI::Runner.new
+    runner.parameters_valid?.should == false
+  end
+
+  it "should return true if ARGV is not empty" do
+    stub_const("ARGV", ["słowik", "-t", "36", "-d"])
+    runner = Dict::CLI::Runner.new
+    runner.parameters_valid?.should == true
+  end
+end
+
+describe "parse_parameters" do
+  it "should return Hash for parameters słowik -t 36" do
+    stub_const("ARGV", ["słowik", "-t", "36"])
+    runner = Dict::CLI::Runner.new
+    opts = runner.parse_parameters
+    {:help=>nil, :time=>"36", :dict=>nil}.should == opts.to_hash
+  end
+
+  it "should return Hash for parameters słowik" do
+    stub_const("ARGV", ["słowik"])
+    runner = Dict::CLI::Runner.new
+    opts = runner.parse_parameters
+    {:help=>nil, :time=>nil, :dict=>nil}.should == opts.to_hash
+  end
+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"=>{}, "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
+
+  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"]}
+  end
+
+  it "should return timeout message for word słowik and -t 5" do
+    stub_const("ARGV", ["słowik","-t","5"])
+    runner = Dict::CLI::Runner.new
+    opts = runner.parse_parameters
+    Dict.should_receive(:get_all_dictionaries_translations).
+      and_return { sleep 20 }
+    runner.get_translations(opts, "słowik").should == "Timeout for the query."
+  end
+end
+
+describe "CLI::Runner" do
+  HELP_MSG = "Usage: dict WORD [OPTIONS]\nSearch WORD in dict, an open source dictionary aggregator.\n\n    -h, --help      Display this help message\n    -t, --time      Set timeout in seconds. Default: 300\n    -d, --dict      Select desired dictionary. Available options: wiktionary, dictpl"
+  DICT_MSG = "Missing argument. Expected: wiktionary, dictpl"
+  TIME_MSG = "Missing argument. Expected: number of seconds"
+
+  it "should call abort when program is called with -h" do
+    stub_const("ARGV",["-h"])
+    opts = Slop.new
+    runner = Dict::CLI::Runner.new
+    runner.should_receive(:abort).with(HELP_MSG).and_raise(SystemExit)
+    expect {
+      runner.run
+    }.to raise_error(SystemExit)
+  end
+
+  it "should try to display meaningful information when -d option arguments are missing" do
+    stub_const("ARGV",["-d"])
+    runner = Dict::CLI::Runner.new
+    runner.should_receive(:abort).with(DICT_MSG).and_raise(SystemExit)
+    expect {
+      runner.run
+    }.to raise_error(SystemExit)
+  end
+
+  it "should try to display meaningful information when -t option arguments are missing" do
+    stub_const("ARGV",["-t"])
+    runner = Dict::CLI::Runner.new
+    runner.should_receive(:abort).with(TIME_MSG).and_raise(SystemExit)
+    expect {
+      runner.run
+    }.to raise_error(SystemExit)
+  end
+end

data/spec/dict/lib_dict_spec.rb

@@ -14,8 +14,14 @@ describe Dict do
     Dict.get_all_dictionaries_translations('samochód').should be_a(Hash)
   end
 
-  it "should return array of available services" do
-    Dict.available_services.should be_a(Array)
+  it "should return array of available services which is not empty" do
+    arr = Dict.available_dictionaries
+		arr.should be_a(Array)
+		arr.size.should_not == 0
   end
 
+	it "should return array of available services which contains wiktionary and dictpl" do
+		Dict.available_dictionaries.should == ['wiktionary', 'dictpl']
+	end
+
 end

data/spec/dict/lib_dictpl_spec.rb

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*
 
+require_relative './vcr_setup'
 require 'dict/dictpl'
 
 describe Dict::Dictpl do
@@ -7,27 +8,48 @@ describe Dict::Dictpl do
   it "should raise no given word exception" do
     expect { Dict::Dictpl.new }.to raise_error ArgumentError
   end
-
-  it "should return hash for given word: 'samochód'" do
-    result = Dict::Dictpl.new('samochód', DICT_URL).translate
-    result.should be_a(Hash)
+  
+  it "should return array with translations for 'krowa'" do
+    VCR.use_cassette('translations_krowa_cassette') do
+	  d = Dict::Dictpl.new("krowa")
+	  d.translate
+	  d.translations.should be_a(Array)
+	  d.translations.should == ["krowa", "krowa bliska wycielenia", "krowa mleczna", "krowa morska; Hydrodamalis gigas", "krowa morska; krowa morska Stellera; Hydrodamalis gigas (wymarły ssak morski)", "krowa nie zapłodniona", "krowa po pierwszym ocieleniu się", "krowa wysokomleczna", "cielna krowa", "dojna krowa", "mleczna krowa", "wata cukrowa", "mąka cukrowa", "święta krowa", "trzcina cukrowa", "lukier; polewa lukrowa", "święta krowa [przen]"]
+    end    
   end
-
-  it "should return array with translations" do
-    d = Dict::Dictpl.new('samochód', DICT_URL)
-    d.translate
-    d.translations.should be_a(Array)
+  
+  it "should return array with examples for 'krowa'" do
+    VCR.use_cassette('examples_krowa_cassette') do
+	  d = Dict::Dictpl.new("krowa")
+	  d.translate
+      d.examples.should be_a(Array)
+      d.examples.should == [["cow"], ["freshen of cow"], ["milker", "milcher", "milk cow", "dairy cow", "milch cow"], ["Steller's sea cow"], ["Steller's sea cow"], ["barren cow"], ["cow heifer"], ["deep milking cow"], ["springer"], ["milch-cow"], ["milk cow"], ["candyfloss", "candy floss", "candy-floss", "cotton candy"], ["false grain"], ["sacred moose"], ["sugarcane"], ["icing"], ["sacred cow"]]    
+    end    
   end
-
-  it "should return array with examples of translated words" do
-    d = Dict::Dictpl.new('samochód', DICT_URL)
-    d.translate
-    d.examples.should be_a(Array)
+    
+  it "should return array with translations for 'samochód'" do
+    VCR.use_cassette('translations_samochod_cassette') do
+      d = Dict::Dictpl.new('samochód')
+      d.translate
+      d.translations.should be_a(Array)
+      d.translations.should == ["samochód", "samochód ciężarowy", "samochód ciężarowy; samochód skrzyniowy", "samochód cysterna (rodzaj pojazdu)", "samochód do przewozu wojska [wojsk]", "samochód dostawczy", "samochód dwudrzwiowy", "docierać samochód", "kasować samochód", "pojazd; samochód", "duży i tani samochód", "wypożyczony samochód", "uruchomić samochód", "krążownik szos; duży amerykański samochód", "zapalać samochód (zwłaszcza na pych)", "kabriolet; samochód bez dachu", "uruchomić samochód bez uzycia kluczyków (zwłaszcza, aby go ukraść)", "ciężarówka; samochód ciężarowy"]
+    end
+  end
+  
+  it "should return array with examples for 'samochód'" do
+    VCR.use_cassette('examples_samochod_cassette') do
+      d = Dict::Dictpl.new('samochód')
+      d.translate
+      d.examples.should be_a(Array)
+      d.examples.should ==  [["car", "autocar", "automobile"], ["lorry"], ["truck"], ["gas tanker", "petrol tanker", "gasoline tanker"], ["troop-carrying vehicle"], ["van", "cargo plane"], ["two-door car"], ["break in"], ["write off"], ["automobile"], ["flivver"], ["u-drive"], ["put the car in gear"], ["yank-tank"], ["bump-start", "push-start"], ["no-top"], ["hot-wire"], ["lorry"]]
+    end
   end
 
   it "should return a hash from array of paired values" do
-    d = Dict::Dictpl.new('samochód', DICT_URL)
-    d.make_hash_results(d.translate).should be_a(Hash)
+    VCR.use_cassette('paired_value_samochod_cassette') do
+      d = Dict::Dictpl.new('samochód')
+      d.make_hash_results(d.translate).should be_a(Hash)
+    end
   end
-
+  
 end

data/spec/dict/lib_wiktionary_spec.rb

@@ -9,25 +9,25 @@ describe Dict::Wiktionary do
   end
 
   it "should return an two element array of translations of word samochód containing [\"car\",\"automobile\"]" do
-    w = Dict::Wiktionary.new('samochód', WIKI_URL)
+    w = Dict::Wiktionary.new('samochód')
     w.translate
     w.translations.should == ["car", "automobile"]
   end
 
   it "should return array with translations" do
-    w = Dict::Wiktionary.new('samochód', WIKI_URL)
+    w = Dict::Wiktionary.new('samochód')
     w.translate
     w.translations.should be_a(Array)
   end
 
   it "should return array with examples of translated words" do
-    w = Dict::Wiktionary.new('samochód', WIKI_URL)
+    w = Dict::Wiktionary.new('samochód')
     w.translate
     w.examples.should be_a(Array)
   end
 
   it "should return a hash from array of paired values" do
-    w = Dict::Wiktionary.new('samochód', WIKI_URL)
+    w = Dict::Wiktionary.new('samochód')
     w.make_hash_results(w.translate).should be_a(Hash)
   end