kame 0.4.0 → 0.5.0

data/CHANGE_LOG.txt

@@ -0,0 +1,15 @@
+0.5.0
+
+* Added more colours as selected by my 6yo daughter.
+* Added an optional colour param to pen_down.
+* Added defensive check for valid colour names.
+* Added grid. See options, off by default.
+
+0.4.0
+
+* Fixed bug when on Windows. The gosu draw method was called before update on the first time round and so the time variable wasn't available. Now works on Windows.
+* Changed the default pen to black as the default paper is white.
+
+0.3.0
+
+* Initial public release

data/README.md

@@ -18,10 +18,10 @@ Each command is on a new line and they are executed in order.
 
 As this is using Ruby, you also have access to Ruby constructs such as loops and functions.
 
-Notice
-------
+Platforms
+---------
 
-I've tested this on OSX and it works fine. However, there seems to be an issue on Windows 7 when creating the Gosu window. I'll investigate.
+I've tested this on OSX Snow Leopard and also Windows 7. Both work fine :o) It should also work on OSX Lion and Linux in theory, but I haven't tested this yet. Please let me know if you try it.
 
 Install
 -------
@@ -74,9 +74,14 @@ To move the turtle backward by 75 pixels from it's current position, you can use
 
 	backward 75
 		
-To tell the turtle to put his pen down onto the paper use the `pen_down` command:
+You can change the colour of the turtle's pen at any time (on the paper or not) with the `colour` command:
+
+	colour :pink
+
+To tell the turtle to put his pen down onto the paper use the `pen_down` command. There is an optional parameter for the pen colour to switch to, if not supplied the pen is not changed:
 		
 	pen_down
+	pen_down :red
 
 To tell the turtle to pick his pen up again, use the `pen_up` command:
 
@@ -89,10 +94,6 @@ You can ask the turtle to rotate 90 degrees to the left (anti-clockwise) on the
 You can ask the turtle to rotate 90 degrees to the right (clockwise) on the spot without moving by using the `turn_right` command:
 
 	turn_right 90
-
-You can change the colour of the turtle's pen at any time (on the paper or not) with the `colour` command:
-
-	colour :pink
 		
 Colours
 -------
@@ -107,6 +108,14 @@ Here is a list of the available colours:
 	:yellow
 	:pink
 	:grey
+	:orange
+	:purple
+	:brown
+	:peach
+	:turquoise
+	:silver
+	:gold
+	:violet
 
 Options
 -------
@@ -119,11 +128,15 @@ In addition to commanding the turtle, there are some options you can specify. Yo
 
 Here is a list of all options with their default values (all are optional):
 
-	:width => 640 		# The width of the paper in pixels
-	:height => 480		# The height of the paper in pixels
-	:paper => :white	# The colour of the paper (from the list above)
-	:title => 'Kame'  	# The window title
-	:speed => 10		# The speed that the turtle draws. This is how many lines per second should be drawn
+	:width => 640 						# The width of the paper in pixels
+	:height => 480						# The height of the paper in pixels
+	:paper => :white					# The colour of the paper (from the list above)
+	:title => 'Kame'  				# The window title
+	:speed => 10							# The speed that the turtle draws. This is how many lines per second should be drawn
+  :grid => false						# Should the help grid be displayed (true | false)?
+	:grid_size => 8						# If the help grid is displayed, this is how many rows and columns should be drawn
+  :grid_colour => :silver		# If the help grid is displayed, this is the colour for the grid (from the list above)
+
 
 
 Contributing to kame

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/kame.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "kame"
-  s.version = "0.4.0"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Pike"]
-  s.date = "2011-11-11"
+  s.date = "2011-11-13"
   s.description = "Kame (Japanese for turtle) is an implementation of the Logo programming language built as a challenge to myself. I wanted a simple way to introduce programming in Ruby to my daughter and thought this would be fun. With Kame, you control the movement of a turtle around the screen by programming commands. With these simple commands your turtle will draw you a picture. It's a nice introduction to programming for kids and will also help their maths :o)"
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   ]
   s.files = [
     ".document",
+    "CHANGE_LOG.txt",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",

data/lib/kame.rb

@@ -17,7 +17,10 @@ class Kame
       :height => 480,
       :paper => :white,
       :title => 'Kame',
-      :speed => 10
+      :speed => 10,
+      :grid_size => 8,
+      :grid_colour => :silver,
+      :grid => false
     }.merge(options)
     
     instance_eval(&block)
@@ -29,8 +32,9 @@ class Kame
     @state[:pen_down] = false
   end
   
-  def pen_down
+  def pen_down(colour = nil)
     @state[:pen_down] = true
+    colour(colour) unless colour.nil?
   end
   
   def pen_down?
@@ -46,7 +50,12 @@ class Kame
   end
   
   def colour(colour)
-    @state[:line_colour] = KameColours::lookup[colour]
+    new_colour = KameColours::lookup[colour]
+    if new_colour.nil?
+      new_colour = KameColours::lookup[:black]
+      puts "Can't find the colour '#{colour.to_s}', using black instead."
+    end  
+    @state[:line_colour] = new_colour
   end
   
   def forward(distance)

data/lib/kame/kame_colours.rb

@@ -8,7 +8,15 @@ class KameColours
       :blue => 0xff0000ff,  
       :yellow => 0xffffff00,
       :pink => 0xffff00ff,
-      :grey => 0xff808080
+      :grey => 0xff808080,
+      :orange => 0xffff9900,
+      :purple => 0xff9900ff,
+      :brown => 0xff6b4e01,
+      :peach => 0xffffcb7a,
+      :turquoise => 0xff5edfbf,
+      :silver => 0xffcccccc,
+      :gold => 0xffffd700,
+      :violet => 0xffbe75ea
     }
   end
 end

data/lib/kame/kame_window.rb

@@ -6,6 +6,9 @@ class KameWindow < Gosu::Window
     @height = options[:height]
     @background_colour = Gosu::Color.argb(KameColours::lookup[options[:paper]])
     @speed = options[:speed]
+    @grid = options[:grid]
+    @grid_size = options[:grid_size]
+    @grid_colour = Gosu::Color.argb(KameColours::lookup[options[:grid_colour]])
     @lines = lines
     @first_frame = Gosu::milliseconds
     
@@ -21,6 +24,21 @@ class KameWindow < Gosu::Window
               0)
   end
   
+  def grid
+    @grid_font ||= Gosu::Font.new(self, "Arial", 10)
+    @grid_size.times do |i|
+      c = (@width / @grid_size) * (i + 1)
+      r = (@height / @grid_size) * (i + 1)
+
+      draw_line(0, r, @grid_colour, @width, r, @grid_colour, 1)
+      @grid_font.draw(r.to_s, 2, r - 11, 1, 1, 1, @grid_colour)
+
+      draw_line(c, 0, @grid_colour, c, @height, @grid_colour, 1)
+      c_width = @grid_font.text_width(c.to_s)
+      @grid_font.draw(c.to_s, c - c_width - 2, @height - 13, 1, 1, 1, @grid_colour)
+    end
+  end
+  
   def update
     @this_frame = Gosu::milliseconds
     @seconds_since_last_frame = (@this_frame - @first_frame) / 1000.0
@@ -28,6 +46,7 @@ class KameWindow < Gosu::Window
   
   def draw
     self.draw_background
+    self.grid if @grid
     return if @lines.nil? || @lines.count == 0 || @seconds_since_last_frame.nil?
     
     max = (@seconds_since_last_frame * @speed).round
@@ -38,7 +57,7 @@ class KameWindow < Gosu::Window
     0.upto(max).each do |i|
       line = @lines[i]
       line_colour = Gosu::Color.argb(line[:colour])
-      draw_line(line[:from][:x], line[:from][:y], line_colour, line[:to][:x], line[:to][:y], line_colour, 1)
+      draw_line(line[:from][:x], line[:from][:y], line_colour, line[:to][:x], line[:to][:y], line_colour, 10)
     end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: kame
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Andy Pike
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-11 00:00:00 Z
+date: 2011-11-13 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: gosu
@@ -56,6 +56,7 @@ extra_rdoc_files:
 - README.md
 files: 
 - .document
+- CHANGE_LOG.txt
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -79,7 +80,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3112740880397074236
+      hash: 2769029216864616128
       segments: 
       - 0
       version: "0"