knowledge 0.1.0

data/README.md

@@ -0,0 +1,107 @@
+# Knowledge
+
+Configuration variables are a project's knowledge. This gem is here to help your projects learn what they need to work properly.
+
+## Disclaimer
+
+The full documentation is currently being written. You should be able to find a better documentation in a few hours.
+
+Waiting for the full documentation, you can have a look at the code which is already well-documented.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knowledge'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knowledge
+
+## Usage
+
+Documentation is in progress. Please have a look to the [wiki](https://github.com/knowledge-ruby/knowledge/wiki/).
+
+**Using default stuff**:
+
+```ruby
+knowledge = Knowledge::Learner.new
+
+knowledge.use(name: :default)
+knowledge.variables = { key: :value }
+knowledge.gather!
+
+Knowledge::Configuration.key # => "value"
+```
+
+**Using your own setter**:
+
+```ruby
+#
+# === Description ===
+#
+# Sets config variables in Rails.application.config
+#
+# === Usage ===
+#
+# @example:
+#   setter = MyCustomRailsSetter.new
+#   setter.set(name: :foo, value: :bar)
+#
+#   Rails.application.config.foo # => "bar"
+#
+class MyCustomRailsSetter
+    #
+    # === Description ===
+    #
+    # Sets config variables in the right place.
+    #
+    # === Usage ===
+    #
+    # See the same section in the class description.
+    #
+    # === Attributes ===
+    #
+    # @option [String | Symbol] :name
+    # @option [Any] :value
+    #
+    def set(name:, value:)
+        Rails.application.config.public_send("#{name}=", value)
+    end
+end
+
+knowledge = Knowledge::Learner.new
+
+knowledge.setter = MyCustomRailsSetter.new
+knowledge.use(name: :default)
+knowledge.variables = { key: :value }
+knowledge.gather!
+
+Rails.application.config.key # => "value"
+```
+
+## Development
+
+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).
+
+## 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.
+
+## Code of Conduct
+
+Everyone interacting in the Knowledge project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/knowledge-ruby/knowledge/blob/master/CODE_OF_CONDUCT.md).
+
+## Licensing
+
+This project is licensed under [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.en.html).
+
+You can find it in LICENSE.md file.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'knowledge'
+
+# 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/knowledge.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knowledge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'knowledge'
+  spec.version       = Knowledge::VERSION
+  spec.authors       = ['Johann Wilfrid-Calixte']
+  spec.email         = ['johann.open-source@protonmail.ch']
+
+  spec.licenses      = ['GPL-3.0']
+
+  spec.summary       = "Because configuration is your app's knowledge."
+  spec.description   = 'Easy knowledge for yout project.'
+  spec.homepage      = 'https://github.com/knowledge-ruby/knowledge'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata['allowed_push_host'] = 'https://johann.wilfrid-calixte.fr'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/knowledge-ruby/knowledge'
+    spec.metadata['changelog_uri'] = 'https://github.com/knowledge-ruby/knowledge/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'dry-configurable'
+
+require 'knowledge/version'
+require 'knowledge/exceptions'
+require 'knowledge/learner'
+
+#
+# === Description ===
+#
+# Configuration is your project's knowledge, let's make it very simple!
+#
+# === Configuration ===
+#
+# Funny but quite normal, this gem needs some config.
+# If you're familiar with dry-configurable, it should be very understandable for you.
+# If not, it's still simple.
+#
+# You can configure it one by one or all at once:
+#
+# @example:
+#
+#   Knowledge.config.environment = ENV['RACK_ENV'] || Rails.env || ENV['APP_ENV'] # Or whatever you want
+#
+#   Knowledge.configure do |config|
+#     config.environment = ENV['RACK_ENV'] || Rails.env || ENV['APP_ENV'] # Or whatever you want
+#   end
+#
+# === Usage ===
+#
+# @example:
+#   Knowledge.configure do |config|
+#     config.environment = :production
+#   end
+#
+#   # or
+#
+#   Knowledge.config.environment = :production
+#   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)
+#
+#   learner.gather!
+#
+module Knowledge
+  # == Behaviors ===================================================================================================
+  extend Dry::Configurable
+
+  # == Settings ====================================================================================================
+  setting :environment, :development
+end

data/lib/knowledge/adapters.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Knowledge
+  #
+  # === 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.
+  #
+  module Adapters
+  end
+end
+
+require 'knowledge/adapters/base'
+require 'knowledge/adapters/environment'
+require 'knowledge/adapters/key_value'
+require 'knowledge/adapters/file'

data/lib/knowledge/adapters/base.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Knowledge
+  module Adapters
+    #
+    # === Description ===
+    #
+    # This adapter is the base adapter.
+    # It does nothing specific but is meant to manage all generic stuff.
+    #
+    # === Usage ===
+    #
+    # Just inherit from it
+    #
+    # === Attributes ===
+    #
+    # @attr_reader [Class] setter
+    # @attr_reader [Hash] variables
+    #
+    class Base
+      # == Attributes ==================================================================================================
+      attr_reader :setter, :variables
+
+      # == Constructor =================================================================================================
+      #
+      # @option [Hash] :variables
+      # @option [Class] :setter
+      # @option [Hash] :params
+      #
+      def initialize(variables:, setter:, params: nil) # rubocop:disable Lint/UnusedMethodArgument
+        @variables = variables
+        @setter = setter
+      end
+
+      # == Instance Methods ============================================================================================
+      #
+      # === Description ===
+      #
+      # Should run the actual adapter.
+      # This method is meant to be overriden
+      #
+      # === Errors ===
+      #
+      # @raise [Knowledge::AdapterRunMethodNotImplemented] if not overridden by subclasses
+      #
+      def run
+        raise ::Knowledge::AdapterRunMethodNotImplemented, "Please override the #run method for #{self.class}"
+      end
+    end
+  end
+end

data/lib/knowledge/adapters/environment.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Knowledge
+  module Adapters
+    #
+    # === Description ===
+    #
+    # This adapter takes some vars in ENV vars and put it in your project's config.
+    #
+    # === Usage ===
+    #
+    # @example:
+    #   adapter = Knowledge::Adapters::Environment.new(setter: MySetter, variables: my_vars)
+    #
+    #   adapter.run
+    #
+    # === Attributes ===
+    #
+    # @attr_reader [Class] setter
+    # @attr_reader [Hash] variables
+    #
+    class Environment < Base
+      # == Instance Methods ============================================================================================
+      #
+      # === Description ===
+      #
+      # Runs the actual adapter.
+      #
+      def run
+        variables.each do |name_in_project, name_in_env|
+          setter.set(name: name_in_project, value: ENV[name_in_env.to_s])
+        end
+      end
+    end
+  end
+end

data/lib/knowledge/adapters/file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Knowledge
+  module Adapters
+    #
+    # === 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 ===
+    #
+    # @example:
+    #   adapter = Knowledge::Adapters::File.new(setter: MySetter, variables: my_vars)
+    #
+    #   adapter.run
+    #
+    # === Attributes ===
+    #
+    # @attr_reader [Class] setter
+    # @attr_reader [Hash] variables
+    #
+    class File < KeyValue; end
+  end
+end

data/lib/knowledge/adapters/key_value.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Knowledge
+  module Adapters
+    #
+    # === 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 ===
+    #
+    # @example:
+    #   adapter = Knowledge::Adapters::KeyValue.new(setter: MySetter, variables: my_vars)
+    #
+    #   adapter.run
+    #
+    # === Attributes ===
+    #
+    # @attr_reader [Class] setter
+    # @attr_reader [Hash] variables
+    #
+    class KeyValue < Base
+      # == Instance Methods ============================================================================================
+      #
+      # === Description ===
+      #
+      # Runs the actual adapter.
+      #
+      def run
+        variables.each { |name, value| setter.set(name: name, value: value) }
+      end
+    end
+  end
+end

data/lib/knowledge/configuration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Knowledge
+  #
+  # === Description ===
+  #
+  # If the project has no defined way to manage its config, why not providing it our way?
+  #
+  class Configuration
+    class << self
+      #
+      # === 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.
+      # That's what happens here. To have a proper inspect, we've got to re-write it manually.
+      # It's not something I find very clear but anyway, the API is cool so it's ok for me.
+      #
+      # It allows us to see every variable that has been defined on the class by metaprogramming.
+      #
+      # === 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 ===
+      #
+      # @return [String] as expected
+      #
+      def inspect
+        base = "#<Knowledge::Configuration:0x0000#{object_id}"
+
+        instance_variables.each do |var_name|
+          base = "#{base} #{var_name}=\"#{instance_variable_get(var_name)}\""
+        end
+
+        "#{base}>"
+      end
+    end
+  end
+end