sphyg 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2848658d5b40c87c179d97114d9c5436fda7c2622bcaee0ecaa738d72f1c8ce
-  data.tar.gz: 063e17dce0f642c6b0844a6f6aadc57673b4b82135f63ae6bd80f66bf63ff7ab
+  metadata.gz: 13e0fcf2c3419135646ab226f0ade0d32737330efc77e8c3d410f03c5a3345ae
+  data.tar.gz: 0f3b3ac10c36be44cdd2bf4639aa187ca0e5e746e22b4025b8dbed52d077f30a
 SHA512:
-  metadata.gz: 5f71fc602645b2143ac9eb0bbe88ca5f43d9a1d16467eba7d242be334646615adf7a5558377ced7136387c03981729027b370003ae2963a2bceb3804f0d45743
-  data.tar.gz: 572959d26091368ac1f628b88cb25ec3d5eccae71a8020c41775189dd037c40a7716285f4653c8445bf6d092948a040c41691ef7551626439f4ad5b4bde6b027
+  metadata.gz: 8e34ddd9e7caa9f18e8ce56c3c8ae8e16a29320cc41304c11c45c1c2461af316e5b12557885bcf51b49d0ef34a51d7940c963bfb6f0748ddfed4932fe9815957
+  data.tar.gz: 5c0e3bfd8cefd0d397464b7a7859ef948223829a41ec465a6336e561879a1a5c747626e218fa19f5ca9d13e069d94a773e4847086a9264b05cf5e9429d8e4090

data/CHANGELOG.md

@@ -0,0 +1,34 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## Unreleased
+### Added
+- None
+
+### Changed
+- None
+
+### Fixed
+
+## 0.2.0 (2017-12-30)
+### Added
+- Convenience method `::Sphyg.pulse`
+
+### Changed
+- None
+
+### Fixed
+- None
+
+## 0.1.0 (2017-12-29)
+### Added
+- Everything
+
+### Changed
+- None
+
+### Fixed
+- None

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sphyg (0.1.0)
+    sphyg (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,7 +1,7 @@
 # Sphyg
 
 'Sphygmos' is the Greek word for 'pulse'. Sphyg provides [throbbers](https://en.wikipedia.org/wiki/Throbber)
-for command line programs. 
+to indicate that your long-running command line program still has a pulse.
 
 ## Installation
 
@@ -21,16 +21,31 @@ Or install it yourself as:
 
 ## Usage
 
+Pass the _message_ you want to display while your command is running
+and a _block_ containing your long-running command to `Sphyg.pulse`.
+
 ```ruby
-> ::Sphyg::Pulse.new('Please wait', { kind: :wave }).run { while true; sleep 1; end }
+> ::Sphyg.pulse('Please wait') { sleep }
 Please wait ⡀ ⠄ ⠂ ⠁ ⠂ ⠄ # animated 
 ```
 
 ### Options
 
-#### Kind
+You can also pass an _options_ hash to `::Sphyg.pulse` using the following keys:
+
+#### `:kind`
+
+Configure which kind of throbber you would like to use. Available kinds and their associated frames:
 
-See [`Sphyg::FRAMES`](sphyg/frames.rb) for throbber kinds and their associated animation frames.
+| Kind | Frames |
+| ---- | ------ |
+| `:ascii` | \| / - \ |
+| `:elipsis` | . .. ... .. |
+| `:heart` | ❤️ 🧡 💛 💚 💙 💜 |
+| `:heroku` | ⣾ ⣽ ⣻ ⢿ ⡿ ⣟ ⣯ ⣷ |
+| `:moon` | 🌑 🌒 🌓 🌔 🌕 🌖 🌗 🌘 |
+| `:time` | 🕛 🕐 🕒 🕓 🕔 🕕 🕖 🕗 🕘 🕙 🕚 |
+| `:wave` | ⡀ ⠄ ⠂ ⠁ ⠂ ⠄ |
 
 ## Development
 

data/lib/sphyg.rb

@@ -1,4 +1,8 @@
 require "sphyg/pulse"
 require "sphyg/version"
 
-module Sphyg; end
+module Sphyg
+  def self.pulse(message, options = nil, &blk)
+    ::Sphyg::Pulse.new(message, options).run { yield blk }
+  end
+end

data/lib/sphyg/pulse.rb

@@ -2,10 +2,10 @@ require 'sphyg/frames'
 
 module Sphyg
   class Pulse
-    def initialize(message, options = {})
+    def initialize(message, options = { kind: :wave })
       @message = message
       @options = options
-      @frames = Sphyg::FRAMES[options[:kind]] || Sphyg::FRAMES[:wave]
+      @frames = Sphyg::FRAMES[options[:kind]]
     end
 
     def run(&blk)

data/lib/sphyg/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sphyg
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Shane Cavanaugh
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock