weekends 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c70cf6d890ee4e9e53a17816dd772e6ff273957
+  data.tar.gz: 5aae575a665953edd5edbe8bc588e1a689ee490b
+SHA512:
+  metadata.gz: 8503d9d2a81a89c915665596f22af624c0c92454deadcac016c3ac21b1f86114d934725cfde2a7f20b98d27aa526f8df8e811f452b450fc476cdb36b43f9fa9c
+  data.tar.gz: 234b43a5926e486eef5967172b25ab4c10c84869957919b1a2e9f05a59152df0417d41da3efaa551da91e3499c4f57b899a1d07c31c045c859a7709c9e96cf7e

data/.gitignore

@@ -0,0 +1,13 @@
+/.idea
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  DisplayCopNames: true
+  Exclude:
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - '**/weekends.gemspec'
+Documentation:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.3
+script:
+  - gem install rubocop
+  - rubocop

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 GeorgeGorbanev
+
+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,83 @@
+# Weekends [![Build Status](https://travis-ci.org/GeorgeGorbanev/weekends.svg?branch=master)](https://travis-ci.org/GeorgeGorbanev/weekends)
+
+This gem import class `Weekend` that help to identify weekend dates.
+
+## Usage
+
+It is possible to pass `Time`, `Date`, `DateTime` or `ActiveSupport::TimeWithZone` to all methods and `Time` will be returned.
+
+Class does't have `ActiveSupport` dependency, so Rails dependencies not required.
+
+### Nearest methods
+
+This methods returns nearest weekends:
+
+ ```ruby
+ monday = Time.new(2017, 10, 2) 
+
+ Weekend.nearest_saturday(monday)
+ # => 2017-10-07 00:00:00 +0300 
+ 
+ Weekend.nearest_sunday(monday)
+ # => 2017-10-08 00:00:00 +0300 
+ 
+ Weekend.nearest_full_weekends(monday)
+ # => 2017-10-07 00:00:00 +0300..2017-10-08 00:00:00 +0300 
+
+ ```
+ 
+ If given weekend, methods will return next weekend:
+ 
+  ```ruby
+  saturday = Time.new(2017, 10, 7)
+ 
+  Weekend.nearest_saturday(saturday)
+  # => 2017-10-14 00:00:00 +0300 
+   
+  # ...
+ 
+  ```
+
+### On date
+
+There is also basic method to check if date are weekend:
+
+  ```ruby
+  monday = Time.new(2017, 10, 2) 
+  saturday = Time.new(2017, 10, 7)
+  
+  Weekend.on_date?(monday)
+  # => false 
+ 
+  Weekend.on_date?(saturday)
+  # => true 
+  ```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'weekends'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install weekends
+    
+## TODO: 
+
+* add Rails optional monky patching, like `Date.today.weekend?` and `Date.today.nearest_sunday`;
+* add getter of weekends on range of dates;
+* add schedule with optionals weekend (for schedule not only 5/2, but 2/2, 2/3 or first weekday not monday).
+
+
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'weekend'
+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/weekend.rb

@@ -0,0 +1,10 @@
+require 'weekends/version'
+require 'weekends/nearest'
+require 'weekends/on_date'
+
+class Weekend
+  class << self
+    include Weekends::Nearest
+    include Weekends::OnDate
+  end
+end

data/lib/weekends/nearest.rb

@@ -0,0 +1,29 @@
+module Weekends
+  module Nearest
+    DAY = 86_400
+
+    def nearest_saturday(date)
+      wday = date.wday
+      diff = wday == 6 ? 7 : 6 - wday
+      date + diff * DAY
+    end
+
+    def nearest_sunday(date)
+      wday = date.wday
+      diff = wday == 7 ? 7 : 7 - wday
+      date + diff * DAY
+    end
+
+    def nearest_full_weekends(date)
+      if on_date?(date)
+        current_weekend_end = nearest_sunday(date)
+        next_saturday = nearest_saturday(current_weekend_end)
+        next_sunday = nearest_sunday(current_weekend_end)
+
+        next_saturday..next_sunday
+      else
+        nearest_saturday(date)..nearest_sunday(date)
+      end
+    end
+  end
+end

data/lib/weekends/on_date.rb

@@ -0,0 +1,7 @@
+module Weekends
+  module OnDate
+    def on_date?(date)
+      date.wday.zero? || date.wday == 6
+    end
+  end
+end

data/lib/weekends/version.rb

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

data/weekends.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'weekends/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'weekends'
+  spec.version       = Weekends::VERSION
+  spec.authors       = ['GeorgeGorbanev']
+  spec.email         = ['GeorgeGorbanev@gmail.com']
+
+  spec.summary       = 'Weekend class with methods like #near and #today?'
+  spec.homepage      = 'https://github.com/GeorgeGorbanev/weekends'
+  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_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: weekends
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- GeorgeGorbanev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+description: 
+email:
+- GeorgeGorbanev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/weekend.rb
+- lib/weekends/nearest.rb
+- lib/weekends/on_date.rb
+- lib/weekends/version.rb
+- weekends.gemspec
+homepage: https://github.com/GeorgeGorbanev/weekends
+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.6.10
+signing_key: 
+specification_version: 4
+summary: 'Weekend class with methods like #near and #today?'
+test_files: []