alchemist 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 971b2a4f87be414e30ada4d1f1f34465c634fe60
-  data.tar.gz: d997c55e956f6d2174712a7a9f9fa566a793abf3
+  metadata.gz: 09cdd7bc72d33ef49f70bfa21e7a6b98bc56ca35
+  data.tar.gz: 5930f598e0adec3f2a8b3e3e2030fd61b9c48234
 SHA512:
-  metadata.gz: cf02dbbd813adbdbaa066e712213fe1e09c751d87507b2b8bdac5d67531ac6e7d7b9eada8d090258dcbfae0ee2c818c279e67c11ce0d6ac6498ed2e3f02eaacb
-  data.tar.gz: 4d5c6dd3011d8c984e7b9eda8df286e92489b6c9f49235b4dca1e05137b9931130c090698f7d8e419e9d62d5fa18ce0f470a23b146f95ee8e95624f7c2a77655
+  metadata.gz: 72133a2fa6b707b2e52e6cb5354506d364b176aaab25383b9db8f341be847fa2622a89e888fc3adeb8021f2e347b210961a2fca687d4278a5807da5d41827bc0
+  data.tar.gz: b6ded515a9ebd212ace47ba64a91a9f44619f757457f27a8ae384edf380b327312e5223c444122ae5e3a2552c9d1330964c99e115f88c2e66ac6315f31fc8b3d

data/Gemfile.lock

@@ -1,24 +1,26 @@
 PATH
   remote: .
   specs:
-    alchemist (0.1.4)
+    alchemist (0.1.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.0.8)
-    method_source (0.8.1)
-    pry (0.9.12)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
+    diff-lcs (1.2.4)
     rake (10.0.3)
-    slop (3.4.3)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.3)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   alchemist!
-  pry
   rake
+  rspec

data/README.md

@@ -9,113 +9,85 @@ code more readable.
 
 Having code that looks like this is meaningless
 
-    miles = 8 * 1609.344
+```ruby
+miles = 8 * 1609.344
+```
 
 You could add comments
 
-    miles = 8 * 1609.344 # converting meters to miles
+```ruby
+miles = 8 * 1609.344 # converting meters to miles
+```
 
 But why not have this!
 
-    8.meters.to.miles
+```ruby
+8.meters.to.miles
+```
 
 You can even perform mathematical operations
 
-    10.kilometers + 1.mile # 11.609344 kilometers
+```ruby
+10.kilometers + 1.mile # 11.609344 kilometers
+```
 
 Handling bytes now works according to the JEDEC memory standard
 
-    1.kb.to.b.to_f == 1024.0
+```ruby
+1.kb.to.b.to_f == 1024.0
+```
 
-To switch to the IEC memory standard, force SI units with
+Converting distance of arc length on Earth to an (approximate) corresponding spherical geometry angle can be done with
 
-    Alchemist::use_si = true
+```ruby
+require 'alchemist/geospatial'
+1.mile.geospatial.to.degree == 0.014457066992474555
+```
 
-<strong>You may also register your own units</strong>
+To switch to the IEC memory standard, force SI units with
 
-    Alchemist.register(:distance, [:beard_second, :beard_seconds], 5.angstroms)
+```ruby
+Alchemist::use_si = true
+```
 
-Thanks to <a href='http://github.com/simonmenke'>simonmenke</a> you can
-now do comparisons without having to convert to floats like so:
+To see all the units alchemist has built in conversion for, check out the [units file](lib/alchemist/data/units.yml)
 
-    5.grams == 0.005.kilograms
+<strong>You may also register your own units</strong>
+
+```ruby
+Alchemist.register(:distance, [:beard_second, :beard_seconds], 5.angstroms)
+```
 
 Installation
 ------------
 
     gem install alchemist
 
-Usage
+Setup
 -----
 
-    require 'rubygems'
-    require 'alchemist'
-
-Or if you’re using rails
-
-    gem 'alchemist'
-
-Alchemist has conversions for:
-------------------------------
-
-### Distance
-
--   metres or meters
--   fermis
--   microns
--   chains
--   inches
--   microinches
--   mils
--   rods
--   leagues
--   feet
--   yards
--   miles
--   astronomical\_units
--   light\_years
--   parsecs
--   nautical\_miles
--   admirality\_miles
--   fathoms
--   cable\_lengths
--   angstroms
--   picas
--   printer\_picas
--   points
--   printer\_points
-
-### Mass
-
--   grams or grammes
--   carats
--   ounces
--   pennyweights
--   pounds
--   troy\_pounds or apothecary\_pounds
--   slugs
--   assay\_tons
--   metric\_tons
--   tons or short\_tons
-
-### Volume
-
--   litres or liters
--   barrels
--   bushels
--   cubic\_meters
--   cups
--   imperial\_fluid\_ounces
--   fluid\_ounces
--   imperial\_gallons
--   gallons
--   imperial\_gills
--   gills
--   pints
--   liquid\_pints
--   quarts
--   liquid\_quarts
--   tablespoons
--   teaspoons
-
-### And many more checkout **lib/alchemist.rb** for the rest
+In order for methods like `1.meter` to work, you'll either need to setup Alchemist yourself:
+
+```ruby
+Alchemist.setup # This will load every category of measurement
+```
+
+if you only want to use one category for conversions you can load it individually:
+
+```ruby
+Alchemist.setup('distance') # This will load only distance
+```
+
+Rails Warning
+-------------
+
+Rails adds some methods like `bytes` to `Numeric` so it's highly recommended that instead of trying to call `bytes` on a numeric, you should use the `measure` method:
+
+```ruby
+Alchemist.measure(10, :bytes)
+```
+
+License
+-------
+
+Alchemist is licensed under the MIT license as specified in the [gemspec](alchemist.gemspec)

data/Rakefile

@@ -1,15 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
-task :default => [:test]
-task :test => ['test:units']
-
-namespace :test do
-  Rake::TestTask.new(:units) do |test|
-    test.libs << 'test'
-    test.ruby_opts << '-rubygems'
-    test.pattern = 'test/*.rb'
-    test.verbose = true
-  end
-end
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/alchemist.gemspec

@@ -11,10 +11,12 @@ Gem::Specification.new do |gem|
   gem.homepage = 'http://github.com/halogenandtoast/alchemist'
   gem.summary = 'Conversions... like you\'ve never seen them before!'
   gem.description = 'Conversions... like you\'ve never seen them before!!'
+  gem.license = 'MIT'
 
   gem.files = `git ls-files`.split($/)
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
 end

data/lib/alchemist.rb

@@ -1,31 +1,32 @@
-require "alchemist/units"
-require "alchemist/compound_numeric_conversion"
-require "alchemist/numeric_conversion"
-require "alchemist/numeric_ext"
+require "alchemist/conversion_table"
+require "alchemist/measurement"
+require "alchemist/compound_measurement"
+require "alchemist/module_builder"
 
 module Alchemist
-  def self.measurement value, unit, exponent = 1.0
-    NumericConversion.new value, unit, exponent
-  end
+  autoload :Earth, "alchemist/objects/planets/earth"
 
-  def self.use_si
-    @use_si ||= false
-  end
+  DATA_DIR = File.join(File.dirname(__FILE__), "alchemist", "data")
 
-  def self.use_si= use_si
-    @use_si = use_si
-  end
+  DEFAULT_UNITS_FILE = File.join(DATA_DIR, "units.yml")
+  DEFAULT_BINARY_PREFIXES_FILE = File.join(DATA_DIR, "binary_prefixes.yml")
+  DEFAULT_SI_UNITS_FILE = File.join(DATA_DIR, "si_units.yml")
+  DEFAULT_UNIT_PREFIXES_FILE = File.join(DATA_DIR, "unit_prefixes.yml")
 
-  def self.conversion_table
-    @conversion_table ||= ConversionTable.new.load_all
+  def self.setup category = nil
+    if category
+      Numeric.send(:include, ModuleBuilder.new(category).build)
+    else
+      conversion_table.keys.each { |category| Numeric.send(:include, ModuleBuilder.new(category).build) }
+    end
   end
 
-  def self.operator_actions
-    @operator_actions ||= {}
+  def self.measure value, unit, exponent = 1.0
+    Measurement.new value, unit, exponent
   end
 
-  def self.conversions
-    @conversions ||= load_conversions
+  def self.has_measurement? name
+    conversions.keys.include? name.to_sym
   end
 
   def self.measurement_for name
@@ -33,9 +34,9 @@ module Alchemist
   end
 
   def self.register(type, names, value)
-
     names = Array(names)
-    value = value.is_a?(NumericConversion) ? value.base(type) : value
+    value = value.is_a?(Measurement) ? value.base(type) : value
+    Alchemist.conversion_table[type] ||= {}
 
     names.each do |name|
       conversions[name] ||= []
@@ -44,11 +45,6 @@ module Alchemist
     end
   end
 
-  def self.register_operation_conversions type, other_type, operation, converted_type
-    operator_actions[operation] ||= []
-    operator_actions[operation] << [type, other_type, converted_type]
-  end
-
   def self.parse_prefix(unit)
     matches = unit.to_s.match(prefix_matcher)
     prefix, parsed_unit = matches.captures
@@ -61,16 +57,59 @@ module Alchemist
     end
   end
 
+  def self.register_operation_conversions type, other_type, operation, converted_type
+    operator_actions[operation] ||= []
+    operator_actions[operation] << [type, other_type, converted_type]
+  end
+
+  def self.operator_actions
+    @operator_actions ||= {}
+  end
+
+  def self.binary_prefixes
+    @binary_prefixes ||= YAML.load_file(DEFAULT_BINARY_PREFIXES_FILE)
+  end
+
+  def self.si_units
+    @si_units ||= YAML.load_file(DEFAULT_SI_UNITS_FILE)
+  end
+
+  def self.unit_prefixes
+    @unit_prefixes ||= YAML.load_file(DEFAULT_UNIT_PREFIXES_FILE)
+  end
+
+  def self.use_si
+    @use_si ||= false
+  end
+
+  def self.use_si= use_si
+    @use_si = use_si
+  end
+
+  def self.load_conversion_table(filename=DEFAULT_UNITS_FILE)
+    @conversion_table = ConversionTable.new.load_all(filename)
+  end
+
+  def self.conversion_table
+    @conversion_table ||= load_conversion_table
+  end
+
+  def self.conversions
+    @conversions ||= load_conversions
+  end
+
+
   private
 
   def self.use_binary_prefix? unit
     !use_si && measurement_for(unit).include?(:information_storage)
   end
 
-
   def self.prefix_matcher
-    keys = unit_prefixes.keys.map(&:to_s).sort{ |a,b| b.length <=> a.length }
-    %r{^(#{keys.join('|')})?(.+)}
+    @prefix_matcher ||= begin
+                          prefix_keys = unit_prefixes.keys.map(&:to_s).sort{ |a,b| b.length <=> a.length }
+                          %r{^(#{prefix_keys.join('|')})?(.+)}
+                        end
   end
 
   def self.prefixed_value_for prefix, unit
@@ -92,5 +131,3 @@ module Alchemist
     conversions
   end
 end
-
-require "alchemist/compound"

data/lib/alchemist/{compound_numeric_conversion.rb → compound_measurement.rb}

@@ -1,5 +1,5 @@
 module Alchemist
-  class CompoundNumericConversion
+  class CompoundMeasurement
     attr_accessor :numerators, :denominators
 
     def initialize(numerator)
@@ -13,13 +13,12 @@ module Alchemist
       when Numeric
          @coefficient *= value
          self
-      when Alchemist::NumericConversion
+      when Alchemist::Measurement
         @numerators << value
         return consolidate
       end
     end
 
-    # TODO: minify this
     def consolidate
       compress_units
       set_coefficients
@@ -58,7 +57,7 @@ module Alchemist
 
     def method_missing(method, *attrs, &block)
       if Alchemist.measurement_for(method)
-        @denominators << Alchemist.measurement(1, method)
+        @denominators << Alchemist.measure(1, method)
         consolidate
       end
     end

data/lib/alchemist/conversion_table.rb

@@ -0,0 +1,69 @@
+require 'yaml'
+
+module Alchemist
+  class ConversionTable
+
+    def load_all(yaml_file)
+      begin
+        YAML.load_file(yaml_file).merge(proc_based)
+      rescue Psych::SyntaxError, Errno::ENOENT
+        nil
+      end
+    end
+
+    private
+
+    def proc_based
+      {
+        :density => {
+          :specific_gravity => 1, :sg => 1,
+          :brix     => [lambda{ |d| -261.3 / (d - 261.3) }, lambda{ |d| 261.3 - (261.3 / d) }],
+          :plato    => [lambda{ |d| -260.0 / (d - 260.0) }, lambda{ |d| 260.0 - (260.0 / d) }],
+          :baume    => [lambda{ |d| -145.0 / (d - 145.0) }, lambda{ |d| 145.0 - (145.0 / d) }]
+        },
+        :temperature => temperature
+      }
+    end
+
+    def temperature
+      {
+        :kelvin => 1.0, :K => 1.0,
+
+        :celsius => celsius_conversion,
+        :centrigrade => celsius_conversion,
+        :degree_celsius => celsius_conversion,
+        :degree_centrigrade => celsius_conversion,
+        :degrees_celsius => celsius_conversion,
+        :degrees_centrigrade => celsius_conversion,
+        :fahrenheit => fahrenheit_conversion,
+        :degree_fahrenheit => fahrenheit_conversion,
+        :degrees_fahrenheit => fahrenheit_conversion,
+        :rankine => 1.8, :rankines => 1.8
+      }
+    end
+
+    def to_celsius
+      lambda{ |t| t + 273.15 }
+    end
+
+    def from_celsius
+      lambda{ |t| t - 273.15 }
+    end
+
+    def celsius_conversion
+      [to_celsius, from_celsius]
+    end
+
+    def to_fahrenheit
+      lambda{ |t| (t - 32.0) * (5.0/9.0) + 273.15 }
+    end
+
+    def from_fahrenheit
+      lambda{ |t| (t - 273.15) * (9.0/5.0) + 32.0 }
+    end
+
+    def fahrenheit_conversion
+      [to_fahrenheit, from_fahrenheit]
+    end
+  end
+end