knowledge 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51d29764dd9bdb6b270f4442758757ff5c718382ea9809b4dcabe56c5699b5ae
-  data.tar.gz: 7d3497e51d391f8749f31e7405415a49dbd769ce4a73f8e50ed287ff3c85acb7
+  metadata.gz: 26d7ecee28ecca4444ab9b42c7f98a0a429783fcb4692dbf13db06d30382bbef
+  data.tar.gz: e4775687f169d0171b5b9ab97afb0b676a0222bc90046862e4cddb248d715145
 SHA512:
-  metadata.gz: 1bf281b1fb5c068842bebd16c71379f028726749f76ff0f2120a6b99155afa2a546a5a95193eb5e103fc4317730656c96cf5666b612015101dfc42e06e95ce46
-  data.tar.gz: 3426d895a27222546963c49a7adbc656db3a25aa741dc845a52541f6c03dd9424d52d473cacc6d8123a68859e83383181b691e0b3826d1a2081bf29bfb32746b
+  metadata.gz: e338eb5b0dc2b621d66a1370c10f5080218a949c8dbf1ab1f6729b37bc48dc60288cbb09f8467898b4ccf2e496d2f8bc5a76323b27e450e3e764749b80549021
+  data.tar.gz: 5849a2224c0f9a436d323e868d7e69f4105d3d9c088b4c67846e886536caf35b78fbdf81946a392c5eb90094696f52e42bf80d199852999e5e248b4de501fdc2

data/.circleci/config.yml

@@ -0,0 +1,53 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.5
+      
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+
+      - run:
+          name: RSpec specs
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            
+            bundle exec rspec --format progress \
+                            --out /tmp/test-results/rspec.xml \
+                            --format progress \
+                            $TEST_FILES
+
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results
+
+      - run:
+          name: Rubocop linting
+          command: bundle exec rubocop

data/.gitignore

@@ -10,4 +10,5 @@
 # rspec failure tracking
 .rspec_status
 
-/.ruby-*
+/.ruby-*
+/knowledge-*.gem

data/.rubocop.yml

@@ -4,6 +4,9 @@ Metrics/LineLength:
 Metrics/MethodLength:
   Max: 50
 
+Metrics/ClassLength:
+  Max: 200
+
 Metrics/BlockLength:
   Exclude:
     - knowledge.gemspec

data/README.md

@@ -2,11 +2,14 @@
 
 Configuration variables are a project's knowledge. This gem is here to help your projects learn what they need to work properly.
 
+Knowledge is a multi-source highly customizable configuration variables manager.
+
+
 ## Disclaimer
 
-The full documentation is currently being written. You should be able to find a better documentation in a few hours.
+The full documentation is currently being written. You should be able to find a better documentation in a few hours / days.
 
-Waiting for the full documentation, you can have a look at the code which is already well-documented.
+Waiting for the full documentation, you can have a look at the code which is already well-documented or at the [wiki](https://github.com/knowledge-ruby/knowledge/wiki)
 
 ## Installation
 
@@ -40,6 +43,43 @@ knowledge.gather!
 Knowledge::Configuration.key # => "value"
 ```
 
+**Using a config file**:
+
+```yml
+key: value
+```
+
+```ruby
+knowledge = Knowledge::Learner.new
+
+knowledge.use(name: :file)
+knowledge.variables = 'path/to/file.yml'
+knowledge.gather!
+
+Knowledge::Configuration.key # => "value"
+```
+
+Or
+
+```yml
+development:
+    key: value
+production:
+    key: other_value
+```
+
+```ruby
+Knowledge.config.environment = :production
+
+knowledge = Knowledge::Learner.new
+
+knowledge.use(name: :file)
+knowledge.variables = 'path/to/file.yml'
+knowledge.gather!
+
+Knowledge::Configuration.key # => "other_value"
+```
+
 **Using your own setter**:
 
 ```ruby

data/lib/knowledge.rb

@@ -7,11 +7,11 @@ require 'knowledge/exceptions'
 require 'knowledge/learner'
 
 #
-# === Description ===
+# === Description
 #
 # Configuration is your project's knowledge, let's make it very simple!
 #
-# === Configuration ===
+# === Configuration
 #
 # Funny but quite normal, this gem needs some config.
 # If you're familiar with dry-configurable, it should be very understandable for you.
@@ -27,7 +27,7 @@ require 'knowledge/learner'
 #     config.environment = ENV['RACK_ENV'] || Rails.env || ENV['APP_ENV'] # Or whatever you want
 #   end
 #
-# === Usage ===
+# === Usage
 #
 # @example:
 #   Knowledge.configure do |config|
@@ -47,9 +47,9 @@ require 'knowledge/learner'
 #   learner.gather!
 #
 module Knowledge
-  # == Behaviors ===================================================================================================
+  # == Behaviors =======================================================================================================
   extend Dry::Configurable
 
-  # == Settings ====================================================================================================
+  # == Settings ========================================================================================================
   setting :environment, :development
 end

data/lib/knowledge/adapters.rb

@@ -2,7 +2,7 @@
 
 module Knowledge
   #
-  # === Description ===
+  # === Description
   #
   # This is the namespace used to put the lib's adapters.
   # You can find the adapters by looking to the inclusions below or to the adapters folder.

data/lib/knowledge/adapters/base.rb

@@ -3,29 +3,43 @@
 module Knowledge
   module Adapters
     #
-    # === Description ===
+    # === Description
     #
     # This adapter is the base adapter.
     # It does nothing specific but is meant to manage all generic stuff.
     #
-    # === Usage ===
+    # === Usage
     #
     # Just inherit from it
     #
-    # === Attributes ===
+    # @example:
+    #
+    #   class MySuperAdapter < Knowledge::Adapters::Base; end
+    #
+    # === Attributes
     #
     # @attr_reader [Class] setter
     # @attr_reader [Hash] variables
     #
     class Base
       # == Attributes ==================================================================================================
-      attr_reader :setter, :variables
+
+      # Setter object used to set variables once retrieved
+      attr_reader :setter
+
+      # Variables descriptor
+      attr_reader :variables
 
       # == Constructor =================================================================================================
+
       #
-      # @option [Hash] :variables
-      # @option [Class] :setter
-      # @option [Hash] :params
+      # Just initializes instance variables with given params
+      #
+      # === Parameters
+      #
+      # @param :variables [Hash]
+      # @param :setter [Class]
+      # @param :params [Hash]
       #
       def initialize(variables:, setter:, params: nil) # rubocop:disable Lint/UnusedMethodArgument
         @variables = variables
@@ -33,13 +47,12 @@ module Knowledge
       end
 
       # == Instance Methods ============================================================================================
-      #
-      # === Description ===
+
       #
       # Should run the actual adapter.
       # This method is meant to be overriden
       #
-      # === Errors ===
+      # === Errors
       #
       # @raise [Knowledge::AdapterRunMethodNotImplemented] if not overridden by subclasses
       #

data/lib/knowledge/adapters/environment.rb

@@ -3,26 +3,30 @@
 module Knowledge
   module Adapters
     #
-    # === Description ===
+    # === Description
     #
     # This adapter takes some vars in ENV vars and put it in your project's config.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
+    #   # Define your vars with the name of the variable as key and the name of the env var as value
+    #   my_vars = { application_token: 'APPLICATION_TOKEN', aws_secret: 'AWS_SECRET_KEY' }
+    #
+    #   # Instanciate the adapter
     #   adapter = Knowledge::Adapters::Environment.new(setter: MySetter, variables: my_vars)
     #
+    #   # And run it
     #   adapter.run
     #
-    # === Attributes ===
+    # === Attributes
     #
     # @attr_reader [Class] setter
     # @attr_reader [Hash] variables
     #
     class Environment < Base
       # == Instance Methods ============================================================================================
-      #
-      # === Description ===
+
       #
       # Runs the actual adapter.
       #

data/lib/knowledge/adapters/file.rb

@@ -3,19 +3,26 @@
 module Knowledge
   module Adapters
     #
-    # === Description ===
+    # === Description
     #
     # This adapter takes some vars in a config file and put it in your project's config.
     # The config file should provide some YAML with key=value format.
     #
-    # === Usage ===
+    # It works exactly like the KeyValue adapter, just pass a path to the learner as variables descriptor.
+    #
+    # === Usage
     #
     # @example:
+    #   # Define your vars with the name of the variable as key and the value as value
+    #   my_vars = { application_token: 's3cret', aws_secret: 's3cret' }
+    #
+    #   # Initializes the adapter
     #   adapter = Knowledge::Adapters::File.new(setter: MySetter, variables: my_vars)
     #
+    #   # And run it
     #   adapter.run
     #
-    # === Attributes ===
+    # === Attributes
     #
     # @attr_reader [Class] setter
     # @attr_reader [Hash] variables

data/lib/knowledge/adapters/key_value.rb

@@ -3,27 +3,31 @@
 module Knowledge
   module Adapters
     #
-    # === Description ===
+    # === Description
     #
     # This adapter takes some vars in a config object and put it in your project's config.
     # The config object should provide a hash with key=value format.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
+    #   # Define your vars with the name of the variable as key and the value as value
+    #   my_vars = { application_token: 's3cret', aws_secret: 's3cret' }
+    #
+    #   # Instanciate the adapter
     #   adapter = Knowledge::Adapters::KeyValue.new(setter: MySetter, variables: my_vars)
     #
+    #   # And run it
     #   adapter.run
     #
-    # === Attributes ===
+    # === Attributes
     #
     # @attr_reader [Class] setter
     # @attr_reader [Hash] variables
     #
     class KeyValue < Base
       # == Instance Methods ============================================================================================
-      #
-      # === Description ===
+
       #
       # Runs the actual adapter.
       #

data/lib/knowledge/backupper.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+require 'knowledge/configuration'
+
+module Knowledge
+  #
+  # === Description
+  #
+  # Object used to backup configuration variables.
+  #
+  # === Usage
+  #
+  # @example:
+  #
+  #   backupper = Knowledge::Backupper.new
+  #
+  #   backupper.register(name: :foo, value: 'bar')
+  #   backupper.register(name: :bar, value: 'baz')
+  #
+  #   backupper.backup!
+  #
+  # === Attributes
+  #
+  # @attr_reader [Hash] configuration
+  # @attr_reader [String] path
+  #
+  class Backupper
+    # == Attributes ====================================================================================================
+
+    # Configuration hash
+    attr_reader :configuration
+
+    # Backup file path
+    attr_reader :path
+
+    # == Constructor ===================================================================================================
+
+    #
+    # Just sets the basic configuration object.
+    #
+    # === Parameters
+    #
+    # @param :path [String] Path to the YAML file where to backup the config
+    #
+    def initialize(path:)
+      @configuration = {}
+      @path = path
+    end
+
+    # == Instance methods ==============================================================================================
+
+    #
+    # Backups the configuration.
+    #
+    def backup!
+      f = File.new(path, 'w')
+
+      f.write(configuration.to_yaml)
+
+      f.close
+    end
+
+    #
+    # Sets the variable before backuping everything.
+    #
+    # === Parameters
+    #
+    # @param :name [String | Symbol]
+    # @param :value [Any]
+    #
+    def set(name:, value:)
+      configuration[name.to_sym] = value
+    end
+    alias register set
+  end
+end

data/lib/knowledge/configuration.rb

@@ -2,14 +2,14 @@
 
 module Knowledge
   #
-  # === Description ===
+  # === Description
   #
   # If the project has no defined way to manage its config, why not providing it our way?
   #
   class Configuration
     class << self
       #
-      # === Description ===
+      # === Description
       #
       # We're doing black magic (a.k.a metaprogramming) to set variables directly on this class.
       # When programmers do black magic, they should redefine some basic things that are broken as a side effect.
@@ -18,21 +18,25 @@ module Knowledge
       #
       # It allows us to see every variable that has been defined on the class by metaprogramming.
       #
-      # === Usage ===
+      # === Usage
       #
       # @example:
       #   # Do some magic before
       #   Knowledge.config.environment = :development
       #   learner = Knowledge::Learner.new
+      #
       #   learner.use name: :default
       #   learner.variables = { foo: :bar }
+      #
       #   learner.gather!
+      #
       #   # And then inspect it
       #   puts Knowledge::Configuration.inspect
       #   # => #<Knowledge::Configuration:0x000047116740290980 @foo="bar">
+      #
       #   # Wonderful, isn't it?
       #
-      # === Parameters ===
+      # === Parameters
       #
       # @return [String] as expected
       #

data/lib/knowledge/exceptions.rb

@@ -2,13 +2,13 @@
 
 module Knowledge
   #
-  # === Description ===
+  # === Description
   #
   # This error class should be considered as the lib's standard error.
   # All error classes inherit from this one.
   # The goal is to be able to rescue Knowledge::Error outside the lib and catch them all.
   #
-  # === Usage ===
+  # === Usage
   #
   # You have many examples behind. Just inherit from this class and it's ok.
   #
@@ -18,28 +18,28 @@ module Knowledge
   class Error < ::StandardError; end
 
   #
-  # === Description ===
+  # === Description
   #
   # This error is used when, at some point, we can't find the adapter we're looking for
   #
   class AdapterNotFound < Error; end
 
   #
-  # === Description ===
+  # === Description
   #
   # This error is used when an adapter has no #run method declared
   #
   class AdapterRunMethodNotImplemented < Error; end
 
   #
-  # === Description ===
+  # === Description
   #
   # This error is pretty generic and is meant to be used when we're not able to gather infos in order to set vars.
   #
   class LearnError < Error; end
 
   #
-  # === Description ===
+  # === Description
   #
   # This error is used when we fail registering an adapter.
   #

data/lib/knowledge/initializer.rb

@@ -2,19 +2,21 @@
 
 module Knowledge
   #
-  # === Description ===
+  # === Description
   #
   # We all need an initializer, here's this lib's initializer.
   # Its role is to gather all informations and run the enabled adapters.
   #
-  # === Usage ===
+  # === Usage
   #
   # @example:
   #   Knowledge::Initializer.new(adapters: adapters, params: { foo: :bar }, setter: setter, variables: variables).run
   #
+  #   # or
+  #
   #   Knowledge::Initializer.run(adapters: adapters, params: { foo: :bar }, setter: setter, variables: variables)
   #
-  # === Attributes ===
+  # === Attributes
   #
   # @attr_reader [Array<String | Symbol>] adapters
   # @attr_reader [Hash] params
@@ -22,15 +24,31 @@ module Knowledge
   # @attr_reader [Hash] variables
   #
   class Initializer
-    # == Attributes ==================================================================================================
-    attr_reader :adapters, :params, :setter, :variables
+    # == Attributes ====================================================================================================
+
+    # Adapters that will be used to retrieve variables' values
+    attr_reader :adapters
+
+    # Additionnal parameters to pass to the adapters
+    attr_reader :params
+
+    # Setter used to set variables after having retrieved their values
+    attr_reader :setter
+
+    # Descriptor for the variables to retrieve/fetch
+    attr_reader :variables
 
     # == Constructor =================================================================================================
+
+    #
+    # Just initializes instance variables with given params.
     #
-    # @option [Array<Class>] :adapters
-    # @option [Hash] :params
-    # @option [Class] :setter
-    # @option [Hash] :variables
+    # === Parameters
+    #
+    # @param :adapters [Array<Class>]
+    # @param :params [Hash]
+    # @param :setter [Class]
+    # @param :variables [Hash]
     #
     def initialize(adapters:, params:, setter:, variables:)
       @adapters = adapters
@@ -42,16 +60,16 @@ module Knowledge
     # == Class methods ===============================================================================================
     class << self
       #
-      # === Description ===
+      # === Description
       #
       # Instanciates the current class and runs all registered adapters.
       #
-      # === Parameters ===
+      # === Parameters
       #
-      # @option [Hash{Symbol => Class}] :adapters
-      # @option [Hash] :params
-      # @option [Class] :setter
-      # @option [Hash] :variables
+      # @param :adapters [Hash{Symbol => Class}]
+      # @param :params [Hash]
+      # @param :setter [Class]
+      # @param :variables [Hash]
       #
       def run(adapters:, params:, setter:, variables: {})
         new(adapters: adapters, params: params, setter: setter, variables: variables).run
@@ -59,8 +77,9 @@ module Knowledge
     end
 
     # == Instance methods ============================================================================================
+
     #
-    # === Description ===
+    # === Description
     #
     # Runs all registered adapters.
     #

data/lib/knowledge/learner.rb

@@ -5,20 +5,21 @@ require 'yaml'
 require 'knowledge/initializer'
 require 'knowledge/adapters'
 require 'knowledge/setter'
+require 'knowledge/backupper'
 
 module Knowledge
   #
-  # === Description ===
+  # === Description
   #
   # Knowledge is something that needs some learning.
   #
-  # === Usage ===
+  # === Usage
   #
   # @example:
   #
   #   learner = Knowledge::Learner.new
   #
-  # === Attributes ===
+  # === Attributes
   #
   # @attr_reader [Hash] additionnal_params
   # @attr_reader [Hash{Symbol => Class}] available_adapters
@@ -28,10 +29,27 @@ module Knowledge
   #
   class Learner
     # == Attributes ====================================================================================================
+
+    # Config variables setter - can be overridden from outside of the object
     attr_accessor :setter
-    attr_reader :additionnal_params, :available_adapters, :enabled_adapters, :variables
+
+    # Additionnal params to be passed to the adapter
+    attr_reader :additionnal_params
+
+    # List of available adapters
+    attr_reader :available_adapters
+
+    # List of enabled adapters
+    attr_reader :enabled_adapters
+
+    # Descriptor object for the variables to set/fetch
+    attr_reader :variables
 
     # == Constructor ===================================================================================================
+
+    #
+    # Just sets default value for instance variables.
+    #
     def initialize
       @additionnal_params = {}
       @available_adapters = {}
@@ -44,6 +62,31 @@ module Knowledge
     class << self
       attr_reader :adapters
 
+      #
+      # Registers given adapter as a default one.
+      # This method is meant to be used only by libraries adding adapters to the lib.
+      #
+      # @see Knowledge::Learner#use for more details on how details are used.
+      #
+      # === Usage
+      #
+      # @example:
+      #   # Define your adapter
+      #   class SuperServiceAdapter < ::Knowledge::Adapters::Base; end
+      #
+      #   # Register your adapter
+      #   Knowledge::Learner.register_default_adapter(names: %i[super_service service], klass: SuperServiceAdapter)
+      #
+      #   # Now you can use it the same way every other default adapters
+      #   learner = Knowledge::Learner.new
+      #
+      #   learner.use(name: :super_service)
+      #
+      # === Parameters
+      #
+      # @param :names [Array<String | Symbol>] The supported names
+      # @param :klass [Class] The actual adapter class
+      #
       def register_default_adapter(names:, klass:)
         @adapters ||= {}
 
@@ -52,16 +95,46 @@ module Knowledge
     end
 
     # == Instance methods ==============================================================================================
+
+    #
+    # Gathers all the knowledge and backups it
+    #
+    # === Usage
+    #
+    # @example:
+    #   learner = Knowledge::Learner.new
+    #
+    #   # Do some config (add adapters, define your setter, etc.)
+    #
+    #   learner.backup!
+    #
+    # === Parameters
+    #
+    # @param :path [String] Path to the YAML file where to backup the config
     #
-    # === Description ===
+    def backup!(path:)
+      backupper = ::Knowledge::Backupper.new(path: path)
+
+      ::Knowledge::Initializer.new(
+        adapters: enabled_adapters,
+        params: additionnal_params,
+        setter: backupper,
+        variables: variables
+      ).run
+
+      backupper.backup!
+    end
+
     #
     # Gathers all the knowledge and put it into your app.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   # Do some config (add adapters, define your setter, etc.)
+    #
     #   learner.gather!
     #
     def gather!
@@ -74,89 +147,90 @@ module Knowledge
     end
 
     # == Adapters methods ============================================================================================
-    #
-    # === Description ===
+
     #
     # Sets additional params to be passed to the adapter through params option.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.add_adapter_param(adapter: :custom, name: :base_path, value: '/base/path')
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :adapter
-    # @option [String | Symbol] :name
-    # @option [any] :value
+    # @param :adapter [String | Symbol] The adapter's name
+    # @param :name [String | Symbol] The parameter's name
+    # @param :value [any] The parameter's value
     #
     def add_adapter_param(adapter:, name:, value:)
       @additionnal_params[adapter.to_sym] ||= {}
       @additionnal_params[adapter.to_sym][name] = value
     end
 
-    #
-    # === Description ===
     #
     # Sets additional params to be passed to the adapter through params option.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.add_adapter_param(name: :base_path, value: '/base/path')
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :adapter
-    # @option [any] :params
+    # @param :adapter [String | Symbol] Adapter's name
+    # @param :params [any] Params to pass
     #
     def add_adapter_params(adapter:, params:)
       @additionnal_params[adapter.to_sym] = params
     end
 
-    #
-    # === Description ===
     #
     # Disables an adapter.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.register_adapter(name: :my_adapter, klass: MyAdapter, enable: true)
+    #
     #   # Somewhere else in the code
     #   learner.disable_adapter(name: :my_adapter) if should_disable_custom_adapter?
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
+    # @param :name [String | Symbol]
     #
     def disable_adapter(name:)
       @enabled_adapters.delete(name.to_sym)
     end
 
-    #
-    # === Description ===
     #
     # Enables an adapter.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
+    #   # Register your adapter
     #   learner.register_adapter(name: :my_adapter, klass: MyAdapter)
+    #
+    #   # Now you can enable it
     #   learner.enable_adapter(name: :my_adapter)
     #
-    # === Errors ===
+    # === Errors
     #
     # @raises [Knowledge::AdapterNotFound] if adapter is not available
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
-    # @option [Hash | String | nil] :variables
+    # @param :name [String | Symbol]
+    # @param :variables [Hash | String | nil]
     #
     def enable_adapter(name:, variables: nil)
       _key, klass = available_adapters.find { |key, _klass| key.to_sym == name.to_sym }
@@ -167,23 +241,22 @@ module Knowledge
       set_adapter_variables(name: name, variables: variables)
     end
 
-    #
-    # === Description ===
     #
     # Registers an adapter and enable it if asked.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.register_adapter(name: :my_adapter, klass: MyAdapter, enable: true)
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
-    # @option [Class] :klass
-    # @option [Boolean] :enable
-    # @option [Hash | String | nil] :variables
+    # @param :name [String | Symbol]
+    # @param :klass [Class]
+    # @param :enable [Boolean]
+    # @param :variables [Hash | String | nil]
     #
     def register_adapter(name:, klass:, enable: false, variables: nil)
       @available_adapters[name.to_sym] = klass
@@ -192,20 +265,19 @@ module Knowledge
     end
 
     #
-    # === Description ===
-    #
-    # Sets variables for a given adapter
+    # Sets variables for a given adapter.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.set_adapter_variables(name: :default, variables: { foo: :bar })
     #
-    # === Attributes ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
-    # @option [Hash | nil] :variables
+    # @param :name [String | Symbol]
+    # @param :variables [Hash | nil]
     #
     def set_adapter_variables(name:, variables: nil)
       return unless variables
@@ -223,20 +295,19 @@ module Knowledge
     end
 
     #
-    # === Description ===
+    # Sets variables as a hash for a given adapter.
     #
-    # Sets variables as a hash for a given adapter
-    #
-    # === Usage ===
+    # === Usage
     #
     # @example
     #   learner = Knowledge::Learner.new
+    #
     #   learner.set_adapter_variables_by_hash(name: :default, variables: { foo: :bar })
     #
-    # === Attributes ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
-    # @option [Hash] :variables
+    # @param :name [String | Symbol]
+    # @param :variables [Hash]
     #
     def set_adapter_variables_by_hash(name:, variables:)
       variables = variables[name.to_s] if variables.key?(name.to_s)
@@ -244,22 +315,22 @@ module Knowledge
       @variables[name.to_sym] = variables
     end
 
-    #
-    # === Description ===
     #
     # Unregisters an adapter and disable it.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.register_adapter(name: :my_adapter, klass: MyAdapter)
+    #
     #   # somewhere else in the code
     #   learner.unregister_adapter(name: :my_adapter)
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
+    # @param :name [String | Symbol]
     #
     def unregister_adapter(name:)
       disable_adapter(name: name)
@@ -267,20 +338,22 @@ module Knowledge
     end
 
     #
-    # === Description ===
+    # Registers & enables one of the lib's default adapters.
     #
-    # Registers & enables one of the lib's adapters.
+    # If you're writing a gem to add an adapter to knowledge, please have a look at
+    # Knowledge::Learned#register_default_adapter
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.use(name: :ssm)
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] name
-    # @option [Boolean] enable
+    # @param :name [String | Symbol]
+    # @param :enable [Boolean]
     #
     def use(name:, enable: true)
       adapter = self.class.adapters[name.to_sym]
@@ -291,33 +364,36 @@ module Knowledge
     end
 
     # == Variables config ==============================================================================================
-    #
-    # === Description ===
+
     #
     # Setter for the variables config.
     #
-    # === Usage ===
+    # === Usage
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.variables = { name: 'value' }
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.use(name: :env)
+    #
     #   learner.variables = { name: 'ENV_KEY' }
     #
     # @example:
     #   learner = Knowledge::Learner.new
+    #
     #   learner.variables = 'path/to/vars/config/file.yml'
     #
-    # === Errors ===
+    # === Errors
     #
     # @raise [Knowledge::LearnError] if parameter isn't a hash or a string
     #
     # === Parameters
     #
-    # @param [String | Hash] path_or_descriptor
+    # @param path_or_descriptor [String | Hash]
     #
     def variables=(path_or_descriptor)
       case path_or_descriptor
@@ -332,14 +408,12 @@ module Knowledge
 
     protected
 
-    #
-    # === Description ===
     #
     # Opens the config file and sets the variable config.
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @param [String] path
+    # @param path [String]
     #
     def fetch_variables_config(path)
       descriptor = yaml_content(path)
@@ -347,13 +421,11 @@ module Knowledge
     end
 
     #
-    # === Description ===
+    # Loads YAML file content.
     #
-    # Loads YAML file content
-    #
-    # === Parameters ===
+    # === Parameters
     #
-    # @param [String] path
+    # @param path [String]
     #
     # @return [Hash]
     #

data/lib/knowledge/setter.rb

@@ -4,32 +4,38 @@ require 'knowledge/configuration'
 
 module Knowledge
   #
-  # === Description ===
+  # === Description
   #
   # If you don't have a defined strategy to manage config for your project, you can use Knowledge's one.
-  # This is the custom setter
+  # This is the custom setter.
   #
-  # === Usage ===
+  # === Usage
   #
   # @example:
+  #
   #   Knowledge::Setter.new.set(name: :foo, value: 'bar')
   #
   class Setter
     # == Constructor ===================================================================================================
+
+    #
+    # Just sets the basic configuration object.
+    #
     def initialize
       @configuration = ::Knowledge::Configuration
     end
 
     # == Instance methods ==============================================================================================
+
     #
-    # === Description ===
+    # === Description
     #
-    # Sets the variable by doing black magic on Knowledge::Configuration
+    # Sets the variable by doing black magic on Knowledge::Configuration.
     #
-    # === Parameters ===
+    # === Parameters
     #
-    # @option [String | Symbol] :name
-    # @option [Any] :value
+    # @param :name [String | Symbol]
+    # @param :value [Any]
     #
     def set(name:, value:)
       @configuration.singleton_class.class_eval { attr_accessor name.to_sym } unless @configuration.respond_to?(name)

data/lib/knowledge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Knowledge
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knowledge
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Johann Wilfrid-Calixte
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-01 00:00:00.000000000 Z
+date: 2018-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -135,6 +136,7 @@ files:
 - lib/knowledge/adapters/environment.rb
 - lib/knowledge/adapters/file.rb
 - lib/knowledge/adapters/key_value.rb
+- lib/knowledge/backupper.rb
 - lib/knowledge/configuration.rb
 - lib/knowledge/exceptions.rb
 - lib/knowledge/initializer.rb