gosu_enhanced 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ef82237800c5e7fd75f41a937f99d7b808404ab
-  data.tar.gz: b98df43837d6c32aea1ac89ed56535312aba3122
+  metadata.gz: e2699bea318f54f161b957521611d3d040b35ff3
+  data.tar.gz: c813f99173dde10a796a5c6b43e8c0ce7264203b
 SHA512:
-  metadata.gz: a72b1e8286b8db6942610d7a3c5ecae0ea1f0406266141867e242d38359cf9b9bde2b0d89b5ff267f1142d725f6d43e854e76e724f29faa9daef78e84118bce0
-  data.tar.gz: ffb4c4a46f40322495bed1705429e7e36d13a439aa8c7dcfb2a0502d9c25c17c9bd215c2da938a98a58645cdf31586b9534addd1cf0a9673180f6ea6b5c2be3d
+  metadata.gz: 715bfe01bfdbd958bff4cd54b439d131ce28c0d3de3cac6981581f8dade51f426483ad97f2a0b06fe6debbc2f678019380ada333331c35e6c73c4e61240b650a
+  data.tar.gz: e4f0de31b1089d43bc69d9518dd8f1fee678bb82fef2c360db9473e60f0ea962be73c535c08209fd968a5ea73172f8797f2429fc9de2411c059fad56ab9bd2ca

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    gosu_enhanced (0.4.1)
-      gosu (~> 0.10)
+    gosu_enhanced (0.4.2)
+      gosu (~> 0.10.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    gosu (0.10.1.2)
-    minitest (5.8.0)
+    gosu (0.10.4)
+    minitest (5.8.3)
     rake (10.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.10)
+  bundler (~> 1.11)
   gosu_enhanced!
   minitest (~> 5.8)
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/gosu_enhanced.gemspec

@@ -8,12 +8,12 @@ Gem::Specification.new do |spec|
   spec.version       = GosuEnhanced::VERSION
   spec.authors       = ['Julian Nicholls']
   spec.email         = ['juliannicholls29@gmail.com']
-  spec.summary       = 'Enhanced versions of some Gosu classes.'
-  spec.description   = %(Point, Size, and Region classes to hold pixel co-ordinatess
-and rectangle sizes respectively.
-Updated window class to draw rectangles and lines 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.summary       = 'Extra and enhanced versions of some Gosu classes.'
+  spec.description   = %(Point, Size, and Region classes to hold pixel
+co-ordinates and rectangle sizes respectively. An updated window class to draw
+rectangles and lines 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      = 'https://github.com/JulianNicholls/gosu_enhanced-gem'
   spec.license       = 'MIT'
 
@@ -22,9 +22,9 @@ of text in a rectangle size.)
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'gosu', '~> 0.10'
+  spec.add_runtime_dependency 'gosu', '~> 0.10.4'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.8'
 end

data/lib/gosu_enhanced/enhanced.rb

@@ -1,8 +1,8 @@
 # Gosu is the module that the Gosu library uses. It is re-opened here to allow
 # access to the Window and Font classes.
 module Gosu
-  # Add a draw_rectangle() to Window which simplifies drawing a simple rectangle
-  # in one colour
+  # Add draw_rectangle() and draw_simple_line() to Window which simplifies
+  # drawing simple rectangles and lines in one colour
   class Window
     # Simplify drawing a rectangle in a single colour.
     #
@@ -40,8 +40,8 @@ module Gosu
     end
   end
 
-  # Add a measure to return both width and height for a text and a way
-  # to centre a text in a rectangle.
+  # Add a measure to return both width and height for a text and a way to
+  # centre a piece of text in a rectangle.
   class Font
     include GosuEnhanced
 
@@ -58,19 +58,16 @@ module Gosu
     # Return the co-ordnates needed to place a given string in the centre of an
     # area, both vertically and horizontally.
     #
-    # return::  [Point] The point to write the string, expressed as an offset
-    #           from the top-left corner of the rectangle.
-    #
     # * +text+    [String] String to centre
     # * +rect+    [Size] Rectangular area size
+    #
+    # return::  [Point] The point to write the string, expressed as an offset
+    #           from the top-left corner of the rectangle.
 
     def centred_in(text, rect)
       size = measure(text)
 
-      Point.new(
-        (rect.width - size.width) / 2,
-        (rect.height - size.height) / 2
-      )
+      Point((rect.width - size.width) / 2, (rect.height - size.height) / 2)
     end
 
     # Synonym for centred_in, allowing for centre to be spelled center.

data/lib/gosu_enhanced/point.rb

@@ -2,12 +2,16 @@
 module GosuEnhanced
   # Hold a (x, y) pixel position, and allow for offsetting and movement
   Point = Struct.new(:x, :y) do
+    # Negative co-ordinates are allowed.
+
+    # Return a new point offset by +by_x+ and +by_y+
+    # by_x and by_y can be Fixnum, or another Point, or a Size
     def offset(by_x, by_y = nil)
       dup.move_by!(by_x, by_y)
     end
 
-    # Negative co-ordinates are allowed.
-
+    # Move the current point offset by +by_x+ and +by_y+
+    # by_x and by_y can be Fixnum, or another Point, or a Size
     def move_by!(by_x, by_y = nil)
       return move_by_point(by_x) if by_x.respond_to? :x
       return move_by_size(by_x)  if by_x.respond_to? :width
@@ -18,6 +22,8 @@ module GosuEnhanced
       self
     end
 
+    # Move the current point to the point +new_x+ and +new_y+
+    # by_x and by_y can be Fixnum or another Point
     def move_to!(new_x, new_y = nil)
       return move_to_point(new_x) if new_x.respond_to? :x
 
@@ -29,6 +35,7 @@ module GosuEnhanced
 
     private
 
+    # Move the current point by the x and y co-ordinates in the Point +pt+
     def move_by_point(pt)
       self.x += pt.x
       self.y += pt.y
@@ -36,6 +43,7 @@ module GosuEnhanced
       self
     end
 
+    # Move the current point by the width and height in the Size +sz+
     def move_by_size(sz)
       self.x += sz.width
       self.y += sz.height
@@ -43,6 +51,7 @@ module GosuEnhanced
       self
     end
 
+    # Move the current point to the x and y co-ordinates in the point +pt+
     def move_to_point(pt)
       self.x = pt.x
       self.y = pt.y
@@ -62,4 +71,3 @@ module GosuEnhanced
 
   module_function :Point
 end
-

data/lib/gosu_enhanced/region.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 
+# Module for the Gosu Enhanced gem.
 module GosuEnhanced
   # Hold a rectangular region specified by a Point and a Size
   # Most functions are delegated to the constituent Point and Size
@@ -15,7 +16,8 @@ module GosuEnhanced
     attr_reader :size
 
     # Create a new region with specified +pos+ as top left corner and +size+
-    # as width and height.
+    # as width and height. The stored positions are copies of the passed
+    # position and size to avoid aliasing.
     #
     # Alternatively, can be initialized with 2 +Point+s.
 
@@ -23,7 +25,7 @@ module GosuEnhanced
       size = Size.new(size.x - pos.x, size.y - pos.y) if size.respond_to? :x
 
       @position = pos.dup
-      @size = size.dup
+      @size     = size.dup
     end
 
     # Return whether the region contains the specified +row+ and +col+
@@ -45,6 +47,7 @@ module GosuEnhanced
       position.x
     end
 
+    # Duplicate a Region, must be done explicitly to avoid aliasing.
     def dup
       Region.new(position, size)
     end
@@ -62,12 +65,15 @@ module GosuEnhanced
 
     private
 
+    # Return whether the passed Point +pt+ is contained within the current
+    # Region.
     def contains_point?(pt)
       pt.x.between?(left, left + width - 1) &&
         pt.y.between?(top, top + height - 1)
     end
   end
 
+  # Utility function to create a new Region
   def Region(pos, size)
     Region.new(pos, size)
   end

data/lib/gosu_enhanced/size.rb

@@ -1,3 +1,4 @@
+# Module for the Gosu Enhanced gem.
 module GosuEnhanced
   # Hold a 2-dimensional size and allow for inflation / deflation
   class Size
@@ -14,7 +15,7 @@ module GosuEnhanced
     # * +ht+    Height
 
     def initialize(wid, ht)
-      @width = wid
+      @width  = wid
       @height = ht
       validate(0, 0)
     end
@@ -47,7 +48,7 @@ module GosuEnhanced
 
       validate(by_w, by_h)
 
-      @width += by_w
+      @width  += by_w
       @height += by_h
 
       self

data/lib/gosu_enhanced/version.rb

@@ -1,5 +1,5 @@
 # Version of the gosu_enhanced gem.
 module GosuEnhanced
   # gosu_enhanced gem version
-  VERSION = '0.4.2'
+  VERSION = '0.4.3'
 end

data/test/point_test.rb

@@ -22,7 +22,7 @@ describe GosuEnhanced::Point do
       point.y.must_equal(-20)
     end
 
-    it "should work with the utility function" do
+    it 'should work with the utility function' do
       point = GosuEnhanced::Point(10, 20)
       point.x.must_equal 10
       point.y.must_equal 20
@@ -68,35 +68,35 @@ describe GosuEnhanced::Point do
 
   describe '#move_by!' do
     it 'should work with another Point' do
-      point  = GosuEnhanced::Point.new(10, 20)
+      point = GosuEnhanced::Point.new(10, 20)
       point.move_by!(GosuEnhanced::Point.new(30, 40))
       point.x.must_equal 40
       point.y.must_equal 60
     end
 
     it 'should work with a Size' do
-      point  = GosuEnhanced::Point.new(10, 20)
+      point = GosuEnhanced::Point.new(10, 20)
       point.move_by!(GosuEnhanced::Size.new(40, 50))
       point.x.must_equal 50
       point.y.must_equal 70
     end
 
     it 'should work with two positive values' do
-      point  = GosuEnhanced::Point.new(10, 20)
+      point = GosuEnhanced::Point.new(10, 20)
       point.move_by!(40, 50)
       point.x.must_equal 50
       point.y.must_equal 70
     end
 
     it 'should work with two negative values' do
-      point  = GosuEnhanced::Point.new(60, 80)
+      point = GosuEnhanced::Point.new(60, 80)
       point.move_by!(-40, -50)
       point.x.must_equal 20
       point.y.must_equal 30
     end
 
     it 'should work with values that result in negative co-ordinates' do
-      point  = GosuEnhanced::Point.new(60, 80)
+      point = GosuEnhanced::Point.new(60, 80)
       point.move_by!(-80, -150)
       point.x.must_equal(-20)
       point.y.must_equal(-70)
@@ -105,21 +105,21 @@ describe GosuEnhanced::Point do
 
   describe '#move_to!' do
     it 'should work with another Point' do
-      point  = GosuEnhanced::Point.new(10, 20)
+      point = GosuEnhanced::Point.new(10, 20)
       point.move_to!(GosuEnhanced::Point.new(30, 40))
       point.x.must_equal 30
       point.y.must_equal 40
     end
 
     it 'should work with two positive values' do
-      point  = GosuEnhanced::Point.new(10, 20)
+      point = GosuEnhanced::Point.new(10, 20)
       point.move_to!(40, 50)
       point.x.must_equal 40
       point.y.must_equal 50
     end
 
     it 'should work with two negative values' do
-      point  = GosuEnhanced::Point.new(60, 80)
+      point = GosuEnhanced::Point.new(60, 80)
       point.move_to!(-40, -50)
       point.x.must_equal(-40)
       point.y.must_equal(-50)
@@ -150,7 +150,7 @@ describe GosuEnhanced::Point do
 
   describe '#to_s' do
     it 'should render usefully.' do
-      point  = GosuEnhanced::Point.new(10, 20)
+      point = GosuEnhanced::Point.new(10, 20)
       point.to_s.must_equal '#<struct GosuEnhanced::Point x=10, y=20>'
     end
   end

data/test/size_test.rb

@@ -44,7 +44,7 @@ describe GosuEnhanced::Size do
     end
 
     it 'should raise an error with out-of-range values' do
-      size  = GosuEnhanced::Size.new(40, 50)
+      size = GosuEnhanced::Size.new(40, 50)
       expect { size.inflate(-50, -20) }.must_raise Exception
       expect { size.inflate(-30, -60) }.must_raise Exception
       expect { size.inflate(-50, -70) }.must_raise Exception
@@ -67,7 +67,7 @@ describe GosuEnhanced::Size do
     end
 
     it 'should raise an error for out-of-range values' do
-      size  = GosuEnhanced::Size.new(70, 60)
+      size = GosuEnhanced::Size.new(70, 60)
       expect { size.deflate(80, 50) }.must_raise Exception
       expect { size.deflate(60, 70) }.must_raise Exception
       expect { size.deflate(80, 70) }.must_raise Exception
@@ -76,28 +76,28 @@ describe GosuEnhanced::Size do
 
   describe '#inflate!' do
     it 'should work with another Size' do
-      size  = GosuEnhanced::Size.new(10, 20)
+      size = GosuEnhanced::Size.new(10, 20)
       size.inflate!(GosuEnhanced::Size.new(30, 40))
       size.width.must_equal 40
       size.height.must_equal 60
     end
 
     it 'should work with two values' do
-      size  = GosuEnhanced::Size.new(10, 20)
+      size = GosuEnhanced::Size.new(10, 20)
       size.inflate!(40, 50)
       size.width.must_equal 50
       size.height.must_equal 70
     end
 
     it 'should work with negative values' do
-      size  = GosuEnhanced::Size.new(40, 50)
+      size = GosuEnhanced::Size.new(40, 50)
       size.inflate!(-30, -20)
       size.width.must_equal 10
       size.height.must_equal 30
     end
 
     it 'should raise an error with out-of-range values' do
-      size  = GosuEnhanced::Size.new(40, 50)
+      size = GosuEnhanced::Size.new(40, 50)
       expect { size.inflate!(-50, -20) }.must_raise Exception
       expect { size.inflate!(-30, -60) }.must_raise Exception
       expect { size.inflate!(-50, -70) }.must_raise Exception
@@ -106,21 +106,21 @@ describe GosuEnhanced::Size do
 
   describe '#deflate!' do
     it 'should work with another Size' do
-      size  = GosuEnhanced::Size.new(60, 80)
+      size = GosuEnhanced::Size.new(60, 80)
       size.deflate!(GosuEnhanced::Size.new(30, 40))
       size.width.must_equal 30
       size.height.must_equal 40
     end
 
     it 'should work with two values' do
-      size  = GosuEnhanced::Size.new(70, 60)
+      size = GosuEnhanced::Size.new(70, 60)
       size.deflate!(40, 50)
       size.width.must_equal 30
       size.height.must_equal 10
     end
 
     it 'should raise an error for out-of-range values' do
-      size  = GosuEnhanced::Size.new(70, 60)
+      size = GosuEnhanced::Size.new(70, 60)
       expect { size.deflate!(80, 50) }.must_raise Exception
       expect { size.deflate!(60, 70) }.must_raise Exception
       expect { size.deflate!(80, 70) }.must_raise Exception
@@ -149,7 +149,7 @@ describe GosuEnhanced::Size do
 
   describe '#to_s' do
     it 'should render usefully' do
-      size  = GosuEnhanced::Size.new(10, 20)
+      size = GosuEnhanced::Size.new(10, 20)
       size.to_s.must_equal '<GosuEnhanced::Size 10x20>'
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosu_enhanced
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Julian Nicholls
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-11 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gosu
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.10.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,11 +67,11 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.8'
 description: |-
-  Point, Size, and Region classes to hold pixel co-ordinatess
-  and rectangle sizes respectively.
-  Updated window class to draw rectangles and lines 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.
+  Point, Size, and Region classes to hold pixel
+  co-ordinates and rectangle sizes respectively. An updated window class to draw
+  rectangles and lines 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.
 email:
 - juliannicholls29@gmail.com
 executables: []
@@ -116,10 +116,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Enhanced versions of some Gosu classes.
+summary: Extra and enhanced versions of some Gosu classes.
 test_files:
 - test/point_test.rb
 - test/region_delegation_test.rb