gui_geometry 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'rspec', :cli => "--color" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Shane Brinkman-Davis
+
+MIT License
+
+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,70 @@
+# GuiGeometry
+
+There are a few good geometry gems already available for Ruby (ruby-geometry and geometry), but I need one which is focused on the needs of creating 2D graphical user interfaces.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gui_geometry'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gui_geometry
+
+## Usage
+
+Points are represented by X and Y coordinates:
+
+Rectangles consist of two point objects. One specifies the location of the rectangle - it's top-left corner. The other specifies its size in terms of width then height.
+
+``` ruby
+require "gui_geometry"
+include GuiGeometry::Tools
+
+# create point x == y == 0
+> point
+ => point(0,0)
+
+# create a point x=3, y=4
+> my_point = point(3,4)
+ => point(3,4)
+
+> [my_point.x, my_point.y]
+ => [3, 4]
+
+# create a rectangle with location (top-left corner) = poiunt(4,5), width=100, height=80
+> rect(4,5,100,80)
+ => rect(4,5,100,80)
+> my_rect = rect point(4,5), point(100,80) # alternate form
+ => rect(4,5,100,80)
+
+# create a rect with location == point(0,0), size = point(30,50) (width = 30, height = 50)
+> rect point(30,50)
+ => rect(0,0,30,50)
+
+# get loc and size:
+> [my_rect.loc, my_rect.size]
+ => [point(4,5), point(100,80)]
+
+# get x, y, width and height
+> [my_rect.x, my_rect.y, my_rect.w, my_rect.h]
+ => [4, 5, 100, 80]
+
+# get the 4 corners:
+> [my_rect.tl, my_rect.tr, my_rect.bl, my_rect.br]
+ => [point(4,5), point(104,5), point(4,85), point(104,85)]
+
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/gui_geometry.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gui_geometry/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "gui_geometry"
+  gem.version       = GuiGeometry::VERSION
+  gem.authors       = ["Shane Brinkman-Davis"]
+  gem.email         = ["shanebdavis@gmail.com"]
+  gem.description   = %q{2D geometry specificly designed to support graphical user interfaces and bitmaps currently focsued on Point and Rectangle classes}
+  gem.summary       = %q{2D geometry specificly designed to support graphical user interfaces and bitmaps}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-test'
+  gem.add_development_dependency 'rb-fsevent'
+  gem.add_development_dependency 'simplecov'
+end

data/lib/gui_geometry.rb

@@ -0,0 +1,13 @@
+
+%w{
+  tools
+  point
+  rectangle
+  version
+}.each do |file|
+  require File.join(File.dirname(__FILE__),"gui_geometry",file)
+end
+
+module GuiGeometry
+  # Your code goes here...
+end

data/lib/gui_geometry/point.rb

@@ -0,0 +1,26 @@
+module GuiGeometry
+class Point < Struct.new(:x, :y)
+  include Tools
+
+  def initialize(*args)
+    self.x = self.y = 0
+    super if args.length!=0
+  end
+
+  def min(b); point(super(x, b.x), super(y, b.y)); end
+  def max(b); point(super(x, b.x), super(y, b.y)); end
+
+  def inspect; "point(#{x},#{y})" end
+  def to_s; "(#{x},#{y})" end
+
+  def >=(b) x>=b.x && y>=b.y end
+  def <=(b) x<=b.x && y<=b.y end
+  def >(b) x>b.x && y>b.y end
+  def <(b) x<b.x && y<b.y end
+
+  def +(b) b.kind_of?(Point) ? point(x+b.x, y+b.y) : point(x+b, y+b) end
+  def -(b) b.kind_of?(Point) ? point(x-b.x, y-b.y) : point(x-b, y-b) end
+  def *(b) b.kind_of?(Point) ? point(x*b.x, y*b.y) : point(x*b, y*b) end
+  def /(b) b.kind_of?(Point) ? point(x/b.x, y/b.y) : point(x/b, y/b) end
+end
+end

data/lib/gui_geometry/rectangle.rb

@@ -0,0 +1,74 @@
+module GuiGeometry
+class Rectangle < Struct.new(:loc, :size)
+  include Tools
+
+  def initialize(*args)
+    case args.length
+    when 0 then super point, point
+    when 1 then super point, args[0].clone
+    when 2 then super args[0].clone, args[1].clone
+    when 4 then super point(*args[0..1]), point(*args[2..3])
+    else raise ArgumentError.new
+    end
+  end
+
+  def +(b) b.kind_of?(Point) ? rect(loc+b, size) : rect(loc+b.loc, size+b.size) end
+  def -(b) b.kind_of?(Point) ? rect(loc-b, size) : rect(loc-b.loc, size-b.size) end
+
+  def present?
+    w > 0 && h > 0
+  end
+
+  def blank?
+    !present?
+  end
+
+  def x; loc.x; end
+  def y; loc.y; end
+  def w; size.x; end
+  def h; size.y; end
+
+  def x_range; x .. (x + w - 1) end
+  def y_range; y .. (y + h - 1) end
+
+  def inspect
+    "rect"+to_s
+  end
+
+  def to_s
+    "(#{[loc.x,loc.y,size.x,size.y].join ','})"
+  end
+
+  def overlaps?(b)
+    b.loc + b.size > loc &&
+    loc + size > b.loc
+  end
+
+  def contains?(b)
+    (self & b) == self
+  end
+
+  def tl; loc; end
+  def br; loc + size; end
+  def bl; point(x, y + h); end
+  def tr; point(x + w, y); end
+
+
+  def union(b)
+    return clone unless b
+    l = loc.min(b.loc)
+    s = br.max(b.br) - l
+    rect l, s
+  end
+  alias :& :union
+
+  def intersection(b)
+    return rect unless b
+    l = loc.max(b.loc)
+    s = br.min(b.br) - l
+    return rect unless s>point
+    rect l, s
+  end
+  alias :| :intersection
+end
+end

data/lib/gui_geometry/tools.rb

@@ -0,0 +1,12 @@
+module GuiGeometry
+module Tools
+  def min(a,b) a < b ? a : b; end
+  def max(a,b) a > b ? a : b; end
+  def bound(a,bounded,c) bounded < a ? a : (bounded > c) ? c : bounded; end
+
+  def point(*args); Point.new *args end
+  def rect(*args); Rectangle.new *args end
+  def buffer(*args); Buffer.new *args end
+  def window(*args); Window.new *args end
+end
+end

data/lib/gui_geometry/version.rb

@@ -0,0 +1,3 @@
+module GuiGeometry
+  VERSION = "0.0.1"
+end

data/spec/point_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+module GuiGeometry
+describe "Point" do
+  include Tools
+
+  it "init" do
+    point.should == point(0,0)
+  end
+
+  it "+" do
+    (point(1,2) + point(3,4)).should == point(4,6)
+    (point(1,2) + 3).should == point(4,5)
+  end
+
+  it "-" do
+    (point(9,8) - point(3,4)).should == point(6,4)
+    (point(9,8) - 3).should == point(6,5)
+  end
+
+  it "*" do
+    (point(9,8) * point(3,4)).should == point(27,32)
+    (point(9,8) * 3).should == point(27,24)
+  end
+
+  it "/" do
+    (point(36,24) / point(4,3)).should == point(9,8)
+    (point(36,24) / 2).should == point(18,12)
+  end
+
+  it "==" do
+    (point(3,4) == point(3,4)).should == true
+    (point(3,4) == point(2,4)).should == false
+    (point(3,4) == point(3,3)).should == false
+  end
+
+  it "<=" do
+    (point(3,4) <= point(3,4)).should == true
+    (point(3,4) <= point(2,4)).should == false
+    (point(3,4) <= point(3,3)).should == false
+    (point(4,4) <= point(3,4)).should == false
+    (point(3,5) <= point(3,4)).should == false
+  end
+
+  it "<" do
+    (point(3,4) < point(4,5)).should == true
+    (point(3,4) < point(3,5)).should == false
+    (point(3,4) < point(4,4)).should == false
+    (point(4,4) < point(4,5)).should == false
+    (point(3,5) < point(4,5)).should == false
+  end
+
+  it ">=" do
+    (point(3,4) >= point(3,4)).should == true
+    (point(2,4) >= point(3,4)).should == false
+    (point(3,3) >= point(3,4)).should == false
+    (point(3,4) >= point(4,4)).should == false
+    (point(3,4) >= point(3,5)).should == false
+  end
+
+  it ">" do
+    (point(4,5) > point(3,4)).should == true
+    (point(3,5) > point(3,4)).should == false
+    (point(4,4) > point(3,4)).should == false
+    (point(4,5) > point(4,4)).should == false
+    (point(4,5) > point(3,5)).should == false
+  end
+
+  it "min" do
+    point(5,5).min(point(9,9)).should == point(5,5)
+    point(9,9).min(point(5,5)).should == point(5,5)
+    point(9,5).min(point(5,9)).should == point(5,5)
+    point(5,9).min(point(9,5)).should == point(5,5)
+  end
+
+  it "max" do
+    point(5,5).max(point(9,9)).should == point(9,9)
+    point(9,9).max(point(5,5)).should == point(9,9)
+    point(9,5).max(point(5,9)).should == point(9,9)
+    point(5,9).max(point(9,5)).should == point(9,9)
+  end
+end
+end

data/spec/rectangle_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module GuiGeometry
+describe "Rectangle" do
+  include Tools
+
+  it "defaults" do
+    rect.should == rect(0,0,0,0)
+    rect.should == rect(point,point)
+  end
+
+  it "invalid init" do
+    expect { rect(1,2,3,4,5) }.to raise_error
+  end
+
+  it "init with one point" do
+    rect(point(1,2)).should == rect(0,0,1,2)
+  end
+
+  it "inspect" do
+    rect.inspect.class.should == String
+  end
+
+  it "contains?" do
+    rect(0,0,10,10).contains?(rect(2,2,5,5)).should == true
+    rect(0,0,10,10).contains?(rect(8,2,5,5)).should == false
+  end
+
+  it ".overlap?" do
+    # solidly overlapping
+    rect(0,0,10,10).overlaps?(rect(0,0,10,10)).should == true
+    rect(0,0,10,10).overlaps?(rect(0,5,10,10)).should == true
+    rect(0,0,10,10).overlaps?(rect(5,0,10,10)).should == true
+
+    # just below, just to the right, just above, just to the left
+    rect(0,0,10,10).overlaps?(rect(10,0,10,10)).should == false
+    rect(0,0,10,10).overlaps?(rect(0,10,10,10)).should == false
+    rect(10,0,10,10).overlaps?(rect(0,0,10,10)).should == false
+    rect(0,10,10,10).overlaps?(rect(0,0,10,10)).should == false
+
+    # below, right, above, left
+    rect(0,0,10,10).overlaps?(rect(11,0,10,10)).should == false
+    rect(0,0,10,10).overlaps?(rect(0,11,10,10)).should == false
+    rect(11,0,10,10).overlaps?(rect(0,0,10,10)).should == false
+    rect(0,11,10,10).overlaps?(rect(0,0,10,10)).should == false
+
+    # just overlapping below, right, above, left
+    rect(0,0,10,10).overlaps?(rect(9,0,10,10)).should == true
+    rect(0,0,10,10).overlaps?(rect(0,9,10,10)).should == true
+    rect(9,0,10,10).overlaps?(rect(0,0,10,10)).should == true
+    rect(0,9,10,10).overlaps?(rect(0,0,10,10)).should == true
+  end
+
+  it ".union" do
+    (rect(0,0,10,10)   & rect(0,5,10,10)).should == rect(0,0,10,15)
+    (rect(0,0,10,10)   & rect(5,0,10,10)).should == rect(0,0,15,10)
+    (rect(20,20,10,10) & rect(0,0,10,10)).should == rect(0,0,30,30)
+  end
+
+  it ".intersection" do
+    (rect(0,0,10,10)   | rect(0,0,10,10)).should == rect(0,0,10,10)
+    (rect(0,0,10,10)   | rect(0,5,10,10)).should == rect(0,5,10,5)
+    (rect(0,0,10,10)   | rect(5,0,10,10)).should == rect(5,0,5,10)
+    (rect(0,0,10,10)   | rect(10,0,10,10)).should == rect(0,0,0,0)
+    (rect(0,0,10,10)   | rect(-5,-5,10,10)).should == rect(0,0,5,5)
+  end
+
+  it ".present?" do
+    rect(0,0,1,1).present?.should == true
+    rect(0,0,1,0).present?.should == false
+    rect(0,0,0,1).present?.should == false
+    rect(0,0,0,0).present?.should == false
+  end
+  it ".blank?" do
+    rect(0,0,1,1).blank?.should == false
+    rect(0,0,1,0).blank?.should == true
+    rect(0,0,0,1).blank?.should == true
+    rect(0,0,0,0).blank?.should == true
+  end
+end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "vendor/ruby"
+end
+
+require File.join(File.dirname(__FILE__),"..","lib","gui_geometry")

data/spec/tools_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module GuiGeometry
+describe "Tools" do
+  include Tools
+
+  it "min" do
+    min(4,5).should == 4
+  end
+end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: gui_geometry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shane Brinkman-Davis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 2D geometry specificly designed to support graphical user interfaces
+  and bitmaps currently focsued on Point and Rectangle classes
+email:
+- shanebdavis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gui_geometry.gemspec
+- lib/gui_geometry.rb
+- lib/gui_geometry/point.rb
+- lib/gui_geometry/rectangle.rb
+- lib/gui_geometry/tools.rb
+- lib/gui_geometry/version.rb
+- spec/point_spec.rb
+- spec/rectangle_spec.rb
+- spec/spec_helper.rb
+- spec/tools_spec.rb
+homepage: ''
+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: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: 2D geometry specificly designed to support graphical user interfaces and
+  bitmaps
+test_files:
+- spec/point_spec.rb
+- spec/rectangle_spec.rb
+- spec/spec_helper.rb
+- spec/tools_spec.rb