time_window 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28095f55f17892cabbc31bf44bd8e114968f720f3f2466152cab4fa85b7d4789
+  data.tar.gz: 987aa9ea2313c274ba9e0a35f21407120c657fa96a06eece12059936cccaf7a6
+SHA512:
+  metadata.gz: 2a4f98c5754fac92d582959a9c497e3f1d6c9481fefae91fad158b00f5f302ac0d829d417fe5ce37023f6e5a3eb29c67593c36859b99c0e64d46a4d5945d2d1d
+  data.tar.gz: a8ff425e5797c2cff6e5753a623010a59eb81ee1cce7ee4dcd05c11146508f414f2c6534af5695fbdc2624a4963d4aa92e97eba8f3a0e76add9efa616c5b9904

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+cache: bundler
+sudo: false
+notifications:
+  email: false
+rvm:
+- 2.5.3
+before_script:
+- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+- chmod +x ./cc-test-reporter
+- "./cc-test-reporter before-build"
+after_script:
+- "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+env:
+  global:
+    secure: oanQQ2DXrqCbMuw7oDS+GvN2HekLKqcPFkT5cIxUW+SyRyf7WAVPY9x8BjTVrejx4L6GrT68E+vcUJNZf3UTo8RADGrbA5WxKUKhDO7i85GvbStRXE+5AOO7c1S8DPiT4KRISxzbUtE69UpwlOqZW3L6Pd9PneMPlsiB8O6KLGIP06LMxljlEcfpD21v2bovDUaHf2gd9i+CD2SojXhdgdVeR0LFOHYG9x7rDqvEApG01uKRsI7QizlC9WWMEmh6QxyWJ/DpLwooeOtBQV6h/dtBKBkh0mW4qFovCmm+HuioEPq3sx/ApoqrQoLFZf1gZ6Fxzqw9dzDIA2gIyB4nCbtuPCJSmuXgXmmGVLfGFozHF4byuHxFp20QuNaOcGZUAr08ntFeFqvZ5BLB0EGj0Q2FpB42SWRKnURar1rAfrDKiHooLJgiwpKpvN0AVXdD0gHk2A6IKx1umvKPLL/3AU3vmtbXlHRRT8zerLwAn27JZRZsjYHxN/3jwGPDIAV56z7ozuLTvLLbQxHBhlU6Tn+/SzS0wia5l8w+z6D0Wt1h0m9ytr1JnYvs5kk3inKWMHEMeXkwN2oOS5axX8jzP+LnBR32Gb4Gedc0Qrra2HCmmD5NYgjYAEuipNBUeffcoLX9Mvi+J/NZRamE6oAxD4A0eu5uH/ZaCLE3pMZb2Xk=

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@fnando.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in time_window.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    time_window (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    docile (1.3.1)
+    json (2.1.0)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    minitest-utils (0.4.4)
+      minitest
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    pry-meta (0.0.10)
+      awesome_print
+      pry
+      pry-byebug
+      pry-remote
+    pry-remote (0.1.8)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (12.3.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  minitest
+  minitest-utils
+  pry-meta
+  rake
+  simplecov
+  time_window!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nando Vieira
+
+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,77 @@
+# TimeWindow
+
+[![Travis-CI](https://travis-ci.org/fnando/time_window.svg)](https://travis-ci.org/fnando/time_window)
+[![CodeClimate](https://codeclimate.com/github/fnando/time_window.svg)](https://codeclimate.com/github/fnando/time_window)
+[![Test Coverage](https://codeclimate.com/github/fnando/time_window/badges/coverage.svg)](https://codeclimate.com/github/fnando/time_window/coverage)
+[![Gem](https://img.shields.io/gem/v/time_window.svg)](https://rubygems.org/gems/time_window)
+[![Gem](https://img.shields.io/gem/dt/time_window.svg)](https://rubygems.org/gems/time_window)
+
+Retrieve time objects by time windows (e.g. TimeWindow.call('5m') will round minutes to multiples of 5).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'time_window'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install time_window
+
+## Usage
+
+You can get a time window for any given time object. By default, it uses `Time.now`.
+
+```ruby
+require "time_window"
+
+Time.now
+#=> 2018-12-10 07:07:14 -0800
+
+TimeWindow.call("5m")
+#=> 2018-12-10 07:05:00 -0800
+```
+
+You can use the following units as time windows:
+
+- `s`: second
+- `m`: minute
+- `h`: hour
+
+To specify a custom time object, just pass a second argument.
+
+```ruby
+TimeWindow.call "15m", Time.parse("2032-11-23T14:55:26")
+#=> 2032-11-23 14:45:00 -0800
+```
+
+By default, `Time.now` is used as the default time. You can override the generator by setting `TimeWindow.now_proc`.
+
+```ruby
+# https://api.rubyonrails.org/classes/Time.html#method-c-current
+TimeWindow.now_proc = -> { Time.current }
+```
+
+## 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/fnando/time_window. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TimeWindow project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/time_window/blob/master/CODE_OF_CONDUCT.md).

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 "time_window"
+
+# 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/time_window.rb

@@ -0,0 +1,66 @@
+module TimeWindow
+  require "time_window/version"
+
+  InvalidUnit = Class.new(StandardError)
+  InvalidWindow = Class.new(StandardError)
+
+  ALIASES = {
+    "s" => "second",
+    "m" => "minute",
+    "h" => "hour"
+  }.freeze
+
+  class << self
+    attr_accessor :now_proc
+  end
+
+  self.now_proc = -> { Time.now }
+
+  def self.now
+    now_proc.call
+  end
+
+  # Retrieve the formatted date time window.
+  # The `time` param defaults to the current time.
+  # Returns a `Time` object.
+  #
+  # Accept units are: s (second), m (minute), h (hour).
+  #
+  #   TimeWindow.call("5m")
+  #   #=> 2018-12-10 05:40:00 -0800
+  #
+  def self.call(window, time = now)
+    _, window, unit = *window.match(/\A(\d+)(.)\z/)
+
+    window = Integer(window)
+    unit = ALIASES.fetch(unit) { raise InvalidUnit, "#{unit.inspect} is not a valid unit" }
+
+    hour, minute, second = public_send("process_#{unit}_window", time, window)
+
+    Time.new(time.year, time.month, time.day, hour, minute, second)
+  end
+
+  def self.process_second_window(time, window)
+    raise InvalidWindow, "#{window.inspect} must be covered by 1..59" unless (1..59).cover?(window)
+
+    second = time.sec - (time.sec % window)
+
+    [time.hour, time.min, second]
+  end
+
+  def self.process_minute_window(time, window)
+    raise InvalidWindow, "#{window.inspect} must be covered by 1..59" unless (1..59).cover?(window)
+
+    minute = time.min - (time.min % window)
+
+    [time.hour, minute, 0]
+  end
+
+  def self.process_hour_window(time, window)
+    raise InvalidWindow, "#{window.inspect} must be covered by 1..23" unless (1..23).cover?(window)
+
+    hour = time.hour - (time.hour % window)
+
+    [hour, 0, 0]
+  end
+end

data/lib/time_window/version.rb

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

data/time_window.gemspec

@@ -0,0 +1,29 @@
+require "./lib/time_window/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "time_window"
+  spec.version       = TimeWindow::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["me@fnando.com"]
+
+  spec.summary       = "Retrieve time objects by time windows (e.g. TimeWindow.call('5m') will round minutes to multiples of 5)."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/time_window"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject {|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"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: time_window
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest-utils
+  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: pry-meta
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Retrieve time objects by time windows (e.g. TimeWindow.call('5m') will
+  round minutes to multiples of 5).
+email:
+- me@fnando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/time_window.rb
+- lib/time_window/version.rb
+- time_window.gemspec
+homepage: https://github.com/fnando/time_window
+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: Retrieve time objects by time windows (e.g. TimeWindow.call('5m') will round
+  minutes to multiples of 5).
+test_files: []