sphyg 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c97ec87a49cef9bac4b9d5fd41be9db71995a06e
-  data.tar.gz: 64be64fdc27bba014e901a948fd218ec76bac448
+  metadata.gz: 2d139d42bad771622c37cfacb62a29d436c0d4ca
+  data.tar.gz: 2e0a4741929467bc81a0216e9578cce7f56d533d
 SHA512:
-  metadata.gz: ad1a1018342b045cdef23c65295a8aa0ac9edbac22d2f6ce4e1317bb822ba870009e2d0cd2a71d1062f915dad91fe96309a936c6227cfb3be621031b2fd4d33d
-  data.tar.gz: cbef5bbe68f0816275ad3b7bf70107701afd10af1dc94c999345b02519c7f8969e96844fba7f221de8ec676ab7ad8a4253fcacc102e724f10a481156303b184f
+  metadata.gz: b9bf2ce0dc8b57af61a92585869ebdb8d43c9c821d1e837bf289afd8c376169638bb21db308672a93360416fc3aece3131f242344bc71922afa5d1079981c31b
+  data.tar.gz: 9ef9703521fd6782993c7f10da5a40e7a425bd5b1c9a98be460c545515b19ea8214fb11f3c1b9864345e296243cfd2271d040f19bda726ae08c5968a49641bb6

data/.gitignore

@@ -9,3 +9,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Layout/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# The trailing style can be copy-and-pasted into a console
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*

data/CHANGELOG.md

@@ -14,6 +14,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Fixed
 - None
 
+## 0.3.0 (2018-01-01)
+### Added
+-  API for configuring custom throbbers
+
+### Changed
+- None
+
+### Fixed
+- None
+
 ## 0.2.1 (2017-12-30)
 ### Added
 - None

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in throbber.gemspec
 gemspec

data/Gemfile.lock

@@ -1,12 +1,18 @@
 PATH
   remote: .
   specs:
-    sphyg (0.2.1)
+    sphyg (0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.3.0)
     diff-lcs (1.3)
+    parallel (1.12.1)
+    parser (2.4.0.2)
+      ast (~> 2.3)
+    powerpack (0.1.1)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -21,6 +27,15 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.0)
+    rubocop (0.52.1)
+      parallel (~> 1.10)
+      parser (>= 2.4.0.2, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    unicode-display_width (1.3.0)
 
 PLATFORMS
   ruby
@@ -29,6 +44,7 @@ DEPENDENCIES
   bundler (~> 1.16)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 0.52.0)
   sphyg!
 
 BUNDLED WITH

data/README.md

@@ -1,7 +1,8 @@
 # Sphyg
 
-'Sphygmos' is the Greek word for 'pulse'. Sphyg provides [throbbers](https://en.wikipedia.org/wiki/Throbber)
-to indicate that your long-running command line program still has a pulse.
+'Sphygmos' is the Greek word for 'pulse'. Sphyg provides an interface for
+creating [throbbers](https://en.wikipedia.org/wiki/Throbber) to indicate that
+your long-running command line program still has a pulse.
 
 ## Installation
 
@@ -31,7 +32,10 @@ Please wait ⡀ ⠄ ⠂ ⠁ ⠂ ⠄ # animated
 
 ### Options
 
-You can also pass an _options_ hash to `::Sphyg.pulse` using the following keys:
+You can also pass an _options_ hash to `::Sphyg.pulse` to customize the displayed
+throbber. A throbber consists of an array of _frames_, an _enumerator_, and a
+_rate_. The following are built-in throbbers. You may use the `:kind` key to 
+choose a built-in throbber, or utilize `::Sphyg::THROBBERS` to configure them.
 
 #### `:kind`
 
@@ -47,10 +51,40 @@ Configure which kind of throbber you would like to use. Available kinds and thei
 | `:time` | 🕛 🕐 🕒 🕓 🕔 🕕 🕖 🕗 🕘 🕙 🕚 |
 | `:wave` | ⡀ ⠄ ⠂ ⠁ ⠂ ⠄ |
 
+#### `:frames`
+
+An array of glyphs from which to choose to display.
+
+#### `:enumerator`
+
+The string name of an object that is used to generate successive frames
+to display. Must respond to `#next`. For example:
+
+```ruby
+Randomizer = Struct.new(:frames) { def next; frames.sample; end }
+options = {
+  frames: %w[a b c],
+  enumerator: 'Randomizer',
+  rate: 0.1
+}
+> Sphyg.pulse('Please wait', options) { sleep }
+Please wait a # Will display a random value from `frames` every 0.1 seconds alongside the message
+
+```
+
+See [`Sphyg::Enumerators`](lib/sphyg/enumerators) for more examples.
+
+#### `:rate`
+
+An `Integer` or `Float` representing the 'frame' rate of the throbber in 
+seconds. Sphyg will cycle through the enumerator at this value.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
+Run `bundle exec rake` to lint and run tests.
+
 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

data/Rakefile

@@ -1,6 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.verbose = false
+end
 
-task :default => :spec
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "sphyg"
+require 'bundler/setup'
+require 'sphyg'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "sphyg"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/lib/sphyg.rb

@@ -1,7 +1,53 @@
-require "sphyg/pulse"
-require "sphyg/version"
+require 'sphyg/pulse'
+require 'sphyg/version'
 
+# Top-level namespace
 module Sphyg
+  THROBBERS = {
+    ascii: {
+      enumerator: '::Sphyg::Enumerators::Cycle',
+      frames: %w[| / - \\],
+      rate: 0.1
+    },
+    elipsis: {
+      enumerator: '::Sphyg::Enumerators::Cycle',
+      frames: %w[. .. ... ..],
+      rate: 0.2
+    },
+    heart: {
+      enumerator: '::Sphyg::Enumerators::Cycle',
+      frames: %w[🧡 💛 💚 💙 💜],
+      rate: 0.1
+    },
+    heroku: {
+      enumerator: '::Sphyg::Enumerators::Cycle',
+      frames: %w[⣾ ⣽ ⣻ ⢿ ⡿ ⣟ ⣯ ⣷],
+      rate: 0.1
+    },
+    moon: {
+      enumerator: '::Sphyg::Enumerators::Cycle',
+      frames: %w[🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘],
+      rate: 0.2
+    },
+    time: {
+      enumerator: '::Sphyg::Enumerators::Cycle',
+      frames: %w[🕛 🕐 🕒 🕓 🕔 🕕 🕖 🕗 🕘 🕙 🕚],
+      rate: 1
+    },
+    wave: {
+      enumerator: '::Sphyg::Enumerators::Rotate',
+      frames: %w[⡀ ⠄ ⠂ ⠁ ⠂ ⠄],
+      rate: 0.1
+    }
+  }.freeze
+
+  # Presents a message and throbber
+  # Params:
+  # +message+:: friendly +string+ to display that indicates a command is running
+  #   for example, 'Please wait'
+  # +options+:: configuration +hash+
+  # +&blk+:: a +block+ containing a long-running command to run while displaying
+  #   the message and throbber
   def self.pulse(message, options = nil, &blk)
     ::Sphyg::Pulse.new(message, options).run { yield blk }
   end

data/lib/sphyg/enumerators/base.rb

@@ -0,0 +1,19 @@
+module Sphyg
+  module Enumerators
+    # Enumerator template
+    class Base
+      class AbstractMethodCall < StandardError; end
+
+      def initialize(frames)
+        @frames = frames
+      end
+
+      # `next` is called at each iteration of a throbber's existance. It
+      # returns the throbber state to display. For example, simply looping
+      # a given array is implemented in 'Enumerators::Cycle'.
+      def next
+        raise AbstractMethodCall, 'Implement :run in a child class'
+      end
+    end
+  end
+end

data/lib/sphyg/enumerators/cycle.rb

@@ -0,0 +1,14 @@
+require 'sphyg/enumerators/base'
+
+module Sphyg
+  module Enumerators
+    # Loops through each individual frame of the given sequence.
+    # Just like Enumerator#next but wraps around the array.
+    class Cycle < Base
+      def next
+        @frames_index ||= 0
+        @frames[(@frames_index += 1) % @frames.length]
+      end
+    end
+  end
+end

data/lib/sphyg/enumerators/rotate.rb

@@ -0,0 +1,12 @@
+require 'sphyg/enumerators/base'
+
+module Sphyg
+  module Enumerators
+    # Rotates the whole array of frames at each iteration
+    class Rotate < Base
+      def next
+        @frames.rotate!.join
+      end
+    end
+  end
+end

data/lib/sphyg/pulse.rb

@@ -1,69 +1,43 @@
-require 'sphyg/frames'
+require 'sphyg/throbber'
 
 module Sphyg
+  # Handles threading and running the throbber
   class Pulse
-    def initialize(message, options)
+    def initialize(message, options = {})
       @message = message
-      @options = options || { kind: :wave }
-      @frames = Sphyg::FRAMES[@options[:kind]]
+      @options = parse_options(options)
     end
 
     def run(&blk)
-      thr = Thread.new do
-        case @options[:kind]
-        when :ascii then unitary_frame_loop(frames(:ascii), 0.1)
-        when :elipsis then unitary_frame_loop(frames(:elipsis), 0.2)
-        when :heart then unitary_frame_loop(frames(:heart), 0.1)
-        when :heroku then unitary_frame_loop(frames(:heroku), 0.1)
-        when :moon then unitary_frame_loop(frames(:moon), 0.2)
-        when :time then unitary_frame_loop(frames(:time), 1)
-        when :wave then wave
-        else wave
-        end
-      end
-
+      # Note: the block will continue to run even if our throbber crashed. This
+      # is more user-frindly than setting `abort_on_exception` for our thread.
+      # TODO: use `Thread#reporting_on_exception` for Ruby versions >= 2.4
+      thr = ::Thread.new { throbber.run }
       yield blk
     ensure
-      Thread.kill(thr)
+      thr.kill
       print "\n"
     end
 
     private
 
-    def frames(kind)
-      Sphyg::FRAMES[kind.to_sym].dup
-    end
-
-    # For unitary-frame loops, if a frame is longer than its counterparts, then it will not
-    # be completely replaced by the following frame. This padding ensures that each line
-    # is longer enough to overwrite the previous frame.
-    def padding
-      "\s" * @frames.max { |a, b| a.length <=> b.length }.length
-    end
-
-    def print_message_and_pulser(pulser)
-      print format "%s %s%s\r", @message, pulser, padding
-    end
-
-    def unitary_frame_loop(sequence, pulse_rate = 0.1)
-      frames_index = 0
-      loop do
-        print_message_and_pulser(sequence[frames_index])
-        frames_index = (frames_index + 1) % sequence.length
-        sleep pulse_rate
+    def parse_options(options)
+      if options.nil?
+        ::Sphyg::THROBBERS[:wave]
+      elsif options[:kind]
+        ::Sphyg::THROBBERS[options[:kind]]
+      else
+        ::Sphyg::THROBBERS[:wave].merge(options)
       end
     end
 
-    def wave
-      frames_index = 0
-      wave = frames(:wave)
-      loop do
-        print_message_and_pulser(wave.join)
-        wave.shift
-        frames_index = (frames_index + 1) % frames(:wave).length
-        wave << frames(:wave)[frames_index]
-        sleep 0.1
-      end
+    def throbber
+      ::Sphyg::Throbber.new(
+        @message,
+        @options[:frames],
+        @options[:enumerator],
+        @options[:rate]
+      )
     end
   end
 end

data/lib/sphyg/throbber.rb

@@ -0,0 +1,38 @@
+require 'sphyg/enumerators/cycle'
+require 'sphyg/enumerators/rotate'
+
+module Sphyg
+  # Generates and displays a throbber with a message
+  class Throbber
+    def initialize(message, frames, enumerator, rate)
+      @message = message
+      @frames = frames
+      @enumerator = Object.const_get(enumerator).new(@frames)
+      @rate = rate
+    end
+
+    def run
+      loop do
+        print_throbber_iteration
+        sleep @rate
+      end
+    end
+
+    private
+
+    # For unitary-frame loops, if a frame is longer than its counterparts,
+    # then it will not be completely replaced by the following frame. This
+    # padding ensures that each line is long enough to overwrite the previous
+    # frame.
+    def padding
+      @_padding ||= "\s" * @frames.max_by(&:length).length
+    end
+
+    def print_throbber_iteration
+      print format "%<message>s %<enumeration>s%<padding>s\r",
+        message: @message,
+        enumeration: @enumerator.next,
+        padding: padding
+    end
+  end
+end

data/lib/sphyg/version.rb

@@ -1,3 +1,3 @@
 module Sphyg
-  VERSION = "0.2.1"
+  VERSION = '0.3.0'.freeze
 end

data/sphyg.gemspec

@@ -1,27 +1,30 @@
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "sphyg/version"
+require 'sphyg/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "sphyg"
+  spec.name          = 'sphyg'
   spec.version       = Sphyg::VERSION
-  spec.authors       = ["Shane Cavanaugh"]
-  spec.email         = ["shane@shanecav.net"]
+  spec.authors       = ['Shane Cavanaugh']
+  spec.email         = ['shane@shanecav.net']
 
   spec.summary       = 'Throbbers for command line programs'
   spec.description   = 'Throbbers for command line programs'
   spec.homepage      = nil
-  spec.license       = "MIT"
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.required_ruby_version = '>= 2.2.9'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.52.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sphyg
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Shane Cavanaugh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-30 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
 description: Throbbers for command line programs
 email:
 - shane@shanecav.net
@@ -60,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -70,8 +85,11 @@ files:
 - bin/console
 - bin/setup
 - lib/sphyg.rb
-- lib/sphyg/frames.rb
+- lib/sphyg/enumerators/base.rb
+- lib/sphyg/enumerators/cycle.rb
+- lib/sphyg/enumerators/rotate.rb
 - lib/sphyg/pulse.rb
+- lib/sphyg/throbber.rb
 - lib/sphyg/version.rb
 - sphyg.gemspec
 homepage: 
@@ -86,7 +104,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.9
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -94,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.4.5.4
 signing_key: 
 specification_version: 4
 summary: Throbbers for command line programs

data/lib/sphyg/frames.rb

@@ -1,11 +0,0 @@
-module Sphyg
-  FRAMES = {
-    ascii: %w[| / - \\],
-    elipsis: ['.', '..', '...', '..'],
-    heart: %w[❤️ 🧡 💛 💚 💙 💜],
-    heroku: %w[⣾ ⣽ ⣻ ⢿ ⡿ ⣟ ⣯ ⣷],
-    moon: %w[🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘],
-    time: %w[🕛 🕐 🕒 🕓 🕔 🕕 🕖 🕗 🕘 🕙 🕚],
-    wave: %w[⡀ ⠄ ⠂ ⠁ ⠂ ⠄],
-  }.freeze
-end