acts_as_historical 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+coverage.data
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [name of plugin creator]
+
+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

@@ -0,0 +1,13 @@
+ActsAsHistoric
+==============
+
+Introduction goes here.
+
+
+Example
+=======
+
+Example goes here.
+
+
+Copyright (c) 2009 [name of plugin creator], released under the MIT license

data/README.rdoc

@@ -0,0 +1,17 @@
+= acts_as_historical
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 hasclass. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+  require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_historical"
+    gem.summary = %Q{ActiveRecord plugin for historical data (stock prices, pageviews, etc).}
+    gem.description = %Q{}
+    gem.email = "sebastian.burkhard@gmail.com"
+    gem.homepage = "http://github.com/hasclass/acts_as_historical"
+    gem.authors = ["hasclass"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test' << 'rails'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/*_test.rb'
+    test.rcov_opts = %w{--rails --exclude osx\/objc,gems\/,spec\/,features\/ --aggregate coverage.data}
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_historical #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/acts_as_historical.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_historical}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["hasclass"]
+  s.date = %q{2010-01-11}
+  s.description = %q{}
+  s.email = %q{sebastian.burkhard@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_historical.gemspec",
+     "lib/acts_as_historical.rb",
+     "rails/init.rb",
+     "test/acts_as_historical_test.rb",
+     "test/database.yml",
+     "test/schema.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/hasclass/acts_as_historical}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ActiveRecord plugin for historical data (stock prices, pageviews, etc).}
+  s.test_files = [
+    "test/acts_as_historical_test.rb",
+     "test/schema.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/acts_as_historical.rb

@@ -0,0 +1,184 @@
+
+module ActsAsHistorical
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    
+    # acts_as_historical
+    # 
+    #
+    # @option opts [Symbol] :date_column (:snapshot_date) the database column for the date of the record 
+    # @option opts [Symbol] :days (:all_days) what days are records valid. 
+    # @option opts [Symbol] :scope (nil)
+    #
+    def acts_as_historical(opts = {})
+      configuration = { 
+        :date_column => "snapshot_date",
+        :days => :all_days,
+        :scope => nil
+      }
+      configuration.update(options) if opts.is_a?(Hash)
+
+      send :include, InstanceMethods
+      send :extend, DynamicClassMethods
+      
+      case configuration[:days].to_sym
+      when :all_days
+        send :extend, AllDays::ClassMethods
+      when :weekdays
+        send :extend, WeekDays::ClassMethods
+      end
+      self.cattr_accessor :historical_date_col, :historical_scope, :only_weekdays
+      self.historical_date_col = configuration[:date_column]
+      self.historical_scope    = configuration[:scope]
+      
+      order_desc = "#{self.historical_date_col_sql} DESC"
+      order_asc = "#{self.historical_date_col_sql} ASC"
+      
+      default_scope :order => order_desc
+      
+      # named_scopes - sortings
+      named_scope :asc,  :order => order_asc
+      named_scope :desc, :order => order_desc
+
+      named_scope :oldest,        :limit => 1, :order => order_asc
+      named_scope :newest,        :limit => 1
+      named_scope :newest_two,    :limit => 2
+    
+      # one snapshot per week (every wednesday)      
+      named_scope :weekly,
+                  :conditions => "DAYOFWEEK(#{self.historical_date_col_sql}) = 2"
+
+      %w[sundays mondays tuesdays wednesdays thursdays fridays saturdays].each_with_index do |name, day_of_week|
+        named_scope name,
+                    :conditions => "DAYOFWEEK(#{self.historical_date_col_sql}) = #{day_of_week+1}"
+      end
+
+      named_scope :within_month, lambda {{
+          :conditions => ["#{self.historical_date_col_sql} > ?", Date.today - 30]
+      }}
+
+      named_scope :within_year, lambda {{
+          :conditions => ["#{self.historical_date_col_sql} > ?", Date.today - 364]
+      }}
+
+      named_scope :same_scope, lambda {|record| 
+        if self.historical_scope.nil?
+          {}
+        else
+          {:conditions => {self.historical_scope => record[self.historical_scope]} }
+        end
+      }
+
+      named_scope :at_date, lambda {|date| {
+          :conditions => { :snapshot_date => date },
+          :limit => 1
+      }}
+
+      named_scope :between, lambda {|*args|
+        from, to = args
+        range = from.to_date..to.to_date
+        {
+          :conditions => {self.historical_date_col => range }
+      }}
+      
+      
+      # nearest(date, 1)
+      # nearest(date, (date_from..date_to))
+      #
+      named_scope :nearest, lambda {|*args| 
+        date = args.first.to_date
+        range = self.tolerance_to_range(date, args[1])
+        
+        {
+          :conditions => {self.historical_date_col => range},
+          :order => ["ABS(DATEDIFF(#{self.historical_date_col_sql}, '#{date.to_s(:db)}')) ASC"]
+      }}
+
+      # TODO
+      named_scope :until
+      named_scope :from
+      
+      named_scope :opt, lambda {|attributes_for_select| {:select => [:snapshot_date, attributes_for_select].flatten.uniq.join(', ') } }
+
+      # validations
+      validate :valid_date?, :on => :save
+      nil
+    end
+  end
+
+  module DynamicClassMethods
+    def historical_date_col_sql
+      "`#{self.table_name}`.`#{self.historical_date_col}`"
+    end
+    
+    def tolerance_to_range(date,range)
+      if range.is_a?(Numeric)
+        range = (date - range)..(date + range)
+      elsif range.respond_to?(:to_date_range)
+        range = range.to_date_range
+      elsif range.is_a?(Range)
+        range
+      end
+    end
+  end
+
+  module InstanceMethods
+    def valid_date?
+      if snapshot_date.nil?
+        errors.add_to_base('snapshot_date missing')
+        return false
+      end
+      if self.class.only_weekdays and snapshot_date and snapshot_date.cwday >= 6
+        errors.add_to_base('snapshot_date is not a weekday')
+        return false
+      end
+      if self.snapshot_date >= Date.tomorrow
+        errors.add_to_base('snapshot_date is in future')
+        return false
+      end
+      true
+    end
+    
+    def previous; find_record_at(prev_day);   end
+    def next;     find_record_at(next_day);   end
+
+    def to_date
+      self.send(self.class.historical_date_col)
+    end
+    
+    private
+    def find_record_at(date)
+      self.class.at_date(date).same_scope(self).find(:first)
+    end    
+    
+    def next_day; self.class.step_date(to_date,  1); end
+    def prev_day; self.class.step_date(to_date, -1); end  
+  end
+  
+  module AllDays
+    module ClassMethods
+      def step_date(date, step_size)
+        date + step_size
+      end
+    end
+  end
+  
+  module WeekDays
+    module ClassMethods
+      def step_date(date, step_size)
+        date = date + step_size
+        while date.cwday > 5
+          date = step_size < 0 ? date - 1 : date + 1
+        end
+        date
+      end
+    end
+  end
+
+end
+
+ActiveRecord::Base.send :include, ActsAsHistorical

data/rails/init.rb

@@ -0,0 +1,3 @@
+# Include hook code here
+require 'acts_as_historical'
+

data/test/acts_as_historical_test.rb

@@ -0,0 +1,153 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class ActsAsHistoricalTest < ActiveSupport::TestCase
+  load_schema 
+  
+  class Record < ActiveRecord::Base
+    acts_as_historical
+  end
+
+  class RecordWeekday < ActiveRecord::Base
+    acts_as_historical :days => :weekdays
+  end
+  
+  def test_schema_has_loaded_correctly 
+    assert Record.all
+  end 
+  
+  def test_to_date
+    date = Date.today
+    assert_equal Record.create(:snapshot_date => date).to_date, date
+  end
+
+  context 'named_scopes with 5 weekdays' do
+    setup {
+      Record.delete_all
+      @mon = Date.new(2009,11,30)
+      @tue = Date.new(2009,12,1)
+      @wed = Date.new(2009,12,2)
+      @thu = Date.new(2009,12,3)
+      @fri = Date.new(2009,12,4)
+    
+      @r_mon = Record.create! :snapshot_date => @mon
+      @r_tue = Record.create! :snapshot_date => @tue    
+      @r_wed = Record.create! :snapshot_date => @wed
+      @r_thu = Record.create! :snapshot_date => @thu
+      @r_fri = Record.create! :snapshot_date => @fri      
+    }
+    
+    should "create 5 records" do
+      assert_equal 5, Record.count
+    end
+    
+    context "nearest" do
+      should "always return monday no matter what tolerance range" do
+        assert_equal @r_mon, Record.nearest(@mon-1, 1).first
+        assert_equal @r_mon, Record.nearest(@mon, 0).first
+        assert_equal @r_mon, Record.nearest(@mon, 1).first
+        assert_equal @r_mon, Record.nearest(@mon, 2).first
+      end
+
+      should "return nothing when no records within range" do
+        Record.stubs(:only_weekdays).returns(false)
+        assert Record.nearest(@mon - 1, 0).empty?
+        assert Record.nearest(@fri + 1, 0).empty?
+      end
+    end
+  
+    context "within" do
+      setup { @records = Record.between(@tue, @wed)}
+      
+      should "include only days within range" do
+        assert  @records.include?(@r_tue)
+        assert  @records.include?(@r_wed)
+        assert !@records.include?(@r_mon)
+        assert !@records.include?(@r_thu)
+        assert !@records.include?(@r_fri)
+      end
+      
+      should "return record when range start and end are the same" do
+        assert  Record.between(@mon, @mon).include?(@r_mon)
+      end
+    end
+  end
+
+  context ":days => :weekdays" do
+    context "day present" do
+      setup {
+        RecordWeekday.delete_all
+        @old = RecordWeekday.create! :snapshot_date => Date.new(2009,12,4)
+        @new = RecordWeekday.create! :snapshot_date => Date.new(2009,12,7)
+      }
+      context "#previous" do
+        should "return record of previous weekday" do
+          assert_equal @old, @new.previous
+        end
+      end
+      context "#next" do
+        should "return record of next weekday" do
+          assert_equal @new, @old.next
+        end
+      end
+    end
+  
+    context "day missing" do
+      setup {
+        RecordWeekday.delete_all
+        @record = RecordWeekday.create! :snapshot_date => Date.new(2009,12,3)
+      }
+      context "#previous" do
+        should "return nil if record on previous weekday" do
+          assert_equal nil, @record.previous
+        end
+      end
+    
+      context "#next" do
+        should "return nil if record on next weekday" do
+          assert_equal nil, @record.next
+        end
+      end
+    end
+  end
+  
+  context ":days => :all_days" do
+    context "day present" do
+      setup {
+        Record.delete_all
+        @old = Record.create! :snapshot_date => Date.new(2009,12,3)
+        @new = Record.create! :snapshot_date => Date.new(2009,12,4)
+      }
+      context "#previous" do
+        should "return record of previous day" do
+          assert_equal @old, @new.previous
+        end
+      end
+      context "#next" do
+        should "return record of next day" do
+          assert_equal @new, @old.next
+        end
+      end
+    end
+  
+    context "day missing" do
+      setup {
+        Record.delete_all
+        @record = Record.create! :snapshot_date => Date.new(2009,12,3)
+      }
+      context "#previous" do
+        should "return nil if record on previous day" do
+          assert_equal nil, @record.previous
+        end
+      end
+    
+      context "#next" do
+        should "return nil if record on next day" do
+          assert_equal nil, @record.next
+        end
+      end
+    end
+  end
+
+
+
+end

data/test/database.yml

@@ -0,0 +1,6 @@
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: 
+  :database: acts_as_historic_plugin_test

data/test/schema.rb

@@ -0,0 +1,8 @@
+ActiveRecord::Schema.define(:version => 0) do  
+  create_table :records, :force => true do |t|     
+    t.string :snapshot_date  
+  end 
+  create_table :record_weekdays, :force => true do |t|     
+    t.string :snapshot_date  
+  end 
+end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'active_record'
+require 'active_record/fixtures'
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'redgreen'
+
+ENV['RAILS_ENV'] = 'test'
+#ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+#require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+def load_schema
+  config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+
+  db_adapter = ENV['DB']
+
+  # no db passed, try one of these fine config-free DBs before bombing.
+  db_adapter ||= 'mysql'
+
+  if db_adapter.nil?
+    raise "No DB Adapter selected. Pass the DB= option to pick one, or install Sqlite or Sqlite3."
+  end
+
+  ActiveRecord::Base.establish_connection(config[db_adapter])
+  #Fixtures.create_fixtures(File.dirname(__FILE__), ActiveRecord::Base.connection.tables)
+
+
+  load(File.dirname(__FILE__) + "/schema.rb")
+  require File.dirname(__FILE__) + '/../rails/init.rb'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_historical
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- hasclass
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-11 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: ""
+email: sebastian.burkhard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- acts_as_historical.gemspec
+- lib/acts_as_historical.rb
+- rails/init.rb
+- test/acts_as_historical_test.rb
+- test/database.yml
+- test/schema.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/hasclass/acts_as_historical
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ActiveRecord plugin for historical data (stock prices, pageviews, etc).
+test_files: 
+- test/acts_as_historical_test.rb
+- test/schema.rb
+- test/test_helper.rb