cli_spinnable 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b57d77c25a5bb808706cb92487a5877fa2c32121
+  data.tar.gz: f59c00a22d6b5958b6a2183f10fbd6a1728ffa11
+SHA512:
+  metadata.gz: 64cd82f07433483e87807de0268ceec2cb175f129b5adacad2d4bea007c09b8d4c72230b0434d312361db7de0a5bd2085337e1d8a496a5d3d454b78080bb03d8
+  data.tar.gz: 0b77ed47dde390e9977b9549c9ee200eb9b7a2c4c924e698366e36ccb07943437e2103fe12d236cd0421d095901eefb7cb1a6c7681a6ec53404e7e84c0565cf6

data/.codeclimate.yml

@@ -0,0 +1,17 @@
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - "**.rb"
+  exclude_paths:
+    - spec/
+exclude_paths:
+  - "examples/*.rb"

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  TargetRubyVersion: 2.1
+
+AllCops:
+  Exclude:
+    - 'examples/*.rb'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/ParallelAssignment:
+  Enabled: false
+
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,9 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+env:
+  global:
+    CODECLIMATE_REPO_TOKEN: 878aaba630e5c7040aa3d3b0fc0cab946ac392cbf00ca59f1540e6b30017e84e
+before_install: gem install bundler -v 1.13.3
+after_success: codeclimate-test-reporter

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at krzysztof.maicher@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cli_spinnable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Krzysztof Maicher
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# CliSpinnable
+
+[![Gem Version](https://badge.fury.io/rb/cli_spinnable.svg)](https://badge.fury.io/rb/cli_spinnable)
+[![Build Status](https://travis-ci.org/maicher/cli_spinnable.svg?branch=master)](https://travis-ci.org/maicher/cli_spinnable)
+[![Code Climate](https://codeclimate.com/github/maicher/cli_spinnable/badges/gpa.svg)](https://codeclimate.com/github/maicher/cli_spinnable)
+[![Test Coverage](https://codeclimate.com/github/maicher/cli_spinnable/badges/coverage.svg)](https://codeclimate.com/github/maicher/cli_spinnable/coverage)
+
+CliSpinnable, a module that enriches ruby command line interface with rotating spinner, check mark (✓) and and fail mark (×).
+
+## Dependencies
+
+  * Ruby >= 2.1
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli_spinnable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cli_spinnable
+
+## How to use
+
+1. Mix-in CliSpinnable module into YourClass
+
+        class YourClass
+          include CliSpinnable
+        
+2. Call `with_spinner` inside `your_method` providing a block         
+        
+          def your_method
+            with_spinner do |cli|
+              # ...
+            end
+          end
+
+3. Use `#print` and `#tick` methods
+        
+        with_spinner do |cli|
+          cli.print 'Downloading something'
+          sleep 1 # some long operation
+          cli.print '...downloaded 1MB'
+          cli.tick
+          cli.print 'Processing data'
+          sleep 1 # other long operation
+          cli.tick
+        end
+        
+4. If operation will fail (exception raised within the block), × will be printed
+
+        with_spinner do |cli|
+          cli.print 'Trying to do something that can fail'
+          1 / 0 # raise Error
+          cli.tick # you will not see the tick
+        end
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/maicher/cli_spinnable. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cli_spinnable'
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cli_spinner.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli_spinnable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cli_spinnable'
+  spec.version       = CliSpinnable::VERSION
+  spec.authors       = ['Krzysztof Maicher']
+  spec.email         = ['krzysztof.maicher@gmail.com']
+
+  spec.summary       = 'CliSpinnable, a module that enriches ruby command line interface'
+  spec.summary      += ' with rotating spinner, check mark (✓) and and fail mark (×).'
+  spec.description   = 'CliSpinnable, a module that enriches ruby command line interface'
+  spec.description  += ' with rotating spinner, check mark (✓) and and fail mark (×).'
+  spec.homepage      = 'https://github.com/maicher/cli_spinnable'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rubocop', '~> 0.44'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'simplecov', '~> 0.12'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+end

data/examples/example1.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'cli_spinnable'
+
+class Foo
+  include CliSpinnable
+
+  def call
+    puts 'HAPPY RUN (ending with success):'
+    with_spinner do |cli|
+      cli.print 'Downloading something'
+      sleep 1
+      cli.print '...downloaded 1MB'
+      cli.tick
+      cli.print 'Processing data'
+      sleep 1
+      cli.tick
+    end
+
+    puts 'SAD RUN (ending with fail):'
+    with_spinner do |cli|
+      cli.print 'Downloading something'
+      sleep 1
+      cli.print '...downloaded 1MB'
+      cli.tick
+      cli.print 'Processing data'
+      sleep 1
+      1 / 0
+      cli.tick
+    end
+  end
+end
+
+Foo.new.call

data/examples/example2.rb

@@ -0,0 +1,30 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'cli_spinnable'
+
+module Foo
+  extend CliSpinnable
+end
+
+puts 'HAPPY RUN (ending with success):'
+Foo.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.print '...downloaded 1MB'
+  cli.tick
+  cli.print 'Processing data'
+  sleep 1
+  cli.tick
+end
+
+puts 'SAD RUN (ending with fail):'
+Foo.with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.print '...downloaded 1MB'
+  cli.tick
+  cli.print 'Processing data'
+  sleep 1
+  1 / 0
+  cli.tick
+end

data/examples/example3.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'cli_spinnable'
+
+include CliSpinnable
+
+puts 'HAPPY RUN (ending with success):'
+with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.print '...downloaded 1MB'
+  cli.tick
+  cli.print 'Processing data'
+  sleep 1
+  cli.tick
+end
+
+puts 'SAD RUN (ending with fail):'
+with_spinner do |cli|
+  cli.print 'Downloading something'
+  sleep 1
+  cli.print '...downloaded 1MB'
+  cli.tick
+  cli.print 'Processing data'
+  sleep 1
+  1 / 0
+  cli.tick
+end

data/lib/cli_spinnable.rb

@@ -0,0 +1,21 @@
+require 'cli_spinnable/version'
+require 'cli_spinnable/cli_spinnable_error'
+require 'cli_spinnable/line/colourable_string'
+require 'cli_spinnable/line/sign'
+require 'cli_spinnable/line'
+require 'cli_spinnable/writer'
+
+module CliSpinnable
+  def with_spinner
+    writer = Writer.new(STDOUT, Line.new)
+    yield writer
+    writer.finalize
+    self
+  rescue CliSpinnableError => e
+    raise e
+  rescue StandardError => e
+    writer.failure
+    writer.finalize
+    raise e
+  end
+end

data/lib/cli_spinnable/cli_spinnable_error.rb

@@ -0,0 +1,3 @@
+module CliSpinnable
+  class CliSpinnableError < StandardError; end
+end

data/lib/cli_spinnable/line.rb

@@ -0,0 +1,47 @@
+module CliSpinnable
+  class Line
+    class Error < CliSpinnableError; end
+
+    CARRIAGE_RETURN = "\r".freeze
+    NEWLINE = "\n".freeze
+
+    attr_accessor :newline
+
+    def initialize(str = nil, sign = nil, newline = nil)
+      self.str = str
+      @sign = Sign.new(sign)
+      self.newline = newline
+    end
+
+    def sign=(sym)
+      sign.sign = sym
+    end
+
+    def <<(arg)
+      str << ensure_single_line(String(arg))
+    end
+
+    def str=(arg)
+      @str = ensure_single_line(String(arg))
+    end
+
+    def to_s_resetting_newline
+      [CARRIAGE_RETURN, sign, str, newline_with_reset].join
+    end
+
+    private
+
+    attr_reader :str, :sign
+
+    def ensure_single_line(str)
+      raise Error, 'Multiline strings not allowed' if str.include?(NEWLINE)
+      str
+    end
+
+    def newline_with_reset
+      return unless newline
+      self.newline = false
+      NEWLINE
+    end
+  end
+end

data/lib/cli_spinnable/line/colourable_string.rb

@@ -0,0 +1,15 @@
+module CliSpinnable
+  class Line
+    module ColourableString
+      refine String do
+        def red
+          "\e[31m#{self}\e[0m"
+        end
+
+        def green
+          "\e[0;32;49m#{self}\e[0m"
+        end
+      end
+    end
+  end
+end

data/lib/cli_spinnable/line/sign.rb

@@ -0,0 +1,58 @@
+module CliSpinnable
+  class Line
+    class Sign
+      using ColourableString
+
+      class Error < CliSpinnableError; end
+
+      SPIN = %w(- \\ | /).freeze
+      TICK = "\u2713".green.freeze
+      FAIL = "\u00d7".red.freeze
+      BLANK = ''.freeze
+
+      AVAILABLE_SIGNS = %i(spin tick fail blank).freeze
+
+      def initialize(sign = nil)
+        self.sign = sign || :blank
+      end
+
+      def sign=(sign)
+        raise Error, "Unavailable sign: #{sign || 'nil'}" unless AVAILABLE_SIGNS.include?(sign)
+        @sign = sign
+        self
+      end
+
+      def to_s
+        send(sign) + separator
+      end
+
+      private
+
+      attr_reader :sign
+
+      def separator
+        sign == :blank ? '' : ' '
+      end
+
+      def spin
+        spinner_enum.next
+      end
+
+      def tick
+        TICK
+      end
+
+      def fail
+        FAIL
+      end
+
+      def blank
+        BLANK
+      end
+
+      def spinner_enum
+        @spinner_enum ||= SPIN.cycle
+      end
+    end
+  end
+end

data/lib/cli_spinnable/version.rb

@@ -0,0 +1,3 @@
+module CliSpinnable
+  VERSION = '0.1'.freeze
+end

data/lib/cli_spinnable/writer.rb

@@ -0,0 +1,72 @@
+module CliSpinnable
+  class Writer
+    class Error < CliSpinnableError; end
+
+    REFRESH_DELAY_IN_SECONDS = 0.1
+
+    def initialize(output, line)
+      @output = output
+      @line = line
+      @queue = Queue.new
+      @session = start_session
+    end
+
+    def print(str)
+      push(:sign=, :spin)
+      push(:<<, str)
+      self
+    end
+
+    def tick
+      push(:sign=, :tick)
+      push(:newline=, true)
+      push(:str=, '')
+      self
+    end
+
+    def failure
+      push(:sign=, :fail)
+      push(:newline=, true)
+      self
+    end
+
+    def finalize
+      push(:sign=, :blank)
+      push(:str=, '')
+      finalize_session
+      self
+    end
+
+    private
+
+    attr_reader :output, :line, :queue, :session
+
+    def push(attr, val)
+      raise Error, 'Session finalized' unless session.status
+      queue.push([attr, val])
+    end
+
+    def start_session
+      Thread.new do
+        loop do
+          loop do
+            output.write reload_line.to_s_resetting_newline
+            break if queue.empty?
+          end
+          break if Thread.current[:finalize]
+          sleep REFRESH_DELAY_IN_SECONDS
+        end
+      end
+    end
+
+    def reload_line
+      line.public_send(*queue.pop) unless queue.empty?
+      line
+    end
+
+    def finalize_session
+      session[:finalize] = true
+      session.join
+    end
+  end
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: cli_spinnable
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Krzysztof Maicher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-17 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: CliSpinnable, a module that enriches ruby command line interface with
+  rotating spinner, check mark (✓) and and fail mark (×).
+email:
+- krzysztof.maicher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cli_spinner.gemspec
+- examples/example1.rb
+- examples/example2.rb
+- examples/example3.rb
+- lib/cli_spinnable.rb
+- lib/cli_spinnable/cli_spinnable_error.rb
+- lib/cli_spinnable/line.rb
+- lib/cli_spinnable/line/colourable_string.rb
+- lib/cli_spinnable/line/sign.rb
+- lib/cli_spinnable/version.rb
+- lib/cli_spinnable/writer.rb
+homepage: https://github.com/maicher/cli_spinnable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: CliSpinnable, a module that enriches ruby command line interface with rotating
+  spinner, check mark (✓) and and fail mark (×).
+test_files: []