urban 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 279344d172dfd0791a5c6d1bfa1bb08e46689562
+  data.tar.gz: 434a62d05989c3b064daa500a8af7e700d7016be
+SHA512:
+  metadata.gz: 6f11ea8f3569c5500380a8f478137b07a7c8c2955dfd87ed4859a439b6a50e7ab71e9828e3a0bdef8a8eefac767701f6d38d45d7480b236b6328e35f1c0b1a45
+  data.tar.gz: 3dd0ff3b40e0873901e50a38b9f4f0997028dbea37a4ea7e129db8a490ce5890d6cf85e8710fbf1374b1300b4285a9dbb0d61f263066948edb6f3287dc60a407

data/.travis.yml

@@ -1,3 +1,11 @@
+language: ruby
 rvm:
-  - 1.8.7
-  - 1.9.2
+  - ree
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"

data/HISTORY.rdoc

@@ -1,25 +1,40 @@
+=== 2.0.0
+
+* Major enhancements:
+
+  * Remove deperecated `--list` and `-l` flags.
+  * Remove official support for Ruby 1.8.6.
+
+* Bug fixes
+
+  * Urban Dictionary redesigned the website. Xpath selectors were out of date
+    and would not return results properly.
+  * Undefined words now show a cleaner error. This was apparently not fixed
+    in the prior release.
+
 === 1.0.0
 
 * Major enhancements:
 
-  * Change `list` flag to the `all` flag for more clarity
-  * Remove query from Urban::Web replace with random and search
-  * Add `url` flag to print the url of the definition
+  * Change `--list` flag to the `--all` flag for more clarity.
+  * Deprecate `--list` flag.
+  * Remove query from Urban::Web replace with random and search.
+  * Add `url` flag to print the url of the definition.
 
 * Minor enhancements:
 
-  * Add this history file
-  * Add Urban::Web#fetch for fetching pages from urban dictionary
-  * Add examples to help
-  * Remove require 'rubygems' from program and lib
-  * Test now only stubs singleton instead of class
-  * Use ~> instead of >= on dependencies
-  * Replace OpenStruct in Urban::Dictionary with plain Struct
-  * Move Nokogiri call to Dictionary#process
-
-* Bug fix:
-
-  * Passing -v or --version no longer prints help
-  * Undefined words now show a clean error
-  * No internet connection now shows a clean error
-  * Invalid options now show a clean error
+  * Add this history file.
+  * Add Urban::Web#fetch for fetching pages from urban dictionary.
+  * Add examples to help.
+  * Remove require 'rubygems' from program and lib.
+  * Test now only stubs singleton instead of class.
+  * Use ~> instead of >= on dependencies.
+  * Replace OpenStruct in Urban::Dictionary with plain Struct.
+  * Move Nokogiri call to Dictionary#process.
+
+* Bug fixs:
+
+  * Passing -v or --version no longer prints help.
+  * Undefined words now show a clean error.
+  * No internet connection now shows a clean error.
+  * Invalid options now show a clean error.

data/Manifest.txt

@@ -0,0 +1,25 @@
+.travis.yml
+HISTORY.rdoc
+LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+bin/urban
+lib/urban.rb
+lib/urban/cli.rb
+lib/urban/dictionary.rb
+lib/urban/web.rb
+script/test
+test/fixtures/impromptu.html
+test/fixtures/missing.html
+test/fixtures/screens/definition.txt
+test/fixtures/screens/definition_with_url.txt
+test/fixtures/screens/definitions.txt
+test/fixtures/screens/help.txt
+test/fixtures/screens/invalid_option_error.txt
+test/fixtures/screens/missing_phrase_error.txt
+test/fixtures/screens/no_internet_error.txt
+test/test_helper.rb
+test/urban/cli_test.rb
+test/urban/dictionary_test.rb
+test/urban/web_test.rb

data/README.rdoc

@@ -1,17 +1,22 @@
 = Urban
-{<img src="https://secure.travis-ci.org/tmiller/urban.png"/>}[http://travis-ci.org/tmiller/urban]
 
-Urban is a command line tool that allows you to look up definitions or pull a
-random definition from {Urban Dictionary}[http://www.urbandictionary.com].
+* Home :: http://github.com/tmiller/urban
+* Bug Tracker :: http://github.com/tmiller/urban/issues
 
-* {Git}[http://github.com/tmiller/urban]
-* {Bug Tracker}[http://github.com/tmiller/urban/issues]
+== Description:
 
-== Requirements
+Urban is a command line utility with an API to query definitions from Urban
+Dictionary.
 
-* Ruby >= 1.8.6
+== BADGES
 
-== Installation
+{<img src="https://secure.travis-ci.org/tmiller/urban.png"/>}[http://travis-ci.org/tmiller/urban] {<img src="https://codeclimate.com/github/tmiller/urban.png" />}[https://codeclimate.com/github/tmiller/urban]
+
+== REQUIREMENTS
+
+* Ruby >= 1.8.7
+
+== INSTALLATION
 
 With Rubygems:
 
@@ -23,7 +28,7 @@ With git and local working copy
     $ cd urban
     $ sudo rake install
 
-== CLI Usage
+== CLI USAGE
 
 === 1. Look up a definition
 
@@ -49,9 +54,9 @@ With git and local working copy
     $ urban --help
     $ urban --version
 
-== API Ussage
+== API USAGE
 
-    requre 'urban'
+    require 'urban'
 
     # Search for a word
     entry = Urban::Dictionary.search('impromtpu')
@@ -68,10 +73,6 @@ With git and local working copy
       puts definition
     end
 
-== To Do
-
-* Add YARD documentation for API
-
 ---
 
 Copyright (c) 2011 Thomas Miller. See LICENSE for details.

data/Rakefile

@@ -1,38 +1,21 @@
-require 'rubygems'
-require 'bundler/gem_helper'
-Bundler::GemHelper.install_tasks
+# -*- ruby -*-
+require "rubygems"
+require "hoe"
 
+Hoe.plugin :minitest
+Hoe.plugin :git
 
-task :default => :test
+Hoe.spec "urban" do
+  self.readme_file = "README.rdoc"
+  self.history_file = "History.rdoc"
 
-require 'rake/testtask'
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-  t.warning = true
-end
+  license "MIT"
+  developer("Tom Miller", "jackerran@gmail.com")
 
-Rake::TestTask.new do |t|
-  t.name = 'test:cli'
-  t.libs << "test"
-  t.test_files = FileList['test/**/cli_test.rb']
-  t.verbose = true
-  t.warning = true
-end
+  dependency 'nokogiri',  '~> 1.5.0'
 
-Rake::TestTask.new do |t|
-  t.name = 'test:dictionary'
-  t.libs << "test"
-  t.test_files = FileList['test/**/dictionary_test.rb']
-  t.verbose = true
-  t.warning = true
+  dependency 'rake',      '~> 10.0', :development
+  dependency 'minitest',  '~> 5.0',  :development
 end
 
-Rake::TestTask.new do |t|
-  t.name = 'test:web'
-  t.libs << "test"
-  t.test_files = FileList['test/**/web_test.rb']
-  t.verbose = true
-  t.warning = true
-end
+# vim: syntax=ruby

data/bin/urban

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require 'urban/version'
+require 'urban'
 require 'urban/cli'
 
 Urban::CLI.new.run(ARGV)

data/lib/urban.rb

@@ -1,3 +1,6 @@
 require 'urban/dictionary'
-require 'urban/version'
 require 'urban/web'
+
+module Urban
+  VERSION = '2.0.0'
+end

data/lib/urban/cli.rb

@@ -1,7 +1,6 @@
-require 'optparse'
-require 'ostruct'
-require 'socket'
-require 'urban/dictionary'
+require "optparse"
+require "ostruct"
+require "socket"
 
 module Urban
   class CLI
@@ -9,94 +8,89 @@ module Urban
     attr_accessor :dictionary
 
     def initialize
-      @dictionary = Urban::Dictionary
+      @dictionary = Urban::Dictionary.new
     end
 
     def run(args = ARGV)
-      begin
-        options = parse(args)
-        output = case
-          when options.help           ; options.help_screen
-          when options.version        ; "Urban #{Urban::VERSION} (c) Thomas Miller"
-          when options.random         ; dictionary.random
-          when !options.phrase.empty? ; dictionary.search(options.phrase)
-          else                        ; options.help_screen
-        end
-
-        if output.respond_to?(:phrase)
-          if output.definitions
-            print_entry(output, options)
-          else
-            $stderr.puts "urban: no definitions found for #{entry.phrase.upcase}."
-          end
-        else
-          puts output
-        end
-
-      rescue SocketError
-        $stderr.puts 'urban: no internet connection available.'
-      rescue OptionParser::InvalidOption => e
-        $stderr.puts "urban: #{e.message}\nTry `urban --help' for more information."
-      rescue Exception => e
-        $stderr.puts e.message
+
+      options = parse(args)
+      results = lookup(options)
+
+      case
+      when results.definitions
+        generate_output results, options
+      when results.phrase
+        error "no definitions found for #{results.phrase.upcase}."
+      else
+        $stdout.puts options.version ? version : usage
       end
+
+    rescue SocketError
+      error "no internet connection available."
+    rescue OptionParser::InvalidOption => e
+      error "#{e.message}\nTry `urban --help' for more information."
+    rescue Object => e
+      error e.message
     end
 
     private
 
-    def print_error(entry)
+    def error(message)
+      $stderr.puts "urban: #{message}"
     end
 
-    def print_entry(entry, options)
-      puts "WARNING: --list and -l are deprecated please use --all or -a instead" if options.list
-      puts "\n#{entry.phrase.upcase}\n\n"
+    def generate_output(entry, options)
+      output = "\n#{entry.phrase.upcase}\n\n"
       if options.all
-        entry.definitions.each { |definition| puts "#{definition}\n\n" }
+        output << "#{entry.definitions.join("\n\n")}\n\n"
       else
-        puts "#{entry.definitions.first}\n\n"
+        output << "#{entry.definitions.first}\n\n"
       end
-      puts "URL: #{entry.url}\n\n" if options.url
+      output << "URL: #{entry.url}\n\n" if options.url
+
+      $stdout.puts output
     end
 
     def parse(args)
       options = OpenStruct.new
-      options.random = options.all = options.version = options.help = false
-
-      opts = OptionParser.new do |o|
-        o.banner = <<-EOB
-Usage: urban [OPTION]... [PHRASE]
-Search http://urbandictionary.com for definitions of phrases
-
-        EOB
-
-        o.separator "Options:"
-        o.on('-a', '--all', 'List all definitions') do
-          options.all = true
-        end
 
-        o.on('-r', '--random', 'Return a random phrase and definition') do
-          options.random = true
-        end
+      options_parser = OptionParser.new do |o|
+        o.on("-a", "--all") { options.all = true }
+        o.on("-r", "--random") { options.random = true }
+        o.on("-u", "--url") { options.url = true }
+        o.on("-h", "--help")
+        o.on("-v", "--version") { options.version = true }
+      end
 
-        o.on('-u', '--url', "Print the definition's url after the definition") do
-          options.url = true
-        end
+      options_parser.parse!(args)
+      options.phrase = args.join(" ")
+      options.search = !options.phrase.empty?
+      options
+    end
 
-        o.on('-h', '--help', 'Show this message') do
-          options.help = true
-        end
+    def lookup(options)
+      case
+      when options.random then dictionary.random
+      when options.search then dictionary.search(options.phrase)
+      else OpenStruct.new
+      end
+    end
 
-        o.on('-v', '--version', 'Show version information') do
-          options.version = true
-        end
+    def version
+      "Urban #{Urban::VERSION} (c) Thomas Miller"
+    end
 
-        o.on('-l', '--list', 'DEPRECATED please use --all or -a instead') do
-          options.list = true
-          options.all = true
-        end
-      end
+    def usage
+      <<-EOS
+Usage: urban [OPTION]... [PHRASE]
+Search http://urbandictionary.com for definitions of phrases
 
-      examples = <<-EOE
+Options:
+    -a, --all                   List all definitions
+    -r, --random                Return a random phrase and definition
+    -u, --url                   Print the definition's url after the definition
+    -h, --help                  Show this message
+    -v, --version               Show version information
 
 Examples:
     urban cookie monster        Search for "cookie monster" and print its
@@ -107,11 +101,7 @@ Examples:
     urban -ra                   Print a random phrase and all of its available
                                 definitions
 
-      EOE
-      opts.parse!(args)
-      options.phrase = args.join(' ')
-      options.help_screen = opts.help + examples
-      options
+      EOS
     end
   end
 end

data/lib/urban/dictionary.rb

@@ -1,12 +1,10 @@
-require 'nokogiri'
-require 'urban/version'
-require 'urban/web'
+require "nokogiri"
 
 module Urban
-  module Dictionary
-    extend self
+  class Dictionary
 
     Entry = Struct.new(:phrase, :definitions, :url)
+
     attr_writer :web_service
 
     def random
@@ -18,7 +16,7 @@ module Urban
     end
 
     def web_service
-      @web_service ||= Urban::Web
+      @web_service ||= Urban::Web.new
     end
 
   private
@@ -28,15 +26,17 @@ module Urban
       if not_defined = document.at_xpath('//div[@id="not_defined_yet"]/i')
         Entry.new(not_defined.content.strip, nil, nil)
       else
-        Entry.new( document.at_xpath('//td[@class="word"][1]').content.strip ,
-                   parse_definitions(document),
-                   response.url)
+        Entry.new(
+          document.at_xpath('//a[@class="word"][1]').content.strip,
+          parse_definitions(document),
+          response.url
+        )
       end
     end
 
     def parse_definitions(document)
-      definitions = document.xpath('//td/div[@class="definition"]').map do |node|
-        node.xpath('//br').each { |br| br.replace(Nokogiri::XML::Text.new("\n", node.document)) };
+      document.xpath('//div[@class="def-panel"]/div[@class="meaning"]').map do |node|
+        node.xpath("//br").each { |br| br.replace(Nokogiri::XML::Text.new("\n", node.document)) };
         node.content.strip
       end
     end