yzz 2.0.5 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9860ebc7b96fb69826c2141521128ab87f094de7
-  data.tar.gz: 463614b5ee9ed02ae0af1c57d217cd0b28c7f714
+  metadata.gz: 71afce9e8205663f471fc06f91794c8431b427f0
+  data.tar.gz: bd85a78e18579012e0fca1fc9dd0226fd0fecb8f
 SHA512:
-  metadata.gz: 10c94eaecf746f70f7714e782fac97beb752386a029c8da1cf7a7e69e16c92a8866319d01e562adaea8b0de1ab50d13d3dfda4ca89d72836cb1972d63ea53a2f
-  data.tar.gz: 73f83d60ed2e57397bef44d8de8819e8de03d179222dfa4b3ad95541d0c1a77f8acfb011b0eabdb2a26e62774e3aec89013bf135f7a899a86b2f2e6f272118e6
+  metadata.gz: d1985109e51e93ab03df13eb2800900b4a2306466cbf5a65a0f0459b7b18b6c41e37b3843af073acaf030f782c5937b0f02f67cdd5d96e84e2e0121047baccb5
+  data.tar.gz: 7ec0dd897ac19354c8a19e11a99205661b9691cccfd8ae53fa92bc61e500058140b842578a858e1c1477d3e122007d83bd5ed45b7b9fb8878aa53dfa54679baf

data/README.md

@@ -1,25 +1,65 @@
-# Yzz
+ # Yzz
 
-y_ted is a Zz structure domain model
+`Yzz` is a domain model of Ted Nelson's Zz structures. 
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+The following usage example takes use of `y_support/name_magic` features.
+Please install [y_support gem] before trying it.
+```ruby
+  require 'yzz'
+  require 'y_support/name_magic'
 
-    gem 'yzz'
+  # Let's establish a new class and imbue it with Yzz quality.
+  #
+  class Cell
+    include Yzz, NameMagic
+    def to_s
+      name ? name.to_s : "#<Cell: #{connections.size} conn.>"
+    end
+  end
 
-And then execute:
+  # Let's create 6 new cells.
+  A1, A2, A3, B1, B2, B3 = 6.times.map { Cell.new }
 
-    $ bundle
+  # And let's connect them along :x and :y dimensions:
+  A1.along( :x ) >> A2 >> A3
+  B1.along( :x ) >> B2 >> B3
+  A1.along( :y ) >> B1
+  A2.along( :y ) >> B2
+  A3.along( :y ) >> B3
 
-Or install it yourself as:
+  # The Zz structure that we have created looks like this:
+  #
+  #   a1 --> a2 --> a3
+  #   |      |      |
+  #   |      |      |
+  #   v      v      v
+  #   b1 --> b2 --> b3
+  #
+  # The above structure is a little bit like a small spreadsheet 3×2.
 
-    $ gem install yzz
+  # The structure can be investigated:
+  A1.neighbors # gives all the neighbors of A1
+  #=> [A2, B1]
+  A1.towards A2 # returns all the sides of A1 facing A2
+  #=> [#<Yzz::Side: A1 along x, posward>]
+  A1.tw A2 # more concise way of showing the sides facing A2
+  #=> x->
+  A1.tw B1
+  #=> y->
 
-## Usage
+  # Of course, more complicated Zz structures can be created. See the [online
+  # presentation at xanadu.com for more](http://xanadu.com/zigzag/). For a small
+  # example here, let's create 2 diagonal connections:
 
-Zz structures have been described by Ted Nelson. Yzz provides mixin that
-imbues objects with zz structure qualities.
+  A1.along( :diagonal ) >> B2
+  A2.along( :diagonal ) >> B3
+  A1.tw B2
+  #=> diagonal->
+  A1.neighbors
+  #=> [A2, B1, B2]
+```
 
 ## Contributing
 

data/lib/yzz.rb

@@ -67,6 +67,12 @@ module Yzz
     connectivity.select { |side| side.neighbor == other }
   end
 
+  # Prints the labels of the sides facing towards a given zz object.
+  # 
+  def tw other
+    puts towards( other ).map &:label
+  end
+
   # Short string describing the object.
   # 
   def to_s

data/lib/yzz/side.rb

@@ -66,12 +66,6 @@ class Yzz::Side
   end
   alias * crossover
 
-  # Returns the string briefly describing the instance.
-  # 
-  def to_s
-    "#<YTed::Zz::Side: #{direction} side of #{zz} along #{dimension}>"
-  end
-
   # Given a zz object (named argument :of), returns its side along same
   # dimension, in the direction same as self.
   # 
@@ -94,6 +88,24 @@ class Yzz::Side
     end
   end
 
+  # Returns the "side label" string.
+  # 
+  def label
+    direction == :posward ? "#{dimension}->" : "<-#{dimension}"
+  end
+
+  # Returns the string briefly describing the instance.
+  # 
+  def to_s
+    "#<Yzz::Side: #{zz} along #{dimension}, #{direction}>"
+  end
+
+  # Inspect string of the instance.
+  # 
+  def inspect
+    to_s
+  end
+
   protected
 
   # Sets neighbor carelessly, returning the old neighbor.

data/lib/yzz/side_pair.rb

@@ -44,6 +44,12 @@ class Yzz::SidePair
   # Returns the string briefly describing the instance.
   # 
   def to_s
-    "#<YTed::Zz::SidePair: #{zz} along dimension #{dimension} >"
+    "#<Yzz::SidePair: #{zz} along #{dimension}>"
+  end
+
+  # Instance inspect string.
+  # 
+  def inspect
+    to_s
   end
 end # class YTed::Zz::SidePair

data/lib/yzz/version.rb

@@ -1,3 +1,3 @@
 module Yzz
-  VERSION = "2.0.5"
+  VERSION = "2.0.7"
 end

data/test/yzz_test.rb

@@ -40,7 +40,7 @@ describe Yzz do
     end
 
     it "has #to_s" do
-      assert @a.along(:row).to_s.starts_with? "#<YTed::Zz::SidePair"
+      assert @a.along(:row).to_s.starts_with? "#<Yzz::SidePair"
     end
 
     describe 'more advanced zz object behavior' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yzz
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.7
 platform: ruby
 authors:
 - boris