trtl 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in trtl.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Peter Cooper
+
+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,62 @@
+# Trtl - Simple Ruby Turtle Graphics
+
+![example session](http://no.gd/p/trtl-20120708-034138.jpg)
+
+## Installation
+    gem install trtl
+
+## Description
+
+Trtl is a simple turtle system inspired by Python's turtle.py. It provides
+simple turtle drawing capabilities in Ruby, even if you're just at an IRb 
+prompt. It leans on Tk which is part of MRI 1.9's standard library so in theory it should
+work 'out of the box' with most MRI 1.9 installs.
+
+## Usage
+
+If Trtl detects you're in an IRb or Pry session, it'll automatically make turtle
+methods available directly at the prompt. For example:
+
+    $ irb
+    > require 'trtl'
+    > forward 100
+    # At this point, a window appears with the turtle
+
+If you wish to use Trtl from a regular Ruby script, you have a few options. You
+can create a Trtl instance and use it directly:
+
+    require 'trtl'
+    t = Trtl.new
+    10.times { t.left(24); t.forward(30); t.ensure_drawn }
+    t.wait
+
+You can use Trtl's `run` method to use it in a more interactive fashion:
+
+	Trtl.new.run { 10.times { left(24); forward(30); ensure_drawn } }
+
+Or you can include InteractiveTurtle and get a similar effect as if you were in
+IRb:
+
+    include InteractiveTurtle
+    10.times { left(24); forward(30) }
+
+Note: Using InteractiveTurtle makes drawing slower as it ensures all graphics
+are drawn after every action (as necessary for IRb use).
+
+## Examples
+
+The examples in the `examples` folder should be reasonably illustrative. If you
+try any of them, try `example4.rb` - it renders an awesome looking tree.
+
+![tree](http://no.gd/p/trtltree-20120708-035127.jpg)
+
+## Credits
+
+* turtle.py for inspiration
+* Some of the examples taken from examples for an earlier Ruby turtle found at http://www.rubyquiz.com/quiz104.html
+
+## Copyright and License
+
+Copyright (c) 2012 Peter Cooper (other than minor parts of some samples.)
+
+MIT licensed. See LICENSE.md

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new
+task :default => :test

data/examples/example1.rb

@@ -0,0 +1,14 @@
+require_relative '../lib/trtl'
+
+# Example of using Trtl in a 'simple' interactive fashion
+
+# In irb or pry this isn't needed as InteractiveTurtle will be
+# included by default.
+include InteractiveTurtle
+
+10.times do 
+  left(24)
+  forward(30)
+end
+
+wait

data/examples/example2.rb

@@ -0,0 +1,14 @@
+require_relative '../lib/trtl'
+
+# Example of using Trtl in a more traditional fashion
+
+t = Trtl.new
+
+10.times do 
+  t.left(24)
+  t.forward(30)
+  t.dot
+  t.ensure_drawn
+end
+
+gets

data/examples/example3.rb

@@ -0,0 +1,21 @@
+require_relative '../lib/trtl'
+
+include InteractiveTurtle
+
+# Example below taken from Ruby quiz turtle_graphics archive
+# http://www.rubyquiz.com/quiz104.html
+
+# BYZANTIUM
+
+def byzantium(r, n)
+   return if n < 1
+   fd r; rt 135
+   4.times {
+      pd; fd 2 * r * Math.sin(45 * DEG); pu
+      byzantium(r / 2, n - 1)
+      rt 90
+   }
+   lt 135; bk r
+end
+
+byzantium(100, 4)

data/examples/example4.rb

@@ -0,0 +1,33 @@
+require_relative '../lib/trtl'
+
+# Example below adapted from Ruby quiz turtle_graphics archive
+# http://www.rubyquiz.com/quiz104.html
+
+# TREE
+
+Trtl.new(:width => 2, :color => 'brown').run do
+   def tree(_size)
+      if _size < 10
+         forward _size; back _size; return
+      end
+      color 'brown'
+      forward _size / 3
+      color %w{green darkgreen darkolivegreen}.sample
+      left 30; tree _size * 2 / 3; right 30
+      forward _size / 6
+      right 25; tree _size / 2; left 25
+      forward _size / 3
+      width rand(2) + 1
+      right 25; tree _size / 2; left 25
+      forward _size / 6
+      back _size
+      ensure_drawn
+   end
+   
+   left 90
+   back 180
+   pen_down
+   tree 300.0
+
+   wait
+end

data/examples/example5.rb

@@ -0,0 +1,12 @@
+require_relative '../lib/trtl'
+
+t = Trtl.new :color => 'blue', :width => 5
+
+10.times do 
+  t.circle rand(100), 180, rand(10) + 15
+  t.dot 20
+  t.forward rand(100)
+  t.color %w{blue cyan yellow}.sample
+end
+
+t.wait

data/examples/example6.rb

@@ -0,0 +1,12 @@
+require_relative '../lib/trtl'
+
+Trtl.new(:color => 'blue', :width => 5).run do
+	10.times do 
+	  circle rand(100), 180, rand(10) + 15
+	  dot 20
+	  forward rand(100)
+	  color %w{blue cyan yellow}.sample
+	end
+	
+	wait
+end

data/lib/trtl.rb

@@ -0,0 +1,171 @@
+require 'tk'
+
+class Trtl
+  VERSION = "0.0.1"
+
+  CANVAS_WIDTH = 800
+  CANVAS_HEIGHT = 600
+  HOME_X = CANVAS_WIDTH / 2
+  HOME_Y = CANVAS_HEIGHT / 2
+  COLORS = %w{red blue green white cyan pink yellow}
+  DEG = Math::PI / 180.0
+
+  attr_accessor :heading, :x, :y
+  attr_writer :color, :width
+  attr_reader :canvas
+
+  def initialize(options = {})
+    @color = options[:color] || COLORS.sample
+    @interactive = options[:interactive]
+    @canvas = options[:canvas] || self.class.canvas
+    @width = options[:width] || 1
+    @drawing = true
+    home
+    draw
+  end
+
+  def self.canvas
+    return @canvas if @canvas
+
+    root = TkRoot.new(:title => 'trtl', :minsize => [CANVAS_WIDTH, CANVAS_HEIGHT])
+    @canvas = TkCanvas.new(root, :bg => 'black', :highlightthickness => 0, :width => CANVAS_WIDTH, :height => CANVAS_HEIGHT)
+    @canvas.pack(:fill => 'both', :expand => 1)
+    @canvas
+  end
+
+  def pen_up
+    @drawing = false
+  end
+  
+  def pen_down
+    @drawing = true
+  end
+
+  def is_drawing?
+    @drawing
+  end
+
+  def color(color)
+    @color = color.to_s
+  end
+
+  def width(width)
+    @width = width
+  end
+  
+  def forward(amount = 20)
+    new_x = (@x + dx * amount)
+    new_y = (@y + dy * amount)
+    move(new_x, new_y)
+  end
+
+  def back(amount = 20)
+    new_x = (@x - dx * amount)
+    new_y = (@y - dy * amount)
+    move(new_x, new_y)
+  end
+  
+  def move(new_x, new_y)
+    TkcLine.new(canvas, @x, @y, new_x, new_y, :width => @width, :fill => @color) if @drawing
+    @x, @y = new_x, new_y
+    draw
+  end
+  
+  def right(offset)
+    @heading = (@heading + offset) % 360
+    draw
+  end
+  
+  def left(offset)
+    @heading = (@heading - offset) % 360
+    draw
+  end
+
+  def dot(size = nil)
+    size ||= [@width + 4, @width * 2].max
+    TkcOval.new(canvas, @x - size / 2, @y - size / 2, @x + size / 2, @y + size / 2, :fill => @color, :outline => @color)
+  end
+
+  # TODO / TOFIX: This is horribly wrong with the fewer steps due to circumference varying ;-)
+  def circle(radius, extent = 360, steps = 360)
+    circumference = (Math::PI * 2 * radius) * (extent / 360.0)
+    steps.times do
+      left extent / steps.to_f
+      forward circumference / steps.to_f
+    end
+  end
+
+  def position
+    [@x, @y]
+  end
+
+  def home
+    @x = HOME_X
+    @y = HOME_Y
+    @heading = 0
+    draw
+  end
+
+  def sleep(time = 100000)
+    Tk.sleep(time)
+  end
+
+  def ensure_drawn
+    sleep 30
+  end
+
+  def wait
+    ensure_drawn and gets
+  end
+
+  alias :run :instance_eval
+
+  # Compatibility aliases (with turtle.py and KidsRuby primarily)
+  alias :fd :forward
+  alias :bk :back
+  alias :rt :right
+  alias :lt :left
+  alias :pu :pen_up
+  alias :pd :pen_down
+  alias :penup :pen_up
+  alias :pendown :pen_down
+  alias :up :pen_up
+  alias :down :pen_down
+  alias :turnright :right
+  alias :turnleft :left
+  alias :backward :back
+  alias :pencolor :color
+  alias :goto :move
+  alias :setpos :move
+  alias :setposition :move
+  alias :pos :position
+
+  private
+  def dx
+    Math.cos(@heading * DEG)
+  end
+  
+  def dy
+    Math.sin(@heading * DEG)
+  end
+
+  def draw
+    canvas.delete(@turtle_line) if @turtle_line
+    @turtle_line = TkcLine.new(canvas, @x, @y, @x + dx * 5 , @y + dy * 5, :arrow => 'last', :width => 10, :fill => @color)
+    # Can probably just use ensure_drawn actually..
+    TkTimer.new(60, 1) { Tk.update }.start.wait if @interactive
+    true
+  end
+end
+
+module InteractiveTurtle
+  DEG = Math::PI / 180.0
+
+  Trtl.instance_methods(false).each do |meth|
+    define_method meth do |*args, &p|
+      (@turtle ||= ::Trtl.new(:interactive => true)).send(meth, *args, &p)
+    end
+  end
+end
+
+include InteractiveTurtle if %w{irb pry}.include?($0)

data/test/helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'trtl'

data/test/test_trtl.rb

@@ -0,0 +1,64 @@
+require_relative 'helper'
+
+# Note: Only very simple high level tests here. Just stretching 
+#       some of the public API. One day I may care to stub out Tk ;-)
+
+describe Trtl do
+  before do
+    @trtl = Trtl.new
+  end
+
+  it "gets a default canvas when none is provided" do
+    @trtl.canvas.must_be_instance_of TkCanvas
+  end
+
+  it "has pen down by default" do
+    @trtl.is_drawing?.must_equal true
+  end
+
+  it "can have pen moved up" do
+    @trtl.pen_up
+    @trtl.is_drawing?.must_equal false    
+  end
+
+  it "has default X and Y set" do
+    @trtl.x.must_equal Trtl::CANVAS_WIDTH / 2
+    @trtl.y.must_equal Trtl::CANVAS_HEIGHT / 2
+  end
+
+  it "can report its position" do
+    @trtl.position.must_equal [@trtl.x, @trtl.y]
+  end
+
+  it "can rotate and change heading" do
+    @trtl.left 20
+    @trtl.heading.must_equal 340
+    @trtl.right 40
+    @trtl.heading.must_equal 20
+  end
+
+  it "can move in straight lines" do
+    start_x, start_y = @trtl.position
+    @trtl.heading = 0
+    @trtl.forward 50
+    @trtl.x.must_equal start_x + 50
+    @trtl.heading = 90
+    @trtl.forward 50
+    @trtl.y.must_equal start_y + 50
+    @trtl.back 50
+    @trtl.y.must_equal start_y
+  end
+
+  it "can move at angles" do
+    start_x, start_y = @trtl.position
+    @trtl.heading = 45
+    @trtl.forward 100
+    @trtl.x.must_be_close_to start_x + 100 / Math.sqrt(2)
+    @trtl.y.must_be_close_to start_y + 100 / Math.sqrt(2)
+  end
+
+  it "can be moved absolutely" do
+    @trtl.move(310, 201)
+    @trtl.position.must_equal [310, 201]
+  end
+end

data/trtl.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "trtl"
+
+Gem::Specification.new do |s|
+  s.name        = "trtl"
+  s.version     = Trtl::VERSION
+  s.authors     = ["Peter Cooper"]
+  s.email       = ["git@peterc.org"]
+  s.homepage    = "https://github.com/peterc/trtl"
+  s.summary     = %q{Ruby turtle graphics (ideal for use from IRb)}
+  s.description = %q{A Logo / turtle.py style turtle graphics system for Ruby}
+
+  s.rubyforge_project = "trtl"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: trtl
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Peter Cooper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-08 00:00:00.000000000 Z
+dependencies: []
+description: A Logo / turtle.py style turtle graphics system for Ruby
+email:
+- git@peterc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- examples/example1.rb
+- examples/example2.rb
+- examples/example3.rb
+- examples/example4.rb
+- examples/example5.rb
+- examples/example6.rb
+- lib/trtl.rb
+- test/helper.rb
+- test/test_trtl.rb
+- trtl.gemspec
+homepage: https://github.com/peterc/trtl
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: trtl
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby turtle graphics (ideal for use from IRb)
+test_files:
+- test/helper.rb
+- test/test_trtl.rb