zypper-onlinesearch 1.0.0 → 1.1.0

data/README.md

@@ -6,6 +6,9 @@ directly in your terminal.
 Basically it is just a command-line frontend to these search engines, it executes a query to them,
 arrange the results and display them in a table or report view.
 
+[![Ruby](https://github.com/fabiomux/zypper-onlinesearch/actions/workflows/main.yml/badge.svg)][wf_main]
+[![Gem Version](https://badge.fury.io/rb/zypper-onlinesearch.svg)][gem_version]
+
 ## Installation
 
 There are a couple of options to install this application.
@@ -44,108 +47,6 @@ To list the links from that page:
 $ onlinesearch -l <page>,<link_number>
 ```
 
-For example looking for *Qmmp*:
-```shell
-$ onlinesearch -s qmmp
-
-====================================================================================================
-Parameters: Engine: packman | Query: qmmp | Cache: On (2023-02-23 16:37)
-====================================================================================================
-    # |       Page       | Description 
-----------------------------------------------------------------------------------------------------
-    1 | qmmp             | Qt-based Multimedia Player
-----------------------------------------------------------------------------------------------------
-    2 | qmmp-plugin-pack | Extra plugins for Qmmp
-----------------------------------------------------------------------------------------------------
-
-====================================================================================================
-Parameters: Engine: opensuse | Query: qmmp | Cache: On (2023-02-23 16:37)
-====================================================================================================
-    # |              Page              | Description 
-----------------------------------------------------------------------------------------------------
-    1 | qmmp                            | Qt-based Multimedia Player
-----------------------------------------------------------------------------------------------------
-    2 | libqmmp1                        | Qmmp library
-----------------------------------------------------------------------------------------------------
-    3 | libqmmp-devel                   | Development files for libqmmp
-----------------------------------------------------------------------------------------------------
-...
-```
-
-We get among the results a page called *qmmp* for both engines, so to read that pages:
-```shell
-$ onlinesearch -p qmmp
-
-====================================================================================================
-Parameters:  Engine: packman | OS: openSUSE Leap 15.4 | Architecture: 64 Bit | Cache: On (2023-02-07 16:57)
-====================================================================================================
-Name:        qmmp
-Summary:     
-Description: 
-Qt-based Multimedia Player
-----------------------------------------------------------------------------------------------------
-    # | Version |  Repo   |        Distro       
-----------------------------------------------------------------------------------------------------
-    1 |   2.1.2 | Packman | openSUSE Leap 15.4
-----------------------------------------------------------------------------------------------------
-
-====================================================================================================
-Parameters:  Engine: opensuse | OS: openSUSE Leap 15.4 | Architecture: 64 Bit | Cache: On (2023-02-07 16:57)
-====================================================================================================
-Name:        qmmp
-Summary:     Qt-based Multimedia Player
-Description: This program is an audio-player, written with help of Qt library.
-----------------------------------------------------------------------------------------------------
-    # | Version |         Repo          |        Distro       
-----------------------------------------------------------------------------------------------------
-    1 |   2.1.2 | home:plater           | openSUSE Leap 15.4
-----------------------------------------------------------------------------------------------------
-    2 |   1.4.4 | home:ykoba:multimedia | openSUSE Leap 15.4
-----------------------------------------------------------------------------------------------------
-    3 |   2.1.2 | multimedia:apps       | openSUSE Leap 15.4
-----------------------------------------------------------------------------------------------------
-```
-
-To show the page from one engine only, just append the `--engine <engine_name>` param:
-```shell
-$ onlinesearch -p qmmp --engine opensuse
-```
-
-To list the links in the third repository listed in the *opensuse* engine:
-```shell
-$ onlinesearch -l qmmp,3 --engine opensuse
-
-====================================================================================================
-Parameters:  Engine: opensuse | OS: openSUSE Leap 15.4 | Architecture: 64 Bit | Cache: On (2023-02-07 16:57)
-====================================================================================================
-Name:        qmmp
-Summary:     Qt-based Multimedia Player
-Description: This program is an audio-player, written with help of Qt library.
-----------------------------------------------------------------------------------------------------
-    # | Format | Link
-----------------------------------------------------------------------------------------------------
-    1 |    ymp | https://software.opensuse.org/ymp/multimedia:apps/15.4/qmmp.ymp?base=openSUSE%3ALeap%3A15.4&query=qmmp
-----------------------------------------------------------------------------------------------------
-    2 |    src | https://download.opensuse.org/repositories/multimedia:/apps/15.4/src/qmmp-2.1.2-lp154.182.3.src.rpm
-----------------------------------------------------------------------------------------------------
-    3 | x86_64 | https://download.opensuse.org/repositories/multimedia:/apps/15.4/x86_64/qmmp-2.1.2-lp154.182.3.x86_64.rpm
-----------------------------------------------------------------------------------------------------
-```
-
-To print only the raw URLs:
-```shell
-$ onlinesearch -l qmmp,3 --urls
-https://software.opensuse.org/ymp/multimedia:apps/15.4/qmmp.ymp?base=openSUSE%3ALeap%3A15.4&query=qmmp
-https://download.opensuse.org/repositories/multimedia:/apps/15.4/src/qmmp-2.1.2-lp154.182.3.src.rpm
-https://download.opensuse.org/repositories/multimedia:/apps/15.4/x86_64/qmmp-2.1.2-lp154.182.3.x86_64.rpm
-```
-
-And in case we are interested to a specific format:
-```shell
-$ onlinesearch -l qmmp,3 --urls --format ymp
-https://software.opensuse.org/ymp/multimedia:apps/15.4/qmmp.ymp?base=openSUSE%3ALeap%3A15.4&query=qmmp
-```
-
 ## Get help
 
 Where to start:
@@ -156,7 +57,10 @@ $ onlinesearch --help
 ## More Help:
 
 More info is available at:
-- the [Zypper-Onlinesearch Project page][project_page].
+- the [Zypper-Onlinesearch Project page][project_page];
+- the [Zypper-Onlinesearch Github wiki][zypper_onlinesearch_wiki].
 
 [project_page]: https://freeaptitude.altervista.org/projects/zypper-onlinesearch.html "Zypper-Onlinesearch project page"
-
+[zypper_onlinesearch_wiki]: https://github.com/fabiomux/zypper-onlinesearch/wiki "Zypper-Onlinesearch wiki page on GitHub"
+[wf_main]: https://github.com/fabiomux/zypper-onlinesearch/actions/workflows/main.yml
+[gem_version]: https://badge.fury.io/rb/zypper-onlinesearch

data/Rakefile

@@ -1,6 +1,12 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/zypper/onlinesearch/cache.rb

@@ -1,40 +1,39 @@
-require 'fileutils'
-require 'uri'
+# frozen_string_literal: true
+
+require "fileutils"
+require "uri"
 
 module Zypper
   module Onlinesearch
-
+    #
+    # Handles the cached data.
+    #
     class Cache
-
       def initialize(operation, engine)
-        @base_folder = File.join(ENV['HOME'], '.cache', 'zypper-onlinesearch', engine, operation)
-        FileUtils.mkdir_p @base_folder unless Dir.exists? @base_folder
+        @base_folder = File.join(Dir.home, ".cache", "zypper-onlinesearch", engine, operation)
+        FileUtils.mkdir_p @base_folder
       end
 
       def set(query, response)
-        File.open(File.join(@base_folder, query_to_filename(query)), 'w+') do |f|
-          f.write Marshal.dump(response)
-        end
+        File.write(File.join(@base_folder, query_to_filename(query)), Marshal.dump(response))
       end
 
       def get(query)
         fname = query_to_filename(query)
-        Marshal.load(File.read(File.join(@base_folder, fname))) if exists? query
+        Marshal.load(File.read(File.join(@base_folder, fname))) if exist? query
       end
 
-      def exists?(query)
-        File.exists?(File.join(@base_folder, query_to_filename(query)))
+      def exist?(query)
+        File.exist?(File.join(@base_folder, query_to_filename(query)))
       end
 
       def self.reset!
-        base_folder = File.join(ENV['HOME'], '.cache', 'zypper-onlinesearch')
-        if Dir.exist? base_folder
-          size = Dir.glob(File.join(base_folder, '**', '*')).map{ |f| File.size(f) }.inject(:+)
-          FileUtils.remove_dir base_folder
-          return size
-        else
-          raise EmptyCache
-        end
+        base_folder = File.join(Dir.home, ".cache", "zypper-onlinesearch")
+        raise EmptyCache unless Dir.exist? base_folder
+
+        size = Dir.glob(File.join(base_folder, "**", "*")).map { |f| File.size(f) }.inject(:+)
+        FileUtils.remove_dir base_folder
+        size
       end
 
       def mtime(query)
@@ -45,10 +44,8 @@ module Zypper
       private
 
       def query_to_filename(query)
-        URI.encode query.delete('./')
+        URI.encode query.delete("./")
       end
     end
-
   end
 end
-

data/lib/zypper/onlinesearch/cli.rb

@@ -1,162 +1,164 @@
-require 'optparse'
-require 'ostruct'
-require 'zypper/onlinesearch'
-require 'zypper/onlinesearch/version'
+# frozen_string_literal: true
 
-module Zypper
+require "optparse"
+require "zypper/onlinesearch"
+require "zypper/onlinesearch/version"
 
+module Zypper
   module Onlinesearch
-
+    #
+    # Parsing the input data.
+    #
     class OptParseMain
-
       def self.parse(args)
-        options = OpenStruct.new
+        options = Struct.new(:operation, :query, :refresh, :engine, :timeout, :formats,
+                             :distributions, :types, :number, :view, :format).new
         options.operation = :search
-        options.query = ''
+        options.query = ""
         options.refresh = false
         options.engine = :all # :opensuse, :packman
         options.timeout = 20
         options.formats = :compatible # :all
         options.distributions = :compatible # :all
-        options.types = [:supported, :community, :experimental]
+        options.types = %i[supported community experimental unsupported]
         options.number = 0
         options.view = :table
         options.format = :all # or single format
-        #options.preload = nil #used by :links or :page operations
+        # options.preload = nil #used by :links or :page operations
 
         opt_parser = OptionParser.new do |opt|
+          command = ENV["ZYPPER_ONLINESEARCH"] ? "zypper onlinesearch" : "onlinesearch"
+          opt.banner = "Usage: #{command} [OPTIONS] [OPERATION]"
 
-          if ENV['ZYPPER_ONLINESEARCH']
-            opt.banner = 'Usage: zypper onlinesearch [OPTIONS] [OPERATION]'
-          else
-            opt.banner = 'Usage: onlinesearch [OPTIONS] [OPERATION]'
-          end
-
-          opt.separator ''
-          opt.separator 'Operations:'
+          opt.separator ""
+          opt.separator "Operations:"
 
-          opt.on('-s', '--search <STRING>', 'Search for STRING to the online engines available') do |o|
+          opt.on("-s", "--search <STRING>", "Search for STRING to the online engines available") do |o|
             options.operation = :search
             options.query = o
           end
 
-          opt.on('-p', '--page <PAGE_NAME>', 'Get info about the PAGE_NAME') do |o|
+          opt.on("-p", "--page <PAGE_NAME>", "Get info about the PAGE_NAME") do |o|
             options.operation = :page
             options.query = o
           end
 
-          opt.on('-l', '--links <PAGE_NAME>,<NTH>', Array, 'Print all the links of the NTH item in the PAGE_NAME') do |o|
+          opt.on("-l", "--links <PAGE_NAME>,<NTH>", Array,
+                 "Print all the links of the NTH item in the PAGE_NAME") do |o|
             options.operation = :links
             options.query = o[0]
             options.number = o[1].to_i
-            #options.preload = :page
+            # options.preload = :page
           end
 
-          opt.on('--clean-cache', 'Clean the whole cache') do |o|
+          opt.on("--clean-cache", "Clean the whole cache") do
             options.operation = :cache_clean
           end
 
-          opt.separator ''
-          opt.separator 'General Options'
+          opt.separator ""
+          opt.separator "General Options"
 
-          opt.on('--engine <ENGINE>', 'Use only ENGINE to search for (default: ' + options.engine.to_s + ', alternatives: ' + Request::Search.constants.map(&:to_s).map(&:downcase).join(', ')  + ')') do |o|
+          alt = Request::Search.constants.map(&:to_s).map(&:downcase).join(", ")
+          opt.on("--engine <ENGINE>",
+                 "Use only ENGINE to search for (default: #{options.engine}, alternatives: #{alt})") do |o|
             options.engine = o.to_sym
           end
 
-          opt.on('--refresh', 'Refresh the cached values.') do |o|
+          opt.on("--refresh", "Refresh the cached values.") do
             options.refresh = true
           end
 
-          opt.on('--timeout <SECONDS>', "Adjust the waiting SECONDS used to catch an HTTP Timeout Error (Default: #{options.timeout})") do |o|
+          opt.on("--timeout <SECONDS>", "The SECONDS before an HTTP Timeout Error (Default: #{options.timeout})") do |o|
             options.timeout = o.to_f
           end
 
-          opt.separator ''
-          opt.separator 'View options:'
+          opt.separator ""
+          opt.separator "View options:"
 
-          opt.on('--table', 'Show the results as a table [DEFAULT]') do |o|
+          opt.on("--table", "Show the results as a table [DEFAULT]") do
             options.view = :table
           end
 
-          opt.on('--report', 'Show the results as report') do |o|
+          opt.on("--report", "Show the results as report") do
             options.view = :report
           end
 
-          opt.separator ''
+          opt.separator ""
           opt.separator '"Page" and "Links" options:'
 
-          opt.on('--all-formats', 'Show all the available formats') do |o|
+          opt.on("--all-formats", "Show all the available formats") do
             options.formats = :all
           end
 
-          opt.on('--all-distributions', 'Show all the available distributions') do |o|
+          opt.on("--all-distributions", "Show all the available distributions") do
             options.distributions = :all
           end
 
-          opt.on('--no-supported', 'Hide supported packages.') do |o|
+          opt.on("--no-supported", "Hide supported packages.") do
             options.types.delete :supported
           end
 
-          opt.on('--no-experimental', 'Hide experimental packages.') do |o|
+          opt.on("--no-experimental", "Hide experimental packages.") do
             options.types.delete :experimental
           end
 
-          opt.on('--no-community', 'Hide community packages.') do |o|
+          opt.on("--no-community", "Hide community packages.") do
             options.types.delete :community
           end
 
-          opt.separator ''
+          opt.on("--no-unsupported", "Hide unsupported packages.") do
+            options.types.delete :unsupported
+          end
+
+          opt.separator ""
           opt.separator '"Links" options:'
 
-          opt.on('--format FORMAT', 'Filter for packages with the specified FORMAT') do |o|
+          opt.on("--format FORMAT", "Filter for packages with the specified FORMAT") do |o|
             options.format = o.to_sym
           end
 
-          opt.on('--urls', 'Show only the urls without headers') do |o|
+          opt.on("--urls", "Show only the urls without headers") do
             options.view = :urls
           end
 
-          unless ENV['ZYPPER_ONLINESEARCH']
-            opt.separator ''
-            opt.separator 'Other:'
+          unless ENV["ZYPPER_ONLINESEARCH"]
+            opt.separator ""
+            opt.separator "Other:"
 
-            opt.on_tail('-h', '--help', 'Show this message') do |o|
+            opt.on_tail("-h", "--help", "Show this message") do
               puts opt
               exit
             end
 
-            opt.on_tail('-v', '--version', 'Show version') do |o|
+            opt.on_tail("-v", "--version", "Show version") do
               puts VERSION
               exit
             end
           end
-
         end
 
-
         if ARGV.empty?
-          puts opt_parser; exit
+          puts opt_parser
+          exit
         else
-          opt_parser.parse!(ARGV)
+          opt_parser.parse!(args)
         end
 
         options
       end
     end
 
-
+    #
+    # Interface class to run the application.
+    #
     class CLI
       def self.start
-        begin
-          options = OptParseMain.parse(ARGV)
-          Onlinesearch::Builder.new(options).send(options.operation)
-         rescue => e
-           Messages.error e
-           exit e.error_code
-         end
+        options = OptParseMain.parse(ARGV)
+        Onlinesearch::Builder.new(options).send(options.operation)
+      rescue StandardError => e
+        Messages.error e
+        exit e.error_code
       end
     end
-
   end
 end
-