defcli 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 671ad3b060e2945f7eeda6802e5327565596986a2934c85635efcb7678ad065e
+  data.tar.gz: 22927817e5e29dc4845b44575af9ca1d061b81ff7f8bd4cae047d4aba86c11bc
+SHA512:
+  metadata.gz: 5be8378f87f339c13a49c660d01dca507b59467ffd5ae033f487f562b22cd2210ab2bf65d36a96bb346625a6110b2f1169406515caef9e97ea2206fedd112eb4
+  data.tar.gz: 43fdb3e659694db3b5a34c5fedbe3d56f40ba0f0ba0a8089c9bca9c0446d30209dd2f9210d7c815d57a6f0565f3e4e9c826f32c72e6b5929afdde325e6c612e6

data/lib/defcli.rb

@@ -0,0 +1,44 @@
+# -*- coding: UTF-8 -*-
+
+require "uri"
+require "json"
+require "open-uri"
+
+require_relative "./defcli/formatting"
+
+module Defcli
+  class << self
+    def version
+      "0.0.1"
+    end
+
+    # Format results for output
+    # @param results [Array] array of results
+    # @param color [Boolean] colored output
+    # @return [String]
+    def format_results(results, color = true)
+      Defcli::Formatting.format_results(results, color)
+    end
+
+    def read_url(url)
+      OpenURI.open_uri(url).read
+    end
+
+    def open_in_browser(url)
+      system open_cmd, url
+    end
+
+    private
+
+    def open_cmd
+      case RbConfig::CONFIG["host_os"]
+      when /darwin/
+        "open"
+      when /bsd|linux/
+        "xdg-open"
+      when /cygwin|mingw|mswin/
+        "start"
+      end
+    end
+  end
+end

data/lib/defcli/formatting.rb

@@ -0,0 +1,114 @@
+# -*- coding: UTF-8 -*-
+
+module Defcli
+  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>] array of results
+      # @param color [Boolean] colored output
+      # @return [String]
+      def format_results(results, color = true)
+        results.map { |r| format_result(r, color) }.join "\n"
+      end
+
+      def format_result(r, color = true)
+        require "colored" if color
+
+        word = r[:word]
+        word = word.bold if color
+
+        rating = format_result_rating(r, color)
+
+        definition = tab(fit(r[:definition], 75)).join "\n"
+
+        text = "* #{word}"
+        text << " (#{rating})" if rating
+        text << ":\n\n#{definition}\n"
+
+        text << "(📍 #{r[:location]})\n" if r[:location]
+
+        text << (format_result_examples(r, color) or "")
+
+        text + "\n\n"
+      end
+
+      private
+
+      def format_result_examples(r, color = true)
+        examples = if r[:example]
+                     [r[:example]]
+                   elsif r[:examples]
+                     r[:examples]
+                   else
+                     []
+                   end
+
+        if examples.count == 1
+          example = tab(fit(examples.first, 75)).join "\n"
+          "\n Example:\n#{example}\n"
+
+        elsif examples.count > 1
+          examples = examples.map do |e|
+            tab(fit(e, 75)).join "\n"
+          end.join "\n"
+          "\n Examples:\n#{examples}\n"
+        end
+      end
+
+      def format_result_rating(r, color = true)
+        if r[:upvotes]
+          # upvotes/downvotes
+          upvotes = r[:upvotes]
+          downvotes = r[:downvotes]
+          if color
+            upvotes   = upvotes.to_s.green
+            downvotes = downvotes.to_s.red
+          end
+
+          "#{upvotes}/#{downvotes}"
+        elsif r[:ratio]
+          percentage = r[:ratio] * 100.0
+          rating = format("%2d%%", percentage)
+
+          if color
+            if percentage > 60
+              rating = rating.green
+            else
+              rating = rating.red
+            end
+          end
+
+          rating
+        end
+      end
+    end
+  end
+end

data/tests/formatting_tests.rb

@@ -0,0 +1,96 @@
+class DefcliFormattingTest < Test::Unit::TestCase
+
+  # == Defcli::Formatting.format_results == #
+
+  def test_format_results_empty_list
+    assert_equal('', Defcli.format_results([]))
+  end
+
+  def test_format_results_one_element_no_color
+    res = {
+      :word => 'XYZ',
+      :upvotes => 42,
+      :downvotes => 78,
+      :definition => 'xyz',
+      :example => 'zyx'
+    }
+
+    output = Defcli.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 = Defcli.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
+
+  # == Defcli::Formatting.fit == #
+
+  def test_fit_0_width
+    assert_equal([], Defcli::Formatting.fit('foo', 0))
+  end
+
+  def test_fit_negative_width
+    assert_equal([], Defcli::Formatting.fit('foo', -1))
+  end
+
+  def test_fit_right_width
+    assert_equal(['foo'], Defcli::Formatting.fit('foo', 3))
+  end
+
+  def test_fit_larger_width
+    assert_equal(['foo'], Defcli::Formatting.fit('foo', 4))
+  end
+
+  def test_fit_smaller_width
+    assert_equal(['a', 'b'], Defcli::Formatting.fit('a b', 2))
+  end
+
+  # == Defcli::Formatting.tab == #
+
+  def test_tab_0_width
+    assert_equal('foo', Defcli::Formatting.tab('foo', 0))
+  end
+
+  def test_tab_negative_width
+    assert_equal('foo', Defcli::Formatting.tab('foo', -1))
+  end
+
+  def test_tab_2_width
+    assert_equal('  foo', Defcli::Formatting.tab('foo', 2))
+  end
+
+  def test_tab_array
+    assert_equal([' a', ' b'], Defcli::Formatting.tab(['a', 'b'], 1))
+  end
+end

data/tests/tests.rb

@@ -0,0 +1,54 @@
+#! /usr/bin/env ruby
+
+ci = ENV["CI"] || ENV["CONTINUOUS_INTEGRATION"]
+
+if ci
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+require 'test/unit'
+require 'simplecov'
+
+test_dir = File.expand_path( File.dirname(__FILE__) )
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter if ci
+SimpleCov.start { add_filter '/tests/' }
+
+require 'defcli'
+
+for t in Dir.glob( File.join( test_dir,  '*_tests.rb' ) )
+  require t
+end
+
+class DefcliTests < Test::Unit::TestCase
+
+  # == Defcli.version == #
+
+  def test_version
+    assert(Defcli.version =~ /^\d+\.\d+\.\d+/)
+  end
+
+  # == Defcli.open_cmd (private) == #
+
+  def test_open_cmd
+    os = RbConfig::CONFIG["host_os"]
+
+    RbConfig::CONFIG["host_os"] = "darwin"
+    assert_equal "open", Defcli.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = "linux"
+    assert_equal "xdg-open", Defcli.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = "bsd"
+    assert_equal "xdg-open", Defcli.send(:open_cmd)
+
+    RbConfig::CONFIG["host_os"] = "cygwin"
+    assert_equal "start", Defcli.send(:open_cmd)
+  ensure
+    RbConfig::CONFIG["host_os"] = os
+  end
+end
+
+
+exit Test::Unit::AutoRunner.run

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: defcli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Baptiste Fontaine
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIID/DCCAmSgAwIBAgIBAjANBgkqhkiG9w0BAQsFADAkMSIwIAYDVQQDDBliL0RD
+  PXB0aXN0ZWZvbnRhaW5lL0RDPWZyMB4XDTIwMDMwNDE5MDMyMVoXDTIxMDMwNDE5
+  MDMyMVowJDEiMCAGA1UEAwwZYi9EQz1wdGlzdGVmb250YWluZS9EQz1mcjCCAaIw
+  DQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBAKdjTwN/gnJ3WHxKeusaRN1o902Q
+  BmIRgdtbhpsHtgUruKNujutEBpmhG1fka8+mujhqh885blckeC8hXgqpHGK1MsJU
+  tgsNB2F2Nvof/uGBzi+OZ76HPLmfvJFb/KUiwrh08jTbFftMBCmuekbxBajt2N2F
+  shF6DFEqO2hl/itVt5UeIZhpIZvO7qSZ9FtLRXs0q2O27h4QfAv6XobNDwH5TBs5
+  z+EYufgTtupf26xW0v6z2NDG6z36Eap7QAwoivuPCuXO+IPgxhubtGvFYSo7ygP4
+  RbYsaGucRneCCzezTD+i1LnhGt9TCbQjdvidgM+i616JC/HRXglM0apgBZSjayoI
+  XHoajIajnU+570cu01Wsa+SF9m4stKao0hLnCUMeYybmA/Ilk58nJ2xZJWMULu76
+  7Ttzead1Ah25ZdWefKG5FIGkpezEp4z/YihGEJt+hxS7Aa2xYiIlnYFwUno530/8
+  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-04-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: optimist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: Utilities to build simple dictionnary CLI tools.
+email: b@ptistefontaine.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/defcli.rb
+- lib/defcli/formatting.rb
+- tests/formatting_tests.rb
+- tests/tests.rb
+homepage: https://github.com/bfontaine/defcli
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Dictionnary CLI tools utilities
+test_files:
+- tests/tests.rb
+- tests/formatting_tests.rb

metadata.gz.sig

@@ -0,0 +1,2 @@
+H�y�����}^G|��>��ސ�J����>����k.^["O��*�O�-!��<�|�!HH?X�ȟ���,��I�V�Y�
���W�����mvq�4<<b����	��y�D��W�#幗E-z��o�k�T���Pn�^�h�jHE�Zs5e������rъ��G8�P��V�֠dŢِ����!r�wF�%���2���5mƔv�{�\����]�8BNQ���V��{��������0W �d�YL��Id��Oo�E=�aC�}Cu���<��ъy
+e���F� �u��x�u흝�8�9{�T��d�J�e�q�v��5 ����mM��'�C����a���9����20n=�}��|�L�I(<1�����k