carioca 1.0 → 1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5725ebfdae23b3175784bfc8f961a8ee5d31c455
+  data.tar.gz: 564985d9a48ab2e72017dca0b08d0c556ae0627b
+SHA512:
+  metadata.gz: 7690724ad858c0f2a29f48bde4b7dd1674afdc9ed9a3cb0a5adfecb00b55e0338a33ddee6842829783140684f3e3bd2f014eabee48ab07c45f0468ce1d33207d
+  data.tar.gz: 6a3ab862d8c13fab2ddb0ac9fb7de1fd3ef4d6ce47e83750254e242dc36de6a68eaee9efe720840421744d39540f4c5b7f964b6895983c50b5dc14303bf43b6e

data/Gemfile

@@ -1,11 +1,4 @@
 source "http://rubygems.org"
-gem "yard-rspec"
-gem "rspec", :require => "spec"
-gem "rake"
-gem "yard"
-gem "rdoc"
-gem "rcov"
-gem "roodi"
-gem "uuid"
-gem "methodic"
-gem "code_statistics"
+
+gemspec
+

data/Gemfile.lock

@@ -1,31 +1,29 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    code_statistics (0.2.13)
-    diff-lcs (1.1.3)
-    json (1.6.5)
-    macaddr (1.0.0)
-    methodic (0.2)
-    rake (0.9.2.2)
-    rcov (1.0.0)
-    rdoc (3.12)
-      json (~> 1.4)
+    diff-lcs (1.2.1)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    methodic (1.2)
+    rake (10.0.4)
+    rdoc (4.0.0)
     roodi (2.2.0)
       ruby_parser (~> 2.3.0)
-    rspec (2.9.0)
-      rspec-core (~> 2.9.0)
-      rspec-expectations (~> 2.9.0)
-      rspec-mocks (~> 2.9.0)
-    rspec-core (2.9.0)
-    rspec-expectations (2.9.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.9.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     ruby_parser (2.3.1)
       sexp_processor (~> 3.0)
     sexp_processor (3.2.0)
-    uuid (2.3.1)
+    systemu (2.5.2)
+    uuid (2.3.7)
       macaddr (~> 1.0)
-    yard (0.7.5)
+    yard (0.8.5.2)
     yard-rspec (0.1)
       yard
 
@@ -33,10 +31,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  code_statistics
   methodic
   rake
-  rcov
   rdoc
   roodi
   rspec

data/README.md

@@ -14,6 +14,9 @@ Carioca provide :
 - a complete Configuration Agent 
 - A service Registry (base on IOC/DI pattern)
 
+[![Build Status](https://travis-ci.org/lecid/carioca.png?branch=master)](https://travis-ci.org/lecid/carioca)
+
+
 ## Installation
 
 In a valid Ruby environment :

data/Rakefile

@@ -5,7 +5,6 @@ require 'rake'
 require "rake/clean"
 require "rubygems/package_task"
 require "rdoc/task"
-require 'code_statistics'
 require 'rspec/core/rake_task'
 require 'yard'
 require 'yard/rake/yardoc_task.rb'

data/carioca.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = %q{carioca}
   s.author = "Romain GEORGES"
-  s.version = "1.0"
+  s.version = "1.1"
   s.date = %q{2013-02-18}
   s.summary = %q{Carioca : Configuration Agent and Registry with Inversion Of Control for your Applications}
   s.email = %q{romain@ultragreen.net}
@@ -9,8 +9,15 @@ Gem::Specification.new do |s|
   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.bindir = nil
-  s.add_dependency('methodic', '>= 1.2')
+  s.add_development_dependency('rspec')
+  s.add_development_dependency('yard')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('roodi')
+  s.add_development_dependency('uuid')
+  s.add_development_dependency('code_statistics')
+  s.add_development_dependency('yard-rspec')
+  s.add_dependency('dorsal')
+  s.add_dependency('methodic')
   s.required_ruby_version = '>= 1.8.1'
   s.rdoc_options << '--title' << 'Carioca : Gem documentation' << '--main' << 'doc/manual.rdoc' << '--line-numbers' 
   # << '--diagram'

data/lib/carioca.rb

@@ -1,4 +1,6 @@
+
 #!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
 #---
 # Author : Romain GEORGES
 # type : gem component library
@@ -8,9 +10,8 @@
 require 'yaml'
 require 'rubygems'
 require 'methodic'
-require 'services'
-require 'daemons'
-require 'carioca_private'
+require 'carioca/services'
+require 'carioca/private'
 
 
 
@@ -48,7 +49,10 @@ module Carioca
       private :require_service
       private :instanciate_service
       private :kill_service
-
+      private :scan_instance_suffix
+      private :kill_distributed_service
+      private :shutdown_ring_if_empty
+      
       
       @@inst = nil
       
@@ -62,10 +66,9 @@ module Carioca
       #    registry = Carioca::Services::Registry.init :file => 'myservices.registry' # or
       #    registry = Carioca::Services::Registry.init :file => 'myservices.registry', :debug => true
       def Registry.init(_options = {})
-        options = Methodic::get_options(_options) do |m|
-          m.specify_defaults_value :file => './services.registry', :debug => false
-          m.merge!
-        end
+        options = Methodic::get_options(_options)
+        options.specify_defaults_values :file => './services.registry', :debug => false, :name => 'Carioca'
+        options.merge
         @@inst = new(options) if @@inst.nil?
         return @@inst
       end
@@ -98,6 +101,14 @@ module Carioca
       #   p registry.debug
       # @attr_reader [TrueClass,FalseClass] debug a boolean of the current debug status
       attr_reader :debug
+
+      # @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 
@@ -129,22 +140,18 @@ module Carioca
         options.specify_class_of :name => String
         options.specify_presence_of([:name])
         options.validate!
-        if @loaded_services.include?(options[:name]) then
-          # prevent logger services killing
-          if options[:name] == 'logger' then
-            @log.debug('Carioca') { "Service logger can't be unloaded" } if @log
-            return false
-          end
-          # calling private killer
-          kill_service options[:name]
-          @log.debug('Carioca') { "Service #{options[:name]} stopped" } if @log
-          return true
+        @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        
+          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
@@ -155,17 +162,14 @@ module Carioca
       # @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
+      # @option _options [TruClass|FalseClass] :distributed if service must be load as a distributed service
       # @return [TrueClass,FalseClass] true if service is added
       # @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_presences_of([:name,:type,:resource,:service])
-        cond = Proc::new{|option| case option 
-                                  when :gem then true 
-                                  when :file then true
-                                  when :builtin then true
-                                  else false end }
+        cond = Proc::new{|option| if [:gem,:gem_file,:file,:builtin].include? option then true else false end }
         options.specify_condition_for :type => cond
         options.validate!
         _name = _options.delete(:name)
@@ -253,16 +257,15 @@ module Carioca
         options.specify_classes_of :name => String
         options.specify_presences_of [:name]
         options.validate!
-        
-        if @loaded_services.include? options[:name] then
+        options = scan_instance_suffix(options)
+        dist = (@list[options[:shortname]][:distributed].nil?)? false : @list[options[:shortname]][:distributed]
+        if dist and @loaded_services.include? options[:name] then
+          @log.debug('Carioca') { "Restarting distributed service #{options[:name]}"} if @log
+          kill_distributed_service options
+        elsif @loaded_services.include? options[:name] then
           @log.debug('Carioca') { "Restarting service #{options[:name]}"} if @log
-          kill_service :name => options[:name]     
+          kill_service options     
         end    
-        if options[:name] =~ /.*_.*/ then
-          (options[:shortname],options[:instance]) = options[:name].split(/_/) 
-        else
-          options[:shortname] = options[:name]
-        end
         verify_requires_dependancies(options)
         require_service(options)
         return instanciate_service(options)
@@ -276,13 +279,16 @@ module Carioca
       # @return [TrueClass,FalseClass] true if registry closed successfully
       def close
         @log.debug('Carioca') { "closing Registry ..." }
+        options = Hash::new
         @loaded_services.keys.each do |service|
-          next if service == 'logger' 
-          @log.debug('Carioca') { "Stopping service #{service} ..."} 
-          self.stop_service :name => service
+          options[:name] = service
+          options = scan_instance_suffix(options)
+          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
         @log.debug('Carioca') { "Registry services closed, logger will be closed asynchronously" }
-        kill_service 'logger'
+        kill_service :name => 'logger'
         return true
       end
 

data/lib/carioca/exceptions.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#---
+# Author : Romain GEORGES
+# type : gem component library
+# obj : Carioca Exceptions definition Module
+#---
+
+# Exception overload class for Carioca
+class RegistryError < Exception; end

data/lib/carioca/helpers.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+#---
+# Author : Romain GEORGES
+# type : gem component library
+# obj : Carioca Helpers definition Module
+#---
+
+class Class
+  # Usage:
+  #     prelaod_service :name => 'service', :params => { :arg => 'value'}
+  def preload_service(_options = {})
+    Carioca::Services::Registry.init.start_service _options
+  end
+
+  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.merge
+    options.validate!
+    Carioca::Services::Registry.init.start_service :name => 'configuration', :params => { :config_file => options[:with_file]}
+  end
+end
+
+
+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.merge
+    options.validate!
+    Carioca::Services::Registry.init :file => options[:with_file]
+  end
+end

data/lib/carioca/private.rb

@@ -0,0 +1,170 @@
+#!/usr/bin/env ruby
+#---
+# Author : Romain GEORGES
+# type : gem component library
+# obj : Carioca Private Module (mixin for Carioca::Services::Registry)
+#---
+
+# private methods to mixin  Carioca::Services::Registry
+# @private
+module PrivateMethodsCariocaServicesRegistry
+
+
+  # private initializer
+  def initialize(_options)
+    @logger_not_in_reg = false
+    @debug = _options[:debug]
+    @registry_filename = _options[:file]
+    @name = _options[:name]
+    @list  = Hash::new
+    load if File::exist?(@registry_filename)
+    unless @list.include?('logger') then
+      self.register_service({:name => 'logger', 
+                              :service => 'Carioca::Services::InternalLogger',
+                              :resource => 'logger', 
+                              :description => "The standard ruby Logger internal wrapper Service", 
+                              :type => :builtin, 
+                              :init_options => { :target => "/tmp/log.file"}})
+      @logger_not_in_reg = true
+    end         
+    @loaded_services = Hash::new
+    # preload logger service
+    @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 
+  # in _options and start it if needed
+  def verify_requires_dependancies(_options)
+    _name = _options[:shortname]
+    if @list[_name].include?(:requires) then
+      @list[_name][:requires].each do |service|
+        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 
+        end
+      end
+    end      
+  end
+  
+  # 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] 
+    when :file then
+      require @list[_name][:resource]
+    when :builtin then
+      _file = Carioca::Services::search_builtins _name
+      if _file then
+        require _file
+      else
+        raise RegistryError::new("Config failed")
+      end
+    when :gem then
+      require @list[_name][:resource] 
+    when :gem_file then
+      (_name,_file) = @list[_name][:resource].split(':')
+      _dfile = Carioca::Services::search_file_in_gem _name,_file
+      if _dfile then
+        require _dfile
+      else
+        raise RegistryError::new("Config failed")
+      end
+    else 
+      raise RegistryError::new("Config failed")
+    end
+  end
+
+
+  # scan for <service>_<instance> and rewrite options with :name and :shortname, :instance
+  def scan_instance_suffix(options)
+    if options[:name] =~ /.*_.*/ then
+      (options[:shortname],options[:instance]) = options[:name].split(/_/)
+    else
+      options[:shortname] = options[:name]
+    end
+    return options
+  end
+  
+  #shutdown ring server if empty
+  def shutdown_ring_if_empty
+    get_ring if @ring_server.nil?
+    if @ring_server.list_services.empty? then
+      @log.debug('Carioca') { "Stopping Ultragreen Ring server if no distributed services found" }
+      @dorsal_controller.stop_ring_server
+    end
+  end
+
+  # run a ring servier instance or get existing
+  def get_ring
+    @dorsal_controller = start_service :name => 'dorsal'
+    @ring_server = @dorsal_controller.bind_to_ring
+    if @ring_server.nil? then
+      @dorsal_controller.start_ring_server
+      @ring_server = @dorsal_controller.bind_to_ring
+      @log.debug('Carioca') { "Starting new Ring Server" } if @log
+    else
+      @log.debug('Carioca') { "Getting already started Ring Server" } if @log
+    end
+  end
+
+  # instanciate Object from class defintion of a service defined in 
+  # the service definition in _opts
+  def instanciate_service(_opts)
+    _name = _opts[:shortname]
+    dist = (@list[_name][:distributed].nil?)? false : @list[_name][:distributed]
+    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 
+      eval("@obj = #{@list[_name][:service]}::new")
+    else
+      eval("@obj = #{@list[_name][:service]}::new(@list[_name][:init_options])")
+    end
+    if dist then
+      @ring_server.start_service({ :name => _opts[:name], :object => @obj, :description => @list[_name][:description], :owner => @name })
+      @loaded_services[_opts[:name]] = @ring_server.bind_to_service :name => _opts[:name]
+    else
+      @loaded_services[_opts[:name]] = @obj
+    end
+    return @loaded_services[_opts[:name]]
+  end
+  
+  # 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
+    @loaded_services[options[:name]].garbage if @loaded_services[options[:name]].respond_to? :garbage
+    @loaded_services.delete(options[:name])
+    return true
+  end
+
+  def kill_distributed_service(options)
+    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
+        @log.debug('Carioca') { "Unlinking distributed Service #{options[:name]} owned by #{@name}." } if @log
+      else
+        @ring_server.destroy_service :name => options[:name]
+        @log.debug('Carioca') { "Killing distributed Service #{options[:name]}." } if @log
+      end
+      @loaded_services.delete(options[:name])
+      shutdown_ring_if_empty
+      return true
+    else
+      @log.debug('Carioca') { "Distributed service #{options[:name]} not in ring" } if @log
+      return false
+    end
+  end
+
+
+end # end of PrivateMethodsCariocaServicesRegistry
+
+