mongoid_occurrence_views 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ec270d211cd1ad0bc58b60980d77f4defff948f5c8bd0d63db70f450f1f7d5c7
+  data.tar.gz: 2b351998c8815c1d1cd0aa7af2778e44e390f606cd35ae140bf9b246abc20bdb
+SHA512:
+  metadata.gz: f915e5edb172f9a21bdb48bd1442fbcc677716212b9314e6463b93b0f6f755481bdf9a690bce663f623968edc0f312b1643d6e9f568e1420519583bb5dd277d2
+  data.tar.gz: b818d09e3c18d21b994a7250cf785ad898822d3d134cdc68e57b3e7844e39935b68b9a1ef8f4eeb1e6ff781c7b1031368a0bd551e52110a3979324c8f98ccf90

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 2.5.1
+services:
+  - mongodb
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never
+
+matrix:
+  include:
+    - rvm: 2.5.1
+      env: MONGOID_VERSION=7

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+* initial release

data/Gemfile

@@ -0,0 +1,11 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mongoid_occurrence_views.gemspec
+gemspec
+
+case version = ENV['MONGOID_VERSION'] || '~> 7.0'
+when /7/ then gem 'mongoid', '~> 7.0'
+else gem 'mongoid', version
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard :minitest do
+  watch(%r{^lib/(.+)\.rb$})                               { |m| "test/#{m[1]}_test.rb" }
+  watch(%r{^test/.+_test\.rb$})
+  watch(%r{^test/test_helper\.rb$})                       { 'test' }
+end

data/README.md

@@ -0,0 +1,136 @@
+# Mongoid Occurrence Views
+
+[![Build Status](https://travis-ci.org/tomasc/mongoid_occurrence_views.svg)](https://travis-ci.org/tomasc/mongoid_occurrence_views) [![Gem Version](https://badge.fury.io/rb/mongoid_occurrence_views.svg)](http://badge.fury.io/rb/mongoid_occurrence_views) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid_occurrence_views.svg)](https://coveralls.io/r/tomasc/mongoid_occurrence_views)
+
+By taking advantage of [Mongodb views](https://docs.mongodb.com/manual/core/views), this gem simplifies querying for events with multiple occurrences or a recurring schedule.
+
+## Requirements
+
+* Mongoid 7.1+
+* MongoDB 3.4+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_occurrence_views'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_occurrence_views
+
+## Usage
+
+### Occurrences
+
+Define a Mongoid document class that will hold information about each occurrence.
+
+```ruby
+class Occurrence
+  include Mongoid::Document
+  include MongoidOccurrenceViews::Event::Occurrence
+
+  embedded_in_event class_name: 'Event'
+end
+```
+
+This will create the following fields on `Occurrence`:
+
+* `dtstart`, (`DateTime`)
+* `dtend` (`DateTime`)
+* `schedule` (`MongoidIceCubeExtension::Schedule`)
+
+And the `all_day` (`Boolean`) `attr_accessor`, which is useful for user-facing forms.
+
+### Events
+
+```ruby
+class Event
+  include Mongoid::Document
+  include MongoidOccurrenceViews::Event
+
+  embeds_many_occurrences class_name: 'Occurrence'
+end
+```
+
+The `embeds_many_occurences` macro will setup an embedded relation that holds a definition of occurrences. For example:
+
+```ruby
+<Occurrence dtstart: …, dtend: …, schedule: …>
+<Occurrence dtstart: …, dtend: …, schedule: …>
+<Occurrence dtstart: …, dtend: …, schedule: …>
+```
+
+Before each validation callback, each occurrence will expand its definition as follows:
+
+* multi-day occurrences are split into single-day occurrences
+* recurring schedules are expanded into single-day occurrences
+
+The following scopes are available for querying:
+
+* `occurs_between(Time, Time)`
+* `occurs_from(Time)`
+* `occurs_on(Time)`
+* `occurs_until(Time)`
+
+And these scopes for ordering:
+
+* `order_by_start(:asc / :desc)`
+* `order_by_end(:asc / :desc)`
+
+### Views & queries
+
+The gem creates two views (virtual collections):
+
+* `expanded_occurrences_view` for working with the expanded events
+* `occurrences_ordering_view` for ordering the unexpanded events
+
+#### Expanded Occurrences View
+
+This view lists expanded events – meaning events expanded for each daily occurrence.
+
+Use the `with_expanded_occurrences_view` method to query the expanded events:
+
+```ruby
+Event.with_expanded_occurrences_view do
+  Event.occurs_from(Time.zone.now).…
+end
+```
+
+The `.with_expanded_occurrences_view` method is simply a syntactic sugar on top of Mongoid's `.with(collection: …)` method, which specifies the collection to be the expanded occurrences view (`event__expanded_occurrences_view`).
+
+The view adds a `:_dtstart` and `:_dtend` fields to each `Event`.
+
+#### Occurrences Ordering View
+
+This view lists unexpanded events, circumnavigating Mongodb limitation for sorting by embedded documents. It adds `dtstart` field with a value coming from occurrence chronologically first, and `dtend` field with a value of occurrence chronologically last.
+
+Use the `with_occurrences_ordering_view` method to order the unexpanded events.
+
+```ruby
+Event.with_occurrences_ordering_view do
+  Event.order_by_start(:asc)…
+end
+```
+
+The `.with_occurrences_ordering_view` method is simply a syntactic sugar on top of Mongoid's `.with(collection: …)` method, which specifies the collection to be the expanded occurrences view (`event__expanded_occurrences_view`).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tomasc/mongoid_occurrence_views.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid_occurrence_views"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongoid_occurrence_views.rb

@@ -0,0 +1,25 @@
+require 'mongoid_occurrence_views/version'
+
+require 'mongoid'
+require 'mongoid_ice_cube_extension'
+
+require 'mongoid_occurrence_views/create_mongodb_view'
+require 'mongoid_occurrence_views/destroy_mongodb_view'
+
+require 'mongoid_occurrence_views/event'
+require 'mongoid_occurrence_views/event/occurrence'
+
+require 'mongoid_occurrence_views/event/has_views_on_occurrences'
+require 'mongoid_occurrence_views/event/has_occurrence_scopes'
+
+require 'mongoid_occurrence_views/event/create_view'
+require 'mongoid_occurrence_views/event/create_expanded_occurrences_view'
+require 'mongoid_occurrence_views/event/create_occurrences_ordering_view'
+
+require 'mongoid_occurrence_views/queries/query'
+require 'mongoid_occurrence_views/queries/occurs_between'
+require 'mongoid_occurrence_views/queries/occurs_from'
+require 'mongoid_occurrence_views/queries/occurs_on'
+require 'mongoid_occurrence_views/queries/occurs_until'
+require 'mongoid_occurrence_views/queries/order_by_end'
+require 'mongoid_occurrence_views/queries/order_by_start'

data/lib/mongoid_occurrence_views/create_mongodb_view.rb

@@ -0,0 +1,25 @@
+module MongoidOccurrenceViews
+  class CreateMongodbView
+    def initialize(name:, collection:, pipeline:)
+      @name = name
+      @collection = collection
+      @pipeline = pipeline
+    end
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def call
+      Mongoid.clients.each do |client_name, _|
+        client = Mongoid.client(client_name)
+        next if client.collections.map(&:name).include?(name)
+        client.command(create: name, viewOn: collection, pipeline: pipeline)
+      end
+    end
+
+    private
+
+    attr_reader :name, :collection, :pipeline
+  end
+end

data/lib/mongoid_occurrence_views/destroy_mongodb_view.rb

@@ -0,0 +1,23 @@
+module MongoidOccurrenceViews
+  class DestroyMongodbView
+    def initialize(name:)
+      @name = name
+    end
+
+    def self.call(*args)
+      new(*args).call
+    end
+
+    def call
+      Mongoid.clients.each do |client_name, _|
+        client = Mongoid.client(client_name)
+        next unless client.collections.map(&:name).include?(name)
+        client.command(drop: name)
+      end
+    end
+
+    private
+
+    attr_reader :name
+  end
+end

data/lib/mongoid_occurrence_views/event.rb

@@ -0,0 +1,21 @@
+module MongoidOccurrenceViews
+  module Event
+    def self.included(base)
+      base.class_eval do
+        include HasViewsOnOccurrences
+        include HasOccurrenceScopes
+      end
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def embeds_many_occurrences(options = {})
+        embeds_many :occurrences, class_name: options.fetch(:class_name)
+        accepts_nested_attributes_for :occurrences, allow_destroy: true, reject_if: :all_blank
+
+        CreateExpandedOccurrencesView.call(self) unless embedded?
+        CreateOccurrencesOrderingView.call(self) unless embedded?
+      end
+    end
+  end
+end

data/lib/mongoid_occurrence_views/event/create_expanded_occurrences_view.rb

@@ -0,0 +1,34 @@
+module MongoidOccurrenceViews
+  module Event
+    class CreateExpandedOccurrencesView < CreateView
+      def view_name
+        klass.expanded_occurrences_view_name
+      end
+
+      def pipeline
+        [add_fields,
+         unwind_associations_to_parent,
+         add_datetime_fields].flatten
+      end
+
+      private
+
+      def add_fields
+        { '$addFields': { "_#{occurrence_relation_chain.first}": "$#{occurrence_relation_chain.first}" } }
+      end
+
+      def unwind_associations_to_parent
+        occurrence_relations_chained.map do |chain|
+          { '$unwind': "$_#{chain}" }
+        end
+      end
+
+      def add_datetime_fields
+        { '$addFields': {
+          '_dtstart': "$_#{occurrence_relations_chained.last}.ds",
+          '_dtend': "$_#{occurrence_relations_chained.last}.de",
+        } }
+      end
+    end
+  end
+end

data/lib/mongoid_occurrence_views/event/create_occurrences_ordering_view.rb

@@ -0,0 +1,31 @@
+module MongoidOccurrenceViews
+  module Event
+    class CreateOccurrencesOrderingView < CreateView
+      def view_name
+        klass.occurrences_ordering_view_name
+      end
+
+      def pipeline
+        [add_fields].flatten
+      end
+
+      private
+
+      def add_fields
+        { '$addFields': { '_dtstart': order_dtstart_field, '_dtend': order_dtend_field } }
+      end
+
+      def order_dtstart_field
+        min = "$#{occurrence_relations_chained.last}.ds"
+        occurrence_relations_chained.length.times { min = { '$min': min } }
+        min
+      end
+
+      def order_dtend_field
+        max = "$#{occurrence_relations_chained.last}.de"
+        occurrence_relations_chained.length.times { max = { '$max': max } }
+        max
+      end
+    end
+  end
+end

data/lib/mongoid_occurrence_views/event/create_view.rb

@@ -0,0 +1,40 @@
+module MongoidOccurrenceViews
+  module Event
+    class CreateView
+      delegate(
+        :occurrence_relations_chained,
+        :occurrence_relation_chain,
+
+        to: :klass
+      )
+
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def self.call(*args)
+        new(*args).call
+      end
+
+      def call
+        CreateMongodbView.call(
+          name: view_name,
+          collection: klass.collection.name,
+          pipeline: pipeline
+        )
+      end
+
+      def pipeline
+        raise NotImplementedError
+      end
+
+      def view_name
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :klass
+    end
+  end
+end

data/lib/mongoid_occurrence_views/event/has_occurrence_scopes.rb

@@ -0,0 +1,32 @@
+module MongoidOccurrenceViews
+  module Event
+    module HasOccurrenceScopes
+      def self.included(base)
+        base.extend ClassMethods
+        base.class_eval do
+          scope :occurs_between, ->(dtstart, dtend, dtstart_field = dtstart_query_field, dtend_field = dtend_query_field) { MongoidOccurrenceViews::Queries::OccursBetween.criteria(criteria, dtstart, dtend, dtstart_field: dtstart_field, dtend_field: dtend_field) }
+          scope :occurs_from, ->(date_time, dtstart_field = dtstart_query_field) { MongoidOccurrenceViews::Queries::OccursFrom.criteria(criteria, date_time, dtstart_field: dtstart_field) }
+          scope :occurs_on, -> (date_time, dtstart_field = dtstart_query_field, dtend_field = dtend_query_field) { MongoidOccurrenceViews::Queries::OccursOn.criteria(criteria, date_time, dtstart_field: dtstart_field, dtend_field: dtend_field) }
+          scope :occurs_until, ->(date_time, dtend_field = dtend_query_field) { MongoidOccurrenceViews::Queries::OccursUntil.criteria(criteria, date_time, dtend_field: dtend_field) }
+
+          scope :order_by_start, ->(order = :asc, dtstart_field = dtstart_query_field) { MongoidOccurrenceViews::Queries::OrderByStart.criteria(criteria, order, dtstart_field: dtstart_field) }
+          scope :order_by_end, ->(order = :asc, dtend_field = dtend_query_field) { MongoidOccurrenceViews::Queries::OrderByEnd.criteria(criteria, order, dtend_field: dtend_field) }
+        end
+      end
+
+      module ClassMethods
+        def dtstart_query_field
+          within_view? ? :_dtstart : :"#{occurrence_relations_chained.last}.ds"
+        end
+
+        def dtend_query_field
+          within_view? ? :_dtend : :"#{occurrence_relations_chained.last}.de"
+        end
+
+        def within_view?
+          collection.name =~ /#{MongoidOccurrenceViews::Event::HasViewsOnOccurrences::EXPANDED_VIEW_NAME_SUFFIX}|#{MongoidOccurrenceViews::Event::HasViewsOnOccurrences::ORDERING_VIEW_NAME_SUFFIX}/
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_occurrence_views/event/has_views_on_occurrences.rb

@@ -0,0 +1,81 @@
+module MongoidOccurrenceViews
+  module Event
+    module HasViewsOnOccurrences
+      ORDERING_VIEW_NAME_SUFFIX = 'occurrences_ordering_view'.freeze
+      EXPANDED_VIEW_NAME_SUFFIX = 'expanded_occurrences_view'.freeze
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      def dtstart
+        return unless self.class.within_view?
+        DateTime.demongoize(self[:_dtstart])
+      end
+
+      def dtend
+        return unless self.class.within_view?
+        DateTime.demongoize(self[:_dtend])
+      end
+
+      module ClassMethods
+        def occurrences_ordering_view_name
+          [collection.name, ORDERING_VIEW_NAME_SUFFIX].join('__').freeze
+        end
+
+        def expanded_occurrences_view_name
+          [collection.name, EXPANDED_VIEW_NAME_SUFFIX].join('__').freeze
+        end
+
+        def with_expanded_occurrences_view(&block)
+          with_occurrences_view(expanded: true, &block)
+        end
+
+        def with_occurrences_ordering_view(&block)
+          with_occurrences_view(expanded: false, &block)
+        end
+
+        def with_occurrences_view(options = {}, &block)
+          expanded = options.delete(:expanded) { |_| true }
+          options[:collection] ||= expanded ? expanded_occurrences_view_name : occurrences_ordering_view_name
+          criteria.with(options, &block)
+        end
+
+        def occurrence_relations_chained
+          occurrence_relation_chain.each_with_index.map do |_, i|
+            occurrence_relation_chain[0..i].join('.')
+          end
+        end
+
+        def occurrence_relation_chain
+          return occurrence_relation_names unless event_relations.present?
+          [event_relations.first.store_as, occurrence_relation_names].flatten
+        end
+
+        def event_relations
+          return unless self.relations.present?
+          self.relations.values.select { |rel| is_event_relation?(rel) }
+        end
+
+        def is_event_relation?(rel)
+          relation_class_name = rel.options[:class_name]
+          return false unless relation_class_name.present?
+          return true if event_class_names.include?(relation_class_name)
+          return unless relation_class = relation_class_name.safe_constantize
+          event_superclasses = event_class_names.map { |cn| cn.safe_constantize.ancestors }.flatten
+          event_superclasses.include? relation_class
+        end
+
+        def event_class_names
+          ObjectSpace.each_object(Class).select do |cls|
+            cls.included_modules.include?(MongoidOccurrenceViews::Event)
+          end.map(&:to_s)
+        end
+
+        def occurrence_relation_names
+          %w[occurrences daily_occurrences]
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_occurrence_views/event/occurrence.rb

@@ -0,0 +1,122 @@
+module MongoidOccurrenceViews
+  module Event
+    module Occurrence
+      SCHEDULE_DURATION = 1.year
+
+      def self.included(base)
+        base.include MongoidOccurrenceViews::Event::HasOccurrenceScopes
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def embedded_in_event(options = {})
+          field :dtstart, type: DateTime
+          field :dtend, type: DateTime
+
+          field :schedule, type: MongoidIceCubeExtension::Schedule
+          field :schedule_dtend, type: Time
+
+          embedded_in :event, class_name: options.fetch(:class_name, nil)
+          embeds_many :daily_occurrences, class_name: 'MongoidOccurrenceViews::Event::Occurrence::DailyOccurrence', order: :dtstart.asc
+
+          validates_presence_of :dtstart
+          validates_presence_of :dtend
+
+          before_validation :nil_schedule, unless: :recurring?
+
+          after_validation :adjust_dates_for_all_day, if: :changed?
+          after_validation :assign_daily_occurrences, if: :changed?
+        end
+
+        def dtstart_query_field
+          :"daily_occurrences.ds"
+        end
+
+        def dtend_query_field
+          :"daily_occurrences.de"
+        end
+      end
+
+      def all_day
+        return unless dtstart.present?
+        return unless dtend.present?
+
+        @all_day ||= dtstart == dtstart.beginning_of_day && dtend == dtend.end_of_day
+      end
+      alias all_day? all_day
+
+      def all_day=(val)
+        @all_day = [true, 'true', 1, '1'].include?(val)
+      end
+
+      def recurring?
+        schedule.present?
+      end
+
+      def schedule_dtend
+        read_attribute(:schedule_dtend) || (dtstart.try(:to_time) || Time.now) + SCHEDULE_DURATION
+      end
+
+      private
+
+      def nil_schedule
+        self.schedule = nil
+      end
+
+      def adjust_dates_for_all_day
+        return unless all_day?
+
+        self.dtstart = dtstart.beginning_of_day
+        self.dtend = dtend.end_of_day
+      end
+
+      def assign_daily_occurrences
+        return unless dtstart_changed? || dtend_changed? || schedule_changed? || schedule_dtend_changed?
+        self.daily_occurrences = daily_occurrences_from_schedule + daily_occurrences_from_date_range
+      end
+
+      def daily_occurrences_from_schedule
+        return [] unless recurring?
+
+        schedule.occurrences(schedule_dtend).map do |occurrence|
+          relations['daily_occurrences'].klass.new(
+            dtstart: occurrence.start_time,
+            dtend: occurrence.end_time.change(hour: dtend.hour, min: dtend.minute)
+          )
+        end.compact
+      end
+
+      def daily_occurrences_from_date_range
+        return [] if recurring?
+        date_range = Range.new(dtstart.to_date, dtend.to_date)
+        is_single_day = (date_range.first == date_range.last)
+
+        date_range.map do |date|
+          occurence_dtstart = is_single_day || date == date_range.first ? dtstart : date.beginning_of_day
+          occurence_dtend = is_single_day || date == date_range.last ? dtend : date.end_of_day
+
+          relations['daily_occurrences'].klass.new(
+            dtstart: occurence_dtstart,
+            dtend: occurence_dtend
+          )
+        end.compact
+      end
+
+      class DailyOccurrence
+        include Mongoid::Document
+
+        # alias fields to keep document size small
+        field :ds, as: :dtstart, type: DateTime
+        field :de, as: :dtend, type: DateTime
+
+        def all_day
+          return unless dtstart.present?
+          return unless dtend.present?
+
+          dtstart == dtstart.beginning_of_day && dtend == dtend.end_of_day
+        end
+        alias all_day? all_day
+      end
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/occurs_between.rb

@@ -0,0 +1,28 @@
+module MongoidOccurrenceViews
+  module Queries
+    class OccursBetween < Query
+      def initialize(base_criteria, dtstart, dtend, options = {})
+        @base_criteria = base_criteria
+        @dtstart = dtstart
+        @dtend = dtend
+        @dtstart_field = options.fetch(:dtstart_field)
+        @dtend_field = options.fetch(:dtend_field)
+      end
+
+      def criteria
+        _dtstart = dtstart.beginning_of_day if dtstart.instance_of?(Date)
+        _dtstart = dtstart.utc
+
+        _dtend = dtend.end_of_day if dtend.instance_of?(Date)
+        _dtend = dtend.utc
+
+        base_criteria.lte(dtstart_field => dtend.to_datetime)
+                           .gte(dtend_field => dtstart.to_datetime)
+      end
+
+      private
+
+      attr_reader :dtstart, :dtend, :dtstart_field, :dtend_field
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/occurs_from.rb

@@ -0,0 +1,22 @@
+module MongoidOccurrenceViews
+  module Queries
+    class OccursFrom < Query
+      def initialize(base_criteria, date_time, options = {})
+        @base_criteria = base_criteria
+        @date_time = date_time
+        @dtstart_field = options.fetch(:dtstart_field)
+      end
+
+      def criteria
+        _date_time = date_time.end_of_day if date_time.instance_of?(Date)
+        _date_time = date_time.utc
+
+        base_criteria.gte(dtstart_field => _date_time)
+      end
+
+      private
+
+      attr_reader :date_time, :dtstart_field
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/occurs_on.rb

@@ -0,0 +1,24 @@
+module MongoidOccurrenceViews
+  module Queries
+    class OccursOn < Query
+      def initialize(base_criteria, date_time, options = {})
+        @base_criteria = base_criteria
+        @date_time = date_time
+        @dtstart_field = options.fetch(:dtstart_field)
+        @dtend_field = options.fetch(:dtend_field)
+      end
+
+      def criteria
+        _date_time = date_time.beginning_of_day if date_time.instance_of?(Date)
+        _date_time = date_time.utc
+
+        base_criteria.lte(dtstart_field => _date_time)
+                           .gte(dtend_field => _date_time)
+      end
+
+      private
+
+      attr_reader :date_time, :dtstart_field, :dtend_field
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/occurs_until.rb

@@ -0,0 +1,22 @@
+module MongoidOccurrenceViews
+  module Queries
+    class OccursUntil < Query
+      def initialize(base_criteria, date_time, options = {})
+        @base_criteria = base_criteria
+        @date_time = date_time
+        @dtend_field = options.fetch(:dtend_field)
+      end
+
+      def criteria
+        _date_time = date_time.beginning_of_day if date_time.instance_of?(Date)
+        _date_time = date_time.utc
+
+        base_criteria.lte(dtend_field => _date_time)
+      end
+
+      private
+
+      attr_reader :date_time, :dtend_field
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/order_by_end.rb

@@ -0,0 +1,19 @@
+module MongoidOccurrenceViews
+  module Queries
+    class OrderByEnd < Query
+      def initialize(base_criteria, order, options = {})
+        @base_criteria = base_criteria
+        @order = order
+        @dtend_field = options.fetch(:dtend_field)
+      end
+
+      def criteria
+        base_criteria.order_by(dtend_field => order)
+      end
+
+      private
+
+      attr_reader :order, :dtend_field
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/order_by_start.rb

@@ -0,0 +1,19 @@
+module MongoidOccurrenceViews
+  module Queries
+    class OrderByStart < Query
+      def initialize(base_criteria, order, options = {})
+        @base_criteria = base_criteria
+        @order = order
+        @dtstart_field = options.fetch(:dtstart_field)
+      end
+
+      def criteria
+        base_criteria.order_by(dtstart_field => order)
+      end
+
+      private
+
+      attr_reader :order, :dtstart_field
+    end
+  end
+end

data/lib/mongoid_occurrence_views/queries/query.rb

@@ -0,0 +1,21 @@
+module MongoidOccurrenceViews
+  module Queries
+    class Query
+      def initialize(base_criteria)
+        @base_criteria = base_criteria
+      end
+
+      def self.criteria(*args)
+        new(*args).criteria
+      end
+
+      def criteria
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :base_criteria
+    end
+  end
+end

data/lib/mongoid_occurrence_views/version.rb

@@ -0,0 +1,3 @@
+module MongoidOccurrenceViews
+  VERSION = '0.1.0'.freeze
+end

data/mongoid_occurrence_views.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_occurrence_views/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mongoid_occurrence_views'
+  spec.version       = MongoidOccurrenceViews::VERSION
+  spec.authors       = ['Tomas Celizna', 'Asger Behncke Jacobsen']
+  spec.email         = ['tomas.celizna@gmail.com', 'a@asgerbehnckejacobsen.dk']
+
+  spec.summary       = "Makes one's life easier when working with events that have multiple occurrences, or a recurring schedule."
+  spec.homepage      = 'https://github.com/tomasc/mongoid_occurrence_views'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ice_cube'
+  spec.add_dependency 'mongoid', '>= 7.0.2', '< 8'
+  spec.add_dependency 'mongoid_ice_cube_extension', '>= 0.1.1'
+
+  spec.add_development_dependency 'activesupport', '> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'factory_bot', '~> 4.0'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-implicit-subject'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,263 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_occurrence_views
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+- Asger Behncke Jacobsen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: mongoid_ice_cube_extension
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: database_cleaner
+  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: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-minitest
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-implicit-subject
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- tomas.celizna@gmail.com
+- a@asgerbehnckejacobsen.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid_occurrence_views.rb
+- lib/mongoid_occurrence_views/create_mongodb_view.rb
+- lib/mongoid_occurrence_views/destroy_mongodb_view.rb
+- lib/mongoid_occurrence_views/event.rb
+- lib/mongoid_occurrence_views/event/create_expanded_occurrences_view.rb
+- lib/mongoid_occurrence_views/event/create_occurrences_ordering_view.rb
+- lib/mongoid_occurrence_views/event/create_view.rb
+- lib/mongoid_occurrence_views/event/has_occurrence_scopes.rb
+- lib/mongoid_occurrence_views/event/has_views_on_occurrences.rb
+- lib/mongoid_occurrence_views/event/occurrence.rb
+- lib/mongoid_occurrence_views/queries/occurs_between.rb
+- lib/mongoid_occurrence_views/queries/occurs_from.rb
+- lib/mongoid_occurrence_views/queries/occurs_on.rb
+- lib/mongoid_occurrence_views/queries/occurs_until.rb
+- lib/mongoid_occurrence_views/queries/order_by_end.rb
+- lib/mongoid_occurrence_views/queries/order_by_start.rb
+- lib/mongoid_occurrence_views/queries/query.rb
+- lib/mongoid_occurrence_views/version.rb
+- mongoid_occurrence_views.gemspec
+homepage: https://github.com/tomasc/mongoid_occurrence_views
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Makes one's life easier when working with events that have multiple occurrences,
+  or a recurring schedule.
+test_files: []