mongoid-metastamp 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/README.md

@@ -0,0 +1,31 @@
+Mongoid Metastamp
+=========================
+
+This gem provides Mongoid with enhanced meta-timestamps which allow querying by day, month, year, min, sec, or even by local vs. universal timezone.
+
+What It Does
+=========================
+(Or why would I want to use this?)
+
+Storing simple timestamps is all well and good if you only need to search inside a continuous range relative to one timezone.
+Sometimes however, you might want to search for all events that occurred between 9 AM and 5 PM, but across multiple locations and timezones.
+
+So you could query all possible events between some range and then run a conversion on each result to narrow it down, but that makes servers die and developers cry.
+With mongoid-metastamp you get a custom timestamp field that performs conversions when you save, and then stores the metadata in a MongoDB friendly way for easy querying.
+
+Storage
+=========================
+(What metadata should we store?)
+
+* in_zone (Date)
+* normalized (Date)
+* year (Int)
+* month (Int)
+* day (Int)
+* hour (Int)
+* min (Int)
+* sec (Int)
+* time_zone (String)
+
+
+(More to come)

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/mongoid-metastamp.rb

@@ -0,0 +1 @@
+require "mongoid/metastamp"

data/lib/mongoid/core_ext.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+module Mongoid #:nodoc
+  module Fields #:nodoc:
+    module Mappings #:nodoc:
+
+      def for(klass, foreign_key = false)
+        return Serializable::Object unless klass
+        if foreign_key
+          return "#{MODULE}::ForeignKeys::#{klass.to_s.demodulize}".constantize
+        end
+        begin
+          modules = "#{MODULE}::|BSON::|ActiveSupport::"
+          if match = klass.to_s.match(Regexp.new("^(#{ modules })?(\\w+)$"))
+            "#{MODULE}::#{match[2]}".constantize
+          else
+            klass.to_s.constantize
+          end
+        rescue NameError
+          klass
+        end
+      end
+
+    end
+  end
+end

data/lib/mongoid/metastamp.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require "mongoid"
+require "mongoid/core_ext"
+
+require "mongoid/metastamp/time"
+
+module Mongoid #:nodoc:
+  module Metastamp
+  end
+end

data/lib/mongoid/metastamp/time.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+module Mongoid #:nodoc:
+  module Metastamp
+    class Time
+      include Mongoid::Fields::Serializable
+      include Mongoid::Fields::Serializable::Timekeeping
+
+      def deserialize(object)
+        return nil if object.blank?
+        super(object[:in_zone])
+      end
+
+      def serialize(object)
+        time = super(object)
+        normalized_time = normalize_time(object)
+        { 
+          in_zone:      time,
+          normalized:   normalized_time,
+          year:         normalized_time.year,
+          month:        normalized_time.month,
+          day:          normalized_time.day,
+          hour:         normalized_time.hour,
+          min:          normalized_time.min,
+          sec:          normalized_time.sec
+        }
+      end
+
+    protected
+
+      def normalize_time(object)
+        case object
+          when ::String
+            time = ::Time.parse(object)
+          when ::DateTime
+            time = ::Time.new(object.year, object.month, object.day, object.hour, object.min, object.sec)
+          when ::Date
+            time = ::Time.new(object.year, object.month, object.day)
+          when ::Array
+            time = ::Time.new(*object)
+          else
+            time = object
+        end
+        ::Time.parse(time.iso8601.sub(/-(\d\d:\d\d)$/, "-00:00"))
+      end
+    end
+  end
+end

data/lib/mongoid/metastamp/version.rb

@@ -0,0 +1,5 @@
+module Mongoid #:nodoc:
+  module Metastamp
+    VERSION = "0.0.1"
+  end
+end

data/mongoid-metastamp.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongoid/metastamp/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongoid-metastamp"
+  s.version     = Mongoid::Metastamp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Peter Gumeson"]
+  s.email       = ["gumeson@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/mongoid-metastamp"
+  s.summary     = %q{ Store and query more useful information about your Mongoid timestamps }
+  s.description = %q{ Provides enhanced meta-timestamps for mongoid that allow querying by day, month, year, min, sec, or by local vs. universal timezone. }
+
+  s.rubyforge_project = "mongoid-metastamp"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency("mongoid", "~> 2.1")
+  s.add_development_dependency("bson_ext", "~> 1.3")
+  s.add_development_dependency("rake", "~> 0.9")
+  s.add_development_dependency("rspec", "~> 2.6")
+end

data/spec/metastamp_spec.rb

@@ -0,0 +1,57 @@
+#encoding: utf-8
+
+require "spec_helper"
+
+describe Mongoid::Metastamp do
+
+  let :ten_am_utc do
+    "2011-10-05T10:00:00-00:00"
+  end
+
+  let :ten_am_eastern do
+    "2011-10-05T10:00:00-04:00"
+  end
+
+  let :ten_am_pacific do
+    "2011-10-05T10:00:00-07:00"
+  end
+
+  describe "with custom field of type Mongoid::Metastamp::Time" do
+
+    context "named timestamp" do
+
+      context "when set to 10:00 AM PST" do
+
+        let :pst_event do
+          Event.create(timestamp: ten_am_pacific)
+        end
+
+        it "should have a timestamp field" do
+          pst_event.should respond_to(:timestamp)
+        end
+
+        it "should deserialize the timestamp as 10 AM PST" do
+          pst_event.timestamp.should == Time.parse(ten_am_pacific)
+        end
+
+        it "should be searchable by timestamp.in_zone" do
+          Event.where(
+            "timestamp.in_zone" => { '$gt' => Time.parse(ten_am_pacific) - 1.minute },
+            "timestamp.in_zone" => { '$lt' => Time.parse(ten_am_pacific) + 1.minute }
+          ).should == [pst_event]
+        end
+
+        it "should be searchable by timestamp.normalized" do
+          Event.where(
+            "timestamp.normalized" => { '$gt' => Time.parse(ten_am_utc) - 1.minute },
+            "timestamp.normalized" => { '$lt' => Time.parse(ten_am_utc) + 1.minute }
+          ).should == [pst_event]
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/models/event.rb

@@ -0,0 +1,4 @@
+class Event
+  include Mongoid::Document
+  field :timestamp, type: Mongoid::Metastamp::Time
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+require "rubygems"
+require "bundler/setup"
+
+require "mongoid"
+require "mongoid/core_ext"
+
+require "mongoid/metastamp"
+require "mongoid/metastamp/time"
+
+require "rspec"
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("mongoid_metastamp_test")
+  config.use_utc = false
+  config.use_activesupport_time_zone = true
+end
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |f| require f }
+
+RSpec.configure do |c|
+  c.before(:each) do
+    ::Time.zone = "UTC"
+    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:remove)
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid-metastamp
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Gumeson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-08 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.9"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.6"
+  type: :development
+  version_requirements: *id004
+description: " Provides enhanced meta-timestamps for mongoid that allow querying by day, month, year, min, sec, or by local vs. universal timezone. "
+email: 
+- gumeson@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/mongoid-metastamp.rb
+- lib/mongoid/core_ext.rb
+- lib/mongoid/metastamp.rb
+- lib/mongoid/metastamp/time.rb
+- lib/mongoid/metastamp/version.rb
+- mongoid-metastamp.gemspec
+- spec/metastamp_spec.rb
+- spec/models/event.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/mongoid-metastamp
+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: mongoid-metastamp
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Store and query more useful information about your Mongoid timestamps
+test_files: 
+- spec/metastamp_spec.rb
+- spec/models/event.rb
+- spec/spec_helper.rb