simple_time_series 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 854ef6e94d122e68388000a7c63705a989b20e3d
-  data.tar.gz: 827f82c991da060d9a2e3e46ac7b62f6ecd8e630
+  metadata.gz: a9ad59d5ec507c02b79dfac4e610a9e53713b251
+  data.tar.gz: e8a81306099468b983d7218253109766b274e00d
 SHA512:
-  metadata.gz: 6ce2c910fa78063cbfcb97f2432b0c08f469741d8554d2751c05bddbd80d83a0dca6c0efad1e493aea111e778d577cef01122a642ea1eb8157642036440b161b
-  data.tar.gz: 5af15fd7ce32aa5edc34d868edc5e333d1a9c6af9ba1c71ad4a32c79000cac3bc3f69b8364076e291013ff1bb4e30a5274d7885dd1a0d948df65401d58663213
+  metadata.gz: f1f60e0b32bae7007e5ff17a186abfd5ac8c16822000049a44a34f1ee3a9b597c85e98a29e1327179c5b6ffedc51d333a5640aa9c47a2fe4e720024b90d30471
+  data.tar.gz: 9af94d475ed26267745dab1150b2fcf63f0c0d9495d85e5f0acdfdb53900132259cb6d0be1687876b9f210dfc2221a49e85898e746d30bfb5cec13ca7f236c4c

data/README.md

@@ -20,38 +20,81 @@ Or install it yourself as:
 
 Example:
 
-Imagine you have recorded over the past week the number of pizzas consumed, the number of miles run, and the number of tasks done.
-
-You have these stored in simple Ruby arrays (that you can name anything you want):
+Imagine you have recorded over the past week the number of pizzas you have consumed, the number of miles you've run, and the number of tasks you've done and you have stored these values in simple Ruby arrays (that you can name anything you want):
 
     pizzas = [0, 0, 1, 0, 0.5, 0, 2]
     miles = [2.2, 3.1, 0.0, 4.3, 1.2, 12.2, 2.3]
     tasks_done = [2, 3, 0, 14, 3, 11, 0]
 
-To associate these observations with the days they belong to, you create arrays of days-of-the-week ("dows") and/or "dates". (You can put whatever time/date values in these arrays that you wish. Currently, however, only arrays named "dows" and "dates" are supported, but I will soon make it so the names you choose don't matter. Only their order in the array(s) matters.)
+To associate these observations with the days they belong to, you create one or more ordered arrays holding sequential observation numbers, days-of-the-week, dates or anything else you want to use to label the ordered events/dates for which you're recording data. (You can put whatever time/date values in these arrays that you wish. Only their order in the array(s) matters.) Below, we create "dows" (for days-of-the-week), "dates" and "full_dates," but you can make whatever ordered observation/date variables you desire. And you need only one time variable:
 
-    dows = ['Sunday', 'Monday', 'Tuesday', 'Wednesday',
-            'Thursday', 'Friday', 'Saturday']
-    dates = ['2014-01-01', '2014-01-02', '2014-01-03',
-             '2014-01-04', '2014-01-05', '2014-01-06', '2014-01-07']
+    dows = ['Sunday', 'Monday', 'Tuesday', 'Wednesday','Thursday', 'Friday', 'Saturday']
+    dates = ['2014-01-01', '2014-01-02', '2014-01-03', '2014-01-04', '2014-01-05', '2014-01-06', '2014-01-07']
+    full_dates = ['Jan 1, 2014', 'Jan 2, 2014', 'Jan 3, 2014', 'Jan 4, 2014', 'Jan 5, 2014', 'Jan 6, 2014', 'Jan 7, 2014']
 
 This is sufficient to package up your data into a SimpleTimeSeries object:
 
     require 'simple_time_series'
     my_data = SimpleTimeSeries.new(:time_vars => {'dows' => dows,
-                                                  'dates' => dates},
+                                                  'dates' => dates,
+                                                  'full_dates' => full_dates},
                                    :data_vars => {'pizzas' => pizzas,
                                                   'miles' => miles,
                                                   'tasks_done' => tasks_done})
 
-You can now easily access the value of any data variable for any value of one of your time variables:
+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'):
+
+    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
+    puts "Pizzas eaten on 'Jan 3, 2014': #{my_data.pizzas_on('Jan 3, 2014')}" # prints 1
+
+    puts "Miles run on Friday: #{my_data.miles_run_on('Friday')}" # prints 12.2
+    puts "Miles run on 2014-01-06: #{my_data.miles_run_on('2014-01-06')}" # prints 12.2
+    puts "Miles run on 'Jan 6, 2014': #{my_data.miles_run_on('Jan 6, 2014')}" # prints 12.2
+
+    puts "Tasks done on Saturday: #{my_data.tasks_done_on('Saturday')}" # prints 0
+    puts "Tasks done on 2014-01-07: #{my_data.tasks_done_on('2014-01-07')}" # prints 0
+    puts "Tasks done on 'Jan 7, 2014': #{my_data.tasks_done_on('Jan 7, 2014')}" # prints 0
+
+You can get the same values by calling SimpleTimeSeries#find with two arguments, first the data_var name and then the time_var value:
+
+    puts "Pizzas eaten on 'Jan 2, 2014': #{my_data.find('pizzas', 'Jan 2, 2014')}" # prints 0
+    puts "Miles on Friday: #{my_data.find('miles', 'Friday')}" # prints 12.2
+    puts "Miles on 2014-01-05: #{my_data.find('miles','2014-01-05')}" # prints 1.2
+    puts "Tasks done on Wednesday: #{my_data.find('tasks_done', 'Wednesday')}" # prints 14
+    puts "Tasks done on 2014-01-05: #{my_data.find('tasks_done', '2014-01-05')}" # prints 3
+
+You can view all the values associated with any variable:
+
+    my_data.miles # prints [2.2, 3.1, 0.0, 4.3, 1.2, 12.2, 2.3]
+
+You can also get the array of values with #current:
+
+    my_data.current('miles') # prints [2.2, 3.1, 0.0, 4.3, 1.2, 12.2, 2.3]
 
-    puts "Pizzas on Tuesday: #{my_data.pizzas_on('Tuesday')}"
-    puts "Pizzas on 2014-01-03: #{my_data.pizzas_on('2014-01-03')}"
-    puts "Miles on Friday: #{my_data.find('miles', 'Friday')}"
-    puts "Miles on 2014-01-05: #{my_data.find('miles','2014-01-05')}"
-    puts "Tasks done on Friday: #{my_data.find('tasks_done', 'Friday')}"
-    puts "Tasks done on 2014-01-05: #{my_data.find('tasks_done', '2014-01-05')}"
+You can change all the values associated with any data variable by setting the value to a different array:
+
+    my_data.pizzas = [4, 6, 3, 2, 3.5, 7, 2]
+    puts "Pizzas eaten on Tuesday: #{my_data.pizzas_on('Tuesday')}" # prints 3
+
+You can change a single value in any data variable by calling #set:
+
+    my_data.set('pizzas', 'Tuesday', 44)
+
+This will change the value:
+
+  puts my_data.pizzas_on('Tuesday') # prints 44
+  puts my_data.pizzas_on('2014-01-03') # prints 44
+  puts my_data.pizzas_on('Jan 3, 2014') # prints 44
+
+A second example of #set:
+
+  my_data.set('tasks_done', 'Saturday', 77)
+  puts my_data.tasks_done_on('Saturday') # prints 77
+  puts my_data.tasks_done_on('2014-01-07') # prints 77
+  puts my_data.tasks_done_on('Jan 7, 2014') # prints 77
+
+Currently, SimpleTimeSeries assumes all variable arrays have equal lengths and represent the same sequence of observations. Though the gem says "time series," it should work with any kind of sequential data.
 
 ## Disclaimer
 
@@ -64,3 +107,7 @@ This began as a simple code example for a collague who needed to do something si
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Acknowledgements
+
+Thanks to my employer, Hedgeye, for letting me create and publish this.

data/lib/simple_time_series/simple_time_series.rb

@@ -13,6 +13,22 @@ class SimpleTimeSeries
     send (what + '_on').to_sym, date
   end
 
+  def current(what)
+    send what.to_sym
+  end
+
+  def index_of_date_value(date)
+    time_vars.each do |tv_key, tv_val|
+      return tv_val.index(date) if tv_val.include?(date)
+    end
+    nil
+  end
+
+  def set(data_var, date, value)
+    arr_index = index_of_date_value(date)
+    current(data_var)[arr_index] = value
+  end
+
   private
 
   def define_time_methods_and_set_values
@@ -29,7 +45,7 @@ class SimpleTimeSeries
       self.class.class_eval do
         define_method(var_on) do |date|
           time_vars.each do |tv_key, tv_val|
-            # tv_key is 'dows' or 'dates'
+            # tv_key is something like 'dows' or 'dates'
             # tv_val is an array of associated values
             return eval(var)[tv_val.index(date)] if tv_val.include?(date)
           end
@@ -50,12 +66,4 @@ class SimpleTimeSeries
     end
   end
 
-  def dows_index(date)
-    dows.index(date)
-  end
-
-  def date_index(date)
-    dates.index(date)
-  end
-
 end

data/lib/simple_time_series/version.rb

@@ -1,3 +1,3 @@
 class SimpleTimeSeries
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/lib/simple_time_series_spec.rb

@@ -5,6 +5,7 @@ describe SimpleTimeSeries do
   before do
     @dows = ['Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
     @dates = ['2014-01-01', '2014-01-02', '2014-01-03', '2014-01-04', '2014-01-05', '2014-01-06', '2014-01-07']
+    @full_dates = ['Jan 1, 2014', 'Jan 2, 2014', 'Jan 3, 2014', 'Jan 4, 2014', 'Jan 5, 2014', 'Jan 6, 2014', 'Jan 7, 2014']
     @pizzas = [0, 0, 1, 0, 0.5, 0, 2]
     @miles = [2.2, 3.1, 0.0, 4.3, 1.2, 12.2, 2.3]
     @tasks_done = [2, 3, 0, 14, 3, 11, 0]
@@ -12,7 +13,8 @@ describe SimpleTimeSeries do
                                        {'pizzas' => @pizzas, 'miles' => @miles,
                                         'tasks_done' => @tasks_done},
                                     :time_vars =>
-                                       {'dows' => @dows, 'dates' => @dates})
+                                       {'dows' => @dows, 'dates' => @dates,
+                                        'full_dates' => @full_dates})
   end
 
   it "should be creatable" do
@@ -47,6 +49,7 @@ describe SimpleTimeSeries do
   end
 
   it "should create setter methods for updating a data series" do
+    @my_data.pizzas_on('Tuesday').should == 1
     @my_data.pizzas = [10, 11, 12, 13, 14, 15, 16]
     @my_data.pizzas_on('Tuesday').should == 12
     @my_data.pizzas_on('Thursday').should == 14
@@ -54,4 +57,37 @@ describe SimpleTimeSeries do
     @my_data.pizzas_on('2014-01-07').should == 16
   end
 
+  describe "#current" do
+
+    it "should print the current array for any data variable" do
+      @my_data.current('pizzas').should == @pizzas
+    end
+
+  end
+
+  describe "#index_of_date_value" do
+
+    it "should return the array index of any date value" do
+      @my_data.index_of_date_value('Thursday').should == 4
+      @my_data.index_of_date_value('2014-01-01').should == 0
+      @my_data.index_of_date_value('Jan 7, 2014').should == 6
+    end
+
+  end
+
+  describe "#set" do
+
+    it "should allow updating a single data series value" do
+      @my_data.set('pizzas', 'Tuesday', 44)
+      @my_data.pizzas_on('Tuesday').should == 44
+      @my_data.pizzas_on('2014-01-03').should == 44
+      @my_data.pizzas_on('Jan 3, 2014').should == 44
+      @my_data.set('tasks_done', 'Saturday', 77)
+      @my_data.tasks_done_on('Saturday').should == 77
+      @my_data.tasks_done_on('2014-01-07').should == 77
+      @my_data.tasks_done_on('Jan 7, 2014').should == 77
+    end
+
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_time_series
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Lavin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-16 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler