output_mode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 459750a9a32c10353ffca23bcf3f9aa1bdb7da651570a324e82ba224c260df87
+  data.tar.gz: 5a1661e01600478c767d79ad27b2b499440f3d610d4255088c7c76fff0842e28
+SHA512:
+  metadata.gz: 4bddfb1d70102c00543a73d6d2bdd56dfcd7f248fd0ea57b222dc428bb1cb6928168592663f07c7bd5d18e22a16ae70af59dc2fbf5281de19004971cb9b26737
+  data.tar.gz: 94d113f12f084cf82a29b4a0f1e8528c3dbd8aa2138237d4dcb5ecbf8cc24352ab25e0528f6edb23a501dc2bdcec1e729698df7bb3f643d2666f8008ff0ece85

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+Gemfile.lock
+
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+  - 2.7.0
+before_install: gem install bundler -v 2.0.2
+script: bundle exec rspec --format documentation --order random
+branches:
+  only:
+    - master
+    - develop

data/Gemfile

@@ -0,0 +1,30 @@
+#==============================================================================
+# 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.
+#==============================================================================
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in output_mode.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,18 @@
+This project is partially dual licensed under BSD-2-Clause OR 0BSD. Source code originating from a BSD-2-Clause licensed file must comply with terms contained within the license header block. Source code originating from files without a license header block maybe redistributed under either license.
+
+The following is a copy of the BSD-2-Clause license:
+
+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.
+
+The following is a copy of the 0BSD license:
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/README.md

@@ -0,0 +1,67 @@
+[![Build Status](https://travis-ci.com/WilliamMcCumstie/output_mode.svg?branch=master)](https://travis-ci.com/WilliamMcCumstie/output_mode)
+
+# OutputMode
+
+Provides a set of wrapper `Outputs` to common libraries: `TTY::Table`, `CSV`, and `ERB`. Focus on "what" you want to print to a terminal instead of "how" it should be formatted.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'output_mode'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install output_mode
+
+## Usage
+
+Checkout the [demo script](bin/demo) for a basic getting started example. It uses the two prefabricated modules:
+ * `OutputMode::TLDR::Index` - Tabulate the data models for humans and tab ("\t") delimit it for machines
+ * `OutputMode::TLDR::Show` - List the data model(s) for humans and tab ("\t") delimit it for machines
+
+The `TLDR` modules are designed for a fairly limited use case, where:
+ * The humanized/machine outputs is toggled if `StandardOut` is connected to a `TTY`,
+ * Certain columns/fields need to be hidden based on a user supplied verbosity toggle.
+
+A basic use case would be:
+
+```
+class Foo
+  extend OutputMode::TLDR::Index
+
+  # Adds a "column" to the output. Fundamentally the "column" is a block transform function
+  register_callable(header: 'ID') { |model| model.id }
+  register_callable(header: 'Name') { |model| model.name }
+
+  # Show different date formats according to verbosity, only one column will be displayed
+  register_callable(header: 'Create Date', verbose: true) { |m| m.create_date.to_rfc3339 }
+  register_callable(header: 'Create Date', verbose false) { |m| m.create_date.strftime("%F") }
+end
+
+data = [... data models ...]
+puts Foo.build_output.render(*data)
+```
+
+If this use case becomes to restrictive, look at the internals of the `TLDR` modules on how they are implemented. This will give you ideas on how to implement the `outputs`/`modes` for your bespoke use case.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/WilliamMcCumstie/output_mode.
+
+## Copyright and License
+
+See [LICENSE](LICENSE.txt) for dual licensing details.
+

data/Rakefile

@@ -0,0 +1,32 @@
+#==============================================================================
+# 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.
+#==============================================================================
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby
+#==============================================================================
+# 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.
+#==============================================================================
+
+require "bundler/setup"
+require "output_mode"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require "pry"
+Pry.start
+

data/bin/demo

@@ -0,0 +1,60 @@
+#!/usr/bin/env ruby
+#==============================================================================
+# Refer to LICENSE.txt for licensing terms
+#==============================================================================
+
+
+require "bundler/setup"
+require "output_mode"
+
+module DemoIndex
+  extend OutputMode::TLDR::Index
+
+  register_callable(header: 'Integer') { |i| i }
+  register_callable(header: 'Standard') { 'always visible' }
+  register_callable(header: 'Verbose', verbose: true) { 'verbose visible' }
+  register_callable(header: 'Simplified', verbose: false) { 'simplified visible' }
+  register_callable(header: 'Yes/True') { true }
+  register_callable(header: 'No/False') { false }
+  register_callable(header: 'Missing') { nil }
+end
+
+module DemoShow
+  extend OutputMode::TLDR::Show
+
+  register_callable(header: 'Integer') { |i| i }
+  register_callable(header: 'Standard') { 'always visible' }
+  register_callable(header: 'Verbose', verbose: true) { 'verbose visible' }
+  register_callable(header: 'Simplified', verbose: false) { 'simplified visible' }
+  register_callable(header: 'Yes/True') { true }
+  register_callable(header: 'No/False') { false }
+  register_callable(header: 'Missing') { nil }
+end
+
+data = [1, 2, 3]
+
+puts <<~EOF
+#==============================================================================
+# Demo Verbose Index
+#==============================================================================
+#{DemoIndex.build_output(verbose: true).render(*data)}
+
+#==============================================================================
+# Demo "Simplified" Index
+# NOTE: Disabled for non-interactive shell, shows the verbose output instead
+#==============================================================================
+#{DemoIndex.build_output(verbose: false).render(*data)}
+
+#==============================================================================
+# Demo Verbose Show
+#==============================================================================
+#{DemoShow.build_output(verbose: true).render(*data)}
+
+#==============================================================================
+# Demo "Simplified" Show
+# NOTE: Disabled for non-interactive shell, shows the verbose output instead
+#==============================================================================
+#{DemoShow.build_output(verbose: false).render(*data)}
+EOF
+
+

data/bin/setup

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+#==============================================================================
+# 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.
+#==============================================================================
+
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/output_mode.rb

@@ -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.
+#==============================================================================
+
+require "output_mode/version"
+require 'output_mode/errors'
+
+require 'output_mode/outputs'
+require 'output_mode/callable'
+require 'output_mode/builder_dsl'
+require 'output_mode/tldr'
+

data/lib/output_mode/builder_dsl.rb

@@ -0,0 +1,50 @@
+#==============================================================================
+# 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 BuilderDSL
+    # The callable objects an `output` can be built from
+    def output_callables
+      @output_callables ||= Callables.new
+    end
+
+    # Adds a new callable object to {output_callables}
+    # @abstract This maybe overridden to restrict the method signature
+    # @param config Directly provided to {OutputMode::Callable#initialize}
+    # @yield Directly provided to {OutputMode::Callable#initialize}
+    def register_callable(**config, &b)
+      output_callables << Callable.new(**config, &b)
+    end
+
+    # Provides the base method signature
+    # @abstract Must be implemented by the main class/module
+    # @return OutputMode::Output The newly created output
+    def build_output(**config)
+      raise NotImplementedError
+    end
+  end
+end
+

data/lib/output_mode/callable.rb

@@ -0,0 +1,138 @@
+#==============================================================================
+# 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
+  # Internal array like object that will convert procs to Callable
+  class Callables < Array
+    # @api private
+    def initialize(callables = nil)
+      case callables
+      when Array
+        super().tap do |all|
+          callables.each { |c| all << c }
+        end
+      when nil
+        super()
+      else
+        raise "Can not convert #{callables.class} into a #{self.class}"
+      end
+    end
+
+    def <<(item)
+      if item.is_a? Callable
+        super
+      elsif item.respond_to?(:call)
+        super(Callable.new(&item))
+      else
+        raise Error, "#{item.class} is not callable"
+      end
+    end
+  end
+
+  class Callable
+    # @!attribute [r] modes
+    #   @return [Hash<Symbol => Boolean>] Returns the configured modes
+    # @!attribute [r] callable
+    #   @return [#call] Returns the underlining block
+    # @!attribute [r] config
+    #   @return [Hash] An arbitrary hash of key-value pairs
+    attr_reader :modes, :callable, :config
+
+    # Wraps a block/ callable object with mode query methods
+    # @overload initialize(modes: {}, **config)
+    #   @param [Hash<Symbol => Boolean>] modes: Provide the preconfigured modes
+    #   @param **config An arbitrary hash to be stored on the object
+    #   @yield Executed by the {#call} method
+    #   @yieldparam *a The arguments provided to {#call}
+    # @overload initialize(modes: []) { |*a| ... }
+    #   @param [Array] modes: The preconfigured modes as an array, this will be converted to a hash
+    def initialize(modes: {}, **config, &block)
+      @callable = block
+      @modes = if modes.is_a? Hash
+                 modes.reject { |_, v| v.nil? }
+                      .map { |k, v| [k, v ? true : false] }
+                      .to_h
+               else
+                 modes.map { |k| [k, true] }.to_h
+               end
+      @config = config
+    end
+
+    # Handles the dynamic +<query>?+ and +<explicit-negation>!+ methods
+    #
+    # The +<query>?+ methods check if the mode has been set on the object. If
+    # +query+ is a defined mode, then the value is directly pulled from #{modes}.
+    # Undefined modes will return +false+.
+    #
+    # The +<explicit-negation>!+ methods are similar to queries, but undefined modes
+    # will return +true+. This means +<explicit-negation>!+ methods only return +false+
+    # if the +explicit-negation+ mode has been set to +false+ in {#modes}.
+    #
+    # @return [Boolean] The result of the query or explicit-negation
+    # @raises [NoMethodError] All other method calls
+    def method_missing(s, *a, &b)
+      mode = s[0..-2].to_sym
+      case method_char(s)
+      when '?'
+        modes.fetch(mode, false)
+      when '!'
+        modes.fetch(mode, true)
+      else
+        super
+      end
+    end
+
+    # Responds +true+ for valid dynamic methods
+    # @param [Symbol] s The method to be tested
+    # @return [Boolean] The truthiness of the underlining call to {#method_char}
+    def respond_to_missing?(s, *_)
+      method_char(s) ? true : false
+    end
+
+    # Determines the "type" associated with a dynamic method
+    # @overload method_char(bang!)
+    #   @param bang! A symbol/string ending with !
+    #   @return ['!']
+    # @overload method_char(question?)
+    #   @param question? A symbol/string ending with ?
+    #   @return ['?']
+    # @overload method_char(other)
+    #   @param other Any other symbol/string
+    #   @return [Nil]
+    def method_char(s)
+      char = s[-1]
+      ['?', '!'].include?(char) ? char : nil
+    end
+
+    # Calls the underlining block
+    # @param *a The arguments to be provided to {#callable}
+    # @return The results from the block
+    def call(*a)
+      callable.call(*a)
+    end
+  end
+end
+