simple_time_series 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96fc69681d3c929e6f16e8f162be2fc246128eed
-  data.tar.gz: 2737be6e56ae082830a0273e76b09663ac94d713
+  metadata.gz: ea71f33d9379194751d0185a8c80785f6f107e75
+  data.tar.gz: 4c0cfefa649209183c53a447e4a1421c77ce3429
 SHA512:
-  metadata.gz: 3b3d87226d74112ebf4c4a2650f57e9340a3a27e1a1de61347be8096606009e5b70610d74f17ec72f5fa072dd86901c6d5031c58a115e41507d659e4e19f4f03
-  data.tar.gz: 01753f203de51d3b6f321cd1c010a931f4764fd657986ecff98c5c4b05c487c1f5bc738f84234e8b2bba103301549347b3c35dae06254d5b98aa3b2d657c4b11
+  metadata.gz: 91c7b8b6e4d342656d125b94270b9365c2a6bab5c5e79ae9c8963d015dcd2e49212e26a6db242fa800fe5c434197c5c768d7d08e9dbbdd9c88d4b33d6ab5d16b
+  data.tar.gz: 7dc09d39e91eb4e636bd70690164f10357ab5ec2d30916e63e6a2ea20dffe4802c19ebb3af20a9f19b446d6f9561ed183420adbbd83da4f4d4bea3ca9916bb86

data/README.md

@@ -42,14 +42,36 @@ This is sufficient to package up your data into a SimpleTimeSeries object:
                                                   'miles' => miles,
                                                   'tasks_done' => tasks_done})
 
-If your input data is strings but should be converted into numeric, you can call #to_num on it and it will be converted to an array of integers (where possible) or floats:
+If a data array contains strings that should be converted to numeric values, you can call #to_num on the data array and its values will be converted to integers (where possible) or floats:
 
     donuts = ["6", "0", "2", "4.5", "1.5", "0", "9"]
     new_data = SimpleTimeSeries.new(:time_vars => {'dates' => dates},
                                     :data_vars => {'donuts' => donuts.to_num})
     new_data.current('donuts') #returns [6, 0, 2, 4.5, 1.5, 0, 9]
 
-You can now easily access the value of any data variable for any value of one of your time variables via xxx_on methods created for each of your data_vars (here called 'pizzas_on,' 'miles_on' and 'tasks_done_on'):
+You can, optionally, pass a hash of :attribs into SimpleTimeSeries.new with additional attributes for each of your time_vars and data_vars. You can call these attributes anything you want and then query their values later. For example, we can associate each data_var with a :full_name, :color, and :position (but you can call your variables almost anything you want):
+
+    my_data = SimpleTimeSeries.new(:time_vars => {'dows' => dows,
+                                                  'dates' => dates,
+                                                  'full_dates' => full_dates},
+                                   :data_vars => {'pizzas' => pizzas,
+                                                  'miles' => miles,
+                                                  'tasks_done' => tasks_done},
+                                   :attribs => {'pizzas' => {:full_name => 'Pizzas Eaten', :color => 'red', :position => 2},
+                                                'miles' => {:full_name => 'Miles Run', :color => 'green', :position => 3},
+                                                'tasks_done' => {:full_name => 'Tasks Completed', :color => 'yellow', :position => 1}
+                                               } )
+
+After doing so, you can then grab these values:
+
+    my_data.full_name('pizzas') # returns 'Pizzas Eaten'
+    my_data.full_name('miles') # returns 'Miles Run'
+    my_data.color('miles') # returns 'green'
+    my_data.color('tasks_done') # returns 'yellow'
+    my_data.position('pizzas') # returns 2
+    my_data.position('miles') # returns 3
+
+You can easily access the value of any data variable for any value of one of your time variables via xxx_on methods created for each of your data_vars (here called 'pizzas_on,' 'miles_on' and 'tasks_done_on'):
 
     puts "Pizzas eaten on Tuesday: #{my_data.pizzas_on('Tuesday')}" # prints 1
     puts "Pizzas eaten on 2014-01-03: #{my_data.pizzas_on('2014-01-03')}" # prints 1

data/lib/simple_time_series/simple_time_series.rb

@@ -2,15 +2,24 @@ class SimpleTimeSeries
   
   DEBUG = false
 
-  attr_accessor :time_vars, :data_vars
+  attr_accessor :time_vars, :data_vars, :attribs
 
   def initialize(opts)
     @time_vars = opts[:time_vars]
     @data_vars = opts[:data_vars]
+    @attribs = opts[:attribs]
     define_data_methods_and_set_values
     define_time_methods_and_set_values
   end
 
+  def method_missing(meth, *args, &block)
+    begin
+      attribs[args[0]][meth]
+    rescue
+      super
+    end
+  end
+
   def find(what, date, end_date=nil, opts={})
     puts "Calling send(#{what}_on, #{date}, #{end_date}, #{opts})" if DEBUG
     send((what + '_on').to_sym, date, end_date, opts)

data/lib/simple_time_series/version.rb

@@ -1,3 +1,3 @@
 class SimpleTimeSeries
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/spec/lib/simple_time_series_spec.rb

@@ -14,7 +14,20 @@ describe SimpleTimeSeries do
                                         'tasks_done' => @tasks_done, 'empty' => []},
                                     :time_vars =>
                                        {'dows' => @dows, 'dates' => @dates,
-                                        'full_dates' => @full_dates})
+                                        'full_dates' => @full_dates},
+                                    :attribs => {'pizzas' => {:full_name => 'Pizzas Eaten', :color => 'red', :position => 2},
+                                                 'miles' => {:full_name => 'Miles Run', :color => 'green', :position => 3},
+                                                 'tasks_done' => {:full_name => 'Tasks Completed', :color => 'yellow', :position => 1}
+                                                } )
+  end
+
+  it "finds values in :attribs" do
+    @my_data.full_name('pizzas').should == 'Pizzas Eaten'
+    @my_data.full_name('miles').should == 'Miles Run'
+    @my_data.color('miles').should == 'green'
+    @my_data.color('tasks_done').should == 'yellow'
+    @my_data.position('pizzas').should == 2
+    @my_data.position('miles').should == 3
   end
 
   it "is creatable" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_time_series
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - James Lavin