kame 0.3.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+gem "gosu"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+end

data/Gemfile.lock

@@ -0,0 +1,18 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    gosu (0.7.38)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  gosu
+  jeweler (~> 1.6.4)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Andy Pike
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,133 @@
+kame (Japanese for turtle)
+==========================
+
+Kame 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 a piece of paper 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)
+
+What it does
+------------
+
+You create a Ruby file with commands that instructs a turtle (kame) to move around. You can tell the turtle to move forward or backward, rotate, put his pen down on the paper or pick it up. You can also change the colour of the pen and background. 
+
+The turtle starts in the top left corner of the kame window and will move from there depending on your commands.
+
+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.
+
+Install
+-------
+
+		gem install kame
+
+Simple Sample
+-------------
+
+Create a new text file called square.rb and paste the below code in and save it:
+
+		require "kame"
+
+		Kame.new do
+		  forward 100
+		  turn_right 90
+		  forward 100
+  
+		  colour :red
+		  pen_down
+  
+		  4.times do
+		    turn_right 90
+		    forward 50     
+		  end
+		end
+
+Running
+-------
+
+In the console use this:
+
+		ruby square.rb
+
+Commands
+--------
+
+To move the turtle forward by 50 pixels from it's current position, you can use the `forward` command:
+
+		forward 50
+		
+To move the turtle backward by 75 pixels from it's current position, you can use the `backward` command:
+
+		backward 75
+		
+To tell the turtle to put his pen down onto the paper use the `pen_down` command:
+		
+		pen_down
+
+To tell the turtle to pick his pen up again, use the `pen_up` command:
+
+		pen_up
+	  
+You can ask the turtle to rotate 90 degrees to the left (anti-clockwise) on the spot without moving by using the `turn_left` command:
+
+		turn_left 90
+	  
+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
+-------
+
+Here is a list of the available colours:
+
+		:white
+		:black
+		:red
+		:green
+		:blue
+		:yellow
+		:pink
+		:grey
+
+Options
+-------
+
+In addition to commanding the turtle, there are some options you can specify. You pass these options to the Kame constructor like so:
+
+		Kame.new(:width => 800, :height => 600) do
+			...
+		end
+
+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
+
+
+Contributing to kame
+--------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+---------
+
+Copyright (c) 2011 Andy Pike. See LICENSE.txt for further details.
+
+

data/Rakefile

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "kame"
+  gem.homepage = "http://github.com/andypike/kame"
+  gem.license = "MIT"
+  gem.summary = %Q{Kame (Japanese for turtle) is an implementation of the Logo programming language for kids}
+  gem.description = %Q{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)}
+  gem.authors = ["Andy Pike"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "kame #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/kame.rb

@@ -0,0 +1,77 @@
+require 'kame/kame_window'
+require 'kame/kame_colours'
+
+class Kame
+  def initialize(options = {}, &block)
+    @lines = []
+    @state = {
+      :pen_down => false,
+      :x => 0,
+      :y => 0,
+      :rotation => 0,
+      :line_colour => KameColours::lookup[:white]
+    }
+  
+    opts = {
+      :width => 640,
+      :height => 480,
+      :paper => :white,
+      :title => 'Kame',
+      :speed => 10
+    }.merge(options)
+    
+    instance_eval(&block)
+    
+    window = KameWindow.new(@lines, opts).show
+  end
+  
+  def pen_up
+    @state[:pen_down] = false
+  end
+  
+  def pen_down
+    @state[:pen_down] = true
+  end
+  
+  def pen_down?
+    @state[:pen_down]
+  end 
+  
+  def turn_left(degrees)
+    @state[:rotation] -= degrees
+  end
+  
+  def turn_right(degrees)
+    @state[:rotation] += degrees
+  end
+  
+  def colour(colour)
+    @state[:line_colour] = KameColours::lookup[colour]
+  end
+  
+  def forward(distance)
+    theta = @state[:rotation].degrees_to_radians
+    x = @state[:x] + distance * Math::cos(theta)
+    y = @state[:y] + distance * Math::sin(theta)
+    
+    if pen_down?
+      @lines << { 
+        :colour => @state[:line_colour], 
+        :from => { :x => @state[:x], :y => @state[:y] },
+        :to => { :x => x, :y => y } 
+      }
+    end
+    
+    @state[:x] = x
+    @state[:y] = y
+  end
+  
+  def backward(distance)
+    self.forward(-distance)
+  end
+  
+  def method_missing(method_name, *args)
+    puts "Sorry, but I don't know what '#{method_name}' means?"
+  end
+end
+

data/lib/kame/kame_colours.rb

@@ -0,0 +1,14 @@
+class KameColours
+  def self.lookup
+    {
+      :white => 0xffffffff,
+      :black => 0xff000000,
+      :red => 0xffff0000,
+      :green => 0xff00ff00,
+      :blue => 0xff0000ff,  
+      :yellow => 0xffffff00,
+      :pink => 0xffff00ff,
+      :grey => 0xff808080
+    }
+  end
+end

data/lib/kame/kame_window.rb

@@ -0,0 +1,44 @@
+require 'gosu'
+
+class KameWindow < Gosu::Window  
+  def initialize(lines, options)
+    @width = options[:width]
+    @height = options[:height]
+    @background_colour = Gosu::Color.argb(KameColours::lookup[options[:paper]])
+    @speed = options[:speed]
+    @lines = lines
+    @first_frame = Gosu::milliseconds
+    
+    super(@width, @height, false)
+    self.caption = options[:title]
+  end
+  
+  def draw_background
+    draw_quad(0,      0,       @background_colour,
+              @width, 0,       @background_colour,
+              0,      @height, @background_colour,
+              @width, @height, @background_colour,
+              0)
+  end
+  
+  def update
+     @this_frame = Gosu::milliseconds
+     @seconds_since_last_frame = (@this_frame - @first_frame) / 1000.0
+  end
+  
+  def draw
+    self.draw_background
+    return if @lines.nil? || @lines.count == 0
+    
+    max = (@seconds_since_last_frame * @speed).round
+    if max > @lines.count - 1
+      max = @lines.count - 1
+    end
+    
+    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)
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: kame
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.3.0
+platform: ruby
+authors: 
+- Andy Pike
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-11-10 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gosu
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+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)
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/kame.rb
+- lib/kame/kame_colours.rb
+- lib/kame/kame_window.rb
+homepage: http://github.com/andypike/kame
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1997320679435807352
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Kame (Japanese for turtle) is an implementation of the Logo programming language for kids
+test_files: []
+