qonfig 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29fa558caa3bd1f96663617174ba854aaf286cf17a08433c8fb4a497fde1d702
-  data.tar.gz: 6f3ad5c3bd5c4e6ca9b81897c11cb8a8edf208d50e86238ade40ccab99832e36
+  metadata.gz: afe6dc7a96eec7d6f1e45a84d88fe5d4d7188547c6f55fb6aff65f7e46b92620
+  data.tar.gz: c045b73600ef8b751229a81ca8030cdbd45b6955f47a1c8e1d0cff48b1229a67
 SHA512:
-  metadata.gz: 0aa25942d38b95a2af5f432af94bd642d8b7074e35f4a53f31b987dab409f3a274853b76eb42fe72f2ca171336e2907eb06309c00062ab3fb188ad1d268c775e
-  data.tar.gz: c7870403e266a21f837bd4789b5a7df74bc06e165a78f4155fb707a4083c165c144ba19e2764610efd3aef802ef0644dfc932abf89be63a7c7553596b495010d
+  metadata.gz: '0933d09ee590ab14c764373e66a90adce051cad88e3edcb8fb72ea75c39616797d263621f99f3ffe53645a652a6a8f8d566762a4b12d165168c0196ca4c87579'
+  data.tar.gz: 5dbcfedecf3a20906e00adb5f0ffec49f240bff0402e2db75690c29cb4b0bb8a394ccf9f1531723ff46c97a51d230c4e2484aa0eae122479189fa57882b41df8

data/.rubocop.yml

@@ -1,95 +1,14 @@
-require: rubocop-rspec
+inherit_gem:
+  armitage-rubocop:
+    - lib/rubocop.general.yml
+    - lib/rubocop.rspec.yml
 
 AllCops:
-  DisplayCopNames:   true
-  DisplayStyleGuide: true
   TargetRubyVersion: 2.5.1
   Include:
     - lib/**/*.rb
     - spec/**/*.rb
-  Exclude:
-    - bin/**/*
     - Gemfile
     - Rakefile
     - qonfig.gemspec
-
-Style/SingleLineMethods:
-  Exclude:
-    - spec/**/*
-
-Style/RescueModifier:
-  Exclude:
-    - spec/**/*
-
-Style/IfUnlessModifier:
-  Enabled: false
-
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Naming/VariableNumber:
-  EnforcedStyle: snake_case
-
-Style/AsciiComments:
-  Enabled: false
-
-Layout/IndentArray:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-RSpec/DescribeClass:
-  Enabled: false
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 100
-
-Style/Alias:
-  EnforcedStyle: prefer_alias_method
-
-Style/MultilineIfModifier:
-  Enabled: false
-
-Lint/HandleExceptions:
-  Enabled: false
-
-Metrics/MethodLength:
-  Max: 20
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/EmptyCaseCondition:
-  Enabled: false
-
-RSpec/ExampleLength:
-  Enabled: false
-
-RSpec/MultipleExpectations:
-  Enabled: false
-
-Style/MultilineBlockChain:
-  Enabled: false
-
-Metrics/AbcSize:
-  Max: 19
-
-Metrics/CyclomaticComplexity:
-  Max: 10
-
-Metrics/PerceivedComplexity:
-  Max: 10
-
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-Lint/UnderscorePrefixedVariableName:
-  Enabled: false
-
-Security/YAMLLoad:
-  Enabled: false
+    - bin/console

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.4.0] - 2018-06-24
+- Introduce Plugin Ecosystem (`Qonfig::Plugins`):
+  - load plugin: `Qonfig.plugin('plugin_name')` or `Qonfig.plugin(:plugin_name)`;
+  - get registered plugins: `Qonfig.plugins #=> array of strings`
+
 ## [0.3.0] - 2018-06-13
 ### Added
 - Improved configuration process: `#configure` can take a hash as a configuration `[option key => option]`

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in qonfig.gemspec
 gemspec

data/README.md

@@ -34,6 +34,7 @@ require 'qonfig'
 - [Load from ENV](#load-from-env)
 - [Load from \_\_END\_\_](#load-from-__end__) (aka `load_from_self`)
 - [Smart Mixin](#smart-mixin) (`Qonfig::Configurable`)
+- [Plugins](#plugins)
 
 ---
 
@@ -691,6 +692,18 @@ GeneralApplication.config.to_h
 
 ---
 
+### Plugins
+
+```ruby
+# --- show names of registered plugins ---
+Qonfig.plugins # => array of strings
+
+# --- load specific plugin ---
+Qonfig.plugin(:plugin_name) # or Qonfig.plugin('plugin_name')
+```
+
+---
+
 ## Contributing
 
 - Fork it ( https://github.com/0exp/qonfig/fork )

data/Rakefile

@@ -5,4 +5,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'qonfig'

data/lib/qonfig.rb

@@ -23,4 +23,12 @@ module Qonfig
   require_relative 'qonfig/data_set'
   require_relative 'qonfig/data_set/class_builder'
   require_relative 'qonfig/configurable'
+  require_relative 'qonfig/plugins/registry'
+  require_relative 'qonfig/plugins'
+  require_relative 'qonfig/plugins/access_mixin'
+  require_relative 'qonfig/plugins/abstract'
+
+  # @api public
+  # @since 0.4.0
+  extend Plugins::AccessMixin
 end

data/lib/qonfig/error.rb

@@ -62,4 +62,16 @@ module Qonfig
   # @api public
   # @since 0.2.0
   SelfDataNotFoundError = Class.new(Error)
+
+  # @see Qonfig::Plugins::Regsitry
+  #
+  # @api private
+  # @since 0.4.0
+  AlreadyRegisteredPluginError = Class.new(Error)
+
+  # @see Qonfig::Plugins::Registry
+  #
+  # @api public
+  # @since 0.4.0
+  UnregisteredPluginError = Class.new(Error)
 end

data/lib/qonfig/plugins.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Qonfig
+  # @api public
+  # @since 0.4.0
+  module Plugins
+    # @since 0.4.0
+    @plugin_registry = Registry.new
+    # @since 0.4.0
+    @access_lock = Mutex.new
+
+    class << self
+      # @param plugin_name [Symbol, String]
+      # @return [void]
+      #
+      # @api public
+      # @since 0.4.0
+      def load(plugin_name)
+        thread_safe { plugin_registry[plugin_name].load! }
+      end
+
+      # @return [Array<String>]
+      #
+      # @api public
+      # @since 0.4.0
+      def names
+        thread_safe { plugin_registry.names }
+      end
+
+      # @param plugin_name [Symbol, String]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.4.0
+      def register_plugin(plugin_name, plugin_module)
+        thread_safe { plugin_registry[plugin_name] = plugin_module }
+      end
+
+      private
+
+      # @return [Qonfig::Plugins::Registry]
+      #
+      # @api private
+      # @since 0.4.0
+      attr_reader :plugin_registry
+
+      # @return [Mutex]
+      #
+      # @api private
+      # @since 0.4.0
+      attr_reader :access_lock
+
+      # @return [void]
+      #
+      # @api private
+      # @since 0.4.0
+      def thread_safe
+        access_lock.synchronize { yield if block_given? }
+      end
+    end
+  end
+end

data/lib/qonfig/plugins/abstract.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Plugins
+    # @api private
+    # @since 0.4.0
+    class Abstract
+      class << self
+        # @return [void]
+        #
+        # @api private
+        # @since 0.4.0
+        def load!; end
+      end
+    end
+  end
+end

data/lib/qonfig/plugins/access_mixin.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Plugins
+    # @api private
+    # @since 0.4.0
+    module AccessMixin
+      # @param plugin_name [Symbol, String]
+      # @return [void]
+      #
+      # @see Qonfig::Plugins
+      #
+      # @api public
+      # @since 0.4.0
+      def plugin(plugin_name)
+        Qonfig::Plugins.load(plugin_name)
+      end
+
+      # @return [Array<String>]
+      #
+      # @see Qonfig::Plugins
+      #
+      # @api public
+      # @since 0.4.0
+      def plugins
+        Qonfig::Plugins.names
+      end
+    end
+  end
+end

data/lib/qonfig/plugins/registry.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Plugins
+    # @api private
+    # @since 0.4.0
+    class Registry
+      # @return [void]
+      #
+      # @api private
+      # @since 0.4.0
+      def initialize
+        @plugin_set = {}
+        @access_lock = Mutex.new
+      end
+
+      # @param plugin_name [Symbol, String]
+      # @return [Qonfig::Plugins::Abstract]
+      #
+      # @api private
+      # @since 0.4.0
+      def [](plugin_name)
+        thread_safe { fetch(plugin_name) }
+      end
+
+      # @param plugin_name [Symbol, String]
+      # @param plugin_module [Qonfig::Plugins::Abstract]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.4.0
+      def register(plugin_name, plugin_module)
+        thread_safe { apply(plugin_name, plugin_module) }
+      end
+      alias_method :[]=, :register
+
+      # @return [Array<String>]
+      #
+      # @api private
+      # @since 0.4.0
+      def names
+        thread_safe { plugin_names }
+      end
+
+      private
+
+      # @return [Hash]
+      #
+      # @api private
+      # @since 0.4.0
+      attr_reader :plugin_set
+
+      # @return [Mutex]
+      #
+      # @api private
+      # @since 0.4.0
+      attr_reader :access_lock
+
+      # @return [void]
+      #
+      # @api private
+      # @since 0.4.0
+      def thread_safe
+        access_lock.synchronize { yield if block_given? }
+      end
+
+      # @return [Array<String>]
+      #
+      # @api private
+      # @since 0.4.0
+      def plugin_names
+        plugin_set.keys
+      end
+
+      # @param plugin_name [String]
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.4.0
+      def registered?(plugin_name)
+        plugin_set.key?(plugin_name)
+      end
+
+      # @param plugin_name [Symbol, String]
+      # @param plugin_module [Qonfig::Plugins::Abstract]
+      # @return [void]
+      #
+      # @raise [Qonfig::AlreadyRegisteredPluginError]
+      #
+      # @api private
+      # @since 0.4.0
+      def apply(plugin_name, plugin_module)
+        plugin_name = indifferently_accessable_plugin_name(plugin_name)
+
+        if registered?(plugin_name)
+          raise Qonfig::AlreadyRegisteredPluginError, "#{plugin_name} plugin already exist"
+        end
+
+        plugin_set[plugin_name] = plugin_module
+      end
+
+      # @param plugin_name [Symbol, String]
+      # @return [Qonfig::Plugins::Abstract]
+      #
+      # @raise [Qonfig::UnregisteredPluginError]
+      #
+      # @api private
+      # @since 0.4.0
+      def fetch(plugin_name)
+        plugin_name = indifferently_accessable_plugin_name(plugin_name)
+
+        unless registered?(plugin_name)
+          raise Qonfig::UnregisteredPluginError, "#{plugin_name} plugin is not registered"
+        end
+
+        plugin_set[plugin_name]
+      end
+
+      # @param key [Symbol, String]
+      # @return [String]
+      #
+      # @api private
+      # @since 0.4.0
+      def indifferently_accessable_plugin_name(plugin_name)
+        plugin_name.to_s
+      end
+    end
+  end
+end

data/lib/qonfig/settings.rb

@@ -355,6 +355,7 @@ module Qonfig
       KeyGuard.new(key).prevent_core_method_intersection!
     end
 
+    # rubocop:disable Layout/ClassStructure
     # @return [Array<String>]
     #
     # @api private
@@ -364,6 +365,7 @@ module Qonfig
       private_instance_methods(false) |
       %i[super define_singleton_method self]
     ).map(&:to_s).freeze
+    # rubocop:enable Layout/ClassStructure
   end
 
   # rubocop:enable Metrics/ClassLength

data/lib/qonfig/version.rb

@@ -2,6 +2,6 @@
 
 module Qonfig
   # @api public
-  # @since 0.3.0
-  VERSION = '0.3.0'
+  # @since 0.1.0
+  VERSION = '0.4.0'
 end

data/qonfig.gemspec

@@ -1,6 +1,7 @@
 # codning: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'qonfig/version'
 
@@ -23,16 +24,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.files  = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.add_development_dependency 'coveralls',      '~> 0.8'
-  spec.add_development_dependency 'simplecov',      '~> 0.14'
-  spec.add_development_dependency 'simplecov-json', '~> 0.2'
-  spec.add_development_dependency 'rubocop',        '~> 0.57'
-  spec.add_development_dependency 'rspec',          '~> 3.7'
-  spec.add_development_dependency 'rubocop-rspec',  '~> 1.26'
+  spec.add_development_dependency 'coveralls',        '~> 0.8'
+  spec.add_development_dependency 'simplecov',        '~> 0.14'
+  spec.add_development_dependency 'simplecov-json',   '~> 0.2'
+  spec.add_development_dependency 'rspec',            '~> 3.7'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.3'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-12 00:00:00.000000000 Z
+date: 2018-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.57'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.57'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.7'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: armitage-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.26'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.26'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,6 +160,10 @@ files:
 - lib/qonfig/dsl.rb
 - lib/qonfig/error.rb
 - lib/qonfig/loaders/yaml.rb
+- lib/qonfig/plugins.rb
+- lib/qonfig/plugins/abstract.rb
+- lib/qonfig/plugins/access_mixin.rb
+- lib/qonfig/plugins/registry.rb
 - lib/qonfig/settings.rb
 - lib/qonfig/settings/builder.rb
 - lib/qonfig/settings/key_guard.rb