gosu_enhanced 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c8c0ff47fba5b897c2f6066b9f4306cdae9f42b
-  data.tar.gz: ad4815c8c03d03ab0483b7b77f094e68a7a26eed
+  metadata.gz: c5dd0948ca7db7ec8a520b70f29b267aa8883eaf
+  data.tar.gz: 8a160117c73e5d9d67bc751b63ad44784bdda3f3
 SHA512:
-  metadata.gz: 197ec5637526f565b3594ed2e3653812c753bdcf45336cfecd0e05ed28936fc32ce239541052835934f738f2ecbde49c3fc8d34d9bc806a49942f37bf64976d7
-  data.tar.gz: d50c833a17e528fca792fa1ea0c3a9ac656fa9ec0b274833b7b74a99e0d10953c70196a3893db943dfe5fa42bc647e56b9d8b54522a5235eb0fecdcf106a5d15
+  metadata.gz: e13b5c1e84a17fb7a7c6323e13cf2d957e37a495245d3025c2bf24a6bc1dae1469163ce79e6db3081ec47da64efec9adb8834d35bc8c305233dde60b74019f64
+  data.tar.gz: bc0fe6bc7545d2cfe6efe5a567b7aabd0adda888bf4a5b09dbdaf74581d793b7d944117ad5444f278cdc2adb2ea040752d62d91100d1dcb2e0b4eb92417d124a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gosu_enhanced (0.1.0)
+    gosu_enhanced (0.2.0)
       gosu (~> 0.7)
 
 GEM

data/README.md

@@ -4,23 +4,28 @@ Some added classes for using Gosu.
 
 ## Point
 
-Holds a set of (x, y) co-ordinates. Allows for offsetting and moving by another Point
-or a pair of co-ordinates.
+Holds a set of (x, y) co-ordinates. Allows for offsetting and moving by another 
+Point or a pair of co-ordinates.
 
 ## Size
 
-Holds a (width, height) size. Allows for inflation / deflation with another size or
-a pair of sizes.
+Holds a (width, height) size. Allows for inflation / deflation with another
+size or a pair of sizes.
+
+## Region
+
+Holds a position and size. Delegates movement and size change to its 
+constituents.
 
 ## Gosu::Window
 
-Added #draw_rectangle which draws a simple rectangle specified with a Point and Size
-in one colour.
+Added #draw_rectangle which draws a simple rectangle specified with a Point 
+and Size in one colour.
 
 ## Gosu::Font
 
-Added #measure and #centred_in which measure a piece of text and centre it in a
-given Size.
+Added #measure and #centred_in which measure a piece of text and centre it in
+a given Size.
 
 ## Installation
 

data/gosu_enhanced.gemspec

@@ -9,11 +9,11 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Julian Nicholls"]
   spec.email         = ["juliannicholls29@gmail.com"]
   spec.summary       = %q{Enhanced versions of some Gosu classes.}
-  spec.description   = %q{Point and Size classes to hold pixel addresses and 
+  spec.description   = %q{Point, Size, and Region classes to hold pixel addresses and 
 rectangle sizes respectively. Updated window class to draw rectangle in a single 
 colour more easily. Updated font class to measure text and return co-ordinates 
 to centre a piece of text in a rectangle size.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/JulianNicholls/gosu_enhanced-gem"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/gosu_enhanced.rb

@@ -4,4 +4,5 @@ require "gosu_enhanced/version"
 
 require 'gosu_enhanced/point'
 require 'gosu_enhanced/size'
+require 'gosu_enhanced/region'
 require 'gosu_enhanced/enhanced'

data/lib/gosu_enhanced/region.rb

@@ -0,0 +1,44 @@
+require 'forwardable'
+
+module GosuEnhanced
+  # Hold a rectangular region specified by a Point and a Size
+  # Most functions are delegated to the constituent Point and Size
+  class Region
+    extend Forwardable
+    
+    def_delegators :@position, :move_by!, :move_to!, :x, :y
+    def_delegators :@size, :inflate!, :deflate!, :width, :height
+    
+    attr_reader :position, :size
+    
+    def initialize( pos, size )
+      @position, @size = pos.dup, size.dup
+    end
+    
+    def contains?( col, row = nil )
+      if col.respond_to? :x
+        col.x.between?( left, left + width - 1 ) && 
+        col.y.between?( top, top + height - 1 )
+      else
+        col.between?( left, left + width - 1 ) && 
+        row.between?( top, top + height - 1 )
+      end        
+    end
+    
+    def top
+      position.y
+    end
+    
+    def left
+      position.x
+    end
+  
+    def dup
+      Region.new( position.dup, size.dup )
+    end
+    
+    def draw( surface, z, colour )
+      surface.draw_rectangle( position, size, z, colour )
+    end
+  end
+end

data/lib/gosu_enhanced/size.rb

@@ -1,9 +1,16 @@
 module GosuEnhanced
   # Hold a 2-dimensional size and allow for inflation / deflation
-  class Size < Struct.new( :width, :height )
-    # Inflation with a negative value or deflation is not allowed to make a 
-    # dimension negative.
-  
+  class Size
+    attr_reader :width, :height
+    
+    # Neither dimension can be negative, since that doesn't make sense.
+    # The values are checked on inflation / deflation.
+    
+    def initialize( w, h )
+      @width, @height = w, h
+      validate( 0, 0 )
+    end
+    
     def inflate( by_w, by_h = nil )
       if by_w.respond_to? :width
         validate( by_w.width, by_w.height )
@@ -28,13 +35,13 @@ module GosuEnhanced
       if by_w.respond_to? :width
         validate( by_w.width, by_w.height )
         
-        self.width  += by_w.width
-        self.height += by_w.height
+        @width  += by_w.width
+        @height += by_w.height
       else
         validate( by_w, by_h )
         
-        self.width  += by_w
-        self.height += by_h
+        @width  += by_w
+        @height += by_h
       end
     end
 
@@ -46,6 +53,9 @@ module GosuEnhanced
       end
     end
     
+    def ==( other )
+      width == other.width && height == other.height
+    end
     private
     
     def validate( by_w, by_h )

data/lib/gosu_enhanced/version.rb

@@ -1,3 +1,3 @@
 module GosuEnhanced
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/point_spec.rb

@@ -2,11 +2,25 @@ require 'spec_helper'
 
 describe GosuEnhanced::Point do
   describe '#initialize' do
-    it 'should work with two values' do
+    it 'should work with two positive values' do
       point = GosuEnhanced::Point.new( 10, 20 )
       expect( point.x ).to eq 10
       expect( point.y ).to eq 20
     end
+
+    it 'should work with negative values' do
+      point = GosuEnhanced::Point.new( -10, 20 )
+      expect( point.x ).to eq -10
+      expect( point.y ).to eq 20
+
+      point = GosuEnhanced::Point.new( 10, -20 )
+      expect( point.x ).to eq 10
+      expect( point.y ).to eq -20
+
+      point = GosuEnhanced::Point.new( -10, -20 )
+      expect( point.x ).to eq -10
+      expect( point.y ).to eq -20
+    end
   end
   
   describe '#offset' do

data/spec/region_delegation_spec.rb

@@ -0,0 +1,152 @@
+require 'spec_helper'
+
+describe GosuEnhanced::Region do
+  let( :point ) { GosuEnhanced::Point.new( 10, 20 ) }
+  let( :size )  { GosuEnhanced::Size.new( 30, 40 ) }
+  
+  describe '#y' do
+    it 'should return the top (y) co-ordinate' do |variable|
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.y ).to eq 20
+    end
+  end
+
+  describe '#x' do
+    it 'should return the left (x) co-ordinate' do |variable|
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.x ).to eq 10
+    end
+  end
+
+  describe '#width' do
+    it 'should return the width' do |variable|
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.width ).to eq 30
+    end
+  end
+
+  describe '#height' do
+    it 'should return the height' do |variable|
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.height ).to eq 40
+    end
+  end
+  
+  describe '#move_by!' do
+    it 'should work with a Point' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_by!( GosuEnhanced::Point.new( 30, 40 ) )
+      expect( reg.left ).to eq 40
+      expect( reg.top ).to  eq 60
+      
+      expect( point.x ).to eq 10
+      expect( point.y ).to eq 20
+    end
+    
+    it 'should work with two positive values' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_by!( 40, 50 )
+      expect( reg.left ).to eq 50
+      expect( reg.top ).to  eq 70
+    end
+
+    it 'should work with two negative values' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_by!( -5, -10 )
+      expect( reg.left ).to eq 5
+      expect( reg.top ).to  eq 10
+    end
+
+    it 'should work with values that result in negative co-ordinates' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_by!( -80, -150 )
+      expect( reg.left ).to eq -70
+      expect( reg.top ).to  eq -130
+    end
+  end
+  
+  describe '#move_to!' do
+    it 'should work with a Point' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_to!( GosuEnhanced::Point.new( 30, 40 ) )
+      expect( reg.left ).to eq 30
+      expect( reg.top ).to  eq 40
+      
+      expect( point.x ).to eq 10
+      expect( point.y ).to eq 20
+    end
+    
+    it 'should work with two positive values' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_to!( 40, 50 )
+      expect( reg.left ).to eq 40
+      expect( reg.top ).to  eq 50
+    end
+
+    it 'should work with two negative values' do
+      reg = GosuEnhanced::Region.new( point, size )
+      reg.move_to!( -5, -10 )
+      expect( reg.left ).to eq -5
+      expect( reg.top ).to  eq -10
+    end
+
+    describe '#inflate!' do
+      it 'should work with a Size' do
+        reg = GosuEnhanced::Region.new( point, size )
+        reg.inflate!( GosuEnhanced::Size.new( 30, 40 ) )
+        expect( reg.width ).to eq 60
+        expect( reg.height ).to eq 80
+      
+        expect( size.width ).to eq 30
+        expect( size.height ).to eq 40
+      end
+
+      it 'should work with two values' do
+        reg = GosuEnhanced::Region.new( point, size )
+        reg.inflate!( 40, 50 )
+        expect( reg.width ).to eq 70
+        expect( reg.height ).to eq 90
+      end
+
+      it 'should work with negative values' do
+        reg = GosuEnhanced::Region.new( point, size )
+        reg.inflate!( -20, -35 )
+        expect( reg.width ).to eq 10
+        expect( reg.height ).to eq 5
+      end
+
+      it 'should raise an error with out-of-range values' do
+        reg = GosuEnhanced::Region.new( point, size )
+        expect { reg.inflate!( -50, -20 ) }.to raise_error Exception
+        expect { reg.inflate!( -25, -60 ) }.to raise_error Exception
+        expect { reg.inflate!( -50, -70 ) }.to raise_error Exception
+      end
+    end
+
+    describe '#deflate!' do
+      it 'should work with a Size' do
+        reg = GosuEnhanced::Region.new( point, size )
+        reg.deflate!( GosuEnhanced::Size.new( 20, 35 ) )
+        expect( reg.width ).to eq 10
+        expect( reg.height ).to eq 5
+    
+        expect( size.width ).to eq 30
+        expect( size.height ).to eq 40
+      end
+
+      it 'should work with two values' do
+        reg = GosuEnhanced::Region.new( point, size )
+        reg.deflate!( 10, 25 )
+        expect( reg.width ).to eq 20
+        expect( reg.height ).to eq 15
+      end
+
+      it 'should raise an error for out-of-range values' do
+        reg = GosuEnhanced::Region.new( point, size )
+        expect { reg.deflate!( 25, 50 ) }.to raise_error Exception
+        expect { reg.deflate!( 60, 35 ) }.to raise_error Exception
+        expect { reg.deflate!( 80, 70 ) }.to raise_error Exception
+      end
+    end
+  end
+end

data/spec/region_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+
+describe GosuEnhanced::Region do
+  let( :point ) { GosuEnhanced::Point.new( 10, 20 ) }
+  let( :size )  { GosuEnhanced::Size.new( 30, 40 ) }
+  
+  describe '#initialize' do
+    it 'should work with a Point and a Size' do
+      reg = GosuEnhanced::Region.new( point, size )
+    end
+  end
+  
+  describe '#position' do
+    it 'should return the position as a Point' do
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.position ).to eq GosuEnhanced::Point.new( 10, 20 )
+    end
+  end
+  
+  describe '#top' do
+    it 'should return the top co-ordinate' do |variable|
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.top ).to eq 20
+    end
+  end
+
+  describe '#left' do
+    it 'should return the left co-ordinate' do |variable|
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.left ).to eq 10
+    end
+  end
+
+  describe '#size' do
+    it 'should return the size as a Size' do
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.size ).to eq GosuEnhanced::Size.new( 30, 40 )
+    end
+  end
+  
+  describe '#contains?' do
+    it 'should work with two co-ordinates' do
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.contains?( 10, 20 ) ).to be true
+      expect( reg.contains?( 20, 35 ) ).to be true
+      expect( reg.contains?( 29, 59 ) ).to be true
+      expect( reg.contains?( 30, 60 ) ).to be false
+    end
+
+    it 'should work with a Point' do
+      reg = GosuEnhanced::Region.new( point, size )
+      expect( reg.contains?( GosuEnhanced::Point.new( 10, 20 ) ) ).to be true
+      expect( reg.contains?( GosuEnhanced::Point.new( 20, 35 ) ) ).to be true
+      expect( reg.contains?( GosuEnhanced::Point.new( 29, 59 ) ) ).to be true
+      expect( reg.contains?( GosuEnhanced::Point.new( 30, 60 ) ) ).to be false
+    end
+  end
+  
+  # Unlike the Point and Size, a Region needs a dup override to actually return
+  # a duplicate correctly.
+  
+  describe '#dup' do
+    it 'should duplicate a region' do
+      reg     = GosuEnhanced::Region.new( point, size )
+      new_reg = reg.dup
+
+      expect( reg.position ).to eq GosuEnhanced::Point.new( 10, 20 )
+      expect( reg.size ).to eq GosuEnhanced::Size.new( 30, 40 )
+
+      expect( new_reg.position ).to eq GosuEnhanced::Point.new( 10, 20 )
+      expect( new_reg.size ).to eq GosuEnhanced::Size.new( 30, 40 )
+
+      new_reg.move_to!( 20, 30 )
+      new_reg.inflate!( 10, 10 )
+      expect( new_reg.position ).to eq GosuEnhanced::Point.new( 20, 30 )
+      expect( new_reg.size ).to eq GosuEnhanced::Size.new( 40, 50 )
+
+      expect( reg.position ).to eq GosuEnhanced::Point.new( 10, 20 )
+      expect( reg.size ).to eq GosuEnhanced::Size.new( 30, 40 )      
+    end
+  end
+end

data/spec/size_spec.rb

@@ -7,6 +7,12 @@ describe GosuEnhanced::Size do
       expect( size.width ).to eq 10
       expect( size.height ).to eq 20
     end
+
+    it 'should reject negative values' do
+      expect { size = GosuEnhanced::Size.new( -10, 20 ) }.to raise_error  Exception
+      expect { size = GosuEnhanced::Size.new( 10, -20 ) }.to raise_error  Exception
+      expect { size = GosuEnhanced::Size.new( -10, -20 ) }.to raise_error Exception
+    end
   end
   
   describe '#inflate' do
@@ -24,7 +30,7 @@ describe GosuEnhanced::Size do
       expect( esize.height ).to eq 70
     end
     
-    it 'should work with two explicitly negative values' do
+    it 'should work with negative values' do
       size  = GosuEnhanced::Size.new( 40, 50 )
       esize = size.inflate( -30, -20 )
       expect( esize.width ).to eq 10
@@ -77,7 +83,7 @@ describe GosuEnhanced::Size do
       expect( size.height ).to eq 70
     end
     
-    it 'should work with two explicitly negative values' do
+    it 'should work with negative values' do
       size  = GosuEnhanced::Size.new( 40, 50 )
       size.inflate!( -30, -20 )
       expect( size.width ).to eq 10

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosu_enhanced
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Julian Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-12 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -94,10 +94,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
-description: "Point and Size classes to hold pixel addresses and \nrectangle sizes
-  respectively. Updated window class to draw rectangle in a single \ncolour more easily.
-  Updated font class to measure text and return co-ordinates \nto centre a piece of
-  text in a rectangle size."
+description: "Point, Size, and Region classes to hold pixel addresses and \nrectangle
+  sizes respectively. Updated window class to draw rectangle in a single \ncolour
+  more easily. Updated font class to measure text and return co-ordinates \nto centre
+  a piece of text in a rectangle size."
 email:
 - juliannicholls29@gmail.com
 executables: []
@@ -114,12 +114,15 @@ files:
 - lib/gosu_enhanced.rb
 - lib/gosu_enhanced/enhanced.rb
 - lib/gosu_enhanced/point.rb
+- lib/gosu_enhanced/region.rb
 - lib/gosu_enhanced/size.rb
 - lib/gosu_enhanced/version.rb
 - spec/point_spec.rb
+- spec/region_delegation_spec.rb
+- spec/region_spec.rb
 - spec/size_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/JulianNicholls/gosu_enhanced-gem
 licenses:
 - MIT
 metadata: {}
@@ -145,5 +148,7 @@ specification_version: 4
 summary: Enhanced versions of some Gosu classes.
 test_files:
 - spec/point_spec.rb
+- spec/region_delegation_spec.rb
+- spec/region_spec.rb
 - spec/size_spec.rb
 - spec/spec_helper.rb