dict 0.2.0 → 0.2.1

data/.gitignore

@@ -0,0 +1,2 @@
+*~
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+notifications:
+  email:
+    - gozdek.aleksander@gmail.com
+    - grk@ragnarson.com
+    - jan.borwin@gmail.com
+    - kosmadunikowski@gmail.com
+    - mtczerwinski@gmail.com
+    - michalk@ragnarson.com
+    - m.podlecki@op.pl
+    - rafal.osko@gmail.com

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in dict.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,30 @@
+PATH
+  remote: .
+  specs:
+    dict (0.2.1)
+      nokogiri (~> 1.5.5)
+      slop (~> 3.3.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    nokogiri (1.5.5)
+    rake (0.9.2.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.0)
+    rspec-expectations (2.11.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.1)
+    slop (3.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dict!
+  rake
+  rspec (~> 2.11)

data/README.md

@@ -0,0 +1,2 @@
+# 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.

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(-fp --color)
+end

data/bin/dict

@@ -1,8 +1,9 @@
 #!/usr/bin/ruby
 # -*- coding: utf-8 -*-
 
-require_relative '../lib/module_main.rb'
+require 'dict/cli/runner'
 
 opts = Hash.new
 
-Main::main(opts)
+runner = Dict::CLI::Runner.new
+runner.run(opts)

data/dict.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "dict/version"
+
+Gem::Specification.new do |s|
+  s.add_dependency 'slop', '~> 3.3.2'
+  s.add_dependency 'nokogiri', '~>1.5.5'
+  s.add_development_dependency "rspec", "~> 2.11"
+  s.add_development_dependency "rake"
+
+  s.name = %q{dict}
+  s.version = Dict::VERSION
+  s.authors = ['Aleksander Gozdek', 'Mateusz Czerwinski', 'Michał Podlecki','Rafał Ośko']
+  s.email = ['mtczerwinski@gmail.com']
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.summary = %q{Gem made for dictionary application}
+  s.description = <<-END
+    Dict is an open source dictionary aggregator.
+  END
+  s.homepage = 'https://github.com/Ragnarson/dict-gem'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/dict/cli/runner.rb

@@ -0,0 +1,57 @@
+# -*- coding: utf-8 -*-
+
+require 'dict/dict'
+require 'slop'
+require 'timeout'
+
+module Dict
+  module CLI
+    class Runner
+      def parameters_valid?
+        not ARGV.empty?
+      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.
+          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}"
+        end
+        opts
+      end
+
+      def get_translations(opts, word)
+        Timeout::timeout(opts[:time].to_i || 300) do
+          if opts.dict?
+            Dict.get_single_dictionary_translations(word, opts[:dict])
+          else
+            Dict.get_all_dictionaries_translations(word)
+          end
+        end
+      rescue Timeout::Error
+        "Timeout for the query."
+      end
+
+      def run(opts)
+        begin
+          opts = parse_parameters
+        rescue Slop::MissingArgumentError
+          abort("Missing argument")
+        end
+
+        abort(opts.to_s) if opts.help?
+        parameters_valid? or abort("Please enter a word. (-h for help)")
+
+        puts get_translations(opts, ARGV[0])
+      end
+    end
+  end
+end
+

data/lib/dict/dict.rb

@@ -0,0 +1,49 @@
+# -*- coding: utf-8 -*-
+
+require 'dict/wiktionary'
+require 'dict/dictpl'
+require 'json'
+
+module Dict
+  class << self
+    def get_all_dictionaries_translations(word)
+      dictionaries = Hash.new
+
+      available_services.each do |service|
+        dictionaries[service] = get_single_dictionary_translations(word, service)
+      end
+      dictionaries
+    end
+
+    def print_all_dictionaries_translations(word)
+    end
+
+    def get_single_dictionary_translations(word, service)
+      case service
+      when 'wiktionary'
+        Wiktionary.new(word, WIKI_URL).translate
+      when 'dictpl'
+        Dictpl.new(word, DICT_URL).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
+    end
+
+    def to_json(hash)
+      hash.to_json
+    end
+
+    def available_services
+      ['wiktionary', 'dictpl']
+    end
+  end
+end

data/lib/dict/dictionary.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+
+require 'open-uri'
+
+module Dict
+  class Dictionary
+    attr_accessor :translations, :examples
+    def initialize(word, url)
+      check_arguments(word)
+      @translations = []
+      @examples = []
+      @uri = URI(URI.escape(url + word.downcase.tr(' ', '_')))
+    end
+
+    def make_hash_results(arr)
+      hash = arr.each_slice(2).inject({}) do |h, (key, value)|
+        if h.has_key?(key)
+          h[key].push(value) ; h
+        else
+          h[key] = [value] ; h
+        end
+      end
+      @translations, @examples = hash.keys, hash.values
+      hash
+    end
+
+    def check_arguments(word)
+      raise ArgumentError.new("No given word") if word.empty?
+    end
+
+    def self.message
+      'There\'s no such dictionary in database.'
+    end
+
+    class ConnectError < Exception
+      attr_reader :original
+      def initialize(original = $!)
+        @original = original
+      end
+    end
+  end
+end

data/lib/dict/dictpl.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+require 'nokogiri'
+require 'dict/dictionary'
+
+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
+    def translate
+      context_words = []
+      Nokogiri::HTML(open(@uri)).xpath('//td[@class="resWordCol"]/a').each do |node|
+        context_words << node.text
+      end
+      make_hash_results(context_words)
+    rescue OpenURI::HTTPError
+      raise Dictionary::ConnectError
+    end
+  end
+end

data/lib/dict/version.rb

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

data/lib/dict/wiktionary.rb

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*-
+
+require 'nokogiri'
+require 'dict/dictionary'
+
+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
+    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|
+          context_words << node.text << example.text
+        end
+      end
+      make_hash_results(context_words)
+    end
+
+    def get_html(url)
+      Nokogiri::HTML(open(url))
+    rescue OpenURI::HTTPError
+      raise Dictionary::ConnectError
+    end
+  end
+end

data/lib/dict.rb

@@ -1,49 +1,5 @@
-# -*- coding: utf-8 -*-
-
-require_relative 'wiktionary'
-require_relative 'dictpl'
-require 'json'
+require 'dict/dict'
 
 module Dict
-  class << self
-    def get_all_dictionaries_translations(word)
-      dictionaries = Hash.new
-
-      available_services.each do |service|
-        dictionaries[service] = get_single_dictionary_translations(word, service)
-      end
-      dictionaries
-    end
-
-    def print_all_dictionaries_translations(word)
-    end
-
-    def get_single_dictionary_translations(word, service)
-      case service
-      when 'wiktionary'
-        Wiktionary.new(word, WIKI_URL).translate
-      when 'dictpl'
-        Dictpl.new(word, DICT_URL).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
-    end
-
-    def to_json(hash)
-      hash.to_json
-    end
-
-    def available_services
-      ['wiktionary', 'dictpl']
-    end
-  end
+  autoload :VERSION, "dict/version"
 end

data/spec/dict/bin_translate_spec.rb

@@ -0,0 +1,50 @@
+# -*- 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", ["-w", "słowik"])
+  #   opts = Main::parse_parameters
+  #   Main::get_translations(opts).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 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

data/spec/dict/lib_dict_spec.rb

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+require 'dict/dict'
+
+describe Dict do
+
+  it "should get single translation from dictionary with two arguments given" do
+    expect{
+      Dict.get_single_dictionary_translations('samochód', 'dictpl')
+    }.to_not raise_error
+  end
+
+  it "should return hash with translations from all dictionaries" 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)
+  end
+
+end

data/spec/dict/lib_dictpl_spec.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*
+
+require 'dict/dictpl'
+
+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)
+  end
+
+  it "should return array with translations" do
+    d = Dict::Dictpl.new('samochód', DICT_URL)
+    d.translate
+    d.translations.should be_a(Array)
+  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)
+  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)
+  end
+
+end

data/spec/dict/lib_wiktionary_spec.rb

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*
+
+require 'dict/wiktionary'
+
+describe Dict::Wiktionary do
+
+  it "should raise no given word exception" do
+    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', WIKI_URL)
+    w.translate
+    w.translations.should == ["car", "automobile"]
+  end
+
+  it "should return array with translations" do
+    w = Dict::Wiktionary.new('samochód', WIKI_URL)
+    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.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.make_hash_results(w.translate).should be_a(Hash)
+  end
+
+end

data/spec/dict/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dict
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -88,12 +88,27 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/dict.rb
-- lib/dictionary.rb
-- lib/wiktionary.rb
-- lib/dictpl.rb
-- lib/module_main.rb
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
 - bin/dict
+- dict.gemspec
+- lib/dict.rb
+- lib/dict/cli/runner.rb
+- lib/dict/dict.rb
+- lib/dict/dictionary.rb
+- lib/dict/dictpl.rb
+- lib/dict/version.rb
+- lib/dict/wiktionary.rb
+- spec/dict/bin_translate_spec.rb
+- spec/dict/lib_dict_spec.rb
+- spec/dict/lib_dictpl_spec.rb
+- spec/dict/lib_wiktionary_spec.rb
+- spec/dict/spec_helper.rb
 homepage: https://github.com/Ragnarson/dict-gem
 licenses: []
 post_install_message: 

data/lib/dictionary.rb

@@ -1,40 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'open-uri'
-
-class Dictionary
-  attr_accessor :translations, :examples
-  def initialize(word, url)
-    check_arguments(word)
-    @translations = []
-    @examples = []
-    @uri = URI(URI.escape(url + word.downcase.tr(' ', '_')))
-  end
-
-  def make_hash_results(arr)
-    hash = arr.each_slice(2).inject({}) do |h, (key, value)|
-      if h.has_key?(key)
-        h[key].push(value) ; h
-      else
-        h[key] = [value] ; h
-      end
-    end
-    @translations, @examples = hash.keys, hash.values
-    hash
-  end
-
-  def check_arguments(word)
-    raise ArgumentError.new("No given word") if word.empty?
-  end
-
-  def self.message
-    'There\'s no such dictionary in database.'
-  end
-
-  class ConnectError < Exception
-    attr_reader :original
-    def initialize(original = $!)
-      @original = original
-    end
-  end
-end

data/lib/dictpl.rb

@@ -1,19 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'nokogiri'
-require_relative 'dictionary'
-
-DICT_URL = 'http://dict.pl/dict?word='
-
-class Dictpl < Dictionary
-  # Method returns hash with translations as keys and examples of using words as values
-  def translate
-    context_words = []
-    Nokogiri::HTML(open(@uri)).xpath('//td[@class="resWordCol"]/a').each do |node|
-      context_words << node.text
-    end
-    make_hash_results(context_words)
-  rescue OpenURI::HTTPError
-    raise Dictionary::ConnectError
-  end
-end

data/lib/module_main.rb

@@ -1,54 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'dict'
-require 'slop'
-require 'timeout'
-
-module Main
-  def self.parameters_valid?
-    not ARGV.empty?
-  end
-
-  def self.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.
-      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}"
-    end
-    opts
-  end
-
-  def self.get_translations(opts, word)
-    Timeout::timeout(opts[:time].to_i || 300) do
-      if opts.dict?
-        Dict.get_single_dictionary_translations(word, opts[:dict])
-      else
-        Dict.get_all_dictionaries_translations(word)
-      end
-    end
-  rescue Timeout::Error
-    "Timeout for the query."
-  end
-
-  def self.main(opts)
-    begin
-      opts = parse_parameters
-    rescue Slop::MissingArgumentError
-      abort("Missing argument")
-    end
-
-    abort(opts.to_s) if opts.help?
-    parameters_valid? or abort("Please enter a word. (-h for help)")
-
-    puts get_translations(opts, ARGV[0])
-  end
-
-end
-

data/lib/wiktionary.rb

@@ -1,26 +0,0 @@
-# -*- coding: utf-8 -*-
-
-require 'nokogiri'
-require_relative 'dictionary'
-
-WIKI_URL = 'http://en.wiktionary.org/wiki/'
-
-class Wiktionary < Dictionary
-  # Method returns hash with translations as keys and examples of using words as values
-  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|
-        context_words << node.text << example.text
-      end
-    end
-    make_hash_results(context_words)
-  end
-
-  def get_html(url)
-    Nokogiri::HTML(open(url))
-  rescue OpenURI::HTTPError
-    raise Dictionary::ConnectError
-  end
-end