fedux_org-stdlib 0.7.21 → 0.7.22

data/lib/fedux_org_stdlib/filesystem/exceptions.rb

@@ -5,7 +5,7 @@ module FeduxOrgStdlib
       # Raise if path with '..' given
       class InvalidPath < Exception; end
 
-      #Raised if library is not used correctly
+      # Raised if library is not used correctly
       class InvalidUsageOfLibrary < Exception; end
     end
   end

data/lib/fedux_org_stdlib/gem_plugins/exceptions.rb

@@ -1,5 +1,6 @@
 # encoding: utf-8
 module FeduxOrgStdlib
+  # Errors for gem plugins
   module GemPlugins
   end
 end

data/lib/fedux_org_stdlib/gem_plugins/no_plugin.rb

@@ -3,7 +3,6 @@ module FeduxOrgStdlib
   module GemPlugins
     # Placeholder when no associated gem found, displays warning
     class NoPlugin
-
       private
 
       attr_reader :name
@@ -19,7 +18,7 @@ module FeduxOrgStdlib
         true
       end
 
-      def method_missing(*args)
+      def method_missing(*_args)
         warn "Warning: The plugin '#{name}' was not found! (no gem found)"
       end
     end

data/lib/fedux_org_stdlib/gem_plugins/plugin.rb

@@ -1,18 +1,19 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/core_ext/array/list'
-require_library %w{ active_support/core_ext/object/blank }
+require_library %w(active_support/core_ext/object/blank)
 
 module FeduxOrgStdlib
   module GemPlugins
+    # Plugin
     class Plugin
       include Comparable
 
       private
 
       attr_accessor :enabled, :active
-      attr_writer   :gem_name
-      attr_reader   :prefix
+      attr_writer :gem_name
+      attr_reader :prefix
 
       public
 
@@ -42,14 +43,13 @@ module FeduxOrgStdlib
       # disabled)
       # Does not reload plugin if it's already active.
       def activate
-
         variants = []
         variants << gem_name
         variants << gem_name.gsub(/-/, '/')
         variants << prefix.source.sub(/-$/, '') if prefix
 
-        begin 
-          if !active?
+        begin
+          unless active?
             begin
               required_file = variants.shift
               require required_file

data/lib/fedux_org_stdlib/gem_plugins/plugin_manager.rb

@@ -63,7 +63,6 @@ module FeduxOrgStdlib
     #   YourApplication.load_plugins
     #
     class PluginManager
-
       private
 
       attr_reader :plugins, :prefix, :whitelist, :blacklist
@@ -99,12 +98,12 @@ module FeduxOrgStdlib
 
       # Require all enabled plugins, disabled plugins are skipped.
       def load_plugins
-        each_enabled_plugin { |p| p.activate }
+        each_enabled_plugin(&:activate)
       end
 
       # String representation
       def to_s
-        data = plugins.sort.inject([]) { |a, e| a << {name: e.name, enabled: e.enabled?, gem_name: e.gem_name, required_file: e.required_file} }
+        data = plugins.sort.reduce([]) { |a, e| a << { name: e.name, enabled: e.enabled?, gem_name: e.gem_name, required_file: e.required_file } }
 
         List.new(data).to_s(
           fields: [:name, :gem_name, :enabled, :required_file]
@@ -114,7 +113,7 @@ module FeduxOrgStdlib
       private
 
       def each_enabled_plugin(&block)
-        plugins.find_all { |p| p.enabled? }.each(&block)
+        plugins.select(&:enabled?).each(&block)
       end
 
       # Find all installed plugins and store them in an internal array.
@@ -136,12 +135,12 @@ module FeduxOrgStdlib
                     else
                       true
                     end
-        
+
           plgs << Plugin.new(
             name,
-            gem_name: gem.name, 
+            gem_name: gem.name,
             enabled: enabled,
-            prefix: prefix,
+            prefix: prefix
           )
         end
 

data/lib/fedux_org_stdlib/list.rb

@@ -3,8 +3,24 @@ require 'fedux_org_stdlib/require_files'
 require_library %w( hirb )
 
 module FeduxOrgStdlib
+  # A list
+  #
+  # @example Usage
+  #
+  #   data = [
+  #     {
+  #       item1: 'data1',
+  #       item2: 'data2'
+  #     },
+  #     {
+  #       item1: 'data1',
+  #       item2: 'data2'
+  #     },
+  #   ]
+  #
+  #   list = List.new(data)
+  #   puts list
   class List
-
     private
 
     attr_reader :data
@@ -16,11 +32,17 @@ module FeduxOrgStdlib
     end
 
     # Render data to table
+    #
+    # @param [Hash] options
+    #   Options which are supported by Hirb
     def to_s(**options)
-      Hirb::Helpers::Table.render data, header_filter: proc { |h| h.humanize }, **options
+      Hirb::Helpers::Table.render data, header_filter: proc(&:humanize), **options
     end
 
     # Data as array
+    #
+    # @return [Array]
+    #   The data as array
     def to_a
       Array(data)
     end

data/lib/fedux_org_stdlib/logging.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/logging/logger'
 
+# Main
 module FeduxOrgStdlib
   def self.logger
     @logger ||= FeduxOrgStdlib::Logging::Logger.new
   end
 
-  def self.logger=(logger)
-    @logger = logger
+  class << self
+    attr_writer :logger
   end
 end

data/lib/fedux_org_stdlib/logging/logger.rb

@@ -1,13 +1,13 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ logger forwardable }
+require_library %w(logger forwardable)
 
 require 'fedux_org_stdlib/logging/severity'
 
 module FeduxOrgStdlib
   module Logging
+    # The logger
     class Logger
-
       extend ::Forwardable
       def_delegators :@logger, :fatal, :warn, :debug, :info, :error, :unknown
 
@@ -17,14 +17,14 @@ module FeduxOrgStdlib
       #
       # @param [Logger] logger (::Logger.new( $stderr ))
       #   The logger with should be used to output data
-      def initialize(logger = ::Logger.new( $stderr ) )
+      def initialize(logger = ::Logger.new($stderr))
         @logger = logger
         self.mode = :info
       end
 
       # Reset logger to ruby logger
       def reset
-        @logger = ::Logger.new( $stderr )
+        @logger = ::Logger.new($stderr)
       end
 
       # Change mode of logger: DEBUG, ... + Change the output format
@@ -52,14 +52,14 @@ module FeduxOrgStdlib
       private
 
       def format_debug
-        @logger.formatter = proc { |severity, datetime, progname , msg|
-          debug_msg("%s %s %s: %s\n" % [ datetime, severity, progname, msg ])
+        @logger.formatter = proc { |severity, datetime, progname, msg|
+          debug_msg(format("%s %s %s: %s\n", datetime, severity, progname, msg))
         }
       end
 
       def format_standard
         @logger.formatter = proc { |severity, datetime, _, msg|
-          info_msg( "%s %s: %s\n" % [ datetime, severity, msg ] )
+          info_msg(format("%s %s: %s\n", datetime, severity, msg))
         }
       end
 

data/lib/fedux_org_stdlib/logging/severity.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+# Ruby Logger-class
+# rubocop:disable Style/ClassAndModuleChildren:
 class ::Logger
+  # rubocop:enable Style/ClassAndModuleChildren:
   SILENT = 9999 unless defined? SILENT
 end

data/lib/fedux_org_stdlib/logic_converters.rb

@@ -6,6 +6,7 @@ require 'fedux_org_stdlib/logic_converters/true_false_converter'
 require 'fedux_org_stdlib/logic_converters/yes_no_converter'
 
 module FeduxOrgStdlib
+  # Logic converters
   module LogicConverters
   end
 end

data/lib/fedux_org_stdlib/logic_converters/exceptions.rb

@@ -3,9 +3,9 @@ module FeduxOrg
   module Stdlib
     module LogicConverters
       module Exceptions
-        #raised if invalid value was provided for conversion 
+        # raised if invalid value was provided for conversion
         class InvalidValue < Exception; end
-        #raised if invalid value was provided for conversion 
+        # raised if invalid value was provided for conversion
         class InvalidType < Exception; end
       end
     end

data/lib/fedux_org_stdlib/logic_converters/logic_converter.rb

@@ -8,22 +8,23 @@ require 'fedux_org_stdlib/logic_converters/y_n_converter'
 
 module FeduxOrgStdlib
   module LogicConverters
+    # Generic converter which passes arguments to other converters, e.g.
+    # true/false, yes/no, on/off, y/n-converters
     class LogicConverter
-
       # @param [String, Symbol] type (true_false, yes_no, on_off)
-      #   choose the type of converter which should be used 
+      #   choose the type of converter which should be used
       def initialize(type)
         @converter = case type.to_s
                      when 'true_false'
                        TrueFalseConverter.new
-                     when 'yes_no' 
+                     when 'yes_no'
                        YesNoConverter.new
-                     when 'on_off' 
+                     when 'on_off'
                        OnOffConverter.new
-                     when 'y_n' 
+                     when 'y_n'
                        YNConverter.new
                      else
-                       raise FeduxOrgStdlib::LogicConverters::Exceptions::InvalidType, "Unknown type \"#{type}\" for logic converter. Valid types are \"true_false\", \"yes_no\" or \"on_off\"."
+                       fail FeduxOrgStdlib::LogicConverters::Exceptions::InvalidType, "Unknown type \"#{type}\" for logic converter. Valid types are \"true_false\", \"yes_no\" or \"on_off\"."
                      end
       end
 
@@ -31,8 +32,8 @@ module FeduxOrgStdlib
       #   the logic value which should be converted
       # @return [String]
       #   the converted value
-      def parse( value )
-        @converter.parse( value )
+      def parse(value)
+        @converter.parse(value)
       end
     end
   end

data/lib/fedux_org_stdlib/logic_converters/on_off_converter.rb

@@ -2,9 +2,10 @@
 require 'fedux_org_stdlib/logic_converters/exceptions'
 
 module FeduxOrgStdlib
+  # Logic Converters
   module LogicConverters
+    # Convert on/off to true/false
     class OnOffConverter
-
       # @param [true,false] value
       #   the logic value which should be converted
       # @return [String]
@@ -17,8 +18,8 @@ module FeduxOrgStdlib
       # @example Parse false
       #    converter = FeduxOrgStdlib::LogicConverters::OnOffConverter.new
       #    converter.parse( false ) # off
-      #   
-      def parse( value )
+      #
+      def parse(value)
         case value
         when true
           'on'
@@ -27,7 +28,7 @@ module FeduxOrgStdlib
         when ''
           nil
         else
-          raise FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
+          fail FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
         end
       end
     end

data/lib/fedux_org_stdlib/logic_converters/true_false_converter.rb

@@ -3,8 +3,8 @@ require 'fedux_org_stdlib/logic_converters/exceptions'
 
 module FeduxOrgStdlib
   module LogicConverters
+    # Convert 'true'/'false' to true/false
     class TrueFalseConverter
-
       # @param [true,false] value
       #   the logic value which should be converted
       # @return [String]
@@ -17,7 +17,7 @@ module FeduxOrgStdlib
       # @example Parse false
       #    converter = FeduxOrgStdlib::LogicConverters::OnOffConverter.new
       #    converter.parse( false ) # 'false'
-      def parse( value )
+      def parse(value)
         case value
         when true
           'true'
@@ -26,7 +26,7 @@ module FeduxOrgStdlib
         when ''
           nil
         else
-          raise FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
+          fail FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
         end
       end
     end

data/lib/fedux_org_stdlib/logic_converters/y_n_converter.rb

@@ -3,8 +3,8 @@ require 'fedux_org_stdlib/logic_converters/exceptions'
 
 module FeduxOrgStdlib
   module LogicConverters
+    # Convert y/n to true/false
     class YNConverter
-
       # @param [true,false] value
       #   the logic value which should be converted
       # @return [String]
@@ -17,7 +17,7 @@ module FeduxOrgStdlib
       # @example Parse false
       #    converter = FeduxOrgStdlib::LogicConverters::OnOffConverter.new
       #    converter.parse( false ) # 'n'
-      def parse( value )
+      def parse(value)
         case value
         when true
           'y'
@@ -26,7 +26,7 @@ module FeduxOrgStdlib
         when ''
           nil
         else
-          raise FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
+          fail FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
         end
       end
     end

data/lib/fedux_org_stdlib/logic_converters/yes_no_converter.rb

@@ -3,6 +3,7 @@ require 'fedux_org_stdlib/logic_converters/exceptions'
 
 module FeduxOrgStdlib
   module LogicConverters
+    # Convert yes/no to true/false
     class YesNoConverter
       # @param [true,false] value
       #   the logic value which should be converted
@@ -16,8 +17,8 @@ module FeduxOrgStdlib
       # @example Parse false
       #    converter = FeduxOrgStdlib::LogicConverters::OnOffConverter.new
       #    converter.parse( false ) # 'no'
-      #   
-      def parse( value )
+      #
+      def parse(value)
         case value
         when true
           'yes'
@@ -26,7 +27,7 @@ module FeduxOrgStdlib
         when ''
           nil
         else
-          raise FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
+          fail FeduxOrgStdlib::LogicConverters::Exceptions::InvalidValue, "Unknown logic value \"#{value}\"."
         end
       end
     end

data/lib/fedux_org_stdlib/models/base_model.rb

@@ -2,12 +2,12 @@
 require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/logging'
 require 'fedux_org_stdlib/models/exceptions'
-require_library %w{ set }
+require_library %w(set)
 
 module FeduxOrgStdlib
   module Models
+    # Base model
     class BaseModel
-
       include Comparable
 
       @instances = ::Set.new
@@ -23,13 +23,13 @@ module FeduxOrgStdlib
         @enabled = false
       end
 
-      #enable action
+      # enable action
       def enable
         @enabled = true
       end
 
-      #check if action is enabled
-      def enabled?(val=true)
+      # check if action is enabled
+      def enabled?(val = true)
         @enabled == val
       end
 
@@ -46,11 +46,11 @@ module FeduxOrgStdlib
       end
 
       def hash
-        name.to_s.hash 
+        name.to_s.hash
       end
 
       class << self
-        #attr_accessor :instances
+        # attr_accessor :instances
 
         def register(element)
           @instances << element
@@ -58,17 +58,17 @@ module FeduxOrgStdlib
           element
         end
 
-        def create( *args, &block )
+        def create(*args, &block)
           if block_given?
-            register( new( *args, &block ) )
+            register(new(*args, &block))
           else
-            register( new( *args ) )
+            register(new(*args))
           end
         end
 
-        def delete( val )
-          element = self.find( val.to_s.to_sym )
-          raise FeduxOrgStdlib::Exceptions::InstanceNotFound unless element
+        def delete(val)
+          element = find(val.to_s.to_sym)
+          fail FeduxOrgStdlib::Exceptions::InstanceNotFound unless element
           @instances.delete element
 
           element
@@ -82,8 +82,8 @@ module FeduxOrgStdlib
           @instances.to_a
         end
 
-        #return all names as string
-        def all_names_as_string(connector=", ")
+        # return all names as string
+        def all_names_as_string(connector = ', ')
           find_all(enabled: true).map(&:name).sort.join(connector)
         end
 
@@ -95,36 +95,35 @@ module FeduxOrgStdlib
           @instances.to_a.last
         end
 
-        #enables a specific instance
+        # enables a specific instance
         def enable(name)
           find(name: name).enable
-        rescue NoMethodError => e
+        rescue NoMethodError
           raise FeduxOrgStdlib::Models::Exceptions::InvalidSearchCriteria, "Sorry I'm not able to enable \"#{name}\". You need to create an instance with name \"#{name}\" first."
         end
 
-        #finds a single instance
+        # finds a single instance
         def find(criteria = {})
           find_all(criteria).first
         end
 
-        #finds all instances
+        # finds all instances
         def find_all(criteria = {})
           FeduxOrgStdlib.logger.debug(self) { "Criteria for search: #{ criteria }" }
-          criteria = { name: criteria.to_sym } if criteria.kind_of? Symbol or criteria.kind_of? String
+          criteria = { name: criteria.to_sym } if criteria.is_a?(Symbol) || criteria.is_a?(String)
 
-          FeduxOrgStdlib.logger.debug(self) { "Instances to be searched for: #{ @instances.map { |i| "#{i.name} (#{i.class})" }.join(", ") }" }
-          @instances.find_all do |i| 
-            criteria.all? do |c,v|
+          FeduxOrgStdlib.logger.debug(self) { "Instances to be searched for: #{ @instances.map { |i| "#{i.name} (#{i.class})" }.join(', ') }" }
+          @instances.select do |i|
+            criteria.all? do |c, v|
 
               FeduxOrgStdlib.logger.debug(self) { "Check method for search: #{ c }" }
-              i.send( "#{c}?".to_sym , v )
+              i.send("#{c}?".to_sym, v)
             end
           end
         rescue NameError => e
           raise FeduxOrgStdlib::Models::Exceptions::InvalidSearchCriteria, e.message
         end
       end
-
     end
   end
 end