aurora-sketch 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a30dbae9c584de863771b8fc55d168ce68587f64
+  data.tar.gz: 08d3ee908cac65462bd649998e10abee1c99f971
+SHA512:
+  metadata.gz: 7cbe472f677cbab278b3c2988e4521ef056e17f0a857b4fd8a64fac247d5b8211f9829a911eacecbc67e24d56e478aab02ca349ea80c9e065ae4d62d6e7cd923
+  data.tar.gz: 66f03e9b9d37720623e616825e9731baf350bb19d523dc6d14915cbc26afead7e623c3a39d20bc668739c3dbc0a305a7969784d0ef59ef9dbdcb51d38d17353b

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+.yardoc
+Gemfile.lock
+pkg/*
+doc

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :test do
+    gem 'rake'
+end

data/README.markdown

@@ -0,0 +1,86 @@
+Sketching with Ruby
+===================
+
+[![Build Status](https://travis-ci.org/bfoz/sketch.png)](https://travis-ci.org/bfoz/sketch)
+
+Classes and methods for programmatically creating, manipulating, and exporting 
+simple geometric drawings. This gem is primarily intended to support mechanical
+design generation, but it can also handle the doodling that you used to do in 
+your notebook while stuck in that really boring class (you know the one).
+
+At its most basic, Sketch is a container for Geometry objects. The classes in 
+this gem are based on the classes provided by the Geometry gem, but have some 
+extra magic applied to support transformations, constraints, etc. Like the 
+Geometry module, Sketch assumes that primitives lie in 2D space, but doesn't 
+enforce that constraint. Please let me know if you find cases that don't work in
+higher dimensions and I'll do my best to fix them.
+
+License
+-------
+
+Copyright 2012-2014 Brandon Fosdick <bfoz@bfoz.net> and released under the BSD license.
+
+Examples
+--------
+
+A basic sketch with a single circle
+
+```ruby
+require 'sketch'
+
+sketch = Sketch.new do
+    circle center:[0,0], diameter:5	# Center = [0,0], Radius = 5
+end
+```
+
+The same sketch again, but a little more square
+
+```ruby
+Sketch.new { rectangle origin:[0,0], size:[1,1] }
+```
+
+You can also group elements for convenience
+
+```ruby
+Sketch.new do
+    group origin:[0,2] do
+        circle center:[-2, 0], radius:1
+        circle center:[2, 0], radius:1
+    end
+    circle center:[0, -1], radius:1
+end
+```
+
+There's a shortcut for when you're only creating a group to translate some elements
+
+```ruby
+Sketch.new do
+    translate [0,2] do
+        circle center:[-2, 0], radius:1
+        circle center:[2, 0], radius:1
+    end
+    circle center:[0, -1], radius:1
+end
+```
+
+Sometimes you feel like a group, sometimes you feel like a layout.
+
+```ruby
+Sketch.new do
+    layout :horizontal do
+        circle center:[-2, 0], radius:1
+        circle center:[2, 0], radius:1
+    end
+end
+```
+
+The layout command also takes options for spacing and alignment. For example, to add one unit of extra space between each element, and align them with the X-axis:
+
+```ruby
+Sketch.new do
+    layout :horizontal, spacing:1, align: :bottom do
+        circle center:[-2, 0], radius:1
+        circle center:[2, 0], radius:1
+    end
+end
+```

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.test_files = FileList['test/**/*.rb']
+  t.verbose = true
+end
+
+task :fixdates do
+    branch = `git branch --no-color -r --merged`.strip
+    `git fix-dates #{branch}..HEAD`
+end
+
+task :fixdates_f do
+    branch = `git branch --no-color -r --merged`.strip
+    `git fix-dates -f #{branch}..HEAD`
+end
+
+task :trim_whitespace do
+  system(%Q[git status --short | awk '{if ($1 != "D" && $1 != "R") print $2}' | grep -e '.*\.rb$' | xargs sed -i '' -e 's/[ \t]*$//g;'])
+end
+
+task :docs do
+    `yard`
+end

data/aurora-sketch.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "aurora-sketch"
+  s.version     = '0.0.1'
+  s.authors     = ["Brandon Fosdick", "Meseker Yohannes"]
+  s.email       = ["bfoz@bfoz.net"]
+  s.homepage    = "http://github.com/bfoz/sketch"
+  s.summary     = %q{2D mechanical sketches}
+  s.description = %q{Sketches used in the creation of mechanical designs}
+
+  s.rubyforge_project = "sketch"
+
+  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"]
+
+  s.add_dependency 'aurora-geometry', '0.0.1'
+end

data/lib/geometry/dsl/polyline.rb

@@ -0,0 +1,107 @@
+module Geometry
+    module DSL
+=begin rdoc
+When you want to draw things that are made of lots and lots of lines, this is how you do it.
+
+== Requirements
+This module is intended to be included into a Class, and that Class must provide
+some infrastructure. It must provide a push method for pushing new elements, a
+first method that returns the first vertex in the {Polyline}, and a last method
+that returns the last vertex.
+
+== Usage
+    begin
+	start_at    [0,0]
+	move_y	    1	    # Go up 1 unit
+	right	    1
+	down	    1
+	left	    1	    # Close the box
+	close		    # Unnecessary in this case
+    end
+=end
+	module Polyline
+	    BuildError = Class.new(StandardError)
+
+	    # Close the {Polyline} with a {Line}, if it isn't already closed
+	    def close
+		move_to(first) unless closed?
+	    end
+
+	    # @return [Bool]    True if the {Polyline} is closed, otherwise false
+	    def closed?
+		first == last
+	    end
+
+	    # Draw a line to the given {Point}
+	    # @param [Point]    The {Point} to draw a line to
+	    def move_to(point)
+		push Point[point]
+	    end
+
+	    # Move the specified distance along the X axis
+	    # @param [Number] distance  The distance to move
+	    def move_x(distance)
+		push (last || PointZero) + Point[distance, 0]
+	    end
+
+	    # Move the specified distance along the Y axis
+	    # @param [Number] distance  The distance to move
+	    def move_y(distance)
+		push (last || PointZero) + Point[0, distance]
+	    end
+
+	    # Specify a starting point. Can't be specified twice, and only required if no other entities have been added.
+	    # #param [Point] point  The starting point
+	    def start_at(point)
+		raise BuildError, "Can't specify a start point more than once" if first
+		push Point[point]
+	    end
+
+	    # @group Relative Movement
+
+	    # Move the specified distance along the +Y axis
+	    # @param [Number] distance  The distance to move in the +Y direction
+	    def up(distance)
+		move_y distance
+	    end
+
+	    # Move the specified distance along the -Y axis
+	    # @param [Number] distance  The distance to move in the -Y direction
+	    def down(distance)
+		move_y -distance
+	    end
+
+	    # Move the specified distance along the -X axis
+	    # @param [Number] distance  The distance to move in the -X direction
+	    def left(distance)
+		move_x -distance
+	    end
+
+	    # Move the specified distance along the +X axis
+	    # @param [Number] distance  The distance to move in the +X direction
+	    def right(distance)
+		move_x distance
+	    end
+
+	    # Draw a vertical line to the given y-coordinate while preserving the
+	    # x-coordinate of the previous {Point}
+	    # @param y [Number] the y-coordinate to move to
+	    def vertical_to(y)
+		push Point[last.x, y]
+	    end
+	    alias :down_to :vertical_to
+	    alias :up_to :vertical_to
+
+	    # Draw a horizontal line to the given x-coordinate while preserving the
+	    # y-coordinate of the previous {Point}
+	    # @param x [Number] the x-coordinate to move to
+	    def horizontal_to(x)
+		push [x, last.y]
+	    end
+	    alias :left_to :horizontal_to
+	    alias :right_to :horizontal_to
+
+	    # @endgroup
+	end
+    end
+end

data/lib/geometry/dsl/turtle.rb

@@ -0,0 +1,64 @@
+module Geometry
+    module DSL
+=begin
+An implementation of {http://en.wikipedia.org/wiki/Turtle_graphics Logo Turtle-style} commands
+
+== Examples
+Draw a square...
+
+    PolygonBuilder.new.evaluate do
+        start_at [0,0]	# Every journey begins with a single point...
+        move_to [1,0]	# Draw a line to a new point
+        turn_left 90
+        move 1		# Same as forward 1
+        turn_left 90
+        forward 1
+    end
+
+The same thing, but more succint:
+
+    PolygonBuilder.new.evaluate do
+        start_at [0,0]
+        move [1,0]	# Move and draw using a vector distance
+        move [0,1]
+        move [-1,0]
+    end
+ =end
+	module Turtle
+	    # Turn left by the given number of degrees
+	    def turn_left(angle)
+		@direction += angle if @direction
+		@direction ||= angle
+	    end
+
+	    # Turn right by the given number of degrees
+	    def turn_right(angle)
+		turn_left -angle
+	    end
+
+	    # Draw a line by moving a given distance
+	    # @overload move(Numeric)
+	    #  Same as forward(Numeric)
+	    # @overload move(Array)
+	    # @overload move(x,y)
+	    def move(*distance)
+		return forward(*distance) if (1 == distance.size) && distance[0].is_a?(Numeric)
+
+		if distance[0].is_a?(Vector)
+		    distance = distance[0]
+		elsif distance[0].is_a?(Array)
+		    distance = Vector[*(distance[0])]
+		end
+
+		push(last + distance)
+	    end
+
+	    # Move the specified distance in the current direction
+	    def forward(distance)
+		@direction ||= 0	# direction defaults to 0
+		radians = @direction * Math::PI / 180
+		push(last + Vector[distance*Math.cos(radians),distance*Math.sin(radians)])
+	    end
+	end
+    end
+end

data/lib/sketch.rb

@@ -0,0 +1,180 @@
+require 'geometry'
+require_relative 'sketch/builder'
+require_relative 'sketch/point.rb'
+
+=begin
+A Sketch is a container for Geometry objects.
+=end
+
+class Sketch
+    attr_reader :elements
+    attr_accessor :transformation
+
+    Arc = Geometry::Arc
+    Circle = Geometry::Circle
+    Line = Geometry::Line
+    Rectangle = Geometry::Rectangle
+    Square = Geometry::Square
+
+    def initialize(&block)
+	@elements = []
+	instance_eval(&block) if block_given?
+    end
+
+    # Define a class parameter
+    # @param [Symbol] name  The name of the parameter
+    # @param [Proc] block   A block that evaluates to the desired value of the parameter
+    def self.define_parameter name, &block
+	define_method name do
+	    @parameters ||= {}
+	    @parameters.fetch(name) { |k| @parameters[k] = instance_eval(&block) }
+	end
+    end
+
+    # Define an instance parameter
+    # @param [Symbol] name	The name of the parameter
+    # @param [Proc] block	A block that evaluates to the desired value of the parameter
+    def define_parameter name, &block
+	singleton_class.send :define_method, name do
+	    @parameters ||= {}
+	    @parameters.fetch(name) { |k| @parameters[k] = instance_eval(&block) }
+	end
+    end
+
+# @group Accessors
+    # @attribute [r] bounds
+    #   @return [Rectangle] The smallest axis-aligned {Rectangle} that encloses all of the elements
+    def bounds
+	Rectangle.new(*minmax)
+    end
+
+    # @attribute [r] first
+    #   @return [Geometry] first the first Geometry element of the {Sketch}
+    def first
+	elements.first
+    end
+
+    # @attribute [r] geometry
+    #   @return [Array] All elements rendered into Geometry objects
+    def geometry
+	@elements
+    end
+
+    # @attribute [r] last
+    #  @return [Geometry] the last Geometry element of the {Sketch}
+    def last
+	elements.last
+    end
+
+    # @attribute [r] max
+    # @return [Point]
+    def max
+	minmax.last
+    end
+
+    # @attribute [r] min
+    # @return [Point]
+    def min
+	minmax.first
+    end
+
+    # @attribute [r] minmax
+    # @return [Array<Point>]
+    def minmax
+	return [nil, nil] unless @elements.size != 0
+
+	memo = @elements.map {|e| e.minmax }.reduce {|memo, e| [Point[[memo.first.x, e.first.x].min, [memo.first.y, e.first.y].min], Point[[memo.last.x, e.last.x].max, [memo.last.y, e.last.y].max]] }
+	if self.transformation
+	    if self.transformation.has_rotation?
+		# If the transformation has a rotation, convert the minmax into a bounding rectangle, rotate it, then find the new minmax
+		point1, point3 = Point[memo.last.x, memo.first.y], Point[memo.first.x, memo.last.y]
+		points = [memo.first, point1, memo.last, point3].map {|point| self.transformation.transform(point) }
+		points.reduce([points[0], points[2]]) {|memo, e| [Point[[memo.first.x, e.x].min, [memo.first.y, e.y].min], Point[[memo.last.x, e.x].max, [memo.last.y, e.y].max]] }
+	    else
+		memo.map {|point| self.transformation.transform(point) }
+	    end
+	else
+	    memo
+	end
+    end
+
+    # @attribute [r] size
+    # @return [Size]	The size of the {Rectangle} that bounds all of the {Sketch}'s elements
+    def size
+	Size[self.minmax.reverse.reduce(:-).to_a]
+    end
+
+# @endgroup
+
+    # Append the given {Geometry} element and return the {Sketch}
+    # @param element	[Geometry]	the {Geometry} element to append
+    # @param args	[Array]		optional transformation parameters
+    # @return [Sketch]
+    def push(element, *args)
+	options, args = args.partition {|a| a.is_a? Hash}
+	options = options.reduce({}, :merge)
+
+	if options and (options.size != 0) and (element.respond_to? :transformation)
+	    element.transformation = Geometry::Transformation.new options
+	end
+
+	@elements.push(element)
+	self
+    end
+
+# @group Geometry creation
+
+    # Create and append a new {Arc} object
+    # @param (see Arc#initialize)
+    # @return [Arc]
+    def add_arc(*args)
+	@elements.push(Arc.new(*args)).last
+    end
+
+    # Create and append a new {Circle} object given a center point and radius
+    # @param	[Point]	    center  The circle's center point
+    # @param	[Number]    radius  The circle's radius
+    # @return	[Circle]    A new {Circle}
+    def add_circle(*args)
+	@elements.push Circle.new(*args)
+	@elements.last
+    end
+
+    # Create a Line using any arguments that work for {Geometry::Line}
+    def add_line(*args)
+	@elements.push Line[*args]
+	@elements.last
+    end
+
+    # Create a Point with any arguments that work for {Geometry::Point}
+    def add_point(*args)
+	@elements.push Point[*args]
+	@elements.last
+    end
+
+    # Create a {Rectangle}
+    def add_rectangle(*args)
+	@elements.push Rectangle.new(*args)
+	@elements.last
+    end
+
+    # Create a Square with sides of the given length
+    # @param [Numeric] length	The length of the sides of the square
+    def add_square(length)
+	push Geometry::CenteredSquare.new [0,0], length
+	@elements.last
+    end
+
+    # Create and add a {Triangle}
+    # @param (see Triangle::new)
+    def add_triangle(*args)
+	push Geometry::Triangle.new *args
+    end
+
+# @endgroup
+
+end
+
+def Sketch(&block)
+    Sketch::Builder.new &block
+end