carioca 1.3 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7452e3def3859f67723245f65eaca57325c02df7
-  data.tar.gz: e62a5e8df75b45796408e2b23b8ffa3f7272b9dc
+SHA256:
+  metadata.gz: 23b95a753d4b358bde71f7d1e9f59ba9456b40302ef9a028a5e791a00c2c7d07
+  data.tar.gz: cb29906d32001f5eecf0b7f78e161cf86436b11cec67377a9efacd2ecf63a469
 SHA512:
-  metadata.gz: da22b8fb540c74436f8a594500a8be39a6f40c5fa449b4354a2499da95b9e67a4557a117a544f11645a67a68178eeb3c3b1c54c52eedea4767a43a78f60ce924
-  data.tar.gz: 226b261c12350b1b31729bc42631c7e4ba4f62d6d69de13da218e4daa11c81fdf362082eeb3ab2f7d795f19013609a7fd17dfc21d6cc44cd329c37db04542a45
+  metadata.gz: b105358ef95e063ffdeea22f81eff91dc0a9044b6dcc941fb0449b0d5f6a9b8106d2cdead2d6fd81223b5863d3a2e8ec902d0ce339c24b6c350f84dbcbd4fb4c
+  data.tar.gz: ccd2744676d47b0dd3e6e25acf29194441c2217018d7b1ca1266b55ad598a942b23ae219c26277b6b2986c67c1dcce1b1dc74ee041e4b32f1fab1ec4ed21c567

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,6 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 gemspec
 
+
+

data/Gemfile.lock

@@ -1,54 +1,58 @@
 PATH
   remote: .
   specs:
-    carioca (1.0)
-      dorsal
-      methodic
+    carioca (2.0.2)
+      deep_merge (~> 1.2)
+      i18n (~> 1.10)
+      locale (~> 2.1)
+      pastel (~> 0.8.0)
+      tty-prompt (~> 0.23.1)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    code_statistics (0.2.13)
-    daemons (1.1.9)
-    diff-lcs (1.2.1)
-    dorsal (1.0)
-      daemons
-    macaddr (1.6.1)
-      systemu (~> 2.5.0)
-    methodic (1.2)
-    rdoc (4.0.0)
-    roodi (2.2.0)
-      ruby_parser (~> 2.3.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)
-    systemu (2.5.2)
-    uuid (2.3.7)
-      macaddr (~> 1.0)
-    yard (0.8.5.2)
-    yard-rspec (0.1)
-      yard
+    concurrent-ruby (1.1.9)
+    deep_merge (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    locale (2.1.3)
+    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!
-  code_statistics
-  rdoc
-  roodi
-  rspec
-  uuid
-  yard
-  yard-rspec
+  rake (~> 13.0)
+  rspec (~> 3.0)
 
 BUNDLED WITH
-   1.10.3
+   2.2.3

data/README.md

@@ -1,239 +1,172 @@
 # 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 :
+Install it yourself as:
 
-```
-  $ gem ins bundler # if needed
-  $ bunlde gem myapp
-  $ cd myapp
-```
+    $ gem install carioca
 
-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'
-```
+## Usage
 
-Description and summary need to be changed to be correctly displayed on Rubygems.
 
-so, execute bundle :
+### Basic usage
 
-```
-  $ bundle
-```
+Create you own gem :
 
-Your environment, is ready to create your app
+    $ bundle gem yourgem
+    $ cd yourgem
+    $ vi yourgem.gemspec
 
-#### Prepare Carioca
-
-```
-  $ mkdir config
-  $ mkdir bin
-```
-
-edit bin/myapp :
+check all the TODO in your gemspec, specify concretly you Gem specification, add the following line :
 
 ```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
-
-
+     spec.add_dependency "carioca", "~> 2.0"
 ```
-  $ ruby -e 'require "rubygems"; require "carioca"; reg = Carioca::Services::Registry.init :file => "config/myservices.registry"; reg.discover_builtins; reg.save!'
-```
-
+and after :
 
-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.
+    $ bundle add carioca
+    $ mkdir -p config/locales
 
-Now you could continue coding your bin/myapp
-
-#### Using Configuration Service
+Edit the Rakefil, and add the following line :
 
 ```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. 
+require "carioca/rake/manage"
+```
+Verify, all is right with :
+
+    $ rake -T
+    rake build                         # Build yourgem-0.1.0.gem into the pkg directory
+    rake carioca:registry:add_service  # Adding service to Carioca Registry file
+    rake clean                         # Remove any temporary products
+    rake clobber                       # Remove any generated files
+    rake install                       # Build and install yourgem-0.1.0.gem into system gems
+    rake install:local                 # Build and install yourgem-0.1.0.gem into system gems without network access
+    rake release[remote]               # Create tag v0.1.0 and build and push yourgem-0.1.0.gem to Set to 'http://mygemserver.com'
+    rake spec                          # Run RSpec code examples
+
+You could now initialize the Carioca registry following the wizard, with (sample with a simple UUID generator gem): 
+
+    $ rake carioca:registry:add_service
+    Carioca : registering service :
+    Registry File path ? ./config/carioca.registry
+    Service name ? uuid
+    Choose the service type ? gem
+    Description ? The uuid service
+    Service [uuid] inline Proc Ruby code ? UUID
+    Give the Rubygem name ?  uuid
+    Did this service have dependencies ?  no
+
+     => Service : uuid
+    Definition
+     * type: gem
+     * description: The uuid service
+     * service: UUID
+     * resource: uuid
+    Is it correct ?  Yes
+    Carioca : Registry saved
+
+This will initiate a Carioca Registry (YAML file, the format will be describe after, the wizard support all type of services, managed by Carioca, all keys are Symbols):
+
+    $ cat config/carioca.registry
+    ---
+    :uuid:
+      :type: :gem
+      :description: The uuid service
+      :service: UUID
+      :resource: uuid
+
+Now your are ready to use Carioca :
+
+In this sample, we are going th create a demo command. 
+Firstly, we have to configure a basic usage of Carioca, this could be made in the lib path, in the root gem library. 
+
+    $ emacs lib/yourgem.rb 
+
+content of the destination file 
 
 ```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' }
-```
+# frozen_string_literal: true
 
-#### Creating and using your own service
+require_relative "yourgem/version"
+require 'carioca'
 
-before create your own service :
 
-```
-  $ mkdir services
-```
+Carioca::Registry.configure do |spec|
+  spec.debug = true
+end
 
-Services, must be a class, if not do a wrapper
-edit services/myservice.rb
+module Yourgem
+  class Error < StandardError; end
 
-```ruby
-  class MyService
-      def initialize
-      end
-
-      def test(arg = nil)
-        return 'OK'
-      end
+  class YourgemCMD < Carioca::Container
+    def test
+      logger.info(self.to_s) { "Log me as an instance method" }
+      logger.warn(self.class.to_s) {"Give me an UUID : "  + uuid.generate}
     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 :
+    inject service: :uuid
 
-```yaml
-  ...
-  myservice:
-    :type: :file
-    :resource: services/myservice.rb
-    :description: a test service
-    :service: MyServices
-  ...
+    logger.info(self.to_s) { "Log me as class method" }
 
-So in your app :
+  end
 
-```ruby
-  require 'rubygems'
-  require 'carioca'
+end
 
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry'
-  service = registry.start_service :name => 'myservice'
-  service.test('titi')
 ```
 
-#### Using Debug in multiple service instance
+    $ emacs exe/yourgem_cmd
 
-
-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.)
+content of the file
 
 ```ruby
-  require 'rubygems'
-  require 'carioca'
+require 'yourgem'
 
-  registry = Carioca::Services::Registry.init :file => 'config/myservices.registry' :debug => true
-  proxy1  = registry.get_service :name => 'debug_myservice', :params => {:service => 'myservice'}
-  proxy1.test('titi')
+yourgem_cmd = Yourgem::YourgemCMD::new
+yourgem_cmd.test
 ```
 
+After this, don't forget to stage new files, and you could build & install the gem before running your new command for the first time :
 
-see the log /tmp/log.file  :
-
-```
-    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
-```
+    $ git add config/ exe/
+    $ rake install && yourgem_cmd
+    yourgem 0.1.0 built to pkg/yourgem-0.1.0.gem.
+    yourgem (0.1.0) installed.
+    D, [2022-03-04T23:11:52.663459 #88808] DEBUG -- Carioca: Preloaded service :i18n on locale : en
+    D, [2022-03-04T23:11:52.663519 #88808] DEBUG -- Carioca: Preloaded service :logger ready on STDOUT
+    D, [2022-03-04T23:11:52.663537 #88808] DEBUG -- Carioca: Initializing Carioca registry
+    D, [2022-03-04T23:11:52.663550 #88808] DEBUG -- Carioca: Preparing builtins services
+    D, [2022-03-04T23:11:52.663580 #88808] DEBUG -- Carioca: Adding service configuration
+    D, [2022-03-04T23:11:52.663609 #88808] DEBUG -- Carioca: Adding service i18n
+    D, [2022-03-04T23:11:52.663649 #88808] DEBUG -- Carioca: Initializing registry from file : ./config/carioca.registry
+    D, [2022-03-04T23:11:52.663773 #88808] DEBUG -- Carioca: Adding service uuid
+    D, [2022-03-04T23:11:52.663794 #88808] DEBUG -- Carioca: Registry initialized successfully
+    I, [2022-03-04T23:11:52.663802 #88808]  INFO -- Sample::YourGemCMD: Log me as class method
+    I, [2022-03-04T23:11:52.663813 #88808]  INFO -- #<Sample::YourGemCMD:0x00000001312c0bf0>: Log me as an instance method
+    D, [2022-03-04T23:11:52.663844 #88808] DEBUG -- Carioca: Starting service uuid
+    W, [2022-03-04T23:11:52.682812 #88808]  WARN -- Sample::YourGemCMD: Give me an UUID : 0505f3f0-7e36-013a-22c7-1e00870a7189
 
-#### Using Gem for a service
+You could see, somme interesting things : 
+* Carioca have an internationalisation service (this service will be explain in detail after): 
+  * default configured on :en locale
+  * must be in French (:fr) or English (:en), other traductions are welcome
+* Carioca have a builtin logger service using regular Logger from Stdlib (also explain in detail in this document)
+  * default logging on STDOUT, but could be redirect in the configure bloc
+* Carioca give us some usefull traces in debug   
+* Carioca come with a Container Class Template
+  * the Container automatically inject :logger, :i18n and a :configuration service (explain in detail after) 
+  * the Container provide a class method macro :inject 
+    *  this macro give a way to use other services defined in the registry file (service could be register inline, presented after)   
 
+## A step further 
 
-For exemple install uuid gem :
 
-```
-  $ gem ins uuid
-```
+## Development
 
-add to your YAML config config/myservices.registry :
-
-```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,62 +1,8 @@
-require 'rubygems'
+# frozen_string_literal: true
 
-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"
- 
- 
-RoodiTask.new() do | t |
-t.patterns = %w(lib/**/*.rb)
-t.config = "ultragreen_roodi_coding_convention.yml"
-end
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
+RSpec::Core::RakeTask.new(:spec)
 
-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')
-
-
-
-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 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