yzz 2.0.11 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bda3a0b18dda005b0b0d54a41dc9908c573dde80
-  data.tar.gz: 26f8361a80470e97fa4b834e143554f482629b10
+  metadata.gz: f0090b2be4794a0cc39d852aa7a99f3f359802ed
+  data.tar.gz: 0a58007a6dc23b65ac78d6825443cef1777c20fe
 SHA512:
-  metadata.gz: ed056ee307f1f2117d32ddb2db2f3b0b3a36afdee85b05eb22b37d04af1fbfd9da8a14568a228c530ca5b8709db346a25f24c7d3c6a629e5b88103b3ad1cecd1
-  data.tar.gz: 95608ce640a6c937454e0db378fe80fb1c8f8932b2896be4729ad382181caabeee451953af5b408a735ac18b5d887f24f1df35fd0df5b7d24e1f922c29f215ac
+  metadata.gz: cd37148cea5bb9840e9066aea9c47b7799d1c260035353f4118d09fcd3521f3c51fea0a4ed0a2c5b7991bba7fe9dc0e47c2ed7885bdd3f59539385e0eb8526b8
+  data.tar.gz: f31e4e33755aa01f1ed8129ca185ed2996ac1e6d91799203f569d6a201530e26f1cd4dd54751cf1e9a13b0dfb223cabe4da93c0444a47d2651d2718f9dbb07cf

data/lib/yzz.rb

@@ -2,8 +2,13 @@
 
 require_relative "yzz/version"
 require_relative "yzz/side"
+require_relative "yzz/posward_side"
+require_relative "yzz/negward_side"
 require_relative "yzz/side_pair"
 
+require "y_support/core_ext/object"
+require "y_support/core_ext/class"
+
 # Module Yzz is a mixin that provides qualities of a ZZ structure cell to its
 # includers.
 #
@@ -28,29 +33,57 @@ require_relative "yzz/side_pair"
 # in <em>y_nelson</em> gem.
 # 
 module Yzz
-  # Adds initialization of the @zz_dimensions hash to #initialize.
+  # A hash whose #[] method expects a dimension as an argument and returns
+  # a dimension-specific mixin.
+  # 
+  Dimensions = Hash.new { |ꜧ, missing_dimension|
+    ꜧ[ missing_dimension ] = Module.new do
+      define_singleton_method :dimension do missing_dimension end
+      define_method :dimension do missing_dimension end
+    end
+  }
+
+  # An accessor method for a dimension-specific mixin from Yzz::Dimensions hash.
+  # 
+  def self.Dimension dimension
+    Dimensions[ dimension ]
+  end
+
+  # A reader method that returns a hash whose #[] method returns an appropriate
+  # side pair for a supplied dimension. The hash is constructed upon first call
+  # of the reader. This reader subsequently redefines itself (shadows itself with
+  # a newly defined singleton method) so as to always simply return the same hash.
+  # 
+  def zz_dimensions
+    Hash.new { |ꜧ, missing_dimension|
+      ꜧ[ missing_dimension ] = Class.new SidePair() do
+        include ::Yzz.Dimension missing_dimension # ::Yzz just in case
+      end.new
+    }.tap { |ꜧ| define_singleton_method :zz_dimensions do ꜧ end }
+  end
+
+  # A reader method that returns a parametrized subclass of Yzz::SidePair. This
+  # reader subsequently redefines itself (shadows itself with a newly defined
+  # singleton method) so as to always simply return the same parametrized
+  # subclass.
   # 
-  def initialize *args
-    @zz_dimensions = Hash.new { |ꜧ, missing_dimension|
-      ꜧ[ missing_dimension ] = Yzz::SidePair
-        .new( zz: self, dimension: missing_dimension )
-    } # initialize the @zz_dimensions hash
-    super # and proceed as usual
+  def SidePair
+    SidePair.parametrize( zz: self )
+      .tap { |ç| define_singleton_method :SidePair do ç end }
   end
 
   # Returns a SidePair instance along the requested dimension.
   # 
   def along dimension
-    @zz_dimensions[ dimension ]
+    zz_dimensions[ dimension ]
   end
 
   # Returns all sides actually connected to a zz object.
   # 
   def connections
-    @zz_dimensions.map { |_, pair| [ pair.negward, pair.posward ] }
+    zz_dimensions.map { |_, pair| [ pair.negward, pair.posward ] }
       .reduce( [], :+ ).select { |side| side.neighbor.is_a_zz? }
   end
-  alias connectivity connections
 
   # Returns all neighbors of a zz object.
   # 
@@ -63,7 +96,7 @@ module Yzz
   # more than 1 dimension.
   # 
   def towards other
-    connectivity.select { |side| side.neighbor == other }
+    connections.select { |side| side.neighbor == other }
   end
 
   # Prints the labels of the sides facing towards a given zz object.
@@ -72,7 +105,7 @@ module Yzz
     puts towards( other ).map &:label
   end
 
-  # Short string describing the object.
+  # A string describing the object with respect to its zz qualities.
   # 
   def to_s
     "#<Yzz, #{connections.size} conn.>"

data/lib/yzz/negward_side.rb

@@ -0,0 +1,41 @@
+# Separate class for negward sides of zz objects.
+# 
+class Yzz::NegwardSide
+  include Yzz::Side
+
+  # The direction of a NegwardSide is always :negward.
+  # 
+  def direction; :negward end
+
+  # Opposite direction of a NegwardSide is always :negward.
+  # 
+  def opposite_direction; :posward end
+
+  # Given a +Yzz+ object, returns its negward side along the dimension same
+  # as the receiver's dimension. If no object is given, the method simply
+  # returns the receiver.
+  # 
+  def same_side( of: zz )
+    of.along( dimension ).negward
+  end
+
+  # Given a +Yzz+ object, returns its posward side along the dimension same
+  # as the receiver's dimension. If no object is given, posward side opposite
+  # to the receiver is returned.
+  # 
+  def opposite_side( of: zz )
+    of.along( dimension ).posward
+  end
+
+  # Returns the "side label" string.
+  # 
+  def label
+    "<-#{dimension}"
+  end
+
+  # Returns the string briefly describing the instance.
+  # 
+  def to_s
+    "#<Yzz::NegwardSide of #{zz} along #{dimension}>"
+  end
+end # class Yzz::NegwardSide

data/lib/yzz/posward_side.rb

@@ -0,0 +1,41 @@
+# Separate class for posward sides of zz objects.
+# 
+class Yzz::PoswardSide
+  include Yzz::Side
+
+  # The direction of a PoswardSide is always :posward.
+  # 
+  def direction; :posward end
+
+  # Opposite direction of a PoswardSide is always :negward.
+  # 
+  def opposite_direction; :posward end
+
+  # Given a +Yzz+ object, returns its posward side along the dimension same
+  # as the receiver's dimension. If no object is given, the method simply
+  # returns the receiver.
+  #
+  def same_side( of: zz )
+    of.along( dimension ).posward
+  end
+
+  # Given a +Yzz+ object, returns its negward side along the dimension same
+  # as the receiver's dimension. If no object is given, negward side opposite
+  # to the receiver is returned.
+  #
+  def opposite_side( of: zz )
+    of.along( dimension ).negward
+  end
+
+  # Returns the "side label" string.
+  # 
+  def label
+    "#{dimension}->"
+  end
+
+  # Returns the string briefly describing the instance.
+  # 
+  def to_s
+    "#<Yzz::PoswardSide of #{zz} along #{dimension}>"
+  end
+end # class Yzz::PoswardSide

data/lib/yzz/side.rb

@@ -2,34 +2,35 @@
 # has exactly two sides, posward side and negward side, along each dimension.
 # This is represented by +Yzz::Side+ class here.
 # 
-class Yzz::Side
-  attr_reader :zz, :dimension, :direction, :neighbor
+module Yzz::Side
+  attr_reader :neighbor
 
-  # The constructor expects 3 arguments: +:zz+, +:dimension+, +:direction+,
-  # plus 1 optional argument, +:neighbor+.
+  # Reader #zz delegates to the class, relying on parametrized subclassing.
+  # 
+  def zz; self.class.zz end
+
+  # Reader #dimension delegates to the class, relying on parametrized
+  # subclassing.
+  # 
+  def dimension; self.class.dimension end
+
+  # The constructor has one optional named parameter :neighbor.
   #
-  def initialize( zz: ( fail ArgumentError, ":zz missing!" ),
-                  dimension: ( fail ArgumentError, ":dimension missing!" ),
-                  direction: ( fail ArgumentError, ":direction missing!" ),
-                  neighbor: nil )
-    fail TypeError, "Wrong :zz type!" unless zz.is_a_zz?
-    @zz, @dimension, @direction = zz, dimension, direction.to_sym
-    fail TypeError, "Direction must be either :posward or :negward!" unless
-      [ :posward, :negward ].include? direction.to_sym
+  def initialize neighbor: nil
     set_neighbor! neighbor
   end
 
   # Links a new neighbor, unlinking and returning the old one. Cares about the
   # argument type (a Yzz descendant or _nil_), and cares not to break the new
   # neighbor's conflicting connectivity, if any.
-  #
+  # 
   def link new_neighbor
     return unlink if new_neighbor.nil?
     fail TypeError, "Yzz object or nil expected!" unless new_neighbor.is_a_zz?
     conflicter = opposite_side( of: new_neighbor ).neighbor # have concerns
     return new_neighbor if conflicter == self               # no neighbor change
     fail TypeError, "Suggested new neighbor (#{new_neighbor}) already " +
-      "has a conflicting #{OPPOSITE[direction]} link along dimension " +
+      "has a conflicting #{opposite_direction} link along dimension " +
       "#{dimension}!" if conflicter.is_a_zz?
     begin # TODO: Should be an atomic transaction
       old_neighbor = set_neighbor! new_neighbor
@@ -57,37 +58,14 @@ class Yzz::Side
   end
   alias * crossover
 
-  # Given a +Yzz+ object, returns its side along the dimension same as the
-  # receiver's dimension, in the direction opposite to self.
-  #
-  def opposite_side( of: zz )
-    opposite = case direction
-               when :posward then :negward
-               when :negward then :posward
-               else fail "Unknown direction!" end
-    of.along( dimension ).send( opposite )
-  end
-
   # Unlinks the neighbor, returning it.
-  #
+  # 
   def unlink
     unlink!.tap do |neighbor|
       opposite_side( of: neighbor ).unlink! if neighbor.is_a_zz?
     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
@@ -107,4 +85,4 @@ class Yzz::Side
   def unlink!
     set_neighbor! nil
   end
-end # class Yzz::Side
+end # module Yzz::Side

data/lib/yzz/side_pair.rb

@@ -2,32 +2,41 @@
 # of a Yzz cell along a certain dimension.
 # 
 class Yzz::SidePair
-  attr_reader :zz, :dimension, :negward, :posward
+  attr_reader :negward, :posward
   alias p posward
   alias n negward
 
-  def initialize( zz: ( raise ArgumentError, ":zz missing!" ),
-                  dimension: ( raise ArgumentError, ":dimension missing!" ),
-                  negward_neighbor: nil,
-                  posward_neighbor: nil )
-    @zz, @dimension = zz, dimension
-    @negward = Yzz::Side.new( zz: zz,
-                              dimension: dimension,
-                              direction: :negward,
-                              neighbor: negward_neighbor )
-    @posward = Yzz::Side.new( zz: zz,
-                              dimension: dimension,
-                              direction: :posward,
-                              neighbor: posward_neighbor )
+  # Reader #zz delegates to the class, relying on parametrized subclassing.
+  # 
+  def zz
+    self.class.zz 
+  end
+
+  # Reader #dimension delegates to the class, relying on parametrized
+  # subclassing.
+  # 
+  def dimension
+    self.class.dimension
+  end
+
+  # Takes two optional named parameters, :negward_neighbor and :posward_neigbor.
+  # If not given, the sides are constructed not linked to any neigbors.
+  # 
+  def initialize( negward_neighbor: nil, posward_neighbor: nil )
+    param_class!( { NegwardSide: ::Yzz::NegwardSide,
+                    PoswardSide: ::Yzz::PoswardSide },
+                  with: { zz: zz, dimension: dimension } )
+    @negward = NegwardSide().new( neighbor: negward_neighbor )
+    @posward = PoswardSide().new( neighbor: posward_neighbor )
   end
 
-  # Links a neighbor posward.
+  # Makes the supplied object the posward neighbor of the receiver.
   # 
   def >> new_neighbor
     new_neighbor.along( dimension ).tap { posward << new_neighbor }
   end
 
-  # Crossovers a new neighbor posward.
+  # Crossovers the supplied zz object posward.
   # 
   def * new_neighbor
     posward * new_neighbor

data/lib/yzz/version.rb

@@ -1,3 +1,3 @@
 module Yzz
-  VERSION = "2.0.11"
+  VERSION = "2.1.0"
 end

data/test/yzz_test.rb

@@ -41,12 +41,6 @@ describe Yzz do
     end
 
     describe 'more advanced zz object behavior' do
-      it "has #same_side" do
-        zz = @ç.new
-        assert_equal zz.along(:row).p, @a.along(:row).p.same_side( of: zz )
-        assert_equal zz.along(:row).n, @a.along(:row).n.same_side( of: zz )
-      end
-
       it "works" do
         a, b, c = @ç.new, @ç.new, @ç.new
         assert ( b.along(:row).posward << c ).nil?

data/yzz.gemspec

@@ -18,6 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "y_support"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  
+  spec.required_ruby_version = '>= 2.0'
 end

metadata

@@ -1,41 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: yzz
 version: !ruby/object:Gem::Version
-  version: 2.0.11
+  version: 2.1.0
 platform: ruby
 authors:
 - boris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-23 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: y_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Mixin Yzz imbues the includer with qualities of a ZZ structure cell.
@@ -45,12 +59,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/yzz.rb
+- lib/yzz/negward_side.rb
+- lib/yzz/posward_side.rb
 - lib/yzz/side.rb
 - lib/yzz/side_pair.rb
 - lib/yzz/version.rb
@@ -66,17 +82,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A domain model of Ted Nelson's ZZ structures.