carioca 1.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9be0e1efee67cbc15309f5eb56a72208681b14d84c3c1f3666474c28798c1c51
-  data.tar.gz: 66033e08a911cd0b537eb7ca1114a8aca2d445f8cae79e9d04e62190e27d0a0c
+  metadata.gz: c349ebcb566a9571f7cd424b6cb3a95dd3b6871a99caf992ac04af996a35259a
+  data.tar.gz: d4f4a5db811c978fe0390f41a757a352452c844f72775c21435c6ca1656213c1
 SHA512:
-  metadata.gz: 85c41d310a6ad5f7704b2f244a1616160569dd389939c4ed389b08d81520f15f1c304e5ece750e29205043544bcca886ad39a6925be24c941044acaf5a3c8cbd
-  data.tar.gz: 95cdb63add808821f358742e1fbd6ef611ebc49f062901405ec37cc972dcf7c8695a88583f16685b020df3f08485c8bc1dec83d2868c44641a67fd53c5c0ecef
+  metadata.gz: d05baa11c7379fe052161140fef4a17dd075ce2998c600ad5023d947edf76769fe2020829438863bc4adf4ee4c62f50da2bfb73c2937a5837fe6a48be87de1fb
+  data.tar.gz: 1e12daba542a3e103205f1f7f7fcd71f82a924b2e247fc48ca6a0ee0feb9e4fca85e3a22d2b6baf9c2b7c705b6ef71d0e70611cd9509928eb25584b423a8578a

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -1,4 +1,9 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem 'i18n', "~> 1.10"
+gem 'locale', "~> 2.1"
+gem "deep_merge", "~> 1.2"

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    carioca (2.0.0)
+      tty-prompt (~> 0.23.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (13.0.6)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.4)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  arm64-darwin-20
+  ruby
+
+DEPENDENCIES
+  carioca!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.3

data/README.md

@@ -1,239 +1,31 @@
 # Carioca
 
-## Content
-
-Author:: Romain GEORGES <romain@ultragreen.net> 
-Version:: 1.0
-WWW:: http://www.ultragreen.net/projects/carioca
-
-## Description 
-
-CARIOCA is Configuration Agent and Registry with Inversion Of Control for your Applications
-Carioca provide a full IoC light Container for designing your applications
-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 :
-
-```
-   $ sudo zsh
-   # gem ins carioca
-```
-## Implementation 
-
-* [Carioca]
-* [Carioca::Services]
-* [Carioca:Services::Registry]
-
-## Utilisation
-
-Carioca may be used to create Ruby applications, based on a service registry 
-Carioca come with somes builtin services :
-* logger : an Internal logger based on the logger gem.
-* Configuration : a Configuration Service, with Yaml percistance, and pretty accessors.
-* Debug : a Class Debugger, based on Proxy Design pattern and meta-programation like method_missing   
-
-### Getting start
-
-#### Preparing Gem
-
-Just after Installation, Carioca :
-
-```
-  $ gem ins bundler # if needed
-  $ bunlde gem myapp
-  $ cd myapp
-```
-
-Edit your myapp.gemspec, add this line in Gem::Specification bloc :
-
-```ruby
-  gem.add_dependency 'carioca'
-  gem.add_development_dependency 'rake'
-  gem.add_development_dependency 'carioca'
-```
-
-Description and summary need to be changed to be correctly displayed on Rubygems.
-
-so, execute bundle :
-
-```
-  $ bundle
-```
-
-Your environment, is ready to create your app
-
-#### Prepare Carioca
-
-```
-  $ mkdir config
-  $ mkdir bin
-```
-
-edit bin/myapp :
-
-```ruby
-  require 'rubygems' 
-  require 'carioca'
-
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry'
-```
-
-
-After, you could Run Carioca and discover Builtins Services, you need the write access to config path
-
-
-```
-  $ ruby -e 'require "rubygems"; require "carioca"; reg = Carioca::Services::Registry.init :file => "config/myservices.registry"; reg.discover_builtins; reg.save!'
-```
-
-
-this create you, a New Registry config, with all builtins registered.
-Default path :
-* config file : ./.config
-* log file : /tmp/log.file
-Carioca Registry is a Singleton, and services also be unique instance.
-
-Now you could continue coding your bin/myapp
-
-#### Using Configuration Service
-
-```ruby
-  require 'rubygems'
-  require 'carioca'
-
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry'
-  config = registry.start_service :name => 'configuration'
-  config.setings.db = { :name => 'mydb' }
-  config.settings.db.host = "myhost"
-  config.settings.db.port = "4545"
-  config.settings.email = "my@email.com"
-  config.save!
-```
-
-#### Using Logger Service
-
-logger is automatically loaded with Carioca, loading registry with :debug => true, let you see the Carioca traces. 
-
-```ruby
-  require 'rubygems'
-  require 'carioca'
-
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry' :debug => true
-  log = registry.get_service :name => 'logger'
-  log.info('myapp') {'my message' }
-```
-
-#### Creating and using your own service
-
-before create your own service :
-
-```
-  $ mkdir services
-```
-
-Services, must be a class, if not do a wrapper
-edit services/myservice.rb
-
-```ruby
-  class MyService
-      def initialize
-      end
-
-      def test(arg = nil)
-        return 'OK'
-      end
-    end
-  end
-```
-
-You could use the #service_register API (See spec for all details)
-but, you could write it directly in YAML in your config/myservices.registry :
-add the following lines :
-
-```yaml
-  ...
-  myservice:
-    :type: :file
-    :resource: services/myservice.rb
-    :description: a test service
-    :service: MyServices
-  ...
-
-So in your app :
-
-```ruby
-  require 'rubygems'
-  require 'carioca'
-
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry'
-  service = registry.start_service :name => 'myservice'
-  service.test('titi')
-```
-
-#### Using Debug in multiple service instance
-
-
-in your app, for debug you could use the Proxy Debug (you need to run Carioca Registry in debug mode ) :
-(Using "debug_", you create an instance of service debug, so with this syntaxe you could create multiple services instances, with different parameters calling.)
+Add this line to your application's Gemfile:
 
 ```ruby
-  require 'rubygems'
-  require 'carioca'
-
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry' :debug => true
-  proxy1  = registry.get_service :name => 'debug_myservice', :params => {:service => 'myservice'}
-  proxy1.test('titi')
+gem 'carioca'
 ```
 
+And then execute:
 
-see the log /tmp/log.file  :
+    $ bundle install
 
-```
-    D, [2013-03-23T18:20:39.839826 #76641] DEBUG -- ProxyDebug: BEGIN CALL for mapped service myservice
-    D, [2013-03-23T18:20:39.839875 #76641] DEBUG -- ProxyDebug: called: test
-    D, [2013-03-23T18:20:39.839920 #76641] DEBUG -- ProxyDebug: args : titi
-    D, [2013-03-23T18:20:39.839970 #76641] DEBUG -- ProxyDebug: => returned: OK
-    D, [2013-03-23T18:20:39.840014 #76641] DEBUG -- ProxyDebug: END CALL
-```
+Or install it yourself as:
 
-#### Using Gem for a service
+    $ gem install carioca
 
+## Usage
 
-For exemple install uuid gem :
 
-```
-  $ gem ins uuid
-```
 
-add to your YAML config config/myservices.registry :
+## Development
 
-```yaml
-  uuid:
-    :type: :gem
-    :resource: uuid
-    :description: a Rubygems called uuid to build UUID ids.
-    :service: UUID  
-```
-
-in your app :
-
-```ruby
-  require 'rubygems'
-  require 'carioca'
-
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry' :debug => true
-  uuid  = registry.get_service :name => 'uuid'
-  uuid.generate
-```
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-== Copyright
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-<pre>carioca (c) 2012-2013 Romain GEORGES <romain@ultragreen.net> for Ultragreen Software </pre>
+## Contributing
 
+Bug reports and pull requests are welcome on GitHub at https://github.com/Ultragreen/carioca.

data/Rakefile

@@ -1,69 +1,8 @@
-require 'rubygems'
-require "bundler/gem_tasks"
-require 'rspec'
-require 'rake'
-require "rake/clean"
-require "rubygems/package_task"
-require "rdoc/task"
-require 'rspec/core/rake_task'
-require 'yard'
-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"
-end
-
-
-CLEAN.include('*.tmp','*.old')
-CLOBBER.include('*.tmp', 'build/*','#*#')
-
-
-content = File::readlines(File.join(File.dirname(__FILE__), 'carioca.gemspec')).join
-spec = eval(content)
-
-RSpec::Core::RakeTask.new('spec')
+# frozen_string_literal: true
 
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
 
-YARD::Rake::YardocTask.new do |t|
-  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')
-
-namespace :yardoc do
-  task :clobber do
-    rm_r "yardoc" rescue nil
-    rm_r ".yardoc" rescue nil
-  end
-end
-task :clobber => "yardoc:clobber"
-
-
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
-
-Rake::RDocTask.new('rdoc') do |d|
-  d.rdoc_files.include('doc/**/*','bin/*')
-  d.main = 'doc/manual.rdoc'
-  d.title = 'Uglibs : Ultragreen libraries'
-  d.options << '--line-numbers' << '--diagram' << '-SHN'
-end
-
-task :default => [:gem]
-
-task :stage do
-  Rake::Task["clean"].invoke
-  Rake::Task["clobber"].invoke
-  Rake::Task["install"].invoke
-end
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "carioca"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/carioca.gemspec

@@ -1,32 +1,41 @@
-Gem::Specification.new do |s|
-  s.name = %q{carioca}
-  s.author = "Romain GEORGES"
-  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{https://github.com/Ultragreen/carioca}
-  s.description = %q{Carioca : provide a full IoC light Container for designing your applications}
-  s.files = `git ls-files`.split($/)
+# frozen_string_literal: true
 
+require_relative "lib/carioca/constants"
 
-  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'
+Gem::Specification.new do |spec|
+  spec.name          = "carioca"
+  spec.version       = Carioca::Constants::VERSION
+  spec.authors       = ["Romain GEORGES"]
+  spec.email         = ["romain@ultragreen.net"]
 
 
-s.add_development_dependency 'uuid', '~> 2.3.9'
 
 
+  spec.license =  "BSD-3-Clause"
+
+  spec.summary = %q{Carioca : Configuration Agent and Registry with Inversion Of Control for your Applications}
+  spec.homepage = %q{https://github.com/Ultragreen/carioca}
+  spec.description = %q{Carioca : provide a full IoC light Container 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"
 
-  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'
 
 end

data/config/locales/en.yml

@@ -0,0 +1,15 @@
+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}"
+  init: 
+    carioca: "Initializing Carioca registry"
+    builtins: "Preparing builtins services"
+    registry: 
+        processing: "Initializing registry from file : %{filename}"
+        success: "Registry initialized successfully"

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,47 @@
+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
+        attr_writer :debug, :init_from_file
+        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 = ''
+            @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 = []
+            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 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,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