fedux_org-stdlib 0.7.21 → 0.7.22

data/lib/fedux_org_stdlib/command.rb

@@ -3,6 +3,7 @@ require 'fedux_org_stdlib/command/run_command'
 require 'fedux_org_stdlib/command/which'
 
 module FeduxOrgStdlib
+  # Command module
   module Command
     include RunCommand
     include Which

data/lib/fedux_org_stdlib/command/command_result.rb

@@ -1,6 +1,7 @@
 # encoding: utf-8
 module FeduxOrgStdlib
   module Command
+    # Result of command execution
     class CommandResult
       attr_accessor :stderr, :stdout, :status
 

data/lib/fedux_org_stdlib/command/run_command.rb

@@ -1,19 +1,20 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ open3 }
+require_library %w(open3)
 
 require 'fedux_org_stdlib/environment'
 require 'fedux_org_stdlib/command/command_result'
 
 module FeduxOrgStdlib
   module Command
+    # Run command
     module RunCommand
       include Environment
 
       # Execute command
       #
       # @param [String] cmd
-      #   the command 
+      #   the command
       #
       # @param [Hash] options
       #   the options for command execution
@@ -32,16 +33,16 @@ module FeduxOrgStdlib
       #
       # @return [CommandResult]
       #   the result of the command execution
-      def run_command(cmd,options={})
+      def run_command(cmd, options = {})
         opts = {
           env: nil,
           stdin: nil,
           binmode: false,
-          working_directory: Dir.getwd,
+          working_directory: Dir.getwd
         }.merge options
 
         env = opts[:env] || ENV.to_hash
-        stdin = opts[:stdin] 
+        stdin = opts[:stdin]
         binmode = opts[:binmode]
         working_directory = opts[:working_directory]
 

data/lib/fedux_org_stdlib/command/which.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ pathname active_support/core_ext/object/blank }
+require_library %w(pathname active_support/core_ext/object/blank)
 
 module FeduxOrgStdlib
   module Command
+    # Find path to executable
     module Which
-
       # Search for command
       # @param [String] cmd
       #    name of command or path to command (will be reduced to basename and then searched in PATH)
@@ -15,15 +15,15 @@ module FeduxOrgStdlib
       #
       # @param [Array,String] pathexts
       #   a string containing pathexts separated by ";" or an array of pathexts
-      #   
-      # @return [String] 
+      #
+      # @return [String]
       #   path to command
-      def which(cmd, options={})
+      def which(cmd, options = {})
         options = {
           paths:                         ENV['PATH'].split(File::PATH_SEPARATOR),
-          pathexts:                      ENV['PATHEXT'].to_s.split( /;/ ),
+          pathexts:                      ENV['PATHEXT'].to_s.split(/;/),
           raise_error_on_not_executable: false,
-          raise_error_on_not_found:      false,
+          raise_error_on_not_found:      false
         }.merge options
 
         cmd = Pathname.new(cmd)
@@ -33,26 +33,26 @@ module FeduxOrgStdlib
         raise_error_on_not_executable = options[:raise_error_on_not_executable]
         raise_error_on_not_found      = options[:raise_error_on_not_found]
 
-        raise Exceptions::CommandNotFound if cmd.to_s.empty?
+        fail Exceptions::CommandNotFound if cmd.to_s.empty?
         return nil if cmd.to_s.empty?
 
-        if cmd.absolute? 
+        if cmd.absolute?
           return cmd.to_s if cmd.executable?
-          raise Exceptions::CommandNotFound if raise_error_on_not_found and not cmd.exist?
-          raise Exceptions::CommandNotExecutable if raise_error_on_not_executable and not cmd.executable?
+          fail Exceptions::CommandNotFound if raise_error_on_not_found && !cmd.exist?
+          fail Exceptions::CommandNotExecutable if raise_error_on_not_executable && !cmd.executable?
           return nil
         end
 
         pathexts = [''] if pathexts.blank?
 
-        Array( paths ).each do |path|
-          Array( pathexts ).each do |ext|
-            file = Pathname.new( File.join(path, "#{cmd.to_s}#{ext.to_s}") )
+        Array(paths).each do |path|
+          Array(pathexts).each do |ext|
+            file = Pathname.new(File.join(path, "#{cmd}#{ext}"))
             return file.to_s if file.executable?
-            raise Exceptions::CommandNotExecutable if raise_error_on_not_executable and not cmd.executable?
+            fail Exceptions::CommandNotExecutable if raise_error_on_not_executable && !cmd.executable?
           end
-        end                                                                                                                                                        
-        raise Exceptions::CommandNotFound if raise_error_on_not_found
+        end
+        fail Exceptions::CommandNotFound if raise_error_on_not_found
         nil
       end
     end

data/lib/fedux_org_stdlib/core_ext/array/list.rb

@@ -1,7 +1,12 @@
 # encoding: utf-8
+# Array
 class Array
+  # Convert array to list
+  #
+  # @return [String]
+  #   A string representation of list
   def to_list(separator: ', ', last_separator: separator, around: '"')
-    items = self.map { |l| format("#{around}%s#{around}", l) }
+    items = map { |l| format("#{around}%s#{around}", l) }
 
     return items.join(last_separator) if items.size <= 2
 

data/lib/fedux_org_stdlib/core_ext/hash/list.rb

@@ -1,8 +1,13 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/core_ext/array/list'
 
+# Hash
 class Hash
+  # Convert Hash to list
+  #
+  # @return [String]
+  #   A string representation of hash as list
   def to_list
-    self.map { |key, value| format('%s: %s', key, value) }.to_list
+    map { |key, value| format('%s: %s', key, value) }.to_list
   end
 end

data/lib/fedux_org_stdlib/core_ext/hash/options.rb

@@ -2,6 +2,7 @@
 require 'shellwords'
 require 'fedux_org_stdlib/core_ext/shellwords/clean'
 
+# Hash
 class Hash
   # Convert hash to command line options
   #

data/lib/fedux_org_stdlib/core_ext/shellwords/clean.rb

@@ -1,8 +1,16 @@
 # encoding: utf-8
 require 'shellwords'
 
+# Shellwords
 module Shellwords
   class << self
+    # Clean string based shell pattern
+    #
+    # @param [String] string
+    #   The string which should be clean up
+    #
+    # @return [String]
+    #   Every character which needs to be escape in a shell has been removed
     def shellclean(string)
       shellescape(string).gsub(/\\./, '')
     end

data/lib/fedux_org_stdlib/core_ext/string/underline.rb

@@ -1,9 +1,17 @@
 # encoding: utf-8
+# String
 class String
+  # Underline a string
+  #
+  # @param [String] character ('-')
+  #   The character used to underline the string
+  #
+  # @return [String]
+  #   The string + underline
   def underline(character: '-')
     result = []
     result << self
-    result << self.gsub(/./, character)
+    result << gsub(/./, character)
 
     result.join("\n")
   end

data/lib/fedux_org_stdlib/environment.rb

@@ -1,7 +1,9 @@
 # encoding: utf-8
 module FeduxOrgStdlib
+  # Enviroment helpers
+  #
+  # @deprecated Please use https://github.com/cucumber/aruba instead
   module Environment
-
     # Set environment variable for code block
     #
     # @param [Hash] new_environment_variables
@@ -11,11 +13,11 @@ module FeduxOrgStdlib
     #   options for environment manipulation
     #
     # @option options [True,False] :clear
-    #   Should the environment clear before merge? 
+    #   Should the environment clear before merge?
     #
     # @yield
     #   the block which should be run which the change environment
-    def isolated_environment(new_environment_variables, options={}, &block)
+    def isolated_environment(new_environment_variables, options = {}, &block)
       old_environment = ENV.to_hash
 
       ENV.clear if options[:clear] == true
@@ -23,7 +25,7 @@ module FeduxOrgStdlib
 
       block.call
     ensure
-      ENV.clear 
+      ENV.clear
       ENV.update old_environment
     end
 

data/lib/fedux_org_stdlib/file_template.rb

@@ -3,7 +3,7 @@ require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/file_template/exceptions'
 require 'fedux_org_stdlib/core_ext/array/list'
 require 'fedux_org_stdlib/logging/logger'
-require_library %w{ json active_support/core_ext/string/inflections }
+require_library %w(json active_support/core_ext/string/inflections)
 
 module FeduxOrgStdlib
   # This class makes a template file available as an object. You can use
@@ -25,7 +25,7 @@ module FeduxOrgStdlib
   #   off, e.g "ClientTemplate" becomes "client.tt"
   #
   # 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 template file or name of the
   # template file one of the following methods needs to be overwritten:
@@ -52,7 +52,6 @@ module FeduxOrgStdlib
   #   ---
   #   option1: 'data2'
   class FileTemplate
-
     attr_reader :working_directory, :output_directory, :logger, :file, :content
 
     # Create a new instance of template
@@ -69,7 +68,7 @@ module FeduxOrgStdlib
     # @return [AppTemplate]
     #   The template instance. If the resulting data structure created by the
     #   template_engine does not respond to `:[]` an empty template object will be
-    #   created. 
+    #   created.
     def initialize(
       file: nil,
       logger: FeduxOrgStdlib::Logging::Logger.new,
@@ -80,14 +79,14 @@ module FeduxOrgStdlib
       @working_directory = working_directory
       @output_directory  = output_directory || working_directory
 
-      @file ||= available_template_file
-        
+      @file ||= (file || available_template_file)
+
       fail Exceptions::NoTemplateFileFound, "No template file found at #{allowed_template_file_paths.to_list}, therefor I'm stop working as there are methods which depend on an available template file path." unless @file
 
       begin
         @content = File.read(@file).chomp
       rescue StandardError => e
-        fail Exceptions::TemplateFileNotReadable, JSON.dump(message: e.message, file: @file)
+        raise Exceptions::TemplateFileNotReadable, JSON.dump(message: e.message, file: @file)
       end
     end
 
@@ -175,7 +174,6 @@ module FeduxOrgStdlib
       ::File.expand_path(::File.join(*path))
     end
 
-
     # Use this path as fall back path
     def fallback_template_directory; end
 
@@ -188,11 +186,11 @@ module FeduxOrgStdlib
     end
 
     def available_template_file
-      allowed_template_file_paths.map { |f| Dir.glob(f).first }.compact.find { |f| ::File.exists?(f) }
+      allowed_template_file_paths.map { |f| Dir.glob(f).first }.compact.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 basename

data/lib/fedux_org_stdlib/filesystem.rb

@@ -1,38 +1,39 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ fileutils }
+require_library %w(fileutils)
 
 require 'fedux_org_stdlib/filesystem/exceptions'
 
 # helper for file system
 module FeduxOrgStdlib
+  # File system
+  # @deprecated Please use https://github.com/cucumber/aruba instead
   module Filesystem
-
     # The root directory of the project
     #
     # @return [String]
     #   the root directory
     def root_directory
       #::File.expand_path('../../../', __FILE__)
-      raise Exceptions::InvalidUsageOfLibrary , "Sorry, but you need to define the root directory yourself"
+      fail Exceptions::InvalidUsageOfLibrary, 'Sorry, but you need to define the root directory yourself'
     end
 
     # The temporary directory for the project
     #
     # @return [String]
-    #   the directory created for the tests 
+    #   the directory created for the tests
     def working_directory
       ::File.join(root_directory, 'tmp', 'test')
     end
 
     # Create temporary directory
     def create_working_directory
-      FileUtils.mkdir_p(working_directory) unless ::File.exists? working_directory
+      FileUtils.mkdir_p(working_directory) unless ::File.exist? working_directory
     end
 
     # Delete temporary directory
     def delete_working_directory
-      FileUtils.rm_rf(working_directory) if ::File.exists? working_directory
+      FileUtils.rm_rf(working_directory) if ::File.exist? working_directory
     end
 
     # Clean up test directory
@@ -41,7 +42,7 @@ module FeduxOrgStdlib
       create_working_directory
     end
 
-    # Switch the current working directory to 
+    # Switch the current working directory to
     # the temporary one and execute code block
     def switch_to_working_directory(&block)
       Dir.chdir(working_directory, &block)
@@ -53,8 +54,8 @@ module FeduxOrgStdlib
     # @param [String,Array] dirs
     #   the directories to be created, multiple arguments are possible as well
     #
-    # @return [String,Array] 
-    #   returns a string if there was only one file given, and an array with 
+    # @return [String,Array]
+    #   returns a string if there was only one file given, and an array with
     #   muliple files
     def create_directory(*dirs)
       raise_if_forbidden_path_for_create_operation(dirs)
@@ -74,8 +75,8 @@ module FeduxOrgStdlib
     # @param [String, Array] dirs
     #   the directories to be deleted, multiple arguments are possible as well
     #
-    # @return [String,Array] 
-    #   returns a string if there was only one file given, and an array with 
+    # @return [String,Array]
+    #   returns a string if there was only one file given, and an array with
     #   muliple files
     def delete_directory(*dirs)
       raise_if_forbidden_path_for_delete_operation(dirs)
@@ -101,7 +102,7 @@ module FeduxOrgStdlib
       raise_if_forbidden_path_for_create_operation(paths)
 
       paths_expanded = expand_path(paths.flatten)
-      paths_expanded.flatten.all? { |p| ::File.exists?(p) }
+      paths_expanded.flatten.all? { |p| ::File.exist?(p) }
     end
 
     # Check absence of path(s)
@@ -112,7 +113,7 @@ module FeduxOrgStdlib
     # @return [TrueClass,FalseClass]
     #   the result of all checks done
     def path_does_not_exist?(*paths)
-      not path_exists?(paths)
+      !path_exists?(paths)
     end
 
     # Create a single file
@@ -125,14 +126,14 @@ module FeduxOrgStdlib
     #
     # @return [String]
     #   the path to the created file
-    def create_file(path, content='', mode=0644)
+    def create_file(path, content = '', mode = 0644)
       raise_if_forbidden_path_for_create_operation(path)
 
       file = expand_path(path).first
       directory = ::File.dirname(file)
 
       FileUtils.mkdir_p(directory) unless directory == '.'
-      ::File.open(file, "wb") do |f|
+      ::File.open(file, 'wb') do |f|
         f.write content
       end
 
@@ -166,13 +167,13 @@ module FeduxOrgStdlib
     # @param [String] path
     #   the path to the file
     #
-    # @return [String,Binary] 
+    # @return [String,Binary]
     #   the content of the file
     def read_file(path)
       raise_if_forbidden_path_for_create_operation(path)
 
       file_path = expand_path(path).first
-      return ::File.read(file_path)
+      ::File.read(file_path)
     end
 
     # Expand path based on temporary directory
@@ -185,18 +186,18 @@ module FeduxOrgStdlib
     def expand_path(*paths)
       raise_if_forbidden_path_for_create_operation(paths)
 
-      paths.flatten.map do |p| 
-        case p 
+      paths.flatten.map do |p|
+        case p
         when /^~/
-          ::File.expand_path(p) 
+          ::File.expand_path(p)
         else
-          ::File.join(working_directory, p ) 
+          ::File.join(working_directory, p)
         end
       end
     end
 
     # Check if path is forbidden for delete operation
-    # 
+    #
     # @param [String, Array] paths
     #   paths which should be checked
     #
@@ -205,9 +206,9 @@ module FeduxOrgStdlib
     def raise_if_forbidden_path_for_create_operation(*paths)
       flattend_paths = paths.flatten
       strings = []
-      regex = %r[\.\.]
+      regex = /\.\./
 
-      raise FileSystem::Exceptions::InvalidPath , "Sorry, but you cannot use paths matching \"#{strings.join(', ')}\"  or \"#{regex.inspect}\" here!" if path_matches?(strings, regex, flattend_paths)
+      fail FileSystem::Exceptions::InvalidPath, "Sorry, but you cannot use paths matching \"#{strings.join(', ')}\"  or \"#{regex.inspect}\" here!" if path_matches?(strings, regex, flattend_paths)
     end
 
     # Check if path is forbidden for delete operation
@@ -219,10 +220,10 @@ module FeduxOrgStdlib
     #   true if path is forbidden, false if path is not forbidden
     def raise_if_forbidden_path_for_delete_operation(*paths)
       flattend_paths = paths.flatten
-      strings = %w[ / ]
-      regex = %r[\.\.]
+      strings = %w(/)
+      regex = /\.\./
 
-      raise FileSystem::Exceptions::InvalidPath , "Sorry, but you cannot use paths matching \"#{strings.join(', ')}\"  or \"#{regex.to_s}\" here!" if path_matches?(strings, regex, flattend_paths)
+      fail FileSystem::Exceptions::InvalidPath, "Sorry, but you cannot use paths matching \"#{strings.join(', ')}\"  or \"#{regex}\" here!" if path_matches?(strings, regex, flattend_paths)
     end
 
     # Check if path matches
@@ -236,13 +237,13 @@ module FeduxOrgStdlib
     # @param [Array, String] paths
     #   the paths to be checked
     #
-    # @return [TrueClass, FalseClass] 
+    # @return [TrueClass, FalseClass]
     #   true if path is valid, false if invalid
     def path_matches?(strings, regex, *paths)
       flattend_paths = paths.flatten
       flattend_strings = strings.flatten
 
-      flattend_paths.any? { |f|  f =~ regex or flattend_strings.include?(f) }
+      flattend_paths.any? { |f|  f =~ regex || flattend_strings.include?(f) }
     end
   end
 end