standard_draw_tk 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca7b9a655f27420d979493f99311d989c692ddc42808742be747f2cd84fdf7c
-  data.tar.gz: 68510657307bcf858182bc300577504633d59a444cedca14ef6cb08c092f73cf
+  metadata.gz: d90a6bcb43272afb1a5c528dbc97ee38f4928b97952c394e444a41c35f4c4a42
+  data.tar.gz: b18f7a7059cd831c118fc7a3703a500362c78c80f42a55519a5d648b4ebdcb69
 SHA512:
-  metadata.gz: 0cd52535685c8bb09ed7d903826391db4cc40b958daf1375fd8622964c62aedbbfad0eaad69c4162247f1ab72275f4e0d14bec4e76f547381bdc202fc005fc49
-  data.tar.gz: 10f2e63fb5a8463693737acb1fe16794b90606a920969a64945951f9b948459a424affc384ca962fcc40c0858610168770412c54f2939386e5620f56d033f75a
+  metadata.gz: 21ecd96da9884528642f33848f6e316bc59050d5d5c8a35b4b71cb1430cf4a73230e3eb4f4556cc31662b85784ed706e54cd7a76822e4d4b3e8b6accaaba3b6f
+  data.tar.gz: 2e67038a30e5171e4b043d78160b297ff2e8089b4d67e5237134f7c1969d287099773839ce2cdcd51e51d4be271e9d580f5ade6d0e04f7f1a1e97d6f4a4f3682

data/README.md

@@ -1,8 +1,34 @@
 # Standard Draw TK
 
-I was going through the [Algorithms 4th edition](https://algs4.cs.princeton.edu/home/) and wanted to write the algorithms in ruby instead of the default java. The book uses the [Princeton Standard Libraries](https://introcs.cs.princeton.edu/java/stdlib/) to help clarify the code. I've added a simple [jruby wrapper gem](https://rubygems.org/gems/princeton_standard_libraries) that lets you call the original java code in Jruby.
+The StdDraw class provides a basic capability for creating drawings with your programs. It uses a simple graphics model that allows you to create drawings consisting of points, lines, squares, circles, and other geometric shapes in a window on your computer.
+
+I was going through the excellent [Algorithms 4th edition](https://algs4.cs.princeton.edu/home/) text  and *really* wanted to use ruby instead of the default java. The book makes use of the [Princeton Standard Libraries](https://introcs.cs.princeton.edu/java/stdlib/) to help clarify the code and display useful figures.
+
+The original graphics code uses Java Swing/AWT which works fine with Jruby but not so much with standard ruby. So I started wondering how bad it would be to rewrite it in something MRI friendly. I'm attempting to keep the original interface as much as possible while recreating the logic using the [ruby TK gem](https://github.com/ruby/tk). The graphics drawing portion works but the library is not yet fully complete. See [things to implement](https://github.com/gregors/standard_draw_tk/blob/master/README.md#things-to-implement)
+
+If you need something not yet ported consider using the [jruby wrapper gem](https://rubygems.org/gems/princeton_standard_libraries) that lets you call the original java code in Jruby.
+
+Most of the docs taken/modified from the [original source](https://introcs.cs.princeton.edu/java/stdlib/javadoc/StdDraw.html)
+
+Type the following short program into your editor:
+
+    require 'standard_draw_tk'
+
+    StdDraw.pen_radius = 0.05
+    StdDraw.pen_color = :blue
+    StdDraw.point(0.5, 0.5)
+    StdDraw.pen_color = :magenta
+    StdDraw.line(0.2, 0.2, 0.8, 0.2)
+    StdDraw.pause
+
+run it:
+
+    ruby examples/example4.rb
+
+![image of example4](https://raw.githubusercontent.com/gregors/standard_draw_tk/master/examples/image_example4.png)
+
+
 
-I really would like to call this code in standard ruby. So I'm attempting to keep the original interface while recreating the logic using the [ruby TK gem](https://github.com/ruby/tk).
 
 ## Installation
 
@@ -23,16 +49,67 @@ Ruby doesn't contain TK by default anymore. And installing the TK gem requires a
 
 ## Usage
 
-The drawing of geometric shapes has been implemented though there are probably some small tweaks that need to be added, e.g. the line ends of arcs.
+
+### Note
+
+You will need to add `StdDraw.pause` to the end of your programs as shown in the examples. I may change or alias this in the future or maybe find a work around. This deviates from the original Standar Draw lib
+
+### Points and lines
+
+You can draw points and line segments with the following methods:
+
+    StdDraw.point(x, y)
+    StdDraw.line(x1, y1, x2, y2)
+
+The x- and y-coordinates must be in the drawing area (between 0 and 1 and by default) or the points and lines will not be visible.
+
+### Squares, circles, rectangles, and ellipses
+
+You can draw squares, circles, rectangles, and ellipses using the following methods:
+
+    StdDraw.circle(x, y, radius)
+    StdDraw.ellipse(x, y, semiMajorAxis, semiMinorAxis)
+    StdDraw.square(x, y, radius)
+    StdDraw.rectangle(x, y, halfWidth, halfHeight)
+
+All of these methods take as arguments the location and size of the shape. The location is always specified by the x- and y-coordinates of its center. The size of a circle is specified by its radius and the size of an ellipse is specified by the lengths of its semi-major and semi-minor axes. The size of a square or rectangle is specified by its half-width or half-height. The convention for drawing squares and rectangles is parallel to those for drawing circles and ellipses, but may be unexpected to the uninitiated.
+
+The methods above trace outlines of the given shapes. The following methods draw filled versions:
+
+    StdDraw.filledCircle(x, y, radius)
+    StdDraw.filledEllipse(x, y, semiMajorAxis, semiMinorAxis)
+    StdDraw.filledSquare(x, y, radius)
+    StdDraw.filledRectangle(x, y, halfWidth, halfHeight)
+
+### Circular arcs
+
+You can draw circular arcs with the following method:
+
+    StdDraw.arc(x, y, radius, angle1, angle2)
+
+The arc is from the circle centered at (x, y) of the specified radius. The arc extends from angle1 to angle2. By convention, the angles are polar (counterclockwise angle from the x-axis) and represented in degrees. For example, StdDraw.arc(0.0, 0.0, 1.0, 0, 90) draws the arc of the unit circle from 3 o'clock (0 degrees) to 12 o'clock (90 degrees).
+
+### Polygons
+
+You can draw polygons with the following methods:
+
+    StdDraw.polygon([] x, [] y)
+    StdDraw.filledPolygon([] x, [] y)
+
+### Examples
+
+see the [examples directory](https://github.com/gregors/standard_draw_tk/tree/master/examples)
+
 
 ## 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).
-
 ## Things to implement:
 
+### line ends bug
+* [ ] ends of arcs and line aren't rounded.
+
 ### Drawing geometric shapes
 * [x] line
 * [x] point

data/examples/example4.rb

@@ -0,0 +1,8 @@
+require 'standard_draw_tk'
+
+StdDraw.pen_radius = 0.05
+StdDraw.pen_color = :blue
+StdDraw.point(0.5, 0.5)
+StdDraw.pen_color = :magenta
+StdDraw.line(0.2, 0.2, 0.8, 0.2)
+StdDraw.pause

data/examples/right_triangle.rb

@@ -0,0 +1,9 @@
+require 'standard_draw_tk'
+
+StdDraw.square(0.5, 0.5, 0.5)
+StdDraw.pen_color = 'blue'
+StdDraw.line(0.5, 0.5, 0.9, 0.5)
+StdDraw.line(0.9, 0.5, 0.5, 0.8)
+StdDraw.line(0.5, 0.8, 0.5, 0.5)
+StdDraw.circle(0.7, 0.65, 0.25)
+StdDraw.pause

data/lib/standard_draw_tk.rb

@@ -52,7 +52,7 @@ class StdDraw
     y0 = coords.scale_y(y0)
     x1 = coords.scale_x(x1)
     y1 = coords.scale_y(y1)
-    TkcLine.new(@@canvas, x0, y0, x1, y1, fill: color)
+    TkcLine.new(@@canvas, x0, y0, x1, y1, width: scaled_pen_radius, fill: color)
   end
 
   def self.arc(x, y, radius, angle1, angle2)
@@ -71,7 +71,6 @@ class StdDraw
       y1 = ys - hs/2
       x2 = x1 + ws
       y2 = y1 + hs
-      scaled_pen_radius = @@pen_radius * StandardDrawTk::Coordinates::DEFAULT_SIZE
       TkcArc.new(@@canvas, x1, y1, x2, y2, style: :arc, start: angle1, extent: angle2 - angle1, fill: color, width: scaled_pen_radius, outline: color)
     end
   end
@@ -109,11 +108,10 @@ class StdDraw
   end
 
   def self.point(x, y)
-    draw_circle(x, y, @@pen_radius, outline: color, fill: color)
+    draw_circle(x, y, @@pen_radius/2, outline: color, fill: color)
   end
 
   def self.pixel(x, y)
-    puts 'pixel'
     x1 = coords.scale_x(x).round
     y1 = coords.scale_y(y).round
     TkcRectangle.new(@@canvas, [x1, y1, x1 + 1, y1 + 1], outline: color, fill: color)
@@ -133,6 +131,10 @@ class StdDraw
 
   private
 
+  def self.scaled_pen_radius
+    @@pen_radius * StandardDrawTk::Coordinates::DEFAULT_SIZE
+  end
+
   def self.draw_polygon(x, y, fill: '', outline: nil)
     throw 'x-coordinate array is null' if x.nil?
     throw 'y-coordinate array is null' if y.nil?
@@ -141,7 +143,6 @@ class StdDraw
     x = x.map{|i| coords.scale_x(i)}
     y = y.map{|i| coords.scale_y(i)}
     points = x.zip(y).flatten
-    scaled_pen_radius = @@pen_radius * StandardDrawTk::Coordinates::DEFAULT_SIZE
     TkcPolygon.new(@@canvas, *points, width: scaled_pen_radius, fill: fill, outline: outline)
   end
 
@@ -167,11 +168,11 @@ class StdDraw
     throw 'radius must be nonnegative' if radius < 0
     xs = coords.scale_x(x)
     ys = coords.scale_y(y)
-    scaled_pen_radius = radius * StandardDrawTk::Coordinates::DEFAULT_SIZE
+    scaled_radius = radius * StandardDrawTk::Coordinates::DEFAULT_SIZE
     if scaled_pen_radius <= 1
       pixel(x, y)
     else
-      b = coords.box(xs, ys, scaled_pen_radius/2)
+      b = coords.box(xs, ys, scaled_radius)
       TkcOval.new(@@canvas, b, outline: outline, fill: fill)
     end
   end

data/lib/standard_draw_tk/version.rb

@@ -1,3 +1,3 @@
 module StandardDrawTk
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/standard_draw_tk.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Gregory Ostermayr']
   spec.email         = ['<gregory.ostermayr@gmail.com>']
 
-  spec.summary       = %q{Ruby TK version of Princeton's Standard Draw library}
-  spec.description   = %q{Ruby TK version of Princeton's Standard Draw library}
+  spec.summary       = %q{Ruby TK version of Princeton's Standard Draw}
+  spec.description   = %q{Ruby TK version of Princeton's Standard Draw. A basic graphics drawing library.}
   spec.homepage      = 'https://github.com/gregors/standard_draw_tk'
   spec.license       = 'GPLv3'
 

metadata

@@ -1,72 +1,73 @@
 --- !ruby/object:Gem::Specification
 name: standard_draw_tk
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Gregory Ostermayr
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-29 00:00:00.000000000 Z
+date: 2018-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
+  name: tk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
-  name: tk
-  prerelease: false
   type: :runtime
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
-  name: bundler
-  prerelease: false
   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'
-  name: rake
-  prerelease: false
   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'
-  name: rspec
-  prerelease: false
   type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Ruby TK version of Princeton's Standard Draw library
+description: Ruby TK version of Princeton's Standard Draw. A basic graphics drawing
+  library.
 email:
 - "<gregory.ostermayr@gmail.com>"
 executables: []
@@ -87,9 +88,12 @@ files:
 - examples/example1.rb
 - examples/example2.rb
 - examples/example3.rb
+- examples/example4.rb
+- examples/image_example4.png
 - examples/points.rb
 - examples/polygon.rb
 - examples/rectangle.rb
+- examples/right_triangle.rb
 - examples/square.rb
 - examples/triangle.rb
 - lib/coordinates.rb
@@ -100,7 +104,7 @@ homepage: https://github.com/gregors/standard_draw_tk
 licenses:
 - GPLv3
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -115,9 +119,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
 specification_version: 4
-summary: Ruby TK version of Princeton's Standard Draw library
+summary: Ruby TK version of Princeton's Standard Draw
 test_files: []