fixed_point 0.1.1 → 0.2.0

data/HISTORY.md

@@ -1,6 +1,17 @@
 HISTORY/Changelog
 =================
 
+0.2.1
+-----
+
+ Added hex= method for setting fixed point data via hex
+
+0.2.0
+-----
+
+  Added to_s method on numbers. Output is now the same as calling .to_f.to_s
+
+
 0.1.1
 -----
 

data/Rakefile

@@ -2,10 +2,100 @@ require 'rspec/core/rake_task'
 
 file_list = FileList['spec/*_spec.rb']
 
-RSpec::Core::RakeTask.new('spec') do |t|
-  t.pattern = file_list
-  t.rspec_opts = ["--colour", "--format progress"]
+namespace :test do
+  RSpec::Core::RakeTask.new('spec') do |t|
+    t.pattern = file_list
+    t.rspec_opts = ["--colour", "--format progress"]
+  end
 end
-
 desc 'Default: run specs.'
-task :default => 'spec'
+task :default => 'test:spec'
+
+namespace :deploy do
+
+  ## name and versio taken from 
+  ## https://github.com/mojombo/rakegem
+  def name
+    @name ||= Dir['*.gemspec'].first.split('.').first
+  end
+
+  def version
+    line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+    line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+  end
+
+  #Dir.chdir( './lib/')
+  #puts require NAME
+  #Dir.chdir( './../')
+
+
+  desc 'Run Spec'
+  #file_list = FileList['spec/*_spec.rb']
+  html_path = "spec_results.html"  
+  RSpec::Core::RakeTask.new('run_spec') do |t|
+    t.pattern    = file_list
+    t.rspec_opts = ["--format html", "--out #{html_path}"]
+  end
+
+
+  desc 'Check that the spec passes'
+  task :spec_passes => :run_spec do
+    # find out how many errors were found  
+    html     = open(html_path).read  
+    examples = html.match(/(\d+) examples/)[0].to_i rescue 0  
+    failures = html.match(/(\d+) failures/)[0].to_i rescue 0  
+    pending  = html.match(/(\d+) pending/)[0].to_i rescue 0  
+
+    if failures.zero?  
+      puts "0 failures! #{examples} run, #{pending} pending"  
+    else  
+      $stderr.puts "\aSpecs did not pass deploy aborted!"  
+      $stderr.puts "View spec results at #{File.expand_path(html_path)}"  
+      $stderr.puts  
+      $stderr.puts "#{failures} failures! #{examples} run, #{pending} pending"  
+      exit -1  
+    end
+  end
+
+  task :build_gem do
+    puts "Building Gem"
+    `gem build #{name}.gemspec`
+    unless $?.success?
+        $stderr.puts "Gem Build Failed"
+        exit -1
+    end
+
+  end
+
+  task :push_gem do
+    puts "Pushing Gem #{name}-#{version}"
+    #`gem push`
+    unless $?.success?
+        $stderr.puts "Gem Push Failed"
+        exit -1
+    end    
+  end
+
+  task :create_git_tag do
+    puts "Tagging #{name}-#{version}"
+    #`git tag -a #{version} -m 'Tagging gem release #{version}'`
+    unless $?.success?
+        $stderr.puts "Tagging Git Failed"
+        exit -1
+    end    
+  end
+
+  task :push_tag do
+    puts "Push Tag #{version}"
+    #`git push origin #{version}`
+    unless $?.success?
+        $stderr.puts "Pushing Git Tag Failed"
+        exit -1
+    end    
+  end
+
+  task :gem => [:spec_passes, :build_gem, :push_gem, :create_git_tag, :push_tag] do
+    puts "Deployed #{name} Version #{version} !"
+  end
+
+end

data/lib/fixed_point.rb

@@ -1,5 +1,5 @@
 module FixedPoint
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end
 
 begin

data/lib/fixed_point/number.rb

@@ -77,6 +77,10 @@ module FixedPoint
       (@quantised - to_i)
     end
 
+    def to_s
+      to_f.to_s
+    end
+
     ####################################
     ### Calculate Binary format
     ####################################

data/spec/fixed_point_spec.rb

@@ -16,6 +16,7 @@ describe FixedPoint do
 
     fixt.source.should    == 0.0
     fixt.to_f.should      == 0.0
+    fixt.to_s.should      == "0.0"
     fixt.to_i.should      == 0
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "00000000"
@@ -28,6 +29,7 @@ it "Integers 0 " do
 
   fixt.source.should   == 7.0
   fixt.to_f.should     == 7.0
+  fixt.to_s.should     == "7.0"
   fixt.to_i.should     == 7
   fixt.frac.should     == 0.0
   fixt.to_h.should     == "07"
@@ -40,6 +42,7 @@ it "Different Decimal Mark _ instead of ." do
 
   fixt.source.should   == 0.0
   fixt.to_f.should     == 0.0
+  fixt.to_s.should     == "0.0"
   fixt.to_i.should     == 0
   fixt.frac.should     == 0.0
   fixt.to_h.should     == "00000000"
@@ -55,6 +58,7 @@ end
 
     fixt.source.should   == 0.0
     fixt.to_f.should     == 0.0
+    fixt.to_s.should     == "0.0"
     fixt.to_i.should     == 0
     fixt.frac.should     == 0.0
     #Calculate hex length and fill with 0's
@@ -76,8 +80,9 @@ it "Zero fractional bits " do
 
   fixt.source.should   == 0.0
   fixt.to_f.should     == 0.0
+  fixt.to_s.should     == "0.0"
   fixt.to_i.should     == 0
-  fixt.frac.should == 0.0
+  fixt.frac.should     == 0.0
   fixt.to_h.should     == "000"
   fixt.to_b.should     == "000000000000"
 end
@@ -88,8 +93,9 @@ it "returns 2.5 for initalise of 2.5" do
 
   fixt.source.should   == 2.5
   fixt.to_f.should     == 2.5
+  fixt.to_s.should     == "2.5"
   fixt.to_i.should     == 2
-  fixt.frac.should == 0.5
+  fixt.frac.should     == 0.5
   fixt.to_h.should     == "00280000"
   fixt.to_b.should     == "000000000010.10000000000000000000"
   end
@@ -101,8 +107,9 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should   == 2.501
     fixt.to_f.should     == 2.5
+    fixt.to_s.should     == "2.5"
     fixt.to_i.should     == 2
-    fixt.frac.should == 0.5
+    fixt.frac.should     == 0.5
     fixt.to_h.should     == "0005"
     fixt.to_b.should     == "000000000010.1"
   end
@@ -114,12 +121,13 @@ it "returns 2.5 for initalise of 2.5" do
     format = FixedPoint::Format.new(1, 4, 0)
     fixt   = FixedPoint::Number.new(2**3, format, "_")
 
-    fixt.source.should    == 2**3
-    fixt.to_f.should      == 2**3-1
-    fixt.to_i.should      == 2**3-1
-    fixt.frac.should  == 0.0
-    fixt.to_h.should      == "7"
-    fixt.to_b.should      == "0111"
+    fixt.source.should     == 2**3
+    fixt.to_f.should       == 2**3-1
+    fixt.to_s.should       == "7.0"
+    fixt.to_i.should       == 2**3-1
+    fixt.frac.should       == 0.0
+    fixt.to_h.should       == "7"
+    fixt.to_b.should       == "0111"
     fixt.overflow?.should  == true
     fixt.underflow?.should == false
   end
@@ -130,6 +138,7 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should    == 2**11
     fixt.to_f.should      == 2**11-1
+    fixt.to_s.should      == "2047.0"
     fixt.to_i.should      == 2**11-1
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "7ff"
@@ -146,6 +155,7 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should    == 2**11
     fixt.to_f.should      == 2**11 -1 + max_fractional_value
+    fixt.to_s.should      == "2047.9375"
     fixt.to_i.should      == 2**11 -1
     fixt.frac.should      == max_fractional_value
     fixt.to_h.should      == "7fff"
@@ -163,6 +173,7 @@ it "returns 2.5 for initalise of 2.5" do
     max_fractional_value = (1.0/2) + (1.0/4) + (1.0/8) + (1.0/16)
 
     fixt.to_f.should      == 2**11 -1 + max_fractional_value
+    fixt.to_s.should      == "2047.9375"
     fixt.to_i.should      == 2**11 -1
     fixt.frac.should      == max_fractional_value
     fixt.to_h.should      == "7fff"
@@ -181,6 +192,7 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should    == -2**11
     fixt.to_f.should      == -2**11
+    fixt.to_s.should      == "-2048"
     fixt.to_i.should      == -2**11
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "800"
@@ -195,6 +207,7 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should    == -2**11-1
     fixt.to_f.should      == -2**11
+    fixt.to_s.should      == "-2048"
     fixt.to_i.should      == -2**11
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "800"
@@ -209,6 +222,7 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should    == -2**11-1
     fixt.to_f.should      == -2**11
+    fixt.to_s.should      == "-2048"
     fixt.to_i.should      == -2**11
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "8000"
@@ -224,6 +238,7 @@ it "returns 2.5 for initalise of 2.5" do
 
     fixt.source.should    == -2**17
     fixt.to_f.should      == -2**11
+    fixt.to_s.should      == "-2048"
     fixt.to_i.should      == -2**11
     fixt.frac.should      == 0.0
     fixt.to_h.should      == "8000"
@@ -239,6 +254,7 @@ it "returns 2.5 for initalise of 2.5" do
     fixt.binary = "011_01"
     fixt.source.should    == 3.25
     fixt.to_f.should      == 3.25
+    fixt.to_s.should      == "3.25"
     fixt.to_i.should      == 3
     fixt.frac.should      == 0.25
     fixt.to_h.should      == "0d"
@@ -253,6 +269,7 @@ it "returns 2.5 for initalise of 2.5" do
     fixt.binary = "0_1"
     fixt.source.should    == 0.5
     fixt.to_f.should      == 0.5
+    fixt.to_s.should      == "0.5"
     fixt.to_i.should      == 0
     fixt.frac.should      == 0.5
     fixt.to_h.should      == "1"
@@ -267,6 +284,7 @@ it "returns 2.5 for initalise of 2.5" do
     fixt.binary = "1000_1"
     fixt.source.should    == -7.5
     fixt.to_f.should      == -7.5
+    fixt.to_s.should      == "-7.5"
     fixt.to_i.should      == -7
     fixt.frac.should      == -0.5
     fixt.to_h.should      == "11"
@@ -282,6 +300,7 @@ it "returns 2.5 for initalise of 2.5" do
     fixt.binary = "1000_1"
     fixt.source.should    == 8.5
     fixt.to_f.should      == 8.5
+    fixt.to_s.should      == "8.5"
     fixt.to_i.should      == 8
     fixt.frac.should      == 0.5
     fixt.to_h.should      == "11"
@@ -297,6 +316,7 @@ it "returns 2.5 for initalise of 2.5" do
     fixt.binary = "1000_1"
     fixt.source.should    == 8.5
     fixt.to_f.should      == 8.5
+    fixt.to_s.should      == "8.5"
     fixt.to_i.should      == 8
     fixt.frac.should      == 0.5
     fixt.to_h.should      == "11"

metadata

@@ -1,33 +1,22 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: fixed_point
-version: !ruby/object:Gem::Version 
-  hash: 25
+version: !ruby/object:Gem::Version
+  version: 0.2.0
   prerelease: 
-  segments: 
-  - 0
-  - 1
-  - 1
-  version: 0.1.1
 platform: ruby
-authors: 
+authors:
 - Morgan Prior
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-01-22 00:00:00 +00:00
-default_executable: 
+date: 2012-05-10 00:00:00.000000000 Z
 dependencies: []
-
 description: Fixed Point numerical type for simulating fixed point calculations
 email: fixed_point_gem@amaras-tech.co.uk
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE
 - README.md
 - HISTORY.md
@@ -40,39 +29,28 @@ files:
 - spec/fixed_point_negative_spec.rb
 - spec/fixed_point_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://amaras-tech.co.uk/software/fixed_point
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Fixed Point numerical type
 test_files: []
-