knowledge 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e28940c54f36797206858a07d3d32df46040353791a38ac382ebea787878a6ae
-  data.tar.gz: 896a9533cf13495a123af671fbffe430ece3c0f25d85183fd9b99b4fd5a79f77
+  metadata.gz: 8ddde96c930ed905c6761e25779cd203b752d33a5cad99df862443afbf5a6873
+  data.tar.gz: 6e129b7c1b34c0a927f1595b38d20d3fcc52b85bd0c99618f594e6e40e8b7529
 SHA512:
-  metadata.gz: 3a5aa9d9d3131761a3d1f2b627838d54b352d61f1c37405ec82a2aa82262c0d78739bac2d20f7fb9467911921ce18c0c87b63f186452a9d59a00312028a0cf9f
-  data.tar.gz: d9f4a3335d3cd9f0d6065ec91604ee739a7ac1145d5060eacff40820af8204d40567b8d0ee9de6a5b1d215e7154b370f640a9302f6e69bffbb2bd5f5dbe970df
+  metadata.gz: 1a3fddeafb3a21c2ca6b5a0499a99a64a02d8b1547be45760ed1475228d6d43bf0958fb442faf076420abecd667a8625776983031f63f566388202688e87f043
+  data.tar.gz: 30ec24f95ab6948c56286f436f286f5e1252a509943a6dab29863f103c8d1486c013cfe7c67f97fa07cfb169c0789d2df1c0d1c9659eeeccc21b612f0771839a

data/Dockerfile

@@ -0,0 +1,17 @@
+FROM ruby:2.6.4
+
+RUN bundle config --global frozen 1
+
+RUN mkdir /app
+RUN mkdir -p /app/lib/knowledge
+WORKDIR /app
+
+RUN gem update --system
+RUN gem install bundler -v "~> 2.0" --no-doc
+
+COPY lib/knowledge/version.rb ./lib/knowledge
+COPY knowledge.gemspec Gemfile Gemfile.lock ./
+
+RUN bundle install
+
+COPY . .

data/Gemfile

@@ -6,3 +6,18 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in knowledge.gemspec
 gemspec
+
+# Tests
+gem 'rspec'
+gem 'simplecov'
+
+# Linting
+gem 'rubocop', '~> 0.62.0'
+
+# Documentation
+gem 'yard'
+
+# Watchers
+gem 'guard'
+gem 'guard-process'
+gem 'guard-rspec'

data/Gemfile.lock

@@ -1,24 +1,48 @@
 PATH
   remote: .
   specs:
-    knowledge (0.1.3)
-      dry-configurable (~> 0.7)
+    knowledge (0.1.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
     coderay (1.1.2)
-    concurrent-ruby (1.1.4)
     diff-lcs (1.3)
     docile (1.3.1)
-    dry-configurable (0.7.0)
-      concurrent-ruby (~> 1.0)
-    jaro_winkler (1.5.1)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.1)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-process (1.2.1)
+      guard-compat (~> 1.2, >= 1.2.1)
+      spoon (~> 0.0.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.3)
     json (2.1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
     method_source (0.9.2)
-    parallel (1.12.1)
-    parser (2.5.3.0)
+    nenv (0.3.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.17.0)
+    parser (2.6.4.1)
       ast (~> 2.4.0)
     powerpack (0.1.2)
     pry (0.12.2)
@@ -26,6 +50,9 @@ GEM
       method_source (~> 0.9.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
@@ -39,7 +66,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
-    rubocop (0.60.0)
+    rubocop (0.62.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
       parser (>= 2.5, != 2.5.1.1)
@@ -47,25 +74,35 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
+    ruby-progressbar (1.10.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.2)
-    unicode-display_width (1.4.0)
+    spoon (0.0.6)
+      ffi
+    thor (0.20.3)
+    unicode-display_width (1.4.1)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 1.16)
+  guard
+  guard-process
+  guard-rspec
   knowledge!
   pry (>= 0.12)
   rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (>= 0.60)
+  rspec
+  rubocop (~> 0.62.0)
   simplecov
+  yard
 
 BUNDLED WITH
    1.16.6

data/Guardfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+group :linter do
+  guard 'process', command: 'bundle exec rubocop -a' do
+    watch(/\.rb$/)
+  end
+end
+
+group :test do
+  guard 'rspec', cmd: 'bundle exec rspec' do
+    watch(/\.rb$/) { 'spec' }
+  end
+end

data/README.md

@@ -11,6 +11,12 @@ The full documentation is currently being written. You should be able to find a
 
 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)
 
+## Knowledge official ecosystem
+
+- [knowledge](https://github.com/knowledge-ruby/knowledge) - Core project
+- [knowledge-rails](https://github.com/knowledge-ruby/knowledge-rails) - Rails utilities
+- [knowledge-ssm](https://github.com/knowledge-ruby/knowledge-ssm) - SSM Adapter
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -128,10 +134,32 @@ Rails.application.config.key # => "value"
 
 ## Development
 
+### Without docker
+
 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.
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### With docker
+
+First, please ensure you've got docker and docker-compose properly setup on your computer
+
+Then run:
+
+```bash
+$ docker-compose build
+```
+
+Once the build has been done, run:
+
+```bash
+$ docker-compose up
+```
+
+You will be able to see linting and test tasks running each time you change a file.
+
+You will also find the yard doc under `http://localhost:5001` and the coverage under `http://localhost:5002`.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/knowledge-ruby/knowledge. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
@@ -145,3 +173,5 @@ Everyone interacting in the Knowledge project’s codebases, issue trackers, cha
 This project is licensed under [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.en.html).
 
 You can find it in LICENSE.md file.
+
+Note: if you're a company willing to use the gem but you cannot because of the license, I can provide the gem under a different license. Please contact me if you need it.

data/docker-compose.yml

@@ -0,0 +1,59 @@
+version: "3.7"
+
+services:
+  test:
+    build:
+      context: .
+    command: |
+      bash -c "bundle exec guard --no-interactions -g test"
+    volumes:
+      - .:/app:cached
+    networks:
+      knowledge:
+        aliases:
+          - knowledge.test
+
+  linter:
+    build:
+      context: .
+    command: |
+      bash -c "bundle exec guard --no-interactions -g linter"
+    volumes:
+      - .:/app:cached
+    networks:
+      knowledge:
+        aliases:
+          - knowledge.linter
+
+  doc:
+    build:
+      context: .
+    command: |
+      bash -c "bundle exec yardoc && yard server -B 0.0.0.0 -p 5001 --reload"
+    volumes:
+      - .:/app:cached
+    ports:
+      - "5001:5001"
+    networks:
+      knowledge:
+        aliases:
+          - knowledge.doc
+
+  coverage:
+    build:
+      context: .
+    command: |
+      bash -c "ruby -run -e httpd -- -p 5002 ./coverage"
+    volumes:
+      - .:/app:cached
+    ports:
+      - "5002:5002"
+    networks:
+      knowledge:
+        aliases:
+          - knowledge.coverage
+
+networks:
+  knowledge:
+    name: knowledge
+    driver: bridge

data/knowledge.gemspec

@@ -38,12 +38,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'dry-configurable', '~> 0.7'
-
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'pry', '>= 0.12'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'rubocop', '>= 0.60'
-  spec.add_development_dependency 'simplecov'
 end

data/lib/knowledge.rb

@@ -1,9 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry-configurable'
-
 require 'knowledge/version'
 require 'knowledge/exceptions'
+require 'knowledge/configurable'
 require 'knowledge/learner'
 
 #
@@ -19,7 +18,7 @@ require 'knowledge/learner'
 #
 # You can configure it one by one or all at once:
 #
-# @example:
+# @example
 #
 #   Knowledge.config.environment = ENV['RACK_ENV'] || Rails.env || ENV['APP_ENV'] # Or whatever you want
 #
@@ -29,7 +28,7 @@ require 'knowledge/learner'
 #
 # === Usage
 #
-# @example:
+# @example
 #   Knowledge.configure do |config|
 #     config.environment = :production
 #   end
@@ -40,7 +39,9 @@ require 'knowledge/learner'
 #   learner = Knowledge::Learner.new
 #   learner.setter = MyCustomProjectVariableSetter
 #   learner.variables = 'path/to/config/file'
+#
 #   # or
+#
 #   learner.variables = { name: 'value_key' }
 #   learner.register_adapter(:custom, MyCustomProjectVariableAdapter, enable: true)
 #
@@ -48,8 +49,8 @@ require 'knowledge/learner'
 #
 module Knowledge
   # == Behaviors =======================================================================================================
-  extend Dry::Configurable
+  extend Configurable
 
   # == Settings ========================================================================================================
-  setting :environment, :development
-end
+  setting :environment, default: :development
+end

data/lib/knowledge/configurable.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Knowledge
+  #
+  # === Description
+  #
+  # Internal configuration module providing required DSL to be able to manage internal configuration.
+  #
+  # === Usage
+  #
+  # @example
+  #   module MyModule
+  #     extend Configurable
+  #
+  #     setting :variable, default: :default_value
+  #   end
+  #
+  #   MyModule.variable # :default_value
+  #
+  #   MyModule.configure do |config|
+  #     config.variable = :foo
+  #   end
+  #
+  #   MyModule.variable # :foo
+  #
+  #   MyModule.variable = :bar
+  #
+  #   MyModule.variable # :bar
+  #
+  module Configurable
+    def self.extended(base)
+      base.singleton_class.extend(Forwardable)
+      base.extend(ClassMethods)
+    end
+
+    #
+    # Class Methods to be injected.
+    #
+    module ClassMethods
+      #
+      # Registers a configuration variable with a potential default value
+      #
+      # === Usage
+      #
+      # @example
+      #
+      #   setting :my_config
+      #   setting :environment, default: :development
+      #
+      # === Parameters
+      #
+      # @param name [String, Symbol] the variable's name
+      # @param default [any] default value for the variable to define
+      #
+      def setting(name, default: nil)
+        configuration.class.send(:attr_accessor, name)
+        configuration.public_send("#{name}=", default)
+
+        singleton_class.class_eval { def_delegators :configuration, name, "#{name}=" }
+      end
+
+      #
+      # Exposes the configuration allowing to manage it.
+      #
+      # === Usage
+      #
+      # @example
+      #
+      #   MyModule.configure do |config|
+      #     config.my_variable = :foo
+      #   end
+      #
+      # === Parameters
+      #
+      # @yield configuration [Config]
+      #
+      def configure
+        yield configuration
+      end
+
+      #
+      # Syntaxic sugar allowing to access a config var.
+      #
+      # === Usage
+      #
+      # @example
+      #
+      #   MyModule[:my_variable] # :foo
+      #
+      # === Parameters
+      #
+      # @param name [String, Symbol]
+      #
+      # @return the value of the config var
+      #
+      def [](name)
+        configuration.public_send(name.to_sym)
+      end
+
+      #
+      # Syntaxic sugar allowing to set a config var.
+      #
+      # === Usage
+      #
+      # @example
+      #
+      #   MyModule[:my_variable] = :foo # :foo
+      #
+      # === Parameters
+      #
+      # @param name [String, Symbol]
+      # @param value [any]
+      #
+      # @return the value of the config var
+      #
+      def []=(name, value)
+        configuration.public_send("#{name}=", value)
+      end
+
+      private
+
+      #
+      # === Description
+      #
+      # Used for storing the configuration variables in order not to leak it into Class
+      #
+      class Config; end
+
+      # @return [Config]
+      def configuration
+        @configuration ||= Config.new
+      end
+    end
+  end
+end

data/lib/knowledge/learner.rb

@@ -54,7 +54,7 @@ module Knowledge
       @additionnal_params = {}
       @available_adapters = {}
       @enabled_adapters = {}
-      @setter = ::Knowledge::Setters.config.default.new
+      @setter = ::Knowledge::Setters.default.new
       @variables = {}
     end
 
@@ -417,7 +417,7 @@ module Knowledge
     #
     def fetch_variables_config(path)
       descriptor = yaml_content(path)
-      @variables = descriptor[::Knowledge.config.environment.to_s] || descriptor
+      @variables = descriptor[::Knowledge.environment.to_s] || descriptor
     end
 
     #

data/lib/knowledge/setters.rb

@@ -9,7 +9,7 @@ module Knowledge
   #
   module Setters
     # == Behaviors =====================================================================================================
-    extend Dry::Configurable
+    extend ::Knowledge::Configurable
 
     # == Settings ======================================================================================================
     setting :default
@@ -19,4 +19,4 @@ end
 require 'knowledge/setters/base'
 require 'knowledge/setters/knowledge'
 
-Knowledge::Setters.config.default = Knowledge::Setters::Knowledge
+Knowledge::Setters.default = Knowledge::Setters::Knowledge

data/lib/knowledge/version.rb

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

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: knowledge
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Johann Wilfrid-Calixte
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-22 00:00:00.000000000 Z
+date: 2019-09-29 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: dry-configurable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,48 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.60'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.60'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Easy knowledge for yout project.
 email:
 - johann.open-source@protonmail.ch
@@ -122,13 +66,16 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.md
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - knowledge.gemspec
 - lib/knowledge.rb
 - lib/knowledge/adapters.rb
@@ -137,6 +84,7 @@ files:
 - lib/knowledge/adapters/file.rb
 - lib/knowledge/adapters/key_value.rb
 - lib/knowledge/backupper.rb
+- lib/knowledge/configurable.rb
 - lib/knowledge/configuration.rb
 - lib/knowledge/exceptions.rb
 - lib/knowledge/initializer.rb