fedux_org-stdlib 0.7.21 → 0.7.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f4527fb22b611d0a2eafdeeacda0ddbb8bbeabc
-  data.tar.gz: a6d760bbd9ecc7902e6d3bfe440b2be42ca56908
+  metadata.gz: e0e131c91284b360c65ea622094b771f1dd4ffef
+  data.tar.gz: 60c302269d7ac280cb6be8369e5408aa78b3caf6
 SHA512:
-  metadata.gz: b3a96b663ce768db511aba23fc39c3eb213e9f9990683cca6e78b9b64a7033f89024efe5cf896c6e97b10251d9342e0f7909065b5135e48d2e16f5cf53cfe63d
-  data.tar.gz: cb67a095ea80acd945da543c6b289389a416ca0f2e556f6a9d89f68c9660b7a825ea960ca743e06bf56f4de492009344affd7ac4c87e77a3ef39f3422c6456f8
+  metadata.gz: 440e5a6eb063a5348a4f4f60fdb5854abb1a0e27c52bfe6e409c428c910e702706b8ea30ed0cd33dfdff8b4f483856068190556b9fe9aeeb2b2a301dfef65bcf
+  data.tar.gz: ba554cb16232d30f1f0c42d93a643267342089b67ee084470062b31076a4f84095ec2a5c5e179a78438e05e1400f6c33fdccb930accef6637cb79cde83f9d4fa

data/.rubocop.yml

@@ -0,0 +1,3 @@
+inherit_from:
+  - config/rubocop/exclude.yml
+  - config/rubocop/include.yml

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-# use gem spec 
+# use gem spec
 gemspec
 
 group :development, :test do

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fedux_org-stdlib (0.7.20)
+    fedux_org-stdlib (0.7.21)
       activesupport
 
 PATH
@@ -30,12 +30,15 @@ GEM
       cucumber (>= 1.1.1)
       rspec-expectations (>= 2.7.0)
     ast (2.0.0)
+    astrolabe (1.3.0)
+      parser (>= 2.2.0.pre.3, < 3.0)
     awesome_print (1.2.0)
     blockenspiel (0.4.5)
     builder (3.2.2)
-    byebug (2.7.0)
-      columnize (~> 0.3)
+    byebug (3.4.0)
+      columnize (~> 0.8)
       debugger-linecache (~> 1.2)
+      slop (~> 3.6)
     childprocess (0.5.3)
       ffi (~> 1.0, >= 1.0.11)
     coderay (1.1.0)
@@ -60,7 +63,7 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.5)
     erubis (2.7.0)
-    facter (2.1.0)
+    facter (2.2.0)
       CFPropertyList (~> 2.2.6)
     ffi (1.9.3)
     filegen (0.4.3)
@@ -81,7 +84,7 @@ GEM
       mime-types (>= 1.16, < 3)
     method_source (0.8.2)
     mime-types (2.3)
-    minitest (5.4.0)
+    minitest (5.4.1)
     multi_json (1.10.1)
     multi_test (0.1.1)
     netrc (0.7.7)
@@ -94,8 +97,8 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (1.3.3)
-      byebug (~> 2.7)
+    pry-byebug (2.0.0)
+      byebug (~> 3.4)
       pry (~> 0.10)
     pry-doc (0.6.0)
       pry (~> 0.9)
@@ -106,22 +109,23 @@ GEM
     rest-client (1.7.2)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.2)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
+      rspec-support (~> 3.1.0)
     rspec-legacy_formatters (1.0.0)
       rspec-core (>= 3.0.0.beta2)
       rspec-support (>= 3.0.0.beta2)
-    rspec-mocks (3.0.4)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.4)
-    rubocop (0.25.0)
+    rspec-mocks (3.1.0)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
+    rubocop (0.26.0)
+      astrolabe (~> 1.3)
       parser (>= 2.2.0.pre.4, < 3.0)
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)

data/Rakefile

@@ -8,3 +8,19 @@ desc 'Show help for rake'
 task :default do
   sh 'bundle exec rake -T'
 end
+
+desc 'Run test suite'
+task test: ['test:rubocop', 'test:rspec']
+
+namespace :test do
+  desc 'Test with coveralls'
+  task coveralls: ['test', 'coveralls:push']
+
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+
+  desc 'Run rspec'
+  task :rspec do
+    sh 'bundle exec rspec'
+  end
+end

data/config/rubocop/exclude.yml

@@ -0,0 +1,44 @@
+AllCops:
+  Exclude:
+    -  spec/examples/**/*.rb
+
+# Offense count: 230
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 331
+  Enabled: false
+
+## Offense count: 55
+Style/Documentation:
+  Exclude:
+    - spec/**/*.rb
+    - fixtures/**/*.rb
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 136
+
+# Offense count: 5
+Metrics/CyclomaticComplexity:
+  Max: 14
+
+# Offense count: 19
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 38
+
+# Offense count: 1
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 7
+
+# Offense count: 3
+Metrics/PerceivedComplexity:
+  Max: 14
+
+## Offense count: 1
+## Cop supports --auto-correct.
+## Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+#Style/TrivialAccessors:
+#  Enabled: false

data/fedux_org-stdlib.gemspec

@@ -4,17 +4,17 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'fedux_org_stdlib/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fedux_org-stdlib"
+  spec.name          = 'fedux_org-stdlib'
   spec.version       = FeduxOrgStdlib::VERSION
-  spec.authors       = ["Max Meyer"]
-  spec.email         = ["dev@fedux.org"]
-  spec.summary       = %q{Collection of useful libraries. It maybe depend on external libraries.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Max Meyer']
+  spec.email         = ['dev@fedux.org']
+  spec.summary       = 'Collection of useful libraries. It maybe depend on external libraries.'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.1.0'

data/fixtures/plugin-load-app/fedux_org_stdlib-fixtures-plugin_manager-plugin-load.gemspec

@@ -3,19 +3,19 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "fedux_org_stdlib-fixtures-plugin_manager-plugin-load"
+  spec.name          = 'fedux_org_stdlib-fixtures-plugin_manager-plugin-load'
   spec.version       = '0.0.1'
-  spec.authors       = ["Blub"]
-  spec.email         = ["email@example.com"]
-  spec.summary       = %q{Summary}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Blub']
+  spec.email         = ['email@example.com']
+  spec.summary       = 'Summary'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/fixtures/plugin-no_load-app/fedux_org_stdlib-fixtures-plugin_manager-plugin-no_load.gemspec

@@ -3,19 +3,19 @@ lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
-  spec.name          = "fedux_org_stdlib-fixtures-plugin_manager-plugin-no_load"
+  spec.name          = 'fedux_org_stdlib-fixtures-plugin_manager-plugin-no_load'
   spec.version       = '0.0.1'
-  spec.authors       = ["blub"]
-  spec.email         = ["example@email.com"]
-  spec.summary       = %q{Summary}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['blub']
+  spec.email         = ['example@email.com']
+  spec.summary       = 'Summary'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

data/lib/fedux_org_stdlib.rb

@@ -6,8 +6,9 @@ require 'fedux_org_stdlib/logic_converters'
 require 'fedux_org_stdlib/models'
 require 'fedux_org_stdlib/version'
 
+# Main
 module FeduxOrgStdlib
   def self.root_directory
-    File.expand_path( '../../..', __FILE__ )
+    File.expand_path('../../..', __FILE__)
   end
 end

data/lib/fedux_org_stdlib/app_config.rb

@@ -5,7 +5,7 @@ require 'fedux_org_stdlib/process_environment'
 require 'fedux_org_stdlib/core_ext/array/list'
 require 'fedux_org_stdlib/core_ext/hash/list'
 require 'fedux_org_stdlib/logging/logger'
-require_library %w{ json psych active_support/core_ext/string/inflections set active_support/core_ext/hash/slice active_support/core_ext/object/blank active_support/core_ext/hash/keys}
+require_library %w(json psych active_support/core_ext/string/inflections set active_support/core_ext/hash/slice active_support/core_ext/object/blank active_support/core_ext/hash/keys)
 
 module FeduxOrgStdlib
   # This class makes a config file available as an object. The config file
@@ -31,7 +31,7 @@ module FeduxOrgStdlib
   #   off, e.g "ClientConfig" becomes "clients.yaml" (mind the pluralized name)
   #
   # Most conventions defined by me are implemented as separate methods. If one convention
-  # is not suitable for your use case, just overwrite the method. 
+  # is not suitable for your use case, just overwrite the method.
   #
   # If you prefer to use a different path to the config file or name of the
   # config file one of the following methods needs to be overwritten:
@@ -70,7 +70,6 @@ module FeduxOrgStdlib
   #   option1: 'data2'
   class AppConfig
     class << self
-      
       # @api private
       def known_options
         @options ||= Set.new
@@ -104,7 +103,7 @@ module FeduxOrgStdlib
           _config.fetch(option, default_value)
         end
 
-        self.known_options << option
+        known_options << option
       end
 
       # Define a writer for option
@@ -131,7 +130,7 @@ module FeduxOrgStdlib
           end
         end
 
-        self.known_options << option
+        known_options << option
       end
 
       # Define a writer and a reader for option
@@ -150,9 +149,11 @@ module FeduxOrgStdlib
     private
 
     # Holds the config
+    # rubocop:disable Style/TrivialAccessors
     def _config
       @__config
     end
+    # rubocop:enable Style/TrivialAccessors
 
     public
 
@@ -178,9 +179,9 @@ module FeduxOrgStdlib
     # @return [AppConfig]
     #   The config instance. If the resulting data structure created by the
     #   config_engine does not respond to `:[]` an empty config object will be
-    #   created. 
+    #   created.
     def initialize(
-      file: _available_config_file, 
+      file: _available_config_file,
       config_engine: Psych,
       logger: FeduxOrgStdlib::Logging::Logger.new,
       check_unknown_options: true
@@ -188,24 +189,24 @@ module FeduxOrgStdlib
       @logger = logger
 
       unless file
-        logger.debug "No configuration file found at #{_allowed_config_file_paths.to_list}, therefor I'm going to use an empty config object instead." 
+        logger.debug "No configuration file found at #{_allowed_config_file_paths.to_list}, therefor I'm going to use an empty config object instead."
         @__config = {}
 
-        return 
+        return
       end
 
       begin
-        yaml = Psych.safe_load(File.read(file), [Symbol])
+        yaml = config_engine.safe_load(File.read(file), [Symbol])
       rescue StandardError => e
-        fail Exceptions::ConfigFileNotReadable, JSON.dump(message: e.message, file: file)
+        raise Exceptions::ConfigFileNotReadable, JSON.dump(message: e.message, file: file)
       end
 
       if yaml.blank?
         @__config = {}
-      elsif yaml.kind_of? Hash
+      elsif yaml.is_a? Hash
         yaml = yaml.deep_symbolize_keys
 
-        yaml_withknown_options = yaml.deep_symbolize_keys.slice(*self.known_options)
+        yaml_withknown_options = yaml.deep_symbolize_keys.slice(*known_options)
         unknown_options = yaml.keys - yaml_withknown_options.keys
 
         logger.warn "Unknown config options #{(unknown_options).to_list} in config file #{file} detected. Please define them in your config class or remove the entries in your config file or disable check via `check_unknown_options: false` to get rid of this warning." unless unknown_options.blank? && check_unknown_options == true
@@ -233,11 +234,11 @@ module FeduxOrgStdlib
     #   An formatted version of the configuration
     def to_s
       # header 'length' = 6 letters
-      length = self.class.known_options.inject(6) { |memo, o| o.size > memo ? o.size : memo }
+      length = self.class.known_options.reduce(6) { |a, e| e.size > a ? e.size : a }
 
       result = []
-      result << sprintf("%#{length}s | %s", 'option', 'value')
-      result << sprintf("%s + %s", '-' * length, '-' * 80)
+      result << format("%#{length}s | %s", 'option', 'value')
+      result << format('%s + %s', '-' * length, '-' * 80)
 
       self.class.known_options.each do |o|
         value = public_send(o)
@@ -252,7 +253,7 @@ module FeduxOrgStdlib
                   Array(value)
                 end
 
-        result << sprintf("%#{length}s | %s", o, value.to_list)
+        result << format("%#{length}s | %s", o, value.to_list)
       end
 
       result.join("\n")
@@ -300,7 +301,7 @@ module FeduxOrgStdlib
       unless (name = _class_name.sub(/Config/, '').underscore.pluralize).blank?
         return name
       end
-      
+
       fail Exceptions::ClassNameIsMissing, JSON.dump(klass: _class_name)
     end
 
@@ -346,13 +347,13 @@ module FeduxOrgStdlib
     end
 
     def _available_config_file
-      _allowed_config_file_paths.find { |f| ::File.exists? f }
+      _allowed_config_file_paths.find { |f| ::File.exist? f }
     end
 
     def self._reserved_key_words
-      (methods | instance_methods | private_methods | private_instance_methods ) - (Class.methods | Class.private_methods ) | [:to_s]
+      (methods | instance_methods | private_methods | private_instance_methods) - (Class.methods | Class.private_methods) | [:to_s]
     end
-    
+
     def method_missing(*args, &block)
       $stderr.puts "Please check if you have defined an option for #{args.first}."
 

data/lib/fedux_org_stdlib/colors/html_color.rb

@@ -1,17 +1,23 @@
 # encoding: utf-8
 module FeduxOrgStdlib
   module Colors
+    # HTML color
+    #
+    # Helps you to check if given string is a valid html color
     class HtmlColor
       # @param [String] color
       #   string in the html color format
-      def initialize( color )
-        @color = color
+      def initialize(color)
+        @color           = color
         @validator_regex = /^#[a-f0-9]{6}$/
       end
 
+      # Is color valid?
       # @return [true,false] color string is valid
       def valid?
+        # rubocop:disable Style/CaseEquality
         @validator_regex === @color
+        # rubocop:enable Style/CaseEquality
       end
     end
   end