howdy 0.0.3 → 0.1.0

data/Rakefile

@@ -45,5 +45,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "howdy #{version}"
   rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_files.include('lib/*/*.rb', 'lib/core/**/*.rb')
+  rdoc.options << "-c UTF-8"
 end

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/bin/how

@@ -19,6 +19,13 @@ opts = OptionParser.new do |opts|
     Howdy::Dictionary.set(dict)
   end
 
+  opts.on("-l", "--list", "List available dictionaries") do |l|
+    Howdy::Dictionary.available.each do |dict|
+      puts "  #{dict.dict_label} - #{dict.dict_description}"
+    end
+    exit
+  end
+
   opts.on_tail("-h", "--help", "Show this message") do |h|
     puts opts
     exit

data/howdy.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{howdy}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["mlomnicki"]
@@ -28,12 +28,12 @@ Gem::Specification.new do |s|
      "bin/how",
      "howdy.gemspec",
      "lib/howdy.rb",
-     "lib/howdy/dictionaries/base.rb",
+     "lib/howdy/base.rb",
+     "lib/howdy/core_ext/ruby/string/underscore.rb",
      "lib/howdy/dictionaries/dict_pl.rb",
      "lib/howdy/dictionaries/dictionary_com.rb",
      "lib/howdy/dictionaries/ling_pl.rb",
      "lib/howdy/dictionaries/urban_dictionary_com.rb",
-     "lib/howdy/pair.rb",
      "spec/howdy_spec.rb",
      "spec/spec_helper.rb"
   ]

data/lib/howdy/base.rb

@@ -0,0 +1,199 @@
+require 'open-uri'
+require 'uri'
+require 'nokogiri'
+
+module Howdy # :nodoc
+  
+  # Standard Howdy exception
+  class HowdyError < Exception; end
+
+  # Howdy::Dictionary exposes accessors of dictionaries collection.
+  module Dictionary
+
+    # Returns current dictionary class
+    def self.current
+      @@dictionary ||= default
+    end
+
+    # Set current dictionary. Pass a class as an argument
+    #   Howdy::Dictionary.set(DictionaryCom)
+    def self.set(dictionary)
+      @@dictionary = dictionary
+    end
+
+    # Returns default dictionary
+    def self.default
+      DictionaryCom
+    end
+
+    # Returns array of available dictionaries
+    def self.available
+      @@available_dictionaries ||= []
+    end
+
+    # Base class for all dictionaries. Inherit from it if you want to implement
+    # your own dictionary.
+    #   Example:
+    #
+    #     class AwesomeDictionary < Howdy::Dictionary::Base
+    #
+    #       url 'http://awesome.example.com?word=#{user_query}'
+    #       label 'example.com'
+    #       description 'Most awesome dictionary you've ever seen'
+    #
+    #       def parse
+    #         document.css('table.results tr td.word') do |cell|
+    #           result << cell.content
+    #         end
+    #       end
+    #     end
+    class Base
+
+      attr_reader :user_query
+
+      def self.inherited(base) # :nodoc
+        Howdy::Dictionary.available << base
+      end
+
+      def initialize(user_query) # :nodoc
+        @user_query = user_query
+      end
+
+      # Sets URL to query the web dictionary.
+      # You must pass protocol as well:
+      #   http://dictionary.com is correct
+      #   dictionary.com is incorrect
+      #
+      # URL is interpolated:
+      #   'http://dictionary.com/browse/#{user_query}'
+      #
+      # <tt>user_query</tt> is a string given by the user
+      #  
+      # You may provide own interpolations easily:
+      #   Example:
+      #   class Dictionary < Howdy::Dictionary::Base
+      #     url 'http://awesome.example.com?word=#{user_query}&language=#{lang}'
+      #     label 'example.com'
+      #     description 'Interpolations example'
+      #
+      #     def lang
+      #       File.read('/etc/howdy/language.conf')
+      #     end
+      #
+      #     def parse
+      #        # implement parsing
+      #     end
+      #
+      #   end
+      #
+      #   In that example #{lang} in url will be replaced with content of
+      #   /etc/howdy/language.conf
+      #
+      # Indicate the url must be given using <b>SINGLE QUOTES</b>.
+      def self.url(dictionary_url)
+        @url = dictionary_url
+      end
+
+      # Returns URL of the dictionary
+      def self.dict_url
+        @url
+      end
+
+      # Sets a label of the dictionary. Label is used when listing available
+      # dictionaries
+      def self.label(human_name)
+        @name = human_name.to_s
+      end
+
+      # Sets a description of the dictionary. Description is used when listing
+      # available dictionaries.
+      def self.description(dictionary_description)
+        @description = dictionary_description
+      end
+
+      # Returns label of the dictionary.
+      def self.dict_label
+        @name ||= self.label.underscore
+      end
+
+      # Returns description of the dictionary.
+      def self.dict_description
+        @description ||= ""
+      end
+
+      # Sets an encoding of content returned by HTTP response.
+      def self.encoding(enc)
+        @encoding = enc.to_s
+      end
+
+      # Returns an encoding of HTTP response. UTF-8 by default.
+      def self.doc_encoding
+        @encoding ||= 'UTF-8'
+      end
+
+      # Method which transformates raw content received in HTTP response to
+      # human-friendly form. Usually you'll use +document+ which exposes
+      # the raw content wrapped by Nokogiri parser. Read to nokogiri
+      # documentation for details.
+      #
+      # Each human readable word goes to +result+ array.
+      # 
+      #   Example:
+      #     def parse
+      #       document.css('table.content tr td.word').each do |row|
+      #         result << row.content
+      #       end
+      #     end  
+      #
+      def parse
+        raise Howdy::HowdyError, "Implement parse in your Dictionary::Base subclass"
+      end
+
+      # Returns content of HTTP response wrapped in Nokogiri::HTML backend.
+      def document
+        @document ||= Nokogiri::HTML(open(URI.escape(interpolated_url)), nil, self.class.doc_encoding)
+      end
+
+      # Array which stores the answers for the user query. Used in +parse+ method.
+      #   Example:
+      #   result << 'Polyglot - a person who speaks, writes, or reads a number of languages'
+      def result
+        @result ||= []
+      end
+
+      # Prints the contents of +result+ array. You may ovveride it in subclass.
+      def print
+        if result.empty?
+          puts "Nothing found"
+        else
+          result.each do |item|
+            puts item.to_s
+          end
+        end
+      end
+
+      protected
+      # Returns url with interpolated literals. Literals are interpolated using
+      # corresponding instance methods.
+      #   Example:
+      #     url 'http://example.com/word/#{foo}'
+      #
+      #     def foo
+      #       'bar'
+      #     end
+      #
+      # <tt>interpolated_url</tt> will return: 
+      #   http://example/com/word/bar
+      def interpolated_url
+        @interpolated_url ||= self.class.dict_url.gsub(/#\{[^\}]+\}/) do |interpolation|
+          method = interpolation[2..-2].to_sym # drop leading '#{' and trailing '}'
+          raise Howdy::HowdyError.new("Dictionary has to respond to #{method} in order to use it in query") unless respond_to?(method)
+          send(method)
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/howdy/core_ext/ruby/string/underscore.rb

@@ -0,0 +1,9 @@
+# Stolen from Steam project by Sven Fuchs http://github.com/svenfuchs/steam
+
+class String
+
+  # Returns underscored string
+  def underscore
+    self[0, 1].downcase + self[1..-1].gsub(/[A-Z]/) { |c| "_#{c.downcase}" }
+  end
+end unless String.method_defined?(:underscore)

data/lib/howdy/dictionaries/dict_pl.rb

@@ -5,6 +5,8 @@ module Howdy
     class DictPl < Base
 
       url 'http://www.dict.pl/dict?word=#{user_query}'
+      label 'dict.pl'
+      description 'Polish-English dictionary'
 
       def parse
         document.css('table.resTable tr.resRow').each do |row|

data/lib/howdy/dictionaries/dictionary_com.rb

@@ -5,6 +5,8 @@ module Howdy
     class DictionaryCom < Base
 
       url 'http://dictionary.reference.com/browse/#{user_query}'
+      label 'dictionary.com'
+      description 'English dictionary'
 
       def parse
         document.css('div.KonaBody div.results_content table.luna-Ent tr').each do |row|

data/lib/howdy/dictionaries/ling_pl.rb

@@ -5,6 +5,8 @@ module Howdy
     class LingPl < Base
 
       url 'http://www2.ling.pl/lingfeed-ps.php?word=#{user_query}&sType=0&chooseLang=1'
+      label 'ling.pl'
+      description 'Polish-English dictionary'
 
       def parse
         document.css('div.dictdef')[0..2].each do |definiton|

data/lib/howdy/dictionaries/urban_dictionary_com.rb

@@ -1,7 +1,10 @@
 module Howdy
 	module Dictionary
 		class UrbanDictionaryCom < Base
+
 			url 'http://www.urbandictionary.com/define.php?term=#{user_query}'
+      label 'urbandictionary.com'
+      description 'Slang dictionary'
 
 			def parse
 				document.css('table#entries tr td.text').each do |cell|

data/lib/howdy.rb

@@ -1,15 +1,6 @@
-$: << File.join(File.dirname(__FILE__),'howdy')
+$: << File.join(File.dirname(__FILE__), 'howdy')
 
-require 'pair'
-require 'dictionaries/base'
-require 'dictionaries/dict_pl'
-require 'dictionaries/ling_pl'
-require 'dictionaries/dictionary_com'
-require 'dictionaries/urban_dictionary_com'
-
-module Howdy
-
-  class HowdyError < Exception; end
-
-end
+require 'core_ext/ruby/string/underscore'
+require 'base'
+Dir[File.join(File.dirname(__FILE__), 'howdy', 'dictionaries', '*.rb')].each { |dict| require dict }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: howdy
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - mlomnicki
@@ -51,12 +51,12 @@ files:
 - bin/how
 - howdy.gemspec
 - lib/howdy.rb
-- lib/howdy/dictionaries/base.rb
+- lib/howdy/base.rb
+- lib/howdy/core_ext/ruby/string/underscore.rb
 - lib/howdy/dictionaries/dict_pl.rb
 - lib/howdy/dictionaries/dictionary_com.rb
 - lib/howdy/dictionaries/ling_pl.rb
 - lib/howdy/dictionaries/urban_dictionary_com.rb
-- lib/howdy/pair.rb
 - spec/howdy_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true

data/lib/howdy/dictionaries/base.rb

@@ -1,80 +0,0 @@
-require 'open-uri'
-require 'uri'
-require 'nokogiri'
-
-module Howdy
-
-  module Dictionary
-      
-    def self.current
-      @@dictionary ||= default_dictionary
-    end
-
-    def self.set(dictionary)
-      @@dictionary = dictionary
-    end
-
-    def self.default_dictionary
-      DictionaryCom
-    end
-
-    class Base
-
-      attr_reader :user_query
-
-      def initialize(user_query)
-        @user_query = user_query
-      end
-
-      def self.url(dictionary_url)
-        @url = dictionary_url
-      end
-
-      def self.dict_url
-        @url
-      end
-
-      def self.encoding(enc)
-        @encoding = enc.to_s
-      end
-
-      def self.doc_encoding
-        @encoding ||= 'UTF-8'
-      end
-
-      def parse
-        raise Howdy::HowdyError, "Implement parse in your Dictionary::Base subclass"
-      end
-
-      def document
-        @document ||= Nokogiri::HTML(open(URI.escape(interpolated_url)), nil, self.class.doc_encoding)
-      end
-
-      def result
-        @result ||= []
-      end
-
-      def print
-        if result.empty?
-          puts "Nothing found"
-        else
-          result.each do |item|
-            puts item.to_s
-          end
-        end
-      end
-
-      protected
-      def interpolated_url
-        @interpolated_url ||= self.class.dict_url.gsub(/#\{[^\}]+\}/) do |interpolation|
-          method = interpolation[2..-2].to_sym # drop leading '#{' and trailing '}'
-          raise Howdy::HowdyError.new("Dictionary has to respond to #{method} in order to use it in query") unless respond_to?(method)
-          send(method)
-        end
-      end
-
-    end
-
-  end
-
-end

data/lib/howdy/pair.rb

@@ -1,22 +0,0 @@
-module Howdy
-
-  class Pair
-
-    attr_accessor :left, :right
-
-    CENTER = 85
-
-    def initialize(left = nil, right = nil)
-      @left = left
-      @right = right
-    end
-
-    def to_s
-      "#{@left.center(CENTER)} => #{@right.center(CENTER)}"
-    end
-
-    alias :inspect :to_s
-
-  end
-
-end