grid_generator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 354f6d7c26815275c2e0fe9362d949ba46fed6952c563c3fbaa2cd1706df0119
-  data.tar.gz: 0ba1e09b47296264b8d783179ce39cb719aaeb1463131bd4ae7c93f112dde70e
+  metadata.gz: c37d1d10aae708a8406359d0082de82ab9426d760bc34ddfd34f916e55b86776
+  data.tar.gz: 227df89f4324e8418afef7eb1705d3a19205095d3be359bf6ee9d7f7981a8f37
 SHA512:
-  metadata.gz: 6824d24e5a61e8b5b7ed125ecadfc9695cd27b0f60cfcad42b61cd4d364c270e16c346c24d320da6332d69ba8f2f58064633f0c33594992d4575603ba0b540a1
-  data.tar.gz: 977769a202c6d33ad3f8c89b0edaac847c2fb6f7cc80a9eac9f076836a2c614d29a9c1ad31ff21f1cb55049445238c988457ac39f1cd185dfb8a0b1ca5505f6c
+  metadata.gz: 1280447a17b87c59ec84b81105f20607167f535b0660c43b39ec2d7db719fc92a8027a2f52efd04e6d5afae1660f4755c6cc1e3cc7a5543ea5eb6a9700534cc7
+  data.tar.gz: efcfe14dcfce8a2ef7927a00f032a7c4bd64d631ec5981da629a344093282a2a2e8bec2aac402b298abdb94926142433c1846ff5b4eed66b2640f8133bc8e122

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    grid_generator (0.1.0)
+    grid_generator (0.1.1)
       matrix (~> 0.4.2)
 
 GEM

data/README.md

@@ -1,24 +1,34 @@
 # GridGenerator
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/grid_generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+Library for generating grids based on twisty puzzles. The output can be used in svg `polygon` and `line` elements.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add grid_generator 
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install grid_generator 
 
 ## Usage
 
-TODO: Write usage instructions here
+Generate an iso grid at co-ordinates 20, 20, with each unit being 20.
+
+Squares arguments are csv-like with commas separating elements and newlines separating rows.
+
+Each element can be a colour, represented by a letter, or blank, represented by a dash.
+
+```
+grid = GridGenerator.iso_view(x: 20, y: 20, units: 20, top_squares: "-,-,-\\n-,-,R\\n-,-,W", front_squares: "-,-,R\\n-,b,-\\n-,b,-", right_squares: "B,B,-\\n-,r,-\\n-,r,-")
+```
+
+Serialized the data for use in svg polygon and line elements: 
+
+```
+grid.as_json
+```
 
 ## Development
 
@@ -28,7 +38,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/grid_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/grid_generator/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/mrlhumphreys/grid_generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mrlhumphreys/grid_generator/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +46,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the GridGenerator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/grid_generator/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the GridGenerator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mrlhumphreys/grid_generator/blob/main/CODE_OF_CONDUCT.md).

data/lib/grid_generator/arrows/diagonal_down_arrow.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/arrows/arrow.rb'
+require_relative 'arrow'
 
 module GridGenerator
   module Arrows

data/lib/grid_generator/arrows/diagonal_up_arrow.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/arrows/arrow.rb'
+require_relative 'arrow'
 
 module GridGenerator
   module Arrows

data/lib/grid_generator/arrows/horizontal_arrow.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/arrows/arrow.rb'
+require_relative 'arrow'
 
 module GridGenerator
   module Arrows

data/lib/grid_generator/arrows/vertical_arrow.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/arrows/arrow.rb'
+require_relative 'arrow'
 
 module GridGenerator
   module Arrows

data/lib/grid_generator/cubic/bordered_grid.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/face_parser'
-require './lib/grid_generator/cubic/facing_square_factory'
+require_relative '../face_parser'
+require_relative 'facing_square_factory'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/facing_grid.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/face_parser'
-require './lib/grid_generator/cubic/facing_square_factory'
+require_relative '../face_parser'
+require_relative 'facing_square_factory'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/facing_square_factory.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/base_element'
+require_relative '../base_element'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/front_grid.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/cubic/grid'
+require_relative 'grid'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/grid.rb

@@ -1,5 +1,5 @@
 require 'matrix'
-require './lib/grid_generator/face_parser'
+require_relative '../face_parser'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/iso_view.rb

@@ -1,3 +1,7 @@
+require_relative 'top_grid'
+require_relative 'front_grid'
+require_relative 'right_grid'
+
 module GridGenerator
   module Cubic
     class IsoView

data/lib/grid_generator/cubic/right_grid.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/cubic/grid'
+require_relative 'grid'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/square_factory.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/base_element'
+require_relative '../base_element'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/cubic/top_grid.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/cubic/grid'
+require_relative 'grid'
 
 module GridGenerator
   module Cubic

data/lib/grid_generator/megaminx/common.rb

@@ -1,4 +1,5 @@
 require 'matrix'
+
 module GridGenerator
   module Megaminx
     module Common

data/lib/grid_generator/megaminx/element_factory.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/base_element'
-require './lib/grid_generator/megaminx/common'
+require_relative '../base_element'
+require_relative 'common'
 
 module GridGenerator
   module Megaminx

data/lib/grid_generator/megaminx/face.rb

@@ -1,6 +1,6 @@
-require './lib/grid_generator/face_parser'
-require './lib/grid_generator/megaminx/common'
-require './lib/grid_generator/megaminx/element_factory'
+require_relative '../face_parser'
+require_relative 'common'
+require_relative 'element_factory'
 
 module GridGenerator
   module Megaminx

data/lib/grid_generator/pyraminx/grid.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/pyraminx/triangle_factory'
+require_relative 'triangle_factory'
 
 module GridGenerator
   module Pyraminx

data/lib/grid_generator/pyraminx/triangle_factory.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/base_element'
+require_relative '../base_element'
 
 module GridGenerator
   module Pyraminx

data/lib/grid_generator/skewb/left_element_factory.rb

@@ -1,3 +1,5 @@
+require_relative '../base_element'
+
 module GridGenerator
   module Skewb
     class LeftElementFactory

data/lib/grid_generator/skewb/left_skewb_grid.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/skewb/skewb_grid.rb'
-require './lib/grid_generator/skewb/left_element_factory.rb'
+require_relative 'skewb_grid'
+require_relative 'left_element_factory'
 
 module GridGenerator
   module Skewb

data/lib/grid_generator/skewb/right_element_factory.rb

@@ -1,3 +1,5 @@
+require_relative '../base_element'
+
 module GridGenerator
   module Skewb
     class RightElementFactory

data/lib/grid_generator/skewb/right_skewb_grid.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/skewb/skewb_grid.rb'
-require './lib/grid_generator/skewb/right_element_factory.rb'
+require_relative 'skewb_grid.rb'
+require_relative 'right_element_factory.rb'
 
 module GridGenerator
   module Skewb

data/lib/grid_generator/skewb/skewb_grid.rb

@@ -1,4 +1,4 @@
-require './lib/grid_generator/face_parser'
+require_relative '../face_parser'
 
 module GridGenerator
   module Skewb

data/lib/grid_generator/skewb/top_element_factory.rb

@@ -1,3 +1,5 @@
+require_relative '../base_element'
+
 module GridGenerator
   module Skewb
     class TopElementFactory

data/lib/grid_generator/skewb/top_skewb_grid.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/skewb/skewb_grid.rb'
-require './lib/grid_generator/skewb/top_element_factory.rb'
+require_relative 'skewb_grid'
+require_relative 'top_element_factory'
 
 module GridGenerator
   module Skewb

data/lib/grid_generator/square_one/element_factory.rb

@@ -1,5 +1,5 @@
 require 'matrix'
-require './lib/grid_generator/base_element'
+require_relative '../base_element'
 
 module GridGenerator
   module SquareOne

data/lib/grid_generator/square_one/face.rb

@@ -1,5 +1,5 @@
-require './lib/grid_generator/square_one_face_parser'
-require './lib/grid_generator/square_one/element_factory'
+require_relative '../square_one_face_parser'
+require_relative 'element_factory'
 
 module GridGenerator
   module SquareOne

data/lib/grid_generator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GridGenerator
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/grid_generator.rb

@@ -2,23 +2,23 @@
 
 require_relative "grid_generator/version"
 
-require './lib/grid_generator/cubic/iso_view.rb'
-require './lib/grid_generator/cubic/top_grid'
-require './lib/grid_generator/cubic/front_grid'
-require './lib/grid_generator/cubic/right_grid'
-require './lib/grid_generator/cubic/facing_grid'
-require './lib/grid_generator/cubic/bordered_grid'
-require './lib/grid_generator/cubic/square_factory'
-require './lib/grid_generator/skewb/top_skewb_grid'
-require './lib/grid_generator/skewb/left_skewb_grid'
-require './lib/grid_generator/skewb/right_skewb_grid'
-require './lib/grid_generator/square_one/face'
-require './lib/grid_generator/arrows/vertical_arrow'
-require './lib/grid_generator/arrows/horizontal_arrow'
-require './lib/grid_generator/arrows/diagonal_down_arrow'
-require './lib/grid_generator/arrows/diagonal_up_arrow'
-require './lib/grid_generator/pyraminx/grid'
-require './lib/grid_generator/megaminx/face'
+require_relative 'grid_generator/cubic/iso_view'
+require_relative 'grid_generator/cubic/top_grid'
+require_relative 'grid_generator/cubic/front_grid'
+require_relative 'grid_generator/cubic/right_grid'
+require_relative 'grid_generator/cubic/facing_grid'
+require_relative 'grid_generator/cubic/bordered_grid'
+require_relative 'grid_generator/cubic/square_factory'
+require_relative 'grid_generator/skewb/top_skewb_grid'
+require_relative 'grid_generator/skewb/left_skewb_grid'
+require_relative 'grid_generator/skewb/right_skewb_grid'
+require_relative 'grid_generator/square_one/face'
+require_relative 'grid_generator/arrows/vertical_arrow'
+require_relative 'grid_generator/arrows/horizontal_arrow'
+require_relative 'grid_generator/arrows/diagonal_down_arrow'
+require_relative 'grid_generator/arrows/diagonal_up_arrow'
+require_relative 'grid_generator/pyraminx/grid'
+require_relative 'grid_generator/megaminx/face'
 
 module GridGenerator
   def self.iso_view(args)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grid_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Mark Humphreys
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-23 00:00:00.000000000 Z
+date: 2023-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: matrix
@@ -68,7 +68,6 @@ files:
 - lib/grid_generator/skewb/skewb_grid.rb
 - lib/grid_generator/skewb/top_element_factory.rb
 - lib/grid_generator/skewb/top_skewb_grid.rb
-- lib/grid_generator/square_one/element.rb
 - lib/grid_generator/square_one/element_factory.rb
 - lib/grid_generator/square_one/face.rb
 - lib/grid_generator/square_one_face_parser.rb

data/lib/grid_generator/square_one/element.rb

@@ -1,60 +0,0 @@
-require 'matrix'
-
-module GridGenerator
-  module SquareOne
-    class Element 
-      def initialize(x:, y:, units:, offset: , colour: , opacity: )
-        @x, @y = x, y
-        @units = units
-        @offset = offset
-        @colour = colour
-        @opacity = opacity
-      end
-  
-      attr_reader :x, :y, :units, :offset, :colour, :opacity
-      
-      def ==(other)
-        self.x == other.x &&
-          self.y == other.y &&
-          self.units == other.units &&
-          self.colour == other.colour &&
-          self.opacity == other.opacity
-      end
-  
-      def offset_radians
-        offset*Math::PI/6
-      end
-  
-      def half_edge_width 
-        @half_edge_width ||= half_face_size * Math.tan(Math::PI/12) 
-      end
-  
-      def half_face_size 
-        @half_face_size ||= face_size / 2 
-      end
-  
-      def face_size
-        @face_size ||= 3 * units
-      end
-  
-      def rotation_point
-        Matrix.column_vector([x+half_face_size, y+half_face_size])
-      end
-  
-      def rotation_matrix
-        @rotation_matrix ||= Matrix[
-          [Math.cos(offset_radians), -1*Math.sin(offset_radians)], 
-          [Math.sin(offset_radians), Math.cos(offset_radians)]
-        ]
-      end
-  
-      def points
-        base_points.map { |p| (rotation_matrix * (p - rotation_point)) + rotation_point }
-      end
-  
-      def points_string
-        points.map { |p| "#{p[0,0].round},#{p[1,0].round}" }.join(' ')
-      end
-    end
-  end
-end