carioca 2.0.2 → 2.0.5

data/lib/carioca/container.rb

@@ -1,16 +1,14 @@
+# frozen_string_literal: true
 
 module Carioca
-    class Container
+  class Container
+    extend Carioca::Injector
 
-        extend Carioca::Injector
-
-        inject service: :logger
-        inject service: :configuration
-
-        def initialize(name: 'Carioca')
-            @name = name
-        end
+    inject service: :logger
+    inject service: :configuration
 
+    def initialize(name: 'Carioca')
+      @name = name
     end
-
+  end
 end

data/lib/carioca/dependencies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml'
 require 'forwardable'
 require 'singleton'
@@ -8,11 +10,11 @@ require 'locale'
 require 'deep_merge'
 require 'pastel'
 
+require_relative 'helpers'
 require_relative 'constants'
 require_relative 'validator'
 require_relative 'mixin'
 require_relative 'container'
-require_relative 'helpers'
 require_relative 'configuration'
 
 require_relative 'registry_file'

data/lib/carioca/helpers.rb

@@ -1,48 +1,46 @@
-module Carioca
-    module Helpers
+# frozen_string_literal: true
 
-        def log
-            return self.get_service name: :logger
-        end
+module Carioca
+  module Helpers
+    def log
+      get_service name: :logger
+    end
 
-        def i18n
-            return self.get_service name: :i18n
-        end
+    def i18n
+      get_service name: :i18n
+    end
 
-        def debug(message: )
-            log.debug(self.config.name) { "#{message}" } 
-        end
+    def debug(message:)
+      log.debug(config.name) { message.to_s }
+    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 search_file_in_gem(_gem,_file)
-            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
+    # 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 search_file_in_gem(gem, file)
+      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
+                Gem.searcher.lib_dirs_for(spec).split('/')
+              end
+        res.pop
+        services_path = res.join('/').concat("/#{file}")
+        return services_path if File.exist?(services_path)
 
-
+      end
+      false
     end
-end
+  end
+end

data/lib/carioca/mixin.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 module Carioca
   module Injector
-    def inject(service: )              
-        self.create_methods(service){return Carioca::Registry.get.get_service name: service }
+    def inject(service:)
+      create_methods(service) { return Carioca::Registry.get.get_service name: service }
     end
 
-    def register(service: , definition:)
-      Carioca::Registry.get.add service: service, definition: definition 
+    def register(service:, definition:)
+      Carioca::Registry.get.add service: service, definition: definition
     end
 
     def services
@@ -14,19 +16,15 @@ module Carioca
 
     def active_services
       Carioca::Registry.get.active_services
-     end
+    end
 
     def create_methods(name, &block)
-      self.define_method name, &block
+      define_method name, &block
       self.class.send(:define_method, name, &block)
     end
 
     def self.extended(base)
       base.include self
-     end
-    
-     
-
+    end
   end
-  
-end
+end

data/lib/carioca/rake/manage.rb

@@ -1,7 +1,10 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 require 'rake'
 require 'rubygems'
 require 'carioca'
+require 'tty-prompt'
+require 'pastel'
 
 $VERBOSE = nil
 if Gem::Specification.respond_to?(:find_by_name)
@@ -9,7 +12,7 @@ if Gem::Specification.respond_to?(:find_by_name)
     spec = Gem::Specification.find_by_name('carioca')
     res = spec.lib_dirs_glob.split('/')
   rescue LoadError
-    spec = nil
+    res = []
   end
 else
   spec = Gem.searcher.find('carioca')

data/lib/carioca/rake/tasks/config.tasks

@@ -0,0 +1,46 @@
+namespace :carioca do
+     namespace :services do
+         namespace :config do 
+            desc "Initialise Service configuration file ./config/settings.yml file"
+            task :init do 
+                begin
+                    prompt = TTY::Prompt.new
+                    pastel = ::Pastel.new
+
+                    if File::exist? "./config/settings.yml" then 
+                        puts pastel.yellow "WARNING : config file already exist, if you continue, you will destroy it !"
+                        continue = prompt.yes?("continue ? ") do |q|
+                            q.default false
+                        end
+                        print "Carioca : "                            
+                        unless continue then 
+                            puts pastel.yellow "canceled"
+                            exit 5
+                        else
+                            File::unlink "./config/settings.yml"
+                            puts pastel.cyan "Reset File"
+                        end
+                    end
+
+                    unless File::exist? "./config" then
+                        puts pastel.red "Carioca is not initialized for Gem usage, perhaps need to run :"
+                        puts pastel.red "$ rake carioca:gem:init_path"
+                        exit 10
+                    end
+                    puts "Carioca : initializing default config file (./config/settings.yml): "
+                    root = prompt.ask("Root config name ? (like your gem/App name)") { |q| 
+                        q.modify :down
+                        q.required true }.to_sym
+                    print "Carioca : Generating config file : "
+                    structure = {root => {:production => {}, :staging => {}, :development => {}, :test => {}, :default => {}}}
+                    File.open('./config/settings.yml', 'w') { |file| file.write(structure.to_yaml) } 
+                    puts pastel.green 'done'
+                rescue TTY::Reader::InputInterrupt
+                    print "Carioca : "
+                    puts pastel.yellow 'interrupted'
+                   exit 5
+                end
+            end
+        end
+    end
+end

data/lib/carioca/rake/tasks/gem.tasks

@@ -0,0 +1,15 @@
+namespace :carioca do
+     namespace :gem do
+        desc "prepare Gem vitals path for Carioca"
+        task :init_path do 
+            pastel = Pastel.new
+            if File::exist? "./config/locales"
+                puts pastel.yellow "Carioca path already initialized"
+            else
+                print 'Carioca : Initialising vitals gem path : '
+                FileUtils.mkdir_p "./config/locales"
+                puts pastel.green "done"
+            end
+        end
+    end
+end

data/lib/carioca/rake/tasks/registry.tasks

@@ -1,15 +1,18 @@
-require "tty-prompt"
-require "pastel"
-
 namespace :carioca  do
     namespace :registry do 
         desc "Adding service to Carioca Registry file"
         task :add_service do
+        prompt = TTY::Prompt.new
+            pastel = ::Pastel.new
             begin 
+                unless File::exist? "./config" then
+                
+                    puts pastel.yellow "Carioca is not initialized for Gem usage, perhaps need to run :"
+                    puts pastel.yellow "$ rake carioca:gem:init_path"
+                    exit unless prompt.yes?("Do you want to continue, with a standalone registry (not recommanded). ? ")
+                end
                 puts "Carioca : registering service :"
                 config = Carioca::Configuration::new
-                prompt = TTY::Prompt.new
-                pastel = Pastel.new
                 filename = prompt.ask("Registry File path ?", default: config.filename)
                 registry_file = Carioca::RegistryFile::new filename: filename
                 name = prompt.ask("Service name ?") { |q| q.required true }.to_sym
@@ -36,22 +39,26 @@ namespace :carioca  do
                 end
                 is_correct = prompt.yes?("Is it correct ? ")
             rescue TTY::Reader::InputInterrupt
-                puts 'Carioca : interrupted'
+                print "Carioca : "
+                puts pastel.yellow 'interrupted'
                 exit 5
             end
+             print "Carioca : Registry saving : "
             if is_correct then 
                 begin
                     registry_file.add service: name, definition: definition
                     registry_file.save!
                 rescue => e 
-                    puts "Carioca: Can't save : #{e}"
+                    print pastel.red "failed" 
+                    puts " error : #{e}"
                     exit 10
                 end
 
-                puts "Carioca : Registry saved"
+                puts pastel.green "done"
             else
-                puts 'Carioca : Nothing saved'
+                puts pastel.yellow 'canceled'
             end
         end
     end
-  end
+  
+end

data/lib/carioca/registry.rb

@@ -1,94 +1,103 @@
+# frozen_string_literal: true
+
 module Carioca
-    class Registry 
-        include Carioca::Helpers
-        include Singleton
-        @@config = Configuration::new
-    
-        def Registry.config
-          return @@config
-        end
-    
-        def Registry.configure(&block)
-          yield(@@config)
-        end
-    
-        class << self
-          alias_method :get, :instance
-          alias_method :init, :instance
+  class Registry
+    include Carioca::Helpers
+    include Singleton
+    @@config = Configuration.new
 
-        end
-    
-        attr_accessor :services
-        attr_accessor :active_services
-    
-        def get_service(name: )
+    def self.config
+      @@config
+    end
 
-          raise "Service not found: #{name}" unless @services.include? name
-          if @active_services.include? name then 
-            debug message: i18n.t('service.getting', name: name) if @active_services.include? :logger and ![:logger, :i18n].include? name and @@config.debug?
-          else
-            service = @services[name]
-            service[:depends].each do|dep|
-              debug  message: i18n.t('service.depends', name: dep) if @active_services.include? :logger and ![:logger, :i18n].include? dep and @@config.debug?
-              get_service(name: dep) unless @active_services.include? dep
-            end if service.include? :depends
-            debug  message: i18n.t('service.starting', name: name) if @active_services.include? :logger and ![:logger, :i18n].include? name and @@config.debug?
-            require  service[:resource] if [:gem, :file, :stdlib].include? service[:type]
-            @active_services[name] ||= eval("lambda { #{service[:service]} }").call
-          end
-          return @active_services[name] 
-        end
-    
-        def config
-          return @@config
-        end
+    def self.configure
+      yield(@@config)
+    end
 
-        def add(service: , definition:, skip_validation: false )
-          mess = 
-          raise "Service #{service} already exist." if @services.include? service and skip_validation == false
-          debug message: i18n.t('service.adding', name: service) if @active_services.include? :logger and @@config.debug?
-          checker = Carioca::Services::Validator::new service: service , definition: definition
-          checker.validate! unless skip_validation
-          @services[service] = checker.definition
-        end
-    
-        private 
-        def prepare_logger
-          conf_i18n = @@config.builtins[:i18n]
-          add service: :i18n, definition: @@config.builtins[:i18n], skip_validation: true
-          conf_logger = @@config.builtins[:logger]
-          conf_logger[:service] = @@config.log_target
-          add service: :logger, definition: @@config.builtins[:logger], skip_validation: true
-          log = get_service name: :logger
-          log.level = @@config.log_level
-        end
+    class << self
+      alias get instance
+      alias init instance
+    end
+
+    attr_accessor :services, :active_services
+
+    def get_service(name:)
+      raise "Service not found: #{name}" unless @services.include? name
 
-        def initialize
-          @services = Hash::new
-          @active_services = Hash::new
-          prepare_logger
-          locale = @@config.default_locale
-          target = (@@config.log_file?)? @@config.log_file : "STDOUT"
-          debug message: i18n.t('notify.locale', loc: locale) if @@config.debug?
-          debug message:  i18n.t('notify.logger', target: target) if @@config.debug?
-          debug message:  i18n.t('init.carioca') if @@config.debug?
-          debug message: i18n.t('init.builtins') if @@config.debug?
-          @@config.builtins.each do |service, spec|
-            add service: service, definition: spec, skip_validation: true unless service == :logger
+      if @active_services.include? name
+        debug message: i18n.t('service.getting', name: name) if @active_services.include?(:logger) && !%i[logger
+                                                                                                          i18n output].include?(name) && @@config.debug?
+      else
+        service = @services[name]
+        if service.include? :depends
+          service[:depends].each do |dep|
+            debug message: i18n.t('service.depends', name: dep) if @active_services.include?(:logger) && !%i[logger
+                                                                                                             i18n].include?(dep) && @@config.debug?
+            get_service(name: dep) unless @active_services.include? dep
           end
-          open_registry_file if File::exist? @@config.filename and @@config.init_from_file?
         end
-    
-        def open_registry_file
-          debug message: i18n.t('init.registry.processing', filename: @@config.filename) if @@config.debug?
-          registry_file = Carioca::RegistryFile::new filename: @@config.filename
-          debug message: i18n.t('notify.useless_entry', altered: registry_file.altered.to_s, file_name: @@config.filename ) if registry_file.altered? and @@config.debug?
-          registry_file.validated.each do |service,spec|
-            add service: service, definition: spec
-          end
-          debug message: i18n.t('init.registry.success') if @@config.debug?
-        end 
-    
-    
+        debug message: i18n.t('service.starting', name: name) if @active_services.include?(:logger) && !%i[logger
+                                                                                                           i18n].include?(name) && @@config.debug?
+        require  service[:resource] if %i[gem file stdlib].include? service[:type]
+        @active_services[name] ||= eval("lambda { #{service[:service]} }").call # lambda { Aservice::new }
+      end
+      @active_services[name]
+    end
+
+    def config
+      @@config
+    end
+
+    def add(service:, definition:, skip_validation: false)
+      raise "Service #{service} already exist." if @services.include?(service) && (skip_validation == false)
+
+      if @active_services.include?(:logger) && @@config.debug?
+        debug message: i18n.t('service.adding',
+                              name: service)
+      end
+      checker = Carioca::Services::Validator.new service: service, definition: definition
+      checker.validate! unless skip_validation
+      @services[service] = checker.definition
+    end
+
+    private
+
+    def prepare_logger
+      add service: :i18n, definition: @@config.builtins[:i18n], skip_validation: true
+      conf_logger = @@config.builtins[:logger]
+      conf_logger[:service] = @@config.log_target
+      add service: :logger, definition: @@config.builtins[:logger], skip_validation: true
+      log = get_service name: :logger
+      log.level = @@config.log_level
+    end
+
+    def initialize
+      @services = {}
+      @active_services = {}
+      prepare_logger
+      locale = @@config.default_locale
+      target = @@config.log_file? ? @@config.log_file : 'STDOUT'
+      debug message: i18n.t('notify.locale', loc: locale) if @@config.debug?
+      debug message:  i18n.t('notify.logger', target: target) if @@config.debug?
+      debug message:  i18n.t('init.carioca') if @@config.debug?
+      debug message: i18n.t('init.builtins') if @@config.debug?
+      @@config.builtins.each do |service, spec|
+        add service: service, definition: spec, skip_validation: true unless service == :logger
+      end
+      open_registry_file if File.exist?(@@config.filename) && @@config.init_from_file?
+    end
+
+    def open_registry_file
+      debug message: i18n.t('init.registry.processing', filename: @@config.filename) if @@config.debug?
+      registry_file = Carioca::RegistryFile.new filename: @@config.filename
+      if registry_file.altered? && @@config.debug?
+        debug message: i18n.t('notify.useless_entry', altered: registry_file.altered.to_s,
+                                                      file_name: @@config.filename)
+      end
+      registry_file.validated.each do |service, spec|
+        add service: service, definition: spec
+      end
+      debug message: i18n.t('init.registry.success') if @@config.debug?
     end
-end
+  end
+end

data/lib/carioca/registry_file.rb

@@ -1,62 +1,59 @@
+# frozen_string_literal: true
+
 module Carioca
+  class RegistryFile
+    attr_accessor :validated, :altered
+
+    include Carioca::Constants
+
+    def initialize(filename:)
+      @filename = filename
+      @candidates = {}
+      @validated = {}
+      @altered = []
+      open
+    end
+
+    def altered?
+      !@altered.empty?
+    end
 
-  
-    
-
-    class RegistryFile
-
-        attr_accessor :validated, :altered
-        include Carioca::Constants
-
-        def initialize(filename:)
-            @filename = filename
-            @candidates = Hash::new
-            @validated = Hash::new
-            @altered = []
-            open
-        end
-
-        def altered? 
-            return !@altered.empty?
-        end
-
-        def create!(force: false)
-            write_ok = true
-            write_ok = force if File::exist? @filename
-            File.open(@filename, 'w') { |file| file.write(@validated.to_yaml) } if write_ok
-        end
-
-        def save!
-            create! force: true
-        end
-
-        def add(service:, definition: )
-            checker = Carioca::Services::Validator::new service: service , definition: definition
-            checker.validate!
-            @validated[service] = checker.definition
-        end
-
-        def open
-            if File::exist?(@filename) then
-                @candidates = YAML.load_file(@filename)
-            else
-                create!
-            end
-            prepare!
-        end
-
-        private
-        def prepare!
-            save  = @candidates.dup
-            @candidates.delete_if {|key, value| BUILTINS.keys.include? key  }
-            @altered = save.keys - @candidates.keys 
-            @candidates.each do |service, definition|
-                checker = Carioca::Services::Validator::new service: service , definition: definition
-                checker.validate!
-                @validated[service] = checker.definition
-            end
-        end
+    def create!(force: false)
+      write_ok = true
+      write_ok = force if File.exist? @filename
+      File.write(@filename, @validated.to_yaml) if write_ok
+    end
+
+    def save!
+      create! force: true
+    end
 
+    def add(service:, definition:)
+      checker = Carioca::Services::Validator.new service: service, definition: definition
+      checker.validate!
+      @validated[service] = checker.definition
+    end
+
+    def open
+      if File.exist?(@filename)
+        @candidates = YAML.load_file(@filename)
+      else
+        create!
+      end
+      prepare!
+    end
 
+    private
+
+    def prepare!
+      save = @candidates.dup
+      @candidates.delete_if { |key, _value| BUILTINS.keys.include? key }
+      @altered = save.keys - @candidates.keys
+      @candidates.each do |service, definition|
+        checker = Carioca::Services::Validator.new service: service, definition: definition
+        checker.validate!
+        @validated[service] = checker.definition
+      end
     end
-end
+  end
+end