gosu_wrapper 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 917ff2ab23c3b32591b9ca6e6cb81b60e88aaf13
-  data.tar.gz: 96a2c3dd86049eef3b8b00c2d620e9d435154d75
+  metadata.gz: 4714b462fb1c471cf994ff6dc847b3e7b1685b44
+  data.tar.gz: 06dbe58ba8eb7d0a895a05e2f33927f5fc37a6b1
 SHA512:
-  metadata.gz: 64d1346282045251db6f4de0300f6701087643d85e9a9bf875c415b77c77f34960b8b75f61c3cd8f4040bf08ce3054781b8d6ac38a1eced95657b4c3de26d835
-  data.tar.gz: d67cc8edbee1b432e7a61682f85dec118fc20193919a6f9cdf55cb9503ceb3b471f1fea5f6f9f1cad08d74bc4ba87beeb53caa97d48a9e094f7ff390dcd80c92
+  metadata.gz: ed5952d37fd52deff3aa3136469684b71b2737e61c1976a29d7105b6c79192ecc946fd93754dfa0ab16f1fb8b5fad43010a57e27f4289c225aec24ee8563c3f9
+  data.tar.gz: 8e1744ea198b03d390025a3970551903e5b80ddbcc15ebb1e42c040c55bb444b62551a7541d0da8503d14adea3b24d9ff53e875deff9c0cebe284bb49fc1a7d0

data/README.md

@@ -0,0 +1,182 @@
+### Installing
+
+_gosu and activesupport will be loaded as dependencies_
+
+`gem install gosu_wrapper` or in a gemfile: `gem 'gosu_wrapper'`
+
+### Usage
+
+One public class is exposed, `GosuWrapper`. It's essentially a wrapper over an
+anonymous `Gosu::Window` class that gets functionality added through metaprogramming.
+
+In lieue of a "getting started" snippet, I'm going to delegate that to the
+[gosu_wrapper_snake_example](http://github.com/maxpleaner/gosu_wrapper_snake_example)
+codebase and run through the API step-by-step here.
+
+---
+
+**`#initialize(width:, height:, attributes:)`**
+
+  - This defines `#window` which is an instance of `Gosu::Window`.
+
+  - width & height are num pixels (of the total window).
+
+  - attributes is an array of symbols.
+    - It must at least include `:window_height` and `:window_width`.  
+    - All of the keys in your app's state hash should be given here.  
+    - Each of them get attr_accessors defined on `#window` and shorthand accessors
+      using `method_missing` (see next section).
+
+---
+
+**There are four instance methods added using `method_missing`**
+
+  1. `#get_<attr>`  
+      delegates the getter to `window`
+
+  2. `#set_<attr>(val)`  
+      delegates the setter to `window`
+
+  3. `#change_<attr>(sym, arg)`  
+      a shorthand for some update operations on non-mutable objects. 
+      For example `change_score(:+, 1)` 
+
+  4. `#get_or_set_<attr>(&blk)`  
+      returns the val if it's truthy, and otherwise sets the val equal to the 
+      block result (returning it as well).
+
+---
+
+**`#define_method_on_window(name, &blk)`**
+
+  - this should be a private method, but is used by `#add_hook/#add_helper` so 
+    it's worth explaining.
+
+  - It defines the method named `name` on `window` with `blk` as its body.
+
+  - Arguments are determined by the given block
+
+  - The block is always invoked with the `GosuWrapper` instance as the value of `self`
+
+---
+
+**`#scope(*args, **keywords, &blk)`**
+
+  - another method that should be private; this is what handles calling a proc 
+    with the `GosuWrapper` instance as the value of `self`.
+
+---
+
+**`#config(&blk)`**
+
+  - mostly the same thing as `#scope` but is meant to be used publically.  
+
+  - the only functional difference is this always returns `self` 
+    (the `GosuWrapper` instance) whereas `#scope` returns the result of the 
+    block.
+
+  - Like `#scope`, this is a classic DSL-style method which exists for the 
+    sole purpose of saving keystrokes (using `instance_exec`)
+
+---
+
+**`#add_hook(name, &blk)`**
+
+  - a "hook" conceptually is a method internally defined by `Gosu::Window` 
+    that we're tapping into by overriding. Hooking into events `update`, 
+    `button_down`, and `draw` are how the app works fundamentally.
+
+  - the `button_down` proc is passed an `id` which can be checked against 
+    the values in `#buttons` to determine which key was pressed.
+
+  - `update` and `draw` are run every tick. Conceptually, `update` 
+    is used to change the state and `draw` to represent it.
+
+---
+
+**`#add_helper(name, &blk)`**
+
+  - functionally speaking this is the exact same thing as `add_hook` - 
+    it defines a method on `Gosu::Window`.
+
+  - It exists to distinguish between built-in hooks like `update` from 
+    custom methods. 
+
+  - These can be called with `#invoke` or its alias `#call_helper`.
+
+---
+
+**`#show`**
+
+  - Starts the game. Needs to be called only once.
+
+---
+
+**`#draw_rect(start_x:, start_y:, end_x:, end_y:, color)`**
+
+  - Should be called from `draw` only. Fills the rectangle with `color`
+  - Needs to run every `draw` tick.
+
+---
+
+**`#colors`**
+
+  - a hash of name => color object pairs
+  - e.g. `colors[:red]`
+  - it's also possible to make hexademical colors with Gosu
+
+---
+
+**`#buttons`**
+
+  - a hash of name => button id pairs
+  - e.g. `buttons[:right]` or `buttons[:escape]`
+  - not all the gosu buttons are mapped here but I'd welcome a PR to add more.
+
+---
+
+**`#invoke/#call_helper/#dispatch/#call_hook`**
+
+  - all aliases for the same simple thing: calling a function on 
+    `window` (the `Gosu::Window instance`).
+
+---
+
+**default helpers**
+
+There are a few predefined helpers.
+
+They can be called with `#call_helper(name_sym, *args, **keywords, &blk)`
+
+The required parameters differ between the helpers.
+
+1. `div_window_into(num_cols:, num_rows:, margin:)`  
+   - splits the window into a grid but doesn't draw it
+   - returns a matrix-like hash which can be passed to `draw_grid` 
+     as the `sections` argument
+   - uses `div_section_into` internally
+
+2. `div_setion_into(start_x: start_y:, end_x:, end_y:, num_cols:, num_rows:, margin:)`
+  - splits a rectangle into a grid but doesn't draw it
+  - returns a matrix-like hash which can be passed to `draw_grid`
+  - `margin` is an optional reduction of the size of each column. 
+    It's passed as `1` in `div_window_into` and the columns won't be 
+    distinguishable (there will be no visible border) unless this is positive.
+  - specifically, the return value looks like this:  
+
+          # many rows and columns can be stored in this structure
+          {
+            <row_idx> => {
+              start_x: <num>, start_y: <num>, end_x: <num>, end_y: <num>,
+              cols: {
+                <col_idx> => {
+                  start_x: <num>, start_y: <num>, end_x: <num>, end_y: <num>
+                }
+              }
+            }
+          }
+
+3. `draw_grid(sections:, row_color:, col_color:)`
+  - The result of `div_window_into` can be passed to this.
+  - Internally it uses `GridHelpers#draw_rect`
+

data/lib/gosu_wrapper/grid_helpers.rb

@@ -0,0 +1,63 @@
+class GosuWrapper
+  class GridHelpers
+
+    def self.div_windo_into
+      Proc.new do |num_cols:, num_rows:, margin:|
+        call_helper :div_section_into, {
+          start_x: 0,
+          start_y: 0,
+          end_x: get_window_width,
+          end_y: get_window_height,
+          margin: margin,
+          num_rows: num_rows,
+          num_cols: num_cols
+        }
+      end
+    end
+
+    def self.div_section_into
+      Proc.new do |
+        start_x:, start_y:, end_x:, end_y:, num_cols:, num_rows:, margin:
+      |
+        total_height = end_y - start_y
+        total_width = end_x - start_x
+        row_height = total_height / num_rows
+        col_width = total_width / num_cols
+        (num_rows).times.reduce({}) do |rows, row_idx|
+          row_start_y = (row_height * row_idx)
+          row_end_y = (row_start_y + row_height)
+          rows[row_idx] = {
+            start_y: row_start_y,
+            end_y: row_end_y,
+            start_x: start_x,
+            end_x: end_x,
+            cols: (num_cols).times.reduce({}) do |cols, col_idx|
+              col_start_x = col_width * col_idx
+              col_end_x = col_start_x + col_width
+              cols[col_idx] = {
+                start_x: col_start_x + margin,
+                end_x: col_end_x - margin,
+                start_y: row_start_y + margin,
+                end_y: row_end_y - margin,
+              } 
+              cols
+            end
+          }
+          rows
+        end
+      end
+    end
+
+    def self.draw_grid
+      Proc.new do |sections:, row_color:, col_color:|
+        sections.each do |row_num, row|
+          draw_rect row.merge(color: row_color)
+          row[:cols].each do |col_num, col|
+            draw_rect col.merge(color: col_color)
+          end
+        end
+      end
+    end
+    
+  end
+end

data/lib/gosu_wrapper/util.rb

@@ -1,32 +1,7 @@
 class GosuWrapper
   module Util
-
-  # ================================================
+    
     def method_missing_for(regex, type:, &definition_blk)
-    # Regex should include a match group
-    # type should be either :instance or :class
-    # Definition blk is run unless there's an existing method with the same name.
-    # if caller_blk is provided, it will be passed to definition_blk's invocation
-    #
-    # Example:
-    #
-    # class Animal
-    #   extend Util
-    #   attr_reader :noises
-    #   def initialize
-    #     @noises = { cat: "meow" }
-    #   end
-    #   method_missing_for /^(.+)_goes$/ do |match, arg|
-    #     puts @noises[match]
-    #   end
-    # end
-    # 
-    # Animal.new.cat_goes # => "meow"
-    #
-    # Through the use of an anonymous modules (adding method_missing to the
-    # inheritance chain vs overwriting it with define_method), this can be
-    # used multiple times.
-    #
       anon_module = Module.new do |mod|
         define_method(:method_missing) do |name, *args, **keywords, &caller_blk|
           match = name.to_s.scan(regex).flatten[0]
@@ -59,7 +34,6 @@ class GosuWrapper
       base.prepend anon_module
 
     end
-  # ================================================
 
   end
 end

data/lib/gosu_wrapper.rb

@@ -21,6 +21,13 @@ class GosuWrapper
     @window.window_width = width
     @hooks = []
     @helpers = []
+    add_default_helpers
+  end
+
+  def add_default_helpers
+    add_helper :div_window_into,  GridHelpers.div_window_into
+    add_helper :div_section_into, GridHelpers.div_section_into
+    add_helper :draw_grid,        GridHelpers.draw_grid
   end
 
   # Delegate "set_<attr>" setters to window

data/lib/version.rb

@@ -1,3 +1,3 @@
 module GosuWrapper
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gosu_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - maxpleaner
@@ -45,13 +45,14 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/gosu_wrapper
 - lib/gosu_wrapper.rb
 - lib/gosu_wrapper/buttons.rb
 - lib/gosu_wrapper/colors.rb
+- lib/gosu_wrapper/grid_helpers.rb
 - lib/gosu_wrapper/util.rb
 - lib/version.rb
-- readme.md
 homepage: http://github.com/maxpleaner/gosu_wrapper
 licenses:
 - MIT

data/readme.md

@@ -1,126 +0,0 @@
-### Installing
-
-_gosu and activesupport will be loaded as dependencies_
-
-`gem install gosu_wrapper`
-
-or in a gemfile: `gem 'gosu_wrapper'`
-
-### Usage
-
-One public class is exposed, `GosuWrapper`. It's essentially a wrapper
-over an anonymous `Gosu::Window` class that gets functionality added through
-metaprogramming.
-
-In lieue of a "getting started" snippet, I'm going to delegate that to the
-[gosu_wrapper_snake_example](http://github.com/maxpleaner/gosu_wrapper_snake_example)
- codebase and run through the API step-by-step here.
-
----
-
-**`#initialize(width:, height:, attributes:)`**
-
-  - This defines `#window` which is an instance of `Gosu::Window`.
-  - width & height are num pixels (of the total window).
-  - attributes is an array of symbols.  
-    It must at least include `:window_height` and `:window_width`.  
-    All of the keys in your app's state hash should be given here.  
-    Each of them get attr_accessors defined on `#window` and shorthand  
-    accessors using `method_missing` (see next section).
-
----
-
-**There are four instance methods added using `method_missing`**
-
-  1. `#get_<attr>`
-    - delegates the getter to `window`
-  2. `#set_<attr>(val)`
-    - delegates the setter to `window`
-  3. `#change_<attr>(sym, arg)`
-    - a shorthand for some update operations  
-     on non-mutable objects. For example `change_score(:+, 1)` 
-  4. `#get_or_set_<attr>(&blk)`
-    - returns the val if it's truthy, and otherwise sets the val equal  
-      to the block result (returning it as well).
-
----
-
-**`#define_method_on_window(name, &blk)`**
-
-  - this should be a private method, but is used by a number of others so  
-    it's worth explaing.  
-  - It defines the method named `name` on `window` with `blk` as its body.
-  - Arguments are determined by the block
-  - The block is always invoked with the `GosuWrapper` instance as  
-    the value of `self`
-
----
-
-**`#scope(*args, **keywords, &blk)`**
-
-  - another method that should be private; this is what handles  
-    calling a proc with the `GosuWrapper` instance as the value of `self`.
-
----
-
-**`#config(&blk)`**
-
-  - mostly the same thing as `#scope` but is meant to be used publically.  
-  - the only functional difference is this always returns `self`  
-    (the `GosuWrapper` instance) whereas `#scope` returns the result of the  
-    block.
-  - Like `#scope`, this is a classic DSL-style method which exists for the  
-    sole purpose of saving keystrokes (using `instance_exec`)
-
----
-
-**`#add_hook(name, &blk)`**
-
-  - a "hook" conceptually is a method internally defined by `Gosu::Window`  
-    that we're tapping into by overriding. Hooking into events `update`,  
-    `button_down`, and `draw` are how the app works at a basic level.
-  - the `button_down` proc is passed an `id` which can be checked against  
-    the values in `#buttons` to determine which key was pressed.
-  - `update` and `draw` are run every tick. Conceptually, `update`  
-    is used to change the state and `draw` to represent it.
-
----
-
-**`#add_helper(name, &blk)`**
-
-  - functionally speaking this is the exact same thing as `add_hook` -  
-    it defines a method on `Gosu::Window`.
-  - It exists to distinguish between built-in hooks like `update` from  
-    custom methods. 
-  - These can be called with `#invoke` or its alias `#call_helper`.
-
----
-
-**`#show`**
-
-  - Starts the game. Needs to be called only once.
-
----
-
-**`#draw_rect(start_x:, start_y:, end_x:, end_y:, color)`**
-
-  - Can be called from `draw` only. Fills the rectangle with `color`
-
----
-
-**`#colors`**
-
-  -  a hash of name => color object pairs
-
----
-
-**`#buttons`**
-
-  -  a hash of name => button id pairs
-
----
-
-**`#invoke/#call_helper/#dispatch/#call_hook`**
-
-  - all aliases for the same simple thing: calling a function on  
-    `window` (the `Gosu::Window instance`).