carioca 2.1.4 → 2.1.5

data/lib/carioca/services/toolbox.rb

@@ -1,104 +1,103 @@
-# coding: utf-8
+# frozen_string_literal: true
 
 # base Carioca namespace
 module Carioca
-    
-    module Services
-        
-        # Exiter namespace
-        class Toolbox
-            
-            def self.describe
-                result = {}
-                self.methods(false).each do |meth|
-                    next if meth == :describe
-                    result[meth] = self.send meth, **{describe: true}
-                end
-                return result
-            end
+  module Services
+    # Exiter namespace
+    class Toolbox
+      def self.describe
+        result = {}
+        methods(false).each do |meth|
+          next if meth == :describe
 
-            # return the 'root' name
-            # @return [String] name
-            def self.user_root(description: "Get the local system root username ", describe: false)
-                return description if describe
-                return Etc.getpwuid(0).name
-            end
-            
-            # return the 'root' group name : root or wheel
-            # @return [String] name
-            def self.group_root(description: "Get the local system root groupname ", describe: false)
-                return description if describe
-                return Etc.getgrgid(0).name
-            end
-            
-            # facility for retreiving PID from process query
-            # @option  [String] :pattern a regexp to search
-            # @option  [Array] :patterns an array of regexp to search
-            # @option  [Bool] :full flag to retrieve all process data not only PID
-            # @return [String|Array] PID or data structure
-            def self.get_processes(patterns: [], pattern: nil, full: false, description: "Get the list of running processus", describe: false)
-                return description if describe
-                patterns << pattern if pattern
-                res = ::PS.get_all_processes
-                patterns.each do |item|
-                    res = res.find_processes item
-                end
-                if full then
-                    return res
-                else
-                    return res.pick_attr('PID')
-                end
-            end
-            
-            
-            # facility to find a file in gem path
-            # @param [String] _gem a Gem name
-            # @param [String] _file a file relative path in the gem
-            # @return [String] the path of the file, if found.
-            # @return [False] if not found
-            def self.search_file_in_gem(_gem=nil,_file=nil, description: "Retrieve absolute path of a file in a specific gem", describe: false)
-                return description if describe
-                if Gem::Specification.respond_to?(:find_by_name)
-                    begin
-                        spec = Gem::Specification.find_by_name(_gem)
-                    rescue LoadError
-                        spec = nil
-                    end
-                else
-                    spec = Gem.searcher.find(_gem)
-                end
-                if spec then
-                    if Gem::Specification.respond_to?(:find_by_name)
-                        res = spec.lib_dirs_glob.split('/')
-                    else
-                        res = Gem.searcher.lib_dirs_for(spec).split('/')
-                    end
-                    res.pop
-                    services_path = res.join('/').concat("/#{_file}")
-                    return services_path if File::exist?(services_path)
-                    return false
+          result[meth] = send meth, describe: true
+        end
+        result
+      end
+
+      # return the 'root' name
+      # @return [String] name
+      def self.user_root(description: 'Get the local system root username ', describe: false)
+        return description if describe
+
+        Etc.getpwuid(0).name
+      end
+
+      # return the 'root' group name : root or wheel
+      # @return [String] name
+      def self.group_root(description: 'Get the local system root groupname ', describe: false)
+        return description if describe
+
+        Etc.getgrgid(0).name
+      end
+
+      # facility for retreiving PID from process query
+      # @option  [String] :pattern a regexp to search
+      # @option  [Array] :patterns an array of regexp to search
+      # @option  [Bool] :full flag to retrieve all process data not only PID
+      # @return [String|Array] PID or data structure
+      def self.get_processes(patterns: [], pattern: nil, full: false, description: 'Get the list of running processus', describe: false)
+        return description if describe
+
+        patterns << pattern if pattern
+        res = ::PS.get_all_processes
+        patterns.each do |item|
+          res = res.find_processes item
+        end
+        if full
+          res
+        else
+          res.pick_attr('PID')
+        end
+      end
+
+      # facility to find a file in gem path
+      # @param [String] _gem a Gem name
+      # @param [String] _file a file relative path in the gem
+      # @return [String] the path of the file, if found.
+      # @return [False] if not found
+      def self.search_file_in_gem(gem: nil, file: nil, description: 'Retrieve absolute path of a file in a specific gem', describe: false)
+        return description if describe
+
+        if Gem::Specification.respond_to?(:find_by_name)
+          begin
+            spec = Gem::Specification.find_by_name(gem)
+          rescue LoadError
+            spec = nil
+          end
+        else
+          spec = Gem.searcher.find(gem)
+        end
+        if spec
+          res = if Gem::Specification.respond_to?(:find_by_name)
+                  spec.lib_dirs_glob.split('/')
                 else
-                    return false
+                  Gem.searcher.lib_dirs_for(spec).split('/')
                 end
-            end
-            
-            
-            
-            # facility to verifying if the active process run as root
-            # @return [Bool] status
-            def self.is_root?(description: "Verify if active current processus is running as root", describe: false)
-                return description if describe
-                return Process.uid == 0
-            end
+          res.pop
+          services_path = res.join('/').concat("/#{file}")
+          return services_path if File.exist?(services_path)
 
-            # check if unicode must be used with term ENV
-            # @return [Boolean]
-            def self.check_unicode_term(description: "Check if terminal support unicode", describe: false)
-                return description if describe
-                return false unless ENV.include? "TERM"
-                return (ENV.values_at("LC_ALL","LC_CTYPE","LANG").compact.include?("UTF-8") and ENV.values_at('TERM').include? "xterm")
-            end
-                    
         end
+        false
+      end
+
+      # facility to verifying if the active process run as root
+      # @return [Bool] status
+      def self.root?(description: 'Verify if active current processus is running as root', describe: false)
+        return description if describe
+
+        Process.uid.zero?
+      end
+
+      # check if unicode must be used with term ENV
+      # @return [Boolean]
+      def self.check_unicode_term(description: 'Check if terminal support unicode', describe: false)
+        return description if describe
+        return false unless ENV.include? 'TERM'
+
+        (ENV.values_at('LC_ALL', 'LC_CTYPE', 'LANG').compact.include?('UTF-8') and ENV.values_at('TERM').include? 'xterm')
+      end
     end
+  end
 end

data/samples/Gemfile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-gem "carioca", "~> 2.1"
+gem 'carioca', '~> 2.1'
 
-gem "uuid", "~> 2.3"
+gem 'uuid', '~> 2.3'

data/samples/test.rb

@@ -47,7 +47,6 @@ spec = {
   type: :internal
 }
 
-
 puts "\nTest 1 : access to registry : adding a internal service MyService"
 Carioca::Registry.init.add service: :myservice, definition: spec
 
@@ -55,24 +54,21 @@ puts "\nTest 2 : list of avaible services : MyService include"
 logger = Carioca::Registry.get.get_service name: :logger
 logger.info(to_s) { "Available services : #{Carioca::Registry.get.services.keys} " }
 
-
 puts "\nTest 3 : using MyService "
 myservice = Carioca::Registry.get.get_service name: :myservice
 myservice.hello
 
-
-
 puts "\nTest 4 : Service I18n test :es, :fr, come back :en vi service output"
 i18n = Carioca::Registry.get.get_service name: :i18n
 output = Carioca::Registry.get.get_service name: :output
-[:es,:fr,:en].each do |locale|
+%i[es fr en].each do |locale|
   i18n.locale = locale
   output.item i18n.t(:test)
 end
 
 puts "\nTest 5 : Service I18n test fallback :en on local :es for missing :es locale"
 i18n.locale = :es
-  output.item i18n.t(:fallback)
+output.item i18n.t(:fallback)
 i18n.locale = :en
 
 puts "\nTest 5 : Service Configuration test merge runtime form config file"
@@ -80,7 +76,6 @@ config = Carioca::Registry.get.get_service name: :configuration
 pp config.settings.to_h
 config.settings.newkey = 'value'
 
-
 # template override sample
 class MyAppli < Carioca::Container
   def test
@@ -98,21 +93,21 @@ class MyAppli < Carioca::Container
   def test2
     cycle = %i[unknown fatal error ko warn info item arrow scheduling trigger sending calling receive
                ok success debug flat]
-    puts  "*** color and Emoji"
+    puts  '*** color and Emoji'
     cycle.each do |verb|
       output.send verb, verb.to_s
     end
-    puts "*** no-color and Emoji"
+    puts '*** no-color and Emoji'
     output.color = false
     cycle.each do |verb|
       output.send verb, verb.to_s
     end
-    puts "*** no-color and no-Emoji"
+    puts '*** no-color and no-Emoji'
     output.emoji = false
     cycle.each do |verb|
       output.send verb, verb.to_s
     end
-    puts "*** color and no-Emoji"
+    puts '*** color and no-Emoji'
     output.color = true
     cycle.each do |verb|
       output.send verb, verb.to_s
@@ -138,7 +133,7 @@ appli.test3
 output.emoji = true
 output.color = true
 
-puts "\nTest 9 : Service toolbox list of avaibles methodes"
+puts "\nTest 9 : Service toolbox list of availables methodes"
 toolbox = Carioca::Registry.get.get_service name: :toolbox
 pp toolbox.describe
 
@@ -146,7 +141,7 @@ puts "\nTest 10 : Service toolbox test of simple methode : :user_root"
 pp toolbox.user_root
 
 puts "\nTest 11 : Service toolbox test of simple methode : :search_file_in_gem"
-pp toolbox.search_file_in_gem('carioca','config/locales/en.yml')
+pp toolbox.search_file_in_gem(gem: 'carioca', file: 'config/locales/en.yml')
 
 puts "\nTest 12 : Service setup execute setup schema from configuration"
 setup = Carioca::Registry.get.get_service name: :setup
@@ -157,61 +152,59 @@ sanitycheck = Carioca::Registry.get.get_service name: :sanitycheck
 sanitycheck.run
 
 puts "\nTest 14 : Service SecureStore init or access"
-puts "skipped"
-#securestore = Carioca::Registry.get.get_service name: :securestore
-
+puts 'skipped'
+# securestore = Carioca::Registry.get.get_service name: :securestore
 
 puts "\nTest 15 : Service SecureStore getting previous data"
-#res = (securestore.data.empty?)? "first time" : securestore.data.to_s
-#output.info res
-puts "skipped"
+# res = (securestore.data.empty?)? "first time" : securestore.data.to_s
+# output.info res
+puts 'skipped'
 
 puts "\nTest 16 : Service SecureStore setting new data"
-#securestore.data[:time] = Time.now
-#securestore.save!
-puts "skipped"
+# securestore.data[:time] = Time.now
+# securestore.save!
+puts 'skipped'
 
 puts "\nTest 17 : Service finisher : test all cases"
-output.item "flat api return, no-json, no-structured"
+output.item 'flat api return, no-json, no-structured'
 finisher = Carioca::Registry.get.get_service name: :finisher
-test = finisher.secure_api_return(return_case: :status_ok, structured: false, json: false) do 
- "test"
+test = finisher.secure_api_return(return_case: :status_ok, structured: false, json: false) do
+  'test'
 end
 puts test
 
-output.item "api return, no-json, no-structured but with secure_raise"
-test = finisher.secure_api_return(return_case: :status_ok, structured: false, json: false) do 
-  finisher.secure_raise message: "error !", error_case: :status_ko
-  "test"
- end
- puts test
-
- output.item "api return, json, structured but with secure_raise"
-test = finisher.secure_api_return(return_case: :status_ok, structured: true, json: true) do 
-  finisher.secure_raise message: "error !", error_case: :status_ko
- "test"
+output.item 'api return, no-json, no-structured but with secure_raise'
+test = finisher.secure_api_return(return_case: :status_ok, structured: false, json: false) do
+  finisher.secure_raise message: 'error !', error_case: :status_ko
+  'test'
+end
+puts test
+
+output.item 'api return, json, structured but with secure_raise'
+test = finisher.secure_api_return(return_case: :status_ok, structured: true, json: true) do
+  finisher.secure_raise message: 'error !', error_case: :status_ko
+  'test'
 end
 puts test[:status]
 puts test[:data]
 
-output.item "api return, json, structured"
-test = finisher.secure_api_return(return_case: :status_ok, structured: true, json: true) do 
-   "test"
+output.item 'api return, json, structured'
+test = finisher.secure_api_return(return_case: :status_ok, structured: true, json: true) do
+  'test'
 end
 puts test[:status]
 puts test[:data]
 
-
-output.item "api return, json, structured with status=false"
-test = finisher.secure_api_return(return_case: :status_ok, structured: true, json: true, status: false) do 
-   "test"
+output.item 'api return, json, structured with status=false'
+test = finisher.secure_api_return(return_case: :status_ok, structured: true, json: true, status: false) do
+  'test'
 end
 puts test
 
 puts "\nTest 18 : Service finisher : exit case in success"
 i18n.locale = :fr
-finisher.secure_execute! exit_case: :success_exit do 
+finisher.secure_execute! exit_case: :success_exit do
   puts 'finishing action'
-  #finisher.secure_raise message: "error !", error_case: :status_ko
+  # finisher.secure_raise message: "error !", error_case: :status_ko
   'message'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carioca
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.5
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-15 00:00:00.000000000 Z
+date: 2024-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.23.1
+- !ruby/object:Gem::Dependency
+  name: bundle-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: code_statistics
   requirement: !ruby/object:Gem::Requirement
@@ -164,20 +178,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: bundle-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: version
   requirement: !ruby/object:Gem::Requirement
@@ -308,7 +308,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 3.2.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="