Contents

module Pantograph
  module Actions
    class PutsAction < Action
      def self.run(params)
        # display text from the message param
        # if called like `puts 'hi'` then params won't be a configuration item, so we have to check
        if params.kind_of?(PantographCore::Configuration) && params[:message]
          UI.message(params[:message])
          return
        end

        # no parameter included in the call means treat this like a normal pantograph ruby call
        UI.message(params.join(' '))
      end

      #####################################################
      # @!group Documentation
      #####################################################

      def self.description
        "Prints out the given text"
      end

      def self.available_options
        [
          PantographCore::ConfigItem.new(key: :message,
                                       env_name: 'PUTS_MESSAGE',
                                       description: 'Message to be printed out',
                                       optional: true,
                                       is_string: true)
        ]
      end

      def self.authors
        ['KrauseFx']
      end

      def self.is_supported?(platform)
        true
      end

      def self.alias_used(action_alias, params)
        if !params.kind_of?(PantographCore::Configuration) || params[:message].nil?
          UI.important("#{action_alias} called, please use 'puts' instead!")
        end
      end

      def self.aliases
        ["println", "echo"]
      end

      # We don't want to show this as step
      def self.step_text
        nil
      end

      def self.example_code
        [
          'puts "Hi there"'
        ]
      end

      def self.category
        :misc
      end
    end
  end
end

Version data entries

7 entries across 7 versions & 1 rubygems

Version	Path
pantograph-0.1.8	pantograph/lib/pantograph/actions/puts.rb
pantograph-0.1.7	pantograph/lib/pantograph/actions/puts.rb
pantograph-0.1.6	pantograph/lib/pantograph/actions/puts.rb
pantograph-0.1.4	pantograph/lib/pantograph/actions/puts.rb
pantograph-0.1.3	pantograph/lib/pantograph/actions/puts.rb
pantograph-0.1.1	pantograph/lib/pantograph/actions/puts.rb
pantograph-0.1.0	pantograph/lib/pantograph/actions/puts.rb