analog 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d406496d1f9d968519029f39c59cfd4de9d89959
-  data.tar.gz: 6c6594988cb9a366f6125f21a340d1782ee1930c
+  metadata.gz: 5fa67d3ea0f497fdb0f6c4e0d795d539963f4b09
+  data.tar.gz: deed6727fb227a1f7f59efd3b6ac09d3c915ea52
 SHA512:
-  metadata.gz: fd71860f234567f1f0111c7b723a0b0760ccf02645a1ea6f85f678dbd1e863974af788b45429a93c2708873d128c8ddb72e29597b8b7a2c96266e865dce1ebe7
-  data.tar.gz: 92ef67f94ef2ff5049da82808d8046d4cae7e11a836ea3ee546914d1e0b3dbdfcfa6db991ce401f20bcfcf4fe8b29eec4f55548f63d3b4d5dd87158608ce45ef
+  metadata.gz: 49e2004c03e8cbc8288feff90b472efca61cfc5dc84c9df5cbcdadaed0b5d9ead6ae231056f7919af3d56784a7198d8711294bfdeb95fcbeb3a645d1e15f59dd
+  data.tar.gz: 0ecb3626a87261d3d6c5c693a83420d000df25158a16ef055e89fef2d846d9244519b9afa8e1d80b2944ecb6b0221fbcec408c404d57c7c6ff3510e4e79089cc

data/README.md

@@ -4,15 +4,15 @@ A Ruby helper for scaling numbers.
 
 #### Background
 
-This helper provides a quick way to take a number and scale it given a source and destination range/set/etc.
+Provides a quick way to scale a number from one range or set to another.
 
-It's useful for converting data from raw values to a range used for display or other kinds of output.
+This is useful for converting data from raw values to a range used for display or other kinds of output.
 
-I use this all the time in music programming, converting OSC messages to musical notes and things like that and figure it might be useful to others.
+I use it all the time in music programming, converting OSC messages to musical notes and things like that and figure it might be useful to others.
 
 A simple example is:
 
-If you want to plot a point on a 500px graph using a data that lies in the 0..1 range, do
+You want to plot a point on a 500px graph using a data that lies in the 0..1 range.
 
 ```ruby
 Scale.transform(0.5).using(0..1, 0..500)

data/lib/scale.rb

@@ -6,6 +6,6 @@ require "scale/source"
 # A Ruby helper for scaling numbers
 module Scale
 
-  VERSION = "0.1"
+  VERSION = "0.2"
 
 end

data/lib/scale/scheme.rb

@@ -4,7 +4,29 @@ module Scale
   # @param [Numeric] input
   # @return [Scale::Scheme]
   def self.transform(input)
-    Scheme.new(:input => input)
+    Scheme.new.scale(input)
+  end
+
+  # Build a scaling scheme starting with the given source
+  # @param [::Enumerable] source
+  # @return [Scale::Scheme]
+  def self.from(source)
+    Scheme.new.from(source)
+  end
+
+  # Build a scaling scheme starting with the given destination
+  # @param [::Enumerable] destination  
+  # @return [Scale::Scheme]
+  def self.to(destination)
+    Scheme.new.to(destination)
+  end
+
+  # Build a scaling scheme starting with the given source and destination
+  # @param [::Enumerable] source
+  # @param [::Enumerable] destination
+  # @return [Scale::Scheme]
+  def self.using(source, destination)
+    Scheme.new.using(:source => source, :destination => destination)
   end
 
   # Describes a particular scaling scenario
@@ -13,8 +35,8 @@ module Scale
     attr_reader :destination, :input, :source
 
     # @param [Hash] options
-    # @option options [Scale::Destination] :destination The destination for this scaling scenario
-    # @option options [Scale::Source] :source The source for this scaling scenario
+    # @option options [::Enumerable] :destination The destination for this scaling scenario
+    # @option options [::Enumerable] :source The source for this scaling scenario
     def initialize(options = {})
       @input = options[:input]
       @source = Source.new(options[:source]) unless options[:source].nil?
@@ -25,39 +47,59 @@ module Scale
     # has all of its needed properties, the scaled value will be returned.  Otherwise
     # this method will return the updated Scheme object.
     #
-    # @param [Scale::Source] source
-    # @return [Fixnum, Scale::Scheme]
+    # @param [::Enumerable] source
+    # @return [Numeric, Scale::Scheme]
     def from(source)
       @source = Source.new(source)
-      if @input.nil? || @destination.nil?
-        self
-      else
-        @destination.scale(@input, @source)
-      end
+      scale? ? result : self
     end
 
     # Set the destination for this scaling scenario.  If on calling this method, the 
     # scenario has all of its needed properties, the scaled value will be returned.  
     # Otherwise this method will return the updated Scheme object.
     #
-    # @param [Scale::Destination] destination
-    # @return [Fixnum, Scale::Scheme]
+    # @param [::Enumerable] destination
+    # @return [Numeric, Scale::Scheme]
     def to(destination)
       @destination = Destination.new(destination)
-      if @input.nil? || @source.nil?
-        self
-      else
-        @destination.scale(@input, @source) 
-      end
+      scale? ? result : self
     end
 
-    # Set both the source and destination on this scheme
-    # @param [Scale::Source] source
-    # @param [Scale::Destination] destination
+    # Set both the source and destination on this scheme. If on calling this method, the 
+    # scenario has all of its needed properties, the scaled value will be returned.  
+    # Otherwise this method will return the updated Scheme object.
+    #
+    # @param [::Enumerable] source
+    # @param [::Enumerable] destination
+    # @return [Numeric, Scale::Scheme]
     def using(source, destination)
       @source = Source.new(source)
       @destination = Destination.new(destination)
-      @destination.scale(@input, @source)
+      scale? ? result : self
+    end
+
+
+    # Set the input of this scaling scenario.  If on calling this method, the 
+    # scenario has all of its needed properties, the scaled value will be returned.  
+    # Otherwise this method will return the updated Scheme object.
+    # 
+    # @param [Numeric] number
+    # @return [Numeric, Scale::Scheme]
+    def scale(number)
+      @input = number
+      scale? ? result : self
+    end
+
+    # Scan this scaling scenario be run?
+    # @return [Boolean] Whether this scaling scenario can be run
+    def scale?
+      !@input.nil? && !@source.nil? && !@destination.nil?
+    end
+
+    # Get the result of this scaling scenario
+    # @return [Numeric, nil]
+    def result
+      @result ||= @destination.scale(@input, @source)
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: analog
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Ari Russo
@@ -52,8 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides a quick way to take a number and scale it given a source and
-  destination Array, Range, Set, etc
+description: Provides a quick way to scale a number from one range or set to another
 email:
 - ari.russo@gmail.com
 executables: []