carioca 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7452e3def3859f67723245f65eaca57325c02df7
-  data.tar.gz: e62a5e8df75b45796408e2b23b8ffa3f7272b9dc
+SHA256:
+  metadata.gz: 9be0e1efee67cbc15309f5eb56a72208681b14d84c3c1f3666474c28798c1c51
+  data.tar.gz: 66033e08a911cd0b537eb7ca1114a8aca2d445f8cae79e9d04e62190e27d0a0c
 SHA512:
-  metadata.gz: da22b8fb540c74436f8a594500a8be39a6f40c5fa449b4354a2499da95b9e67a4557a117a544f11645a67a68178eeb3c3b1c54c52eedea4767a43a78f60ce924
-  data.tar.gz: 226b261c12350b1b31729bc42631c7e4ba4f62d6d69de13da218e4daa11c81fdf362082eeb3ab2f7d795f19013609a7fd17dfc21d6cc44cd329c37db04542a45
+  metadata.gz: 85c41d310a6ad5f7704b2f244a1616160569dd389939c4ed389b08d81520f15f1c304e5ece750e29205043544bcca886ad39a6925be24c941044acaf5a3c8cbd
+  data.tar.gz: 95cdb63add808821f358742e1fbd6ef611ebc49f062901405ec37cc972dcf7c8695a88583f16685b020df3f08485c8bc1dec83d2868c44641a67fd53c5c0ecef

data/ChangeLog

@@ -4,4 +4,7 @@ carioca :
 	Romain GEORGES
 - initial stable version
  - version 1.0 (stable)
-	Romain GEORGES	
+	Romain GEORGES
+
+- current stable version
+  - version 1.4 (stable) 2020/04/30 

data/Rakefile

@@ -1,5 +1,5 @@
 require 'rubygems'
-
+require "bundler/gem_tasks"
 require 'rspec'
 require 'rake'
 require "rake/clean"
@@ -11,8 +11,9 @@ require 'yard/rake/yardoc_task.rb'
 require "rake/tasklib"
 require "roodi"
 require "roodi_task"
- 
- 
+require 'code_statistics'
+
+
 RoodiTask.new() do | t |
 t.patterns = %w(lib/**/*.rb)
 t.config = "ultragreen_roodi_coding_convention.yml"
@@ -31,12 +32,12 @@ RSpec::Core::RakeTask.new('spec')
 
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']			   
+  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']
   t.options += ['--title', "Gem Documentation"]
   t.options += ['-o', "yardoc"]
   t.options += ['-r', "doc/manual.rdoc"]
 end
-YARD::Config.load_plugin('yard-rspec') 
+YARD::Config.load_plugin('yard-rspec')
 
 namespace :yardoc do
   task :clobber do
@@ -59,4 +60,10 @@ Rake::RDocTask.new('rdoc') do |d|
   d.options << '--line-numbers' << '--diagram' << '-SHN'
 end
 
-task :default => [:gem]
+task :default => [:gem]
+
+task :stage do
+  Rake::Task["clean"].invoke
+  Rake::Task["clobber"].invoke
+  Rake::Task["install"].invoke
+end

data/carioca.gemspec

@@ -1,33 +1,32 @@
 Gem::Specification.new do |s|
   s.name = %q{carioca}
   s.author = "Romain GEORGES"
-  s.version = "1.3"
-  s.license =  "BSD-2"
-  s.date = %q{2013-02-18}
+  s.version = "1.4"
+  s.license =  "BSD-2-Clause"
   s.summary = %q{Carioca : Configuration Agent and Registry with Inversion Of Control for your Applications}
   s.email = %q{romain@ultragreen.net}
-  s.homepage = %q{http://www.ultragreen.net}
+  s.homepage = %q{https://github.com/Ultragreen/carioca}
   s.description = %q{Carioca : provide a full IoC light Container for designing your applications}
-  s.has_rdoc = true
-  s.files = Dir['*/*/*/*'] + Dir['*/*/*'] + Dir['*/*'] + Dir['*']
-
-  s.add_development_dependency "bundler", "~> 1.5"
-  s.add_development_dependency "rake", "~> 10.5"
-  s.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
-  s.add_development_dependency 'yard', '~> 0.8', '>= 0.8.7.2'
-  s.add_development_dependency 'rdoc', '~> 4.0', '>= 4.0.1'
-  s.add_development_dependency 'roodi', '~> 3.1', '>= 3.1.1'
-  s.add_development_dependency 'code_statistics', '~> 0.2', '>= 0.2.13'
+  s.files = `git ls-files`.split($/)
+
+
+  s.add_development_dependency "rake", "~> 13.0.1"
+  s.add_development_dependency 'rspec', '~> 3.9.0'
+  s.add_development_dependency 'yard', '~> 0.9.24'
+  s.add_development_dependency 'rdoc', '~> 6.2.1'
+  s.add_development_dependency 'roodi', '~> 5.0.0'
+  s.add_development_dependency 'code_statistics', '~> 0.2.13'
   s.add_development_dependency 'yard-rspec', '~> 0.1'
 
-  
 
-  s.add_dependency 'dorsal', "~> 1.0"
-  s.add_dependency 'methodic', "~> 1.2", '>= 1.2'
-  s.add_dependency 'xml-simple', "~> 1.1", '>= 1.1.5'	
+s.add_development_dependency 'uuid', '~> 2.3.9'
+
 
+
+  s.add_dependency 'dorsal', "~> 1.0"
+  s.add_dependency 'methodic', "~> 1.3", '>= 1.3'
+  s.add_dependency 'xml-simple', "~> 1.1", '>= 1.1.5'
+  s.add_dependency 'activesupport', "~> 6.0.2.2"
   s.required_ruby_version = '>= 1.8.1'
-  s.rdoc_options << '--title' << 'Carioca : Gem documentation' << '--main' << 'doc/manual.rdoc' << '--line-numbers' 
-  # << '--diagram'
-  s.rubyforge_project = "nowarning"
+
 end

data/lib/carioca.rb

@@ -1,6 +1,6 @@
 
 #!/usr/bin/env ruby
-# -*- coding: utf-8 -*-
+# coding: utf-8
 #---
 # Author : Romain GEORGES
 # type : gem component library
@@ -23,27 +23,27 @@ require 'carioca/private'
 module Carioca
 
 
-  
+
   # module Services
-  # @note this module is a namespace Carioca::Services 
+  # @note this module is a namespace Carioca::Services
   module Services
-    
-    
+
+
     # class Registry
     #  This class provide the Registry manager for Carioca
     # @note this class is a Singleton Class to instanciate do not use new (initializer), but :
-    #    Carioca::Services::Registry.init options 
-    # @example Complete usage 
+    #    Carioca::Services::Registry.init options
+    # @example Complete usage
     #    require 'rubygems'
-    #    require 'carioca'  
-    #    registry = Carioca::Services::Registry.init 
+    #    require 'carioca'
+    #    registry = Carioca::Services::Registry.init
     #    registry = Carioca::Services::Registry.init :file => 'myservices.registry'
     #    registry = Carioca::Services::Registry.init :file => 'myservices.registry', :debug => true
     class Registry
 
       include PrivateMethodsCariocaServicesRegistry
-      
-      # for singleton 
+
+      # for singleton
       private_class_method :new
       private :verify_requires_dependancies
       private :require_service
@@ -52,17 +52,17 @@ module Carioca
       private :scan_instance_suffix
       private :kill_distributed_service
       private :shutdown_ring_if_empty
-      
-      
+
+
       @@inst = nil
-      
+
       # Singleton constructor for Registry
       # @param [Hash] _options the options, keys are symbols
       # @option _options [String] :file The path of your registry YAML definition (see YAML registry format)
-      # @option _options [TrueClass,FalseClass] :debug Boolean activation/deactiviation of the carioca debug mode (log traces) 
+      # @option _options [TrueClass,FalseClass] :debug Boolean activation/deactiviation of the carioca debug mode (log traces)
       # @return [Carioca::Services::Registry] Singleton class instance of Registry
       # @example usage
-      #    registry = Carioca::Services::Registry.init # or  
+      #    registry = Carioca::Services::Registry.init # or
       #    registry = Carioca::Services::Registry.init :file => 'myservices.registry' # or
       #    registry = Carioca::Services::Registry.init :file => 'myservices.registry', :debug => true
       def Registry.init(_options = {})
@@ -72,52 +72,52 @@ module Carioca
         @@inst = new(options) if @@inst.nil?
         return @@inst
       end
-      
+
       # @example read
       #   registry = Carioca::Services::Registry.init
       #   p registry.registry_filename
       # @example write
       #   registry = Carioca::Services::Registry.init
       #   p registry.registry_filename = '/tmp/test.file'
-      # @attr_reader [Hash] list a hash table of all structured registred services definition 
+      # @attr_reader [Hash] list a hash table of all structured registred services definition
       # (come from file and explicitly registered services)
       attr_accessor :registry_filename
-      
-      # @example 
+
+      # @example
       #   registry = Carioca::Services::Registry.init
       #   p registry.list
-      # @attr_reader [Hash] list a hash table of all structured registred services definition 
+      # @attr_reader [Hash] list a hash table of all structured registred services definition
       # (come from file and explicitly registered services)
       attr_reader :list
 
-      # @example 
+      # @example
       #   registry = Carioca::Services::Registry.init
       #   p registry.loaded_services # you should see the logger service Hash definition
-      # @attr_reader [Hash] loaded_services a hash table of all structured loaded services 
+      # @attr_reader [Hash] loaded_services a hash table of all structured loaded services
       attr_reader :loaded_services
 
-      # @example 
+      # @example
       #   registry = Carioca::Services::Registry.init
       #   p registry.debug
       # @attr_reader [TrueClass,FalseClass] debug a boolean of the current debug status
       attr_reader :debug
 
-      # @example 
+      # @example
       #   registry = Carioca::Services::Registry.init
       #   p registry.name
       #   registry.name = 'Agent'
       # @attr_reader [String] the name of the Registry, used for distributed services
       # @note default value is 'Carioca'
       attr_accessor :name
-      
+
       # writer accessor for debug (interaction with log service)
-      # @example 
+      # @example
       #   registry = Carioca::Services::Registry.init
       #   p registry.debug = true
-      # @param [TrueClass,FalseClass] _value true or false to activate/deactivate debug mode 
+      # @param [TrueClass,FalseClass] _value true or false to activate/deactivate debug mode
       # @note interaction with preloaded service logger
       def debug=(_value)
-        @log.level =(_value)? Logger::DEBUG : Logger::INFO     
+        @log.level =(_value)? Logger::DEBUG : Logger::INFO
       end
 
 
@@ -126,7 +126,7 @@ module Carioca
       # @option _options [String] :name The name of the service to stop
       # @return [TruaClass,FalseClass] true if service effectivly stopped, false if not, or :name == 'logger'
       # @example usage
-      #    registry = Carioca::Services::Registry.init 
+      #    registry = Carioca::Services::Registry.init
       #    registry.start_service :name => 'configuration'
       #    registry.stop_service :name => 'configuration'
       #    #=> return true
@@ -142,23 +142,23 @@ module Carioca
         options.validate!
         @log.debug('Carioca') { "Service logger can't be unloaded" } if @log and options[:name] == 'logger'
         return false if options[:name] == 'logger'
-        if @loaded_services.include?(options[:name]) then        
+        if @loaded_services.include?(options[:name]) then
           options = scan_instance_suffix(options)
           return kill_distributed_service options if @list[options[:shortname]][:distributed]
           return kill_service options
         else
           @log.debug('Carioca') { "Service #{options[:name]} not loaded" } if @log
-          return false          
+          return false
         end
       end
-      
+
 
       # register a new service in registry added to @list
       # @param [Hash] _options the options hash, key are :symbols
       # @option _options [String] :name the name of the service (required)
       # @option _options [String] :resource the resource, must be a gem name, a fullpath filename, a builtin service (required)
       # @option _options [Symbol] :type the resource type of the service, must be :gem, :builtin or :file (required)
-      # @option _options [String] :service the realname of the service class with namespace (eg. ExternalServices::Dummy ) 
+      # @option _options [String] :service the realname of the service class with namespace (eg. ExternalServices::Dummy )
       # @option _options [String] :description the description of the service (required)
       # @option _options [Hash] :init_options the params of the service, keys are symbols
       # @option _options [Array] :requires the list of [String] services name required to load this service
@@ -167,7 +167,7 @@ module Carioca
       # @raise ArgumentError when :type is not in [:gem,:file,:builtin]
       def register_service(_options)
         options = Methodic.get_options(_options)
-        options.specify_classes_of({:name => String, :resource => String, :description => String, :type => Symbol, :service => String }) 
+        options.specify_classes_of({:name => String, :resource => String, :description => String, :type => Symbol, :service => String })
         options.specify_presences_of([:name,:type,:resource,:service])
         cond = Proc::new{|option| if [:gem,:gem_file,:file,:builtin].include? option then true else false end }
         options.specify_condition_for :type => cond
@@ -193,7 +193,7 @@ module Carioca
         @list.delete(options[:name])
         return true
       end
-      
+
       # overload @list (self.list) by adding/reloading the builtins services definition scanned from Carioca gem
       #  alterate @list
       # @example usage
@@ -203,11 +203,11 @@ module Carioca
       def discover_builtins
         @list.merge! Carioca::Services::discover_builtins
       end
-      
+
       # save the registry file in self.registry_filename
       # @return [TruaClass,FalseClass] true if the file is saved
       # @example usage
-      #    registry = Carioca::Services::Registry.init :file => './empty.file' 
+      #    registry = Carioca::Services::Registry.init :file => './empty.file'
       #    registry.discover_builtins
       #    registry.unregister_service :name => 'configuration'
       #    registry.save!
@@ -218,15 +218,15 @@ module Carioca
         end
         return res
       end
-      
+
       # start or get e previously started service in @list
       # @return [Object] the loaded service class instance
       # @param [Hash] _options the params, key are symbols
       # @option _options [String] :name the name of the service
       # @option _options [Hash] :params the params of the service
       # @raise [RegistryError] Config Failed, for unconsistant service definition in @list
-      # @example usage 
-      #    registry = Carioca::Services::Registry.init 
+      # @example usage
+      #    registry = Carioca::Services::Registry.init
       #    config = registry.start_service :name => 'configuration'
       #    proxy = subject.start_service :name => 'debug' , :params => {:service => 'configuration'}
       def start_service(_options)
@@ -235,7 +235,7 @@ module Carioca
         options.specify_presences_of([:name])
         options.validate!
         @log.debug('Carioca') { "getting service #{options[:name]}"} if @log
-        self.restart_service(options) unless @loaded_services.include? options[:name] 
+        self.restart_service(options) unless @loaded_services.include? options[:name]
         return @loaded_services[options[:name]]
       end
       alias :get_service :start_service
@@ -246,8 +246,8 @@ module Carioca
       # @option _options [String] :name the name of the service
       # @option _options [Hash] :params the params of the service
       # @raise [RegistryError] Config Failed, for unconsistant service definition in @list
-      # @example usage 
-      #    registry = Carioca::Services::Registry.init 
+      # @example usage
+      #    registry = Carioca::Services::Registry.init
       #    config = registry.restart_service :name => 'configuration'
       #    config = registry.restart_service :name => 'configuration' # stop and restart the previous services
       #    proxy = subject.restart_service :name => 'debug' , :params => {:service => 'configuration'}
@@ -264,17 +264,17 @@ module Carioca
           kill_distributed_service options
         elsif @loaded_services.include? options[:name] then
           @log.debug('Carioca') { "Restarting service #{options[:name]}"} if @log
-          kill_service options     
-        end    
+          kill_service options
+        end
         verify_requires_dependancies(options)
         require_service(options)
         return instanciate_service(options)
       end
-      
+
       # close the registry (finalizer)
-      #  * stop all the services 
+      #  * stop all the services
       #  * kill logger
-      #  * call private kill_service for each 
+      #  * call private kill_service for each
       # @note the garbage method hook is call if defined, for each service
       # @return [TrueClass,FalseClass] true if registry closed successfully
       def close
@@ -283,7 +283,7 @@ module Carioca
         @loaded_services.keys.each do |service|
           options[:name] = service
           options = scan_instance_suffix(options)
-          next if options[:name] == 'logger' 
+          next if options[:name] == 'logger'
           kill_distributed_service :name => options[:name], :preserve => true if @list[options[:shortname]][:distributed]
           kill_service options unless @list[options[:shortname]][:distributed]
         end
@@ -293,7 +293,7 @@ module Carioca
       end
 
       # load the registry file from self.registry_filename
-      # @return [Hash] @list the list Structure of the loaded registry 
+      # @return [Hash] @list the list Structure of the loaded registry
       # @example usage
       #    registry = Carioca::Services::Registry.init
       #    registry.registry_filename = "./an_other.file"
@@ -303,12 +303,12 @@ module Carioca
         @list = YAML.load_file(@registry_filename)
       end
       alias :reload :load
-      
+
     end # end of Carioca::Services::Registry
   end # end of Carioca:Services
 end # end of Carioca
 
-# Exception overload class for Carioca 
+# Exception overload class for Carioca
 class RegistryError < Exception; end
 
 

data/lib/carioca/exceptions.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# coding: utf-8
 #---
 # Author : Romain GEORGES
 # type : gem component library

data/lib/carioca/helpers.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# coding: utf-8
 #---
 # Author : Romain GEORGES
 # type : gem component library
@@ -15,7 +15,7 @@ class Class
   def use_configuration(_options = {})
     options = Methodic.get_options(_options)
     options.specify_classes_of :with_file => String
-    options.specify_default_value_of :with_file => 'services/registry.yml'
+    options.specify_default_value_for :with_file => 'services/registry.yml'
     options.merge
     options.validate!
     Carioca::Services::Registry.init.start_service :name => 'configuration', :params => { :config_file => options[:with_file]}
@@ -27,7 +27,7 @@ Module.class_eval do
   def init_registry _options={}
     options = Methodic.get_options(_options)
     options.specify_classes_of :with_file => String
-    options.specify_default_value_of :with_file => 'services/registry.yml'
+    options.specify_default_value_for :with_file => 'services/registry.yml'
     options.merge
     options.validate!
     Carioca::Services::Registry.init :file => options[:with_file]

data/lib/carioca/private.rb

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby
+# coding: utf-8
 #---
 # Author : Romain GEORGES
 # type : gem component library
@@ -19,24 +19,24 @@ module PrivateMethodsCariocaServicesRegistry
     @list  = Hash::new
     load if File::exist?(@registry_filename)
     unless @list.include?('logger') then
-      self.register_service({:name => 'logger', 
+      self.register_service({:name => 'logger',
                               :service => 'Carioca::Services::InternalLogger',
-                              :resource => 'logger', 
-                              :description => "The standard ruby Logger internal wrapper Service", 
-                              :type => :builtin, 
+                              :resource => 'logger',
+                              :description => "The standard ruby Logger internal wrapper Service",
+                              :type => :builtin,
                               :init_options => { :target => "/tmp/log.file"}})
       @logger_not_in_reg = true
-    end         
+    end
     @loaded_services = Hash::new
     # preload logger service
-    @log = self.start_service :name => 'logger' 
-    @log.level =(@debug)? Logger::DEBUG : Logger::INFO     
+    @log = self.start_service :name => 'logger'
+    @log.level =(@debug)? Logger::DEBUG : Logger::INFO
     @log.debug('Carioca') { "Registry started, service logger preloaded" }
     @log.debug('Carioca') { "Logger registered, not in configured registry" } if @logger_not_in_reg
   end
-  
-  # verify dependancies in services structure 
-  # in @list from a service defition 
+
+  # verify dependancies in services structure
+  # in @list from a service defition
   # in _options and start it if needed
   def verify_requires_dependancies(_options)
     _name = _options[:shortname]
@@ -45,18 +45,18 @@ module PrivateMethodsCariocaServicesRegistry
         raise RegistryError::new 'Missing Required depedancy #{service}' unless @list.keys.include? service
         unless @loaded_services.include?(service) then
           @log.debug('Carioca') { "Registry dependancy found and not loaded : #{service}" }
-          restart_service :name => service 
+          restart_service :name => service
         end
       end
-    end      
+    end
   end
-  
-  # require file for a service 
+
+  # require file for a service
   # from a service definition in _options
   def require_service(_options)
     _name = _options[:shortname]
     sym = ":#{@list[_name][:service].split('::').last}"
-    case @list[_name][:type] 
+    case @list[_name][:type]
     when :file then
       require @list[_name][:resource]
     when :builtin then
@@ -67,7 +67,7 @@ module PrivateMethodsCariocaServicesRegistry
         raise RegistryError::new("Config failed")
       end
     when :gem then
-      require @list[_name][:resource] 
+      require @list[_name][:resource]
     when :gem_file then
       (_name,_file) = @list[_name][:resource].split(':')
       _dfile = Carioca::Services::search_file_in_gem _name,_file
@@ -76,7 +76,7 @@ module PrivateMethodsCariocaServicesRegistry
       else
         raise RegistryError::new("Config failed")
       end
-    else 
+    else
       raise RegistryError::new("Config failed")
     end
   end
@@ -91,7 +91,7 @@ module PrivateMethodsCariocaServicesRegistry
     end
     return options
   end
-  
+
   #shutdown ring server if empty
   def shutdown_ring_if_empty
     get_ring if @ring_server.nil?
@@ -114,7 +114,7 @@ module PrivateMethodsCariocaServicesRegistry
     end
   end
 
-  # instanciate Object from class defintion of a service defined in 
+  # instanciate Object from class defintion of a service defined in
   # the service definition in _opts
   def instanciate_service(_opts)
     _name = _opts[:shortname]
@@ -122,7 +122,7 @@ module PrivateMethodsCariocaServicesRegistry
     get_ring if dist
     @list[_name][:init_options].merge! _opts[:params] unless _opts[:params].nil?
     @obj = Object::new
-    if @list[_name][:init_options].nil? then 
+    if @list[_name][:init_options].nil? then
       eval("@obj = #{@list[_name][:service]}::new")
     else
       eval("@obj = #{@list[_name][:service]}::new(@list[_name][:init_options])")
@@ -135,8 +135,8 @@ module PrivateMethodsCariocaServicesRegistry
     end
     return @loaded_services[_opts[:name]]
   end
-  
-  # call the garbage method of a service if exist and 
+
+  # call the garbage method of a service if exist and
   # Delete from the loaded services list
   def kill_service(options)
     @log.debug('Carioca') { "Service #{options[:name]} stopped" } if @log
@@ -146,7 +146,7 @@ module PrivateMethodsCariocaServicesRegistry
   end
 
   def kill_distributed_service(options)
-    preserve = (options[:preserve].nil?)? false : options[:preserve] 
+    preserve = (options[:preserve].nil?)? false : options[:preserve]
     get_ring if @ring_server.nil?
     if @ring_server.list_services.include?(options[:name]) then
       if options[:preserve] and  @ring_server.list_services[options[:name]][:owner] != @name then
@@ -166,5 +166,3 @@ module PrivateMethodsCariocaServicesRegistry
 
 
 end # end of PrivateMethodsCariocaServicesRegistry
-
-