knowledge 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409e3b9c102f85c26c55bec5aee42ab024fd8c6ade9b20f5cb54bb9c178a64fe
-  data.tar.gz: 0c783a29e26d3fcb7472c868976528950f921599390ca8e58f7c92394b210228
+  metadata.gz: e28940c54f36797206858a07d3d32df46040353791a38ac382ebea787878a6ae
+  data.tar.gz: 896a9533cf13495a123af671fbffe430ece3c0f25d85183fd9b99b4fd5a79f77
 SHA512:
-  metadata.gz: 9ae56a1eedef1509142f30dca684398b734b8da5b7d17b1c050ff601ebcfa0be58b3fcb2c7b067308a1884233b3e8453f1e89a855147fa19d96182dd9fd93c96
-  data.tar.gz: 85f6bae4579b1755de739279f9a30ed5e62bb6bb2e1944eed482960e2507312ea2606acd73cf65fe8c27d7eaf823259650452a71eb23979bbb9f70b50a6307c7
+  metadata.gz: 3a5aa9d9d3131761a3d1f2b627838d54b352d61f1c37405ec82a2aa82262c0d78739bac2d20f7fb9467911921ce18c0c87b63f186452a9d59a00312028a0cf9f
+  data.tar.gz: d9f4a3335d3cd9f0d6065ec91604ee739a7ac1145d5060eacff40820af8204d40567b8d0ee9de6a5b1d215e7154b370f640a9302f6e69bffbb2bd5f5dbe970df

data/.circleci/config.yml

@@ -6,7 +6,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.5
+      - image: circleci/ruby:2.5.1-node-browsers
       
     working_directory: ~/repo
 
@@ -48,6 +48,6 @@ jobs:
           path: /tmp/test-results
           destination: test-results
 
-      - run:
-          name: Rubocop linting
-          command: bundle exec rubocop
+      # - run:
+      #     name: Rubocop linting
+      #     command: bundle exec rubocop

data/.rubocop.yml

@@ -1,3 +1,9 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  Exclude:
+    - lib/knowledge/version.rb
+    - vendor/bundle/*
+
 Metrics/LineLength:
   Max: 120
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    knowledge (0.1.2)
+    knowledge (0.1.3)
       dry-configurable (~> 0.7)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     ast (2.4.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.3)
+    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     docile (1.3.1)
     dry-configurable (0.7.0)

data/lib/knowledge.rb

@@ -52,4 +52,4 @@ module Knowledge
 
   # == Settings ========================================================================================================
   setting :environment, :development
-end
+end

data/lib/knowledge/adapters/environment.rb

@@ -54,7 +54,6 @@ module Knowledge
 
           setter.set(name: name_in_project, value: value)
         end
-
       rescue ::KeyError => e
         raise ::Knowledge::ValueNotFound, "[#{e.class}]: #{e.message}"
       end

data/lib/knowledge/exceptions.rb

@@ -17,6 +17,13 @@ module Knowledge
   #
   class Error < ::StandardError; end
 
+  #
+  # === Description
+  #
+  # This error is used when a method is not defined
+  #
+  class MethodNotImplemented < Error; end
+
   #
   # === Description
   #
@@ -29,7 +36,7 @@ module Knowledge
   #
   # This error is used when an adapter has no #run method declared
   #
-  class AdapterRunMethodNotImplemented < Error; end
+  class AdapterRunMethodNotImplemented < MethodNotImplemented; end
 
   #
   # === Description
@@ -45,6 +52,13 @@ module Knowledge
   #
   class RegisterError < Error; end
 
+  #
+  # === Description
+  #
+  # This error is used when an adapter has no #run method declared
+  #
+  class SetterSetMethodNotImplemented < MethodNotImplemented; end
+
   #
   # === Description
   #

data/lib/knowledge/initializer.rb

@@ -59,8 +59,6 @@ module Knowledge
 
     # == Class methods ===============================================================================================
     class << self
-      #
-      # === Description
       #
       # Instanciates the current class and runs all registered adapters.
       #
@@ -78,8 +76,6 @@ module Knowledge
 
     # == Instance methods ============================================================================================
 
-    #
-    # === Description
     #
     # Runs all registered adapters.
     #

data/lib/knowledge/learner.rb

@@ -4,7 +4,7 @@ require 'yaml'
 
 require 'knowledge/initializer'
 require 'knowledge/adapters'
-require 'knowledge/setter'
+require 'knowledge/setters'
 require 'knowledge/backupper'
 
 module Knowledge
@@ -54,7 +54,7 @@ module Knowledge
       @additionnal_params = {}
       @available_adapters = {}
       @enabled_adapters = {}
-      @setter = ::Knowledge::Setter.new
+      @setter = ::Knowledge::Setters.config.default.new
       @variables = {}
     end
 

data/lib/knowledge/setter.rb

@@ -6,40 +6,11 @@ module Knowledge
   #
   # === 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.
+  # @deprecated
   #
-  # === Usage
+  # Deprecated, will be removed in v1.0.0.
+  # Use Knowledge::Setters::Knowledge instead.
   #
-  # @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
-    #
-    # Sets the variable by doing black magic on Knowledge::Configuration.
-    #
-    # === Parameters
-    #
-    # @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)
-      @configuration.instance_variable_set(:"@#{name}", value)
-    end
-  end
+  class Setter < ::Knowledge::Setters::Knowledge; end
 end

data/lib/knowledge/setters.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Knowledge
+  #
+  # === Description
+  #
+  # This is the namespace used to put the lib's setters.
+  # You can find the setters by looking to the inclusions below or to the setters folder.
+  #
+  module Setters
+    # == Behaviors =====================================================================================================
+    extend Dry::Configurable
+
+    # == Settings ======================================================================================================
+    setting :default
+  end
+end
+
+require 'knowledge/setters/base'
+require 'knowledge/setters/knowledge'
+
+Knowledge::Setters.config.default = Knowledge::Setters::Knowledge

data/lib/knowledge/setters/base.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'knowledge/configuration'
+
+module Knowledge
+  module Setters
+    #
+    # === Description
+    #
+    # This adapter is the base setter.
+    # It does nothing specific but is meant to manage all generic stuff.
+    #
+    # === Usage
+    #
+    # Just inherit from it
+    #
+    # @example:
+    #
+    #   class MySuperSetter < Knowledge::Setters::Base; end
+    #
+    # === Attributes
+    #
+    # @attr_reader [Class | Hash | Object] configuration
+    #
+    class Base
+      # == Attributes ==================================================================================================
+
+      # Configuration object - can be whetever your setter knows how to work with
+      attr_reader :configuration
+
+      # == Instance methods ============================================================================================
+
+      #
+      # Sets the variable.
+      #
+      # === Parameters
+      #
+      # @param :name [String | Symbol]
+      # @param :value [Any]
+      #
+      def set(name:, value:)
+        error_message = "Expect setter to define #set method to be able to set #{name} with value '#{value}'"
+        raise ::Knowledge::SetterSetMethodNotImplemented, error_message
+      end
+    end
+  end
+end

data/lib/knowledge/setters/knowledge.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'knowledge/configuration'
+
+module Knowledge
+  module Setters
+    #
+    # === 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.
+    #
+    # === Usage
+    #
+    # @example:
+    #
+    #   Knowledge::Setters::Knowledge.new.set(name: :foo, value: 'bar')
+    #
+    # === Attributes
+    #
+    # @attr_reader [Knowledge::Configuration] configuration
+    #
+    class Knowledge < Base
+      # == Constructor =================================================================================================
+
+      #
+      # Just sets the basic configuration object.
+      #
+      def initialize
+        @configuration = ::Knowledge::Configuration
+      end
+
+      # == Instance methods ============================================================================================
+
+      #
+      # Sets the variable by doing black magic on Knowledge::Configuration.
+      #
+      # === Parameters
+      #
+      # @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)
+        @configuration.instance_variable_set(:"@#{name}", value)
+      end
+    end
+  end
+end

data/lib/knowledge/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knowledge
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Johann Wilfrid-Calixte
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-15 00:00:00.000000000 Z
+date: 2018-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -142,6 +142,9 @@ files:
 - lib/knowledge/initializer.rb
 - lib/knowledge/learner.rb
 - lib/knowledge/setter.rb
+- lib/knowledge/setters.rb
+- lib/knowledge/setters/base.rb
+- lib/knowledge/setters/knowledge.rb
 - lib/knowledge/version.rb
 homepage: https://github.com/knowledge-ruby/knowledge
 licenses: