rational_number 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc867843cd407372129d0e3090f47476e499295b
-  data.tar.gz: 54595ccb8d94685801bec59fd2412ba9b9e4f920
+  metadata.gz: 794dc0823355a2349f3f92c556d9256119791143
+  data.tar.gz: 7560fbf7d62ba9aefb95f243ad1ca16142591c96
 SHA512:
-  metadata.gz: 7967627fae4440914f62fce3031c00fb6879642137f339a4c53e747c452f54edb6ad9f1729f8f6de36f63e82eda028185b2b06cf4b47cf2a7e3429baa621d319
-  data.tar.gz: d0de1d59035256db00f326c701f20d6af1fb30b4d44e7b08e1b426d46913f39cec54f28464fd0d154c4eab4218db1c038fa2a01f191483db1b6054b0f1d851ab
+  metadata.gz: b0c44b8906a602e9a715878855762692a532e369a6928f90b212487829890b0d1eff7eb732586a174dcf98dc5b37d36d718dd893398bd4f37ab048313687d315
+  data.tar.gz: ee14b91f09f34c9045c0ec27bdb0a47352d89027dcd2e752ab59e4fdab765315dee0718cd2ebfc3f5821142ae6f4529c42d4a9c907148023a6af4417b7198c1c

data/.gitignore

@@ -43,3 +43,5 @@ tmp
 .yardoc
 _yardoc
 doc/
+
+*.sublime-*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rational_number (0.1.0)
+    rational_number (0.1.1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -1,5 +1,5 @@
 # rational_number
-[![Build Status](https://travis-ci.org/leifcr/rational_number.png?branch=master)](https://travis-ci.org/leifcr/rational_number) [![Coverage Status](https://coveralls.io/repos/leifcr/rational_number/badge.png?branch=master)](https://coveralls.io/r/leifcr/rational_number?branch=master)
+[![Gem Version](https://badge.fury.io/rb/rational_number.png)](http://badge.fury.io/rb/rational_number) [![Build Status](https://travis-ci.org/leifcr/rational_number.png?branch=master)](https://travis-ci.org/leifcr/rational_number) [![Coverage Status](https://coveralls.io/repos/leifcr/rational_number/badge.png?branch=master)](https://coveralls.io/r/leifcr/rational_number?branch=master) [![Code Climate](https://codeclimate.com/github/leifcr/rational_number.png)](https://codeclimate.com/github/leifcr/rational_number)
 
 This implements basic rational numbers in Ruby. It can be used in tree implementations and provides a really fast way of looking up a sorted tree.
 

data/lib/rational_number/version.rb

@@ -1,3 +1,3 @@
 module RationalNumberGem
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/rational_number.rb

@@ -14,10 +14,13 @@
 
 class RationalNumber # < Object
   include Comparable
-  attr :nv, :dv, :snv, :sdv, :number
+  attr_reader :nv, :dv, :snv, :sdv, :number
 
   ##
   # Compare to other (Comparable)
+  # Returns 1 if greater than, -1 if less than, and 0 for equality
+  #
+  # @return [Integer] Integer stating the comparison.
   #
   def <=>(other)
     return 0 if (@nv === other.nv) and (@dv === other.dv) and (@snv == other.snv) and (@sdv == other.sdv)
@@ -25,8 +28,6 @@ class RationalNumber # < Object
       -1
     elsif @number > other.number
       1
-    else
-      0
     end
   end
 
@@ -57,23 +58,78 @@ class RationalNumber # < Object
   ##
   # Initialize rational number
   #
+  # @param [Integer/RationalNumber] The nominator value or a rational number, depending on number of given parameters
+  # @param [Integer] The denominator value
+  # @param [Integer] The SNV value
+  # @param [Integer] The SDV Value
+  #
+  # @return [undefined]
+  #
+  def initialize(a = nil, b = nil, c = nil, d = nil)
+    if a == nil and b == nil and c == nil and d == nil
+      init_with_4_args()
+    elsif b == nil and c == nil and d == nil
+      init_with_1_arg(a)
+    elsif c == nil and d == nil
+      init_with_2_args(a,b)
+    else
+      init_with_4_args(a,b,c,d)
+    end
+  end
+
+  ##
+  # Initialize rational number with 1 argument
+  #
+  # @param [RationalNumber] The rational number to initialize with
+  #
+  # @return [undefined]
+  #
+  def init_with_1_arg(rational_number)
+    raise ArgumentError, "given :rational_number in options is of wrong type, should be RationalNumber" unless rational_number.instance_of?(RationalNumber)
+    set_values(rational_number.nv, rational_number.dv, rational_number.snv, rational_number.sdv)
+  end
+
+  ##
+  # Initialize rational number with 2 arguments
+  #
+  # @param [Integer] The nominator value
+  # @param [Integer] The denominator value
+  #
+  # @return [undefined]
+  #
+  def init_with_2_args(nv = 0, dv = 1)
+    raise ArgumentError, ":nv and :dv must be kind_of?(Integer)." unless nv.kind_of?(Integer) and dv.kind_of?(Integer)
+    # initial values needed when getting parent and position
+    @nv = nv
+    @dv = dv
+    # calculate value
+    val = value_from_parent_and_position(self.parent, self.position)
+    raise ArgumentError, "Cannot set nv and dv values. verify the values for :nv and :dv" unless ((val.nv == nv) and (val.dv == dv))
+    set_values(val.nv,val.dv,val.snv,val.sdv)
+  end
+
+  ##
+  # Initialize rational number with 4 arguments
+  #
   # @param [Integer] The nominator value
-  # @param [Integer] The denomitaor value
+  # @param [Integer] The denominator value
   # @param [Integer] The SNV value
   # @param [Integer] The SDV Value
   #
   # @return [undefined]
   #
-  def initialize(nv = 0, dv = 1, snv = 1, sdv = 0)
+  def init_with_4_args(nv = 0, dv = 1, snv = 1, sdv = 0)
+    unless nv.kind_of?(Integer) and dv.kind_of?(Integer) and snv.kind_of?(Integer) and sdv.kind_of?(Integer)
+      raise ArgumentError, ":nv, :dv, :snv and :sdv must be kind_of?(Integer)."
+    end
     set_values(nv, dv, snv, sdv)
-    #super()
   end
 
   ##
   # Set the values of nv,dv,snv and sdv directly
   #
   # @param [Integer] The nominator value
-  # @param [Integer] The denomitaor value
+  # @param [Integer] The denominator value
   # @param [Integer] The SNV value
   # @param [Integer] The SDV Value
   #
@@ -82,7 +138,11 @@ class RationalNumber # < Object
     @dv = dv
     @snv = snv
     @sdv = sdv
-    @number = Float(nv)/Float(dv)
+    if nv == 0 and dv == 0
+      @number = Float(0)
+    else
+      @number = Float(nv)/Float(dv)
+    end
   end
 
   ##

data/spec/rational_number_spec.rb

@@ -1,165 +1,254 @@
 require 'spec_helper'
 describe "RationalNumber" do
-  before(:each) do
-    @root = RationalNumber.new
-    @first_child = @root.child_from_position(1)
-  end
-
-  it "should verify that @root is @root" do
-    @root.root?.should == true
-  end
-
-  it "should raise an error when trying to get parent rational number on @root" do
-    expect {@root.parent}.to raise_error(NoParentRationalNumberIsRootError)
-  end
-
-  it "should raise an error when trying to get a sibling on @root" do
-    expect {@root.next_sibling}.to raise_error(RationalNumberIsRootNoSiblingsError)
-    expect {@root.sibling_from_position(0)}.to raise_error(RationalNumberIsRootNoSiblingsError)
-  end
-
-  it "should verify values" do
-    @root.nv.should ==  0
-    @root.dv.should ==  1
-    @root.snv.should == 1
-    @root.sdv.should == 0
-  end
-
-  it "should get the first child values" do
-    @first_child.nv.should  == 1
-    @first_child.dv.should  == 1
-    @first_child.snv.should == 2
-    @first_child.sdv.should == 1
-    @first_child.number.should == Float(@first_child.nv)/Float(@first_child.dv)
-  end
-
-  it "should verify the parent values of the first child" do
-    parent = @first_child.parent
-    child = @first_child
-    parent.should == child.parent
-  end
-
-  it "should verify the parent values of a child of the first child" do
-    parent = @first_child
-    child = @first_child.child_from_position(5)
-    parent.should == child.parent
-  end
-
-  it "should get the child values from a given position" do
-    fifth_child = @root.child_from_position(5)
-    fifth_child.nv.should  == 5
-    fifth_child.dv.should  == 1
-    fifth_child.snv.should == 6
-    fifth_child.sdv.should == 1
-    fifth_child.number.should == Float(fifth_child.nv)/Float(fifth_child.dv)
-  end
-
-  it "should get the next sibling from first child" do
-    next_sibling = @first_child.next_sibling
-    next_sibling.nv.should  == 2
-    next_sibling.dv.should  == 1
-    next_sibling.snv.should == 3
-    next_sibling.sdv.should == 1
-    next_sibling.number.should == Float(next_sibling.nv)/Float(next_sibling.dv)
-  end
-
-  it "should get fifth sibling from first child" do
-    fifth_sibling = @first_child.sibling_from_position(5)
-    fifth_sibling.nv.should  == 5
-    fifth_sibling.dv.should  == 1
-    fifth_sibling.snv.should == 6
-    fifth_sibling.sdv.should == 1
-    fifth_sibling.number.should == Float(fifth_sibling.nv)/Float(fifth_sibling.dv)
-  end
-
-  it "should verify two children of the first child" do
-    child_1_1 = @first_child.child_from_position(1)
-    child_1_1.nv.should  == 3
-    child_1_1.dv.should  == 2
-    child_1_1.snv.should == 5
-    child_1_1.sdv.should == 3
-    child_1_1.number.should == Float(child_1_1.nv)/Float(child_1_1.dv)
-
-    child_1_3 = @first_child.child_from_position(3)
-
-    child_1_3.nv.should  == 7
-    child_1_3.dv.should  == 4
-    child_1_3.snv.should == 9
-    child_1_3.sdv.should == 5
-    child_1_3.number.should == Float(child_1_3.nv)/Float(child_1_3.dv)
-  end
-
-  it "should verify the position of three rational numbers" do
-    child_1_1 = @first_child.child_from_position(1)
-    child_1_1.position.should == 1
-    child_1_3 = @first_child.child_from_position(3)
-    child_1_3.position.should == 3
-    fifth_child = @root.child_from_position(5)
-    fifth_child.position.should == 5
-  end
-
-  it "should verify comparison of rational numbers" do
-    child_1   = @first_child
-    child_1_1 = @first_child.child_from_position(1)
-    child_1_3 = @first_child.child_from_position(3)
-    child_2   = @first_child.next_sibling
-
-    child_1.should   < child_1_1
-    child_1_1.should < child_1_3
-    child_1_3.should < child_2
-    child_2.should   > child_1
-    child_2.should   > child_1_1
-    child_2.should   > child_1_3
-    child_1_1.should == child_1_1
-  end
-
-  it "should set values directoy" do
-    a = RationalNumber.new
-    b = @first_child.child_from_position(3)
-    a.set_from_other(b)
-    b.should == a
-  end
-
-  it "should set values from other RationalNumber" do
-    a = RationalNumber.new
-    b = @first_child.child_from_position(3)
-    a.set_values(b.nv,b.dv,b.snv,b.sdv)
-    b.should == a
-  end
-
-  it "should check if the RationalNumber resonds to being a child of an given parent" do
-    child_1_4 = @first_child.child_from_position(4)
-    @first_child.is_child_of?(@root).should     == true
-    child_1_4.is_child_of?(@root).should        == false
-    child_1_4.is_child_of?(@first_child).should == true
-    child_1_4.is_child_of?(child_1_4).should    == false # should return false for same object
-  end
-
-  it "should check if the RationalNumber responds to being a parent of a given child" do
-    child_1_4 = @first_child.child_from_position(4)
-    @root.is_parent_of?(@first_child).should     == true
-    @root.is_parent_of?(child_1_4).should        == false
-    @first_child.is_parent_of?(child_1_4).should == true
-    child_1_4.is_parent_of?(child_1_4).should    == false # should return false for same object
-  end
-
-  it "should respons if the RationalNumber is a descendant of given parent" do
-    child_1_4   = @first_child.child_from_position(4)
-    child_1_4_9 = child_1_4.child_from_position(9)
-    child_1_4_9.is_descendant_of?(@root).should        == true
-    child_1_4_9.is_descendant_of?(@first_child).should == true
-    child_1_4_9.is_descendant_of?(child_1_4).should    == true
-
-    child_1_4.is_descendant_of?(@root).should          == true
-    child_1_4.is_descendant_of?(@first_child).should   == true
-    child_1_4.is_descendant_of?(child_1_4_9).should    == false
-
-    @first_child.is_descendant_of?(@root).should       == true
-    @first_child.is_descendant_of?(child_1_4).should   == false
-
-    @root.is_descendant_of?(@root).should               == false
-    @first_child.is_descendant_of?(@first_child).should == false
-    @root.is_descendant_of?(child_1_4_9).should         == false
-  end
-
-end
+
+  describe "when initializing"  do
+    describe "using 0 options" do
+      it "should initialize properly" do
+        a = RationalNumber.new
+        a.nv.should == 0
+        a.dv.should == 1
+        a.snv.should == 1
+        a.sdv.should == 0
+      end
+    end
+
+    describe "using 1 option" do
+      it "should initialize with a single RationalNumber as argument" do
+        a = RationalNumber.new
+        a.set_values(5,2,8,3)
+        b = RationalNumber.new(a)
+        b.nv.should == a.nv
+        b.dv.should == a.dv
+        b.snv.should == a.snv
+        b.sdv.should == a.sdv
+      end
+
+      it "should raise an error if rational_number option has the wrong type/data" do
+        expect {RationalNumber.new(4)}.to raise_error(ArgumentError)
+      end
+    end # describe 1 option
+
+    describe "using 2 options" do
+      it "should initialize with nv and dv values" do
+        a = RationalNumber.new(5, 2)
+        a.nv.should == 5
+        a.dv.should == 2
+        a.snv.should == 8
+        a.sdv.should == 3
+      end
+
+      it "should raise an error if rational_number option has the wrong type/data" do
+        expect {RationalNumber.new("cow", 2)}.to raise_error(ArgumentError)
+      end
+    end # describe 2 options
+
+    describe "using 4 options" do
+      it "should initialize with nv, dv, snv and sdv values" do
+        a = RationalNumber.new(5, 2, 8, 3)
+        a.nv.should == 5
+        a.dv.should == 2
+        a.snv.should == 8
+        a.sdv.should == 3
+      end
+
+      it "should raise an error if rational_number option has the wrong type/data" do
+        expect {RationalNumber.new(5, 2, 5, "cow" )}.to raise_error(ArgumentError)
+      end
+    end # describe 4 options
+  end # describe when initializing
+
+  describe "when using" do
+
+    before(:each) do
+      @root = RationalNumber.new
+      @first_child = @root.child_from_position(1)
+    end
+
+    it "should verify that @root is @root" do
+      @root.root?.should == true
+    end
+
+    it "should raise an error when trying to get parent rational number on @root" do
+      expect {@root.parent}.to raise_error(NoParentRationalNumberIsRootError)
+    end
+
+    it "should raise an error when trying to get a sibling on @root" do
+      expect {@root.next_sibling}.to raise_error(RationalNumberIsRootNoSiblingsError)
+      expect {@root.sibling_from_position(0)}.to raise_error(RationalNumberIsRootNoSiblingsError)
+    end
+
+    it "should verify values" do
+      @root.nv.should ==  0
+      @root.dv.should ==  1
+      @root.snv.should == 1
+      @root.sdv.should == 0
+      @root.number.should == Float(0)
+    end
+
+    it "should create a 0 based rational number without getting div by zero" do
+      test = RationalNumber.new(0,0,0,0)
+      test.number.should == Float(0)
+    end
+
+    it "should get the first child values" do
+      @first_child.nv.should  == 1
+      @first_child.dv.should  == 1
+      @first_child.snv.should == 2
+      @first_child.sdv.should == 1
+      @first_child.number.should == Float(@first_child.nv)/Float(@first_child.dv)
+    end
+
+    it "should verify the parent values of the first child" do
+      parent = @first_child.parent
+      child = @first_child
+      parent.should == child.parent
+    end
+
+    it "should verify the parent values of a child of the first child" do
+      parent = @first_child
+      child = @first_child.child_from_position(5)
+      parent.should == child.parent
+    end
+
+    it "should get the child values from a given position" do
+      fifth_child = @root.child_from_position(5)
+      fifth_child.nv.should  == 5
+      fifth_child.dv.should  == 1
+      fifth_child.snv.should == 6
+      fifth_child.sdv.should == 1
+      fifth_child.number.should == Float(fifth_child.nv)/Float(fifth_child.dv)
+    end
+
+    it "should get the next sibling from first child" do
+      next_sibling = @first_child.next_sibling
+      next_sibling.nv.should  == 2
+      next_sibling.dv.should  == 1
+      next_sibling.snv.should == 3
+      next_sibling.sdv.should == 1
+      next_sibling.number.should == Float(next_sibling.nv)/Float(next_sibling.dv)
+    end
+
+    it "should get fifth sibling from first child" do
+      fifth_sibling = @first_child.sibling_from_position(5)
+      fifth_sibling.nv.should  == 5
+      fifth_sibling.dv.should  == 1
+      fifth_sibling.snv.should == 6
+      fifth_sibling.sdv.should == 1
+      fifth_sibling.number.should == Float(fifth_sibling.nv)/Float(fifth_sibling.dv)
+    end
+
+    it "should verify two children of the first child" do
+      child_1_1 = @first_child.child_from_position(1)
+      child_1_1.nv.should  == 3
+      child_1_1.dv.should  == 2
+      child_1_1.snv.should == 5
+      child_1_1.sdv.should == 3
+      child_1_1.number.should == Float(child_1_1.nv)/Float(child_1_1.dv)
+
+      child_1_3 = @first_child.child_from_position(3)
+
+      child_1_3.nv.should  == 7
+      child_1_3.dv.should  == 4
+      child_1_3.snv.should == 9
+      child_1_3.sdv.should == 5
+      child_1_3.number.should == Float(child_1_3.nv)/Float(child_1_3.dv)
+    end
+
+    it "should verify the position of three rational numbers" do
+      child_1_1 = @first_child.child_from_position(1)
+      child_1_1.position.should == 1
+      child_1_3 = @first_child.child_from_position(3)
+      child_1_3.position.should == 3
+      fifth_child = @root.child_from_position(5)
+      fifth_child.position.should == 5
+    end
+
+    it "should verify comparison of rational numbers" do
+      child_1   = @first_child
+      child_1_1 = @first_child.child_from_position(1)
+      child_1_3 = @first_child.child_from_position(3)
+      child_2   = @first_child.next_sibling
+
+      child_1.should   < child_1_1
+      child_1_1.should < child_1_3
+      child_1_3.should < child_2
+      child_2.should   > child_1
+      child_2.should   > child_1_1
+      child_2.should   > child_1_3
+      child_1_1.should == child_1_1
+      @root.should     == @root
+      child_2.should   == child_2
+      child_1_1.should_not == child_1_3
+      child_1_1.should_not == child_1
+      child_1_1.should_not == @root
+      child_1.should_not   == child_2
+
+    end
+
+    it "should set values directoy" do
+      a = RationalNumber.new
+      b = @first_child.child_from_position(3)
+      a.set_from_other(b)
+      b.should == a
+    end
+
+    it "should set values from other RationalNumber" do
+      a = RationalNumber.new
+      b = @first_child.child_from_position(3)
+      a.set_values(b.nv,b.dv,b.snv,b.sdv)
+      b.should == a
+    end
+
+    it "should check if the RationalNumber resonds to being a child of an given parent" do
+      child_1_4 = @first_child.child_from_position(4)
+      @first_child.is_child_of?(@root).should     == true
+      child_1_4.is_child_of?(@root).should        == false
+      child_1_4.is_child_of?(@first_child).should == true
+      child_1_4.is_child_of?(child_1_4).should    == false # should return false for same object
+    end
+
+    it "should check if the RationalNumber responds to being a parent of a given child" do
+      child_1_4 = @first_child.child_from_position(4)
+      @root.is_parent_of?(@first_child).should     == true
+      @root.is_parent_of?(child_1_4).should        == false
+      @first_child.is_parent_of?(child_1_4).should == true
+      child_1_4.is_parent_of?(child_1_4).should    == false # should return false for same object
+    end
+
+    it "should respons if the RationalNumber is a descendant of given parent" do
+      child_1_4   = @first_child.child_from_position(4)
+      child_1_4_9 = child_1_4.child_from_position(9)
+      child_1_4_9.is_descendant_of?(@root).should        == true
+      child_1_4_9.is_descendant_of?(@first_child).should == true
+      child_1_4_9.is_descendant_of?(child_1_4).should    == true
+
+      child_1_4.is_descendant_of?(@root).should          == true
+      child_1_4.is_descendant_of?(@first_child).should   == true
+      child_1_4.is_descendant_of?(child_1_4_9).should    == false
+
+      @first_child.is_descendant_of?(@root).should       == true
+      @first_child.is_descendant_of?(child_1_4).should   == false
+
+      @root.is_descendant_of?(@root).should               == false
+      @first_child.is_descendant_of?(@first_child).should == false
+      @root.is_descendant_of?(child_1_4_9).should         == false
+    end
+
+    it "should generate a Hash from the rational number" do
+      child_1_4   = @first_child.child_from_position(4)
+      child_1_4.to_hash.should == {
+                                    :nv => child_1_4.nv,
+                                    :dv => child_1_4.dv,
+                                    :snv => child_1_4.snv,
+                                    :sdv => child_1_4.sdv,
+                                    :number => child_1_4.number
+                                  }
+    end
+
+    it "should generate a nice printable string for debugging purposes" do
+      child_1_4   = @first_child.child_from_position(4)
+      child_1_4.to_s.should == "RationalNumber: number: #{child_1_4.number} nv: #{child_1_4.nv} dv: #{child_1_4.dv} snv: #{child_1_4.snv} sdv: #{child_1_4.sdv}"
+    end
+
+  end # describe when using
+end  #describe RationalNumber

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rational_number
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Leif Ringstad