ud 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ea932203fe0c903b5218ce5b146d90654404dc2eebfac0c07e88336aaf37e47
-  data.tar.gz: f62d445b4149d6a1741b33f95760db705f3992462e3ad8d32a6cf19f594b18d0
+  metadata.gz: dcf00a234d982b7fb9457e576eb874f95f155ba00c239017a29bfe735dee1b71
+  data.tar.gz: 54826580f57b21b1e680efb66e68e8f88918085c3585dd62e690b7c76eff0a32
 SHA512:
-  metadata.gz: e3c13f592deea95981d2315ad90cab736e2fa4ff3eecbc0d277d0f764159fa08c5c5691a485ec2105e7679265151640d10d5ce67f5740b6011735c51ef417fee
-  data.tar.gz: b4eee17c59a33c63ef6c7f0796c9595f9724c213279b55f0e68d2d89e3f92e508c9f827cc7ea13a5fb387ead4ef18612c9dcac6bdb9cc000d8c7a7fe66be3ed0
+  metadata.gz: c639b78accaa812407e51c03acf98e47ba7929b6bf6846e8a0ffbfd0a41ca2a2e98ad663b9fb81eb40af5030028aabe687b15bba3c14fd1db893ffeea434c7bf
+  data.tar.gz: dce1bd5cc5efa5710eadae507ed4c85849457a9a1ff0bf7280d65fa331ec4d070c7c0e5884c394ac9f895b477c97425e67a724e11347ac2e2a23805d83dac2bd

data/lib/ud.rb

@@ -2,9 +2,8 @@
 
 require "uri"
 require "json"
-require "open-uri"
 
-require File.dirname(__FILE__) + "/ud/formatting"
+require "defcli"
 
 # This module provide some methods to scrape definitions from the Urban
 # Dictionary website.
@@ -12,7 +11,7 @@ module UD
   class << self
     # @return [String] the current gem's version
     def version
-      "0.3.2"
+      "0.4.0"
     end
 
     API_ROOT = "https://api.urbandictionary.com/v0"
@@ -48,13 +47,13 @@ module UD
     #                      are allowed.
     # @return [Nil]
     def open_url(term)
-      system open_cmd, search_url(term, :api => false)
+      Defcli.open_in_browser search_url(term, :api => false)
     end
 
     # Open a random definition URL in the user's browser
     # @return [Nil]
     def open_random
-      system open_cmd, random_url(:api => false)
+      Defcli.open_in_browser random_url(:api => false)
     end
 
     # Query the website and return a list of definitions for the provided term.
@@ -64,16 +63,16 @@ module UD
     #                    +:count+ is the maximum number of results to return
     # @return [Array<Hash>]
     def query(term, opts = {})
-      parse_response(OpenURI.open_uri(search_url(term)).read, opts)
+      parse_response(Defcli.read_url(search_url(term)), opts)
     end
 
     # Return a random definition
     # @param opts [Hash] options.
     def random(opts = {})
-      parse_response(OpenURI.open_uri(random_url).read, opts)
+      parse_response(Defcli.read_url(random_url), opts)
     end
 
-    # Parse a response from the Urban Dictionnary website.
+    # Parse a response from the Urban Dictionary website.
     # @param opts [Hash] options. This is used by the command-line tool.
     #                    +:count+ is the maximum number of results to return
     # @return [Array<Hash>]
@@ -106,20 +105,7 @@ module UD
     # @param color [Boolean] colored output
     # @return [String]
     def format_results(results, color = true)
-      UD::Formatting.text(results, color)
-    end
-
-    private
-
-    def open_cmd
-      case RbConfig::CONFIG["host_os"]
-      when /darwin/
-        "open"
-      when /bsd|linux/
-        "xdg-open"
-      when /cygwin|mingw|mswin/
-        "start"
-      end
+      Defcli.format_results(results, color)
     end
   end
 end

data/tests/tests.rb

@@ -23,33 +23,10 @@ for t in Dir.glob( File.join( test_dir,  '*_tests.rb' ) )
 end
 
 class UDTests < Test::Unit::TestCase
-
   # == UD#version == #
-
   def test_ud_version
     assert(UD.version =~ /^\d+\.\d+\.\d+/)
   end
-
-  # == UD#open_cmd (private) == #
-
-  def test_ud_open_cmd
-    os = RbConfig::CONFIG["host_os"]
-
-    RbConfig::CONFIG["host_os"] = "darwin"
-    assert_equal "open", UD.send(:open_cmd)
-
-    RbConfig::CONFIG["host_os"] = "linux"
-    assert_equal "xdg-open", UD.send(:open_cmd)
-
-    RbConfig::CONFIG["host_os"] = "bsd"
-    assert_equal "xdg-open", UD.send(:open_cmd)
-
-    RbConfig::CONFIG["host_os"] = "cygwin"
-    assert_equal "start", UD.send(:open_cmd)
-
-    RbConfig::CONFIG["host_os"] = os
-  end
-
 end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ud
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Baptiste Fontaine
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIEPDCCAqSgAwIBAgIBATANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBliL0RD
-  PXB0aXN0ZWZvbnRhaW5lL0RDPWZyMB4XDTE4MTIwODAwMDU0MFoXDTE5MTIwODAw
-  MDU0MFowJDEiMCAGA1UEAwwZYi9EQz1wdGlzdGVmb250YWluZS9EQz1mcjCCAaIw
+  MIID/DCCAmSgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBliL0RD
+  PXB0aXN0ZWZvbnRhaW5lL0RDPWZyMB4XDTIwMDMwNDE5MDMyMVoXDTIxMDMwNDE5
+  MDMyMVowJDEiMCAGA1UEAwwZYi9EQz1wdGlzdGVmb250YWluZS9EQz1mcjCCAaIw
   DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAKdjTwN/gnJ3WHxKeusaRN1o902Q
   BmIRgdtbhpsHtgUruKNujutEBpmhG1fka8+mujhqh885blckeC8hXgqpHGK1MsJU
   tgsNB2F2Nvof/uGBzi+OZ76HPLmfvJFb/KUiwrh08jTbFftMBCmuekbxBajt2N2F
@@ -21,49 +21,34 @@ cert_chain:
   RbYsaGucRneCCzezTD+i1LnhGt9TCbQjdvidgM+i616JC/HRXglM0apgBZSjayoI
   XHoajIajnU+570cu01Wsa+SF9m4stKao0hLnCUMeYybmA/Ilk58nJ2xZJWMULu76
   7Ttzead1Ah25ZdWefKG5FIGkpezEp4z/YihGEJt+hxS7Aa2xYiIlnYFwUno530/8
-  So5Ibqdd3pMKJDUQJvGIBhsQIXF4Iogk4txoPwIDAQABo3kwdzAJBgNVHRMEAjAA
-  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUsV1eKnEFtVRwyz6/nTuharH3G+UwHgYD
-  VR0RBBcwFYETYkBwdGlzdGVmb250YWluZS5mcjAeBgNVHRIEFzAVgRNiQHB0aXN0
-  ZWZvbnRhaW5lLmZyMA0GCSqGSIb3DQEBCwUAA4IBgQBm1mthI2xc/jfKApZigdhO
-  j2X3h5wnBKu/EPU1be0RuFigUGlZCMaM4S8nk5pBJxRv1FHUtR4utP7vcqEWGaE1
-  9RklitOhNSXOeFfFukjUzZXFGUrcSe68BW9dh/KhIt84li13pdDLSNRmO0TzaRdb
-  G7ZRTVIhGqBCY3KJrMwrbjnOH/VK5XwO0hzFZ2/ClWeK+VuJ98bKWpiu2ZSHZCgK
-  nkcbCuzmx0/6UwqUhPEl4i+QLTVr8+Gk3jdxYSBBEUMXyNF6fPM6JJdIui/WjJIx
-  gtCh7AePlEbyxbx4d+oDvo/uzNFfHNNuI4TfkuBNDGLstPbJfyHgk7oPyfvD5dlO
-  yxO7L6A6ZNC1bI3P8tQq+qgDNpkRJ8pqynfF7DxMVOzvlhO5qhV23if7tYaRjqV5
-  T1ACML6wkYk8FexGDaL0txwG/y+b+3sHyUArpv8/rLGqpo+g2TYlqJhdwuA10W2k
-  H0Dpo4eQ8PCwqU7AgGTli19gHcox4Ne0O+6QaiB4eSw=
+  So5Ibqdd3pMKJDUQJvGIBhsQIXF4Iogk4txoPwIDAQABozkwNzAJBgNVHRMEAjAA
+  MAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUsV1eKnEFtVRwyz6/nTuharH3G+UwDQYJ
+  KoZIhvcNAQELBQADggGBAJz7tbRe/iyMthV7fdqnhFv0SZo1UVWZSaIjB39W4lUi
+  7X1Smag2Fe7IqARUPLn2e49ObyupAmTi0zHoSG/+HsBUqNPPoVW1Y67dtrMM49o7
+  qSN66EogB4nvGdvqJ9eOlioiAX7vczWmQjfSONuk0ihOfaTChD7LwoPptTUu/Q6+
+  aT8zz7TH+sxxx+D09Q9+Ywf1RVnUe+i1PTo8kadnHIQdeBPudKrw5GWcIoLz1V16
+  A+j/SNEUqY1ui8TBX6axkd8vh6C1YcVAFCcdrxTMFTeB1irvL8jns6SulRHM08UC
+  9NR+YthP16QuQzb5R2wIGX6WT11cnIpo0LzTnY/QSZGgwJkuLalBLzUssMiVnoSX
+  rVdmQBLrs38YcJouqHpf0wCGygf5430Bq4nCu0xUaH5umPcwJE9qaF1ZfgSCfZEz
+  Qe5fflfwGHtlmT6SWZoQD48xF/ILJ+cLTpF79ardGYnWT6N7VUAI5lKp7OjZYd+q
+  wwYlmlBW0Femxy5WoxzECQ==
   -----END CERTIFICATE-----
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: optimist
+  name: defcli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: colored
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -143,8 +128,6 @@ extra_rdoc_files: []
 files:
 - bin/ud
 - lib/ud.rb
-- lib/ud/formatting.rb
-- tests/formatting_tests.rb
 - tests/query_tests.rb
 - tests/tests.rb
 homepage: https://github.com/bfontaine/ud
@@ -173,4 +156,3 @@ summary: Urban Dictionary unofficial scrapper
 test_files:
 - tests/tests.rb
 - tests/query_tests.rb
-- tests/formatting_tests.rb

data/lib/ud/formatting.rb

@@ -1,72 +0,0 @@
-# -*- 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).
-      # @param txt [String]
-      # @param width [Integer] maximum width
-      # @return [Array] list of lines of text
-      def fit(txt, width = 79)
-        return [] if width < 1
-
-        # from https://stackoverflow.com/a/7567210/735926
-        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.
-      # @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)
-        return txt 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)
-      # @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
-
-        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"
-
-          <<-EOD
-* #{word} (#{votes}):
-
-#{definition}
-
- Example:
-#{example}
-
-
-          EOD
-        end.join "\n"
-      end
-    end
-  end
-end

data/tests/formatting_tests.rb

@@ -1,109 +0,0 @@
-#! /usr/bin/env ruby
-# -*- coding: UTF-8 -*-
-
-class FakeHTMLElement
-
-  attr_reader :text
-
-  def initialize(txt='')
-    @text = txt
-  end
-end
-
-class UD_Formatting_test < Test::Unit::TestCase
-
-  # == UD#format_results == #
-
-  def test_format_results_empty_list
-    assert_equal('', UD.format_results([]))
-  end
-
-  def test_format_results_one_element_no_color
-    res = {
-      :word => 'XYZ',
-      :upvotes => 42,
-      :downvotes => 78,
-      :definition => 'xyz',
-      :example => 'zyx'
-    }
-
-    output = UD.format_results([res], false).strip
-    expected = <<EOS
-* XYZ (42/78):
-
-    xyz
-
- Example:
-    zyx
-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 == #
-
-  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