fedux_org-stdlib 0.7.21 → 0.7.22

data/lib/fedux_org_stdlib/models/class_based_model.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ find active_support/core_ext/object/blank active_support/core_ext/string/inflections }
+require_library %w(find active_support/core_ext/object/blank active_support/core_ext/string/inflections)
 
 require 'fedux_org_stdlib/models/filesystem_based_model'
 
@@ -12,9 +12,10 @@ module FeduxOrgStdlib
         base.extend ClassMethods
       end
 
+      # Class methods
       module ClassMethods
         def require_path(name)
-          path = File.join( library_name.underscore , model_name.pluralize.underscore , name.to_s )
+          path = File.join(library_name.underscore, model_name.pluralize.underscore, name.to_s)
           FeduxOrgStdlib.logger.debug(self) { "Path to instances of model \"#{name}\": #{path}" }
 
           path
@@ -26,18 +27,18 @@ module FeduxOrgStdlib
           raise FeduxOrgStdlib::Models::Exceptions::ExceptionNeedsToBeImplemented, "Exception \"#{library_name}::Exceptions::Invalid#{model_name}\" does not exist."
         end
 
-        def check_klass( klass , *methods)
-          raise exception_for_model, "A valid \"#{model_name}\"-class needs to respond to \"#{ methods.flatten.join(", ") }\"." unless methods.flatten.all? { |m| klass.new.respond_to? m }
+        def check_klass(klass, *methods)
+          fail exception_for_model, "A valid \"#{model_name}\"-class needs to respond to \"#{ methods.flatten.join(', ') }\"." unless methods.flatten.all? { |m| klass.new.respond_to? m }
         end
 
         def build_class_constant(name)
           "#{library_name}::#{model_name.pluralize}::#{name.to_s.camelcase}".constantize
         rescue
-          raise exception_for_model , "Class \"#{library_name}::#{model_name.pluralize}::#{name.to_s.camelcase}\" cannot be found in file \"#{require_path(name)}\"."
+          raise exception_for_model, "Class \"#{library_name}::#{model_name.pluralize}::#{name.to_s.camelcase}\" cannot be found in file \"#{require_path(name)}\"."
         end
 
         def check_method
-          raise FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Method \"check_method\" does not exist."
+          fail FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Method \"check_method\" does not exist."
         end
 
         def suffix
@@ -47,18 +48,18 @@ module FeduxOrgStdlib
         def load_from_filesystem
           files = find_files
 
-          FeduxOrgStdlib.logger.debug(self) { "Files found at path \"#{path_to_instances}\": #{ files.join(", ") }" }
+          FeduxOrgStdlib.logger.debug(self) { "Files found at path \"#{path_to_instances}\": #{ files.join(', ') }" }
 
-          raise FeduxOrgStdlib::Models::Exceptions::NoImplementationsForModelFound, "You might need to store files at \"#{File.dirname(path_to_instances)}\" to make the library work." if files.blank?
+          fail FeduxOrgStdlib::Models::Exceptions::NoImplementationsForModelFound, "You might need to store files at \"#{File.dirname(path_to_instances)}\" to make the library work." if files.blank?
 
-          files.each do |f| 
-            instance_name = name( f )
+          files.each do |f|
+            instance_name = name(f)
 
-            require require_path( instance_name )
+            require require_path(instance_name)
 
-            instance_klass = build_class_constant( instance_name )
-            check_klass( instance_klass, check_method )
-            create( instance_name , instance_klass.new )
+            instance_klass = build_class_constant(instance_name)
+            check_klass(instance_klass, check_method)
+            create(instance_name, instance_klass.new)
           end
         end
       end

data/lib/fedux_org_stdlib/models/exceptions.rb

@@ -2,39 +2,38 @@
 module FeduxOrgStdlib
   module Models
     module Exceptions
-      #internal error
+      # internal error
       class InternalError < Exception; end
 
-      #raised if one tries to delete an instance which
-      #does not exist
+      # raised if one tries to delete an instance which
+      # does not exist
       class InstanceNotFound < InternalError; end
 
-      #raised if one tries to use a keyword whose use
-      #is restricted
+      # raised if one tries to use a keyword whose use
+      # is restricted
       class UnauthorizedUseOfKeyword < InternalError; end
 
-      #raised if one uses invalid search criteria
+      # raised if one uses invalid search criteria
       class InvalidSearchCriteria < InternalError; end
 
-      #raised if the code which defines an import filter
-      #is malformed
+      # raised if the code which defines an import filter
+      # is malformed
       class MethodNeedsToBeImplemented < InternalError; end
 
-      #raised if one tries to use an unimplemented exception
+      # raised if one tries to use an unimplemented exception
       class ExceptionNeedsToBeImplemented < InternalError; end
 
-      #raised if one forgot to store files at `path_to_instances`
+      # raised if one forgot to store files at `path_to_instances`
       class NoImplementationsForModelFound < InternalError; end
 
-      #raised if an file system error occured
-      class FilesystemError < Exception ; end
+      # raised if an file system error occured
+      class FilesystemError < Exception; end
 
-      #raise if a directory does not exist in filesystem
+      # raise if a directory does not exist in filesystem
       class DirectoryDoesNotExist < FilesystemError; end
 
-      #raise if a file does not exist in filesystem
+      # raise if a file does not exist in filesystem
       class FileDoesNotExist < FilesystemError; end
-
     end
   end
 end

data/lib/fedux_org_stdlib/models/filesystem_based_model.rb

@@ -5,14 +5,13 @@ module FeduxOrgStdlib
   module Models
     # model for import action
     module FilesystemBasedModel
-
       def self.included(base)
         base.extend ClassMethods
       end
 
+      # Class methods
       module ClassMethods
-
-        #initialize model
+        # initialize model
         def init
           load_from_filesystem
         end
@@ -27,7 +26,7 @@ module FeduxOrgStdlib
         end
 
         def fqcn
-          self.to_s.split(/::/)
+          to_s.split(/::/)
         end
 
         def model_name
@@ -39,11 +38,11 @@ module FeduxOrgStdlib
         end
 
         def suffix
-          raise FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Please defined the method \"suffix\" to make the library work."
+          fail FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Please defined the method \"suffix\" to make the library work."
         end
 
         def model_path
-          raise FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Please defined the method \"model_path\" to make the library work."
+          fail FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented, "Please defined the method \"model_path\" to make the library work."
         end
 
         def ignore
@@ -54,9 +53,9 @@ module FeduxOrgStdlib
           files = []
           Find.find(path_to_instances) do |path|
             next unless File.file? path
-            next if suffix and path !~/#{suffix}$/
+            next if suffix && path !~ /#{suffix}$/
             next if path =~ /^\.\.?/
-            next if path =~ %r{#{ignore}}
+            next if path =~ /#{ignore}/
 
             files << path
           end
@@ -67,7 +66,7 @@ module FeduxOrgStdlib
         end
 
         def path_to_instances
-          return_path = ::File.expand_path("../../#{model_name.pluralize.underscore}", model_path )
+          return_path = ::File.expand_path("../../#{model_name.pluralize.underscore}", model_path)
 
           FeduxOrgStdlib.logger.debug(self) { "Path to instances of model: #{return_path}" }
 
@@ -75,8 +74,8 @@ module FeduxOrgStdlib
         end
 
         def name(path)
-          name = File.basename(path, suffix ).to_sym
-          raise FeduxOrgStdlib::Models::Exceptions::UnauthorizedUseOfKeyword if forbidden_keywords.include? name
+          name = File.basename(path, suffix).to_sym
+          fail FeduxOrgStdlib::Models::Exceptions::UnauthorizedUseOfKeyword if forbidden_keywords.include? name
 
           FeduxOrgStdlib.logger.debug(self) { "Name of model: #{name}" }
 
@@ -84,15 +83,13 @@ module FeduxOrgStdlib
         end
 
         def load_from_filesystem
-          raise FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented
+          fail FeduxOrgStdlib::Models::Exceptions::MethodNeedsToBeImplemented
         end
 
         def forbidden_keywords
-          [ ]
+          []
         end
-
       end
-
     end
   end
 end

data/lib/fedux_org_stdlib/process_environment.rb

@@ -1,5 +1,16 @@
 # encoding: utf-8
 module FeduxOrgStdlib
+  # Abstract process environment
+  #
+  # @example Init
+  #
+  #   env = ProcessEnvironment.new
+  #   env.fetch('HOME')                # => /home/user
+  #   env.fetch('HOME_123', 'default') # => default
+  #
+  #   env.write('HOME_123' 'you')
+  #   env.fetch('HOME_123')            # => you
+  #
   class ProcessEnvironment
     private
 
@@ -9,7 +20,6 @@ module FeduxOrgStdlib
 
     def initialize(environment = ENV)
       @environment = environment
-
     end
 
     def fetch(key, default_value = nil)

data/lib/fedux_org_stdlib/project.rb

@@ -3,4 +3,3 @@ require 'fedux_org_stdlib/project/logger'
 require 'fedux_org_stdlib/project/plan'
 require 'fedux_org_stdlib/project/report'
 require 'fedux_org_stdlib/project/generators/taskjuggler'
-

data/lib/fedux_org_stdlib/project/generators/taskjuggler.rb

@@ -1,12 +1,13 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ command_exec }
+require_library %w(command_exec)
 
 require 'fedux_org_stdlib/project/logger'
 
 module FeduxOrgStdlib
   module Project
     module Generators
+      # Taskjuggler
       class Taskjuggler
         # Generate report
         #
@@ -15,24 +16,24 @@ module FeduxOrgStdlib
         # @param [Plan] plan
         #   The project plan to use
         def generate_report(directory, plan)
-          FeduxOrgStdlib::Project.logger.debug "Start generating report."
+          FeduxOrgStdlib::Project.logger.debug 'Start generating report.'
 
           begin
-            command = CommandExec::Command.new(:tj3 , 
-                                               :parameter          => "-o #{directory} #{plan}",
-                                               :error_detection_on => [:return_code],
-                                               :error_indicators   => {
-                                                 :allowed_return_code => [0],
+            command = CommandExec::Command.new(:tj3,
+                                               parameter: "-o #{directory} #{plan}",
+                                               error_detection_on: [:return_code],
+                                               error_indicators: {
+                                                 allowed_return_code: [0]
                                                },
-                                               :on_error_do => :raise_error,
+                                               on_error_do: :raise_error
                                               )
             command.run
           rescue CommandExec::Exceptions::CommandExecutionFailed
-            FeduxOrgStdlib::Project.logger.fatal "Failed to generate report:\n\n#{ command.result.stderr.join( "\n" ) }"
+            FeduxOrgStdlib::Project.logger.fatal "Failed to generate report:\n\n#{ command.result.stderr.join("\n") }"
             exit 1
           end
 
-          FeduxOrgStdlib::Project.logger.info "Generating report succeeded."
+          FeduxOrgStdlib::Project.logger.info 'Generating report succeeded.'
         end
       end
     end

data/lib/fedux_org_stdlib/project/logger.rb

@@ -2,6 +2,7 @@
 require 'fedux_org_stdlib/logging/logger'
 
 module FeduxOrgStdlib
+  # Project logger
   module Project
     class << self
       def logger

data/lib/fedux_org_stdlib/project/plan.rb

@@ -1,8 +1,8 @@
 # encoding: utf-8
 module FeduxOrgStdlib
   module Project
+    # Plan file
     class Plan
-
       private
 
       attr_reader :main_file, :additional_files

data/lib/fedux_org_stdlib/project/report.rb

@@ -1,16 +1,16 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ fileutils launchy }
+require_library %w(fileutils launchy)
 
 require 'fedux_org_stdlib/logging/logger'
 require 'fedux_org_stdlib/project/logger'
 require 'fedux_org_stdlib/project/generators/taskjuggler'
 
-
 module FeduxOrgStdlib
+  # Project
   module Project
+    # Taskjugger report
     class Report
-
       attr_reader :directory, :file
 
       private
@@ -28,7 +28,7 @@ module FeduxOrgStdlib
       # @param [Generator] generator
       #   A generator to be used to be generator the report
       def initialize(
-        plan:, 
+        plan:,
         output_file:,
         generator: FeduxOrgStdlib::Project::Generators::Taskjuggler.new
       )
@@ -42,10 +42,10 @@ module FeduxOrgStdlib
       def generate
         prepare_environment
 
-        if output_file_does_not_exist? or plan_is_newer_than_output_file?
-          generator.generate_report(output_directory, plan) 
+        if output_file_does_not_exist? || plan_is_newer_than_output_file?
+          generator.generate_report(output_directory, plan)
         else
-          FeduxOrgStdlib::Project.logger.warn "No need to re-generate report. The plan file \"#{plan.to_s}\" is NOT newer than output \"#{@output_file}\"."
+          FeduxOrgStdlib::Project.logger.warn "No need to re-generate report. The plan file \"#{plan}\" is NOT newer than output \"#{@output_file}\"."
         end
       end
 
@@ -61,13 +61,12 @@ module FeduxOrgStdlib
       end
 
       def output_file_does_not_exist?
-        !File.exists? output_file
+        !File.exist? output_file
       end
 
       def plan_is_newer_than_output_file?
         plan.needs_to_be_compiled? output_file
       end
     end
-
   end
 end

data/lib/fedux_org_stdlib/rake/project.rb

@@ -4,15 +4,15 @@ require 'fedux_org_stdlib/project'
 namespace :report do
 
   plan   = FeduxOrgStdlib::Project::Plan.new
-  report = FeduxOrgStdlib::Project::Report.new( plan )
+  report = FeduxOrgStdlib::Project::Report.new(plan)
 
-  desc "Generate report"
+  desc 'Generate report'
   task :generate do
     report.generate
   end
 
-  desc "Show report"
-  task :show => :generate do
+  desc 'Show report'
+  task show: :generate do
     report.open
   end
 end

data/lib/fedux_org_stdlib/rake/project_task.rb

@@ -8,7 +8,6 @@ module FeduxOrgStdlib
     #
     # @see Rakefile
     class ProjectTask < Task
-
       # @!attribute [r] report
       #   The report to be generated
       attr_reader :report
@@ -26,12 +25,12 @@ module FeduxOrgStdlib
       #   FeduxOrgStdlib::Rake::ProjectTask.new
       #
       # @example Create new task using a different report file
-      #   FeduxOrgStdlib::Rake::ProjectTask.new( 
+      #   FeduxOrgStdlib::Rake::ProjectTask.new(
       #     report_file: File.join(Dir.getwd, 'reports', 'Index.html')
       #   )
       #
       # @example Create new task using a different project plan and adding additional files
-      #   FeduxOrgStdlib::Rake::ProjectTask.new( 
+      #   FeduxOrgStdlib::Rake::ProjectTask.new(
       #     plan_file: File.join(Dir.getwd, 'project1.tjp'),
       #     additional_files: %W{
       #     #{File.join(Dir.getwd, 'resources.tjp')}

data/lib/fedux_org_stdlib/rake/shell_task.rb

@@ -2,7 +2,7 @@
 require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/rake/task'
 require 'fedux_org_stdlib/require_files'
-require_library %w{ erubis }
+require_library %w(erubis)
 
 module FeduxOrgStdlib
   module Rake
@@ -19,7 +19,7 @@ module FeduxOrgStdlib
       attr_reader :use_bundler
 
       # Create a new shell task
-      # 
+      #
       # @param [String] command
       #   The command to be executed
       #
@@ -29,8 +29,8 @@ module FeduxOrgStdlib
       # @see Task
       #   For other arguments accepted
       def initialize(
-        command:, 
-        use_bundler: false, 
+        command:,
+        use_bundler: false,
         **args
       )
         super(**args)
@@ -40,14 +40,14 @@ module FeduxOrgStdlib
       end
 
       # @private
-      def run_task(verbose)
+      def run_task(_verbose)
         logger.warn 'Gemfile does not exist. Running bundler will fail. I am going to run the command without `bundle exec`.' unless gemfile_exists?
 
         cmd = []
-        cmd << 'bundle exec' if use_bundler and gemfile_exists?
+        cmd << 'bundle exec' if use_bundler && gemfile_exists?
         cmd << command
 
-        sh Erubis::Eruby.new(cmd.join(' ')).result(get_binding)
+        sh Erubis::Eruby.new(cmd.join(' ')).result(instance_binding)
       end
 
       private