RubyGems - output_mode - Versions diffs - 1.0.0 - Mend

output_mode 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

checksums.yaml +7 -0
data/.gitignore +15 -0
data/.rspec +3 -0
data/.travis.yml +13 -0
data/Gemfile +30 -0
data/LICENSE.txt +18 -0
data/README.md +67 -0
data/Rakefile +32 -0
data/bin/console +37 -0
data/bin/demo +60 -0
data/bin/setup +34 -0
data/lib/output_mode.rb +34 -0
data/lib/output_mode/builder_dsl.rb +50 -0
data/lib/output_mode/callable.rb +138 -0
data/lib/output_mode/default_erb.rb +19 -0
data/lib/output_mode/errors.rb +30 -0
data/lib/output_mode/output.rb +127 -0
data/lib/output_mode/outputs.rb +36 -0
data/lib/output_mode/outputs/delimited.rb +49 -0
data/lib/output_mode/outputs/tabulated.rb +73 -0
data/lib/output_mode/outputs/templated.rb +128 -0
data/lib/output_mode/tldr.rb +34 -0
data/lib/output_mode/tldr/index.rb +55 -0
data/lib/output_mode/tldr/show.rb +56 -0
data/lib/output_mode/version.rb +29 -0
data/output_mode.gemspec +59 -0
metadata +166 -0

data/lib/output_mode/tldr.rb ADDED

@@ -0,0 +1,34 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+module OutputMode
+  module TLDR
+    Dir.glob(File.expand_path('tldr/*.rb', __dir__)).each do |path|
+      autoload File.basename(path).chomp('.rb').capitalize, path
+    end
+  end
+end

data/lib/output_mode/tldr/index.rb ADDED

@@ -0,0 +1,55 @@
+#==============================================================================
+# Refer to LICENSE.txt for licensing terms
+#==============================================================================
+module OutputMode
+  module TLDR
+    module Index
+      include BuilderDSL
+      # Register a new column in the Index table
+      # @overload register_callable(header:, verbose: true)
+      #   @param header: The column's header field when displaying to humans
+      #   @param verbose: Whether the column will be shown in the verbose output
+      #   @yieldparam model The subject the column is describing, some sort of data model
+      def register_callable(header:, verbose: nil, &b)
+        super(modes: { verbose: verbose }, header: header, &b)
+      end
+      # Creates an new +output+ from the verbosity flag. This method only uses
+      # +$stdout+ as part of it's output class discovery logic. It does not
+      # print to the output directly
+      #
+      # If +$stdout+ is an interactive shell (aka a TTY), then it will display using
+      # {OutputMode::Outputs::Tabulated}. This is intended for human consumption
+      # and will obey the provided +verbose+ flag.
+      #
+      # If +$stdout+ is non-interactive, then it will display using
+      # {OutputMode::Outputs::Delimited} using tab delimiters. This is intended
+      # for consumption by machines. This output ignores the provided +verbose+
+      # flag as it is always verbose.
+      def build_output(verbose: false)
+        callables = if verbose || !$stdout.tty?
+          # Filter out columns that are explicitly not verbose
+          output_callables.select(&:verbose!)
+        else
+          # Filter out columns that are explicitly verbose
+          output_callables.reject(&:verbose?)
+        end
+        if $stdout.tty?
+          # Creates the human readable output
+          Outputs::Tabulated.new(*callables,
+                                 header: callables.map { |c| c.config.fetch(:header, 'missing') },
+                                 renderer: :unicode,
+                                 padding: [0,1],
+                                 default: '(none)',
+                                 yes: '✓', no: '✕')
+        else
+          # Creates the machine readable output
+          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'y', no: 'n', default: '')
+        end
+      end
+    end
+  end
+end

data/lib/output_mode/tldr/show.rb ADDED

@@ -0,0 +1,56 @@
+#==============================================================================
+# Refer to LICENSE.txt for licensing terms
+#==============================================================================
+require 'tty-color'
+module OutputMode
+  module TLDR
+    module Show
+      include BuilderDSL
+      # Register a field when displaying a model
+      # @overload register_callable(header:, verbose: true)
+      #   @param header: The human readable key to the field, uses the term 'header' for consistency
+      #   @param verbose: Whether the field will be shown in the verbose output
+      #   @yieldparam model The subject the column is describing, some sort of data model
+      def register_callable(header:, verbose: nil, &b)
+        super(modes: { verbose: verbose }, header: header, &b)
+      end
+      # Creates an new +output+ from the verbosity flag. This method only uses
+      # +$stdout+ as part of it's output class discovery logic. It does not
+      # print to the io directly
+      #
+      # If +$stdout+ is an interactive shell (aka a TTY), then it will display using
+      # {OutputMode::Outputs::Templated}. This is intended for human consumption
+      # and will obey the provided +verbose+ flag.
+      #
+      # If +$stdout+ is non-interactive, then it will display using
+      # {OutputMode::Outputs::Delimited} using tab delimiters. This is intended
+      # for consumption by machines. This output ignores the provided +verbose+
+      # flag as it is always verbose.
+      def build_output(verbose: false)
+        callables = if verbose || !$stdout.tty?
+          # Filter out columns that are explicitly not verbose
+          output_callables.select(&:verbose!)
+        else
+          # Filter out columns that are explicitly verbose
+          output_callables.reject(&:verbose?)
+        end
+        if $stdout.tty?
+          # Creates the human readable output
+          Outputs::Templated.new(*callables,
+                                 fields: callables.map { |c| c.config.fetch(:header, 'missing') },
+                                 colorize: TTY::Color.color?,
+                                 default: '(none)',
+                                 yes: '✓', no: '✕')
+        else
+          # Creates the machine readable output
+          Outputs::Delimited.new(*callables, col_sep: "\t", yes: 'y', no: 'n', default: '')
+        end
+      end
+    end
+  end
+end

data/lib/output_mode/version.rb ADDED

@@ -0,0 +1,29 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+module OutputMode
+  VERSION = "1.0.0"
+end

data/output_mode.gemspec ADDED

@@ -0,0 +1,59 @@
+#==============================================================================
+# Copyright 2020 William McCumstie
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+#==============================================================================
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "output_mode/version"
+Gem::Specification.new do |spec|
+  spec.name          = "output_mode"
+  spec.version       = OutputMode::VERSION
+  spec.authors       = ["William McCumsite"]
+  spec.email         = ["openlicense.williams@gmail.com"]
+  spec.summary       = %q{Toggle human and machine readable outputs}
+  spec.homepage      = "https://github.com/WilliamMcCumstie/output_mode"
+  spec.metadata["homepage_uri"] = spec.homepage
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency 'tty-table', '~> 0.11'
+  spec.add_runtime_dependency 'pastel', '~> 0.7'
+  spec.add_runtime_dependency 'tty-color', '~> 0.5'
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "> 0.11"
+end

metadata ADDED

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: output_mode
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- William McCumsite
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: tty-color
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description:
+email:
+- openlicense.williams@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/demo
+- bin/setup
+- lib/output_mode.rb
+- lib/output_mode/builder_dsl.rb
+- lib/output_mode/callable.rb
+- lib/output_mode/default_erb.rb
+- lib/output_mode/errors.rb
+- lib/output_mode/output.rb
+- lib/output_mode/outputs.rb
+- lib/output_mode/outputs/delimited.rb
+- lib/output_mode/outputs/tabulated.rb
+- lib/output_mode/outputs/templated.rb
+- lib/output_mode/tldr.rb
+- lib/output_mode/tldr/index.rb
+- lib/output_mode/tldr/show.rb
+- lib/output_mode/version.rb
+- output_mode.gemspec
+homepage: https://github.com/WilliamMcCumstie/output_mode
+licenses: []
+metadata:
+  homepage_uri: https://github.com/WilliamMcCumstie/output_mode
+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: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Toggle human and machine readable outputs
+test_files: []