fuelcell 0.1.0

data/lib/fuelcell/shell.rb

@@ -0,0 +1,102 @@
+module Fuelcell
+  class Shell
+    extend  Forwardable
+
+    SUCCESS_EXIT_CODE      = 0
+    ERROR_EXIT_CODE        = 255
+    DEFAULT_TERMINAL_WIDTH = 80
+
+    attr_reader :output_stream, :error_stream, :input_stream, :backtrace
+    alias_method :backtrace?, :backtrace
+    delegate puts: :output_stream
+
+    def initialize(config = {})
+      @output_stream  = config[:output_stream] || $stdout
+      @input_stream   = config[:input_stream] || $stdin
+      @error_stream   = config[:error_stream] || $stderr
+      @backtrace      = config[:backtrace] || false
+      @terminal_cols  = config[:terminal_cols]
+      @backtrace      = @backtrace == true ? true : false
+    end
+
+    def enable_backtrace
+      @backtrace = true
+    end
+
+    def disable_backtrace
+      @backtrace = false
+    end
+
+    def error(text)
+      error_stream.puts text
+    end
+
+    def exception(e)
+      message = e.message
+      message << "\n" << e.backtrace.join("\n") if backtrace?
+      error(message)
+      failure_exit
+    end
+
+    def terminal_width
+      if ENV['FUELCELL_COLUMNS']
+        result = ENV['FUELCELL_COLUMNS'].to_i
+      elsif @terminal_cols
+        result = @terminal_cols.to_i
+      else
+        result = unix? ? dynamic_width : DEFAULT_TERMINAL_WIDTH
+      end
+
+      result < 10 ? DEFAULT_TERMINAL_WIDTH : result
+    rescue
+      DEFAULT_TERMINAL_WIDTH
+    end
+
+    # Determine the width using stty or tput
+    #
+    # credit goes to the rake project, I took this from the application.rb
+    # @return Integer
+    def dynamic_width
+      @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
+    end
+
+    # Determines if we are on a unix like system for determining the width
+    # of the terminal
+    #
+    # credit goes to the rake project, I took this from the application.rb
+    #
+    # @return Boolean
+    def unix?
+      !(
+        RUBY_PLATFORM =~
+        /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
+      ).nil?
+    end
+
+    # credit goes to the rake project, I took this from the application.rb
+    #
+    # @return Integer
+    def dynamic_width_stty
+      `stty size 2>/dev/null`.split[1].to_i
+    end
+
+    # credit goes to the rake project, I took this from the application.rb
+    #
+    # @return Integer
+    def dynamic_width_tput
+      `tput cols 2>/dev/null`.to_i
+    end
+
+    def successful_exit
+      exit(SUCCESS_EXIT_CODE)
+    end
+
+    def failure_exit
+      exit(ERROR_EXIT_CODE)
+    end
+
+    def exit(code)
+      Kernel.exit(code)
+    end
+  end
+end

data/lib/fuelcell/version.rb

@@ -0,0 +1,3 @@
+module Fuelcell
+  VERSION = "0.1.0"
+end

data/lib/fuelcell.rb

@@ -0,0 +1,114 @@
+require 'forwardable'
+require 'fuelcell/version'
+require 'fuelcell/cli'
+
+# Exposes Fuelcell's main interface. You can describe a complete command
+# heirarchy, and start the processing/execution of a command all at the
+# same time using Fuelcell.start. Fuelcell.define allows you to describe
+# a command heirarchy using separate files. The cli interfaces are needed
+# when :start & :define are used togather, allowing :define to access the
+# root command
+module Fuelcell
+  class << self
+    # Assigning the cli represents the current execution context for which
+    # commandline processing takes place. This is triggered by the :start
+    # method and is needed to allow the :define method to work in a separate
+    # file the was required by the script using :start
+    #
+    # The alias :make_cli_available_for_definitions is ment to describe the
+    # intent of the :start method
+    attr_accessor :cli
+    alias_method :make_cli_available_for_definitions, :cli=
+
+    def cli?
+      ! @cli.nil?
+    end
+
+    # The current execution context
+    #
+    # @return [Fuelcell::Cli]
+
+    # Remove the cli object & replace it with nil. The general case for this
+    # is in the :start method when no more command definition will be
+    # processed. Since we don't know for sure how long we will be in memory
+    # we clean up whats not used
+    #
+    # The alias :remove_cli_availability is an attempt to improve intent of
+    # the :start method
+    #
+    # @return [Nil]
+    def remove_cli
+      @cli = nil
+    end
+    alias_method :remove_cli_availability, :remove_cli
+
+    # Allows definitions to be created in a separate file and have them included
+    # by load/require in the start block.
+    #
+    # @param name [String] name of the command to be defined
+    # @yield instance_eval into the root command
+    def define(name, &block)
+      name = name.to_s
+      if name.empty?
+        fail ArgumentError, 'command name can not be empty'
+      end
+
+      unless cli?
+        fail RuntimeError, 'cli interface does not exist, please use ' \
+                           'Fuelcell.start before Fuelcell.define'
+      end
+
+      root = cli.root
+      cmd_args = name.split(' ')
+      root.ensure_command_hierarchy(cmd_args)
+      cmd = root[name]
+      cmd.instance_eval(&block)
+    end
+
+    # Allows for the configuration of the Cli object which controls
+    # command line processing.
+    #
+    # @param settings [Hash]
+    #   root_name:     used to override the default script name
+    #   root_cmd:      override the RootCommand object with your own
+    #   shell:         override the Shell object with your own
+    #   backtrace:     causes backtraces to be printed to error stream
+    #   output_stream: override $stdout as the output stream
+    #   input_stream:  override $stdin as the input stream
+    #   error_stream:  override $stderr as the error stream
+    #   exit:          cause fuelcell not to explicitly exit,  use false
+    #   parser:        override opt & args parsing
+    #   cmd_args_extractor: override command extraction strategy
+    #
+    # @return [Fuelcell::Cli]
+    def create_cli(settings = {})
+      root_name = settings[:root_name]
+      root_cmd  = settings.fetch(:root_cmd) { Action::Root.new(root_name) }
+      shell     = settings.fetch(:shell) { Shell.new(settings) }
+      Cli.new(root: root_cmd, shell: shell)
+    end
+
+    # Entry point for executing a command which was defined through the
+    # the fuelcell dsl. The executable command should return an exit code,
+    # used to exit the program.
+    #
+    # @param args [Array] command line args to be processed
+    # @param settings [Hash] allows for overriding parts of fuelcell
+    # @yield optional block, will instance_eval on the root command
+    # @return [Int]
+    def start(args = [], settings = {}, &block)
+      cli  = settings[:cli] || create_cli(settings)
+      root = cli.root
+
+      make_cli_available_for_definitions(cli)
+
+      # expose the command dsl
+      root.instance_eval(&block) if block_given?
+      context = cli.parse(args)
+
+      remove_cli_availability
+      code = cli.execute(context)
+      cli.handle_exit code
+    end
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fuelcell
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Scott-Buccleuch
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+description: framework which simplifies working with the command-line.
+email:
+- rsb.code@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .codeclimate.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/example.rb
+- bin/setup
+- bin/test
+- bin/world.rb
+- fuelcell.gemspec
+- lib/fuelcell.rb
+- lib/fuelcell/action.rb
+- lib/fuelcell/action/arg_definition.rb
+- lib/fuelcell/action/arg_results.rb
+- lib/fuelcell/action/args_manager.rb
+- lib/fuelcell/action/callable.rb
+- lib/fuelcell/action/command.rb
+- lib/fuelcell/action/not_found.rb
+- lib/fuelcell/action/opt_definition.rb
+- lib/fuelcell/action/opt_results.rb
+- lib/fuelcell/action/opts_manager.rb
+- lib/fuelcell/action/root.rb
+- lib/fuelcell/action/subcommands.rb
+- lib/fuelcell/cli.rb
+- lib/fuelcell/help.rb
+- lib/fuelcell/help/base_formatter.rb
+- lib/fuelcell/help/builder.rb
+- lib/fuelcell/help/cmds_formatter.rb
+- lib/fuelcell/help/desc_formatter.rb
+- lib/fuelcell/help/opts_formatter.rb
+- lib/fuelcell/help/usage_formatter.rb
+- lib/fuelcell/parser.rb
+- lib/fuelcell/parser/arg_handler.rb
+- lib/fuelcell/parser/base_handler.rb
+- lib/fuelcell/parser/cmd_args_strategy.rb
+- lib/fuelcell/parser/ignore_handler.rb
+- lib/fuelcell/parser/opt_handler.rb
+- lib/fuelcell/parser/opt_name_handler.rb
+- lib/fuelcell/parser/opt_value_equal_handler.rb
+- lib/fuelcell/parser/parsing_strategy.rb
+- lib/fuelcell/parser/short_opt_no_space_handler.rb
+- lib/fuelcell/shell.rb
+- lib/fuelcell/version.rb
+homepage: https://github.com/rsb/fuelcell
+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.4.5
+signing_key: 
+specification_version: 4
+summary: framework which simplifies working with the command-line.
+test_files: []