simple_time_series 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9ad59d5ec507c02b79dfac4e610a9e53713b251
-  data.tar.gz: e8a81306099468b983d7218253109766b274e00d
+  metadata.gz: a99423c6c3e3ef3717c741f6c62a8f6b7d432140
+  data.tar.gz: 94125e0737e9353a24c0e81ce75cd9c226742bde
 SHA512:
-  metadata.gz: f1f60e0b32bae7007e5ff17a186abfd5ac8c16822000049a44a34f1ee3a9b597c85e98a29e1327179c5b6ffedc51d333a5640aa9c47a2fe4e720024b90d30471
-  data.tar.gz: 9af94d475ed26267745dab1150b2fcf63f0c0d9495d85e5f0acdfdb53900132259cb6d0be1687876b9f210dfc2221a49e85898e746d30bfb5cec13ca7f236c4c
+  metadata.gz: 87f4f7d17a23a0eb793483b4864913d7319ffdd4675706c2b9899d262b854977e63263cb422928f80e4ab865e97b072cb57f96b64c32a4d8e5204fe08f033e5c
+  data.tar.gz: 1b6cfeab601d9fb0e70e7a44ddba59c1a378ea76f5e09d845b3ae38799cb45a6ab0963665f62b86d69f8e79321dda06e20c4c30ae40faff6f0e810a64aaedeff

data/README.md

@@ -94,6 +94,50 @@ A second example of #set:
   puts my_data.tasks_done_on('2014-01-07') # prints 77
   puts my_data.tasks_done_on('Jan 7, 2014') # prints 77
 
+You can use #set to build up a data variable from an empty array. Begin by assigning an empty array to a data_var:
+
+    my_data2 = SimpleTimeSeries.new(:time_vars => {'dows' => dows,
+                                                  'dates' => dates,
+                                                  'full_dates' => full_dates},
+                                    :data_vars => {'empty' => []}
+
+You can then set individual values using #set till you've filled in all values:
+
+    my_data2.set('empty', 'Jan 1, 2014', 1)
+    my_data2.set('empty', 'Monday', 2)
+    my_data2.set('empty', '2014-01-03', 3)
+    my_data2.set('empty', 'Jan 4, 2014', 4)
+    my_data2.set('empty', 'Thursday', 5)
+    my_data2.set('empty', '2014-01-06', 6)
+    my_data2.set('empty', 'Jan 7, 2014', 7)
+
+my_data2.empty now equals [1, 2, 3, 4, 5, 6, 7]
+
+You can also create new time variables and data variables after you have created your SimpleTimeSeries object.
+
+Here's how you can create and use a new time variable:
+
+    my_data.new_time_var('short_dow',['Sun', 'Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'])
+
+    puts my_data.tasks_done_on('Fri') # prints 11
+    puts my_data.pizzas_on('Thurs') # prints 0.5
+
+Here's how you can create and use a new data variable:
+
+    my_data.new_data_var('hours_of_tv',[7, 3, 3.5, 3, 4, 6.5, 11])
+
+    puts my_data.hours_of_tv # prints [7, 3, 3.5, 3, 4, 6.5, 11]
+    puts my_data.hours_of_tv_on('Friday') # prints 6.5
+    puts my_data.hours_of_tv_on('2014-01-01') # prints 7
+
+You can create new time and data variables and use them together:
+
+    my_data.new_time_var('short_dow',['Sun', 'Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'])
+    my_data.new_data_var('hours_of_tv',[7, 3, 3.5, 3, 4, 6.5, 11])
+
+    puts my_data.hours_of_tv_on('Fri') # prints 6.5
+    puts my_data.hours_of_tv_on('Sun') # prints 7
+
 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

data/lib/simple_time_series/simple_time_series.rb

@@ -29,30 +29,41 @@ class SimpleTimeSeries
     current(data_var)[arr_index] = value
   end
 
+
+  def new_time_var(var, vals)
+    define_getter_and_setter(var)
+    instance_variable_set("@#{var}", vals) if vals
+    time_vars[var] = vals unless time_vars.has_key?(var)
+  end
+
+  def new_data_var(var, vals)
+    define_getter_and_setter(var)
+    var_on = "#{var}_on"
+    self.class.class_eval do
+      define_method(var_on) do |date|
+        time_vars.each do |tv_key, tv_val|
+          # 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
+        raise "Can't find #{var_on} for #{date}"
+      end
+    end
+    instance_variable_set("@#{var}", vals) if vals
+    data_vars[var] = vals unless data_vars.has_key?(var)
+  end
+
   private
 
   def define_time_methods_and_set_values
     time_vars.each do |var, vals|
-      define_getter_and_setter(var)
-      instance_variable_set("@#{var}", vals) if vals
+      new_time_var(var, vals)
     end
   end
 
   def define_data_methods_and_set_values
     data_vars.each do |var, vals|
-      define_getter_and_setter(var)
-      var_on = "#{var}_on"
-      self.class.class_eval do
-        define_method(var_on) do |date|
-          time_vars.each do |tv_key, tv_val|
-            # 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
-          raise "Can't find #{var_on} for #{date}"
-        end
-      end
-      instance_variable_set("@#{var}", vals) if vals
+      new_data_var(var, vals)
     end
   end
 

data/lib/simple_time_series/version.rb

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

data/spec/lib/simple_time_series_spec.rb

@@ -11,28 +11,28 @@ describe SimpleTimeSeries do
     @tasks_done = [2, 3, 0, 14, 3, 11, 0]
     @my_data = SimpleTimeSeries.new(:data_vars =>
                                        {'pizzas' => @pizzas, 'miles' => @miles,
-                                        'tasks_done' => @tasks_done},
+                                        'tasks_done' => @tasks_done, 'empty' => []},
                                     :time_vars =>
                                        {'dows' => @dows, 'dates' => @dates,
                                         'full_dates' => @full_dates})
   end
 
-  it "should be creatable" do
+  it "is creatable" do
     @my_data.should be_a(SimpleTimeSeries)
   end
 
-  it "should set #time_vars correctly" do
+  it "sets #time_vars correctly" do
     @my_data.time_vars["dates"].should == @dates
     @my_data.time_vars["dows"].should == @dows
   end
 
-  it "should have the correct methods" do
+  it "has the correct methods" do
     [:time_vars, :time_vars=, :data_vars, :data_vars=, :find, :pizzas, :pizzas=, :pizzas_on, :miles, :miles=, :miles_on, :tasks_done, :tasks_done=, :tasks_done_on, :dows, :dows=, :dates, :dates=].each do |mthd|
       @my_data.methods.should include(mthd)
     end
   end
 
-  it "should create accessor methods for looking up data values for any time observation" do
+  it "creates accessor methods for looking up data values for any time observation" do
     @my_data.pizzas_on('Tuesday').should == 1
     @my_data.pizzas_on('Thursday').should == 0.5
     @my_data.miles_on('Sunday').should == 2.2
@@ -40,7 +40,7 @@ describe SimpleTimeSeries do
     @my_data.tasks_done_on('2014-01-02').should == 3
   end
 
-  it "should #find any data value for any time observation" do
+  it "creates a #find method for finding any data value for any time observation" do
     @my_data.find('pizzas', 'Tuesday').should == 1
     @my_data.find('pizzas', 'Thursday').should == 0.5
     @my_data.find('miles', 'Sunday').should == 2.2
@@ -48,7 +48,7 @@ describe SimpleTimeSeries do
     @my_data.find('tasks_done', '2014-01-02').should == 3
   end
 
-  it "should create setter methods for updating a data series" do
+  it "creates 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
@@ -59,7 +59,7 @@ describe SimpleTimeSeries do
 
   describe "#current" do
 
-    it "should print the current array for any data variable" do
+    it "prints the current array for any data variable" do
       @my_data.current('pizzas').should == @pizzas
     end
 
@@ -67,7 +67,7 @@ describe SimpleTimeSeries do
 
   describe "#index_of_date_value" do
 
-    it "should return the array index of any date value" do
+    it "returns 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
@@ -77,7 +77,7 @@ describe SimpleTimeSeries do
 
   describe "#set" do
 
-    it "should allow updating a single data series value" do
+    it "updates 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
@@ -88,6 +88,59 @@ describe SimpleTimeSeries do
       @my_data.tasks_done_on('Jan 7, 2014').should == 77
     end
 
+    it "lets you build up a data series datapoint by datapoint" do
+      @my_data.current('empty').should == []
+      @my_data.set('empty', 'Jan 1, 2014', 1)
+      @my_data.set('empty', 'Monday', 2)
+      @my_data.set('empty', '2014-01-03', 3)
+      @my_data.set('empty', 'Jan 4, 2014', 4)
+      @my_data.set('empty', 'Thursday', 5)
+      @my_data.set('empty', '2014-01-06', 6)
+      @my_data.set('empty', 'Jan 7, 2014', 7)
+      @my_data.current('empty').should == [1, 2, 3, 4, 5, 6, 7]
+    end
+
+    it "lets you build up a data series datapoint by datapoint in any order" do
+      @my_data.current('empty').should == []
+      @my_data.set('empty', '2014-01-06', 6)
+      @my_data.set('empty', 'Jan 4, 2014', 4)
+      @my_data.set('empty', 'Jan 1, 2014', 1)
+      @my_data.set('empty', '2014-01-03', 3)
+      @my_data.set('empty', 'Thursday', 5)
+      @my_data.set('empty', 'Jan 7, 2014', 7)
+      @my_data.set('empty', 'Monday', 2)
+      @my_data.current('empty').should == [1, 2, 3, 4, 5, 6, 7]
+      @my_data.empty.should == [1, 2, 3, 4, 5, 6, 7]
+    end
+
+  end
+
+  describe "#new_time_var" do
+
+    it "lets you create a new time variable after object instantiation" do
+      @my_data.new_time_var('short_dow',['Sun', 'Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'])
+      @my_data.tasks_done_on('Fri').should == 11
+      @my_data.pizzas_on('Thurs').should == 0.5
+    end
+
+  end
+
+  describe "#new_data_var" do
+
+    it "lets you create a new data variable after object instantiation" do
+      @my_data.new_data_var('hours_of_tv',[7, 3, 3.5, 3, 4, 6.5, 11])
+      @my_data.hours_of_tv.should == [7, 3, 3.5, 3, 4, 6.5, 11]
+      @my_data.hours_of_tv_on('Friday').should == 6.5
+      @my_data.hours_of_tv_on('2014-01-01').should == 7
+    end
+
+    it "lets you use a new data variable with a new time variable" do
+      @my_data.new_time_var('short_dow',['Sun', 'Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat'])
+      @my_data.new_data_var('hours_of_tv',[7, 3, 3.5, 3, 4, 6.5, 11])
+      @my_data.hours_of_tv_on('Fri').should == 6.5
+      @my_data.hours_of_tv_on('Sun').should == 7
+    end
+
   end
 
 end

metadata

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