asdrubal 0.1.0

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in date_edge_detection.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 $GIT_AUTHOR_NAME
+
+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,35 @@
+# Asdrúbal
+
+A simple helper for time series manipulation and analysis.
+
+Asdrúbal allows you to create a time series with values and perform simple analysis on it.
+
+Currently, the only analysis it does is "burst of values". Using a given "time span" (let's say 2 days) it consider the that any date with value > 0 at maximum 2 dates of distance behind and ahead is part of the same "burst".
+
+The current purpose of this analysis is to find the period an applicant is looking for a job :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'asdrubal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install asdrubal
+
+## Usage
+
+TODO: Okay, I'll put something here as soon I have time. You you really want to use it as is, chech "spec" directory ;)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/asdrubal.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/asdrubal/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Ronie Uliana']
+  gem.email         = ['ronie.uliana@gmail.com']
+  gem.description   = %q{Simple helper for time series analysis}
+  gem.summary       = %q{Asdrúbal is a simple helper that takes dates and values and allows you to ask more information about a point in time.}
+  gem.homepage      = ''
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'asdrubal'
+  gem.require_paths = ['lib']
+  gem.version       = Asdrubal::VERSION
+
+  gem.add_development_dependency 'rb-inotify', '~> 0.8'
+  gem.add_development_dependency 'rspec', '~> 2.11'
+  gem.add_development_dependency 'guard-rspec', '~> 1.2'
+end

data/lib/asdrubal.rb

@@ -0,0 +1,2 @@
+require 'asdrubal/version'
+require 'asdrubal/time_series'

data/lib/asdrubal/time_series.rb

@@ -0,0 +1,130 @@
+class TimeSeries
+  attr_accessor :smooth_window
+
+  def initialize(from_date, to_date = from_date, step_days = 1)
+    @span = (from_date..to_date)
+    @step = step_days
+    @dates = Hash.new(0)
+    self.smooth_window = 2
+  end
+
+  def self.from(year, month, day)
+    TimeSeries.new to_date(year, month, day)
+  end
+
+  def to(year, month, day)
+    TimeSeries.new @span.first, self.class.to_date(year, month, day)
+  end
+
+  def step(days)
+    @step = days
+    self
+  end
+
+  def each
+    @span.step(@step).each do |date|
+      yield date, self[date]
+    end
+  end
+
+  def include?(date)
+    @span.include?(date)
+  end
+
+  def at(date)
+    refresh_cache
+    @cache[date]
+  end
+
+  def [](date)
+    raise Exception.new('Out of range') unless include?(date)
+    refresh_cache
+    at(date).value
+  end
+
+  def []=(date, value)
+    raise Exception.new('Out of range') unless include?(date)
+    reset_cache
+    @dates[date] = value
+  end
+
+private
+  def self.to_date(year, month, day)
+    Date.new year, month, day
+  end
+
+  def to_value(date, previous = nil)
+    Value.new(self, date, @dates[date], previous)
+  end
+
+  def reset_cache
+    @cache = nil
+  end
+
+  def refresh_cache
+    return if @cache
+
+    @cache = Hash.new
+
+    previous = to_value(@span.first)
+    @cache[@span.first] = previous
+
+    @span.step(@step).drop(1).each do |date|
+      current = to_value(date, previous)
+      @cache[date] = current
+
+      previous = current
+    end
+  end
+end
+
+class Value
+  attr_reader :value
+  attr_accessor :previous, :next
+
+  def initialize(parent, date, value, previous = nil)
+    @parent, @date, @value = parent, date, value || 0
+    @previous = previous
+    previous.next = self if previous
+  end
+
+  def signal
+    self.value > 0 ? 1 : 0
+  end
+
+  def smooth_signal
+    return 1 if self.signal == 1
+
+    if any_signal_behind? && any_signal_ahead?
+      1
+    else
+      0
+    end
+  end
+
+  # Warning: recursion ahead
+  def any_signal_behind?
+
+    def any_before(value, steps)
+      return false if steps <= 0 || value.nil?
+      value.signal == 1 || any_before(value.previous, steps - 1)
+    end
+
+    any_before(self.previous, @parent.smooth_window)
+  end
+
+  # Warning: recursion ahead
+  def any_signal_ahead?
+
+    def any_after(value, steps)
+      return false if steps <= 0 || value.nil?
+      value.signal == 1 || any_after(value.next, steps - 1)
+    end
+
+    any_after(self.next, @parent.smooth_window)
+  end
+
+  def to_s
+    "#{@date.strftime('%Y-%m-%d')} = #{@value}"
+  end
+end

data/lib/asdrubal/version.rb

@@ -0,0 +1,3 @@
+module Asdrubal
+  VERSION = "0.1.0"
+end

data/spec/lib/asdrubal/time_series_spec.rb

@@ -0,0 +1,65 @@
+require_relative '../../../lib/asdrubal.rb'
+describe TimeSeries do
+  describe 'basic features' do
+    let(:time_series) { TimeSeries.from(2000, 12, 31).to(2001, 1, 1) }
+    it 'is initially filled with zeros' do
+      expect(time_series[Date.new(2000, 12, 31)]).to be_equal(0)
+      expect(time_series.at(Date.new(2000, 12, 31)).value).to be_equal(0)
+
+      expect(time_series[Date.new(2001, 1, 1)]).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 1)).value).to be_equal(0)
+    end
+    it 'checks if date is in the time series' do
+      expect { time_series[Date.new(2001, 1, 2)] }.to raise_exception
+      expect { time_series.at(Date.new(2001, 1, 2).value) }.to raise_exception
+    end
+    it 'allow put values in any date' do
+      time_series[Date.new(2000, 12, 31)] = 99
+      expect(time_series[Date.new(2000, 12, 31)]).to equal(99)
+      expect(time_series.at(Date.new(2000, 12, 31)).value).to equal(99)
+    end
+  end
+  describe 'calculations' do
+    let(:time_series) do
+      time_series = TimeSeries.from(2001, 1, 1).to(2001, 1, 8)
+      time_series[Date.new(2001, 1, 4)] = 9999
+      time_series[Date.new(2001, 1, 7)] = 1
+      time_series
+    end
+    it 'mark any non zero value as "signal = 1"' do
+      expect(time_series.at(Date.new(2001, 1, 3)).signal).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 4)).signal).to be_equal(1)
+      expect(time_series.at(Date.new(2001, 1, 5)).signal).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 6)).signal).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 7)).signal).to be_equal(1)
+      expect(time_series.at(Date.new(2001, 1, 8)).signal).to be_equal(0)
+    end
+    it 'try to detect "bursts" of values' do
+      time_series.smooth_window = 2
+      expect(time_series.at(Date.new(2001, 1, 1)).smooth_signal).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 2)).smooth_signal).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 3)).smooth_signal).to be_equal(0)
+      expect(time_series.at(Date.new(2001, 1, 4)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2001, 1, 5)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2001, 1, 6)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2001, 1, 7)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2001, 1, 8)).smooth_signal).to be_equal(0)
+    end
+  end
+  describe 'weekly time series' do
+    let(:time_series) do
+      time_series = TimeSeries.from(2012, 3, 11).to(2012, 4, 8).step(7)
+      time_series[Date.new(2012, 3, 11)] = 3
+      time_series[Date.new(2012, 4,  8)] = 127
+      time_series
+    end
+    it 'has no difference from "by day" use' do
+      time_series.smooth_window = 3
+      expect(time_series.at(Date.new(2012, 3, 11)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2012, 3, 18)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2012, 3, 25)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2012, 4,  1)).smooth_signal).to be_equal(1)
+      expect(time_series.at(Date.new(2012, 4,  8)).smooth_signal).to be_equal(1)
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: asdrubal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ronie Uliana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rb-inotify
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: Simple helper for time series analysis
+email:
+- ronie.uliana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- asdrubal.gemspec
+- lib/asdrubal.rb
+- lib/asdrubal/time_series.rb
+- lib/asdrubal/version.rb
+- spec/lib/asdrubal/time_series_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Asdrúbal is a simple helper that takes dates and values and allows you to
+  ask more information about a point in time.
+test_files:
+- spec/lib/asdrubal/time_series_spec.rb