cliqr 1.2.0 → 2.0.0

data/lib/cliqr/config_validation/verifiable.rb

@@ -1,89 +0,0 @@
-# encoding: utf-8
-
-require 'cliqr/config_validation/validator_factory'
-require 'cliqr/config_validation/validation_set'
-require 'cliqr/validation_errors'
-
-module Cliqr
-  # Validation framework for the command line interface config definition adopted from
-  # lotus/validations by @jodosha
-  #
-  # @api private
-  #
-  # @see https://github.com/lotus/validations
-  module ConfigValidation
-    # If a class includes this module, we add a few useful methods to that class
-    #
-    # @see http://www.ruby-doc.org/core/Module.html#method-i-included
-    #
-    # @return [Object]
-    def self.included(base)
-      base.class_eval do
-        extend Verifiable
-      end
-    end
-
-    # Check if the class is valid based on the configured attribute validations
-    #
-    # @return [Boolean] <tt>true</tt> if there are no validation errors
-    def valid?
-      validate
-
-      errors.empty?
-    end
-
-    # Run the validation against all attribute values
-    #
-    # @return [Hash] All validated attributed attributes and their values
-    def validate
-      read_attributes.each do |name, value|
-        validations.validate(name, value, errors)
-      end
-    end
-
-    # Get the list of validations to be performed
-    #
-    # @return [Hash] A hash of attribute name to its validator
-    def validations
-      self.class.__send__(:validations)
-    end
-
-    # Read current values for all attributes that must be validated
-    #
-    # @return [Hash] All attributes that must be validated along with their current values
-    def read_attributes
-      {}.tap do |attributes|
-        validations.each_key do |attribute|
-          attributes[attribute] = public_send(attribute)
-        end
-      end
-    end
-
-    # Get a list of errors after validation finishes
-    #
-    # @return [Cliqr::ValidationErrors] A wrapper of all errors
-    def errors
-      @errors ||= ValidationErrors.new
-    end
-
-    # Validations DSL
-    module Verifiable
-      # Add a new validation for a attribute
-      #
-      # @param [Symbol] name Name of the attribute to validate
-      # @param [Object] options Configuration to initialize a attribute validator with
-      #
-      # @return [Cliqr::Validation::ValidationSet] A wrapper of all validations configured so far
-      def validates(name, options)
-        validations.add(name, options)
-      end
-
-      # Get or create a new <tt>Cliqr::Validation::ValidationSet</tt>
-      #
-      # @return [Cliqr::Validation::ValidationSet]
-      def validations
-        @validations ||= ValidationSet.new
-      end
-    end
-  end
-end

data/lib/cliqr/dsl.rb

@@ -1,59 +0,0 @@
-# encoding: utf-8
-
-require 'delegate'
-
-module Cliqr
-  # Used to separate all dsl methods in a separate block, thus allowing
-  # separation of concerns between non-dsl methods with dsl methods which
-  # improves maintainability.
-  #
-  # @api private
-  module DSL
-    # Entry point for invoking dsl methods
-    #
-    # @param [Hash] args Arguments to be used to build the DSL instance
-    #
-    # @param [Function] block The block to evaluate the DSL
-    #
-    # @return [Cliqr::DSL]
-    def build(*args, &block)
-      base = new(*args)
-      if block_given?
-        delegator = DSLDelegator.new(base)
-        delegator.instance_eval(&block)
-      end
-      base.finalize
-      base
-    end
-
-    # Delegates all DSL methods to the base class. Can be used to keep DSL
-    # methods separate from non-dsl methods. All implementing subclasses will
-    # have to implement a set_config method as described below
-    #
-    #     class MyDSLClass
-    #       extends Cliqr::DSL
-    #
-    #       def set_config(name, value, &block)
-    #         # handle config value for attribute "name"
-    #       end
-    #     end
-    #
-    # This will be invoked as:
-    #
-    #     MyDSLClass.build do
-    #       attribute 'some-value'
-    #     end
-    class DSLDelegator < SimpleDelegator
-      # All dsl methods are handled dynamically by proxying through #set_config
-      #
-      # @param [Symbol] name Name of the method
-      # @param [Array] args Method arguments
-      # @param [Function] block A function to evaluate in the context of the method's arguments
-      #
-      # @return [Object] The return value of the proxied method
-      def method_missing(name, *args, &block)
-        __getobj__.set_config name, args[0], &block
-      end
-    end
-  end
-end

data/spec/executor/shell_executor_spec.rb

@@ -1,233 +0,0 @@
-# encoding: utf-8
-
-require 'spec_helper'
-
-require 'fixtures/test_command'
-
-describe Cliqr::CLI::Executor do
-  it 'can execute help in command shell' do
-    cli = Cliqr.interface do
-      name 'my-command'
-      handler TestCommand
-
-      action :bla
-    end
-
-    with_input(['help']) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
-my-command > help.
-my-command
-
-USAGE:
-    my-command [actions] [options] [arguments]
-
-Available options:
-
-    --help, -h  :  Get helpful information for action "my-command" along with its usage information.
-
-Available actions:
-[ Type "my-command help [action-name]" to get more information about that action ]
-
-    bla
-
-    shell -- Execute a shell in the context of "my-command" command.
-
-    help -- The help action for command "my-command" which provides details and usage information on how to use the command.
-my-command > exit.
-shell exited with code 0
-      EOS
-    end
-  end
-
-  it 'can execute a sub action from shell' do
-    cli = Cliqr.interface do
-      name 'my-command'
-      handler do
-        puts 'base command executed'
-      end
-
-      action :foo do
-        handler do
-          puts 'foo executed'
-        end
-
-        action :bar do
-          handler do
-            puts 'bar executed'
-          end
-        end
-      end
-    end
-
-    with_input(['', 'my-command', 'foo', 'foo bar', 'foo bar help']) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
-my-command > .
-base command executed
-my-command > my-command.
-base command executed
-my-command > foo.
-foo executed
-my-command > foo bar.
-bar executed
-my-command > foo bar help.
-my-command foo bar
-
-USAGE:
-    my-command foo bar [actions] [options] [arguments]
-
-Available options:
-
-    --help, -h  :  Get helpful information for action "my-command foo bar" along with its usage information.
-
-Available actions:
-[ Type "my-command foo bar help [action-name]" to get more information about that action ]
-
-    help -- The help action for command "my-command foo bar" which provides details and usage information on how to use the command.
-my-command > exit.
-shell exited with code 0
-      EOS
-    end
-  end
-
-  it 'does not allow shell action if shell config is disabled' do
-    cli = Cliqr.interface do
-      name 'my-command'
-      shell :disable
-      arguments :disable
-    end
-    expect { cli.execute_internal %w(my-command shell) }.to(
-      raise_error(Cliqr::Error::IllegalArgumentError, 'invalid command argument "shell"'))
-  end
-
-  it 'can handle errors in shell' do
-    cli = Cliqr.interface do
-      name 'my-command'
-      handler TestCommand
-      arguments :disable
-
-      action :foo do
-        handler do
-          fail StandardError, 'I failed!'
-        end
-
-        action :bar do
-          handler TestCommand
-        end
-      end
-    end
-
-    with_input(['unknown', '--opt-1 val', 'foo']) do
-      result = cli.execute_internal %w(my-command shell), output: :buffer
-      expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
-my-command > unknown.
-invalid command argument "unknown"
-my-command > --opt-1 val.
-unknown option "--opt-1"
-my-command > foo.
-command 'my-command foo' failed
-
-Cause: StandardError - I failed!
-my-command > exit.
-shell exited with code 0
-      EOS
-    end
-  end
-
-  describe 'illegal shell operations' do
-    it 'does not allow shell action if there are no sub-actions' do
-      cli = Cliqr.interface do
-        name 'my-command'
-        help :disable
-        handler TestCommand
-        arguments :disable
-      end
-      expect { cli.execute_internal %w(my-command shell) }.to(
-        raise_error(Cliqr::Error::IllegalArgumentError, 'invalid command argument "shell"'))
-    end
-
-    it 'does not allow shell in shell for base command' do
-      cli = Cliqr.interface do
-        name 'my-command'
-
-        action :foo do
-          action :bar
-        end
-      end
-
-      with_input(['shell']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
-my-command > shell.
-command 'my-command shell' failed
-
-Cause: Cliqr::Error::IllegalCommandError - Cannot run another shell within an already running shell
-my-command > exit.
-shell exited with code 0
-        EOS
-      end
-    end
-
-    it 'does not allow shell in shell for sub action' do
-      cli = Cliqr.interface do
-        name 'my-command'
-
-        action :foo do
-          action :bar
-        end
-      end
-
-      with_input(['shell']) do
-        result = cli.execute_internal %w(my-command foo shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command foo"
-my-command foo > shell.
-command 'my-command foo shell' failed
-
-Cause: Cliqr::Error::IllegalCommandError - Cannot run another shell within an already running shell
-my-command foo > exit.
-shell exited with code 0
-        EOS
-      end
-
-      with_input(['foo shell']) do
-        result = cli.execute_internal %w(my-command shell), output: :buffer
-        expect(result[:stdout]).to eq <<-EOS
-Starting shell for command "my-command"
-my-command > foo shell.
-command 'my-command foo shell' failed
-
-Cause: Cliqr::Error::IllegalCommandError - Cannot run another shell within an already running shell
-my-command > exit.
-shell exited with code 0
-        EOS
-      end
-    end
-  end
-end
-
-def with_input(lines, &block)
-  old_stdin = $stdin
-  $stdin = TestIO.new(lines)
-  block.call
-ensure
-  $stdin = old_stdin
-end
-
-# A test class for wrapping stdin
-class TestIO
-  def initialize(lines)
-    @lines = lines.reverse
-  end
-
-  def gets
-    input = "#{@lines.length > 0 ? @lines.pop : 'exit'}"
-    puts "#{input}."
-    "#{input}\n"
-  end
-end

data/templates/usage.erb

@@ -1,39 +0,0 @@
-<%= command %><% unless description.nil? || description.empty? %> -- <%= description %><% end %>
-
-USAGE:
-    <%= command %><%=
-    ' [actions]' if actions? %><%=
-    ' [options]' if options? %><%=
-    ' [arguments]' if arguments? %><%
-
-if options? %>
-
-Available options:
-<%
-   options.each { |option|
-%>
-    --<%=
-         '[no-]' if option.boolean?
-       %><%=
-         option.name
-       %><%=
-            ", -#{option.short}" if option.short?
-          %><%=
-            if option.details?
-              "  : #{" <#{option.type}>" if option.type?}#{" #{option.description}" if option.description?}#{" (default => #{option.default.inspect})" if option.default?}"
-            end
-          %><%
-   }
-end
-
-if actions? %>
-
-Available actions:
-<%= "[ Type \"#{command} help [action-name]\" to get more information about that action ]\n" if help? %><%
-   actions.each { |action|
-%>
-    <%= action.name %><%= " -- #{action.description}" if action.description? %>
-<%
-   }
-%>
-<% end %>