ud 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c17aeb74c72f8713fd49862c33fa292f256174d
-  data.tar.gz: f1964b4cf50361f5b2765aee3e136cc96d806c61
+  metadata.gz: 1d511a1877540f177fd4d65e6f08f6bb292fbd6a
+  data.tar.gz: 31b686725109b06ea9ea5813dcf8a6380d6ecce4
 SHA512:
-  metadata.gz: cf6a6865b51c9ae2aebd9a063d365b3457aad7aa7a946c706eceb46b299ffcf4a36e981c1d85ee0352693d4c92de840314be300dda31cc9b87742aca105929f4
-  data.tar.gz: e69cc02df921261f58893efb090f8debae155845d4a144f658ad79f1ce15090a9c4903d037bb728cf5a5b9fcd0f16e447b566ecf35566301c71cf364dd79ea92
+  metadata.gz: 749cb4bf772d90c32e4a81783d557773fa993bce4208e14ad357da07e222501c068c3c307ab1344c941d6e4eba5aac14dabbd8e1a7cef5084fe140fd39067005
+  data.tar.gz: 9b4796d197fd96eb62299281851005de965cbd11c84b5c8d7d45fd8b29fbfa7fd2f7d3de880449cf263fbba5dbb55fbe3080c27780bb9b50c97dbe00028718da

data/bin/ud

@@ -1,6 +1,9 @@
 #! /usr/bin/env ruby
 # -*- coding: UTF-8 -*-
 
+# clean interrupt
+trap('INT') { abort }
+
 require 'trollop'
 require 'ud'
 

data/lib/ud/formatting.rb

@@ -1,12 +1,15 @@
-#! /usr/bin/env ruby
 # -*- coding: UTF-8 -*-
 
 module UD
+
+  # Formatting tools for {UD.query}'s output
   module Formatting
     class << self
 
-    # Fit a text in a given width (number of chars). It returns
-    # a list of lines of text.
+    # Fit a text in a given width (number of chars).
+    # @param txt [String]
+    # @param width [Integer] maximum width
+    # @return [Array] list of lines of text
     def fit(txt, width=79)
       return [] if width < 1
 
@@ -17,8 +20,9 @@ module UD
 
     # Add a tab at the beginning of a text. If it's a list, add a tab at
     # the beginning of each element.
-    # [txt] The text to tab, may be a string or a list of strings
-    # [width] The width (number of spaces) of a tab
+    # @param txt [String] The text to tab, may be a string or a list of strings
+    # @param width [Integer] tab width
+    # @return [String]
     def tab(txt, width=4)
       width = 0 if width < 0
 
@@ -30,7 +34,10 @@ module UD
     end
 
     # Format results for text output (e.g. in the terminal)
-    # [results] this must be an array of results, as returned by +UD.query+.
+    # @param results [Array<Hash>] this must be an array of results, as
+    #                              returned by {UD.query}.
+    # @param color [Boolean] colored output
+    # @return [String]
     def text(results, color=true)
       require 'colored' if color
 
@@ -50,14 +57,16 @@ module UD
         definition = tab(fit(r[:definition], 75)).join("\n")
         example    = tab(fit(r[:example], 75)).join("\n")
 
-        s = ''
+        <<-EOD
+* #{word} (#{votes}):
+
+#{definition}
+
+ Example:
+#{example}
+
 
-        s << "* #{word} (#{votes}):\n"
-        s << "\n"
-        s << definition
-        s << "\n\n Example:\n"
-        s << example
-        s << "\n\n"
+        EOD
 
       end.join("\n")
     end

data/lib/ud.rb

@@ -1,4 +1,3 @@
-#! /usr/bin/env ruby
 # -*- coding: UTF-8 -*-
 
 require 'uri'
@@ -12,30 +11,28 @@ require File.dirname(__FILE__) + '/ud/formatting'
 module UD
   class << self
 
+    # @return [String] the current gem's version
     def version
-      '0.2.0'
+      '0.2.1'
     end
 
     # Get the search URL to query for a given term.
-    # [term] the term to search for. It must be a string, spaces are allowed
+    # @param term [String] the term to search for. It must be a string, spaces
+    #                      are allowed.
+    # @return [String]
     def search_url(term='')
       param = URI.encode_www_form('term' => term)
       "http://api.urbandictionary.com/v0/define?#{param}"
     end
 
-    # Get the text of an element. This is an helper for internal usage.
-    def text(el)
-      el.text.strip.gsub(/\r/, "\n")
-    rescue
-      ''
-    end
-
     # Query the website and return a list of definitions for the provided term.
     # This list may be empty if there's no result.
-    # [term] the term to search for
-    # [opts] options. This is used by the command-line tool. +:count+ is the
-    # maximum number of results to return, +:ratio+ is the minimum
-    # upvotes/downvotes ratio. Other options may be added in the future.
+    # @param term [String] the term to search for
+    # @param opts [Hash] options. This is used by the command-line tool.
+    #                    +:count+ is the maximum number of results to return,
+    #                    +:ratio+ is the minimum upvotes/downvotes ratio. Other
+    #                    options may be added in the future.
+    # @return [Array<Hash>]
     def query(term, *opts)
 
       opts = {:count => 1, :ratio => 0.0}.merge(opts[0] || {})
@@ -61,7 +58,10 @@ module UD
     end
 
     # Format results for output
-    # [results] this must be an array of results, as returned by +UD.query+.
+    # @param results [Array] this must be an array of results, as returned by
+    #                        +UD.query+.
+    # @param color [Boolean] colored output
+    # @return [String]
     def format_results(results, color=true)
       UD::Formatting.text(results, color)
     end

data/tests/formatting_tests.rb

@@ -12,42 +12,13 @@ end
 
 class UD_Formatting_test < Test::Unit::TestCase
 
-  # == UD#text == #
-
-  def test_text_empty
-    el = FakeHTMLElement.new
-    assert_equal('', UD.text(el))
-  end
-
-  def test_text_trailing_spaces
-    el = FakeHTMLElement.new('foo    ')
-    assert_equal('foo', UD.text(el))
-
-    el = FakeHTMLElement.new(" bar \n")
-    assert_equal('bar', UD.text(el))
-  end
-
-  def test_text_newline
-    el = FakeHTMLElement.new("a\rb")
-    assert_equal("a\nb", UD.text(el))
-
-    el = FakeHTMLElement.new("a\nb")
-    assert_equal("a\nb", UD.text(el))
-  end
-
-  def test_text_invalid_element
-    assert_equal('', UD.text(nil))
-    assert_equal('', UD.text(true))
-    assert_equal('', UD.text('foo'))
-  end
-
   # == UD#format_results == #
 
   def test_format_results_empty_list
     assert_equal('', UD.format_results([]))
   end
 
-  def test_format_results_one_element
+  def test_format_results_one_element_no_color
     res = {
       :word => 'XYZ',
       :upvotes => 42,
@@ -67,7 +38,32 @@ class UD_Formatting_test < Test::Unit::TestCase
 EOS
 
     assert_equal(expected.strip, output)
+  end
 
+  def test_format_results_one_element_color
+    green = "\e[32m"
+    bold  = "\e[1m"
+    red   = "\e[31m"
+    reset = "\e[0m"
+    res = {
+      :word => 'XYZ',
+      :upvotes => 42,
+      :downvotes => 78,
+      :definition => 'xyz',
+      :example => 'zyx'
+    }
+
+    output = UD.format_results([res], true).strip
+    expected = <<EOS
+* #{bold}XYZ#{reset} (#{green}42#{reset}/#{red}78#{reset}):
+
+    xyz
+
+ Example:
+    zyx
+EOS
+
+    assert_equal(expected.strip, output)
   end
 
   # == UD::Formatting#fit == #

data/tests/query_tests.rb

@@ -3,7 +3,7 @@
 
 require File.dirname(__FILE__) + '/fake_responses'
 
-class UD_Formatting_test < Test::Unit::TestCase
+class UD_Query_test < Test::Unit::TestCase
 
   ROOT_URL = 'http://api.urbandictionary.com/v0/define'
 

data/tests/tests.rb

@@ -1,12 +1,16 @@
 #! /usr/bin/env ruby
 # -*- coding: UTF-8 -*-
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'test/unit'
 require 'simplecov'
 
 test_dir = File.expand_path( File.dirname(__FILE__) )
 
-SimpleCov.start { add_filter '/tests/' } if ENV['COVERAGE']
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start { add_filter '/tests/' }
 
 require 'ud'
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ud
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Baptiste Fontaine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-22 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
@@ -56,58 +56,72 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.1'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 description: Get words' definitions from Urban Dictionary on the command-line.
 email: batifon@yahoo.fr
 executables:
@@ -115,12 +129,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/ud
 - lib/ud.rb
 - lib/ud/formatting.rb
 - tests/formatting_tests.rb
 - tests/query_tests.rb
 - tests/tests.rb
-- bin/ud
 homepage: https://github.com/bfontaine/ud
 licenses:
 - MIT
@@ -141,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.1
 signing_key: 
 specification_version: 4
 summary: Urban Dictionary unofficial scrapper
@@ -149,3 +163,4 @@ test_files:
 - tests/formatting_tests.rb
 - tests/query_tests.rb
 - tests/tests.rb
+has_rdoc: