carioca 1.1 → 2.0.1

data/lib/carioca/constants.rb

@@ -0,0 +1,45 @@
+module Carioca
+    module Constants
+
+        VERSION = '2.0.1'
+        DEFAULT_REGISTRY_FILE  = './config/carioca.registry'
+        DEFAULT_CONFIG_FILE = './config/settings.yml'
+        DEFAULT_ENVIRONMENT = :development
+        DEFAULT_CONFIG_ROOT = :carioca
+        DEFAULT_LOCALE = :en
+        
+
+        # service definitions specs
+        SERVICES_MANDATORY_SPECS = {type: Symbol, service: String}
+        SERVICES_FULL_LIST_SPECS = SERVICES_MANDATORY_SPECS.merge({depends: Array, description: String, resource: String })
+        SERVICES_SPECS_DETAIL = {type: [:gem, :stdlib, :file, :internal]} 
+
+        DEFAULT_ENVIRONMENTS_LIST = [:production, :staging, :test, :development]
+
+        BUILTINS = {
+          configuration: { 
+            type: :internal,
+            depends: [:logger],
+            description: "The configuration service of Carioca",
+            service: "Carioca::Services::Config::Factory::new(
+                                 config_filename: Carioca::Registry.config.config_file, 
+                                 stage: Carioca::Registry.config.environment, 
+                                 root: Carioca::Registry.config.config_root)" },
+          logger: {
+            type: :stdlib,
+            resource: "logger",
+            description: "The Logger service of Carioca",
+            depends: [:i18n]
+          },
+          i18n:{
+            type: :internal,
+            description: "The Internalisation service of Carocia",
+            service: "Carioca::Services::I18n.get(
+                                default_locale: Carioca::Registry.config.default_locale,
+                                load_path: Carioca::Registry.config.locales_load_path,
+                                locales_availables: Carioca::Registry.config.locales_availables)"
+          }
+        }
+
+    end
+end

data/lib/carioca/container.rb

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

data/lib/carioca/dependencies.rb

@@ -0,0 +1,19 @@
+require 'yaml'
+require 'forwardable'
+require 'singleton'
+
+require 'rubygems'
+require 'i18n'
+require 'locale'
+require 'deep_merge'
+
+require_relative 'constants'
+require_relative 'validator'
+require_relative 'mixin'
+require_relative 'container'
+require_relative 'helpers'
+require_relative 'configuration'
+
+require_relative 'registry_file'
+require_relative 'registry'
+require_relative 'services/init'

data/lib/carioca/helpers.rb

@@ -1,35 +1,48 @@
-#!/usr/bin/env ruby
-#---
-# Author : Romain GEORGES
-# type : gem component library
-# obj : Carioca Helpers definition Module
-#---
+module Carioca
+    module Helpers
 
-class Class
-  # Usage:
-  #     prelaod_service :name => 'service', :params => { :arg => 'value'}
-  def preload_service(_options = {})
-    Carioca::Services::Registry.init.start_service _options
-  end
+        def log
+            return self.get_service name: :logger
+        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
+        def i18n
+            return self.get_service name: :i18n
+        end
 
+        def debug(message: )
+            log.debug(self.config.name) { "#{message}" } 
+        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
+        # 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
+        end
+
+
+    end
+end

data/lib/carioca/mixin.rb

@@ -0,0 +1,32 @@
+module Carioca
+  module Injector
+    def inject(service: )              
+        self.create_methods(service){return Carioca::Registry.get.get_service name: service }
+    end
+
+    def register(service: , definition:)
+      Carioca::Registry.get.add service: service, definition: definition 
+    end
+
+    def services
+      Carioca::Registry.get.services
+    end
+
+    def active_services
+      Carioca::Registry.get.active_services
+     end
+
+    def create_methods(name, &block)
+      self.define_method name, &block
+      self.class.send(:define_method, name, &block)
+    end
+
+    def self.extended(base)
+      base.include self
+     end
+    
+     
+
+  end
+  
+end

data/lib/carioca/{tasks/rake.rb → rake/manage.rb}

@@ -1,5 +1,6 @@
+# coding: utf-8
 require 'rake'
-require 'rubygems' 
+require 'rubygems'
 require 'carioca'
 
 $VERBOSE = nil
@@ -16,8 +17,5 @@ else
 end
 
 res.pop
-tasks_path = res.join('/').concat('/lib/carioca/tasks/')
-
-  
-Dir["#{tasks_path}/*.rake"].each { |ext| load ext }
-
+tasks_path = res.join('/').concat('/lib/carioca/rake/tasks/')
+Dir["#{tasks_path}/*.task*"].each { |ext| load ext }

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

@@ -0,0 +1,57 @@
+require "tty-prompt"
+require "pastel"
+
+namespace :carioca  do
+    namespace :registry do 
+        desc "Adding service to Carioca Registry file"
+        task :add_service do
+            begin 
+                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
+                if config.builtins.include? name or  registry_file.validated.include? name then
+                    puts 'Carioca : service already defined or Builtins'
+                    exit 1
+                end 
+                definition = {
+                    :type => prompt.select("Choose the service type ?", [:gem, :stdlib, :file, :internal]),
+                    :description => prompt.ask("Description ?", default: "The #{name} service"),
+                    :service => prompt.ask("Service [#{name}] inline Proc Ruby code ?", default: name.to_s.capitalize)
+                }
+                map = {:gem => "Rubygem name", :stdlib => "StdLib name", :file => "absolut path of the Ruby file"}
+                definition[:resource] = prompt.ask("Give the #{map[definition[:type]]} ? ", default: name.to_s ) if  map.keys.include? definition[:type]
+                have_depends = prompt.yes?("Did this service have dependencies ? ")
+                if have_depends then
+                    potentials = config.builtins.merge(registry_file.validated).keys
+                    definition[:depends] = prompt.multi_select("Choose your depends ?", potentials, min: 1)
+                end
+                puts "\n => Service : #{name}"
+                puts "Definition "
+                definition.each do |key,value|
+                    puts " * #{key}: #{value}"
+                end
+                is_correct = prompt.yes?("Is it correct ? ")
+            rescue TTY::Reader::InputInterrupt
+                puts 'Carioca : interrupted'
+                exit 5
+            end
+            if is_correct then 
+                begin
+                    registry_file.add service: name, definition: definition
+                    registry_file.save!
+                rescue => e 
+                    puts "Carioca: Can't save : #{e}"
+                    exit 10
+                end
+
+                puts "Carioca : Registry saved"
+            else
+                puts 'Carioca : Nothing saved'
+            end
+        end
+    end
+  end

data/lib/carioca/registry.rb

@@ -0,0 +1,93 @@
+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
+
+        end
+    
+        attr_accessor :services
+        attr_accessor :active_services
+    
+        def get_service(name: )
+
+          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 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
+          get_service name: :logger
+        end
+
+        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
+          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, filename: @@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.processing') if @@config.debug?
+        end 
+    
+    
+    end
+end

data/lib/carioca/registry_file.rb

@@ -0,0 +1,62 @@
+module Carioca
+
+  
+    
+
+    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
+
+
+    end
+end

data/lib/carioca/services/config.rb

@@ -0,0 +1,140 @@
+class Hash
+    # monkey patching
+    def deep_symbolize
+      target = dup
+      target.inject({}) do |memo, (key, value)|
+        value = value.deep_symbolize if value.is_a?(Hash)
+        memo[key.to_sym] = value
+        memo
+      end
+    end
+  
+    def method_missing(name, *args, &block)
+      if name.to_s =~ /(.+)=$/
+        self[$1.to_sym] = args.first
+      else
+        self[name.to_sym]
+      end
+    end
+  
+  end
+  
+
+
+  module Carioca
+    module Services
+        module Config
+
+            class ConfigFile
+                include Carioca::Constants
+                attr_accessor :filename, :data
+                attr_reader :error
+
+                def initialize(filename:)
+                    @filename = filename
+                    @data = {}
+                    @error = ""
+                    open
+ 
+                end 
+
+                def error? 
+                    return !@error.empty? 
+                end
+
+                def create!(force: false)
+                    write_ok = true
+                    write_ok = force if File::exist? @filename
+                    File.open(@filename, 'w') { |file| file.write(@data.to_yaml) } if write_ok
+                end
+
+                def open
+                    if File::exist?(@filename) then
+                        begin 
+                            @data = YAML.load_file(@filename)
+                        rescue Exception => e
+                            @error = e.message
+                            @data = {}
+                        end
+                    end
+                    prepare!
+                end
+
+                private
+                def prepare!
+                    config = Carioca::Registry.config
+                    @data = {} unless @data.class == Hash
+                    @data.delete_if {|key,value| config.config_root != key }
+                    @data[config.config_root] = {} unless @data.include? config.config_root
+                    config.supported_environment.each do |evt|
+                        @data[config.config_root][evt] = {} unless  @data[config.config_root].include? evt  
+                    end
+                    @data[config.config_root][:default] = {} unless  @data[config.config_root].include? :default
+                    create!
+                end
+
+            end
+            class Settings < Hash
+                
+                attr_accessor :config_file
+                attr_accessor :stage
+               
+                include Carioca::Helpers
+     
+                def initialize(config_filename: , stage:, root:)
+                    registry = Carioca::Registry.get
+                    @logger = registry.get_service name: :logger
+                    @i18n = registry.get_service name: :i18n
+                    
+                    @stage = stage
+                    @root = root
+                    @config_file = Carioca::Services::Config::ConfigFile::new filename: config_filename
+                    initconf
+                end
+                
+                def refresh
+                    initconf
+                end
+                
+                
+                
+                private
+                def initconf
+                    newsets = {}
+                    @logger.debug("Carioca->Config") { @i18n.t('config.load.error', message: @config_file.error) } if @config_file.error? 
+                    @content = @config_file.data
+
+                    unless @stage then
+                        newsets = @content
+                    else
+                        self.merge!  @content[@root][:default]
+                        data = @content[@root][@stage]
+                        self.deep_merge! data
+
+                    end
+
+
+                end
+                
+                
+            end
+
+
+            
+            class Factory
+                extend Forwardable
+              
+                attr_accessor :settings
+                def_delegators :@settings, :refresh 
+
+
+                def initialize(**keywords)
+                    @settings = Carioca::Services::Config::Settings.new(**keywords)
+                end
+                
+            end
+        end
+        
+    end
+end
+  

data/lib/carioca/services/i18n.rb

@@ -0,0 +1,20 @@
+module Carioca
+    module Services
+        class I18n
+
+            def I18n.get(default_locale: , load_path:, locales_availables: )
+                ::I18n::Backend::Simple.include(::I18n::Backend::Fallbacks)
+                ::I18n.load_path << load_path
+                ::I18n.default_locale = default_locale 
+                 ::I18n.fallbacks = locales_availables
+                return ::I18n
+            end
+
+            def I18n.get_system_locale
+               return ::Locale.candidates.to_s.split('_').first.to_sym 
+            end
+
+
+        end
+    end
+end

data/lib/carioca/services/init.rb

@@ -0,0 +1,2 @@
+# encoding: UTF-8
+Dir[File.dirname(__FILE__) + '/*.rb'].sort.each {|file| require file  unless File.basename(file) == 'init.rb'}

data/lib/carioca/validator.rb

@@ -0,0 +1,49 @@
+module Carioca
+    module Services
+        class Validator
+
+            attr_reader :definition
+
+            include Carioca::Constants
+
+            def initialize(definition: , service: )
+                @definition = definition
+                @service = service
+            end 
+
+            def validate!
+                validate_mandatories
+                validate_full_and_type
+                validate_not_builtins
+                fill_content
+            end
+
+            private
+            def validate_not_builtins
+
+                raise "Builtins reserved name #{@service.to_s}" if BUILTINS.keys.include? @service
+            end
+
+            def validate_mandatories
+                SERVICES_MANDATORY_SPECS.keys.each do |spec|
+                    raise "Key : :#{spec} is mandatory in a service definition" unless @definition.include? spec
+                end
+            end
+
+            def validate_full_and_type
+                @definition.each do |spec,value|
+                    raise "Key : :#{spec} is not allowed in a service definition" unless SERVICES_FULL_LIST_SPECS.include? spec
+                    raise "key : #{spec} must be a : #{SERVICES_FULL_LIST_SPECS[spec].to_s}" unless value.class == SERVICES_FULL_LIST_SPECS[spec]
+                    if SERVICES_SPECS_DETAIL.include? spec then
+                        raise "key : #{spec} must be in : #{SERVICES_SPECS_DETAIL[spec].to_s}" unless SERVICES_SPECS_DETAIL[spec].include? value
+                    end
+                end
+            end
+
+            def fill_content
+                @definition[:description] = @service.to_s unless @definition.include? :description
+            end
+
+        end
+    end
+end