Sha256: 1ebfb5ccc23a04e1755667f7fd8d8aa0bd2f309ce8cde7e5483dc09de1f8b639

Contents?: true

Size: 1.96 KB

Versions: 1

Compression:

Stored size: 1.96 KB

Contents

################################################################################
#
#      Author: Zachary Patten <zachary@jovelabs.net>
#   Copyright: Copyright (c) Jove Labs
#     License: Apache License, Version 2.0
#
#   Licensed under the Apache License, Version 2.0 (the "License");
#   you may not use this file except in compliance with the License.
#   You may obtain a copy of the License at
#
#       http://www.apache.org/licenses/LICENSE-2.0
#
#   Unless required by applicable law or agreed to in writing, software
#   distributed under the License is distributed on an "AS IS" BASIS,
#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
#   See the License for the specific language governing permissions and
#   limitations under the License.
#
################################################################################

require "ostruct"

module ZTK

  # ZTK::Spinner Error Class
  #
  # @author Zachary Patten <zachary@jovelabs.net>
  # @author Stephen Nelson-Smith <stephen@atalanta-systems.com>
  class SpinnerError < Error; end

  # Spinner Class
  #
  # @author Zachary Patten <zachary@jovelabs.net>
  # @author Stephen Nelson-Smith <stephen@atalanta-systems.com>
  class Spinner

    class << self

      def spin(options={}, &block)
        options = Base.build_config({
          :sleep => 0.1
        }.merge(options))
        options.logger.debug { "options(#{options.inspect})" }

        !block_given? and Base.log_and_raise(options.logger, SpinnerError, "You must supply a block!")

        charset = %w( | / - \\ )
        count = 0
        spinner = Thread.new do
          while count do
            options.stdout.print(charset[(count += 1) % charset.length])
            options.stdout.print("\b")
            options.stdout.respond_to?(:flush) and options.stdout.flush
            sleep(options.sleep)
          end
        end
        yield.tap do
          count = false
          spinner.join
        end
      end

    end

  end

end

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
ztk-0.2.5 lib/ztk/spinner.rb