mongoid_recurring 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7a8d2508fb0cd720a37d1a45bd165191f2e9b4f
+  data.tar.gz: 346dec8d6a1af3e1501b04f751b269423272f5b8
+SHA512:
+  metadata.gz: 2fa8a4ae37e61c00080f15f2c1e4fe26eab51cca0bfe47edf224588e28a943e2824a1051d836df9816d44dd4cd31bd4af3c5a01b408257a851038c4d13c6eca4
+  data.tar.gz: ef4fa41fe57f18398cc771f60bad5110b68655266402c661078723eba1de7c93ef398dd80b2f5080ba214c950215a0c82498c1eebbd1d977e2ceade6feea230b

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rake'
+rvm:
+  - 2.1.2
+services:
+  - mongodb
+
+notifications:
+  email:
+    recipients:
+      - tomas.celizna@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_recurring.gemspec
+gemspec

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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tomas Celizna
+
+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,65 @@
+# MongoidRecurring
+
+[![Build Status](https://travis-ci.org/tomasc/mongoid_recurring.svg)](https://travis-ci.org/tomasc/mongoid_recurring) [![Gem Version](https://badge.fury.io/rb/mongoid_recurring.svg)](http://badge.fury.io/rb/mongoid_recurring) [![Coverage Status](https://img.shields.io/coveralls/tomasc/mongoid_recurring.svg)](https://coveralls.io/r/tomasc/mongoid_recurring)
+
+Recurring date time fields for Mongoid models, using [IceCube](https://github.com/seejohnrun/ice_cube/).
+
+When included in a model, this gem expands the recurring rules set of an `IceCube` schedule on save into an array of embedded `MongoidRecurring::Occurence` models.
+
+It also adds definitions of several scopes that allow for convenient querying of models stored in the db.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mongoid_recurring'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_recurring
+
+## Usage
+
+```ruby
+class MyModel
+  include Mongoid::Document
+  include MongoidRecurring::HasRecurringFields
+  has_recurring_fields
+end
+```
+
+Which will then add `dtstart`, `dtend`, `all_day`, `schedule` and `schedule_dtend` fields to the model.
+
+The model will generate all occurrences on before save, and stores them as embedded `MongoidRecurring::Occurrence` documents in the `:occurrences` embedded relation.
+
+A scope named `.for_datetime_range` can be then used to query for documents with occurrences in specified DateTime range:
+
+```ruby
+MyModel.for_datetime_range( Date.today, Date.today+1.week )
+```
+
+## Configuration
+
+By default, when `schedule_dtend` is not specified, the `:occurrences` are populated for 1 year in advance. This duration can be configured as follows:
+
+  has_recurring_fields schedule_duration: 2.weeks
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/mongoid_recurring/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid_recurring"
+
+# 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

data/bin/setup

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

data/lib/mongoid_recurring/has_recurring_fields.rb

@@ -0,0 +1,54 @@
+require 'mongoid'
+require 'mongoid_ice_cube_extension'
+
+module MongoidRecurring
+  module HasRecurringFields
+
+    def self.included base
+      base.extend ClassMethods
+      base.class_eval do
+        @@schedule_duration = 1.year
+      end
+    end
+
+    # =====================================================================
+
+    module ClassMethods
+      def has_recurring_fields options={}
+         @@schedule_duration = options[:schedule_duration] if options[:schedule_duration].present?
+
+        field :dtstart, type: DateTime
+        field :dtend, type: DateTime
+        field :all_day, type: Boolean, default: false
+
+        field :schedule, type: MongoidIceCubeExtension::Schedule
+        field :schedule_dtend, type: DateTime
+
+        embeds_many :occurrences, class_name: 'MongoidRecurring::Occurence', order: :dtstart.asc
+
+        validates :dtstart, presence: true
+
+        before_save :expand_schedule_to_occurrences
+
+        scope :for_datetime_range, -> (dtstart, dtend) {
+          where( occurrences: { "$elemMatch" => { :dtstart.gte => dtstart.to_datetime, :dtend.lte => dtend.to_datetime } } )
+        }
+      end
+    end
+
+    private # =============================================================
+
+    def expand_schedule_to_occurrences
+      self.occurrences = schedule.present? ? occurrences_from_schedule : occurrences_from_model
+    end
+
+    def occurrences_from_schedule
+      schedule.occurrences(schedule_dtend || (schedule.start_time + @@schedule_duration)).collect { |o| MongoidRecurring::Occurence.new( dtstart: o.start_time, dtend: o.end_time, all_day: all_day ) }
+    end
+
+    def occurrences_from_model
+      [ MongoidRecurring::Occurence.new( dtstart: dtstart, dtend: dtend, all_day: all_day ) ]
+    end
+
+  end
+end

data/lib/mongoid_recurring/occurence.rb

@@ -0,0 +1,38 @@
+require 'mongoid'
+
+module MongoidRecurring
+  class Occurence
+    include Mongoid::Document
+
+    field :dtstart, type: DateTime
+    field :dtend, type: DateTime
+
+    attr_accessor :all_day
+
+    embedded_in :schedule, class_name: 'MongoidRecurring::Occurence'
+
+    validates :dtstart, presence: true
+    validates :dtend, presence: true
+
+    before_save :set_dtend
+    before_save :adjust_dates_for_all_day
+
+    # =====================================================================
+
+    def all_day?
+      self.all_day == true
+    end
+
+    private # =============================================================
+
+    def set_dtend
+      self.dtend ||= dtstart
+    end
+
+    def adjust_dates_for_all_day
+      return unless all_day?
+      self.dtstart = dtstart.beginning_of_day
+      self.dtend = dtend.end_of_day
+    end
+  end
+end

data/lib/mongoid_recurring/version.rb

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

data/lib/mongoid_recurring.rb

@@ -0,0 +1,7 @@
+require 'active_support/core_ext/date'
+require 'active_support/core_ext/date_time'
+
+require "mongoid_recurring/occurence"
+require "mongoid_recurring/has_recurring_fields"
+
+require "mongoid_recurring/version"

data/mongoid_recurring.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_recurring/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_recurring"
+  spec.version       = MongoidRecurring::VERSION
+  spec.authors       = ["Tomáš Celizna"]
+  spec.email         = ["tomas.celizna@gmail.com"]
+
+  spec.summary       = %q{Recurring date time fields for Mongoid models.}
+  spec.homepage      = "https://github.com/tomasc/mongoid_recurring"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "> 3.0"
+  spec.add_dependency "ice_cube"
+  spec.add_dependency "mongoid", "~> 5.0"
+  spec.add_dependency "mongoid_ice_cube_extension", ">= 0.1.1"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_recurring
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomáš Celizna
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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: '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
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid_recurring.rb
+- lib/mongoid_recurring/has_recurring_fields.rb
+- lib/mongoid_recurring/occurence.rb
+- lib/mongoid_recurring/version.rb
+- mongoid_recurring.gemspec
+homepage: https://github.com/tomasc/mongoid_recurring
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Recurring date time fields for Mongoid models.
+test_files: []