unitwise 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 103adb7dd1ac2529083fd8d85acdf833a2f27306
-  data.tar.gz: 8891c69ba019723b58dbfed12cc366f0e77ef8b5
+  metadata.gz: b218dca039e22556a558a1ec6e20887a9d1776fe
+  data.tar.gz: a0015ccf978b027d0adba04e331055dfddcaa069
 SHA512:
-  metadata.gz: 4a970bfbb1915e4ec48ee19661dcbd4c2bd2582e90f9e1d32473b6dbcb3ea7008741fb2315821b34217e43a3b6bf85b8f4ee80522ac88319bbfe67c32a1bddc9
-  data.tar.gz: 1674a77a54539dfc7eefa1d259ea3736caccbdc92b17527577e508712d316ec4d906dbd89300b90d4ac706203ce0f02d3faa4c4b062e41c576fef2d2a5b98a8c
+  metadata.gz: 49d3df5c02e5c6cc71df3d82c39cd586b18482c08e1cf14b5091bf2f047a4f73156f91b4b623ddd2997fa5b7bdc8b9fa7d341fb547112ec25258c7003b1cbd92
+  data.tar.gz: 06e22d56046f7d5cbaac2f69c68e416f4b652865fa0dd46d3c52d9e66ffbecb7b708899054f1945785f7d6ba5121e24e2e4a51f87affa627c49319fdb8640b3c

data/lib/unitwise.rb

@@ -16,7 +16,7 @@ require 'unitwise/atom'
 require 'unitwise/prefix'
 require 'unitwise/term'
 require 'unitwise/unit'
-require 'unitwise/compound'
+require 'unitwise/search'
 require 'unitwise/errors'
 
 # Unitwise is a library for performing mathematical operations and conversions
@@ -29,7 +29,7 @@ module Unitwise
   # @return [Array]
   # @api public
   def self.search(term)
-    Compound.search(term)
+    Search.search(term)
   end
   
   # The system path for the installed gem

data/lib/unitwise/search.rb

@@ -0,0 +1,44 @@
+module Unitwise
+  module Search
+    class << self
+      # An abbreviated list of possible units. These are known combinations
+      # of atoms and prefixes. Since units can be combined to create more
+      # complex units (and thus an infinite number), a full list can't be
+      # provided.
+      # @return [Array] A list of known units
+      # @api public
+      def all
+        @all ||= begin
+          units = []
+          Atom.all.each do |a|
+            units << build(a)
+            Unitwise::Prefix.all.each { |p| units << build(a,p) } if a.metric?
+          end
+          units
+        end
+      end
+
+      # Search the list of known units for a match. Note that this cannot
+      # find all possible units, only simple combinations of atoms and prefixes.
+      # @param term [String, Regexp] The term to search for
+      # @return [Array] A list of matching units.
+      # @api public
+      def search(term)
+        all.select do |unit|
+          unit.aliases.any? { |str| Regexp.new(term).match(str) }
+        end
+      end
+
+      private
+
+      # Helper method for building a new unit by a known atom and prefix.
+      # @param atom [Unitwise::Atom]
+      # @param prefix [Unitwise::Prefix, nil]
+      # @return [Unitwise::Unit]
+      # @api private
+      def build(atom, prefix=nil)
+        Unit.new([Term.new(:atom => atom, :prefix => prefix)])
+      end
+    end
+  end
+end

data/lib/unitwise/unit.rb

@@ -102,6 +102,13 @@ module Unitwise
       expression(mode || self.mode)
     end
 
+    def aliases
+      [:names, :primary_code, :secondary_code, :symbol].map do |mode| 
+        to_s(mode)
+      end.uniq
+    end
+    memoize :aliases
+
     def mode
       terms
       @mode || :primary_code

data/lib/unitwise/version.rb

@@ -1,3 +1,3 @@
 module Unitwise
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

data/test/unitwise/search_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+describe Unitwise::Search do
+  describe :class_methods do
+    describe :all do
+      subject { Unitwise::Search.all }
+      it { subject.must_be_kind_of Enumerable }
+      it { subject.first.must_be_instance_of Unitwise::Unit }
+    end
+    describe :search do
+      it "should return a list of units" do
+        search = Unitwise::Search.search('foo')
+        search.must_be_kind_of Enumerable
+        search.first.must_be_instance_of Unitwise::Unit
+      end
+    end
+  end
+end

metadata

@@ -1,167 +1,167 @@
 --- !ruby/object:Gem::Specification
 name: unitwise
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Josh Lewis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-11 00:00:00.000000000 Z
+date: 2014-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liner
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: signed_multiset
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: memoizable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
   name: parslet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: nori
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.3'
 description: Physical quantity and units of measure conversion and math library
@@ -171,9 +171,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version"
-- ".travis.yml"
+- .gitignore
+- .ruby-version
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -185,7 +185,6 @@ files:
 - lib/unitwise/atom.rb
 - lib/unitwise/base.rb
 - lib/unitwise/compatible.rb
-- lib/unitwise/compound.rb
 - lib/unitwise/errors.rb
 - lib/unitwise/expression.rb
 - lib/unitwise/expression/composer.rb
@@ -199,6 +198,7 @@ files:
 - lib/unitwise/measurement.rb
 - lib/unitwise/prefix.rb
 - lib/unitwise/scale.rb
+- lib/unitwise/search.rb
 - lib/unitwise/standard.rb
 - lib/unitwise/standard/base.rb
 - lib/unitwise/standard/base_unit.rb
@@ -215,7 +215,6 @@ files:
 - test/test_helper.rb
 - test/unitwise/atom_test.rb
 - test/unitwise/base_test.rb
-- test/unitwise/compound_test.rb
 - test/unitwise/expression/decomposer_test.rb
 - test/unitwise/expression/matcher_test.rb
 - test/unitwise/expression/parser_test.rb
@@ -224,6 +223,7 @@ files:
 - test/unitwise/measurement_test.rb
 - test/unitwise/prefix_test.rb
 - test/unitwise/scale_test.rb
+- test/unitwise/search_test.rb
 - test/unitwise/term_test.rb
 - test/unitwise/unit_test.rb
 - test/unitwise_test.rb
@@ -238,17 +238,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Convert between and perform mathematical operations on physical quantities
@@ -258,7 +258,6 @@ test_files:
 - test/test_helper.rb
 - test/unitwise/atom_test.rb
 - test/unitwise/base_test.rb
-- test/unitwise/compound_test.rb
 - test/unitwise/expression/decomposer_test.rb
 - test/unitwise/expression/matcher_test.rb
 - test/unitwise/expression/parser_test.rb
@@ -267,7 +266,7 @@ test_files:
 - test/unitwise/measurement_test.rb
 - test/unitwise/prefix_test.rb
 - test/unitwise/scale_test.rb
+- test/unitwise/search_test.rb
 - test/unitwise/term_test.rb
 - test/unitwise/unit_test.rb
 - test/unitwise_test.rb
-has_rdoc: 

data/lib/unitwise/compound.rb

@@ -1,83 +0,0 @@
-module Unitwise
-  # A compound is a combination of an atom and a prefix.
-  # This class is isolated from the rest of the code base and primarily exists
-  # for the convenience of listing and searching possible combinations
-  # of atoms and prefixes.
-  class Compound < Liner.new(:atom, :prefix)
-    # List all possible compounds
-    # @return [Array]
-    # @api public
-    def self.all
-      @all || build
-    end
-
-    # Builds up the list of possible compounds. Only required if you are
-    # defining your own atoms/prefixes.
-    # @return [Array]
-    # @api public
-    def self.build
-      compounds = Atom.all.map { |a| new(a) }
-      Atom.all.select(&:metric).each do |a|
-        Prefix.all.each do |p|
-          compounds << new(a, p)
-        end
-      end
-      @all = compounds
-    end
-
-    # Search for compounds with a search term
-    # @param [String, Regexp] What to search for
-    # @return [Array]
-    # @api public
-    def self.search(term)
-      all.select do |compound|
-        compound.search_strings.any? { |str| Regexp.new(term).match(str) }
-      end
-    end
-
-    [:primary_code, :secondary_code, :symbol].each do |attr|
-      define_method attr do
-        instance_variable_get("@#{attr}") ||
-        instance_variable_set("@#{attr}",
-          prefix ? "#{prefix.send attr}#{atom.send attr}" : atom.send(attr))
-      end
-    end
-
-    [:names, :slugs].each do |attr|
-      define_method attr do
-        instance_variable_get("@#{attr}") ||
-        instance_variable_set("@#{attr}",
-          if prefix
-            prefix.send(attr).zip(atom.send(attr)).map { |set| set.join('') }
-          else
-            atom.send(attr)
-          end)
-      end
-    end
-
-    def atom=(value)
-      value.is_a?(Atom) ? super(value) : super(Atom.find value)
-    end
-
-    def prefix=(value)
-      value.is_a?(Prefix) ? super(value) : super(Prefix.find value)
-    end
-
-    def search_strings
-      @search_strings ||= [primary_code, secondary_code, symbol,
-                           names, slugs].flatten.uniq
-    end
-
-    def attribute_string
-      [:atom, :prefix, :primary_code, :secondary_code,
-       :symbol, :names, :slugs].map do |attr|
-        "#{attr}='#{send attr}'"
-      end.join(', ')
-    end
-
-    def to_s(mode = :primary_code)
-      res = send(mode)
-      res.respond_to?(:each) ? res.first : res
-    end
-  end
-end

data/test/unitwise/compound_test.rb

@@ -1,43 +0,0 @@
-require 'test_helper'
-
-describe Unitwise::Compound do
-  describe :class_methods do
-    describe :all do
-      subject { Unitwise::Compound.all }
-      it { subject.must_be_kind_of Enumerable }
-      it { subject.first.must_be_instance_of Unitwise::Compound }
-    end
-    describe :search do
-      it "should return a list of units" do
-        search = Unitwise::Compound.search('foo')
-        search.must_be_kind_of Enumerable
-        search.first.must_be_instance_of Unitwise::Compound
-      end
-    end
-  end
-
-  describe :instance_methods do
-    let(:prefixed)   { Unitwise::Compound.new('m','k') }
-    let(:unprefixed) { Unitwise::Compound.new("[in_i]") }
-    it "should have an atom" do
-      [prefixed, unprefixed].each { |ex| ex.atom.must_be_instance_of Unitwise::Atom }
-    end
-    it "should have a prefix when appropriate" do
-      prefixed.prefix.must_be_instance_of Unitwise::Prefix
-      unprefixed.prefix.must_equal nil
-    end
-    it "should concatenate common methods" do
-      prefixed.primary_code.must_equal 'km'
-      unprefixed.secondary_code.must_equal '[IN_I]'
-      prefixed.names.must_equal ['kilometer']
-      unprefixed.slugs.must_equal ['inch']
-    end
-    it "should have an array of strings for searching" do
-      prefixed.search_strings.must_be_kind_of(Array)
-    end
-    it "should look ok for inspection" do
-      prefixed.inspect.must_include 'km'
-      unprefixed.inspect.must_include '[IN_I]'
-    end
-  end
-end