straightedge 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a4391ab9503098a88e8fcdc920ac529b241afe5
-  data.tar.gz: 5dcff1efdb2e6a442648b381aa124640c72de1f5
+  metadata.gz: f8b2f60d62255936247fe75932dc27426760a1e9
+  data.tar.gz: 05cc12291ebbf0518a608b1f1e0f3ef6f0ca376d
 SHA512:
-  metadata.gz: 9c5a50dc8f32b28f4a07659b29c4a73a6731230bedf5f99b38b93b4d98961ae2602b8d962d195b307ca4d50d35e770be94a58a19ff999fd0706fe53296235ae7
-  data.tar.gz: 33cceb0569dd5753bc4fd886839f180be98aac6ab87b281053b1626fe0dc0e1177c0f4a69d5a955643398894e7e09180d8990e297251dfa77aeef649b02d49c1
+  metadata.gz: 176f4ae297d81ab3c94e6daf7a0ea0aa3ad94cd12594ead81123822e0704ba6b7dd56f2026a1e9094e5840eb0320fc7c64c2e8b49787e1468f52e2e2c8e059aa
+  data.tar.gz: 8e600b22c8cf4463e7a55e5d1883da258e81ea4668e8e686f36af5dbbe0bc35e9e7b277c39a651f6431dbe3ce81703143d14167b630567ddc4b857a1998c9ab6

data/.gitignore

@@ -3,3 +3,4 @@ doc/
 pkg/
 vendor/cache/*.gem
 tags
+**/.*.swp

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.5

data/Gemfile

@@ -2,6 +2,13 @@ source :rubygems
 
 gemspec
 
+gem 'mini-config'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-its'
+end
+
 group :development do
   gem 'pry'
   gem 'kramdown'

data/README.md

@@ -1,28 +1,70 @@
 # straightedge
 
+[![Code Climate](https://codeclimate.com/github/jweissman/straightedge/badges/gpa.svg)](https://codeclimate.com/github/jweissman/straightedge)
+
 * [Homepage](https://rubygems.org/gems/straightedge)
 * [Documentation](http://rubydoc.info/gems/straightedge/frames)
 * [Email](mailto:jweissman1986 at gmail.com)
 
 ## Description
 
-One idea is for this to house the reusable geometry logic in Ruby
+  Give me a compass and straightedge and I will conquer the world
+
+  [![Compass and Straightedge XKCD](http://imgs.xkcd.com/comics/compass_and_straightedge.png)](http://xkcd.com/866/) 
+
+  Geometry primitives and graphical app (game) framework framework.
 
 ## Features
 
+    * Geometry toolkit 
+      - extensible Compass
+      - Ruler (for measuring distances)
+
+    * Figures composed of points called Marks
+      - Line
+      - Quadrilateral
+      - Hexagon
+
+    * Some fledgling support for grids
+
+    * Some reactor-pattern framework platform components
+      to help standardize interfaces (see straightedge-gosu
+      and straightedge-canvas for examples)
+
 ## Examples
 
     require 'straightedge'
 
+    # you need an adapter to actually render something
+    require 'straightedge-gosu'
+
+    class Example::GameController < Straightedge::Director
+      def current_scene
+        {
+	  [200,300] => Quadrilateral.new(dimensions: [200,100], color: :green),
+	  [200,305] => "rectangle",
+
+	  [400,300] => Hexagon.new(scale: 40.0, color: :blue),
+	  [400,305] => "hexagon"
+	}
+      end
+    end
+
 ## Requirements
 
+   Ruby 2.x should be enough
+
 ## Install
 
     $ gem install straightedge
 
 ## Synopsis
 
-    $ straightedge
+    Eventually it would be nice to support a CLI that wraps around tasks (note: not implemented yet)
+    
+    $ straightedge create [app] — builds an example app skeleton
+    $ straightedge serve — stands up a canvas webserver
+    $ straightedge play  — connects to local instance or plays through OpenGL adapter… etc
 
 ## Copyright
 

data/gemspec.yml

@@ -6,6 +6,9 @@ authors: Joseph Weissman
 email: jweissman1986@gmail.com
 homepage: https://rubygems.org/gems/straightedge
 
+dependencies:
+  mini-config: ~> 0.1.3
+
 development_dependencies:
   bundler: ~> 1.0
   rake: ~> 0.8

data/lib/straightedge.rb

@@ -1,17 +1,39 @@
-require 'straightedge/version'
-
-require 'straightedge/compass'
-require 'straightedge/rose'
-require 'straightedge/ruler'
-
-require 'straightedge/mark'
-require 'straightedge/line'
-require 'straightedge/figure'
+require 'mini/config'
 
-# really a grid should be a tiling figure...!
-require 'straightedge/grid'
+require 'straightedge/version'
+require 'straightedge/config'
+require 'straightedge/origin'
+require 'straightedge/aspects'
+require 'straightedge/tools'
+require 'straightedge/figures'
+require 'straightedge/colors'
+require 'straightedge/scene'
+require 'straightedge/presenter'
 
 require 'straightedge/extend/array'
 
+# for integration with viewing/gaming engines...
+# TODO try to downstream as much of this to supporting libs
+#      as possible
+require 'straightedge/motor/engine'
+require 'straightedge/motor/adapter'
+require 'straightedge/director'
+require 'straightedge/surface'
+
 module Straightedge
+  include Toolkit
+  include Figures
+  
+  # create constructors around out configured default components
+  class << self
+    %w[ engine agent surface adapter ].each do |elem|
+      define_method("new_#{elem}") do |*args| 
+	Straightedge.config.send("#{elem}_class").new(*args) 
+      end
+    end
+  end
+
+  def self.bootstrap
+    new_engine.boot
+  end
 end

data/lib/straightedge/aspects.rb

@@ -0,0 +1,3 @@
+require 'straightedge/aspects/positional'
+require 'straightedge/aspects/colorable'
+require 'straightedge/aspects/figural'

data/lib/straightedge/aspects/colorable.rb

@@ -0,0 +1,8 @@
+module Straightedge::Aspects
+  module Colorable
+    attr_reader :color
+    def paint(c=Straightedge::Colors.pick)
+      @color = c
+    end
+  end
+end

data/lib/straightedge/aspects/figural.rb

@@ -0,0 +1,12 @@
+module Straightedge::Aspects
+  module Figural
+    extend Forwardable
+
+    # consider entity as a figure (collection of points)
+    def to_points
+      Straightedge::Figure.new(self)
+    end
+    def_delegators :to_points, :adjacent, :center
+
+  end
+end

data/lib/straightedge/aspects/positional.rb

@@ -0,0 +1,10 @@
+module Straightedge::Aspects
+  module Positional
+    extend Forwardable
+    # consider the entity as a vector in 2-space
+    def to_point
+      Straightedge::Mark.new(*self)
+    end
+    def_delegators :to_point, :x, :y
+  end
+end

data/lib/straightedge/colors.rb

@@ -0,0 +1,72 @@
+module Straightedge
+  module Colors
+    class Palette
+      extend Forwardable
+
+      attr_reader :names_and_values
+      def initialize(names_and_hex_values={}) 
+	@names_and_values = names_and_hex_values 
+      end
+
+
+      def list; @names_and_values.keys end
+      def_delegator :list, :sample
+      
+      def hex_value_for(name)
+	raise "no such color: #{name}" unless list.include?(name)
+	@names_and_values[name] 
+      end
+
+      def self.base
+	@core ||= new({
+	  white: 0xFFFFFFFF,
+	  black: 0xFF000000,
+	  none:  0x00000000,
+	})
+      end
+
+# http://paletton.com/#uid=b5C4c2O0kfUu76fODb3COkppkonk+
+      def self.clean_rgb
+	@smooth_rgb ||= new(base.names_and_values.merge({
+          red:   0xFFEE787B, red1: 0xFFFECDCE,   red2: 0xFFFDA6A8,   red3: 0xFFC8494C,   red4: 0xFFA6282B,
+          blue:  0xFF6C5DA5, blue1: 0xFFC2BAE0,  blue2: 0xFF9488C3,  blue3: 0xFF4D3D8B,  blue4: 0xFF362673, 
+          green: 0xFF67C262, green1: 0xFFC0ECBE, green2: 0xFF93DA8F, green3: 0xFF40A33B, green4: 0xFF258720
+	}))
+      end
+
+      # Palette URL: http://paletton.com/#uid=72s0u0k8kpR26GB4Wuzc2lNfjho
+      #
+      # the '4' is closer to the base color, we may want to rethink the naming strategy
+      # also -- we need a color concept and to generate these but that's another day!
+      def self.pleasant_pastels
+	@pastels ||= new(base.names_and_values.merge({
+	  tan: 0xFFA9BD8C,    tan1: 0xFFEBF2E2,    tan2: 0xFFD2E0BD,    tan3: 0xFF87A063,    tan4: 0xFF667F42, 
+	  green: 0xFF71987D,  green1: 0xFFC7D5CB,  green2: 0xFF98B4A1,  green3: 0xFF50805F,  green4: 0xFF356644,
+	  pink: 0xFFCEA098,   pink1: 0xFFFFF1EE,   pink2: 0xFFF4D3CE,   pink3: 0xFFAE756C,   pink4: 0xFF8B5148,
+	  purple: 0xFFAD8095, purple1: 0xFFE5D6DD, purple2: 0xFFCDADBC, purple3: 0xFF925B74, purple4: 0xFF743D56,
+	}))
+      end
+    end
+
+    # expose module-level wrappers around the currently-configured palette
+    #
+    def self.palette
+      @current_palette ||= Straightedge.config.palette
+    end
+
+    def self.all
+      palette.list
+    end
+
+    def self.pick
+      palette.sample
+    end
+
+    def self.hex_value(color)
+      palette.hex_value_for color
+    end
+  end
+
+  # assign a basic rgb default color palette
+  config.palette = Colors::Palette.clean_rgb
+end

data/lib/straightedge/config.rb

@@ -0,0 +1,6 @@
+module Straightedge
+  include Mini::Config
+  configure do |straightedge|
+    straightedge.geometry = [ 1600, 1200 ]
+  end
+end

data/lib/straightedge/director.rb

@@ -0,0 +1,39 @@
+module Straightedge
+  class Director
+    extend Forwardable
+    include Straightedge::Figures
+
+    def prepare_stage(geometry)
+      @width, @height = *geometry
+      @space = Grid.new([30,30], scale: 20.0)
+      @space.paint!
+    end
+
+    def orchestrate
+      @space.paint!
+    end
+
+    def current_scene
+      Scene.new({
+	ORIGIN    => @space,
+	[10,10]   => "grid",
+
+	[200,300] => Quadrilateral.new(dimensions: [200,100], color: :green),
+	[200,305] => "rectangle",
+
+	[400,300] => Hexagon.new(scale: 40.0, color: :blue),
+	[400,305] => "hexagon"
+      })
+    end
+
+    ## handle custom events from the surface (clicks)...
+    #  how should we handle socket/player connects?
+    #
+    def handle(evt_name, *args)
+      #puts "--- got event #{evt_name} with args #{args}"
+      send(evt_name.to_sym, *args)
+    end
+  end
+
+  config.agent_class = Director
+end

data/lib/straightedge/extend/array.rb

@@ -1,5 +1,6 @@
 class Array
-  extend Forwardable
+  include Straightedge::Aspects::Positional
+  include Straightedge::Aspects::Figural
 
   def sum
     inject(&:+)
@@ -8,16 +9,4 @@ class Array
   def mean 
     sum / size
   end  
-
-  # consider the array as a vector in n-space (where n is the self.length)
-  def to_point
-    Straightedge::Mark.new(*self)
-  end
-  def_delegators :to_point, :x, :y
-
-  # consider the array as an array of points
-  def to_points
-    Straightedge::Figure.new(self)
-  end
-  def_delegators :to_points, :adjacent, :center
 end

data/lib/straightedge/figures.rb

@@ -0,0 +1,8 @@
+require 'straightedge/figures/figure'
+require 'straightedge/figures/mark'
+require 'straightedge/figures/label'
+require 'straightedge/figures/line'
+require 'straightedge/figures/quadrilateral'
+require 'straightedge/figures/hexagon'
+require 'straightedge/figures/grid'
+

data/lib/straightedge/figures/figure.rb

@@ -0,0 +1,44 @@
+module Straightedge
+  module Figures
+    # TODO the idea is that a figure is a collection of marks (and possibly other figures...?)
+    #       marks should be represented relative to the *figural* origin
+    class Figure
+      include Straightedge::Aspects::Colorable
+
+      extend Forwardable
+      include Enumerable
+
+      def_delegators :marks, :each
+      def_delegators :compass, :project
+      def_delegators :location, :x, :y
+
+      attr_accessor :marks, :color, :location
+
+      def initialize(marks=[], location: nil, color: :none)
+	@marks    = marks
+	@color    = color
+	@location = location
+      end
+
+      def compass; @compass ||= Straightedge::Toolkit::Compass.default end
+
+      def adjacent
+	approximate_adjacent = map(&method(:project)).flatten(1).uniq
+	actual_adjacent = approximate_adjacent.reject(&method(:include?))
+	actual_adjacent.sort_by(&method(:distance_from_center))
+      end
+
+
+      # note this is center of the collection of raw marks
+      #      in terms of their own space; not displaced by location
+      #      or scaled by dimensions
+      def center
+	[map(&:x).mean, map(&:y).mean]
+      end
+
+      def distance_from_center(xy)
+	Straightedge::Toolkit::Ruler.distance(xy,center)
+      end
+    end
+  end
+end

data/lib/straightedge/figures/grid.rb

@@ -0,0 +1,65 @@
+module Straightedge
+  module Figures
+    class Grid < Figure
+      include Enumerable
+      def_delegators :to_a, :sample, :map!
+      def_delegator :dimensions, :x, :width
+      def_delegator :dimensions, :y, :height
+
+      attr_reader :dimensions, :scale, :figure
+
+      def initialize(dimensions=[1,1], opts={})
+	@dimensions = dimensions
+	@scale      = opts.delete(:scale)  { 1.0 }
+	super(to_a, opts)
+      end
+
+      def at(xy)
+	[xy.x, xy.y]
+      end
+
+      def each
+	Grid.each_coordinate([width, height]) do |x, y|
+	  yield(at([x,y]))
+	end
+      end
+
+      def cell_at(xy)
+	@cells     ||= {}
+	@cells[xy] ||= Figures::Quadrilateral.new(dimensions: [@scale, @scale], location: to_pixels(xy)) #[xy.x+1,xy.y+1])) #to_pixels(xy))
+      end
+
+      def each_cell
+	each { |xy| yield cell_at(xy) }
+      end
+
+      def paint!
+        #each(&:to_point)
+	each_cell(&:paint)
+      end
+
+      def clip(xys=[])
+	xys.reject do |xy|
+	  _x,_y = *xy
+	  _x < 0 || _y < 0 || x >= _x || y >= _y
+	end 
+      end
+
+      def self.each_coordinate(dimensions)
+	dimensions.x.times do |x|
+	  dimensions.y.times do |y|
+	    yield [x,y]
+	  end
+	end
+      end
+
+      def to_pixels(xy)
+	[xy.x * (@scale/2), xy.y * (@scale/2)]
+      end
+
+      #def to_coords(xy)
+      #  [xy.x / (@scale/2), xy.y / (@scale/2) ]
+      #end
+    end
+  end
+end