sortviz 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a26d73bfed67f35fc0932b25232780f66317e86
-  data.tar.gz: 37bf5941624feb66a49d2bce915f7b30aa791103
+  metadata.gz: 3ab0c658aff4dc772ecffcacb46cf611eabb3461
+  data.tar.gz: 22438a128feac8deb9c70aee7c33d580d5faed1b
 SHA512:
-  metadata.gz: a450eaafc8aa96da572fbbafe76def7f3d85969cdb666aa0f60eccd5537be860ed41b43a05cbf6e79f42dea64db842001841860fa6e26fe6bdda9f9816ca2b79
-  data.tar.gz: 954c10988e7585ea53c4a58392bf0c8f42fd38e318358c99137485d258605acb75fd7bfb2fce87d62cb3fbad5ab1ffaf00f00f15979a9379f97b020950b4da75
+  metadata.gz: 142a64eec59079b2e6e8af322a593226ebdbd04163b69f6f964b2bbe856db9a043626ea61e3d7761533afa833b1c300509983275f78416ad37a2ae98054fe880
+  data.tar.gz: 76f9fed39164fbad24c24cef1891095e581eb551b8c967dfff3ed7b5973c8b561912525f3836da19a65b0fe0fd5499967992a27403a71ae37205be3ffef419c7

data/lib/sortviz/canvas.rb

@@ -9,8 +9,8 @@ module Sortviz
     attr_reader :window
 
     # Initializes a new instance with a title to display, the current cursor
-    # object (+Sortviz::Cursor+) and the modified screen dimensions from the
-    # parent window/screen (standard screen created in +Sortviz::Visualizer+)
+    # object (<tt>Sortviz::Cursor</tt>) and the modified screen dimensions from the
+    # parent window/screen (standard screen created in <tt>Sortviz::Visualizer</tt>)
     def initialize(title, cursor, screen_dim)
       @screen_dim = screen_dim
       @cursor = cursor
@@ -19,7 +19,7 @@ module Sortviz
     end
 
     # Does the initial setup of creating an actual curses window, adding a 
-    # border to it and setting up non-blocking +Curses::Window#getch+
+    # border to it and setting up non-blocking <tt>Curses::Window#getch</tt>
     def setup
       @window ||= Curses::Window.new(
         @screen_dim[:lines] - MARGIN, 
@@ -55,7 +55,7 @@ module Sortviz
     end
 
     private
-    
+
     def draw_bar(height, highlighted)
       attr = highlighted ? @red_highlight : Curses::A_REVERSE
       attron(attr)

data/lib/sortviz/cursor.rb

@@ -8,68 +8,52 @@ module Sortviz
     attr_reader :y, :x, :window
     # Initialize a new Cursor object, follows curses practice of passing
     # the y before the x coords.
-    # @params
-    # => window (Curses::Window)
-    # => y      (Int)
-    # => x      (Int)
-    # @return instance of Sortviz::Cursor
+    #
+    # Params:
+    # +window+:: <tt>Curses::Window</tt> The window that will receive input
+    # +origin+:: <tt>Hash</tt> Origins to start drawing at
     def initialize(window, origin)
       @window = window
       move(origin[:y], origin[:x])
     end
 
     # Move to positions y, x
-    # @params
-    # => y (Int)
-    # => x (Int)
     def move(y, x)
       update(y, x)
       apply_pos
     end
 
     # Move along the y-axis
-    # @params
-    # => val (Int) new Value of y
     def move_y(val)
       update(val, x)
       apply_pos
     end
 
     # Move along the x-axis
-    # @params
-    # => val (Int) new Value of x
     def move_x(val)
       update(y, val)
       apply_pos
     end
 
-    # Increment the y value by val
-    # @params
-    # => val (Int) new Value of y, Default: 1
+    # Increment the y value by val (Default: 1)
     def incr_y(val = 1)
       update(y + val, x)
       apply_pos
     end
 
-    # Decrement the y value by val
-    # @params
-    # => val (Int) new Value of y, Default: 1
+    # Decrement the y value by val (Default: 1)
     def decr_y(val = 1)
       update((y - val).abs, x)
       apply_pos
     end
 
-    # Increment the x value by val
-    # @params
-    # => val (Int) new Value of x, Default: 1
+    # Increment the x value by val (Default: 1)
     def incr_x(val = 1)
       update(y, x + val)
       apply_pos
     end
 
-    # Decrement the x value by val
-    # @params
-    # => val (Int) new Value of x, Default: 1
+    # Decrement the x value by val (Default: 1)
     def decr_x(val = 1)
       update(y, (x - val).abs)
       apply_pos
@@ -87,15 +71,19 @@ module Sortviz
       @cached = nil
     end
 
+    # Switch to a new window that will receive input and optionally move to
+    # new coordinates in the new window
     def switch_window(new_window, coords: {})
       @window = new_window
       move(coords[:y], coords[:x]) unless coords.empty?
     end
 
+    # Print to the current screen receiving input
     def tprint(string)
       @window.addstr(string)
     end
 
+    # Increment y to simulate the addition of a new line
     def newline
       incr_y
     end

data/lib/sortviz/plugins.rb

@@ -3,15 +3,16 @@ module Sortviz
   ALGORITHMS = {}
 
   # Defines a new algorithm for sorting by adding some meta data to
-  # +Sortviz::ALGORITHMS+ and turning the sorting algorithm method into a
-  # Module function of +Sortviz+.
+  # <tt>Sortviz::ALGORITHMS</tt> and turning the sorting algorithm method into a
+  # Module function of <tt>Sortviz</tt>.
   #
   # It's a bad design, should be fixed soon with a proper plugin system as this
   # way pollutes the Sortviz namespace.
+  #
   # Params:
-  # +name+:: +String+ Name of the sorting algorithm for display purposes
-  # +func_name+:: +Symbol+ A symbol representation of the actual method that does
-  # the actual sorting. It's important that both match or else +Sortviz::Visualizer+
+  # +name+:: <tt>String</tt> Name of the sorting algorithm for display purposes
+  # +func_name+:: <tt>Symbol</tt> A symbol representation of the actual method that does
+  # the actual sorting. It's important that both match or else <tt>Sortviz::Visualizer</tt>
   # will not be able to find it and call it.
   def define_algorithm(name, func_name)
     ALGORITHMS[func_name] = name

data/lib/sortviz/version.rb

@@ -1,3 +1,3 @@
 module Sortviz
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/sortviz/visualizer.rb

@@ -1,23 +1,24 @@
 module Sortviz
   # Visualizer is the entry point of Sortviz, given an algorithm name it'll
-  # initialize Curses library, a +Sortviz::Canvas+ with proper screen dimensions
-  # and a +Sortviz::Cursor+.
+  # initialize Curses library, a <tt>Sortviz::Canvas</tt> with proper screen dimensions
+  # and a <tt>Sortviz::Cursor</tt>.
   #
   # It also generates a shuffled list of numbers counting from 1 to n, n is 
-  # decided by Sortviz::Visualizer#generate_list which calculates the number
+  # decided by <tt>Sortviz::Visualizer#generate_list</tt> which calculates the number
   # of bar charts that can be drawn given the current screen size.
   #
-  # _Notice_: Curses coordinates are treated in reverse, (y, x) and x represents
+  # <em>Notice</em>: Curses coordinates are treated in reverse, (y, x) and x represents
   # the number of columns, y represents the number of lines so
-  # *(y, x)* is *(cols, lines)*. As a result of that we too, use _(y, x)_.
+  # <em>(y, x)</em> is <em>(cols, lines)</em>. As a result of that we too, use <em>(y, x)</em>.
   class Visualizer
-    # Origin starts at (1, 0) not 
+    # Origin starts at (1, 0) not (0, 0)
     ORIGIN = { y: 1, x: 5 }
     SLEEP_INTERVAL = 0.05
 
     # Initializes a new Visualizer for a sorting algorithm
+    #
     # Params:
-    # +algo+:: +Symbol+ A symbol representing a sorting algorithm method
+    # +algo+:: <tt>Symbol</tt> A symbol representing a sorting algorithm method
     def initialize(algo)
       setup_curses
       @screen_dim = { cols: Curses.cols - ORIGIN[:x], lines: Curses.lines }
@@ -31,28 +32,28 @@ module Sortviz
 
     # Starts the actual visualization
     # * First prints the program's banner
-    # * Sets up the canvas (+Sortviz::Canvas+)
+    # * Sets up the canvas (<tt>Sortviz::Canvas</tt>)
     # * Caches the cursor location so we can return to our original location later
     # * Refreshes the current standard screen first
     # * Refreshes the canvas
-    # * Finally we switch input to the canvas through +Sortviz::Cursor#switch_window+
+    # * Finally we switch input to the canvas through <tt>Sortviz::Cursor#switch_window</tt>
     #
     # The order is important because curses works in such a way that the last
     # thing on display is the last thing refreshed, if we had refreshed canvas
     # first, it would have been drawn normally, then we refresh the standard
     # screen (in which the canvas is inside) it'll do just that refreshs and overrides the canvas.
     #
-    # === The loop
+    # ==== The loop
     # In order to draw every returned partially sorted list from the algorithm method
     # we have to loop, clearing the canvas everytime and redrawing it then telling
     # Curses to apply these drawn updates. This helps with flicker but I still
-    # seem to be getting some of it ever since I introduced the +Curses::A_REVERSE+
+    # seem to be getting some of it ever since I introduced the <tt>Curses::A_REVERSE</tt>
     # attribute.
     #
     # Durring the loop, we're trapped inside the sorting method, as a block of code
     # that gets yielded to on every iteration of the sorting algorithm. To exit that
     # at anytime during the sorting run, we capture the keyboard and return if any key is pressed,
-    # the canvas has +Curses::Window#getch+ on non-block mode so it doesn't block waiting for a character.
+    # the canvas has <tt>Curses::Window#getch</tt> on non-block mode so it doesn't block waiting for a character.
     #
     # Finally, we make sure both the canvas and the standard screen are closed.
     # It's important to note that we also poll on keyboard after we exit the sorting method.

data/sortviz.gemspec

@@ -7,11 +7,11 @@ Gem::Specification.new do |spec|
   spec.name          = "sortviz"
   spec.version       = Sortviz::VERSION
   spec.authors       = ["Hady Ahmed"]
-  spec.email         = ["hady.fathy@gmail.com"]
+  spec.email         = ["me@hadyahmed.com"]
 
   spec.summary       = %q{Terminal based sorting algorithms visualizer}
   spec.description   = %q{Visualize sorting algorithms with Ruby and Curses lib}
-  spec.homepage      = "http://hadyahmed.com"
+  spec.homepage      = "https://github.com/l0gicpath/sortviz"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_dependency "curses"
+  spec.add_dependency "curses", "~> 1.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sortviz
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Hady Ahmed
@@ -56,19 +56,19 @@ dependencies:
   name: curses
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.2
 description: Visualize sorting algorithms with Ruby and Curses lib
 email:
-- hady.fathy@gmail.com
+- me@hadyahmed.com
 executables:
 - sortviz
 extensions: []
@@ -98,7 +98,7 @@ files:
 - lib/sortviz/visualizer.rb
 - screenshot.png
 - sortviz.gemspec
-homepage: http://hadyahmed.com
+homepage: https://github.com/l0gicpath/sortviz
 licenses:
 - MIT
 metadata: {}