smart-period 1.0.3 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd9b91f3f8553c817029a58445250a56093cc07ea8eb856c88798d5afd72d210
-  data.tar.gz: e5a67dcedd0eae2113f489f46a472cf1b8b4be45caacc1d8910acc59f70be2a5
+  metadata.gz: 0a3d9947a640e16d37b4388f379169c0001a3ae7ec3f62364ce5649c459815a6
+  data.tar.gz: c4e126393399c839bf7a14f1c5484048d3f37d187a4edfcb86b6c120377c66b1
 SHA512:
-  metadata.gz: ea9f3a5074c20e26c9e8718c91263b993bdef3a9e6b8f9b28015d60c67947a403fad37d2f51322f4053f87ca0590973084461a290515dd592a7eb677253dd599
-  data.tar.gz: c703f75c931446e9114d06bacb43f0d613e38a5d21b03721d25d2e1e0b0bef1cb74b29cc73f2df1e7170b48fab6a30ddccda40d58a2f23c85e446616e5e3da6f
+  metadata.gz: 24cf1e781b82c179b9423dc996ab9e125aa673e616814dfcd3492466838fe583f24aa0eebfcdd4e30eda0ee875e4064d7a96b34749b2557a9bf4464879ec9073
+  data.tar.gz: 6b9f7c388255bc3cffd73704d916577faad5e739d764df421ce1785bc46065ff81526d9bba4324aae1f2d928f7f5e3b3f53a2aba351ad23fe4cfe20e72cc6cc5

data/Gemfile.lock

@@ -1,26 +1,27 @@
 PATH
   remote: .
   specs:
-    period (0.1.4)
-      activesupport (= 5.2.3)
-      i18n (= 1.6.0)
+    smart-period (1.0.6)
+      activesupport (>= 5, < 7)
+      i18n (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (6.1.0)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    concurrent-ruby (1.1.6)
-    i18n (1.6.0)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.7)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    minitest (5.14.1)
+    minitest (5.14.2)
     rake (10.5.0)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -28,7 +29,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 10.0)
-  period!
+  smart-period!
 
 BUNDLED WITH
-   2.0.1
+   2.1.2

data/README.md

@@ -1,6 +1,6 @@
-# Smart-Period
+# Smart-Period [![Gem Version](https://badge.fury.io/rb/smart-period.svg)](https://badge.fury.io/rb/smart-period) [![Code Climate](https://codeclimate.com/github/billaul/period.svg)](https://codeclimate.com/github/billaul/period) [![Inline docs](http://inch-ci.org/github/billaul/period.svg)](http://inch-ci.org/github/billaul/period)
 
-Smart-Period aims to simplify Time-range manipulation
+Smart-Period aims to simplify Time-range manipulation. 
 
 ## Installation
 
@@ -20,29 +20,35 @@ Or install it yourself as:
 
 ## Usage
 
-**Smart-Period** was designed to simplify time-range manipulation, specialy with rails and user input   
+**Smart-Period** was designed to simplify time-range manipulation, specialy with rails (~> 5) and user input   
 
 **Warning** :
 - A time-range take place between two date and it's different from an abstract duration of time
 - **Smart-Period** is limited at full day of time and will always round the starting and ending to the beginning and the ending of the day
 
 
-### Quick view (TL;DR)
+## Quick view (TL;DR)
 ``` ruby
-  # Get all user created today
-  User.where(created_at: Period.today)
-  # Get how many weeks there is from the beginning of time ?
-  Period.new('01/01/1970'..Time.now).weeks.count
-  # Is Trump still in charge ?
-  Time.now.in? Period.new('20/01/2017'...'20/01/2021')
-  # Get the week of an arbitrary date
-  Period.week('24/04/1990')
-  # Write a date for me (I18n supported)
-  Period.new('20/01/2017'...'20/01/2021').to_s
-  => "From the 20 January 2017 to the 19 January 2021 included"
+require 'period'
+
+# Get all user created today
+User.where(created_at: Period.today)
+
+# Get how many weeks there is from the beginning of time ?
+Period.new('01/01/1970'..Time.now).weeks.count
+
+# Is Trump still in charge ?
+Time.now.in? Period.new('20/01/2017'...'20/01/2021')
+
+# Get the week of an arbitrary date
+Period.week('24/04/1990')
+
+# Write a date for me (I18n supported)
+Period.new('20/01/2017'...'20/01/2021').to_s
+=> "From the 20 January 2017 to the 19 January 2021 included"
 ```
 
-### Detailed view
+## Detailed view
 
 There's two way to create and manipulate a period of time `FreePeriod` and `StandardPeriod`
 
@@ -51,76 +57,76 @@ There's two way to create and manipulate a period of time `FreePeriod` and `Stan
 You can declare **FreePeriod** as simply as :
 
 ```ruby
-  # With Date objects
-  Period.new(3.month.ago..Date.today)
-  # or with Strings
-  Period.new('01/01/2000'...'01/02/2000')
-  # or with a mix
-  Period.new('01/01/2000'..1.week.ago)
-  # or in a rails Controller with params
-  Period.new(params[:start_date]..params[:end_date])
+# With Date objects
+Period.new(3.month.ago..Date.today)
+# or with Strings
+Period.new('01/01/2000'...'01/02/2000')
+# or with a mix
+Period.new('01/01/2000'..1.week.ago)
+# or in a rails Controller with params
+Period.new(params[:start_date]..params[:end_date])
 ```
 
 **FreePeriod** can be manipulated with `+` and `-`          
 Doing so will move the start **and** the end of the period   
 ```ruby
-  Period.new('01/01/2000'..'05/01/2000') + 3.day
-  # is equal to
-  Period.new('04/01/2000'..'08/01/2000')
+Period.new('01/01/2000'..'05/01/2000') + 3.day
+# is equal to
+Period.new('04/01/2000'..'08/01/2000')
 ```
 
 ### Standard Period of time
 
-Using **StandardPeriod** you are limited to strictly bordered periods of time
+Using **StandardPeriod** you are limited to strictly bordered periods of time      
 These periods are `day`, `week`, `month`, `quarter` and `year`
 
 ```ruby
-  # To get the week, 42th day ago
-  Period.week(42.day.ago)
-  # To get the first month of 2020
-  Period.month('01/01/2020')
-  # or if you like it verbious
-  Period::Month.new('01/01/2020')
-  # or if you need the current week
-  Period.week(Time.now)
+# To get the week, 42th day ago
+Period.week(42.day.ago)
+# To get the first month of 2020
+Period.month('01/01/2020')
+# or if you like it verbious
+Period::Month.new('01/01/2020')
+# or if you need the current week
+Period.week(Time.now)
 ```
 
 **Note** : If you ask for a `month`, `quarter` of `year`, the day part of your param doesn't matter `01/01/2020` give the same result as `14/01/2020` or `29/01/2020`
 
 **StandardPeriod** can be manipulated with `+` and `-` and will always return a **StandardPeriod** of the same type           
 ```ruby
-  # Subtraction are made from the start of the period
-  Period.month('10/02/2000') - 1.day
-  # Return the previous month
-  # Addition are made from the end
-  Period.month('10/02/2000') + 1.day
-  # Return the next month
-  Period.week('10/02/2000') + 67.day
-  # Return a week
+# Subtraction are made from the start of the period
+Period.month('10/02/2000') - 1.day
+# Return the previous month
+# Addition are made from the end
+Period.month('10/02/2000') + 1.day
+# Return the next month
+Period.week('10/02/2000') + 67.day
+# Return a week
 ```
 **StandardPeriod** also respond to `.next` and `.prev`
 ```ruby
-  Period.month('01/01/2000').next.next.next
-  # Return the month of April 2020
+Period.month('01/01/2000').next.next.next
+# Return the month of April 2020
 ```
 
 You can quickly access close period of time with `.(last|this|next)_(day|week|month|quarter|year)` and `.yesterday` `.today` `.tomorrow`
 
 ```ruby
-  Period.this_week
-  # Same as Period.week(Time.now) but shorter
-  Period.next_month
-  # Return the next month
-  Period.last_year
-  # Return the last year
-  Period.today
-  # No comment
+Period.this_week
+# Same as Period.week(Time.now) but shorter
+Period.next_month
+# Return the next month
+Period.last_year
+# Return the last year
+Period.today
+# No comment
 ```
 
-### HasMany smaller-periods
+## HasMany
 
 **FreePeriod** and some **StandardPeriod** respond to `.days`, `.weeks`, `.months`, `.quarters` and `.years`    
-These methods return an array of **StandardPeriod** who are include inside the current period
+These methods return an array of **StandardPeriod** who are overlapping the current period
 
 | HasMany -> [\<StandardPeriod>] | .days | .weeks | .months | .quarters | .years |
 |-------------------------------|:----:|:-----:|:------:|:--------:|:-----:|
@@ -133,13 +139,15 @@ These methods return an array of **StandardPeriod** who are include inside the c
 
 #### Example
 ```ruby
-  # Get how many weeks there is from the beginning of time ?
-  Period.new('01/01/1970'..Time.now).weeks.count
-  # How many day in the current quarter
-  Period.this_quarter.days.count
+# Get how many weeks there is from the beginning of time ?
+Period.new('01/01/1970'..Time.now).weeks.count
+# How many day in the current quarter
+Period.this_quarter.days.count
+# Get all the quarters overlapping a Period of time
+Period.new(...).quarters
 ```
 
-### BelongsTo greater-period
+## BelongsTo
 
 **StandardPeriod** respond to `.day`, `.week`, `.month`, `.quarter` and `.year`        
 These methods return a **StandardPeriod** who include the current period    
@@ -157,29 +165,61 @@ These methods return a **StandardPeriod** who include the current period
 #### Example with BelongTo and HasMany
 
 ```ruby
-  # Get the first day, of the last week, of the second month, of the current year
-  Period.this_year.months.second.weeks.last.days.first
+# Get the first day, of the last week, of the second month, of the current year
+Period.this_year.months.second.weeks.last.days.first
 ```
 
-### ActiveRecord
+## ActiveRecord
 
 As **Period** inherite from **Range**, you can natively use them in **ActiveRecord** query
 
 ```ruby
-  # Get all book published this year
-  Book.where(published_at: Period.this_year)
+# Get all book published this year
+Book.where(published_at: Period.this_year)
 ```
 
-### I18n and to_s
+## Rails Controller
+
+In a Controller, use the error handling to validate the date for you
+
+```ruby
+class BookController < ApplicationController
+  def between # match via GET and POST
+    # Default value for the range in GET context
+    params[:from] ||= 1.month.ago
+    params[:to]   ||= Time.now
+
+    begin
+      # Retrieve books from the DB
+      @books = Book.where(published: Period.new(params[:from]..params[:to]))
+    rescue ArgumentError => e
+      # Period will handle mis-formatted date and incoherent period
+      # I18n is support for errors messages
+      flash[:alert] = e.message
+    end
+  end
+end
+```
+
+## I18n and to_s
 
 I18n is supported for `en` and `fr`   
 
 ```ruby
-  Period.new('01/01/2000'...'01/02/2001').to_s
-  => "From the 01 January 2000 to the 31 January 2001 included"
-  I18n.locale = :fr
-  Period.new('01/01/2000'...'01/02/2001').to_s
-  => "Du 01 janvier 2000 au 31 janvier 2001 inclus"
+Period.new('01/01/2000'...'01/02/2001').to_s
+=> "From the 01 January 2000 to the 31 January 2001 included"
+I18n.locale = :fr
+Period.new('01/01/2000'...'01/02/2001').to_s
+=> "Du 01 janvier 2000 au 31 janvier 2001 inclus"
+```
+Errors are also supported
+```ruby
+Period.new 'Foo'..'Bar'
+#=> ArgumentError (The start date is invalid)
+Period.new '01/02/3030'..'Bar'
+#=> ArgumentError (The end date is invalid)
+Period.new '01/02/3030'..'01/01/2020'
+#=> ArgumentError (The start date is greater than the end date)
 ```
 
 See `locales/en.yml` to implement your language support
@@ -198,11 +238,28 @@ For a FreePeriod or if you need to print the start and the end of your period di
   end
 ```
 
-### Bug reports
+## The tricky case of Weeks
+
+Weeks are implemented following the [ISO 8601](https://en.wikipedia.org/wiki/ISO_week_date)      
+So `Period.this_month.weeks.first` doesn't necessarily include the first days of the month
+
+## TimeZone
+
+Time zone are supported, you have nothing to do   
+If you change the global `Time.zone` of your app, you have nothing to do    
+If your Period [begin in a time zone and end in another](https://en.wikipedia.org/wiki/Daylight_saving_time), you have nothing to do
+
+## Bug reports
+
+If you discover any bugs, feel free to create an [issue on GitHub](https://github.com/billaul/period/issues)        
+Please add as much information as possible to help us in fixing the potential bug     
+We also encourage you to help even more by forking and sending us a pull request
+
+No issues will be addressed outside GitHub
 
-If you discover any bugs, feel free to create an issue on GitHub. Please add as much information as possible to help us in fixing the potential bug. We also encourage you to help even more by forking and sending us a pull request.
+## Maintainer
 
-https://github.com/billaul/period/issues
+* Myself (https://github.com/billaul)
 
 ## License
 

data/lib/period.rb

@@ -2,7 +2,6 @@ require_relative 'period/version.rb'
 require 'active_support/all'
 require 'i18n'
 require_relative 'numeric.rb'
-
 require_relative 'period/free_period.rb'
 require_relative 'period/day.rb'
 require_relative 'period/week.rb'

data/lib/period/free_period.rb

@@ -5,9 +5,6 @@ require_relative 'has_many/months.rb'
 require_relative 'has_many/quarters.rb'
 require_relative 'has_many/years.rb'
 
-I18n.load_path << 'locales/fr.yml'
-I18n.load_path << 'locales/en.yml'
-
 class Period::FreePeriod < Range
   include Comparable
 

data/lib/period/has_many/weeks.rb

@@ -4,7 +4,6 @@ module Period
     # @note when include this module provide itterable access to the weeks of
     # the FreePeriod
     module Weeks
-      # TODO, rewrite this to respect ISO %V %G
       def weeks
         @weeks ||= []
         return @weeks if @weeks.present?

data/lib/period/version.rb

@@ -1,5 +1,5 @@
 module Period
 
-  VERSION = '1.0.3'.freeze
+  VERSION = '1.0.8'.freeze
 
 end

data/period.gemspec

@@ -6,7 +6,6 @@ Gem::Specification.new do |spec|
   spec.name          = 'smart-period'
   spec.version       = Period::VERSION
   spec.authors       = ['billau_l']
-  spec.email         = ['billau_l@modulotech.fr']
 
   spec.summary       = 'Manage time ranges without brain damage.'
   # spec.description   = "Period.new('01/01/2020'..Time.now)"
@@ -35,12 +34,11 @@ Gem::Specification.new do |spec|
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = %w[lib locals]
+  spec.require_paths = %w[lib]
 
-  spec.required_ruby_version = '~> 2.5'
-  spec.add_runtime_dependency 'activesupport', '5.2.3'
-  spec.add_runtime_dependency 'i18n', '1.6.0'
+  spec.required_ruby_version = '>= 2.5'
+  spec.add_runtime_dependency 'activesupport', '>= 5', '< 7'
+  spec.add_runtime_dependency 'i18n', '~> 1'
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rails-i18n', '~> 6.0.0'
 end

metadata

@@ -1,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: smart-period
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.8
 platform: ruby
 authors:
 - billau_l
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-26 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.2.3
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,23 +72,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rails-i18n
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 6.0.0
 description:
 email:
-- billau_l@modulotech.fr
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -95,6 +86,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- config/locales/en.yml
+- config/locales/fr.yml
 - lib/.DS_Store
 - lib/numeric.rb
 - lib/period.rb
@@ -117,8 +110,6 @@ files:
 - lib/period/version.rb
 - lib/period/week.rb
 - lib/period/year.rb
-- locales/en.yml
-- locales/fr.yml
 - period.gemspec
 homepage: https://github.com/billaul/period
 licenses:
@@ -132,10 +123,9 @@ post_install_message:
 rdoc_options: []
 require_paths:
 - lib
-- locals
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement