fedux_org-stdlib 0.7.21 → 0.7.22

data/lib/fedux_org_stdlib/template_directory.rb

@@ -3,7 +3,7 @@ require 'fedux_org_stdlib/require_files'
 require 'fedux_org_stdlib/template_directory/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 "ClientTemplateDirectory" becomes "clients.d"
   #
   # 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:
@@ -47,7 +47,6 @@ module FeduxOrgStdlib
   #     end
   #   end
   class TemplateDirectory
-
     attr_reader :working_directory, :logger, :directory, :template_files
 
     # Create a new instance of template
@@ -64,24 +63,23 @@ 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(
       directory: nil,
       logger: FeduxOrgStdlib::Logging::Logger.new,
-      working_directory: Dir.getwd,
-      output_directory: nil
+      working_directory: Dir.getwd
     )
       @logger            = logger
       @working_directory = working_directory
 
-      @directory ||= available_template_directory
-        
+      @directory ||= (directory || available_template_directory)
+
       fail Exceptions::NoTemplateDirectoryFound, "No template directory found at #{allowed_template_directory_paths.to_list}, therefor I'm stop working as there are methods which depend on an available template directory path." unless @directory
 
       begin
         @template_files = Dir.glob(File.join(@directory, '**', '*')).keep_if { |o| FileTest.file? o }
       rescue StandardError => e
-        fail Exceptions::TemplateDirectoryNotReadable, JSON.dump(message: e.message, file: @directory)
+        raise Exceptions::TemplateDirectoryNotReadable, JSON.dump(message: e.message, file: @directory)
       end
     end
 
@@ -169,7 +167,6 @@ module FeduxOrgStdlib
       ::File.expand_path(::File.join(*path))
     end
 
-
     # Use this path as fall back path
     def fallback_template_directory; end
 
@@ -191,7 +188,7 @@ module FeduxOrgStdlib
     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
   end
 end

data/lib/fedux_org_stdlib/version.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
 # FeduxOrgStdlib
 module FeduxOrgStdlib
-  VERSION = '0.7.21'
+  VERSION = '0.7.22'
 end

data/lib/fedux_org_stdlib/version_management/library_builder.rb

@@ -3,9 +3,10 @@ require 'fedux_org_stdlib/version_management/ruby_library'
 
 module FeduxOrgStdlib
   module VersionManagement
+    # Build library object
     class LibraryBuilder
-      def build_from( *args )
-        RubyLibrary.new( *args )
+      def build_from(*args)
+        RubyLibrary.new(*args)
       end
     end
   end

data/lib/fedux_org_stdlib/version_management/ruby_library.rb

@@ -1,11 +1,11 @@
 # encoding: utf-8
 module FeduxOrgStdlib
   module VersionManagement
+    # A ruby library
     class RubyLibrary
-
       attr_reader :module_names
 
-      def initialize( module_names )
+      def initialize(module_names)
         @module_names = module_names
       end
     end

data/lib/fedux_org_stdlib/version_management/rubygem_version_file.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ erubis forwardable active_support/core_ext/string/strip active_support/core_ext/object/blank }
+require_library %w(erubis forwardable active_support/core_ext/string/strip active_support/core_ext/object/blank)
 
 require 'fedux_org_stdlib/version_management/rubygem_version_file_parser'
 require 'fedux_org_stdlib/version_management/version_builder'
@@ -9,6 +9,7 @@ require 'fedux_org_stdlib/version_management/exceptions'
 
 module FeduxOrgStdlib
   module VersionManagement
+    # Ruby version file
     class RubygemVersionFile
       extend Forwardable
 
@@ -41,7 +42,7 @@ module FeduxOrgStdlib
       end
 
       def to_s
-        klass = Class.new do 
+        klass = Class.new do
           attr_reader :version, :library
 
           def initialize(version, module_names)
@@ -72,7 +73,6 @@ module FeduxOrgStdlib
             <% end -%>
         EOF
       end
-
     end
   end
 end

data/lib/fedux_org_stdlib/version_management/rubygem_version_file_parser.rb

@@ -3,20 +3,20 @@ require 'json'
 require 'fedux_org_stdlib/version_management/exceptions'
 
 module FeduxOrgStdlib
+  # Version management
   module VersionManagement
+    # Ruby version file parser
     class RubygemVersionFileParser
-
       attr_reader :version, :modules
 
       def parse(file)
         data = File.read(file)
 
-        @version = data.match(/(?:VERSION|Version)\s+=\s+["']([^'"]+)["']/) { $1 }
-        @modules = data.scan( /^\s*module\s+([A-Z][A-Za-z0-9]+(?:::[A-Z][A-Z0-9a-z]+)*)$/x ).flatten
+        @version = data.match(/(?:VERSION|Version)\s+=\s+["']([^'"]+)["']/) { Regexp.last_match[1] }
+        @modules = data.scan(/^\s*module\s+([A-Z][A-Za-z0-9]+(?:::[A-Z][A-Z0-9a-z]+)*)$/x).flatten
 
-        raise Exceptions::VersionFileInvalid, JSON.dump(file: file) if self.version.blank?
+        fail Exceptions::VersionFileInvalid, JSON.dump(file: file) if version.blank?
       end
-
     end
   end
 end

data/lib/fedux_org_stdlib/version_management/software_version.rb

@@ -1,9 +1,10 @@
 # encoding: utf-8
 require 'fedux_org_stdlib/require_files'
-require_library %w{ versionomy forwardable }
+require_library %w(versionomy forwardable)
 
 module FeduxOrgStdlib
   module VersionManagement
+    # Software version
     class SoftwareVersion
       extend Forwardable
 
@@ -13,8 +14,8 @@ module FeduxOrgStdlib
         @version = Versionomy.parse(version)
       end
 
-      def update( *args )
-        initialize( *args )
+      def update(*args)
+        initialize(*args)
       end
 
       def bump(type)

data/lib/fedux_org_stdlib/version_management/version_builder.rb

@@ -3,6 +3,7 @@ require 'fedux_org_stdlib/version_management/software_version'
 
 module FeduxOrgStdlib
   module VersionManagement
+    # Build version
     class VersionBuilder
       def build_from(*args)
         SoftwareVersion.new(*args)

data/rakefiles/default.rake

@@ -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/script/terminal

@@ -4,10 +4,10 @@
 require 'tmrb'
 
 tmux = TmRb::Multiplexer.new
-#creates an empty window
-tmux.new_session(:session_name => "fedux_org-stdlib")
+# creates an empty window
+tmux.new_session(session_name: 'fedux_org-stdlib')
 
-tmux.new_window(:name => 'models', :command => 'vim -c  \"NERDTree lib/fedux_org_stdlib/models\"')
-tmux.new_window(:name => 'logging', :command => 'vim -c  \"NERDTree lib/fedux_org_stdlib/logging\"')
-tmux.new_window(:name => 'spec', :command => 'vim -c \"NERDTree spec\"')
+tmux.new_window(name: 'models', command: 'vim -c  \"NERDTree lib/fedux_org_stdlib/models\"')
+tmux.new_window(name: 'logging', command: 'vim -c  \"NERDTree lib/fedux_org_stdlib/logging\"')
+tmux.new_window(name: 'spec', command: 'vim -c \"NERDTree spec\"')
 tmux.start

data/spec/app_config_spec.rb

@@ -45,9 +45,9 @@ RSpec.describe AppConfig do
         expect(config.opt1).to be_nil
 
         silence :stderr do
-          expect {
+          expect do
             config.opt1 = 'blub'
-          }.to raise_error NoMethodError
+          end.to raise_error NoMethodError
         end
       end
     end
@@ -329,10 +329,10 @@ RSpec.describe AppConfig do
         end
 
         result = capture :stderr do
-          config_klass.new 
+          config_klass.new
         end
 
-        expect(result).to include "There seems"
+        expect(result).to include 'There seems'
       end
     end
   end
@@ -343,7 +343,7 @@ RSpec.describe AppConfig do
         config_klass = Class.new(AppConfig) do
           option :opt1, 'test1'
           option :opt2, 'test2'
-          option :opt3, { opt1: 'test1', opt2: 'test2' }
+          option :opt3, opt1: 'test1', opt2: 'test2'
 
           def _class_name
             'TestConfig'
@@ -401,7 +401,7 @@ RSpec.describe AppConfig do
         config_klass = Class.new(AppConfig) do
           option :opt1, 'test1'
           option :opt2, 'test2'
-          option :opt3, { opt1: 'test1', opt2: 'test2' }
+          option :opt3, opt1: 'test1', opt2: 'test2'
 
           def _class_name
             'TestConfig'

data/spec/colors/html_color_spec.rb

@@ -20,6 +20,6 @@ RSpec.describe FeduxOrgStdlib::Colors::HtmlColor do
     it 'fails if no hex number is given' do
       expect(FeduxOrgStdlib::Colors::HtmlColor.new('#ZZAAZZ')).not_to be_valid
     end
-    
+
   end
 end

data/spec/core_ext/array/list_spec.rb

@@ -5,49 +5,49 @@ require 'fedux_org_stdlib/core_ext/array/list'
 RSpec.describe Array do
   context '#to_list' do
     it 'handles single value' do
-      input = %w{ test }
+      input = %w(test)
 
       expect(input.to_list).to eq '"test"'
     end
 
     it 'handles two values' do
-      input = %w{ test1 test2 }
+      input = %w(test1 test2)
 
       expect(input.to_list).to eq '"test1", "test2"'
     end
 
     it 'converts array to a list of values' do
-      input = %w{ test1 test2 test3 }
+      input = %w(test1 test2 test3)
 
       expect(input.to_list).to eq '"test1", "test2", "test3"'
     end
 
     it 'converts array to a list of values' do
-      input = %w{ test1 test2 test3 test4 }
+      input = %w(test1 test2 test3 test4)
 
       expect(input.to_list).to eq '"test1", "test2", "test3", "test4"'
     end
 
     it 'supports to change the last separator' do
-      input = %w{ test1 test2 test3}
+      input = %w(test1 test2 test3)
 
       expect(input.to_list(last_separator: ' or ')).to eq '"test1", "test2" or "test3"'
     end
 
     it 'supports to change the separator' do
-      input = %w{ test1 test2 test3}
+      input = %w(test1 test2 test3)
 
       expect(input.to_list(separator: ':')).to eq '"test1":"test2":"test3"'
     end
 
     it 'change multiple things' do
-      input = %w{ test1 test2 test3}
+      input = %w(test1 test2 test3)
 
       expect(input.to_list(around: '', separator: ':')).to eq 'test1:test2:test3'
     end
 
     it 'supports to change the string to surround items' do
-      input = %w{ test1 test2 test3}
+      input = %w(test1 test2 test3)
 
       expect(input.to_list(around: '$')).to eq '$test1$, $test2$, $test3$'
     end

data/spec/core_ext/hash/options_spec.rb

@@ -4,69 +4,69 @@ require 'fedux_org_stdlib/core_ext/hash/options'
 
 RSpec.describe '#to_options' do
   it 'converts hash to array of command line options' do
-    hash = { }
+    hash = {}
 
     expect(hash.to_options).to be_kind_of Array
   end
 
   it 'converts true value' do
-    hash = { 
+    hash = {
       opt1: true
     }
 
-    expect(hash.to_options).to eq %w{ --opt1 }
+    expect(hash.to_options).to eq %w(--opt1)
   end
 
   it 'converts false value' do
-    hash = { 
+    hash = {
       opt1: false
     }
 
-    expect(hash.to_options).to eq %w{ --no-opt1 }
+    expect(hash.to_options).to eq %w(--no-opt1)
   end
 
   it 'converts integervalue' do
-    hash = { 
+    hash = {
       opt1: 1
     }
 
-    expect(hash.to_options).to eq %w{ --opt1 1 }
+    expect(hash.to_options).to eq %w(--opt1 1)
   end
 
   it 'converts string value' do
-    hash = { 
+    hash = {
       opt1: 'string'
     }
 
-    expect(hash.to_options).to eq %w{ --opt1 string }
+    expect(hash.to_options).to eq %w(--opt1 string)
   end
 
   it 'converts symbol value' do
-    hash = { 
+    hash = {
       opt1: :string
     }
 
-    expect(hash.to_options).to eq %w{ --opt1 string }
+    expect(hash.to_options).to eq %w(--opt1 string)
   end
 
   it 'handles umlauts as well' do
-    hash = { 
-      "öäopt1" => 'string'
+    hash = {
+      'öäopt1' => 'string'
     }
 
-    expect(hash.to_options).to eq %w{ --opt1 string }
+    expect(hash.to_options).to eq %w(--opt1 string)
   end
 
   it 'handles special characters as well' do
-    hash = { 
+    hash = {
       "$o p\tt1" => 'string'
     }
 
-    expect(hash.to_options).to eq %w{ --opt1 string }
+    expect(hash.to_options).to eq %w(--opt1 string)
   end
 
   it 'handles special characters in value as well' do
-    hash = { 
+    hash = {
       opt1: 'string$string string'
     }
 

data/spec/core_ext/shellwords/clean_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe '.shellclean' do
   end
 
   it 'removes $' do
-    result = Shellwords.clean("asdf$asdf")
+    result = Shellwords.clean('asdf$asdf')
 
     expect(result).to eq 'asdfasdf'
   end

data/spec/environment_spec.rb

@@ -5,7 +5,7 @@ RSpec.describe FeduxOrgStdlib::Environment do
   context '#isolated_environment' do
     it 'runs command in isolated environment' do
       klass = Class.new do
-        include FeduxOrgStdlib::Environment 
+        include FeduxOrgStdlib::Environment
 
         def test_env
           isolated_environment 'TEST_VAR' => 'this is a test' do
@@ -19,12 +19,12 @@ RSpec.describe FeduxOrgStdlib::Environment do
 
     it 'let you define an environment before running a command' do
       klass = Class.new do
-        include FeduxOrgStdlib::Environment 
+        include FeduxOrgStdlib::Environment
 
         def test_env
           isolated_environment({}, { clear: true }) do
 
-            #are set by the terminal and can hardly be cleared
+            # are set by the terminal and can hardly be cleared
             ENV.delete('COLUMNS')
             ENV.delete('LINES')
 
@@ -38,17 +38,19 @@ RSpec.describe FeduxOrgStdlib::Environment do
 
     it 'restores environment although an exception occured' do
       klass = Class.new do
-        include FeduxOrgStdlib::Environment 
+        include FeduxOrgStdlib::Environment
 
         def test_env
           ENV['TEST_VAR'] = 'TEST'
 
+          # rubocop:disable Lint/HandleExceptions
           begin
             isolated_environment({}, { clear: true }) do
-              raise
+              fail
             end
           rescue
           end
+          # rubocop:enable Lint/HandleExceptions
 
           ENV['TEST_VAR']
         end