fedux_org-stdlib 0.7.21 → 0.7.22

data/lib/fedux_org_stdlib/rake/sub_task.rb

@@ -18,7 +18,7 @@ module FeduxOrgStdlib
       # @param [Array] sub_tasks
       #   A list of sub tasks, e.g. 'namespace1:task1', 'task2'
       def initialize(
-        sub_tasks:, 
+        sub_tasks:,
         **args
       )
         super(**args)
@@ -27,7 +27,7 @@ module FeduxOrgStdlib
       end
 
       # @private
-      def run_task(verbose)
+      def run_task(_verbose)
         sub_tasks.each { |t| ::Rake::Task[t].invoke }
       end
     end

data/lib/fedux_org_stdlib/rake/task.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ json rake rake/tasklib shellwords active_support/core_ext/object/blank active_support/core_ext/string/inflections}
+require_library %w(json rake rake/tasklib shellwords active_support/core_ext/object/blank active_support/core_ext/string/inflections)
 
 require 'fedux_org_stdlib/rake/exceptions'
 require 'fedux_org_stdlib/logging/logger'
@@ -59,7 +59,7 @@ module FeduxOrgStdlib
       # @param [Array] dependencies
       #   An array of other tasks this task depends on.
       #
-      # @yield 
+      # @yield
       #   A block which is called before the "run_task"-method is called. The
       #   parameters it taskes depends on the number of parameters the block
       #   can take. If the block is defined which two parameters, it takes two
@@ -81,8 +81,9 @@ module FeduxOrgStdlib
         @logger             = FeduxOrgStdlib::Logging::Logger.new
         @working_directory  = Dir.getwd
         @activate_ci_mode   = activate_ci_mode
+        @define_in_ci_mode  = define_in_ci_mode
 
-        if dependencies.blank? 
+        if dependencies.blank?
           @name = name
         else
           @name = {
@@ -93,7 +94,7 @@ module FeduxOrgStdlib
         after_initialize
 
         define_task unless running_in_ci_mode?
-        define_task if define_in_ci_mode? and running_in_ci_mode?
+        define_task if define_in_ci_mode? && running_in_ci_mode?
       end
 
       private
@@ -124,7 +125,7 @@ module FeduxOrgStdlib
       end
 
       # Run code if task is executed
-      def run_task(verbose); end
+      def run_task(_verbose); end
 
       # Should this task be defined in continous integration mode
       def define_in_ci_mode?
@@ -144,7 +145,7 @@ module FeduxOrgStdlib
       public
 
       # Binding to instance
-      def get_binding
+      def instance_binding
         binding
       end
 

data/lib/fedux_org_stdlib/rake/version_bump_task.rb

@@ -8,19 +8,19 @@ module FeduxOrgStdlib
     #
     # @example Create new version task for bumping the major number X.0.0
     #   FeduxOrgStdlib::Rake::VersionBumpTask.new(
-    #     name: 'version:bump:major', 
+    #     name: 'version:bump:major',
     #     description: 'Bump major version part'
     #   ) { |t| t.bump_version :major }
     #
     # @example Create new version task for bumping the minor number 0.X.0
     #   FeduxOrgStdlib::Rake::VersionBumpTask.new(
-    #     name: 'version:bump:minor', 
+    #     name: 'version:bump:minor',
     #     description: 'Bump minor version part'
     #   ) { |t| t.bump_version :minor }
     #
     # @example Create new version task for bumping the tiny number 0.0.X
     #   FeduxOrgStdlib::Rake::VersionBumpTask.new(
-    #     name: 'version:bump:tiny', 
+    #     name: 'version:bump:tiny',
     #     description: 'Bump tiny version part'
     #   ) { |t| t.bump_version :tiny }
     #
@@ -31,13 +31,13 @@ module FeduxOrgStdlib
       # @private
       def bump_version(type)
         version_update do |file|
-          file.bump(type) 
+          file.bump(type)
         end
       end
 
       # @private
-      def set_version(new_version)
-        raise Exception, "You need to define a version via \"VERSION=<version>\" or \"version=<version>\"." if new_version.blank?
+      def version(new_version)
+        fail Exception, "You need to define a version via \"VERSION=<version>\" or \"version=<version>\"." if new_version.blank?
 
         begin
           version_update do |file|
@@ -58,7 +58,6 @@ module FeduxOrgStdlib
         sh "git commit -m 'Version bump to #{version}'"
       end
 
-
       def version_update(&block)
         file = FeduxOrgStdlib::VersionManagement::RubygemVersionFile.read(version_file)
         old_version = file.version

data/lib/fedux_org_stdlib/rake_tasks/console.rb

@@ -8,4 +8,3 @@ FeduxOrgStdlib::Rake::ShellTask.new(
   command: 'script/console',
   define_in_ci_mode: false
 )
-

data/lib/fedux_org_stdlib/rake_tasks/documentation/yard.rb

@@ -4,7 +4,7 @@ require 'fedux_org_stdlib/ci'
 
 unless ci?
   require 'fedux_org_stdlib/require_files'
-  require_library %w{ yard }
+  require_library %w(yard)
 
-  YARD::Rake::YardocTask.new()
+  YARD::Rake::YardocTask.new
 end

data/lib/fedux_org_stdlib/rake_tasks/gems/bundler.rb

@@ -4,6 +4,6 @@ require 'fedux_org_stdlib/ci'
 
 unless ci?
   namespace :gem do
-    require_library %w{ bundler/gem_tasks }
+    require_library %w(bundler/gem_tasks)
   end
 end

data/lib/fedux_org_stdlib/rake_tasks/gems/package.rb

@@ -4,6 +4,6 @@ require 'fedux_org_stdlib/ci'
 
 unless ci?
   namespace :gem do
-    require_library %w{ rubygems/package_task }
+    require_library %w(rubygems/package_task)
   end
 end

data/lib/fedux_org_stdlib/rake_tasks/project/report/generate.rb

@@ -3,8 +3,7 @@ require 'fedux_org_stdlib/rake/project_task'
 
 FeduxOrgStdlib::Rake::ProjectTask.new(
   name: 'project:report:generate',
-  description: 'Generate report for project plan',
+  description: 'Generate report for project plan'
 ) do |t|
   t.report.generate
 end
-

data/lib/fedux_org_stdlib/rake_tasks/project/report/open.rb

@@ -3,8 +3,7 @@ require 'fedux_org_stdlib/rake/project_task'
 
 FeduxOrgStdlib::Rake::ProjectTask.new(
   name: 'project:report:open',
-  description: 'Open generated report for project plan',
+  description: 'Open generated report for project plan'
 ) do |t|
   t.report.open
 end
-

data/lib/fedux_org_stdlib/rake_tasks/project/report/open_shortcut.rb

@@ -5,5 +5,5 @@ require 'fedux_org_stdlib/rake_tasks/project/report/open'
 FeduxOrgStdlib::Rake::SubTask.new(
   name: 'project:report',
   description: 'Open report for generated project plan',
-  sub_tasks: %w{ project:report:open },
+  sub_tasks: %w(project:report:open)
 )

data/lib/fedux_org_stdlib/rake_tasks/qa/rubocop.rb

@@ -9,5 +9,5 @@ FeduxOrgStdlib::Rake::ShellTask.new(
   description: 'Run rubocop',
   use_bundler: true,
   command: 'rubocop',
-  define_in_ci_mode: false,
+  define_in_ci_mode: false
 )

data/lib/fedux_org_stdlib/rake_tasks/qa/travis.rb

@@ -9,5 +9,5 @@ FeduxOrgStdlib::Rake::ShellTask.new(
   description: 'Runs travis-lint to check .travis.yml',
   use_bundler: true,
   command: 'travis-lint',
-  define_in_ci_mode: false,
+  define_in_ci_mode: false
 )

data/lib/fedux_org_stdlib/rake_tasks/software_version/bump.rb

@@ -5,4 +5,4 @@ require 'fedux_org_stdlib/rake/version_bump_task'
 FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump:major', description: 'Bump major version part') { |t| t.bump_version :major }
 FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump:minor', description: 'Bump minor version part') { |t| t.bump_version :minor }
 FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump:tiny',  description: 'Bump tiny version part')   { |t| t.bump_version :tiny }
-FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump',       description: 'Bump version to ENV["VERSION"] or ENV["version"]') { |t| t.set_version ENV['VERSION'] || ENV['version'] }
+FeduxOrgStdlib::Rake::VersionBumpTask.new(name: 'version:bump',       description: 'Bump version to ENV["VERSION"] or ENV["version"]') { |t| t.version ENV['VERSION'] || ENV['version'] }

data/lib/fedux_org_stdlib/rake_tasks/software_version/restore.rb

@@ -6,6 +6,6 @@ require 'fedux_org_stdlib/rake/shell_task'
 task = FeduxOrgStdlib::Rake::ShellTask.new(
   name: 'version:restore',
   description: 'Restore version file from repository',
-  command: "git checkout <%= version_file %>"
+  command: 'git checkout <%= version_file %>'
 )
 task.include FeduxOrgStdlib::Roles::Versionable

data/lib/fedux_org_stdlib/rake_tasks/software_version/show.rb

@@ -5,8 +5,7 @@ require 'fedux_org_stdlib/rake/task'
 task = FeduxOrgStdlib::Rake::Task.new(
   name: 'version:show',
   description: 'Show version'
-) do |t|
-  $stderr.puts FeduxOrgStdlib::VersionManagement::RubygemVersionFile.read(version_file).version 
+) do |_t|
+  $stderr.puts FeduxOrgStdlib::VersionManagement::RubygemVersionFile.read(version_file).version
 end
 task.include FeduxOrgStdlib::Roles::Versionable
-

data/lib/fedux_org_stdlib/rake_tasks/software_version/show_shortcut.rb

@@ -5,5 +5,5 @@ require 'fedux_org_stdlib/rake_tasks/software_version/show'
 FeduxOrgStdlib::Rake::SubTask.new(
   name: 'version',
   description: 'Show version',
-  sub_tasks: %w{ version:show }
+  sub_tasks: %w(version:show)
 )

data/lib/fedux_org_stdlib/rake_tasks/tests/cucumber.rb

@@ -10,4 +10,3 @@ FeduxOrgStdlib::Rake::ShellTask.new(
   use_bundler: true,
   command: 'cucumber -p all'
 )
-

data/lib/fedux_org_stdlib/rake_tasks/tests/travis.rb

@@ -6,6 +6,6 @@ require 'fedux_org_stdlib/rake_tasks/test/cucumber'
 FeduxOrgStdlib::Rake::SubTask.new(
   name: 'test:travis',
   description: 'Runs rspec and cucumber on travis',
-  sub_tasks: %w{ test:rspec test:cucumber },
+  sub_tasks: %w(test:rspec test:cucumber),
   activate_ci_mode: true
 )

data/lib/fedux_org_stdlib/require_files.rb

@@ -2,6 +2,7 @@
 require 'fedux_org_stdlib/core_ext/array'
 
 module FeduxOrgStdlib
+  # Helper
   module RequireFiles
     def require_library(libraries, message_template = 'You need to install %s to make "%s" work.')
       libraries = Array(libraries)
@@ -9,17 +10,17 @@ module FeduxOrgStdlib
       begin
         libraries.each { |l| require l }
       rescue LoadError => e
-        $stderr.puts format(message_template, libraries.map { |l| l.split(%r{/}).first }.uniq.to_list, caller[1].split(/:/)[0,2].join(':'))
+        $stderr.puts format(message_template, libraries.map { |l| l.split(/\//).first }.uniq.to_list, caller[1].split(/:/)[0, 2].join(':'))
         $stderr.puts
         $stderr.puts e.message
-        exit 1 
+        exit 1
       end
     end
 
-    def require_installed_gem(gems, message_template = 'You need to install %s to make "%s" work.')
+    def require_installed_gem(gems, _message_template = 'You need to install %s to make "%s" work.')
       gems = Array(gems)
 
-      raise LoadError, JSON.dump(gems: gems) if gems.any? { |name| Gem::Specification.find_all_by_name(name).blank? }
+      fail LoadError, JSON.dump(gems: gems) if gems.any? { |name| Gem::Specification.find_all_by_name(name).blank? }
     end
   end
 end

data/lib/fedux_org_stdlib/roles/typable.rb

@@ -9,7 +9,7 @@ module FeduxOrgStdlib
     # a `Pathname`.
     #
     # @example
-    #   
+    #
     #   class MyClass
     #     include FeduxOrgStdlib::Roles::Typeable
     #
@@ -32,7 +32,6 @@ module FeduxOrgStdlib
     #   object.image?      # => false
     #   object.stylesheet? # => true
     module Typable
-
       def source_path
         fail NoMethodError, :source_path
       end
@@ -129,7 +128,7 @@ module FeduxOrgStdlib
       def font?
         font_by_path? || font_by_extension?
       end
-      
+
       private
 
       # Is font by path?

data/lib/fedux_org_stdlib/roles/versionable.rb

@@ -3,14 +3,15 @@ require 'fedux_org_stdlib/rake/exceptions'
 
 module FeduxOrgStdlib
   module Roles
+    # Versionable
     module Versionable
       def version_file(working_directory = Dir.getwd)
         paths = []
         paths << File.join(working_directory, 'lib', '**', 'version.rb')
 
-        file = Dir.glob(paths.shift).first while !paths.blank? and file.blank?
+        file = Dir.glob(paths.shift).first while !paths.blank? && file.blank?
 
-        raise FeduxOrgStdlib::Rake::Exceptions::VersionFileNotFound, JSON.dump(message: 'Cannot find version file') unless file
+        fail FeduxOrgStdlib::Rake::Exceptions::VersionFileNotFound, JSON.dump(message: 'Cannot find version file') unless file
 
         file
       end

data/lib/fedux_org_stdlib/shell_language_detector.rb

@@ -3,6 +3,25 @@ require 'fedux_org_stdlib/process_environment'
 require 'fedux_org_stdlib/shell_language_detector/language'
 
 module FeduxOrgStdlib
+  # Detect language of shell
+  #
+  # @example Simple Usage
+  #
+  #   detector = ShellLanguageDetector.new
+  #   lang = detector.detect
+  #   puts lang.language_code
+  #   puts lang.country_code
+  #   puts lang.encoding
+  #
+  # @example Overwrite detected lang
+  #
+  #   detector = ShellLanguageDetector.new
+  #   lang = detector.detect(overwrite: [:de, :de, :utf_8]
+  #
+  # @example Allowed languages
+  #
+  #   detector = ShellLanguageDetector.new
+  #   lang = detector.detect(allowed: [:de, :en])
   class ShellLanguageDetector
     private
 
@@ -27,8 +46,8 @@ module FeduxOrgStdlib
       overwrite = Array(overwrite).map(&:to_sym)
 
       lang = environment.fetch 'LANG'
-      language_code, country_code, encoding = lang.scan(/([^_-]+)[_-]([^.]+)\.([A-Za-z0-9_-]*)/i).flatten.map(&:downcase).map { |e| e.gsub('-', '_') }.map { |e| e.to_sym if !e.nil? }
-      language_code, country_code, encoding = *overwrite if !overwrite.blank? && overwrite.none? { |o| o.blank? } 
+      language_code, country_code, encoding = lang.scan(/([^_-]+)[_-]([^.]+)\.([A-Za-z0-9_-]*)/i).flatten.map(&:downcase).map { |e| e.gsub('-', '_') }.map { |e| e.to_sym unless e.nil? }
+      language_code, country_code, encoding = *overwrite if !overwrite.blank? && overwrite.none?(&:blank?)
 
       return Language.new(language_code: language_code, country_code: country_code, encoding: encoding) if language_code && (allowed.blank? || allowed.include?(language_code))
       Language.new(language_code: default_language_code, country_code: default_country_code, encoding: default_encoding)

data/lib/fedux_org_stdlib/shell_language_detector/language.rb

@@ -1,8 +1,16 @@
 # encoding: utf-8
 module FeduxOrgStdlib
   class ShellLanguageDetector
+    # The detected langauge
     class Language
-
+      # @!attribute [r] language_code
+      #   The language code, e.g de_DE.utf-8 => de
+      #
+      # @!attribute [r] country_code
+      #   The country code, e.g de_DE.utf-8 => DE
+      #
+      # @!attribute [r] encoding
+      #   The country code, e.g de_DE.utf-8 => utf-8
       attr_reader :language_code, :country_code, :encoding
 
       def initialize(language_code:, country_code:, encoding: nil)

data/lib/fedux_org_stdlib/support_information.rb

@@ -1,9 +1,15 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/core_ext/string/underline'
-require_library %w{ facter }
+require_library %w(facter)
 
 module FeduxOrgStdlib
+  # Gather support information
+  #
+  # @example Gather information
+  #
+  # info = SupportInformation.new
+  # puts info
   class SupportInformation
     private
 
@@ -28,30 +34,30 @@ module FeduxOrgStdlib
 
       result << headlines.fetch(:system_information, 'System Information').underline(character: underline_character)
       result << format("%#{max_field_length}s | %s", 'Information', 'Value')
-      result << format("%s + %s", '-' * max_field_length, '-' * 40)
-      result.concat system_information.sort_by { |key, value| key }.map { |key, value| format("%#{max_field_length}s | %s", key, value) }
+      result << format('%s + %s', '-' * max_field_length, '-' * 40)
+      result.concat system_information.sort_by { |key, _value| key }.map { |key, value| format("%#{max_field_length}s | %s", key, value) }
 
-      result << ""
-      result << ""
-      result << ""
+      result << ''
+      result << ''
+      result << ''
 
       max_field_length = determine_max_field_length(rubygems_information.keys)
 
       result << headlines.fetch(:rubygems_information, 'Rubygems Information').underline(character: underline_character)
       result << format("%#{max_field_length}s | %s", 'Information', 'Value')
-      result << format("%s + %s", '-' * max_field_length, '-' * 40)
-      result.concat rubygems_information.sort_by { |key, value| key }.map { |key, value| format("%#{max_field_length}s | %s", key, value) }
+      result << format('%s + %s', '-' * max_field_length, '-' * 40)
+      result.concat rubygems_information.sort_by { |key, _value| key }.map { |key, value| format("%#{max_field_length}s | %s", key, value) }
 
-      result << ""
-      result << ""
-      result << ""
+      result << ''
+      result << ''
+      result << ''
 
       max_field_length = determine_max_field_length(installed_rubygems.keys)
 
       result << headlines.fetch(:installed_rubygems, 'Installed Rubygems').underline(character: underline_character)
       result << format("%#{max_field_length}s | %s", 'Name', 'version')
-      result << format("%s + %s", '-' * max_field_length, '-' * 40)
-      result.concat installed_rubygems.sort_by { |key, value| key }.map { |key, value| format("%#{max_field_length}s | %s", key, value) }
+      result << format('%s + %s', '-' * max_field_length, '-' * 40)
+      result.concat installed_rubygems.sort_by { |key, _value| key }.map { |key, value| format("%#{max_field_length}s | %s", key, value) }
 
       result.join "\n"
     end
@@ -76,8 +82,8 @@ module FeduxOrgStdlib
     end
 
     def system_information
-      Timeout::timeout(10) do
-        Facter.to_hash.keep_if { |key,_| facter_fields.include?(key.to_s) }
+      Timeout.timeout(10) do
+        Facter.to_hash.keep_if { |key, _| facter_fields.include?(key.to_s) }
       end
     rescue Timeout::Error
       logger.warn 'Getting environment information took to long. Please make sure the name resolver is available. This might cause the latency.'
@@ -85,49 +91,48 @@ module FeduxOrgStdlib
     end
 
     def determine_max_field_length(list)
-      list.inject(0) { |memo, f| memo = f.size if f.size > memo ; memo}
+      list.reduce(0) { |a, e| e.size > a ? e.size : a }
     end
 
     def facter_fields
-      %w[
-            architecture 
-            filesystems 
-            hardwareisa 
-            hardwaremodel 
-            is_virtual 
-            kernel 
-            kernelmajversion 
-            kernelrelease 
-            kernelversion 
-            memoryfree 
-            memoryfree_mb 
-            memorysize 
-            memorysize_mb 
-            memorytotal 
-            operatingsystem 
-            operatingsystemrelease 
-            osfamily 
-            path 
-            physicalprocessorcount 
-            processor0 
-            processor1 
-            processorcount 
-            ps 
-            rubysitedir 
-            rubyversion 
-            selinux 
-            swapfree 
-            swapfree_mb 
-            swapsize 
-            swapsize_mb 
-            timezone 
-            uptime 
-            uptime_days 
-            uptime_hours 
-            uptime_seconds 
-            virtual 
-      ]
+      %w(
+        architecture
+        filesystems
+        hardwareisa
+        hardwaremodel
+        is_virtual
+        kernel
+        kernelmajversion
+        kernelrelease
+        kernelversion
+        memoryfree
+        memoryfree_mb
+        memorysize
+        memorysize_mb
+        memorytotal
+        operatingsystem
+        operatingsystemrelease
+        osfamily
+        path
+        physicalprocessorcount
+        processor0
+        processor1
+        processorcount
+        ps
+        rubysitedir
+        rubyversion
+        selinux
+        swapfree
+        swapfree_mb
+        swapsize
+        swapsize_mb
+        timezone
+        uptime
+        uptime_days
+        uptime_hours
+        uptime_seconds
+        virtual
+      )
     end
-
   end
 end