sod 0.0.0

data/lib/sod/prefabs/actions/config/view.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "refinements/pathnames"
+
+module Sod
+  module Prefabs
+    module Actions
+      module Config
+        # Displays project configuration.
+        class View < Action
+          include Import[:kernel, :logger]
+
+          using Refinements::Pathnames
+
+          description "View project configuration."
+
+          on %w[-v --view]
+
+          # :reek:ControlParameter
+          def initialize(path = nil, **)
+            super(**)
+            @path = Pathname(path || context.xdg_config.active)
+          end
+
+          def call(*)
+            return unless check
+
+            logger.info { "Viewing (#{path.to_s.inspect}):" }
+            kernel.puts path.read
+          end
+
+          private
+
+          attr_reader :path
+
+          def check
+            return true if path.exist?
+
+            logger.error { "Configuration doesn't exist: #{path.to_s.inspect}." }
+            kernel.abort
+            false
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sod/prefabs/actions/help.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sod
+  module Prefabs
+    module Actions
+      # Displays help (usage) information.
+      class Help < Action
+        include Import[:kernel]
+
+        description "Show this message."
+
+        on %w[-h --help], argument: "[COMMAND]"
+
+        def initialize(graph, presenter: Presenters::Node, **)
+          super(**)
+          @graph = graph
+          @presenter = presenter
+        end
+
+        def call *lineage
+          if lineage.empty?
+            kernel.puts presenter.new(graph).to_s
+          else
+            kernel.puts presenter.new(graph.get_child(*lineage)).to_s
+          end
+        end
+
+        private
+
+        attr_reader :graph, :presenter
+      end
+    end
+  end
+end

data/lib/sod/prefabs/actions/version.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sod
+  module Prefabs
+    module Actions
+      # Provides a generic version action for use in upstream applications.
+      class Version < Action
+        include Import[:kernel]
+
+        description "Show version."
+
+        on %w[-v --version]
+
+        def initialize(label = nil, **)
+          super(**)
+          @label = context[label, :version_label]
+        end
+
+        def call(*) = kernel.puts label
+
+        private
+
+        attr_reader :label
+      end
+    end
+  end
+end

data/lib/sod/prefabs/commands/config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sod
+  module Prefabs
+    module Commands
+      # Provides a generic configuration command for use in upstream applications.
+      class Config < Sod::Command
+        handle "config"
+
+        description "Manage configuration."
+
+        ancillary "Path is dynamic per current directory."
+
+        on Prefabs::Actions::Config::Create
+        on Prefabs::Actions::Config::Edit
+        on Prefabs::Actions::Config::View
+        on Prefabs::Actions::Config::Delete
+      end
+    end
+  end
+end

data/lib/sod/presenters/action.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "refinements/arrays"
+
+module Sod
+  module Presenters
+    # Aids in rendering an action for display.
+    class Action
+      include Import[:color]
+
+      extend Forwardable
+
+      using Refinements::Arrays
+
+      delegate [*Models::Action.members, :handle] => :record
+
+      def initialize(record, **)
+        super(**)
+        @record = record
+      end
+
+      def colored_handle = [color_aliases, argument].tap(&:compact!).join(" ")
+
+      def colored_documentation = [*ancillary, color_allows, color_default].tap(&:compact!)
+
+      private
+
+      attr_reader :record
+
+      def color_aliases
+        Array(record.aliases).map { |value| color[value, :cyan] }
+                             .join ", "
+      end
+
+      def color_allows
+        return unless allow
+
+        values = Array(allow).map { |value| color[value, :green] }
+                             .to_sentence "or"
+        "Use: #{values}."
+      end
+
+      def color_default
+        cast = default.to_s
+
+        return if cast.empty?
+
+        value = cast == "false" ? color[default, :red] : color[default, :green]
+        "Default: #{value}."
+      end
+    end
+  end
+end

data/lib/sod/presenters/node.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "refinements/arrays"
+require "refinements/strings"
+
+module Sod
+  module Presenters
+    # Aids in rendering a node for display.
+    # :reek:TooManyInstanceVariables
+    class Node
+      include Import[:color]
+
+      extend Forwardable
+
+      using Refinements::Arrays
+      using Refinements::Strings
+
+      delegate Graph::Node.members => :node
+
+      attr_reader :actions
+
+      # rubocop:todo Metrics/ParameterLists
+      def initialize(node, indent: 2, gap: 5, action_presenter: Presenters::Action, **)
+        super(**)
+        @node = node
+        @indent = indent
+        @gap = gap
+        @actions = node.actions.map { |action| action_presenter.new action.record }
+        @all = actions + children.to_a
+      end
+      # rubocop:enable Metrics/ParameterLists
+
+      def to_s
+        [banner, "", *usage, "", *colored_actions, "", *colored_commands].tap(&:compact!)
+                                                                         .join("\n")
+                                                                         .strip
+      end
+
+      private
+
+      attr_reader :node, :indent, :gap, :all
+
+      def banner = color[description, :bold]
+
+      def usage
+        actions = "  #{colored_handle} [OPTIONS]" unless all.empty?
+        commands = "  #{colored_handle} COMMAND [OPTIONS]" unless children.empty?
+
+        add_section "USAGE", [actions, commands].tap(&:compact!)
+      end
+
+      def colored_handle = color[handle, :cyan]
+
+      def colored_actions
+        return if actions.empty?
+
+        collection = actions.each_with_object [] do |action, content|
+          content.append "  #{action.colored_handle}#{description_padding action}" \
+                         "#{action.description}"
+          add_ancillary action, :colored_documentation, content
+        end
+
+        add_section "OPTIONS", collection
+      end
+
+      def colored_commands
+        return if children.empty?
+
+        collection = children.each_with_object [] do |command, content|
+          content.append "  #{color[command.handle, :cyan]}#{description_padding command}" \
+                         "#{command.description}"
+          add_ancillary command, :ancillary, content
+        end
+
+        add_section "COMMANDS", collection
+      end
+
+      def description_padding(item) = " " * ((max_handle_size - item.handle.size) + gap)
+
+      def max_handle_size = all.map(&:handle).maximum :size
+
+      def add_ancillary target, message, content
+        target.public_send(message).each do |line|
+          content.append line.indent (max_handle_size + gap + indent), pad: " "
+        end
+      end
+
+      # :reek:FeatureEnvy
+      def add_section text, collection
+        collection.empty? ? collection : collection.prepend(color[text, :bold, :underline])
+      end
+    end
+  end
+end

data/lib/sod/refines/option_parsers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Sod
+  module Refines
+    # Provides additional enhancements to the option parser primitive.
+    module OptionParsers
+      refine OptionParser do
+        def order!(argument = default_argv, into: nil, command: nil, &)
+          super(argument, into:, &)
+          command.call if command
+        end
+
+        def replicate
+          self.class.new banner, summary_width, summary_indent do |instance|
+            instance.set_program_name program_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sod/shell.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "cogger"
+
+module Sod
+  # The Command Line Interface (CLI).
+  class Shell
+    attr_reader :name, :banner
+
+    # rubocop:todo Metrics/ParameterLists
+    def initialize name = Cogger::Program.call,
+                   banner: nil,
+                   node: Graph::Node,
+                   runner: Graph::Runner,
+                   &block
+      @name = name.to_s
+      @banner = banner
+      graph = node[handle: name, description: banner]
+      graph.instance_eval(&block) if block
+      @runner = runner.new graph
+    end
+    # rubocop:enable Metrics/ParameterLists
+
+    def call arguments = ARGV, process: Process
+      process.setproctitle name
+      runner.call arguments
+    end
+
+    private
+
+    attr_reader :runner
+  end
+end

data/lib/sod/types/pathname.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "pathname"
+
+OptionParser.accept(Pathname) { |value| Pathname value }

data/lib/sod.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem.then do |loader|
+  loader.ignore "#{__dir__}/sod/types"
+  loader.setup
+end
+
+# Main namespace.
+module Sod
+  def self.new(...) = Shell.new(...)
+end

data/sod.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "sod"
+  spec.version = "0.0.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://alchemists.io/projects/sod"
+  spec.summary = "A Domain Specific Language for creating composable Command Line Interfaces."
+  spec.license = "Hippocratic-2.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/sod/issues",
+    "changelog_uri" => "https://alchemists.io/projects/sod/versions",
+    "documentation_uri" => "https://alchemists.io/projects/sod",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
+    "label" => "Sod",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/sod"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.2"
+  spec.add_dependency "cogger", "~> 0.10"
+  spec.add_dependency "dry-container", "~> 0.11"
+  spec.add_dependency "infusible", "~> 2.0"
+  spec.add_dependency "refinements", "~> 11.0"
+  spec.add_dependency "tone", "~> 0.3"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

data.tar.gz.sig

@@ -0,0 +1,4 @@
+�ē�U����{�RAm����\�o�CO�%�~���}h�%J�p�g�}�o�ދ[_��N���	��-ǩ2��&Y�'9���(�$�؍���v�q�����"W���Ǽa��a`)p�.p�0(z2���Gp)r5g��u�X���a����ć��LW�
+��F���o��c`��'���U�$�^�`cTe!P��
+���z�����-R?�I%d{L�62=�#}�Pp��ʫ6sVѣ�H
+i�����7/v|

metadata

@@ -0,0 +1,190 @@
+--- !ruby/object:Gem::Specification
+name: sod
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEeDCCAuCgAwIBAgIBATANBgkqhkiG9w0BAQsFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMjMwMzIyMTYxNDQxWhcNMjUwMzIxMTYxNDQxWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQCro8tj5/E1Hg88
+  f4qfiwPVd2zJQHvdYt4GHVvuHRRgx4HGhJuNp+4BId08RBn7V6V1MW6MY3kezRBs
+  M+7QOQ4b1xNLTvY7FYQB1wGK5a4x7TTokDrPYQxDB2jmsdDYCzVbIMrAvUfcecRi
+  khyGZCdByiiCl4fKv77P12tTT+NfsvXkLt/AYCGwjOUyGKTQ01Z6eC09T27GayPH
+  QQvIkakyFgcJtzSyGzs8bzK5q9u7wQ12MNTjJoXzW69lqp0oNvDylu81EiSUb5S6
+  QzzPxZBiRB1sgtbt1gUbVI262ZDq1gR+HxPFmp+Cgt7ZLIJZAtesQvtcMzseXpfn
+  hpmm0Sw22KGhRAy/mqHBRhDl5HqS1SJp2Ko3lcnpXeFResp0HNlt8NSu13vhC08j
+  GUHU9MyIXbFOsnp3K3ADrAVjPWop8EZkmUR3MV/CUm00w2cZHCSGiXl1KMpiVKvk
+  Ywr1gd2ZME4QLSo+EXUtLxDUa/W3xnBS8dBOuMMz02FPWYr3PN8CAwEAAaN7MHkw
+  CQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFAFgmv0tYMZnItuPycSM
+  F5wykJEVMB8GA1UdEQQYMBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMB8GA1UdEgQY
+  MBaBFGJyb29rZUBhbGNoZW1pc3RzLmlvMA0GCSqGSIb3DQEBCwUAA4IBgQAX+EGY
+  9RLYGxF1VLZz+G1ACQc4uyrCB6kXwI06kzUa5dF9tPXqTX9ffnz3/W8ck2IQhKzu
+  MKO2FVijzbDWTsZeZGglS4E+4Jxpau1lU9HhOIcKolv6LeC6UdALTFudY+GLb8Xw
+  REXgaJkjzzhkUSILmEnRwEbY08dVSl7ZAaxVI679vfI2yapLlIwpbBgmQTiTvPr3
+  qyyLUno9flYEOv9fmGHunSrM+gE0/0niGTXa5GgXBXYGS2he4LQGgSBfGp/cTwMU
+  rDKJRcusZ12lNBeDfgqACz/BBJF8FLodgk6rGMRZz7+ZmjjHEmpG5bQpR6Q2BuWL
+  XMtYk/QzaWuhiR7pWjiF8jbdd7RO6or0ohq7iFkokz/5xrtQ/vPzU2RQ3Qc6YaKw
+  3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
+  gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
+  -----END CERTIFICATE-----
+date: 2023-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  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: infusible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: tone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description:
+email:
+- brooke@alchemists.io
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.adoc
+- LICENSE.adoc
+files:
+- LICENSE.adoc
+- README.adoc
+- lib/sod.rb
+- lib/sod/action.rb
+- lib/sod/command.rb
+- lib/sod/container.rb
+- lib/sod/context.rb
+- lib/sod/error.rb
+- lib/sod/graph/loader.rb
+- lib/sod/graph/node.rb
+- lib/sod/graph/runner.rb
+- lib/sod/import.rb
+- lib/sod/models/action.rb
+- lib/sod/models/command.rb
+- lib/sod/prefabs/actions/config/create.rb
+- lib/sod/prefabs/actions/config/delete.rb
+- lib/sod/prefabs/actions/config/edit.rb
+- lib/sod/prefabs/actions/config/view.rb
+- lib/sod/prefabs/actions/help.rb
+- lib/sod/prefabs/actions/version.rb
+- lib/sod/prefabs/commands/config.rb
+- lib/sod/presenters/action.rb
+- lib/sod/presenters/node.rb
+- lib/sod/refines/option_parsers.rb
+- lib/sod/shell.rb
+- lib/sod/types/pathname.rb
+- sod.gemspec
+homepage: https://alchemists.io/projects/sod
+licenses:
+- Hippocratic-2.1
+metadata:
+  bug_tracker_uri: https://github.com/bkuhlmann/sod/issues
+  changelog_uri: https://alchemists.io/projects/sod/versions
+  documentation_uri: https://alchemists.io/projects/sod
+  funding_uri: https://github.com/sponsors/bkuhlmann
+  label: Sod
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/bkuhlmann/sod
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.14
+signing_key:
+specification_version: 4
+summary: A Domain Specific Language for creating composable Command Line Interfaces.
+test_files: []