spiro 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 84d28bbf80c2fe0eb5bcbe8fe82a60109bfa2425
-  data.tar.gz: 1d989e78b0aa54e1738e8ea321cd6d66e0734e95
+  metadata.gz: d7ea81ccb6dc0f98c003f24d474ba3b34f246601
+  data.tar.gz: 8d0f682b693e55e32acfe428aef0ca6dc0338b7c
 SHA512:
-  metadata.gz: 33f6c9af30e379a5390f2ecd549189a5b9f3f2e19ed8e84f806e91a9495b32fc208fb3735d1cdd69137b2383dc6c817c872395682fe392e87a21a4fc14a28972
-  data.tar.gz: 3cb174eac9af018d16b5f520c5efb068b3ab765b5bf0f6c66845c16f0c5119b79bfb0682275f468eb85e025c67d6b0812fcb6f09e0fb053c0190536cecfcfa90
+  metadata.gz: cc6f2f0a04843331562b99cf8eb5733671c8993215a61ee911ccb1affd3b642f37e71a7c4dba8371dca4b0390c3b46df9d60c807eae66453ac5873f7e0d138d9
+  data.tar.gz: 363483c7472837abf2d1dd8197b453e780e287a63433542567dd4f450eb3e20396808b79fd8bb90e57d33fe507ade009c458609cce6efbcbf6136ad26dfe44fb

data/README.md

@@ -1,6 +1,17 @@
 # Spiro
 
-TODO: Write a gem description
+A Ruby wrapper for [libspiro](https://github.com/fontforge/libspiro), which is itself a bundling of [Spiro](http://levien.com/spiro/) by Raph Levien.
+
+Spiro makes drawing beautiful curves easy.
+
+Usually Bézier splines are used for curves. These require off-curve points which "bend" the line towards them. As these points aren't on the line they are quite unintuitive and it's hard to imagine where the line will end up without a GUI.
+
+Raph Levien's Spiro splines only use on-curve points and so are easier to use and more intuitive to the artist. They make it easy to maintain constant curvature as well as constant slope. Such curves will simply look nicer.
+
+This library will take an array of Spiro control points and convert them into a series of Bézier splines which can then be used in the myriad of ways the world has come to use Béziers.
+
+It was created for the design as code tool [Vector Salad](https://github.com/sfcgeorge/vector_salad).
+
 
 ## Installation
 
@@ -18,9 +29,30 @@ Or install it yourself as:
 
     $ gem install spiro
 
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# takes an array of spiro points and returns an array of bezier points
+# (this will potentially contain both cubic and quadratic beziers)
+splines = Spiro.spiros_to_splines(
+  [[0, 0, :node], [100, 50, :g2], [-50, 300, :node]],
+  true # the path is closed
+)
+```
+
+### Node types:
+
+* :node, a standard non curved point
+* :g2, a node with g2 curvature
+* :g4, a node with g4 curvature
+* :left, used to connect a curved line to a straight one
+* :right, used to connect a straight line to a curved one. If you have a contour which is drawn clockwise, and you have a straight segment at the top, then the left point of that straight segment should be a left constraint, and the right point should be a right constraint.
+
+It's often best to just experiment with the above until you get the desired result.
+
+If it fails to produce a curve, then try switching between g2 and g4 points, and generally experimenting with moving nodes around.
+
 
 ## Contributing
 

data/lib/spiro.rb

@@ -2,5 +2,4 @@ require 'spiro/version'
 require 'spiro/spiro'
 
 module Spiro
-  # Your code goes here...
 end

data/lib/spiro/version.rb

@@ -1,3 +1,3 @@
 module Spiro
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/test/test_spiro.rb

@@ -31,12 +31,12 @@ class TestSpiro < Minitest::Test
   def test_spiros_to_splines_returns_array
     splines = Spiro.spiros_to_splines(
       [[0, 0, :node], [100, 50, :g2], [-50, 300, :node]],
-    true)
+      true
+    )
     assert_kind_of Array, splines
   end
 
   #def test_spiros_to_splines_with_random_data_stress_test
-    ## It will crash after a while, see below
     #while true do
       #path = Random.rand(5..50).times.map{rand_n}
       #p path
@@ -44,26 +44,4 @@ class TestSpiro < Minitest::Test
       #assert_includes [Array, NilClass], splines.class
     #end
   #end
-
-  def test_this_one_crashes
-    # I sometimes get "pointer being freed was not allocated" but it takes a while.
-    # I thought it might be some nodes that Spiro doesn't like, but these are fine
-    # sometimes, it's only after running several times that it crashes.
-    # There must be a bad bit of memory management somewhere :-/
-    #
-    # Other times I get "Segmentation fault".
-    #
-    # It can crash very quickly, or it can take several seconds. So I'm guessing
-    # that there a piece of memory is being freed when it shouldn't somewhere,
-    # and it depends where that memory is whether it hurts anything. Not good.
-    #
-    # Anyway, I don't really know C and because all of the Ruby stacktrace
-    # thrown in I can't figure out if the problem is in my code or Spiro.
-    # Does anyone know C well enough to fix this?
-    path = [[-39, -57, :g2], [-59, 20, :right], [37, -14, :g2], [-67, -40, :g2], [-83, 20, :g2], [56, -87, :left], [-11, 86, :left], [11, 29, :left], [-87, 54, :left]]
-    while true do
-      splines = Spiro.spiros_to_splines(path, true)
-      assert_includes [Array, NilClass], splines.class
-    end
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spiro
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Raph Levien
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler