pause_output 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83c19923ca0b37435ae429d19333cee7ecf30e5a
+  data.tar.gz: f86703967f428ca682930f17988ac0464f4fe07b
+SHA512:
+  metadata.gz: cfa242aa5ca571b682089ca88522e6262cfc7bd11d48d545f4a6ec475d74ee8516c6cd7fab1868acabdca8f54443b5bd0d1fc4539eec1bf3c4eca8a914b854e1
+  data.tar.gz: 65a06d93e70e33d4ddb032225608ed9f6162c75c0fc4edcd0ea07862690d6b202e849d14711540b4a17fd324005969d11281bfc7a979fb64384365752844c20a

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at peter.c.camilleri@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in pause_output.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 PeterCamilleri
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,89 @@
+# PauseOutput
+
+The pause_output gem provides a facility like the classic more (or less) utility
+within Ruby programs. This little bit of code started out as a feature of the
+mysh (my shell) program but was spun off as it was felt that this capability
+had use on a larger scale.
+
+Also included is a simple demo program called pom (Pause Output More) This
+simple demo accepts a list of files and displays them, pausing as needed.
+It is as easy to use as this:
+
+    pom README.md
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pause_output'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pause_output
+
+## Usage
+
+The pause_output gem works through the more command. This simple command
+accepts optional hash arguments and a block. For example:
+
+```ruby
+more do
+  100.times do |i|
+    puts "#{'%5d' % i}, #{'%6d' % (i*i)}, #{'%8d' % (i*i*i)}"
+  end
+end
+```
+
+#### Options
+
+The following options are available for use in the optional options hash
+parameter of the global Object#more method:
+
+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.
+
+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.
+* 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
+block are active. The options passed into "inner" blocks are ignored.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+OR...
+
+* Make a suggestion by raising an
+ [issue](https://github.com/PeterCamilleri/pause_output/issues)
+. All ideas and comments are welcome.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](./LICENSE.txt).
+
+## Code of Conduct
+
+Everyone interacting in the pause_output project’s codebases, issue trackers,
+chat rooms and mailing lists is expected to follow the
+[code of conduct](./CODE_OF_CONDUCT.md).

data/exe/pom

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+#
+# The Ruby inspired, ego based, My Shell command line processor.
+#
+
+require_relative '..\lib\pause_output'
+
+MiniTerm.open(quiet: true, strict: true) unless MiniTerm.term_open?
+
+if ARGV[0] == '-h'
+  puts "The paused output more gem demo. Version: #{::PauseOutput::VERSION}"
+  exit
+end
+
+more do
+  ARGV.each do |file_name|
+    puts "**** File: #{file_name} ****"," "
+    puts IO.read(file_name), " "
+  end
+end

data/lib/pause_output.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+require "mini_term"
+
+require_relative "pause_output/exceptions"
+require_relative "pause_output/output_pager"
+require_relative "pause_output/globalize"
+require_relative "pause_output/version"

data/lib/pause_output/exceptions.rb

@@ -0,0 +1,4 @@
+# coding: utf-8
+
+# The stop output exception.
+class PauseOutputStop < StandardError; end

data/lib/pause_output/globalize.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+#Monkey patches for pause output global entities.
+class Object
+
+  private
+
+  # Execute a block with page paused output.
+  def more(options={})
+    saved = $stdout
+
+    disabled = options[:page_pause]
+    disabled = disabled.downcase if disabled.is_a?(String)
+
+    unless [false, 'false', 'off', 'no'].include?(disabled)
+      outer = $stdout.equal?($pause_output_out)
+      $stdout = ::PauseOutput::OutputPager.new(options) if outer
+    end
+
+    yield
+
+  rescue PauseOutputStop
+    raise unless outer
+    return
+
+  ensure
+    $stdout = saved
+  end
+
+end

data/lib/pause_output/output_pager.rb

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+$pause_output_out = $stdout   # Keep a copy of the real $stdout.
+
+module PauseOutput
+
+  # A class to manage paged output.
+  class OutputPager
+
+    # Set up the initial values.
+    def initialize(options={})
+      @options = options
+      @lines   = 0
+      @chars   = 0
+    end
+
+    # Write out a general string with page pauses.
+    def write(str)
+      while !str.empty?
+        pre,mid,str = str.partition("\n")
+        write_str(pre) unless pre.empty?
+        writeln unless mid.empty?
+      end
+    end
+
+    # Write out an object as a string.
+    def <<(obj)
+      write(obj.to_s)
+    end
+
+  private
+
+    # Write out a simple string with no embedded new-lines.
+    def write_str(str)
+      loop do
+        len = str.length
+
+        if @chars + len < chars_per_line
+          $pause_output_out.write(str)
+          @chars += len
+          return
+        else
+          tilt = chars_per_line - @chars
+          $pause_output_out.write(str[0, tilt])
+          count_lines
+
+          str = (str[tilt..-1])
+        end
+      end
+    end
+
+    # Write out a new-line.
+    def writeln
+      $pause_output_out.write("\n")
+      count_lines
+    end
+
+    # A new line is out, count it!
+    def count_lines
+      @chars = 0
+      @lines += 1
+
+      if @lines >= (lines_per_page - 1)
+        case pause.downcase
+        when " "
+          @lines -= 1
+        when "q"
+          @lines = 0
+          raise PauseOutputStop
+        else
+          @lines = 0
+        end
+      end
+    end
+
+    # Pause waiting for the user.
+    def pause
+      msg = pause_message
+      $pause_output_out.write(msg)
+
+      MiniTerm.raw do |term|
+        result = term.get_raw_char
+        term.flush
+        result
+      end
+
+    ensure
+      $pause_output_out.write("\r" + " " * msg.length + "\r")
+    end
+
+    # How many lines fit on a page?
+    def lines_per_page
+      result = @options[:page_height].to_i
+      result = MiniTerm.height if result < 2
+      result
+    end
+
+    # How many characters fit on a line?
+    def chars_per_line
+      result = @options[:page_width].to_i
+      result = MiniTerm.width if result < 20
+      result
+    end
+
+    # Get the text of the pause message.
+    def pause_message
+      @options.key?(:page_msg) ? @options[:page_msg] : "Press enter, space or q:"
+    end
+
+  end
+
+end

data/lib/pause_output/version.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+
+# Pause console output so that it can be read before scrolling off the screen.
+module PauseOutput
+  VERSION = "0.1.0".freeze
+
+  DESCRIPTION = "pause_output: A simple facility to pause output on the console terminal.".freeze
+end

data/pause_output.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pause_output/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pause_output"
+  spec.version       = PauseOutput::VERSION
+  spec.authors       = ["PeterCamilleri"]
+  spec.email         = ["peter.c.camilleri@gmail.com"]
+
+  spec.summary       = %q{Pause lengthy console output.}
+  spec.description   = %q{pause_output: A simple facility to pause output on the console terminal.}
+  spec.homepage      = "https://github.com/PeterCamilleri/pause_output"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+                          f.match(%r{^(test|docs)/})
+                        end
+  spec.bindir        = "exe"
+  spec.executables   = spec
+                         .files
+                         .reject { |f| f.downcase == 'exe/readme.md'}
+                         .grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency 'minitest_visible', "~> 0.1"
+  spec.add_development_dependency 'reek', "~> 5.0.2"
+
+  spec.add_runtime_dependency     'mini_term', "~> 0.1.0"
+end

data/rakefile.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+# coding: utf-8
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test
+
+desc "Run a scan for smelly code!"
+task :reek do |t|
+  `reek --no-color lib > reek.txt`
+end
+
+desc "What version of pause_output is this?"
+task :vers do |t|
+  puts
+  puts "pause_output version = #{::PauseOutput::VERSION}"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: pause_output
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PeterCamilleri
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest_visible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+- !ruby/object:Gem::Dependency
+  name: mini_term
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: 'pause_output: A simple facility to pause output on the console terminal.'
+email:
+- peter.c.camilleri@gmail.com
+executables:
+- pom
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- exe/pom
+- lib/pause_output.rb
+- lib/pause_output/exceptions.rb
+- lib/pause_output/globalize.rb
+- lib/pause_output/output_pager.rb
+- lib/pause_output/version.rb
+- pause_output.gemspec
+- rakefile.rb
+homepage: https://github.com/PeterCamilleri/pause_output
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Pause lengthy console output.
+test_files: []