time_elapser 0.0.1

data/.document

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

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+gem 'rspec'
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+end

data/Gemfile.lock

@@ -0,0 +1,26 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.1)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Edwin Cruz
+
+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.rdoc

@@ -0,0 +1,38 @@
+= time_elapser
+
+Time-elapser Create timestamps query caching friendly
+
+== Usage
+TimeElapser.sanitize(interval)
+
+*interval means how often it is going to change
+
+== Example - Rails
+
+Product.find(:all, :conditions => ['available_date <= ?', TimeElapser.sanitize(5)])
+
+This will create queries during between 2000-01-01 00:00:00 and 2000-01-01 00:00:04 like this:
+
+select * from products where available_date = '2000-01-01 00:00:00'
+
+Allowing query cache to actually cache the results longer.
+
+== TODO
+
+* Support TimeZone for non rails applications
+
+== Contributing to time_elapser
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2010 CrowdInt. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "time_elapser"
+  gem.homepage = "http://github.com/crowdint/time_elapser"
+  gem.license = "MIT"
+  gem.summary = "Time-elapser Query cache helper"
+  gem.description = "Helper to create queries using time intervals helping databases to cache most used queries easier"
+  gem.email = "edwin.cruz@crowdint.com"
+  gem.authors = ["Edwin Cruz"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "time_elapser #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/time_elapser.rb

@@ -0,0 +1,25 @@
+##
+ # TimeElapser
+ # Returns time in windows, making easier to query caching to save results
+ ##
+class TimeElapser
+
+  # Saninitize current time and returns an starting point of time every interval (in seconds)
+  #
+  # *Example*
+  #
+  # If you want to cache results for 5 seconds, do this:
+  # 
+  # @products = Product.find(:all, :conditions => ['available_date <= ?', TimeElapser.sanitize(5)])
+  #
+  # If RAILS_ROOT is defined, it will use Time.zone.now, otherwise it will use Time.now
+  #
+  def self.sanitize interval = 1
+    now = (defined?(RAILS_ROOT)) ? Time.zone.now : Time.now
+    if interval > 1
+      Time.at((now.to_i/interval)*interval)
+    else
+      now
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'time_elapser'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end
+

data/spec/time_elapser_spec.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe TimeElapser do
+
+  subject { TimeElapser }
+
+  context 'time elapser initialized without parameters' do
+    it 'should return the current date if no params are provided' do
+      Time.stub(:now).and_return(Time.at(946757701))
+      subject.sanitize.to_i.should eq(946757701)
+    end
+  end
+
+  context 'time elapser ready for query caching' do
+    it 'should return a second cero for the next 5 seconds' do
+      [946757700, 946757701, 946757702, 946757703, 946757704].each do |local_time|
+        Time.stub(:now).and_return(Time.at(local_time))
+        subject.sanitize(5).to_i.should eq(946757700)
+      end
+    end
+
+    it 'should jump to the next window when it has to' do
+      Time.stub(:now).and_return(Time.at(946757705))
+      subject.sanitize(5).to_i.should_not eq(946757700)
+    end
+  end
+
+  context 'time elapser initialized without parameters and rails is used' do
+    before(:each) do
+      RAILS_ROOT = true
+      @time_zone = mock('TimeZone')
+    end
+    it 'should return the current date if no params are provided' do
+      @time_zone.stub(:now).and_return(Time.at(946757701))
+      Time.stub(:zone).and_return(@time_zone)
+      subject.sanitize.to_i.should eq(946757701)
+    end
+
+    it 'should return a second cero for the next 5 seconds' do
+      [946757700, 946757701, 946757702, 946757703, 946757704].each do |local_time|
+        @time_zone.stub(:now).and_return(Time.at(local_time))
+        Time.stub(:zone).and_return(@time_zone)
+        subject.sanitize(5).to_i.should eq(946757700)
+      end
+    end
+
+    it 'should jump to the next window when it has to' do
+      @time_zone.stub(:now).and_return(Time.at(946757706))
+      Time.stub(:zone).and_return(@time_zone)
+      subject.sanitize(5).to_i.should_not eq(946757700)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification 
+name: time_elapser
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Edwin Cruz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-14 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id001
+  prerelease: false
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  requirement: *id002
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 1
+        - 5
+        - 1
+        version: 1.5.1
+  requirement: *id003
+  prerelease: false
+  name: jeweler
+description: Helper to create queries using time intervals helping databases to cache most used queries easier
+email: edwin.cruz@crowdint.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/time_elapser.rb
+- spec/spec_helper.rb
+- spec/time_elapser_spec.rb
+has_rdoc: true
+homepage: http://github.com/crowdint/time_elapser
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: Time-elapser Query cache helper
+test_files: 
+- spec/spec_helper.rb
+- spec/time_elapser_spec.rb