oald_parser 0.2.2 → 0.2.3

data/README.rdoc

@@ -2,8 +2,7 @@
 
 == Description
 
-OaldParser is a simple gem for getting descriptions for words.
-It uses online Oxford Advanced Learner's Dictionary for this purpose.
+OALD Parser (Oxford Advanced Learner's Dictionary Parser) is a simple gem providing access to one of the best online dictionaries for people studing English.
 
 == Installation
 
@@ -11,30 +10,27 @@ It uses online Oxford Advanced Learner's Dictionary for this purpose.
 
 == Usage
 
-The whole gem is hidden by a facade class that should be used
-for getting all the information.
-The first way to create this facade is:
+To hide the complexity of parsing and searching words I provide a simple facade:
 
-    facade = OaldParser::Facade.create_facade
+    facade = OaldParser::Facade.create_configured_instance
 
-After that it can be used in such a way:
+It can be used this way:
 
     text = facade.describe(word: 'dog') OR
     text = facade.describe(str: 'a dog [CN]')
 
-The 'describe' method returns a plain text describing word or a string. 
+The 'describe' method returns a plain text describing a word or a string. 
 
 == Customizing
 
-If you want to customize the facade you should look at the 'create_facade' method:
+You can customize the behaviour of the facade by providing your own implemenation of one of the objects the facadeuses.
 
-    def self.create_facade
-      downloader = PageDownloader.new('http://www.oup.com/oald-bin/web_getald7index1a.pl')
+    def self.create_configured_instance
+      downloader = PageDownloader.new(URL)
       parser = PageParser.new
-      formatter = Formatter.new(lines: 15)
+      formatter = Formatter.new
       extractor = WordExtractor.new
       Facade.new(downloader, parser, formatter, extractor)
     end
 
-As you can see it is not a problem to use your own parser or formatter and create
-a special instance of facade.
+Please, take a look at a spec file for more details.

data/Rakefile

@@ -1,6 +1 @@
-require 'spec/rake/spectask'
-
-desc "Run all specs"
-Spec::Rake::SpecTask.new('spec') do |t|
-  t.spec_files = FileList['spec/**/*.rb']
-end
+require 'bundler/gem_tasks'

data/lib/oald_parser/facade.rb

@@ -6,6 +6,8 @@ require_relative 'word_extractor'
 
 module OaldParser
   class Facade
+    URL = 'http://www.oxfordadvancedlearnersdictionary.com/dictionary'
+
     def initialize(downloader, parser, formatter, extractor)
       @downloader = downloader
       @parser = parser
@@ -13,8 +15,8 @@ module OaldParser
       @extractor = extractor
     end
 
-    def self.create_facade
-      downloader = PageDownloader.new('http://www.oxfordadvancedlearnersdictionary.com/dictionary')
+    def self.create_configured_instance
+      downloader = PageDownloader.new(URL)
       parser = PageParser.new
       formatter = Formatter.new
       extractor = WordExtractor.new
@@ -23,6 +25,7 @@ module OaldParser
 
     def describe(args)
       word = get_word(args)
+      
       raise OaldParserException.new(OaldParserException::INTERNAL) unless word 
 
       page = @downloader.download(word)
@@ -46,4 +49,4 @@ module OaldParser
       end
     end
   end
-end
+end

data/lib/oald_parser/oald_parser_exception.rb

@@ -16,4 +16,4 @@ module OaldParser
       end
     end
   end
-end
+end

data/lib/oald_parser/page_downloader.rb

@@ -14,4 +14,4 @@ module OaldParser
       nil
     end
   end
-end
+end

data/lib/oald_parser/page_parser.rb

@@ -83,4 +83,4 @@ module OaldParser
       elements.collect{|e|e.text}.join('').strip
     end
   end
-end
+end

data/lib/oald_parser/word_extractor.rb

@@ -1,19 +1,25 @@
 module OaldParser
   class WordExtractor
+    NOISE = /\Aa | a |\Aan | an |\Athe | the |\[.*\]|\(.*\)| adj | adj\z| adv | adv\z/i
+
     def extract(str)
-      res = remove_unused_words(str)
-      find_first_big_word(res)
+      res = remove_noise(str)
+      retrieve_first_long_word(res)
     end
 
     private
-    def remove_unused_words(str)
-       str.gsub(' ', '  ').
-       gsub(/\Aa | a |\Aan | an |\Athe | the |\[.*\]|\(.*\)| adj | adj\z| adv | adv\z/i, '')
+    def remove_noise(str)
+       str.gsub(' ', '  ').gsub(NOISE, '')
+    end
+
+    def retrieve_first_long_word(str)
+      words = str.split(' ')
+      word = words.size > 1 ?  find_first_long_word(words) : str
+      word.strip
     end
 
-    def find_first_big_word(str)
-      parts = str.split(' ')
-      parts.size > 1 ? parts.find{|w| w.size > 2}  : str.strip
+    def find_first_long_word(words)
+      words.find{|w| w.size > 2}
     end
   end
-end
+end

data/lib/oald_parser.rb

@@ -3,22 +3,3 @@ require_relative 'oald_parser/formatter'
 require_relative 'oald_parser/oald_parser_exception'
 require_relative 'oald_parser/page_downloader'
 require_relative 'oald_parser/page_parser'
-
-
-#include OaldParser
-#
-#downloader = PageDownloader.new("http://www.oxfordadvancedlearnersdictionary.com/dictionary")
-#page = downloader.download("a")
-##puts page
-#
-#parser = PageParser.new
-#parsed = parser.parse(page)
-#puts parsed.inspect
-#
-#formatter = Formatter.new(items: 15)
-#puts formatter.format(parsed)
-
-#class=sd-g block
-#class=n-g new line
-#class=x-g new list item
-#class=xr-g delete

metadata

@@ -1,61 +1,62 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: oald_parser
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 2
-  - 2
-  version: 0.2.2
+version: !ruby/object:Gem::Version
+  version: 0.2.3
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Victor Savkin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-11 00:00:00 +11:00
+date: 2011-07-01 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rspec
+  requirement: &2165618180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *2165618180
+- !ruby/object:Gem::Dependency
+  name: watchr
+  requirement: &2165617620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: nokogiri
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+  version_requirements: *2165617620
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &2165617080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: Simple parse for online oxford dictionary
-email: 
+  prerelease: false
+  version_requirements: *2165617080
+description: Oxford Advanced Learner's Dictionary Parser
+email:
 - avix1000@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- lib/oald_parser/page_downloader.rb
+files:
+- lib/oald_parser/facade.rb
 - lib/oald_parser/formatter.rb
 - lib/oald_parser/oald_parser_exception.rb
+- lib/oald_parser/page_downloader.rb
 - lib/oald_parser/page_parser.rb
-- lib/oald_parser/facade.rb
 - lib/oald_parser/word_extractor.rb
 - lib/oald_parser.rb
 - README.rdoc
@@ -63,34 +64,26 @@ files:
 has_rdoc: true
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 1
-      - 3
-      - 6
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: Simple parse for online oxford dictionary
+summary: Oxford Advanced Learner's Dictionary Parser
 test_files: []
-