data_types 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d10672d37ed9a9d9078f149f3b5461b0832d87af
+  data.tar.gz: 35f5997085de9732c2de7b2a65c976a9a28cc7f1
+SHA512:
+  metadata.gz: 895dde9c53db720c9daf23bf8dfd2610d9ffd276f1cb505154b7bf3901d689ba7f6bc288633cf6512f450494e56845018269e43b38aa15382edbb190eee33d29
+  data.tar.gz: 9948ee9c1429accbdcf45d30a2df553d68da1ad7651468b6250ff58e7b59adab62f4af44c543c3ff5cfbefde087763ebfaec0d893634bea43e311e9a8934c5de

data/lib/data_types.rb

@@ -0,0 +1,2 @@
+require_relative 'data_types/pair'
+require_relative 'data_types/triplet'

data/lib/data_types/pair.rb

@@ -0,0 +1,75 @@
+# The Pair class represents a pair of two pieces of data.
+class Pair
+  # @return [Object] The left data.
+  attr_accessor :left
+
+  # @return [Object] The right data.
+  attr_accessor :right
+
+  # Creates a new pair.
+  # @param left [Object] The left piece of data.
+  # @param right [Object] The right piece of data.
+  # @return [Pair<Object, Object>] The new pair created with these pieces of
+  #   data.
+  def initialize(left, right)
+    @left = left
+    @right = right
+  end
+
+  # Gets a string representation of the pair.
+  # @return [String] The stringified version of the pair.
+  def to_s
+    "#{@left}, #{@right}"
+  end
+
+  # Removes all of the values in the pair..
+  # @return [void]
+  def clear
+    remove_instance_variable(:@left)
+    remove_instance_variable(:@right)
+  end
+
+  # Gets the Pair as an array.
+  # @return [Array<Object>] The array with the pair pieces.
+  def to_a
+    [@left, @right]
+  end
+
+  # Gets the Pair as a hash with left and right keys.
+  # @return [Hash<Symbol, Object>] The hash with the pair pieces.
+  def to_h
+    {
+      left: @left,
+      right: @right
+    }
+  end
+
+  # Returns true if the given object is present in self.
+  # @param data [Object]
+  # @return [Boolean]
+  def include?(data)
+    @left == data || @right == data
+  end
+
+  # Gets whether the pair is empty.
+  # @return [Boolean] True if all values are nil.
+  def empty?
+    @left.nil? && @right.nil?
+  end
+
+  # Flips the pair.
+  # @return [Pair] A new pair with the left and right values flipped.
+  def flip
+    Pair.new(@right, @left)
+  end
+
+  # Flips the pair in place.
+  # @return [Pair] Returns self.
+  def flip!
+    right = @right
+    left = @left
+    @left = right
+    @right = left
+    self
+  end
+end

data/lib/data_types/triplet.rb

@@ -0,0 +1,80 @@
+# Triplet class represents a set of 3 pieces of data.
+class Triplet
+  # @return [Object] The first data piece.
+  attr_accessor :left
+
+  # @return [Object] The second data piece.
+  attr_accessor :middle
+
+  # @return [Object] The third data piece.
+  attr_accessor :right
+
+  # Creates a new Triplet.
+  # @param left [Object] The first data.
+  # @param middle [Object] The middle data.
+  # @param right [Object] The last data.
+  # @return [Triplet<Object, Object, Object>] The new Triplet.
+  def initialize(left, middle, right)
+    @left = left
+    @middle = middle
+    @right = right
+  end
+
+  # @return [String] The stringified version of the Triplet.
+  def to_s
+    "#{@left}, #{@middle}, #{@right}"
+  end
+
+  # Removes all of the values in the triplet.
+  # @return [void]
+  def clear
+    remove_instance_variable(:@left)
+    remove_instance_variable(:@middle)
+    remove_instance_variable(:@right)
+  end
+
+  # Gets the Triplet as an array.
+  # @return [Array<Object>] The array with the triplet pieces.
+  def to_a
+    [@left, @middle, @right]
+  end
+
+  # Gets the Triplet as a hash with left, middle, and right keys.
+  # @return [Hash<Symbol, Object>] The hash with the triplet pieces.
+  def to_h
+    {
+      left: @left,
+      middle: @middle,
+      right: @right
+    }
+  end
+
+  # Returns true if the given object is present in self.
+  # @param data [Object]
+  # @return [Boolean]
+  def include?(data)
+    @left == data || @middle == data || @right == data
+  end
+
+  # Gets whether the triplet is empty.
+  # @return [Boolean] True if all values are nil.
+  def empty?
+    @left.nil? && @middle.nil? && @right.nil?
+  end
+
+  # Flips the Triplet into a new Triplet.
+  # @return [Triplet] The new triplet with the flipped data.
+  def flip
+    Triplet.new(@right, @middle, @left)
+  end
+
+  # Flips the triplet in place.
+  # @return [Triplet] The Triplet with the left and right values flipped.
+  def flip!
+    left = @left
+    right = @right
+    @right = left
+    @left = right
+    self
+  end
+end

data/spec/pair_test_cases.rb

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,57 @@
+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

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: data_types
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Eli Foster
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-26 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: elifosterwy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+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
+metadata:
+  issue_tracker: https://github.com/elifoster/data_types/issues
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby gem that adds new object types like pairs and triplets.
+test_files: []
+has_rdoc: