vector_salad 0.0.7 → 0.0.8

data/lib/vector_salad/standard_shapes/pentagon.rb

@@ -2,10 +2,11 @@ require "vector_salad/standard_shapes/polygon"
 
 module VectorSalad
   module StandardShapes
+    # Regular pentagon shape.
     class Pentagon < Polygon
       # Create a regular pentagon.
       #
-      # Examples:
+      # @example
       #   new(100)
       def initialize(radius, **options)
         super(5, radius, **options)

data/lib/vector_salad/standard_shapes/polygon.rb

@@ -4,13 +4,14 @@ require "vector_salad/mixins/at"
 
 module VectorSalad
   module StandardShapes
+    # Regular polygon shape.
     class Polygon < BasicShape
       include VectorSalad::Mixins::At
       attr_reader :sides
 
       # Create a regular polygon with a specified number of sides.
       #
-      # Examples:
+      # @example
       #   new(6, 100)
       Contract PolySides, Pos, {} => Polygon
       def initialize(sides, radius, **options)
@@ -20,6 +21,7 @@ module VectorSalad
         self
       end
 
+      # Convert the shape to a path
       def to_path
         nodes = []
         angle = 2 * Math::PI / @sides

data/lib/vector_salad/standard_shapes/rect.rb

@@ -4,13 +4,14 @@ require "vector_salad/mixins/at"
 
 module VectorSalad
   module StandardShapes
+    # Rectangle shape.
     class Rect < BasicShape
       include VectorSalad::Mixins::At
       attr_reader :width, :height
 
       # Create a rectangle with specified width and height.
       #
-      # Examples:
+      # @example
       #   new(100, 200)
       Contract Pos, Pos, {} => Rect
       def initialize(width, height, **options)
@@ -20,6 +21,7 @@ module VectorSalad
         self
       end
 
+      # Convert the shape to a path
       def to_path
         Path.new(
           N.n(@x, @y),

data/lib/vector_salad/standard_shapes/rotate.rb

@@ -1,12 +1,10 @@
-require 'vector_salad/standard_shapes/transform'
+require "vector_salad/standard_shapes/transform"
 
 module VectorSalad
   module StandardShapes
+    # Rotates the contained shapes by the specified angle about the origin.
     class Rotate < Transform
-      # Rotates the contained shapes by the specified angle about the origin.
-      #
-      # Examples:
-      #
+      # @example
       #   rotate(45) do
       #     triangle(30, at: [50, -50])
       #     pentagon(40, at: [50, -100])

data/lib/vector_salad/standard_shapes/scale.rb

@@ -1,24 +1,25 @@
-require 'vector_salad/standard_shapes/transform'
+require "vector_salad/standard_shapes/transform"
 
 module VectorSalad
   module StandardShapes
+    # Scale the contained shapes by multiplier about the origin.
     class Scale < Transform
-      # Scale the contained shapes by multiplier about the origin.
-      # Supply just 1 multiplier to scale evenly, or x and y multipliers
-      # to stretch or squash the axies.
-      # @param x_multiplier 1 is no change, 2 is double size, 0.5 is half, etc.
-      #
-      # Examples:
+      # Supply just 1 multiplier to scale evenly,
+      # or x and y multipliers to stretch or squash the axies.
       #
+      # @example
       #   scale(2) do
       #     triangle(30, at: [50, -50])
       #     pentagon(40, at: [50, -100])
       #   end
       #
+      # @example Uneven scaling
       #   scale(2, 0.5) do
       #     triangle(30, at: [50, -50])
       #     pentagon(40, at: [50, -100])
       #   end
+      #
+      # @param x_multiplier 1 is no change, 2 is double size, 0.5 is half, etc.
       Contract Coord, Coord, { canvas: VectorSalad::Canvas }, Proc => Any
       def initialize(x_multiplier,
                      y_multiplier = x_multiplier,

data/lib/vector_salad/standard_shapes/square.rb

@@ -1,34 +1,19 @@
-require "vector_salad/standard_shapes/path"
-require "vector_salad/standard_shapes/n"
+require "vector_salad/standard_shapes/rect"
 require "vector_salad/mixins/at"
 
 module VectorSalad
   module StandardShapes
-    class Square < BasicShape
-      include VectorSalad::Mixins::At
-      attr_reader :size
-
+    # Square shape with equal width and height.
+    class Square < Rect
       # Create a square with equal width and height.
       #
-      # Examples:
-      #   new(100).detail 'Square sides 100x100 at 0,0.'
+      # @example Square with sides 100x100
+      #   new(100)
       Contract Pos, {} => Square
       def initialize(size, **options)
-        @size = size
-        @options = options
-        @x, @y = 0, 0
+        super(size, size, **options)
         self
       end
-
-      def to_path
-        Path.new(
-          N.n(@x, @y),
-          N.n(@x, @y + @size),
-          N.n(@x + @size, @y + @size),
-          N.n(@x + @size, @y),
-          **@options
-        )
-      end
     end
   end
 end

data/lib/vector_salad/standard_shapes/standard_shapes.rb

@@ -0,0 +1,6 @@
+module VectorSalad
+  # All standard shapes built into Vector Salad.
+  # Your compositions will be made from combinations of these.
+  module StandardShapes
+  end
+end

data/lib/vector_salad/standard_shapes/transform.rb

@@ -1,12 +1,13 @@
-require 'contracts'
-require 'contracts_contracts'
+require "contracts"
+require "contracts_contracts"
 
-require 'vector_salad/dsl'
-require 'vector_salad/canvas'
-require 'vector_salad/standard_shapes/path'
+require "vector_salad/dsl"
+require "vector_salad/canvas"
+require "vector_salad/standard_shapes/path"
 
 module VectorSalad
   module StandardShapes
+    # @api private
     class Transform
       include VectorSalad::DSL
       include VectorSalad::StandardShapes

data/lib/vector_salad/standard_shapes/triangle.rb

@@ -2,10 +2,11 @@ require "vector_salad/standard_shapes/polygon"
 
 module VectorSalad
   module StandardShapes
+    # Equilateral triangle shape.
     class Triangle < Polygon
-      # Create an equilateral triangle.
+      # Create a new equilateral triangle.
       #
-      # Examples:
+      # @example
       #   new(100)
       def initialize(radius, **options)
         super(3, radius, **options)

data/lib/vector_salad/standard_shapes/union.rb

@@ -1,21 +1,20 @@
-require 'vector_salad/standard_shapes/clip'
-require 'vector_salad/standard_shapes/multi_path'
+require "vector_salad/standard_shapes/clip"
+require "vector_salad/standard_shapes/multi_path"
 
 module VectorSalad
   module StandardShapes
+    # Unite the contained shapes.
     class Union < Clip
-      # Unite paths.
       # The first path is used as the subject, subsequent paths are united
       # with the first.
       #
-      # Examples:
-      #
+      # @example
       #   Union.new do
       #     canvas << Path.new([0,0], [90,90], [0,90])
       #     canvas << Path.new([50,0], [95,0], [50, 70])
       #   end
       #
-      #   # Using DSL:
+      # @example Using DSL:
       #   union do
       #     path([0,0], [90,90], [0,90])
       #     path([50,0], [95,0], [50, 70])

data/lib/vector_salad/version.rb

@@ -1,3 +1,3 @@
 module VectorSalad
-  VERSION = "0.0.7"
+  VERSION = "0.0.8" # Version of VectorSalad
 end

data/lib/vector_salad.rb

@@ -1,5 +1,5 @@
 require "vector_salad/version"
 
+# Top level namespace for Vector Salad, the design as code tool.
 module VectorSalad
-  # Your code goes here...
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vector_salad
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Simon George
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-12 00:00:00.000000000 Z
+date: 2015-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pretty_backtrace
@@ -208,6 +208,7 @@ files:
 - lib/vector_salad/interpolate.rb
 - lib/vector_salad/magic.rb
 - lib/vector_salad/mixins/at.rb
+- lib/vector_salad/mixins/mixins.rb
 - lib/vector_salad/monkeypatches.rb
 - lib/vector_salad/shape_proxy.rb
 - lib/vector_salad/standard_shapes/basic_shape.rb
@@ -233,6 +234,7 @@ files:
 - lib/vector_salad/standard_shapes/rotate.rb
 - lib/vector_salad/standard_shapes/scale.rb
 - lib/vector_salad/standard_shapes/square.rb
+- lib/vector_salad/standard_shapes/standard_shapes.rb
 - lib/vector_salad/standard_shapes/transform.rb
 - lib/vector_salad/standard_shapes/triangle.rb
 - lib/vector_salad/standard_shapes/union.rb