carioca 1.3 → 2.0.2

data/carioca.gemspec

@@ -1,33 +1,46 @@
-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.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.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.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.required_ruby_version = '>= 1.8.1'
-  s.rdoc_options << '--title' << 'Carioca : Gem documentation' << '--main' << 'doc/manual.rdoc' << '--line-numbers' 
-  # << '--diagram'
-  s.rubyforge_project = "nowarning"
+# frozen_string_literal: true
+
+require_relative "lib/carioca/constants"
+
+Gem::Specification.new do |spec|
+  spec.name          = "carioca"
+  spec.version       = Carioca::Constants::VERSION
+  spec.authors       = ["Romain GEORGES"]
+  spec.email         = ["romain@ultragreen.net"]
+
+
+
+
+  spec.license =  "BSD-3-Clause"
+
+  spec.summary = %q{Carioca : Container And Registry with Inversion Of Control for your Applications}
+  spec.homepage = %q{https://github.com/Ultragreen/carioca}
+  spec.description = %q{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}
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "tty-prompt", "~>0.23.1"
+  spec.add_dependency "pastel", "~>0.8.0"
+  spec.add_dependency 'i18n', "~> 1.10"
+  spec.add_dependency 'locale', "~> 2.1"
+  spec.add_dependency "deep_merge", "~> 1.2"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+
 end

data/config/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  service: 
+    adding: "Adding service %{name}"
+    starting: "Starting service %{name}"
+    getting: "Getting service %{name}"
+    depends: "Dependencie service %{name}"
+  notify: 
+    locale: "Preloaded service :i18n on locale : %{loc}"
+    logger: "Preloaded service :logger ready on %{target}"
+    useless_entry: "Useless entry in registry (builtin service) %{altered} in %{filename}"
+  init: 
+    carioca: "Initializing Carioca registry"
+    builtins: "Preparing builtins services"
+    registry: 
+      processing: "Initializing registry from file : %{filename}"
+      success: "Registry initialized successfully"
+  config:
+    load:
+      error: "Config file ignored, error : %{message}"

data/config/locales/fr.yml

@@ -0,0 +1,19 @@
+fr:
+  service:
+    adding: "Service %{name} Ajouté"
+    starting: "Démarrage du service %{name}"
+    getting: "Appel du service %{name}"
+    depends: "Dépendence du service %{name}"
+  notify: 
+    locale: "Service pré-chargé :i18n sur la locale : %{loc}"
+    logger: "Service pré-chargé :logger sur la cible : %{target}"
+    useless_entry: "Entrée inutile dans le registre (service pré-defini) %{altered} dans %{filename}"
+  init: 
+    carioca: "Initialisation du registre Carioca"
+    builtins: "Préparation des services pré-définis"
+    registry: 
+      processing: "Initialisation du registre depuis le fichier : %{filename}"
+      success: "Registre initialisé avec succès"
+  config:
+    load:
+      error: "Fichier de configuration ignoré, erreur : %{message}"

data/lib/carioca/configuration.rb

@@ -0,0 +1,60 @@
+module Carioca
+    class Configuration
+        include Carioca::Constants
+        include Carioca::Helpers
+        attr_accessor :filename, :name, :builtins, :log_target, :default_locale, :locales_load_path
+        attr_accessor :config_file, :config_root, :environment, :supported_environment, :output_mode, :log_level
+        attr_writer :debug, :init_from_file,  :output_colors, :output_emoji
+        attr_reader :log_file, :locales_availables
+        def initialize
+            @init_from_file = true
+            @filename = DEFAULT_REGISTRY_FILE.dup
+            @debug = false
+            @name = 'Carioca' 
+            @builtins = BUILTINS
+            @log_file = ''
+            @log_level = DEFAULT_LOG_LEVEL.dup
+            @log_level = :info if @debug == false and @log_level == :debug
+            @config_file = DEFAULT_CONFIG_FILE.dup
+            @environment = DEFAULT_ENVIRONMENT.dup
+            @config_root = DEFAULT_CONFIG_ROOT.dup
+            @log_target = '::Logger::new(STDOUT)'
+            @supported_environment = DEFAULT_ENVIRONMENTS_LIST.dup
+            @default_locale = DEFAULT_LOCALE
+            @locales_availables = []
+            @output_mode = DEFAULT_OUTPUT_MODE.dup
+            @output_colors  = DEFAULT_COLORS_STATUS.dup
+            @output_emoji = DEFAULT_EMOJI_STATUS.dup
+            path = search_file_in_gem('carioca',"config/locales")
+            @locales_load_path = Dir[File.expand_path(path) + "/*.yml"]
+            Dir[path + '/*.yml'].sort.each do |file|
+                @locales_availables.push File::basename(file,'.yml').to_sym
+            end
+        end
+
+        def debug? 
+            return @debug
+        end
+
+        def output_colors? 
+            return @output_colors
+        end
+
+        def output_emoji? 
+            return @output_emoji
+        end
+
+        def init_from_file? 
+            return @init_from_file
+        end
+
+        def log_file?
+            return !@log_file.empty?
+        end
+
+        def log_file=(name)
+            @log_file = name
+            @log_target = "::Logger::new('#{name}')"
+        end
+    end
+end

data/lib/carioca/constants.rb

@@ -0,0 +1,60 @@
+module Carioca
+    module Constants
+
+        VERSION = '2.0.2'
+        DEFAULT_REGISTRY_FILE  = './config/carioca.registry'
+        DEFAULT_CONFIG_FILE = './config/settings.yml'
+        DEFAULT_ENVIRONMENT = :development
+        DEFAULT_CONFIG_ROOT = :carioca
+        DEFAULT_LOCALE = :en
+        
+
+        DEFAULT_OUTPUT_MODE = :mono
+        DEFAULT_EMOJI_STATUS = true
+        DEFAULT_COLORS_STATUS = true
+        DEFAULT_LOG_LEVEL = :info
+
+        # 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)"
+          },
+          output:{
+            type: :internal,
+            description: "The Output serice of Carioca",
+            service: "Carioca::Services::Output::Provider::new(
+                                mode: Carioca::Registry.config.output_mode,
+                                emoji: Carioca::Registry.config.output_emoji?,
+                                colors: Carioca::Registry.config.output_colors?,
+                                level: Carioca::Registry.config.log_level
+            )"
+          }
+        }
+
+    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,20 @@
+require 'yaml'
+require 'forwardable'
+require 'singleton'
+
+require 'rubygems'
+require 'i18n'
+require 'locale'
+require 'deep_merge'
+require 'pastel'
+
+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,94 @@
+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
+          log = get_service name: :logger
+          log.level = @@config.log_level
+        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, 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 
+    
+    
+    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