simple_time_series 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 854ef6e94d122e68388000a7c63705a989b20e3d
+  data.tar.gz: 827f82c991da060d9a2e3e46ac7b62f6ecd8e630
+SHA512:
+  metadata.gz: 6ce2c910fa78063cbfcb97f2432b0c08f469741d8554d2751c05bddbd80d83a0dca6c0efad1e493aea111e778d577cef01122a642ea1eb8157642036440b161b
+  data.tar.gz: 5af15fd7ce32aa5edc34d868edc5e333d1a9c6af9ba1c71ad4a32c79000cac3bc3f69b8364076e291013ff1bb4e30a5274d7885dd1a0d948df65401d58663213

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 James Lavin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# SimpleTimeSeries
+
+Packages a set of time series variables into an object that allows easy data access and manipulation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_time_series'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_time_series
+
+## Usage
+
+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):
+
+    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.)
+
+    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']
+
+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},
+                                   :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:
+
+    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')}"
+
+## Disclaimer
+
+This began as a simple code example for a collague who needed to do something similar. When he said he might actually use it, I decided to create this gem. But it's really simple, with very basic functionality.
+
+## Contributing
+
+1. Fork it ( http://github.com/JamesLavin/simple_time_series/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/lib/simple_time_series/simple_time_series.rb

@@ -0,0 +1,61 @@
+class SimpleTimeSeries
+  
+  attr_accessor :time_vars, :data_vars
+
+  def initialize(opts)
+    @time_vars = opts[:time_vars]
+    @data_vars = opts[:data_vars]
+    define_data_methods_and_set_values
+    define_time_methods_and_set_values
+  end
+
+  def find(what, date)
+    send (what + '_on').to_sym, date
+  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
+    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 '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
+    end
+  end
+
+  def define_getter_and_setter(var)
+    ivar = "@#{var}"
+    self.class.class_eval do
+      define_method(var) { instance_variable_get ivar }
+      define_method "#{var}=" do |val|
+        instance_variable_set ivar, val
+      end
+    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

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

data/lib/simple_time_series.rb

@@ -0,0 +1,3 @@
+require "simple_time_series/version"
+require "simple_time_series/simple_time_series"
+

data/simple_time_series.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_time_series/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_time_series"
+  spec.version       = SimpleTimeSeries::VERSION
+  spec.authors       = ["James Lavin"]
+  spec.email         = ["simple_time_series@futureresearch.com"]
+  spec.summary       = %q{Packages a set of time series variables into an object for easy data access and manipulation}
+  spec.description   = %q{Packages a set of time series variables into an object for easy data access and manipulation}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/lib/simple_time_series_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+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']
+    @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]
+    @my_data = SimpleTimeSeries.new(:data_vars =>
+                                       {'pizzas' => @pizzas, 'miles' => @miles,
+                                        'tasks_done' => @tasks_done},
+                                    :time_vars =>
+                                       {'dows' => @dows, 'dates' => @dates})
+  end
+
+  it "should be creatable" do
+    @my_data.should be_a(SimpleTimeSeries)
+  end
+
+  it "should set #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
+    [: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
+    @my_data.pizzas_on('Tuesday').should == 1
+    @my_data.pizzas_on('Thursday').should == 0.5
+    @my_data.miles_on('Sunday').should == 2.2
+    @my_data.miles_on('2014-01-06').should == 12.2
+    @my_data.tasks_done_on('2014-01-02').should == 3
+  end
+
+  it "should #find 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
+    @my_data.find('miles', '2014-01-06').should == 12.2
+    @my_data.find('tasks_done', '2014-01-02').should == 3
+  end
+
+  it "should create setter methods for updating a data series" do
+    @my_data.pizzas = [10, 11, 12, 13, 14, 15, 16]
+    @my_data.pizzas_on('Tuesday').should == 12
+    @my_data.pizzas_on('Thursday').should == 14
+    @my_data.pizzas_on('2014-01-04').should == 13
+    @my_data.pizzas_on('2014-01-07').should == 16
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'simple_time_series'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: simple_time_series
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Lavin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Packages a set of time series variables into an object for easy data
+  access and manipulation
+email:
+- simple_time_series@futureresearch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_time_series.rb
+- lib/simple_time_series/simple_time_series.rb
+- lib/simple_time_series/version.rb
+- simple_time_series.gemspec
+- spec/lib/simple_time_series_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2
+signing_key: 
+specification_version: 4
+summary: Packages a set of time series variables into an object for easy data access
+  and manipulation
+test_files:
+- spec/lib/simple_time_series_spec.rb
+- spec/spec_helper.rb