float-formats 0.1.1 → 0.2.0

data/tasks/setup.rb

@@ -0,0 +1,279 @@
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+require 'ostruct'
+
+class OpenStruct; undef :gem; end
+
+# TODO: make my own openstruct type object that includes descriptions
+# TODO: use the descriptions to output help on the available bones options
+
+PROJ = OpenStruct.new(
+  # Project Defaults
+  :name => nil,
+  :summary => nil,
+  :description => nil,
+  :changes => nil,
+  :authors => nil,
+  :email => nil,
+  :url => "\000",
+  :version => ENV['VERSION'] || '0.0.0',
+  :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/),
+  :release_name => ENV['RELEASE'],
+
+  # System Defaults
+  :ruby_opts => %w(-w),
+  :libs => [],
+  :history_file => 'History.txt',
+  :manifest_file => 'Manifest.txt',
+  :readme_file => 'README.txt',
+
+  # Announce
+  :ann => OpenStruct.new(
+    :file => 'announcement.txt',
+    :text => nil,
+    :paragraphs => [],
+    :email => {
+      :from     => nil,
+      :to       => %w(ruby-talk@ruby-lang.org),
+      :server   => 'localhost',
+      :port     => 25,
+      :domain   => ENV['HOSTNAME'],
+      :acct     => nil,
+      :passwd   => nil,
+      :authtype => :plain
+    }
+  ),
+
+  # Gem Packaging
+  :gem => OpenStruct.new(
+    :dependencies => [],
+    :development_dependencies => [],
+    :executables => nil,
+    :extensions => FileList['ext/**/extconf.rb'],
+    :files => nil,
+    :need_tar => true,
+    :need_zip => false,
+    :extras => {}
+  ),
+
+  # File Annotations
+  :notes => OpenStruct.new(
+    :exclude => %w(^tasks/setup\.rb$),
+    :extensions => %w(.txt .rb .erb .rdoc) << '',
+    :tags => %w(FIXME OPTIMIZE TODO)
+  ),
+
+  # Rcov
+  :rcov => OpenStruct.new(
+    :dir => 'coverage',
+    :opts => %w[--sort coverage -T],
+    :threshold => 90.0,
+    :threshold_exact => false
+  ),
+
+  # Rdoc
+  :rdoc => OpenStruct.new(
+    :opts => [],
+    :include => %w(^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$),
+    :exclude => %w(extconf\.rb$),
+    :main => nil,
+    :dir => 'doc',
+    :remote_dir => nil
+  ),
+
+  # Rubyforge
+  :rubyforge => OpenStruct.new(
+    :name => "\000"
+  ),
+
+  # Rspec
+  :spec => OpenStruct.new(
+    :files => FileList['spec/**/*_spec.rb'],
+    :opts => []
+  ),
+
+  # Subversion Repository
+  :svn => OpenStruct.new(
+    :root => nil,
+    :path => '',
+    :trunk => 'trunk',
+    :tags => 'tags',
+    :branches => 'branches'
+  ),
+
+  # Test::Unit
+  :test => OpenStruct.new(
+    :files => FileList['test/**/test_*.rb'],
+    :file  => 'test/all.rb',
+    :opts  => []
+  )
+)
+
+# Load the other rake files in the tasks folder
+tasks_dir = File.expand_path(File.dirname(__FILE__))
+post_load_fn = File.join(tasks_dir, 'post_load.rake')
+rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
+import(*rakefiles)
+
+# Setup the project libraries
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+# Setup some constants
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
+
+DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+
+def quiet( &block )
+  io = [STDOUT.dup, STDERR.dup]
+  STDOUT.reopen DEV_NULL
+  STDERR.reopen DEV_NULL
+  block.call
+ensure
+  STDOUT.reopen io.first
+  STDERR.reopen io.last
+  $stdout, $stderr = STDOUT, STDERR
+end
+
+DIFF = if WIN32 then 'diff.exe'
+       else
+         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
+         else 'diff' end
+       end unless defined? DIFF
+
+SUDO = if WIN32 then ''
+       else
+         if quiet {system 'which sudo'} then 'sudo'
+         else '' end
+       end
+
+RCOV = WIN32 ? 'rcov.bat' : 'rcov'
+RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
+GEM  = WIN32 ? 'gem.bat'  : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
+  end
+end
+HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
+            system("svn --version 2>&1 > #{DEV_NULL}"))
+HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
+            system("git --version 2>&1 > #{DEV_NULL}"))
+
+# Add bones as a development dependency
+#
+if HAVE_BONES
+  PROJ.gem.development_dependencies << ['bones', ">= #{Bones::VERSION}"]
+end
+
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+  spec = Gem.source_index.find_name(name).last
+  version = spec.version.to_s if version.nil? and !spec.nil?
+
+  PROJ.gem.dependencies << case version
+    when nil; [name]
+    when %r/^\d/; [name, ">= #{version}"]
+    else [name, version] end
+end
+
+# Adds the given arguments to the include path if they are not already there
+#
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
+end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+  Array(names).each do |task_name|
+    task = Rake.application.tasks.find {|t| t.name == task_name}
+    next if task.nil?
+    task.instance_variable_set :@comment, nil
+  end
+end
+
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
+# Scans the current working directory and creates a list of files that are
+# candidates to be in the manifest.
+#
+def manifest_files
+  files = []
+  exclude = Regexp.new(PROJ.exclude.join('|'))
+  Find.find '.' do |path|
+    path.sub! %r/^(\.\/|\/)/o, ''
+    next unless test ?f, path
+    next if path =~ exclude
+    files << path
+  end
+  files.sort!
+end
+
+# We need a "valid" method thtat determines if a string is suitable for use
+# in the gem specification.
+#
+class Object
+  def valid?
+    return !(self.empty? or self == "\000") if self.respond_to?(:to_str)
+    return false
+  end
+end
+
+# EOF

data/tasks/spec.rake

@@ -0,0 +1,54 @@
+
+if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+
+  desc 'Run all specs with basic output'
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  desc 'Run all specs with text output'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts + ['--format', 'specdoc']
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  if HAVE_RCOV
+    desc 'Run all specs with RCov'
+    Spec::Rake::SpecTask.new(:rcov) do |t|
+      t.ruby_opts = PROJ.ruby_opts
+      t.spec_opts = PROJ.spec.opts
+      t.spec_files = PROJ.spec.files
+      t.libs += PROJ.libs
+      t.rcov = true
+      t.rcov_dir = PROJ.rcov.dir
+      t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
+    end
+
+    RCov::VerifyTask.new(:verify) do |t| 
+      t.threshold = PROJ.rcov.threshold
+      t.index_html = File.join(PROJ.rcov.dir, 'index.html')
+      t.require_exact_threshold = PROJ.rcov.threshold_exact
+    end
+
+    task :verify => :rcov
+    remove_desc_for_task %w(spec:clobber_rcov)
+  end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+end  # if HAVE_SPEC_RAKE_SPECTASK
+
+# EOF

data/tasks/svn.rake

@@ -0,0 +1,47 @@
+
+if HAVE_SVN
+
+unless PROJ.svn.root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn.root = (m.nil? ? '' : m[1])
+end
+PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
+
+namespace :svn do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags => 'svn:prereqs' do |t|
+    tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
+    tags.gsub!(%r/\/$/, '')
+    tags = tags.split("\n").sort {|a,b| b <=> a}
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag => 'svn:prereqs' do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+    svn = PROJ.svn
+    trunk = File.join(svn.root, svn.trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(svn.root, svn.tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn.path
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,40 @@
+
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                   else PROJ.test.files end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test.opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
+      opts = opts.join(' ')
+      files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+              else PROJ.test.files end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+end
+
+# EOF

data/test/gen_test_data.rb

@@ -1,119 +1,119 @@
-require File.dirname(__FILE__) + '/../lib/float-formats'
-require 'yaml'
-
-include FltPnt
-include Nio
-
-
-TVALUES = [
-  '+0', '-0', '+1','-1','+0.1','-0.1',
-  '0.5','-0.5',
-  '29.2','-29.2','0.03125','-0.03125','-0.3125',
-  '1.234E2','-1.234E-6','65536.0','-65536.0',
-  '-7.50'
-]
-
-VALUES = [
-  Rational(1,3),
-  Rational(1,10),
-  Rational(2,3),
-  Rational(1,1024),
-  Rational(1,1000),
-  Rational(1024,1),
-  Rational(1024,1)
-]
-
-TEST_DATA = {}
-
-def is_power_of_two(n)
-  nbits = 0
-  while n>0
-    nbits += 1 if n&1==1
-    n >>= 1
-  end
-  nbits==1
-end
-
-EXCEPTIONS = {
-  UNIVAC_DOUBLE=>16,
-  UNIVAC_SINGLE=>16,
-  SATURN_X=>16
-}
-def rep_mode(type)
-  m = EXCEPTIONS[type]
-  if m.nil?
-    if type.total_bits % 8 == 0 # is_power_of_two(flt.total_bits)
-      m = :bytes
-    elsif type.total_bits % 4 == 0
-      m  = 16
-    elsif type.total_bits % 3 == 0
-      m  = 8
-    else
-      m  = 2
-    end
-  end
-  m
-end
-
-%w{IEEE_SINGLE IEEE_DOUBLE IEEE_EXTENDED IEEE_128 XS128 XS256 XS256_DOUBLE
-BORLAND48
-MBF_SINGLE MBF_DOUBLE 
-VAX_F VAX_D VAX_G VAX_H
-PDP11_F PDP11_D
-SATURN SATURN_X HP_CLASSIC
-IEEE_DEC32 IEEE_DEC64 IEEE_DEC128
-IBM32 IBM64 IBM128
-CRAY
-UNIVAC_SINGLE UNIVAC_DOUBLE
-CDC_SINGLE CDC_DOUBLE
-APPLE
-WANG2200
-C51_BCD_FLOAT C51_BCD_DOUBLE C51_BCD_LONG_DOUBLE
-}.each do |t|
-  
-  puts t
-  flt = eval(t)
-  
-  base = rep_mode(flt)
-  TEST_DATA[t] = {'base'=>base}
-
-print "."
-
-  TEST_DATA[t]['parameters'] = []
-  for attrb in [:total_bits, :radix, :significand_digits, :radix_min_exp, :radix_max_exp,
-   :decimal_digits_stored, :decimal_digits_necessary,:decimal_min_exp,:decimal_max_exp]
-    TEST_DATA[t]['parameters'] << {attrb.to_s=>flt.send(attrb)}
-  end
-  
-print "."
-  TEST_DATA[t]['numerals'] = []
-  fmt = Fmt.mode(:gen,flt.decimal_digits_necessary)
-  #fmt = Fmt.default
-  for v in TVALUES + [:min_normalized_value, :max_value, :epsilon, :strict_epsilon].collect{|s| flt.to_fmt(flt.send(s),fmt)}
-    val = flt.from_fmt(v)
-    rep = base==:bytes ? flt.to_hex(val,true) : flt.to_bits_text(val,base).upcase
-    TEST_DATA[t]['numerals'] << {v => rep}
-  end
-
-print "."
-  TEST_DATA[t]['special'] = []
-    [:min_value, :min_normalized_value, :max_value, :epsilon, :strict_epsilon].each do |v|
-      val = flt.send(v)
-      rep = base==:bytes ? flt.to_hex(val,true) : flt.to_bits_text(val,base).upcase      
-      TEST_DATA[t]['special'] << {v.to_s=>rep}
-    end
-
-print "."
-  TEST_DATA[t]['values'] = []  
-  for v in VALUES
-      val = flt.from_number(v)
-      rep = base==:bytes ? flt.to_hex(val,true) : flt.to_bits_text(val,base).upcase      
-      TEST_DATA[t]['values'] << {v.inspect=>rep}
-  end
-puts ""
-
-
-end  
-  
-File.open(File.join(File.dirname(__FILE__),"test_data0.yaml"),"w"){|f| f.write TEST_DATA.to_yaml}
-  
+require File.dirname(__FILE__) + '/../lib/float-formats'
+require 'yaml'
+
+include Flt
+include Nio
+
+
+TVALUES = [
+  '+0', '-0', '+1','-1','+0.1','-0.1',
+  '0.5','-0.5',
+  '29.2','-29.2','0.03125','-0.03125','-0.3125',
+  '1.234E2','-1.234E-6','65536.0','-65536.0',
+  '-7.50'
+]
+
+VALUES = [
+  Rational(1,3),
+  Rational(1,10),
+  Rational(2,3),
+  Rational(1,1024),
+  Rational(1,1000),
+  Rational(1024,1),
+  Rational(1024,1)
+]
+
+TEST_DATA = {}
+
+def is_power_of_two(n)
+  nbits = 0
+  while n>0
+    nbits += 1 if n&1==1
+    n >>= 1
+  end
+  nbits==1
+end
+
+EXCEPTIONS = {
+  UNIVAC_DOUBLE=>16,
+  UNIVAC_SINGLE=>16,
+  SATURN_X=>16
+}
+def rep_mode(type)
+  m = EXCEPTIONS[type]
+  if m.nil?
+    if type.total_bits % 8 == 0 # is_power_of_two(flt.total_bits)
+      m = :bytes
+    elsif type.total_bits % 4 == 0
+      m  = 16
+    elsif type.total_bits % 3 == 0
+      m  = 8
+    else
+      m  = 2
+    end
+  end
+  m
+end
+
+%w{IEEE_SINGLE IEEE_DOUBLE IEEE_EXTENDED IEEE_128 XS128 XS256 XS256_DOUBLE
+BORLAND48
+MBF_SINGLE MBF_DOUBLE 
+VAX_F VAX_D VAX_G VAX_H
+PDP11_F PDP11_D
+SATURN SATURN_X HP_CLASSIC
+IEEE_DEC32 IEEE_DEC64 IEEE_DEC128
+IBM32 IBM64 IBM128
+CRAY
+UNIVAC_SINGLE UNIVAC_DOUBLE
+CDC_SINGLE CDC_DOUBLE
+APPLE
+WANG2200
+C51_BCD_FLOAT C51_BCD_DOUBLE C51_BCD_LONG_DOUBLE
+}.each do |t|
+  
+  puts t
+  flt = eval(t)
+  
+  base = rep_mode(flt)
+  TEST_DATA[t] = {'base'=>base}
+
+print "."
+
+  TEST_DATA[t]['parameters'] = []
+  for attrb in [:total_bits, :radix, :significand_digits, :radix_min_exp, :radix_max_exp,
+   :decimal_digits_stored, :decimal_digits_necessary,:decimal_min_exp,:decimal_max_exp]
+    TEST_DATA[t]['parameters'] << {attrb.to_s=>flt.send(attrb)}
+  end
+  
+print "."
+  TEST_DATA[t]['numerals'] = []
+  fmt = Fmt.mode(:gen,flt.decimal_digits_necessary)
+  #fmt = Fmt.default
+  for v in TVALUES + [:min_normalized_value, :max_value, :epsilon, :strict_epsilon].collect{|s| flt.to_fmt(flt.send(s),fmt)}
+    val = flt.from_fmt(v)
+    rep = base==:bytes ? flt.to_hex(val,true) : flt.to_bits_text(val,base).upcase
+    TEST_DATA[t]['numerals'] << {v => rep}
+  end
+
+print "."
+  TEST_DATA[t]['special'] = []
+    [:min_value, :min_normalized_value, :max_value, :epsilon, :strict_epsilon].each do |v|
+      val = flt.send(v)
+      rep = base==:bytes ? flt.to_hex(val,true) : flt.to_bits_text(val,base).upcase      
+      TEST_DATA[t]['special'] << {v.to_s=>rep}
+    end
+
+print "."
+  TEST_DATA[t]['values'] = []  
+  for v in VALUES
+      val = flt.from_number(v)
+      rep = base==:bytes ? flt.to_hex(val,true) : flt.to_bits_text(val,base).upcase      
+      TEST_DATA[t]['values'] << {v.inspect=>rep}
+  end
+puts ""
+
+
+end  
+  
+File.open(File.join(File.dirname(__FILE__),"test_data0.yaml"),"w"){|f| f.write TEST_DATA.to_yaml}
+