year_week 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 990238f50dc54ddaad7e70b650b9cc7b462b3b71
+  data.tar.gz: 67f470d6fa83f87551785b47708116b8623fadd5
+SHA512:
+  metadata.gz: 3b1fb6467498ed951b94a93c0e8f3d04284d84116413874677f965841a527b3e407a4ebbe011fd03510feeea315f550fe679c2bb8fc0976490f9839edeb027d3
+  data.tar.gz: 38c914449d24fffddecdbdbe7225ce1e69ccb323909d0820d1d852800481cec81839a584c938527140d1351e6da7cd8bbeddf3613d35ea6c730c47c759a5eece

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gert Goet
+
+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,95 @@
+# YearWeek
+
+Makes working with weeks more fun.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'year_week'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install year_week
+
+## Usage
+
+
+```ruby
+# Create:
+> YearWeek.new(2016, 1)
+=> #<YearWeek year=2016, week=1>
+
+> YearWeek.for_date(Date.parse('2016-1-4'))
+=> #<YearWeek year=2016, week=1>
+
+# The current week:
+> YearWeek.current
+=> #<YearWeek year=2016, week=9>
+
+# 'Change':
+# Weeks are immutable. By using `#with` you create a new week:
+> YearWeek.current.with(week: 9)
+=> #<YearWeek year=2016, week=9>
+
+# next and previous:
+> YearWeek.new(2016, 1).succ == YearWeek.new(2016, 3).pred
+=> true
+
+# Comparing
+# Equality is based on value:
+> YearWeek.current.with(week: 8) == YearWeek.new(2016, 8)
+=> true
+
+> YearWeek.current.with(week: 8) < YearWeek.current.with(week: 9)
+=> true
+
+# Check for inclusion:
+> YearWeek.new(2016, 1).include?(Date.parse('2016-1-4'))
+=> true
+```
+
+### ActiveRecord/Arel
+
+Given a `User`-class and a week `@week` you can do the following:
+
+```ruby
+# All users created during the week:
+User.where(created_at: @week)
+
+# all users created before the week:
+user_table = User.arel_table
+User.where(@week.gt(user_table[:created_at]))
+# ...including users created during week
+User.where(@week.gteq(user_table[:created_at]))
+
+# similar to get all users created after a week:
+User.where(@week.lt(user_table[:created_at]))
+# ...including users created during week
+User.where(@week.lteq(user_table[:created_at]))
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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).
+
+## TODO
+
+- [ ] range should have datetimes
+- [ ] use ISO8601 for `#to_s`
+- [ ] make it work without AR
+- [ ] add `YearWeek()`
+- [ ] range of weeks `YearWeek.new(2016, 1)...YearWeek.new(2016, 3)`
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "year_week"
+
+# 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/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/year_week.rb

@@ -0,0 +1,65 @@
+require 'values'
+require 'active_record'
+
+class YearWeek < Value.new(:year, :week)
+  include Comparable
+
+  def <=>(other)
+    to_s <=> other.to_s
+  end
+
+  def to_s
+    "#{@year}-#{@week}"
+  end
+
+  def include?(other)
+    to_range.include?(other.to_date)
+  end
+
+  def self.for_date(date)
+    new(date.cwyear, date.cweek)
+  end
+
+  def self.current
+    for_date(Date.current)
+  end
+
+  def to_range
+    (self.begin...self.end)
+  end
+
+  def begin
+    Date.commercial(@year, @week)
+  end
+
+  def end
+    self.begin + 1.week
+  end
+
+  def succ
+    self.class.for_date(self.end)
+  end
+
+  def pred
+    self.class.for_date(self.begin.prev_day)
+  end
+
+  def lt(att)
+    att.gteq(self.end)
+  end
+
+  def lteq(att)
+    pred.lt(att)
+  end
+
+  def gt(att)
+    att.lt(self.begin)
+  end
+
+  def gteq(att)
+    succ.gt(att)
+  end
+end
+
+# TODO: move this to railtie
+ActiveRecord::PredicateBuilder.register_handler(YearWeek, ->(attribute, value) { attribute.between(value.to_range) })

data/year_week.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "year_week"
+  spec.version       = '0.2.0'     # TODO: make this version accessible from class
+  spec.authors       = ["Gert Goet"]
+  spec.email         = ["gert@thinkcreate.nl"]
+
+  spec.summary       = %q{Makes working with weeks more fun}
+  spec.description   = %q{Makes working with weeks more fun}
+  spec.homepage      = "https://gitlab.com/eval/year_week"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  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 "values", "~> 1.8.0"
+  spec.add_dependency "activerecord", "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: year_week
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Gert Goet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: values
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+description: Makes working with weeks more fun
+email:
+- gert@thinkcreate.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rake
+- bin/rspec
+- bin/setup
+- lib/year_week.rb
+- year_week.gemspec
+homepage: https://gitlab.com/eval/year_week
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Makes working with weeks more fun
+test_files: []