carioca 2.0.12 → 2.1.1

data/lib/carioca/services/toolbox.rb

@@ -0,0 +1,104 @@
+# coding: utf-8
+
+# 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
+
+            # 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
+                else
+                    return false
+                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
+
+            # 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
+    end
+end

data/samples/config/carioca.registry

@@ -1,19 +1,4 @@
 ---
-:toto:
-  :type: :gem
-  :description: The toto service
-  :service: Toto
-  :resource: toto
-  :depends:
-  - :configuration
-:sqdqd:
-  :type: :internal
-  :description: The sqdqd service
-  :service: SQP::new('titi')
-  :depends:
-  - :configuration
-  - :logger
-  - :toto
 :uuid:
   :type: :gem
   :description: The uuid service

data/samples/config/locales/en.yml

@@ -1,2 +1,3 @@
 en:
-  test: 'english'
+  test: 'english'
+  fallback: "english fallback"

data/samples/config/settings.yml

@@ -1,5 +1,5 @@
 ---
-:monappli:
+:myappli:
   :production: {}
   :staging:
     :onstaging: staging
@@ -12,13 +12,36 @@
       :trunk2:
         :branch3: leaf3
         :branch4: leaf4
-        :branch5: [ "toto","titi","tata" ] 
+        :branch5: [ "val1","val2","val3" ] 
   :default:
-    :toto: 'titi'
+    :default_value: 'value'
     :treeA:
       :trunk1:
         :branch2: leaf2
       :trunk2:
-        :branch5: ["tutu"]
-
-    
+        :branch5: ["value"]
+    :setup:
+      :rules:
+        - :action: :install_file
+          :source: "samples/config/settings.yml"
+          :target: "/tmp/settings.yml"
+        - :action: :install_file
+          :source: "samples/config/carioca.registry"
+          :target: "/tmp/carioca.registry"
+          :mode: "755"
+        - :action: :make_folder
+          :path: /tmp/toto
+          :mode: "755"
+        - :action: :make_link
+          :source: /tmp/settings.yml
+          :link: /tmp/application.yml
+    :sanitycheck:
+      :rules:
+        - :test: :verify_file
+          :name: "/tmp/carioca.registry"
+          :mode: "644"
+        - :test: :verify_folder
+          :name: "/tmp/toto"
+          :mode: "755"
+        - :test: :verify_link
+          :name: "/tmp/application.yml"

data/samples/test.rb

@@ -3,33 +3,36 @@
 require 'rubygems'
 require 'carioca'
 
+# Configuration of Carioca
 Carioca::Registry.configure do |spec|
   spec.filename = './config/carioca.registry'
-  spec.debug = true
+  spec.debug = false
   spec.init_from_file = true
-  #    spec.log_file = '/tmp/test.rge'
+  spec.log_file = '/tmp/test.rge'
   spec.config_file = './config/settings.yml'
-  spec.config_root = :monappli
+  spec.config_root = :myappli
   spec.environment = :development
   spec.default_locale = :fr
   spec.log_level = :debug
-  spec.output_mode = :mono
+  spec.output_mode = :dual
   spec.output_emoji = true
   spec.output_colors = true
   spec.locales_load_path << Dir["#{File.expand_path('./config/locales')}/*.yml"]
   spec.debugger_tracer = :output
 end
 
+# test fo internal specific service
 class MyService
   extend Carioca::Injector
   inject service: :logger
+  inject service: :output
 
   def initialize
     logger.warn(self.class.to_s) { 'Init service' }
   end
 
   def hello
-    logger.info(self.class.to_s) { 'Hello World' }
+    output.info 'Hello World'
   end
 
   def method_test(_titi, tutu:)
@@ -44,21 +47,42 @@ spec = {
   type: :internal
 }
 
+
+puts "\nTest 1 : access to registry : adding a internal service MyService"
 Carioca::Registry.init.add service: :myservice, definition: spec
 
+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
+
+
 
-logger.info(to_s) { "avaible services : #{Carioca::Registry.get.services.keys} " }
+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|
+  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
-p i18n.t(:test)
+  output.item i18n.t(:fallback)
+i18n.locale = :en
 
+puts "\nTest 5 : Service Configuration test merge runtime form config file"
 config = Carioca::Registry.get.get_service name: :configuration
+pp config.settings.to_h
 config.settings.newkey = 'value'
 
-logger.info(to_s) { config.settings }
 
-class MonAppli < Carioca::Container
+# template override sample
+class MyAppli < Carioca::Container
   def test
     myservice.hello
     logger.warn(self.class.to_s) { uuid.generate }
@@ -74,17 +98,21 @@ class MonAppli < 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"
     cycle.each do |verb|
       output.send verb, verb.to_s
     end
+    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"
     output.emoji = false
     cycle.each do |verb|
       output.send verb, verb.to_s
     end
+    puts "*** color and no-Emoji"
     output.color = true
     cycle.each do |verb|
       output.send verb, verb.to_s
@@ -99,7 +127,79 @@ class MonAppli < Carioca::Container
   end
 end
 
-appli = MonAppli.new
+appli = MyAppli.new
+puts "\nTest 6 : Carioca::Container template and registry file service defined usage (UUID) from gem"
 appli.test
-# appli.test2
+puts "\nTest 7 : Service output display mode on STDOUT"
+appli.test2
+puts "\nTest 8 : Service debugger display mode on STDOUT"
 appli.test3
+
+output.emoji = true
+output.color = true
+
+puts "\nTest 9 : Service toolbox list of avaibles methodes"
+toolbox = Carioca::Registry.get.get_service name: :toolbox
+pp toolbox.describe
+
+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')
+
+puts "\nTest 12 : Service setup execute setup schema from configuration"
+setup = Carioca::Registry.get.get_service name: :setup
+setup.execute!
+
+puts "\nTest 13 : Service sanitycheck run checking schema from configuration"
+sanitycheck = Carioca::Registry.get.get_service name: :sanitycheck
+sanitycheck.run
+
+puts "\nTest 14 : Service SecureStore init or access"
+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 "\nTest 16 : Service SecureStore setting new data"
+securestore.data[:time] = Time.now
+securestore.save!
+
+puts "\nTest 17 : Service finisher : test all cases"
+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"
+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"
+end
+puts 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
+
+puts "\nTest 18 : Service finisher : exit case in success"
+i18n.locale = :fr
+finisher.secure_execute! exit_case: :success_exit do 
+  puts 'finishing action'
+  #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.0.12
+  version: 2.1.1
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -164,6 +164,20 @@ 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
@@ -178,6 +192,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: ps-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: cyclonedx-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: 'Carioca 2: is a complete rewrite who provide a full IoC/DI light Container
   and a services registry, build with logs, config and Internationalization facilities
   for designing your applications'
@@ -187,18 +229,33 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".debride_withelist"
 - ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
+- assets/images/carioca_output_emoji_colors.PNG
+- assets/images/carioca_output_emoji_no_colors.PNG
+- assets/images/carioca_output_no_emoji_colors.PNG
+- assets/images/carioca_output_no_emoji_no_colors.PNG
+- assets/images/description_carioca.png
+- assets/images/description_configuration_carioca.png
+- assets/images/description_container_carioca.png
+- assets/images/description_registry_carioca.png
+- assets/images/description_services_carioca.png
 - assets/images/logo_carioca.png
+- assets/images/logo_carioca_full_large.png
+- assets/images/logo_carioca_full_small.png
+- assets/images/logo_carioca_light_small.png
 - bin/console
 - bin/setup
+- bom.xml
 - carioca.gemspec
 - config/locales/en.yml
 - config/locales/fr.yml
@@ -217,9 +274,14 @@ files:
 - lib/carioca/registry_file.rb
 - lib/carioca/services/config.rb
 - lib/carioca/services/debug.rb
+- lib/carioca/services/finisher.rb
 - lib/carioca/services/i18n.rb
 - lib/carioca/services/init.rb
 - lib/carioca/services/output.rb
+- lib/carioca/services/sanitycheck.rb
+- lib/carioca/services/securestore.rb
+- lib/carioca/services/setup.rb
+- lib/carioca/services/toolbox.rb
 - lib/carioca/validator.rb
 - lib/carioca/version.rb
 - samples/Rakefile