temperature 1.0 → 1.1.0

data/History.txt

@@ -0,0 +1,8 @@
+=== 1.1.0 2010-03-09
+* 1 major enhancement:
+  * Support ruby 1.9
+
+=== 1.0.0 2010-03-06
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,24 @@
+COPYING
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+config/website.yml
+lib/temperature.rb
+lib/temperature/numeric.rb
+lib/temperature/string.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+test/test_convert.rb
+test/test_dewpoint.rb
+test/test_helper.rb
+test/test_num.rb
+test/test_temperature.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on temperature, see http://temperature.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,66 @@
+= temperature
+
+* http://github.com/sdague/temperature.rb
+
+== DESCRIPTION:
+
+Temperature makes it easy to deal with temperatures in Ruby, but
+adding mixin methods to numbers and strings.  
+
+This was inspired by using Ruby to manipulate data from my home
+weather station, and wanting it to keep track of the units for me so
+that I didn't have to think about that in code.
+
+== FEATURES/PROBLEMS:
+
+* Should autodetect what units are appropriate for the locale
+
+== SYNOPSIS:
+
+  freezing_in_F = 32
+  freezing_in_C = freezing_in_F.to_C
+
+  boiling_in_C = 100
+  boiling_in_C.units = "C"
+  boiling_in_F = boiling_in_C.to_F
+
+  absolute_zero = "0K".to_degrees
+  absolute_zero_in_C = absolute_zero.to_C
+  absolute_zero_in_F = absolute_zero.to_F
+
+There is also support to calculate dewpoint from relative humidity
+based on the NOAA approximation documented here -
+http://en.wikipedia.org/wiki/Dew_point#Closer_approximation
+
+  dewpoint = 32.dewpoint(45)
+
+== REQUIREMENTS:
+
+== INSTALL:
+
+sudo gem install temperature
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 Sean Dague
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,133 +1,28 @@
-require 'rubygems' 
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'rake/clean'
-require 'rake/contrib/sshpublisher'
-
-PKG_NAME = "temperature"
-PKG_VERSION = "1.0"
-
-$VERBOSE = nil
-TEST_CHANGES_SINCE = Time.now - 600 # Recent tests = changed in last 10 minutes
-
-desc "Run all the unit tests"
-task :default => [ :test, :lines ]
-
-desc "Run the unit tests in test"
-Rake::TestTask.new(:test) { |t|
-    t.libs << "test"
-    t.test_files = FileList['test/*_test.rb']
-    t.verbose = true
-}
-
-# rcov code coverage
-rcov_path = '/usr/bin/rcov'
-rcov_test_output = "./test/coverage"
-rcov_exclude = "interactive.rb,read_write.rb,fixtures"
-
-# Add our created paths to the 'rake clobber' list
-CLOBBER.include(rcov_test_output)
-
-desc 'Removes all previous unit test coverage information'
-task (:reset_unit_test_coverage) do |t|
-  rm_rf rcov_unit_test_output
-  mkdir rcov_unit_test_output
-end
-
-desc 'Run all unit tests with Rcov to measure coverage'
-Rake::TestTask.new(:rcov) do |t|
-  t.libs << "test"
-  t.pattern = 'test/**/*_test.rb'
-  t.ruby_opts << rcov_path
-  t.ruby_opts << "-o #{rcov_test_output}"
-  t.ruby_opts << "-x #{rcov_exclude}"
-  t.verbose = true
-end
-
-# Generate the RDoc documentation
-Rake::RDocTask.new(:doc) { |rdoc|
-  rdoc.main = 'README'
-  rdoc.rdoc_files.include('lib/**/*.rb', 'README')
-  rdoc.rdoc_files.include('COPYING')
-  rdoc.rdoc_dir = 'docs/temperature'
-  rdoc.title    = "Temperature -- Temperature mixin for Numerics and Strings"
-  rdoc.options << "--include=examples --line-numbers --inline-source"
-}
-
 require 'rubygems'
-require 'rubygems/gem_runner'
-require 'rake/gempackagetask'
-
-spec = Gem::Specification.new do |s| 
-  s.name = "temperature" 
-  s.version = PKG_VERSION 
-  s.homepage = "http://github.com/sdague/temperature.rb"
-  s.platform = Gem::Platform::RUBY 
-  s.summary = "A ruby mixin for making Numerics temperatures"
-  s.description = ""
-
-  s.files = FileList["{test,lib,docs,examples}/**/*"].to_a
-  s.files += ["Rakefile", "README", "COPYING" ]
-  s.require_path = "lib" 
-  s.autorequire = "temperature"
-  s.has_rdoc = true 
-  s.extra_rdoc_files = ["README", "COPYING" ]
-  s.rdoc_options.concat ['--main', 'README']
-
-  s.author = "Sean Dague" 
-  s.email = "sean@dague.net" 
-end 
-
-Rake::GemPackageTask.new(spec) do |pkg| 
-  pkg.gem_spec = spec
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/temperature'
 
-desc "Upload Docs to RubyForge"
-task :publish_docs => [:doc] do
-    publisher = Rake::SshDirPublisher.new(
-                                          "sdague@rubyforge.org",
-                                          "/var/www/gforge-projects/sdaguegems",
-                                          "docs"
-                                          )
-    publisher.upload
-end
+ENV['VERSION'] = Temperature::VERSION
 
+Hoe.plugin :newgem
+Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
 
-desc "Publish the release files to RubyForge."
-task :release => [ :package, :publish_docs ] do
-    require 'rubyforge'
-    packages = %w( gem tgz zip ).collect{ |ext| "pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}" }
-    rubyforge = RubyForge.new
-    rubyforge.configure
-    rubyforge.login
-    rubyforge.scrape_project("sdaguegems")
-    rubyforge.add_release("sdaguegems", PKG_NAME, "v#{PKG_VERSION}", *packages)
-end
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'temperature' do
+  self.developer 'Sean Dague', 'sean@dague.net'
+  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  self.rubyforge_name       = "sdaguegems" # TODO this is default value
+  # self.extra_deps         = [['activesupport','>= 2.0.2']]
 
-desc 'Install the gem globally (requires sudo)'
-task :install => :package do |t|
-  `sudo gem install pkg/temperature-#{PKG_VERSION}.gem`
 end
 
-task :lines do
-  lines = 0
-  codelines = 0
-  Dir.foreach("lib/") { |file_name|
-    next unless file_name =~ /.*rb/
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
 
-    f = File.open("lib/" + file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-  }
-  puts "\n------------------------------\n"
-  puts "Total Lines: #{lines}"
-  puts "Lines of Code: #{codelines}"
-end
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/config/website.yml

@@ -0,0 +1,2 @@
+host: sdague@rubyforge.org
+remote_dir: /var/www/gforge-projects/sdaguegems/temperature

data/lib/temperature.rb

@@ -1,174 +1,14 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'temperature/numeric'
+require 'temperature/string'
+
 # Temperature works as a mixin on both the Numeric and String classes.
 # The idea is to make manipulating temperatures as simple and natural
 # as possible.  If units are not specified, they are assume to be in
 # degrees 'F'.  Yes, I realize this is US centric, but that's where I
 # live.  In the future I'd like to auto detect that base on locale.
-#
-# Example use:
-#
-#   freezing_in_C = 32.to_C
-#
-#   num = 0
-#   num.units = "C"
-#   freezing_in_F = num.to_F
-
-class Numeric
-    @units
-
-    # The scale factor between C and F
-    CScale = 1.8
-    # The offset between C and F
-    FOffset = 32
-    # The offset between K and C
-    KOffset = 273.15
-
-    # The degree units the temperature is in.  This defaults to "F" if
-    # not specified.  Valid values are "C", "F", or "K" (R is not
-    # currently support... no one really uses that anyway).
-    def units
-        if @units
-            return @units
-        else
-            # this should auto detect the env, but for now, I live in the US
-            return "F"
-        end
-    end
-        
-    def units=(u)
-        if u =~ /^(C|F|K)/
-            @units = u
-        end
-        return @units
-    end
-    
-    # Is this a Farenheit temperature, returns a boolean
-    def is_F?
-        return self.units == "F"
-    end
-
-    # Is this a Celcius temperature, returns a boolean
-    def is_C?
-        return self.units == "C"
-    end
-
-    # Is this a Kelvin temperature, returns a boolean
-    def is_K?
-        return self.units == "K"
-    end
-
-    # Convert the temperature to Farenheit.  If it's already in F, it
-    # returns itself.
-    def to_F
-        case self.units
-        when "F":
-                return self
-        when "C":
-                return self.c2f
-        when "K":
-                return self.k2f
-        end
-    end
-
-    # Convert the temperature to Celcius.  If it's already in C, it
-    # returns itself.
-    def to_C
-        case self.units
-        when "F":
-                return self.f2c
-        when "C":
-                return self
-        when "K":
-                return self.k2c
-        end
-    end
-        
-    # Convert the temperature to Kelvins.  If it's already in K, it
-    # returns itself.
-    def to_K
-        case self.units
-        when "F":
-                return self.f2k
-        when "C":
-                return self.c2k
-        when "K":
-                return self
-        end
-    end
-        
-    def c2f
-        num = self * CScale + FOffset
-        num.units = "F"
-        return num
-    end
-
-    def f2c
-        num = (self - FOffset) / CScale
-        num.units = "C"
-        return num
-    end
-
-    def c2k
-        num = self + KOffset
-        num.units = "K"
-        return num
-    end
-    
-    def k2c
-        num = self - KOffset
-        num.units = "C"
-        return num
-    end
-    
-    def f2k
-        self.f2c.c2k
-    end
-
-    def k2f
-        self.k2c.c2f
-    end
-
-    # Compute the dewpoint for the temperature given a relative
-    # humidity.  This is using the NOAA approximation for dewpoint
-    # calculation -
-    # http://en.wikipedia.org/wiki/Dew_point#Closer_approximation
-    def dewpoint(rh)
-        units = self.units
-        temp = self.to_C
-        e_sub_s = 6.112 * Math.exp((17.76 * temp) / (temp + 243.5))
-        e = rh * e_sub_s / 100
-        dew = 243.5 * Math.log(e / 6.112) / (17.67 -  Math.log(e / 6.112))
-        dew.units = "C"
-        final = dew.send("to_#{units}")
-        return final
-    end
-
-        
-end
-
-class String
-    
-    # Parse a string that looks like a temperature into a temperature
-    # of the right units.  It handles strings of the format
-    #   
-    #   35.1C
-    #   72K
-    #   -40F
-    #
-    # Decimals are support, as are negative numbers.  The units must
-    # be C, K, or F, and not have a space between the numer and the
-    # units
-    def to_degrees
-        if self =~ /^(-?)(\d+)\.(\d+)(F|C|K)$/
-            tmp = "#{$1}#{$2}.#{$3}".to_f
-            tmp.units = $4
-            return tmp
-        elsif self =~ /^(-?)(\d+)(F|C|K)$/
-            tmp = "#{$1}#{$2}".to_f
-            tmp.units = $3
-            return tmp
-        end
-    end
-    
-    
+module Temperature
+    VERSION = "1.1.0"
 end
-