fedux_org-stdlib 0.9.8 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00f1ef63f383a5360c23e10f1a7b4280e7778a59
-  data.tar.gz: 8a6a0e335c55e1dfbbb40328a463d81656dedbd4
+  metadata.gz: 142074fe00300790fa28656899176829d9e6e60b
+  data.tar.gz: 9052f89fe52d1d5226a6ebcad78e37513dcb8858
 SHA512:
-  metadata.gz: ce299f4960290869a15f033ebc848cda1cffa27aa82756ac5b241af246fe7beef19744926495704578d11f28701c32b6ccecca41d128fa136939a89ce6db2974
-  data.tar.gz: d08adb8405bc1b56604d66b0a61af57b1346f9ef57be64203339241c40f9eac05664f8428424d7dff3adb2a61daa06caee7cbc9a62dc95c6d693eba1b50c69e7
+  metadata.gz: 9df9eae8d9e2e5cb8f07ef3cec90f98618e70aea181116099c265a4d290c526b856f26c89719a783908093fbf804d53aad98b301e567f9bb5d3cb5c335719909
+  data.tar.gz: 60bdbdcef44d8c1fdad4792021ba98b1b2eb445d6d6b69bbef6a53427508894d7c41348243936b924262a294305aab47e8c6e5071ed7365dd6ca1d46c4e79308

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fedux_org-stdlib (0.9.7)
+    fedux_org-stdlib (0.10.0)
       activesupport
 
 PATH

data/config/rubocop/exclude.yml

@@ -1,6 +1,7 @@
 AllCops:
   Exclude:
-    -  spec/examples/**/*.rb
+    - spec/examples/**/*.rb
+    - fixtures/**/*.rb
 
 # Offense count: 230
 # Configuration parameters: AllowURI.

data/lib/fedux_org_stdlib/app_config.rb

@@ -270,7 +270,7 @@ module FeduxOrgStdlib
 
     # Return configuration resetted to defaults
     def defaults
-      config = self.dup
+      config = dup
       config.clear
 
       config
@@ -280,8 +280,8 @@ module FeduxOrgStdlib
       options_to_check = known_options.delete_if { |o| !keys.blank? && !keys.map(&:to_sym).include?(o) }.sort
 
       options_to_check.each_with_object({}) do |e, a|
-        next if remove_blank && self.public_send(e).blank?
-        a[e] = self.public_send(e)
+        next if remove_blank && public_send(e).blank?
+        a[e] = public_send(e)
       end
     end
 
@@ -303,7 +303,6 @@ module FeduxOrgStdlib
         return
       end
 
-
       files = if merge_files
                 self.files
               else
@@ -427,10 +426,10 @@ module FeduxOrgStdlib
       (methods | instance_methods | private_methods | private_instance_methods) - (Class.methods | Class.private_methods) | [:to_s]
     end
 
-    #def method_missing(*args, &block)
+    # def method_missing(*args, &block)
     #  $stderr.puts "Please check if you have defined an option for #{args.first}."
 
     #  super
-    #end
+    # end
   end
 end

data/lib/fedux_org_stdlib/command_finder.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/core_ext/file/which'
+
+module FeduxOrgStdlib
+  class CommandFinder
+    private
+
+    attr_reader :search_paths, :alternatives
+
+    public
+
+    # Finds path to command
+    #
+    # It also considers other executables for one command
+    #
+    # @param [String, Array] alternatives
+    #   The executables to be used
+    #
+    # @param [String, Array] search_paths
+    #   The search path as multiple paths as array or string where single
+    #   search paths are concatenated via ':'
+    def initialize(alternatives:, search_paths:)
+      @alternatives = Array(alternatives)
+      @search_paths = Array(search_paths)
+    end
+
+    # Find path to command
+    def path
+      alternatives.each do |e|
+        next unless path = File.which(e, search_paths.join(':'))
+
+        return path
+      end
+
+      nil
+    end
+
+    # Return known commands
+    def known_commands
+      @alternatives
+    end
+  end
+end

data/lib/fedux_org_stdlib/core_ext/file/which.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+require 'rbconfig'
+require 'win32/file' if File::ALT_SEPARATOR
+
+require 'fedux_org_stdlib/require_files'
+require_library %w(active_support/core_ext/object/blank)
+
+# File class
+class File
+  if File::ALT_SEPARATOR
+    MSWINDOWS = true
+    if ENV['PATHEXT']
+      WIN32EXTS = ('.{' + ENV['PATHEXT'].tr(';', ',').tr('.', '') + '}').downcase
+    else
+      WIN32EXTS = '.{exe,com,bat}'
+    end
+  else
+    MSWINDOWS = false
+  end
+
+  class << self
+    # Search program in search path
+    #
+    # @param [String] program
+    #   The program to look for
+    #
+    # @param [String] path
+    #   The search path
+    #
+    # @return [String, NilClass]
+    #   If the program could be found in search path, the full path will be
+    #   returned otherwise `#which` returns nil.
+    def which(program, path = ENV['PATH'])
+      fail ArgumentError, path if path.blank?
+
+      return nil if program.blank?
+
+      # Bail out early if an absolute path is provided.
+      if program =~ %r{^/|^[a-z]:[/]}i
+        program += WIN32EXTS if MSWINDOWS && File.extname(program).blank?
+        found = Dir[program].first
+        if found && File.executable?(found) && !File.directory?(found)
+          return found
+        else
+          return nil
+        end
+      end
+
+      # Iterate over each path glob the dir + program.
+      path.split(File::PATH_SEPARATOR).each do |dir|
+        dir = File.expand_path(dir)
+
+        next unless File.exist?(dir) # In case of bogus second argument
+        file = File.join(dir, program)
+
+        # Dir[] doesn't handle backslashes properly, so convert them. Also, if
+        # the program name doesn't have an extension, try them all.
+        if MSWINDOWS
+          file = file.tr('\\', '/')
+          file += WIN32EXTS if File.extname(program).blank?
+        end
+
+        found = Dir[file].first
+
+        next if !found || !File.executable?(found) || File.directory?(found)
+
+        # Convert all forward slashes to backslashes if supported
+        found.tr!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+
+        return found
+      end
+
+      nil
+    end
+  end
+end

data/lib/fedux_org_stdlib/editor.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+require 'fedux_org_stdlib/command_finder'
+
+module FeduxOrgStdlib
+  # Look for editor in PATH
+  #
+  # @example Usage
+  #
+  #   editor = Editor.new
+  #   editor.path #=> /usr/bin/vim if vim exists at /usr/bin
+  class Editor < CommandFinder
+    def initialize(editors: %w(vim vi emacs nano), search_paths: ENV['PATH'].split(/:/))
+      super alternatives: editors, search_paths: search_paths
+    end
+  end
+end

data/lib/fedux_org_stdlib/recursive_file_finder.rb

@@ -5,6 +5,7 @@ require 'fedux_org_stdlib/logging/logger'
 require_library %w(pathname)
 
 module FeduxOrgStdlib
+  # Look for file recursively
   class RecursiveFileFinder
     # Create a new instance of finder
     #

data/lib/fedux_org_stdlib/version.rb

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

data/spec/app_config_spec.rb

@@ -545,14 +545,9 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option :opt1, 'test1'
 
-        option :opt2, [
-          'test2',
-          'test2',
-        ]
+        option :opt2, %w(test2 test2)
 
-        option :opt3, {
-          test3: 'value3'
-        }
+        option :opt3, test3: 'value3'
 
         def _class_name
           'TestConfig'
@@ -567,10 +562,10 @@ RSpec.describe AppConfig do
       expect(config.to_h).to eq(
         opt1: 'test1',
         opt2: %w(
-        test2
-        test2
+          test2
+          test2
         ),
-          opt3: {
+        opt3: {
           test3: 'value3'
         }
       )
@@ -580,14 +575,9 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option :opt1, 'test1'
 
-        option :opt2, [
-          'test2',
-          'test2',
-        ]
+        option :opt2, %w(test2 test2)
 
-        option :opt3, {
-          test3: 'value3'
-        }
+        option :opt3, test3: 'value3'
 
         def _class_name
           'TestConfig'
@@ -608,14 +598,9 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option :opt1, 'test1'
 
-        option :opt2, [
-          'test2',
-          'test2',
-        ]
+        option :opt2, %w(test2 test2)
 
-        option :opt3, {
-          test3: 'value3'
-        }
+        option :opt3, test3: 'value3'
 
         def _class_name
           'TestConfig'
@@ -660,14 +645,9 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option :opt1, 'test1'
 
-        option :opt2, [
-          'test2',
-          'test2',
-        ]
+        option :opt2, %w(test2 test2)
 
-        option :opt3, {
-          test3: 'value3'
-        }
+        option :opt3, test3: 'value3'
 
         def _class_name
           'TestConfig'
@@ -694,14 +674,9 @@ RSpec.describe AppConfig do
       config_klass = Class.new(AppConfig) do
         option :opt1, 'test1'
 
-        option :opt2, [
-          'test2',
-          'test2',
-        ]
+        option :opt2, %w(test2 test2)
 
-        option :opt3, {
-          test3: 'value3'
-        }
+        option :opt3, test3: 'value3'
 
         def _class_name
           'TestConfig'

data/spec/command_finder_spec.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/command_finder'
+
+RSpec.describe FeduxOrgStdlib::CommandFinder do
+  context '#path' do
+    it 'finds command in given order' do
+      touch_file 'command.sh'
+      filesystem_permissions '0755', 'command.sh'
+
+      editor = CommandFinder.new alternatives: %w(command.sh), search_paths: absolute_path('.')
+      expect(editor.path).to eq absolute_path('command.sh')
+    end
+
+    it 'returns nil if no command can be found' do
+      editor = CommandFinder.new alternatives: %w(command.sh), search_paths: absolute_path('.')
+      expect(editor.path).to be nil
+    end
+  end
+end

data/spec/core_ext/file/which.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'fedux_org_stdlib/core_ext/file/which'
+
+RSpec.describe 'File' do
+  around :example do |example|
+    with_env 'PATH' => absolute_path('.') do
+      example.run
+    end
+  end
+
+  context '#which' do
+    it 'returns path to command' do
+      touch_file 'vim'
+      filesystem_permissions '0755', 'vim'
+
+      expect(File.which('vim')).to eq absolute_path('vim')
+    end
+
+    it 'uses a different search path' do
+      touch_file 'vim'
+      filesystem_permissions '0755', 'vim'
+      expect(File.which('vim', absolute_path('.'))).to eq absolute_path('vim')
+    end
+
+    it 'returns nil if command could not be found' do
+      expect(File.which('vim')).to be nil
+    end
+
+    it 'returns nil if command is not executable' do
+      touch_file 'vim'
+      filesystem_permissions '0644', 'vim'
+      expect(File.which('vim')).to be nil
+    end
+
+    it 'returns nil if command is not a file' do
+      create_dir 'vim'
+      expect(File.which('vim')).to be nil
+    end
+
+    it 'supports ~' do
+      with_env 'HOME' => absolute_path('.') do
+        touch_file 'vim'
+        filesystem_permissions '0755', 'vim'
+        expect(File.which('vim', '~/')).to eq absolute_path('vim')
+      end
+    end
+
+    it 'returns nil if command path is blank' do
+      expect(File.which('')).to eq nil
+      expect(File.which(nil)).to eq nil
+      expect(File.which([])).to eq nil
+    end
+
+    it 'fails if search path is blank' do
+      expect { File.which('vim', '') }.to raise_error ArgumentError
+      expect { File.which('vim', nil) }.to raise_error ArgumentError
+      expect { File.which('vim', []) }.to raise_error ArgumentError
+    end
+  end
+end

data/spec/editor_spec.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'fedux_org_stdlib/editor'
+
+RSpec.describe FeduxOrgStdlib::Editor do
+  around :example do |example|
+    with_env 'PATH' => absolute_path('.') do
+      example.run
+    end
+  end
+
+  context '#path' do
+    let(:editor) { Editor.new }
+
+    Editor.new.known_commands.each do |c|
+      it "finds editor #{c}" do
+        touch_file c
+        filesystem_permissions '0755', c
+        expect(editor.path).to eq absolute_path(c)
+      end
+    end
+
+    it 'changes search path' do
+      touch_file 'vim'
+      filesystem_permissions '0755', 'vim'
+
+      editor = Editor.new search_paths: absolute_path('.')
+      expect(editor.path).to eq absolute_path('vim')
+    end
+
+    it 'changes default editors' do
+      touch_file 'vi'
+      filesystem_permissions '0755', 'vi'
+
+      editor = Editor.new editors: %w(vi)
+      expect(editor.path).to eq absolute_path('vi')
+    end
+
+    it 'returns nil if no editor can be found' do
+      editor = Editor.new
+      expect(editor.path).to be nil
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fedux_org-stdlib
 version: !ruby/object:Gem::Version
-  version: 0.9.8
+  version: 0.10.0
 platform: ruby
 authors:
 - Max Meyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-04 00:00:00.000000000 Z
+date: 2014-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,8 +62,10 @@ files:
 - lib/fedux_org_stdlib/command/command_result.rb
 - lib/fedux_org_stdlib/command/run_command.rb
 - lib/fedux_org_stdlib/command/which.rb
+- lib/fedux_org_stdlib/command_finder.rb
 - lib/fedux_org_stdlib/core_ext/array.rb
 - lib/fedux_org_stdlib/core_ext/array/list.rb
+- lib/fedux_org_stdlib/core_ext/file/which.rb
 - lib/fedux_org_stdlib/core_ext/hash.rb
 - lib/fedux_org_stdlib/core_ext/hash/list.rb
 - lib/fedux_org_stdlib/core_ext/hash/options.rb
@@ -73,6 +75,7 @@ files:
 - lib/fedux_org_stdlib/core_ext/string/underline.rb
 - lib/fedux_org_stdlib/directory_finder.rb
 - lib/fedux_org_stdlib/directory_finder/exceptions.rb
+- lib/fedux_org_stdlib/editor.rb
 - lib/fedux_org_stdlib/environment.rb
 - lib/fedux_org_stdlib/file_finder.rb
 - lib/fedux_org_stdlib/file_finder/exceptions.rb
@@ -172,12 +175,15 @@ files:
 - spec/colors/html_color_spec.rb
 - spec/command/run_command_spec.rb
 - spec/command/which_spec.rb
+- spec/command_finder_spec.rb
 - spec/core_ext/array/list_spec.rb
+- spec/core_ext/file/which.rb
 - spec/core_ext/hash/list_spec.rb
 - spec/core_ext/hash/options_spec.rb
 - spec/core_ext/shellwords/clean_spec.rb
 - spec/core_ext/string/underline_spec.rb
 - spec/directory_finder_spec.rb
+- spec/editor_spec.rb
 - spec/environment_spec.rb
 - spec/examples/models/class_based/forbidden_keyword.rb
 - spec/examples/models/class_based/ignore/ignored.rb
@@ -245,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Collection of useful libraries. It maybe depend on external libraries.
@@ -254,12 +260,15 @@ test_files:
 - spec/colors/html_color_spec.rb
 - spec/command/run_command_spec.rb
 - spec/command/which_spec.rb
+- spec/command_finder_spec.rb
 - spec/core_ext/array/list_spec.rb
+- spec/core_ext/file/which.rb
 - spec/core_ext/hash/list_spec.rb
 - spec/core_ext/hash/options_spec.rb
 - spec/core_ext/shellwords/clean_spec.rb
 - spec/core_ext/string/underline_spec.rb
 - spec/directory_finder_spec.rb
+- spec/editor_spec.rb
 - spec/environment_spec.rb
 - spec/examples/models/class_based/forbidden_keyword.rb
 - spec/examples/models/class_based/ignore/ignored.rb