pause_output 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4bf4d23cd1bc4ad32ab0bf9ef6b16c55854a3ad
-  data.tar.gz: 4a48dc6a1dd7c55f3e26452ec97d6b4b8044eed0
+  metadata.gz: f07a728fb17d8650be3191bc00a3dda19e48d9db
+  data.tar.gz: 2480a692ce205401748633a48b820ec5300e8494
 SHA512:
-  metadata.gz: dfb1628b3399782cda367aa30b0c050e80f1b07b3769a21b0ef6834d0d652cdf2a1f8ce3945d49b66e2c6e984b7917e67981fa457a44b5862396a8dfe8e2d030
-  data.tar.gz: 7a567d20923d3716f12baf13f13dfb37d2a1db6337689b0bfa65ef5e02315a52e07e71198a656c3f1c5e9313821d38222d1a6d48148c81c1003f8e02e20220dc
+  metadata.gz: 94d81e38f5bf8938d7094081b503d760b2b5964bd1397dec9f9759108671ceeda5503d9f1c5832da6f718a1658b13a32fb39f810a6c4efc019f21812b3d2d255
+  data.tar.gz: d234de7852054060c8529a1d001434aa2df161a4f0cc0e25c0cb9739111c1d31d9647c88b862a20c04dd6c4ad4bde1c4592404814228bf251cd39fcca077c9b7

data/README.md

@@ -50,14 +50,19 @@ Option      | Values  | Default       | Description
 :page_pause | boolean | true          | Is page pause enabled?
 :page_height| integer | console height| The height of the page.
 :page_width | integer | console width | The width of the page.
-:page_msg   | string  | "Press enter, space or q:" | The paused prompt message.
+:page_msg   | string  | "Press space (line), n (no pause), q(uit) or other (page):" | The paused prompt message.
+:one_line   | string  | " "           | The key to progress by one line.
+:skip_all   | string  | "q"           | The key to skip the rest of the output.
+:no_pause   | string  | "n"           | The key to display the rest with no pauses.
 
 The default value is used if the option is absent from the hash. Unsupported
 option values are ignored and have no effect.
 
 Notes:
+
 * Setting page_pause to false can allow a block of code to run without pausing
-at page breaks, if that is desired.
+at page breaks, if that is desired. Since, Ruby has no boolean type, this can
+be any object. The values false, "false", "off", or "no" will disable pauses.
 * If the :page_height and :page_width values are not valid, the default values
 will be used instead.
 * Nesting of "more" blocks is allowed. However, only the options of the outermost

data/lib/pause_output/globalize.rb

@@ -10,10 +10,10 @@ class Object
     saved = $stdout
     outer = $stdout.equal?($pause_output_out)
 
-    disabled = options[:page_pause]
-    disabled = disabled.downcase if disabled.is_a?(String)
+    enabled = options[:page_pause]
+    enabled = enabled.downcase if enabled.is_a?(String)
 
-    unless [false, 'false', 'off', 'no'].include?(disabled)
+    unless [false, 'false', 'off', 'no'].include?(enabled)
       $stdout = ::PauseOutput::OutputPager.new(options) if outer
     end
 

data/lib/pause_output/output_pager.rb

@@ -62,11 +62,13 @@ module PauseOutput
 
       if @lines >= (lines_per_page - 1)
         case pause.downcase
-        when " "
+        when one_line
           @lines -= 1
-        when "q"
+        when skip_all
           @lines = 0
           raise PauseOutputStop
+        when no_pause
+          @lines = -1_000_000
         else
           @lines = 0
         end
@@ -104,7 +106,23 @@ module PauseOutput
 
     # Get the text of the pause message.
     def pause_message
-      @options.key?(:page_msg) ? @options[:page_msg] : "Press enter, space or q:"
+      @options.key?(:page_msg) ? @options[:page_msg] :
+        "Press space (line), n (no pause), q(uit) or other (page):"
+    end
+
+    # Keystroke to advance one line.
+    def one_line
+      @options.key?(:one_line) ? @options[:one_line] : " "
+    end
+
+    # Keystroke to quit processing.
+    def skip_all
+      @options.key?(:skip_all) ? @options[:skip_all] : "q"
+    end
+
+    # Keystroke to disable pauses.
+    def no_pause
+      @options.key?(:no_pause) ? @options[:no_pause] : "n"
     end
 
   end

data/lib/pause_output/version.rb

@@ -2,7 +2,7 @@
 
 # Pause console output so that it can be read before scrolling off the screen.
 module PauseOutput
-  VERSION = "0.1.2".freeze
+  VERSION = "0.2.0".freeze
 
   DESCRIPTION = "pause_output: A simple facility to pause output on the console terminal.".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pause_output
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - PeterCamilleri
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-05 00:00:00.000000000 Z
+date: 2020-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler