urban 0.0.6 → 0.0.11

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2011 Thomas Miller
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.rdoc

@@ -0,0 +1,48 @@
+= 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].
+
+* {Git}[http://github.com/tmiller/urban]
+* {Bug Tracker}[http://github.com/tmiller/urban/issues]
+
+== Installation
+
+With Rubygems:
+
+    $ sudo gem install urban
+
+With git and local working copy
+
+    $ git clone git://github.com/tmiller/urban.git
+    $ cd urban
+    $ sudo rake install
+
+== Usage
+
+=== 1. Look up a word
+
+    $ urban cookie
+
+=== 2. Random word
+
+    $ urban
+
+== To Do
+
+* Write Tests
+* Implement looking up a word
+* Document with {YARD}[http://yardoc.org]
+* Implement -l switch to list all definitions
+
+== Test words for formatting
+
+The first definitions on these words were show to
+have problems displaying in the terminal. They are to be used to write tests.
+
+* {mina}[http://www.urbandictionary.com/define.php?term=minal]
+* {ugly-hot}[http://www.urbandictionary.com/define.php?term=ugly-hot]
+* {bolen}[http://www.urbandictionary.com/define.php?term=bolen]
+* {chinalian}[http://www.urbandictionary.com/define.php?term=chinalian]
+
+Copyright (c) 2011 Thomas Miller. See LICENSE for details.

data/bin/urban

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
 require 'urban/version'
-require 'urban'
+require 'urban/cli'
 
-Urban.random
+Urban.process

data/lib/urban.rb

@@ -1,28 +1,2 @@
-require "urban/version"
-
-require 'open-uri'
-require 'nokogiri'
-require 'active_support/core_ext/string/inflections'
-
-module Urban
-  def self.random
-    url = URI.encode('http://www.urbandictionary.com/random.php')
-    doc = Nokogiri.HTML(open(url))
-    word = clean_text(doc.at_css('.word')).humanize
-    definition = clean_text(doc.at_css('.definition')).gsub(/\s{2,}/, ' ').gsub(/^\s*\w|\.\s+\w/) { |char| char.upcase }
-    puts "#{word}: #{definition}"
-  end
-
-  private
-  def self.clean_text(node_set)
-    node_set.children.each do |node|
-      if node.name == 'br'
-        node.remove
-      else
-        node.content = node.content.strip << ' '
-      end
-    end
-    return node_set.content.strip.gsub(/ \./, '.')
-  end
-
-end
+require 'urban/version'
+require 'urban/dictionary'

data/lib/urban/cli.rb

@@ -0,0 +1,14 @@
+require 'urban/dictionary'
+
+module Urban
+
+  def process
+    begin
+      result = ARGV.first ? define(ARGV.first) : random
+      puts "#{result[:word]}: #{result[:definition]}"
+    rescue
+      puts "ERROR: #{ARGV.first.capitalize} not found!"
+    end
+  end
+
+end

data/lib/urban/dictionary.rb

@@ -0,0 +1,53 @@
+require 'urban/version'
+
+require 'open-uri'
+require 'nokogiri'
+
+module Urban
+  extend self
+
+  URL = 'http://www.urbandictionary.com'
+
+  def random
+    get_definition(query(:random))
+  end
+
+  def define(word)
+    get_definition(query(:define, word))
+  end
+
+  def get_definition(document)
+    word = wordize(node_to_s(document.at_css('.word')))
+    definition = definitionize(node_to_s(document.at_css('.definition')))
+    return { word: word, definition: definition }
+  end
+
+  def query(type, word = nil)
+    query = "#{type.to_s}.php"
+    query << "?term=#{word}" if word
+    doc = Nokogiri.HTML(open(URI.encode("#{URL}/#{query}")))
+  end
+
+  def node_to_s(node_set)
+    node_set.children.each do |node|
+      case node.name
+      when 'br'
+        node.previous.content = node.previous.content << "\n" if node.previous
+        node.remove
+      end
+    end
+    return node_set.content.strip.gsub(/\r/, "\n")
+  end
+
+  def capitalize(string, pattern)
+    return string.gsub(pattern, &:upcase).gsub(/\s{2,}/, ' ')
+  end
+
+  def wordize(string)
+    return capitalize(string, /^\s*\w/)
+  end
+
+  def definitionize(string)
+    return capitalize(string, /^\s*\w|\.\s+\w/)
+  end
+end

data/lib/urban/version.rb

@@ -1,3 +1,3 @@
 module Urban
-  VERSION = '0.0.6'
+  VERSION = '0.0.11'
 end

data/urban.gemspec

@@ -5,13 +5,12 @@ require 'urban/version'
 Gem::Specification.new do |s|
   s.name        = 'urban'
   s.version     = Urban::VERSION
-  s.authors     = ['Tom Miller']
+  s.authors     = ['Thomas Miller']
   s.email       = ['jackerran@gmail.com']
   s.homepage    = 'https://github.com/tmiller/urban'
-  s.summary     = %q{A command line tool to output a random Urban Dictionary entry}
-  s.description = %q{Currently only a beta command line tool that outputs a random urban dictionary entry. In
-                     the future there are plans to add other features to the tool such as search
-                     and word of the day. There will also be an api to use in your projects.}
+  s.summary     = %q{A command line tool that interfaces with Urban Dictionary.}
+  s.description = %q{Urban is a command line tool that allows you to look up definitions
+                     or pull a random definition from Urban Dictionary.}
 
   s.rubyforge_project = 'urban'
 
@@ -21,7 +20,5 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_dependency 'nokogiri'
-  s.add_dependency 'i18n'
-  s.add_dependency 'activesupport'
   s.add_development_dependency 'ruby-debug19'
 end

metadata

@@ -2,15 +2,15 @@
 name: urban
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.6
+  version: 0.0.11
 platform: ruby
 authors: 
-- Tom Miller
+- Thomas Miller
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-08-12 00:00:00 -05:00
+date: 2011-08-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,43 +24,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: i18n
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: activesupport
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-  type: :runtime
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: ruby-debug19
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id002
 description: |-
-  Currently only a beta command line tool that outputs a random urban dictionary entry. In
-                       the future there are plans to add other features to the tool such as search
-                       and word of the day. There will also be an api to use in your projects.
+  Urban is a command line tool that allows you to look up definitions
+                       or pull a random definition from Urban Dictionary.
 email: 
 - jackerran@gmail.com
 executables: 
@@ -73,10 +50,13 @@ files:
 - .gitignore
 - .rvmrc
 - Gemfile
-- README
+- LICENSE
+- README.rdoc
 - Rakefile
 - bin/urban
 - lib/urban.rb
+- lib/urban/cli.rb
+- lib/urban/dictionary.rb
 - lib/urban/version.rb
 - urban.gemspec
 has_rdoc: true
@@ -106,6 +86,6 @@ rubyforge_project: urban
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
-summary: A command line tool to output a random Urban Dictionary entry
+summary: A command line tool that interfaces with Urban Dictionary.
 test_files: []
 

data/README

@@ -1,6 +0,0 @@
-Known words with bad markup for testing
-  http://www.urbandictionary.com/define.php?term=minal
-  http://www.urbandictionary.com/define.php?term=ugly-hot
-  http://www.urbandictionary.com/define.php?term=bolen
-  http://www.urbandictionary.com/define.php?term=chinalian
-