color_wave 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8bea5c65d46bd4ff80b996381338abf97fae6f3
-  data.tar.gz: d58e46eb0b84ab91bac57e499c4a0f6dea860a40
+  metadata.gz: 5aacaab444c91b6fe32b1f2254db321b7238db5b
+  data.tar.gz: fe295feaaf56f627ab5ad3eb546191a552e20cbe
 SHA512:
-  metadata.gz: 22577827d698abec6d8756bfe269709084bfd69f78178cc7699ae92e5fc4eb4b218ffa73ea4b7a5ddd286d10c68c70eaefebba13e203a2a2b770b14735a5daf4
-  data.tar.gz: 41858f0d4330b53921e30e33bd15f08174b1078729d9c094aefe7faf41cba6a745c805fb1b758d14f9e2cca8b7fd4f10f6044dea583ce364c0c5d7cb59624e9b
+  metadata.gz: 9904322801784ecd78448a9029ee7fb18a98c6af69db7664be87e54a68f6e420f2b3b2a0457261951d6a9b5f73f40e09be0490bfb0b48fda638f3ae194b77241
+  data.tar.gz: 7a18164cbef3291c0494aeed4bcea9b387abd085ea29b9d2eb56a14e9f3acc20fa2e2305dd6f51373475b2bc0650f9903882fed237054c38b1bea2960c66feba

data/README.md

@@ -21,26 +21,29 @@ Or install it yourself as:
 
 You can run it from the command line with or without some options:
 
-    $ color_wave --lines 10 --cycles 2
+    $ color_wave --lines 20 --cycles 3 --speed 10.0
+
+The above values are the defaults.
+##### Options
+* `--lines` - the height of the wave in terminal lines
+* `--cycles` - how many cycles of the wave will be drawn
+* `--speed` - used as the divisor of the delay time between drawing loops; use higher values for faster redrawing
+* `--help` - show usage information
 
 You can use it in Ruby too:
 ```ruby
 require 'color_wave'
 
-ColorWave.new(lines: 10, cycles: 2, colors: %w( ff0000 00ff00 0000ff ), chars: %w( _ / ^ \ )).run
+ColorWave.new(lines: 10, cycles: 2, speed: 1, colors: %w( ff0000 00ff00 0000ff ), chars: %w( _ / ^ \ )).run
 ```
 
-`Ctrl-C` will stop it once it's running.
-
-## Development
+The `speed` option is used as the divisor to a `BASE_SLEEP_TIME` constant so higher speeds will redraw the wave more quickly. The `colors` and `chars` options specify the colors and characters to be cycled through when drawing the wave.
 
-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).
+`Ctrl-C` will stop it once it's running.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jbratton/color_wave. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jbratton/color_wave. 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
 

data/bin/color_wave

@@ -3,14 +3,14 @@
 require 'color_wave'
 require 'trollop'
 
-DEFAULT_LINES = 20
-DEFAULT_CYCLES = 3
-
 opts = Trollop::options do
-  opt :lines, "Wave height in lines", default: DEFAULT_LINES
-  opt :cycles, "Wave cycles to display", default: DEFAULT_CYCLES
+  opt :lines, "Wave height in lines", default: ColorWave::DEFAULT_LINES
+  opt :cycles, "Wave cycles to display", default: ColorWave::DEFAULT_CYCLES
+  opt :speed, "Speed of redrawing", default: ColorWave::DEFAULT_SPEED
 end
+
 Trollop::die :lines, "must be greater than zero" unless opts[:lines] > 0
 Trollop::die :cycles, "must be greater than zero" unless opts[:cycles] > 0
+Trollop::die :speed, "must be greater than zero" unless opts[:speed] > 0
 
-ColorWave.new(lines: opts[:lines], cycles: opts[:cycles]).run
+ColorWave.new(lines: opts[:lines], cycles: opts[:cycles], speed: opts[:speed]).run

data/lib/color_wave/color_wave.rb

@@ -8,6 +8,7 @@ class ColorWave
   DEFAULT_LINES = 20
   DEFAULT_CHARS = %w( O ).freeze
   DEFAULT_CYCLES = 3
+  DEFAULT_SPEED = 10.0
 
   # rainbow RGB values stolen from Term-Colormap on CPAN
   # https://metacpan.org/source/XXFELIXXX/Term-Colormap-0.06/lib/Term/Colormap.pm
@@ -19,18 +20,19 @@ class ColorWave
   ).freeze
 
   TWO_PI = Math::PI * 2
-  LOOP_SLEEP = 0.00001
+  BASE_SLEEP_TIME = 0.001
 
-  attr_reader :lines, :cycles, :chars, :colors
+  attr_reader :lines, :cycles, :chars, :colors, :speed
 
   def initialize(lines: DEFAULT_LINES, cycles: DEFAULT_CYCLES,
-                 chars: DEFAULT_CHARS, colors: DEFAULT_COLORS)
+                 chars: DEFAULT_CHARS, colors: DEFAULT_COLORS,
+                 speed: DEFAULT_SPEED)
     @lines = lines
     @cycles = cycles
     @chars = chars.cycle
     @colors = colors.cycle
+    @speed = speed
 
-    @sleep_time = LOOP_SLEEP
     @current_line = 0
     @shutdown = false
 
@@ -51,7 +53,7 @@ class ColorWave
 
   private
 
-  attr_accessor :current_line, :cycles, :shutdown, :sleep_time, :wave_rows
+  attr_accessor :current_line, :cycles, :shutdown, :wave_rows
 
   def width
     TermInfo.screen_width
@@ -83,12 +85,17 @@ class ColorWave
 
   def write_one_pass(pass)
     width.times do |step|
+      break if shutdown
       move_to_line next_line
       print Rainbow(next_char).color(next_color(pass, step))
       sleep sleep_time
     end
   end
 
+  def sleep_time
+    BASE_SLEEP_TIME / speed
+  end
+
   def ready_next_pass
     print "\r"
   end

data/lib/color_wave/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class ColorWave
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: color_wave
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - jbratton
@@ -113,8 +113,6 @@ email:
 - jeremy@alumni.rice.edu
 executables:
 - color_wave
-- console
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -126,8 +124,6 @@ files:
 - README.md
 - Rakefile
 - bin/color_wave
-- bin/console
-- bin/setup
 - color_wave.gemspec
 - lib/color_wave.rb
 - lib/color_wave/color_wave.rb

data/bin/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "color_wave"
-
-# 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.
-
-require "pry"
-Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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