sphyg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2848658d5b40c87c179d97114d9c5436fda7c2622bcaee0ecaa738d72f1c8ce
+  data.tar.gz: 063e17dce0f642c6b0844a6f6aadc57673b4b82135f63ae6bd80f66bf63ff7ab
+SHA512:
+  metadata.gz: 5f71fc602645b2143ac9eb0bbe88ca5f43d9a1d16467eba7d242be334646615adf7a5558377ced7136387c03981729027b370003ae2963a2bceb3804f0d45743
+  data.tar.gz: 572959d26091368ac1f628b88cb25ec3d5eccae71a8020c41775189dd037c40a7716285f4653c8445bf6d092948a040c41691ef7551626439f4ad5b4bde6b027

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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 shane@shanecav.net. 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,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in throbber.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    sphyg (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sphyg!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shane Cavanaugh
+
+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,51 @@
+# Sphyg
+
+'Sphygmos' is the Greek word for 'pulse'. Sphyg provides [throbbers](https://en.wikipedia.org/wiki/Throbber)
+for command line programs. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sphyg'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sphyg
+
+## Usage
+
+```ruby
+> ::Sphyg::Pulse.new('Please wait', { kind: :wave }).run { while true; sleep 1; end }
+Please wait ⡀ ⠄ ⠂ ⠁ ⠂ ⠄ # animated 
+```
+
+### Options
+
+#### Kind
+
+See [`Sphyg::FRAMES`](sphyg/frames.rb) for throbber kinds and their associated animation frames.
+
+## 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.
+
+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/shanecav84/sphyg. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sphyg project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/shanecav84/sphyg/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/lib/sphyg.rb

@@ -0,0 +1,4 @@
+require "sphyg/pulse"
+require "sphyg/version"
+
+module Sphyg; end

data/lib/sphyg/frames.rb

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

data/lib/sphyg/pulse.rb

@@ -0,0 +1,69 @@
+require 'sphyg/frames'
+
+module Sphyg
+  class Pulse
+    def initialize(message, options = {})
+      @message = message
+      @options = options
+      @frames = Sphyg::FRAMES[options[:kind]] || Sphyg::FRAMES[:wave]
+    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
+
+      yield blk
+    ensure
+      Thread.kill(thr)
+      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
+      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
+    end
+  end
+end

data/lib/sphyg/version.rb

@@ -0,0 +1,3 @@
+module Sphyg
+  VERSION = "0.1.0"
+end

data/sphyg.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sphyg/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sphyg"
+  spec.version       = Sphyg::VERSION
+  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.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: sphyg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Shane Cavanaugh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Throbbers for command line programs
+email:
+- shane@shanecav.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sphyg.rb
+- lib/sphyg/frames.rb
+- lib/sphyg/pulse.rb
+- lib/sphyg/version.rb
+- sphyg.gemspec
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Throbbers for command line programs
+test_files: []