gosu_enhanced 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fdfb20c8fb5079f40adf28f07762babe6a844f1c
-  data.tar.gz: 6dd6cfd4a944a7e1888c423d878c7fd4835c67e6
+  metadata.gz: 3a951985d3479c4c6c784582a6c62d89033d20a0
+  data.tar.gz: 6abef53400b8d8994e1e43ff69af8e1ceaf0fb6c
 SHA512:
-  metadata.gz: e27f8d50b970ee5a7b9b41b6ecb76fa1da3597cbcfb10df3af0d44c8b9a7fcb4840061b828a92fefc5a26291132680fc2ddb71e03a6e5da6a2c0798e54d6333f
-  data.tar.gz: 35804c2dac06b6b21ebd527c1617c16e626003c9b622063f46a7dca4eb9de003010c2aaaecb064d649618f8def62ad4c4f72156999c4bdf140b5c39d30536a0d
+  metadata.gz: ef111cb6f34b22de480995f567721e1ca7468d7daab013947376f6aff09e6722c3e4c4ae250e601991751a9fef17474151d06897e2621653539e94a6e5722891
+  data.tar.gz: 30aeb5557b13a7321fcd87f39b7ab06555103fe372f8cd5b9415a233ff676070f76758d6c3dfaeb92ae47ad0130a3a38e6641a173a2a1167bd14eef077129ff2

data/Gemfile.lock

@@ -1,15 +1,15 @@
 PATH
   remote: .
   specs:
-    gosu_enhanced (0.3.3)
-      gosu (~> 0.7)
+    gosu_enhanced (0.3.4)
+      gosu (~> 0.10)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.0)
     diff-lcs (1.2.5)
-    gosu (0.7.50)
+    gosu (0.10.0)
     method_source (0.8.2)
     pry (0.10.0)
       coderay (~> 1.1.0)
@@ -38,9 +38,12 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.6)
+  bundler
   gosu_enhanced!
-  pry (~> 0.10)
-  rake (~> 0.9)
-  rspec (~> 3.0)
-  rspec-nc (~> 0.0)
+  pry
+  rake
+  rspec
+  rspec-nc
+
+BUNDLED WITH
+   1.10.6

data/README.md

@@ -1,6 +1,6 @@
-# gosu_enhanced V0.3.2
+# gosu_enhanced V0.3.4
 
-Some added classes for using Gosu.
+Some added classes for using Gosu. Updated to use Gosu 0.9.x.
 
 ## Point
 
@@ -35,7 +35,7 @@ Add this line to your application's Gemfile:
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -58,5 +58,5 @@ Or install it yourself as:
 I am not affiliated in any way to the authors of the Gosu Gem or
 [libgosu](libgosu.org).
 
-Gosu and all documentation © 2001-2014 Julian Raschke, Jan Lücker, and
+Gosu and all documentation © 2001-2015 Julian Raschke, Jan Lücker, and
 other contributors. Gosu is released under the MIT license.

data/Rakefile

@@ -1,10 +1,10 @@
 require 'rspec/core/rake_task'
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 # Default directory for tests is ./spec
 # Run with rake spec
-RSpec::Core::RakeTask.new( :spec ) do |task|
+RSpec::Core::RakeTask.new(:spec) do |task|
   task.rspec_opts = ['--color']
 end
 
-task :default => :spec
+task default: :spec

data/gosu_enhanced.gemspec

@@ -4,29 +4,29 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gosu_enhanced/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gosu_enhanced"
+  spec.name          = 'gosu_enhanced'
   spec.version       = GosuEnhanced::VERSION
-  spec.authors       = ["Julian Nicholls"]
-  spec.email         = ["juliannicholls29@gmail.com"]
-  spec.summary       = %q{Enhanced versions of some Gosu classes.}
-  spec.description   = %{Point, Size, and Region classes to hold pixel addresses
+  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 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      = "https://github.com/JulianNicholls/gosu_enhanced-gem"
-  spec.license       = "MIT"
+of text in a rectangle size.)
+  spec.homepage      = 'https://github.com/JulianNicholls/gosu_enhanced-gem'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency "gosu", "~> 0.9"
+  spec.add_runtime_dependency 'gosu', '~> 0.10'
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 0.9"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rspec-nc", "~> 0.0"
-  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-nc', '~> 0.2'
+  spec.add_development_dependency 'pry', '~> 0.10'
 end

data/lib/gosu_enhanced/enhanced.rb

@@ -6,22 +6,23 @@ module Gosu
   class Window
     # Simplify drawing a rectangle in a single colour.
     #
-    # @param point [Point] Top left corner
-    # @param size [Size] Width and Height
-    # @param z_index [Fixnum] Z-order
-    # @param colour [Gosu::Color] Colour of rectangle
+    # +point+     [Point] Top left corner
+    # +size+      [Size] Width and Height
+    # +z_index+   [Fixnum] Z-order
+    # +colour+    [Gosu::Color] Colour of rectangle
 
-    def draw_rectangle( point, size, z_index, colour )
-      left, top     = point.x, point.y
-      width, height = size.width, size.height
+    def draw_rectangle(point, size, z_index, colour)
+      left    = point.x
+      top     = point.y
+      width   = size.width
+      height  = size.height
 
       draw_quad(
         left, top, colour,
         left + width, top, colour,
         left + width, top + height, colour,
         left, top + height, colour,
-        z_index
-      )
+        z_index)
     end
   end
 
@@ -32,24 +33,25 @@ module Gosu
 
     # Return the width and height of a given string
     #
-    # @param text [String] String to measure
+    # +text+    String to measure
     #
-    # @return [Size] The height and width of the string.
+    # return    [Size] The height and width of the string.
 
-    def measure( text )
-      Size.new( text_width( text, 1 ), height )
+    def measure(text)
+      Size.new(text_width(text, 1), height)
     end
 
     # Return the co-ordnates needed to place a given string in the centre of an
-    # area, both vertically and horizontally
+    # area, both vertically and horizontally.
     #
-    # @param text [String] String to centre
-    # @param 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.
     #
-    # @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
 
-    def centred_in( text, rect )
-      size = measure( text )
+    def centred_in(text, rect)
+      size = measure(text)
 
       Point.new(
         (rect.width - size.width) / 2,

data/lib/gosu_enhanced/point.rb

@@ -1,33 +1,51 @@
+# Module for gosu_enhanced gem.
 module GosuEnhanced
   # Hold a (x, y) pixel position, and allow for offsetting and movement
-  Point = Struct.new( :x, :y ) do
-    def offset( by_x, by_y = nil )
-      self.dup.move_by!( by_x, by_y )
+  Point = Struct.new(:x, :y) do
+    def offset(by_x, by_y = nil)
+      dup.move_by!(by_x, by_y)
     end
 
     # Negative co-ordinates are allowed.
 
-    def move_by!( by_x, by_y = nil )
-      if by_x.respond_to? :x
-        self.x += by_x.x
-        self.y += by_x.y
-      elsif by_x.respond_to? :width
-        self.x += by_x.width
-        self.y += by_x.height
-      else
-        self.x += by_x
-        self.y += by_y
-      end
+    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
+
+      self.x += by_x
+      self.y += by_y
+
+      self
+    end
+
+    def move_to!(new_x, new_y = nil)
+      return move_to_point(new_x) if new_x.respond_to? :x
+
+      self.x = new_x
+      self.y = new_y
+
+      self
+    end
+
+    private
+
+    def move_by_point(pt)
+      self.x += pt.x
+      self.y += pt.y
+
+      self
+    end
+
+    def move_by_size(sz)
+      self.x += sz.width
+      self.y += sz.height
 
       self
     end
 
-    def move_to!( new_x, new_y = nil )
-      if new_x.respond_to? :x
-        self.x, self.y = new_x.x, new_x.y
-      else
-        self.x, self.y = new_x, new_y
-      end
+    def move_to_point(pt)
+      self.x = pt.x
+      self.y = pt.y
 
       self
     end

data/lib/gosu_enhanced/region.rb

@@ -9,41 +9,58 @@ module GosuEnhanced
     def_delegators :@position, :move_by!, :move_to!, :x, :y
     def_delegators :@size, :inflate!, :deflate!, :width, :height
 
-    attr_reader :position, :size
+    # Top left corner
+    attr_reader :position
+    # Overall Width and Height
+    attr_reader :size
 
-    def initialize( pos, size )
-      @position, @size = pos.dup, size.dup
+    # Create a new region with specified +pos+ as top left corner and +size+
+    # as width and height
+    def initialize(pos, size)
+      @position = pos.dup
+      @size = 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
+    # Return whether the region contains the specified +row+ and +col+
+    def contains?(col, row = nil)
+      return contains_point?(col) if col.respond_to? :x
+
+      col.between?(left, left + width - 1) &&
+        row.between?(top, top + height - 1)
     end
 
+    # Return the topmost co-ordinate
     def top
       position.y
     end
 
+    # Return the leftmost co-oridinate
     def left
       position.x
     end
 
     # It is necessary to override dup to produce an actual duplicate.
     def dup
-      Region.new( position, size )
+      Region.new(position, size)
     end
 
-    def draw( surface, z_order, colour )
-      surface.draw_rectangle( position, size, z_order, colour )
+    # Draw a rectangle on the specified +surface+ at the specified +z_order+
+    # and with the specified +colour+
+    def draw(surface, z_order, colour)
+      surface.draw_rectangle(position, size, z_order, colour)
     end
 
+    # Return a string representation of the region's position and size
     def to_s
       "<GosuEnhanced::Region: #{position}, #{size}>"
     end
+
+    private
+
+    # NODOC
+    def contains_point?(pt)
+      pt.x.between?(left, left + width - 1) &&
+        pt.y.between?(top, top + height - 1)
+    end
   end
 end

data/lib/gosu_enhanced/size.rb

@@ -1,60 +1,103 @@
 module GosuEnhanced
   # Hold a 2-dimensional size and allow for inflation / deflation
   class Size
-    attr_reader :width, :height
+    # Width in pixels
+    attr_reader :width
+    # Height in pixels
+    attr_reader :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 )
+    # Initialise a size
+    # +wid+   Width
+    # +ht+    Height
+
+    def initialize(wid, ht)
+      @width = wid
+      @height = ht
+      validate(0, 0)
     end
 
-    def inflate( by_w, by_h = nil )
-      self.dup.inflate!( by_w, by_h )
+    # Create a new size with the dimensions INcreased in the width direction
+    # by +by_w+ and in the height direction by +by_h+.
+    #
+    # by_w and by_h can be a Fixnum, or another Size.
+
+    def inflate(by_w, by_h = nil)
+      dup.inflate!(by_w, by_h)
     end
 
-    def deflate( by_w, by_h = nil )
-      self.dup.deflate!( by_w, by_h )
+    # Create a new size with the dimensions DEcreased in the width direction
+    # by +by_w+ and in the height direction by +by_h+.
+    #
+    # by_w and by_h can be a Fixnum, or another Size.
+
+    def deflate(by_w, by_h = nil)
+      dup.deflate!(by_w, by_h)
     end
 
-    def inflate!( by_w, by_h = nil )
-      if by_w.respond_to? :width
-        validate( by_w.width, by_w.height )
+    # INcrease the dimensions of the current Size in the width direction
+    # by +by_w+ and in the height direction by +by_h+.
+    #
+    # by_w and by_h can be a Fixnum, or another Size.
 
-        @width  += by_w.width
-        @height += by_w.height
-      else
-        validate( by_w, by_h )
+    def inflate!(by_w, by_h = nil)
+      return inflate_by_size(by_w) if by_w.respond_to? :width
 
-        @width  += by_w
-        @height += by_h
-      end
+      validate(by_w, by_h)
+
+      @width += by_w
+      @height += by_h
 
       self
     end
 
-    def deflate!( by_w, by_h = nil )
+    # DEcrease the dimensions of the current Size in the width direction
+    # by +by_w+ and in the height direction by +by_h+.
+    #
+    # by_w and by_h can be a Fixnum, or another Size.
+
+    def deflate!(by_w, by_h = nil)
       if by_w.respond_to? :width
-        inflate!( -by_w.width, -by_w.height )
+        inflate!(-by_w.width, -by_w.height)
       else
-        inflate!( -by_w, -by_h )
+        inflate!(-by_w, -by_h)
       end
     end
 
-    def ==( other )
+    # Return whether the +other+ size is identical in both dimensions
+
+    def ==(other)
       width == other.width && height == other.height
     end
 
+    # Return a string representation of the width and height of the current
+    # Size
+
     def to_s
       "<GosuEnhanced::Size #{width}x#{height}>"
     end
 
     private
 
-    def validate( by_w, by_h )
+    # Check that the passed dimension deltas do not make either dimension of
+    # Size negative.
+
+    def validate(by_w, by_h)
       fail 'Cannot make size negative' if width + by_w < 0 || height + by_h < 0
     end
+
+    # Change the dimensions using the dimensions of another Size.
+    def inflate_by_size(sz)
+      width  = sz.width
+      height = sz.height
+      validate(width, height)
+
+      @width  += width
+      @height += height
+
+      self
+    end
   end
 end

data/lib/gosu_enhanced/version.rb

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