data_types 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d10672d37ed9a9d9078f149f3b5461b0832d87af
-  data.tar.gz: 35f5997085de9732c2de7b2a65c976a9a28cc7f1
+  metadata.gz: b32c543113e49bddaced81642323a64dd7070482
+  data.tar.gz: 38722da0ce5a3bfb9e8f0e73901b459fb769b8e6
 SHA512:
-  metadata.gz: 895dde9c53db720c9daf23bf8dfd2610d9ffd276f1cb505154b7bf3901d689ba7f6bc288633cf6512f450494e56845018269e43b38aa15382edbb190eee33d29
-  data.tar.gz: 9948ee9c1429accbdcf45d30a2df553d68da1ad7651468b6250ff58e7b59adab62f4af44c543c3ff5cfbefde087763ebfaec0d893634bea43e311e9a8934c5de
+  metadata.gz: 793cd05b43b4856f58b625c4adcc47ab718105882fbde3c4be5f6b30b41e22560d4e813683911d5eaeeed033f07631800db0abc2702b69642e950a6eba3ccc64
+  data.tar.gz: 5144e1a2677b04b3dc18c02e7d726f9c2dba98e6397eed633696575e77d6ec510d549e67c4e84975e20d36465f5c57f551c4c8f5b3e178378f8d71fc3c47974c

data/lib/data_types/pair.rb

@@ -1,10 +1,10 @@
-# The Pair class represents a pair of two pieces of data.
+# The Pair class represents a pair of two pieces of data. The attributes are readers for custom = behavior.
 class Pair
   # @return [Object] The left data.
-  attr_accessor :left
+  attr_reader :left
 
   # @return [Object] The right data.
-  attr_accessor :right
+  attr_reader :right
 
   # Creates a new pair.
   # @param left [Object] The left piece of data.
@@ -14,6 +14,7 @@ class Pair
   def initialize(left, right)
     @left = left
     @right = right
+    @frozen = false
   end
 
   # Gets a string representation of the pair.
@@ -72,4 +73,60 @@ class Pair
     @right = left
     self
   end
+
+  # Returns true if self and other have the same left and right values.
+  # @param other [Pair] The other Pair
+  # @return [Boolean] Whether they are equivalent.
+  def eql?(other)
+    @left == other.left && @right == other.right
+  end
+
+  alias == eql?
+
+  # Returns whether self is frozen.
+  # @return [Boolean] Whether self is frozen.
+  def frozen?
+    @frozen
+  end
+
+  # Deep-freezes the Pair, freezing left and right, as well as the object itself.
+  # @return [Pair] self.
+  def freeze
+    unless frozen?
+      @left.freeze
+      @right.freeze
+      @frozen = true
+    end
+    self
+  end
+
+  # Sets right to the value.
+  # @raise RuntimeError when self is frozen.
+  # @param new [Any] The new right value.
+  # @return [void]
+  def right=(new)
+    if frozen?
+      raise RuntimeError.new("can't modify frozen Pair")
+    else
+      @right = new
+    end
+  end
+
+  # Sets left to the value.
+  # @raise RuntimeError when self is frozen.
+  # @param new [Any] The new left value.
+  # @return [void]
+  def left=(new)
+    if frozen?
+      raise RuntimeError.new("can't modify frozen Pair")
+    else
+      @left = new
+    end
+  end
+
+  # Returns a new copied version of the Pair, with copied values.
+  # @return [Pair] The new Pair
+  def clone
+    Pair.new(@left.dup, @right.dup)
+  end
 end

data/lib/data_types/triplet.rb

@@ -1,13 +1,13 @@
-# Triplet class represents a set of 3 pieces of data.
+# Triplet class represents a set of 3 pieces of data. The attributes are readers for custom = behavior.
 class Triplet
   # @return [Object] The first data piece.
-  attr_accessor :left
+  attr_reader :left
 
   # @return [Object] The second data piece.
-  attr_accessor :middle
+  attr_reader :middle
 
   # @return [Object] The third data piece.
-  attr_accessor :right
+  attr_reader :right
 
   # Creates a new Triplet.
   # @param left [Object] The first data.
@@ -18,6 +18,7 @@ class Triplet
     @left = left
     @middle = middle
     @right = right
+    @frozen = false
   end
 
   # @return [String] The stringified version of the Triplet.
@@ -77,4 +78,73 @@ class Triplet
     @left = right
     self
   end
+
+  # Returns true if self and other have the same left and right values.
+  # @param other [Triplet] The other Triplet
+  # @return [Boolean] Whether they are equivalent.
+  def eql?(other)
+    @left == other.left &&@middle == other.middle && @right == other.right
+  end
+
+  alias == eql?
+
+  # Returns whether self is frozen.
+  # @return [Boolean] Whether self is frozen.
+  def frozen?
+    @frozen
+  end
+
+  # Deep-freezes the Triplet, freezing left, middle, and right, as well as the object itself.
+  # @return [Triplet] self.
+  def freeze
+    unless frozen?
+      @left.freeze
+      @middle.freeze
+      @right.freeze
+      @frozen = true
+    end
+    self
+  end
+
+  # Sets right to the value.
+  # @raise RuntimeError when self is frozen.
+  # @param new [Any] The new right value.
+  # @return [void]
+  def right=(new)
+    if frozen?
+      raise RuntimeError.new("can't modify frozen Triplet")
+    else
+      @right = new
+    end
+  end
+
+  # Sets middle to the value.
+  # @raise RuntimeError when self is frozen.
+  # @param new [Any] The new middle value.
+  # @return [void]
+  def middle=(new)
+    if frozen?
+      raise RuntimeError.new("can't modify frozen Triplet")
+    else
+      @middle = new
+    end
+  end
+
+  # Sets left to the value.
+  # @raise RuntimeError when self is frozen.
+  # @param new [Any] The new left value.
+  # @return [void]
+  def left=(new)
+    if frozen?
+      raise RuntimeError.new("can't modify frozen Triplet")
+    else
+      @left = new
+    end
+  end
+
+  # Returns a new copied version of the Triplet, with copied values.
+  # @return [Triplet] The new Triplet
+  def clone
+    Triplet.new(@left.dup, @middle.dup, @right.dup)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: data_types
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eli Foster
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-26 00:00:00.000000000 Z
+date: 2016-03-14 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: elifosterwy@gmail.com
@@ -19,8 +19,6 @@ files:
 - lib/data_types.rb
 - lib/data_types/pair.rb
 - lib/data_types/triplet.rb
-- spec/pair_test_cases.rb
-- spec/triplet_test_cases.rb
 homepage: https://github.com/elifoster/data_types
 licenses:
 - CC-BY-NC-ND-4.0
@@ -42,9 +40,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that adds new object types like pairs and triplets.
 test_files: []
-has_rdoc: 

data/spec/pair_test_cases.rb

@@ -1,53 +0,0 @@
-require 'test/unit'
-require_relative '../lib/data_types/pair'
-
-class PairTestCases < Test::Unit::TestCase
-  def test_string
-    pair = Pair.new(1, 2)
-    assert_equal('1, 2', pair.to_s)
-  end
-
-  def test_array
-    pair = Pair.new(1, 2)
-    assert_equal([1, 2], pair.to_a)
-  end
-
-  def test_hash
-    pair = Pair.new(1, 2)
-    assert_equal({ left: 1, right: 2 }, pair.to_h)
-  end
-
-  def test_include?
-    pair = Pair.new(1, 2)
-    assert_equal(true, pair.include?(1))
-    assert_equal(true, pair.include?(2))
-    assert_equal(false, pair.include?(3))
-  end
-
-  def test_flip
-    pair = Pair.new(1, 2)
-    assert_equal(1, pair.flip.right)
-    assert_equal(2, pair.flip.left)
-  end
-
-  def test_flip!
-    pair = Pair.new(1, 2)
-    pair.flip!
-    assert_equal(1, pair.right)
-    assert_equal(2, pair.left)
-  end
-
-  def test_empty?
-    pair = Pair.new(1, 2)
-    assert_equal(false, pair.empty?)
-    pair.clear
-    assert_equal(true, pair.empty?)
-  end
-
-  def test_clear
-    pair = Pair.new(1, 2)
-    pair.clear
-    assert_nil(pair.left)
-    assert_nil(pair.right)
-  end
-end

data/spec/triplet_test_cases.rb

@@ -1,57 +0,0 @@
-require 'test/unit'
-require_relative '../lib/data_types/triplet'
-
-class TripletTestCases < Test::Unit::TestCase
-  def test_string
-    triplet = Triplet.new(1, 2, 3)
-    assert_equal('1, 2, 3', triplet.to_s)
-  end
-
-  def test_array
-    triplet = Triplet.new(1, 2, 3)
-    assert_equal([1, 2, 3], triplet.to_a)
-  end
-
-  def test_hash
-    triplet = Triplet.new(1, 2, 3)
-    assert_equal({ left: 1, middle: 2, right: 3 }, triplet.to_h)
-  end
-
-  def test_include?
-    triplet = Triplet.new(1, 2, 3)
-    assert_equal(true, triplet.include?(1))
-    assert_equal(true, triplet.include?(2))
-    assert_equal(true, triplet.include?(3))
-    assert_equal(false, triplet.include?(4))
-  end
-
-  def test_flip
-    triplet = Triplet.new(1, 2, 3)
-    assert_equal(1, triplet.flip.right)
-    assert_equal(2, triplet.flip.middle)
-    assert_equal(3, triplet.flip.left)
-  end
-
-  def test_flip!
-    triplet = Triplet.new(1, 2, 3)
-    triplet.flip!
-    assert_equal(1, triplet.right)
-    assert_equal(2, triplet.middle)
-    assert_equal(3, triplet.left)
-  end
-
-  def test_empty?
-    triplet = Triplet.new(1, 2, 3)
-    assert_equal(false, triplet.empty?)
-    triplet.clear
-    assert_equal(true, triplet.empty?)
-  end
-
-  def test_clear
-    triplet = Triplet.new(1, 2, 3)
-    triplet.clear
-    assert_nil(triplet.left)
-    assert_nil(triplet.middle)
-    assert_nil(triplet.right)
-  end
-end