ud 0.1.1 → 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11f8394cb33159ae220771206f5c66611840532a
+  data.tar.gz: ed5b562d420f7a2e071a9da934c0b8528978674f
+SHA512:
+  metadata.gz: 6d3b91414b1ee2f7ba0543ffc684892bc0d064f2e762623a22ab85a792a20883b5b565684ad801c6ddf3f2bf49106e043530dbc9ae63618620962b98dc3091a0
+  data.tar.gz: 8cfe02567efc781a86af680b6d2a11bbeb4e6f81440ea543f7aa1523500381d2aad36adb5287c115faa8a07bd108877da4bf79aca5263719f5c4190e98336b7f

data/bin/ud

@@ -15,7 +15,7 @@ where [options] are:
 EOS
 
   opt :ratio, 'Filter by upvotes/downvotes ratio', :type => :float, :default => 0.0
-  opt :count, 'Limit the number of definitions', :type => :int, :default => 10, :short => '-n'
+  opt :count, 'Limit the number of definitions', :type => :int, :default => 1, :short => '-n'
   opt :color, 'Use colorized output', :default => true
   opt :up, 'Shortcut for \'-r 2\''
 

data/lib/ud.rb

@@ -14,7 +14,7 @@ module UD
 
   # The current version of the module
   def UD.version
-    '0.1.1'
+    '0.1.2'
   end
 
   # Get the search URL to query for a given term.
@@ -62,7 +62,7 @@ module UD
   # upvotes/downvotes ratio. Other options may be added in the future.
   def UD.query(term, *opts)
 
-    opts = {:count => 10, :ratio => 0.0}.merge(opts[0] || {})
+    opts = {:count => 1, :ratio => 0.0}.merge(opts[0] || {})
 
     return [] if opts[:count] <= 0
 
@@ -106,37 +106,7 @@ module UD
   # Format results for output
   # [results] this must be an array of results, as returned by +UD.query+.
   def UD.format_results(results, color=true)
-    require 'colored' if color
-
-    t = '   ' # 4-spaces tab
-
-    results.map do |r|
-
-      word  = r[:word]
-      upvotes = r[:upvotes]
-      downvotes = r[:downvotes]
-
-      if (color)
-        word      = word.bold
-        upvotes   = upvotes.to_s.green
-        downvotes = downvotes.to_s.red
-      end
-
-      votes = "#{upvotes}/#{downvotes}"
-      definition = UD::Formatting.fit(r[:definition], 75).map {|l| t+l}.join("\n")
-      example = UD::Formatting.fit(r[:example], 75).map {|l| t+l}.join("\n")
-
-      s = ''
-
-      s << "* #{word} (#{votes}):\n"
-      s << "\n"
-      s << definition
-      s << "\n\n Example:\n"
-      s << example
-      s << "\n\n"
-
-    end.join("\n")
-
+    UD::Formatting.text(results, color)
   end
 
 end

data/lib/ud/formatting.rb

@@ -7,8 +7,58 @@ module UD
     # Fit a text in a given width (number of chars). It returns
     # a list of lines of text.
     def self.fit(txt, width=79)
+      return [] if width < 1
+
       # from http://stackoverflow.com/a/7567210/735926
-      txt.split("\n").map{|l| l.scan(/(.{1,#{width}})(?:\s|$)/m) }.flatten
+      r = /(.{1,#{width}})(?:\s|$)/m
+      txt.split("\n").map { |l| l.scan(r) }.flatten
+    end
+
+    # 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
+    def self.tab(txt, width=4)
+      width = 0 if width < 0
+
+      tab = ' ' * width
+
+      return tab + txt if txt.is_a?(String)
+
+      txt.map { |l| tab + l }
+    end
+
+    # Format results for text output (e.g. in the terminal)
+    # [results] this must be an array of results, as returned by +UD.query+.
+    def self.text(results, color=true)
+      require 'colored' if color
+
+      results.map do |r|
+
+        word  = r[:word]
+        upvotes = r[:upvotes]
+        downvotes = r[:downvotes]
+
+        if (color)
+          word      = word.bold
+          upvotes   = upvotes.to_s.green
+          downvotes = downvotes.to_s.red
+        end
+
+        votes = "#{upvotes}/#{downvotes}"
+        definition = tab(fit(r[:definition], 75)).join("\n")
+        example    = tab(fit(r[:example], 75)).join("\n")
+
+        s = ''
+
+        s << "* #{word} (#{votes}):\n"
+        s << "\n"
+        s << definition
+        s << "\n\n Example:\n"
+        s << example
+        s << "\n\n"
+
+      end.join("\n")
     end
 
   end

data/tests/formatting_tests.rb

@@ -60,14 +60,54 @@ class UD_Formatting_test < Test::Unit::TestCase
     expected = <<EOS
 * XYZ (42/78):
 
-   xyz
+    xyz
 
  Example:
-   zyx
+    zyx
 EOS
 
     assert_equal(expected.strip, output)
 
   end
 
+  # == UD::Formatting#fit == #
+
+  def test_fit_0_width
+    assert_equal([], UD::Formatting.fit('foo', 0))
+  end
+
+  def test_fit_negative_width
+    assert_equal([], UD::Formatting.fit('foo', -1))
+  end
+
+  def test_fit_right_width
+    assert_equal(['foo'], UD::Formatting.fit('foo', 3))
+  end
+
+  def test_fit_larger_width
+    assert_equal(['foo'], UD::Formatting.fit('foo', 4))
+  end
+
+  def test_fit_smaller_width
+    assert_equal(['a', 'b'], UD::Formatting.fit('a b', 2))
+  end
+
+  # == UD::Formatting#tab == #
+
+  def test_tab_0_width
+    assert_equal('foo', UD::Formatting.tab('foo', 0))
+  end
+
+  def test_tab_negative_width
+    assert_equal('foo', UD::Formatting.tab('foo', -1))
+  end
+
+  def test_tab_2_width
+    assert_equal('  foo', UD::Formatting.tab('foo', 2))
+  end
+
+  def test_tab_array
+    assert_equal([' a', ' b'], UD::Formatting.tab(['a', 'b'], 1))
+  end
+
 end

data/tests/query_tests.rb

@@ -74,7 +74,7 @@ class UD_Formatting_test < Test::Unit::TestCase
       }
     ]
 
-    assert_equal(expected, UD.query('two'))
+    assert_equal(expected, UD.query('two', :count => 2))
   end
 
   def test_query_count
@@ -104,7 +104,7 @@ class UD_Formatting_test < Test::Unit::TestCase
       }
     ]
 
-    assert_equal(expected, UD.query('two', :ratio => 1.5))
+    assert_equal(expected, UD.query('two', :count => 10, :ratio => 1.5))
   end
 
 end

metadata

@@ -1,142 +1,125 @@
 --- !ruby/object:Gem::Specification
 name: ud
 version: !ruby/object:Gem::Version
-  version: 0.1.1
-  prerelease: 
+  version: 0.1.2
 platform: ruby
 authors:
 - Baptiste Fontaine
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-04 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.5.9
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: trollop
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Get words' definitions from Urban Dictionary on the command-line.
@@ -148,36 +131,35 @@ extra_rdoc_files: []
 files:
 - lib/ud.rb
 - lib/ud/formatting.rb
-- tests/tests.rb
-- tests/query_tests.rb
 - tests/formatting_tests.rb
+- tests/query_tests.rb
+- tests/tests.rb
 - bin/ud
 homepage: https://github.com/bfontaine/ud
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 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: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.1.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Urban Dictionary unofficial scrapper
 test_files:
-- tests/tests.rb
-- tests/query_tests.rb
 - tests/formatting_tests.rb
+- tests/query_tests.rb
+- tests/tests.rb