dimensional 0.1.1 → 1.0.0

data/CHANGELOG

@@ -1,2 +1,3 @@
 0.1.0
-0.1.1	Simpler conversion system-to-system and redefinition of preference semantics.
+0.1.1	Simpler conversion system-to-system and redefinition of preference semantics.
+0.1.2	Cleanup tests to work with gem check -t

data/Rakefile

@@ -1,11 +1,32 @@
+require 'rubygems'
 require 'rake'
 require 'rake/testtask'
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'rubygems'
+require 'jeweler'
 require 'lib/dimensional/version'
 
-task :default => [:test]
+spec = Gem::Specification.new do |spec|
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  spec.platform = Gem::Platform::RUBY
+  spec.name = %q{dimensional}
+  spec.version = Dimensional::VERSION
+  spec.required_ruby_version = '>= 1.6.8'
+  spec.date = Time.now.strftime("%Y-%m-%d")
+  spec.authors = ["Chris Hapgood"]
+  spec.email = %q{cch1@hapgoods.com}
+  spec.summary = %q{Dimensional provides handling for numbers with units.}
+  spec.homepage = %q{http://cho.hapgoods.com/dimensional}
+  spec.description = <<-EOF
+    Dimensional provides handling for dimensional values (numbers with units).  Dimensional values
+    can be parsed, stored, converted and formatted for output.
+  EOF
+  spec.files = Dir['lib/**/*.rb'] + Dir['test/**/*.rb']
+  spec.files += ["README", "CHANGELOG", "LICENSE", "Rakefile", "test/helper.rb"]
+  spec.test_files = ["test/helper.rb"] + Dir['test/**/*_test.rb']
+end
+
+Jeweler::Tasks.new(spec)
+Jeweler::GemcutterTasks.new
 
 Rake::TestTask.new do |t|
   t.libs << 'test'
@@ -14,26 +35,14 @@ Rake::TestTask.new do |t|
 end
 Rake::Task['test'].comment = "Run all tests in test/*_test.rb"
 
-spec = Gem::Specification.new do |s|
-  s.platform = Gem::Platform::RUBY
-  s.name = %q{dimensional}
-  s.version = Dimensional::VERSION
-  s.required_ruby_version = '>= 1.6.8'
-  s.date = Time.now.strftime("%Y-%m-%d")
-  s.authors = ["Chris Hapgood"]
-  s.email = %q{cch1@hapgoods.com}
-  s.summary = %q{Dimensional provides handling for numbers with units.}
-  s.homepage = %q{http://cho.hapgoods.com/dimensional}
-  s.description = <<-EOF
-    Dimensional provides handling for dimensional values (numbers with units).  Dimensional values
-    can be parsed, stored, converted and formatted for output.
-  EOF
-  s.files = Dir['lib/**/*.rb'] + Dir['test/**/*.rb']
-  s.files += ["README", "CHANGELOG", "LICENSE", "Rakefile"]
-  s.test_files = Dir['test/**/*.rb']
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tttt #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-    pkg.need_zip = true
-    pkg.need_tar = false
-end
+task :test => :check_dependencies
+task :default => :test

data/lib/dimensional/version.rb

@@ -1,3 +1,3 @@
 module Dimensional
-  VERSION = "0.1.1"
+  VERSION = "1.0.0"
 end

data/test/configurator_test.rb

@@ -1,4 +1,4 @@
-require 'test/unit'
+require 'helper'
 require 'dimensional/configurator'
 
 class ConfiguratorTest < Test::Unit::TestCase

data/test/dimension_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'dimensional/dimension'
+require 'helper'
 
 class DimensionTest < Test::Unit::TestCase
   include Dimensional

data/test/dimensional_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'dimensional'
+require 'helper'
 
 class DimensionalTest < Test::Unit::TestCase
   include Dimensional

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'dimensional'
+
+class Test::Unit::TestCase
+end

data/test/metric_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'dimensional/metric'
+require 'helper'
 require 'rational'
 
 class MetricTest < Test::Unit::TestCase

data/test/system_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'dimensional/system'
+require 'helper'
 
 class SystemTest < Test::Unit::TestCase
   include Dimensional

data/test/unit_test.rb

@@ -1,5 +1,4 @@
-require 'test/unit'
-require 'dimensional/unit'
+require 'helper'
 
 class UnitTest < Test::Unit::TestCase
   include Dimensional

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dimensional
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors: 
 - Chris Hapgood
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-05 00:00:00 -05:00
+date: 2010-02-06 00:00:00 -05:00
 default_executable: 
 dependencies: []
 
@@ -19,36 +19,36 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README
 files: 
-- lib/dimensional/configuration.rb
+- CHANGELOG
+- LICENSE
+- README
+- Rakefile
+- lib/dimensional.rb
 - lib/dimensional/configurator.rb
 - lib/dimensional/dimension.rb
 - lib/dimensional/metric.rb
 - lib/dimensional/system.rb
 - lib/dimensional/unit.rb
 - lib/dimensional/version.rb
-- lib/dimensional.rb
-- test/configuration_test.rb
 - test/configurator_test.rb
 - test/demo.rb
 - test/dimension_test.rb
 - test/dimensional_test.rb
+- test/helper.rb
 - test/metric_test.rb
 - test/system_test.rb
 - test/unit_test.rb
-- README
-- CHANGELOG
-- LICENSE
-- Rakefile
 has_rdoc: true
 homepage: http://cho.hapgoods.com/dimensional
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -71,9 +71,8 @@ signing_key:
 specification_version: 3
 summary: Dimensional provides handling for numbers with units.
 test_files: 
-- test/configuration_test.rb
+- test/helper.rb
 - test/configurator_test.rb
-- test/demo.rb
 - test/dimension_test.rb
 - test/dimensional_test.rb
 - test/metric_test.rb

data/lib/dimensional/configuration.rb

@@ -1,121 +0,0 @@
-require 'dimensional/dimension'
-require 'dimensional/system'
-require 'dimensional/unit'
-require 'dimensional/metric'
-require 'forwardable'
-
-# Encapsulates the application-specific configuration of Dimensional elements, including
-#   * Dimensions
-#   * Systems, including a prioritized array of Systems to be consulted during parsing.
-#   * Metrics, including associated Unit formatting and parsing options
-#   * Units
-# Configurations can be constructed with a Configurator.  They can also be copied and extended.
-#
-# Metric == context
-#
-# Configuration#options(unit, context) => options_hash
-#   a hash of formatting and parsing options for the given unit in the given context
-
-# Configuration#format(unit, context = nil) => format_string
-#   #strfmeasure-compatible format string for given unit and given context
-
-# Configuration#detectors(context = nil) => detector_hash
-#   Measure#parse-compatible detector->unit pairs suitable for given context
-
-# Measure.parse(str, detectors) => measure
-#    instance of measure with unit matched by detectors
-
-# Measure.new(value, unit, context) => measure
-#    instance of measure with given value and unit, and with the given context.
-
-# Measure#strfmeasure(format) => str
-#   formatted string representing the given measure
-
-# Measure#change_system(system) => measure
-#   a
-
-# Create a Measure from a Numeric and Unit, optionally for a given Metric (load attribute from DB)
-# Create a Measure from a String for a given Metric with a preferred System (parse form input)
-# Convert a Measure from a given Unit to the most appropriate Unit in a given System
-# Format a Measure as a String given a specific format String
-
-class Configuration
-  # A (unordered and unique) set of dimensions with generous lookup semantics
-  # TODO: Prevent a composite dimension from being added unless its fundamentals are already included
-  class Dimensions < Set
-    def [](str)
-      raise unless str
-      detect{|d| d.name == str.to_s || d.symbol == str.to_s} 
-    end
-  end
-
-  # An ordered and unique collection of systems with generous lookup semantics and re-orderability.  Order
-  # is not defined prior to invoking #priortize.
-  class Systems < DelegateClass(Set)
-    include Enumerable
-    attr_reader :priority
-    
-    def initialize(*args)
-      @priority = []
-      super(args)
-    end
-
-    # Prioritize the system according to the given array of lookup keys
-    def prioritize(keys)
-      new = keys.map{|k| self[k]}.uniq.compact
-      priority.replace(new)
-    end
-    
-    # Iteration is in priority order.  We directly access the delegate object so that enumerable
-    # methods needed here don't recurse (#each being called from a mixin apparently triggers this behavior) 
-    def each(&block)
-      @_dc_obj.sort_by{|s| priority.index(s) || priority.size}.each(&block)
-    end
-
-    def [](str)
-      detect {|s| (s == str.to_s) || (s.abbreviation == str.to_s) } 
-    end
-  end
-
-  attr_reader :dimensions, :systems, :metrics
-  
-  include Enumerable
-  extend Forwardable
-
-  def initialize
-    @dimensions = Dimensions.new
-    @systems = Systems.new
-    @units = Set.new
-  end
-  
-  def_delegators :@units, :each
-  def_delegators :to_set, :size, :length, :empty?
-
-  def add(u)
-    systems << u.system
-    # TODO: Add fundamental dimensions before adding composite dimension
-    dimensions << u.dimension
-    @units << u
-  end
-  alias << add
-  
-  def [](dim, sys, str)
-    us = select{|u| u.dimension == dim && u.system == sys}
-    us.detect{|u| str == u.name || (u.abbreviation && str == u.abbreviation)}
-  end
-
-  # Returns a new configuration with only the units with the specified dimension
-  def dimension(d)
-    scope(@units.select{|u| u.dimension == d})
-  end
-  
-  private
-  # Returns a new configuration scoped to the supplied units
-  def scope(us)
-    config = self.dup
-    config.instance_eval do
-      @units = us
-    end
-    config
-  end
-end

data/test/configuration_test.rb

@@ -1,217 +0,0 @@
-require 'test/unit'
-require 'dimensional/configuration'
-
-class ConfigurationTest < Test::Unit::TestCase
-  include Dimensional
-
-  def setup
-    @s0 = System.new('International System', 'SI', "International System (kg, m)")
-    @s1 = System.new('United States Customary', 'US', "US Customary (ft, lbs)")
-    @dL = Dimension.new('Length')
-    @dM = Dimension.new('Mass')
-    @um = Unit.new('meter', @s0, @dL)
-    @ug = Unit.new('gram', @s0, @dM)
-#    System.register('British Admiralty', 'BA')
-#    Dimension.register('Area', 'A', {Dimension::L => 2})
-  end
-
-  def test_create_configuration
-    assert_instance_of Configuration, c = Configuration.new
-    assert c.dimensions.empty?
-    assert c.systems.empty?
-    assert c.empty?
-  end
-  
-  def test_add_dimension
-    c = Configuration.new
-    assert c.dimensions << @dL
-    assert_same @dL, c.dimensions['Length']
-    assert_same @dL, c.dimensions['L']
-    assert_same @dL, c.dimensions[:L]
-  end
-
-  def test_add_system
-    c = Configuration.new
-    assert c.systems << @s0
-    assert_same @s0, c.systems['SI']
-    assert_same @s0, c.systems['International System']
-    assert_same @s0, c.systems[:SI]
-  end
-
-  def test_prioritize_systems
-    c = Configuration.new
-    assert c.systems << @s0
-    assert c.systems << @s1
-    c.systems.prioritize([:US, :SI])
-    assert_equal @s1, c.systems.first
-    assert_equal [@s1, @s0], c.systems.to_a
-    c.systems.prioritize([:SI, :US])
-    assert_equal [@s0, @s1], c.systems.to_a
-  end
-
-  def test_add_unit
-    c = Configuration.new
-    assert c << @um
-    assert c.include?(@um)
-    assert c.dimensions.include?(@dL)
-    assert c.systems.include?(@s0)
-    assert_same @um, c[@dL, @s0, 'meter']
-  end
-
-  def test_scope
-    c = Configuration.new
-    c << @um
-    c << @ug
-    assert c.include?(@ug)
-    c1 = c.dimension(@dL)
-    assert c1.include?(@um)
-    assert_same @um, c1[@dL, @s0, 'meter']
-    assert !c1.include?(@ug)
-    c2 = c1.dimension(@dM)
-    assert c2.empty?
-    assert !c2.any?
-    assert c.include?(@ug)
-  end
-
-#  def test_start_configurator
-#    assert Configurator.start
-#    assert Configurator.start {true}
-#    assert !Configurator.start {false}
-#  end
-#
-#  def test_start_configurator_with_context_args
-#    assert_same Dimension::L, Configurator.start(:dimension => Dimension::L){context.dimension}
-#  end
-#
-#  def test_change_dimension_context_for_duration_of_block
-#    test_context = self
-#    Configurator.start do
-#      dimension(Dimension::L) do
-#        test_context.assert_equal Dimension::L, context.dimension
-#        true
-#      end
-#      test_context.assert_nil context.dimension
-#    end
-#  end
-#  
-#  def test_change_system_context_for_duration_of_block
-#    test_context = self
-#    Configurator.start do
-#      system(System::SI) do
-#        test_context.assert_equal System::SI, context.system
-#        true
-#      end
-#      test_context.assert_nil context.system
-#    end
-#  end
-#
-#  def test_preserve_context_within_block
-#    test_context = self
-#    Dimensional::Configurator.start do
-#      dimension(:L) do
-#        system(:SI) do
-#          base('meter') do
-#            test_context.assert uc = context.unit
-#            derive('centimeter', 'cm', 1e-2)
-#            test_context.assert_same uc, context.unit
-#          end
-#        end
-#      end
-#    end
-#  end
-#
-#  def test_build_base_unit
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm', :detector => /\A(meters?|m)\Z/)
-#    end
-#    assert_instance_of Unit, u = Unit[Dimension::L, System::SI, 'meter']
-#    assert_same System::SI, u.system
-#    assert_same Dimension::L, u.dimension
-#    assert u.base?
-#    assert_equal 'm', u.abbreviation
-#    assert_instance_of Metric, m = Metric[:L]
-#    assert m.preferences(u)[:detector]
-#  end
-#
-#  def test_build_derived_unit
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm', :detector => /\A(meters?|m)\Z/) do
-#        derive('centimeter', 'cm', 1e-2, :detector => /\A(centimeters?|cm)\Z/)
-#      end
-#    end
-#    u0 = Unit[Dimension::L, System::SI, 'meter']
-#    assert_instance_of Unit, u = Unit[Dimension::L, System::SI, 'centimeter']
-#    assert_same System::SI, u.system
-#    assert_same Dimension::L, u.dimension
-#    assert_same u0, u.base
-#    assert_equal 1E-2, u.factor
-#    assert_equal 'cm', u.abbreviation
-#  end
-#
-#  def test_build_aliased_unit
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm', :detector => /\A(meters?|m)\Z/) do
-#        self.alias('decadecimeter')
-#      end
-#    end
-#    u0 = Unit[Dimension::L, System::SI, 'meter']
-#    assert_instance_of Unit, u = Unit[Dimension::L, System::SI, 'decadecimeter']
-#    assert_same System::SI, u.system
-#    assert_same Dimension::L, u.dimension
-#    assert_same u0, u.base
-#    assert_equal 1, u.factor
-#  end
-#
-#  def test_build_referenced_unit
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm', :detector => /\A(meters?|m)\Z/)
-#      system(:US) do
-#        reference('yard', 'yd', Unit[:L, :SI, 'meter'], 0.9144, :detector => /\A(yards?|yds?)\Z/)
-#      end
-#    end
-#    u0 = Unit[Dimension::L, System::SI, 'meter']
-#    assert_instance_of Unit, u = Unit[Dimension::L, System::US, 'yard']
-#    assert_equal 0.9144, u.factor
-#    assert_same u0, u.base
-#  end
-#
-#  def test_build_combined_unit
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm', :detector => /\A(meters?|m)\Z/)
-#      system(:US) do
-#        reference('yard', 'yd', Unit[:L, :SI, 'meter'], 0.9144, :detector => /\A(yards?|yds?)\Z/)
-#        dimension(:A) do
-#          combine('square yard', 'yd2', [Unit[:L, :US, 'yard'], Unit[:L, :US, 'yard']], :detector => /\A(yd|yard)2\Z/)
-#        end
-#      end
-#    end
-#    u1 = Unit[Dimension::L, System::US, 'yard']
-#    assert_instance_of Unit, u = Unit[:A, :US, 'square yard']
-#    assert_equal Dimension::A, u.dimension
-#    assert_equal 0.83612736, u.factor
-#    assert_equal [u1.base, u1.base], u.base
-#  end
-#  
-#  def test_add_default_preferences
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm')
-#    end
-#    u = Unit[Dimension::L, System::SI, 'meter']
-#    m = Metric[:L]
-#    assert d = m.preferences(u)[:detector]
-#    assert_match d, 'meter'
-#    assert f = m.preferences(u)[:format]
-#  end
-#
-#  def test_register_metric_options
-#    Configurator.start(:system => System::SI, :dimension => Dimension::L) do
-#      base('meter', 'm', :detector => /\A(meters?|m)\Z/) do
-#        prefer(:length_over_all, :precision => 0.01)
-#      end
-#    end
-#    u = Unit[:L, :SI, 'm']
-#    assert_instance_of Metric, m = Metric[:length_over_all]
-#    assert_same Metric[:L], m.parent
-#    assert_equal 0.01, m.preferences(u)[:precision]
-#  end
-end