chef-dk 0.9.0 → 0.10.0

data/lib/chef-dk/helpers.rb

@@ -1,159 +1,159 @@
-#
-# Copyright:: Copyright (c) 2014 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'mixlib/shellout'
-require 'chef-dk/exceptions'
-
-module ChefDK
-  module Helpers
-    extend self
-
-    #
-    # Runs given commands using mixlib-shellout
-    #
-    def system_command(*command_args)
-      cmd = Mixlib::ShellOut.new(*command_args)
-      cmd.run_command
-      cmd
-    end
-
-    def err(message)
-      stderr.print("#{message}\n")
-    end
-
-    def msg(message)
-      stdout.print("#{message}\n")
-    end
-
-    def stdout
-      $stdout
-    end
-
-    def stderr
-      $stderr
-    end
-
-    #
-    # Locates the omnibus directories
-    #
-
-    def omnibus_install?
-      File.exist?(omnibus_chefdk_location)
-    end
-
-    def omnibus_root
-      @omnibus_root ||= omnibus_expand_path(expected_omnibus_root)
-    end
-
-    def omnibus_apps_dir
-      @ominbus_apps_dir ||= omnibus_expand_path(omnibus_root, "embedded", "apps")
-    end
-
-    def omnibus_bin_dir
-      @omnibus_bin_dir ||= omnibus_expand_path(omnibus_root, "bin")
-    end
-
-    def omnibus_embedded_bin_dir
-      @omnibus_embedded_bin_dir ||= omnibus_expand_path(omnibus_root, "embedded", "bin")
-    end
-
-    def omnibus_chefdk_location
-      @omnibus_chefdk_location ||= File.expand_path('embedded/apps/chef-dk', expected_omnibus_root)
-    end
-
-    def chefdk_home
-      @chefdk_home ||= begin
-                         chefdk_home_set = !([nil, ''].include? ENV['CHEFDK_HOME'])
-                         if chefdk_home_set
-                           ENV['CHEFDK_HOME']
-                         else
-                           default_chefdk_home
-                         end
-                       end
-    end
-
-    # Returns the directory that contains our main symlinks.
-    # On Mac we place all of our symlinks under /usr/local/bin on other
-    # platforms they are under /usr/bin
-    def usr_bin_prefix
-      @usr_bin_prefix ||= os_x? ? "/usr/local/bin" : "/usr/bin"
-    end
-
-    # Returns the full path to the given command under usr_bin_prefix
-    def usr_bin_path(command)
-      File.join(usr_bin_prefix, command)
-    end
-
-    private
-
-    def omnibus_expand_path(*paths)
-      dir = File.expand_path(File.join(paths))
-      raise OmnibusInstallNotFound.new() unless ( dir and File.directory?(dir) )
-      dir
-    end
-
-    def expected_omnibus_root
-      File.expand_path(File.join(Gem.ruby, "..", "..", ".."))
-    end
-
-    def default_chefdk_home
-      if Chef::Platform.windows?
-        File.join(ENV['LOCALAPPDATA'], 'chefdk')
-      else
-        File.expand_path('~/.chefdk')
-      end
-    end
-
-    #
-    # environment vars for omnibus
-    #
-
-    def omnibus_env
-      @omnibus_env ||=
-        begin
-          user_bin_dir = File.expand_path(File.join(Gem.user_dir, 'bin'))
-          {
-            'PATH' => [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH'] ].join(File::PATH_SEPARATOR),
-            'GEM_ROOT' => Gem.default_dir,
-            'GEM_HOME' => Gem.user_dir,
-            'GEM_PATH' => Gem.path.join(File::PATH_SEPARATOR),
-          }
-        end
-    end
-
-    # Open a file. By default, the mode is for read+write,
-    # and binary so that windows writes out what we tell it,
-    # as this is the most common case we have.
-    def with_file(path, mode='wb+', &block)
-      File.open(path, mode, &block)
-    end
-
-    #@api private
-    # This method resets all the instance variables used. It
-    # should only be used for testing
-    def reset!
-      self.instance_variables.each do |ivar|
-        self.instance_variable_set(ivar, nil)
-      end
-    end
-
-    # Returns true if we are on Mac OS X. Otherwise false
-    def os_x?
-      !!(RUBY_PLATFORM =~ /darwin/)
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'mixlib/shellout'
+require 'chef-dk/exceptions'
+
+module ChefDK
+  module Helpers
+    extend self
+
+    #
+    # Runs given commands using mixlib-shellout
+    #
+    def system_command(*command_args)
+      cmd = Mixlib::ShellOut.new(*command_args)
+      cmd.run_command
+      cmd
+    end
+
+    def err(message)
+      stderr.print("#{message}\n")
+    end
+
+    def msg(message)
+      stdout.print("#{message}\n")
+    end
+
+    def stdout
+      $stdout
+    end
+
+    def stderr
+      $stderr
+    end
+
+    #
+    # Locates the omnibus directories
+    #
+
+    def omnibus_install?
+      File.exist?(omnibus_chefdk_location)
+    end
+
+    def omnibus_root
+      @omnibus_root ||= omnibus_expand_path(expected_omnibus_root)
+    end
+
+    def omnibus_apps_dir
+      @ominbus_apps_dir ||= omnibus_expand_path(omnibus_root, "embedded", "apps")
+    end
+
+    def omnibus_bin_dir
+      @omnibus_bin_dir ||= omnibus_expand_path(omnibus_root, "bin")
+    end
+
+    def omnibus_embedded_bin_dir
+      @omnibus_embedded_bin_dir ||= omnibus_expand_path(omnibus_root, "embedded", "bin")
+    end
+
+    def omnibus_chefdk_location
+      @omnibus_chefdk_location ||= File.expand_path('embedded/apps/chef-dk', expected_omnibus_root)
+    end
+
+    def chefdk_home
+      @chefdk_home ||= begin
+                         chefdk_home_set = !([nil, ''].include? ENV['CHEFDK_HOME'])
+                         if chefdk_home_set
+                           ENV['CHEFDK_HOME']
+                         else
+                           default_chefdk_home
+                         end
+                       end
+    end
+
+    # Returns the directory that contains our main symlinks.
+    # On Mac we place all of our symlinks under /usr/local/bin on other
+    # platforms they are under /usr/bin
+    def usr_bin_prefix
+      @usr_bin_prefix ||= os_x? ? "/usr/local/bin" : "/usr/bin"
+    end
+
+    # Returns the full path to the given command under usr_bin_prefix
+    def usr_bin_path(command)
+      File.join(usr_bin_prefix, command)
+    end
+
+    private
+
+    def omnibus_expand_path(*paths)
+      dir = File.expand_path(File.join(paths))
+      raise OmnibusInstallNotFound.new() unless ( dir and File.directory?(dir) )
+      dir
+    end
+
+    def expected_omnibus_root
+      File.expand_path(File.join(Gem.ruby, "..", "..", ".."))
+    end
+
+    def default_chefdk_home
+      if Chef::Platform.windows?
+        File.join(ENV['LOCALAPPDATA'], 'chefdk')
+      else
+        File.expand_path('~/.chefdk')
+      end
+    end
+
+    #
+    # environment vars for omnibus
+    #
+
+    def omnibus_env
+      @omnibus_env ||=
+        begin
+          user_bin_dir = File.expand_path(File.join(Gem.user_dir, 'bin'))
+          {
+            'PATH' => [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH'] ].join(File::PATH_SEPARATOR),
+            'GEM_ROOT' => Gem.default_dir,
+            'GEM_HOME' => Gem.user_dir,
+            'GEM_PATH' => Gem.path.join(File::PATH_SEPARATOR),
+          }
+        end
+    end
+
+    # Open a file. By default, the mode is for read+write,
+    # and binary so that windows writes out what we tell it,
+    # as this is the most common case we have.
+    def with_file(path, mode='wb+', &block)
+      File.open(path, mode, &block)
+    end
+
+    #@api private
+    # This method resets all the instance variables used. It
+    # should only be used for testing
+    def reset!
+      self.instance_variables.each do |ivar|
+        self.instance_variable_set(ivar, nil)
+      end
+    end
+
+    # Returns true if we are on Mac OS X. Otherwise false
+    def os_x?
+      !!(RUBY_PLATFORM =~ /darwin/)
+    end
+  end
+end

data/lib/chef-dk/pager.rb

@@ -1,106 +1,106 @@
-#
-# Copyright:: Copyright (c) 2015 Chef Software Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-
-require 'chef-dk/ui'
-
-module ChefDK
-  class Pager
-
-    attr_reader :pager_pid
-
-    def initialize(enable_pager: true)
-      @enable_pager = enable_pager
-      @pipe = nil
-      @pager_pid
-    end
-
-    def pager_enabled?
-      !!(@enable_pager && have_tty? && env["PAGER"])
-    end
-
-    def ui
-      @ui ||=
-        if pager_enabled?
-          UI.new(out: parent_stdout)
-        else
-          UI.new
-        end
-    end
-
-    def with_pager
-      start
-      begin
-        yield self
-      ensure
-        wait
-      end
-    end
-
-    def start
-      return false unless pager_enabled?
-
-      # Ignore CTRL-C because it can cause the parent to die before the
-      # pager which causes wonky behavior in the terminal
-      Kernel.trap(:INT, "IGNORE")
-
-      @pager_pid = Process.spawn(pager_env, env["PAGER"], in: child_stdin)
-
-      child_stdin.close
-    end
-
-    def wait
-      return false unless pager_enabled?
-
-      # Sends EOF to the PAGER
-      parent_stdout.close
-      # wait or else we'd kill the pager when we exit
-      Process.waitpid(pager_pid)
-    end
-
-    # @api private
-    # This is just public so we can stub it for testing
-    def env
-      ENV
-    end
-
-    # @api private
-    # This is just public so we can stub it for testing
-    def have_tty?
-      $stdout.tty?
-    end
-
-    private
-
-    def child_stdin
-      pipe[0]
-    end
-
-    def parent_stdout
-      pipe[1]
-    end
-
-    def pipe
-      @pipe ||= IO.pipe
-    end
-
-    def pager_env
-      {"LESS" => "-FRX", "LV" => "-c"}
-    end
-
-  end
-end
-
+#
+# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef-dk/ui'
+
+module ChefDK
+  class Pager
+
+    attr_reader :pager_pid
+
+    def initialize(enable_pager: true)
+      @enable_pager = enable_pager
+      @pipe = nil
+      @pager_pid
+    end
+
+    def pager_enabled?
+      !!(@enable_pager && have_tty? && env["PAGER"])
+    end
+
+    def ui
+      @ui ||=
+        if pager_enabled?
+          UI.new(out: parent_stdout)
+        else
+          UI.new
+        end
+    end
+
+    def with_pager
+      start
+      begin
+        yield self
+      ensure
+        wait
+      end
+    end
+
+    def start
+      return false unless pager_enabled?
+
+      # Ignore CTRL-C because it can cause the parent to die before the
+      # pager which causes wonky behavior in the terminal
+      Kernel.trap(:INT, "IGNORE")
+
+      @pager_pid = Process.spawn(pager_env, env["PAGER"], in: child_stdin)
+
+      child_stdin.close
+    end
+
+    def wait
+      return false unless pager_enabled?
+
+      # Sends EOF to the PAGER
+      parent_stdout.close
+      # wait or else we'd kill the pager when we exit
+      Process.waitpid(pager_pid)
+    end
+
+    # @api private
+    # This is just public so we can stub it for testing
+    def env
+      ENV
+    end
+
+    # @api private
+    # This is just public so we can stub it for testing
+    def have_tty?
+      $stdout.tty?
+    end
+
+    private
+
+    def child_stdin
+      pipe[0]
+    end
+
+    def parent_stdout
+      pipe[1]
+    end
+
+    def pipe
+      @pipe ||= IO.pipe
+    end
+
+    def pager_env
+      {"LESS" => "-FRX", "LV" => "-c"}
+    end
+
+  end
+end
+