active_date_range 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0b596b6208103ad08949d24191796250a8df396ed0f2536b35578bb250781b3
-  data.tar.gz: 9ade9b1b706a11f9892353a63f9acb61c5e537602de67954c37434f24e0c23bb
+  metadata.gz: 8f3c8036025bdc70d1d72d08a4d46d5f72ccefc6e072782b15f266fb783b6397
+  data.tar.gz: 8b5dd01d16009fbd7d2df94c3bf65dd71de81f31c610288277bd1dba96cdb610
 SHA512:
-  metadata.gz: 1a5ff4a0c6b173751d60f2cc959b614e59216e2c17085556ffe34674596ed74bb776882fcc576f7da8ac20e749d8a1aa9a740210e6da3dad85efb4f93876b086
-  data.tar.gz: 5960b5d080937c6ef690aefb4b6f758035c93a2d483ded6370307253526c69ccf72bfd0398e8f441610a8a2ced1520e860f331b3782e87441b3b05c5c10ffa72
+  metadata.gz: bf8dfe1ba846c42abf2c544819b2938ab477c611d3b8a38775f692fe69e02fdaaa098b5c3634a7369c18cc6ebb4e41cb76b7591acd49736ea2543e146c9764a3
+  data.tar.gz: 4f10617d476efd7275a37e6a3594a2d193bd59aa95c86f25aadc1ae2cc6200e28a0081f55b69b64ed2d1cefc2a7d9a3a938a09b5199c3798c5de0c53c2900d4d

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## 0.6.0
+
+Rename the `safe:` option on the `:date_range` ActiveModel type to `safe_parse:`. On an attribute, `safe: true` reads as a claim that the value is trusted, while it actually describes how the value is parsed. The option was introduced in 0.5.3 and `safe:` now raises an `ArgumentError`:
+
+```ruby
+attribute :period, :date_range, safe_parse: true
+```
+
+  *wesselmoneybird*
+
+## 0.5.3
+
+* Add `safe_parse`, which returns `nil` instead of raising for input that isn't a valid date range. Use it for input you don't control, like a query parameter or a form field:
+
+```ruby
+DateRange.safe_parse("202101..202112") # => DateRange(2021-01-01..2021-12-31)
+DateRange.safe_parse("test")           # => nil
+DateRange.safe_parse("202112..202101") # => nil
+```
+
+  *wesselmoneybird*
+
+* Add a `safe: true` option to the `:date_range` ActiveModel type, which casts to `nil` instead of raising. Use it for attributes fed by input you don't control, so a validation can report the problem:
+
+```ruby
+attribute :period, :date_range, safe: true
+```
+
+  *wesselmoneybird*
+
 ## 0.5.2
 
 * Add calendar-aware `DateRangeValidator` for ActiveModel validations. Unlike `validates_length_of` which compares day counts (causing `1.month` to use ~30.44 day averages), this validator uses date arithmetic so that February (28 or 29 days) correctly satisfies `minimum_duration: 1.month`:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_date_range (0.5.2)
+    active_date_range (0.6.0)
       activesupport (~> 8.0)
       i18n (~> 1.6)
 
@@ -45,9 +45,9 @@ GEM
     bigdecimal (4.0.1)
     builder (3.3.0)
     coderay (1.1.3)
-    concurrent-ruby (1.3.6)
+    concurrent-ruby (1.3.7)
     connection_pool (3.0.2)
-    crass (1.0.6)
+    crass (1.0.7)
     date (3.5.1)
     drb (2.2.3)
     erb (6.0.1)
@@ -86,7 +86,7 @@ GEM
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     logger (1.7.0)
-    loofah (2.25.0)
+    loofah (2.25.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
     lumberjack (1.4.2)
@@ -95,10 +95,10 @@ GEM
     mini_portile2 (2.8.9)
     minitest (5.27.0)
     nenv (0.3.0)
-    nokogiri (1.19.1)
+    nokogiri (1.19.4)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.19.1-x86_64-linux-gnu)
+    nokogiri (1.19.4-x86_64-linux-gnu)
       racc (~> 1.4)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -131,8 +131,8 @@ GEM
       activesupport (>= 5.0.0)
       minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
+    rails-html-sanitizer (1.7.1)
+      loofah (~> 2.25, >= 2.25.2)
       nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
     railties (8.1.2)
       actionpack (= 8.1.2)
@@ -218,4 +218,4 @@ DEPENDENCIES
   rubocop-rails (~> 2.33)
 
 BUNDLED WITH
-   2.3.5
+   2.6.9

data/README.md

@@ -55,6 +55,14 @@ ActiveDateRange::DateRange.parse('20210101..20210115')
 
 Parse accepts three formats: `YYYYMM..YYYYMM`, `YYYYMMDD..YYYYMMDD` and any short hand like `this_month`.
 
+`parse` raises `InvalidDateRangeFormat` or `InvalidDateRange` on input it can't handle. For input you don't control, like a query parameter or a form field, use `safe_parse` instead. It returns `nil` in those cases, the same way `safe_constantize` relates to `constantize`:
+
+```ruby
+ActiveDateRange::DateRange.safe_parse('202101..202112') # => DateRange(2021-01-01..2021-12-31)
+ActiveDateRange::DateRange.safe_parse('test')           # => nil
+ActiveDateRange::DateRange.safe_parse('202112..202101') # => nil
+```
+
 ### The date range instance
 
 A `DateRange` object is an extension of a regular `Range` object. You can use [all methods available on `Range`](https://ruby-doc.org/core-3.0.0/Range.html):
@@ -126,6 +134,21 @@ class Report
 end
 ```
 
+The attribute raises on a value it can't parse. For an attribute fed by input you don't control, like a query parameter or a form field, pass `safe_parse: true`. The attribute then casts through `safe_parse`, so it returns `nil` instead and a validation can report the problem:
+
+```ruby
+class ReportFilter
+  include ActiveModel::Attributes
+  include ActiveModel::Validations
+
+  attribute :period, :date_range, safe_parse: true
+
+  validates :period, date_range: { bounded: true }
+end
+
+ReportFilter.new(period: "test").period # => nil
+```
+
 ### Usage example
 
 Use the shorthands to link to a specific period:

data/lib/active_date_range/active_model_type.rb

@@ -2,7 +2,19 @@
 
 module ActiveDateRange
   class DateRangeType < ActiveModel::Type::String
+    # Pass <tt>safe_parse: true</tt> for attributes fed by input you don't control, like a query
+    # parameter. The attribute then casts through .safe_parse, so it returns nil instead of
+    # raising:
+    #
+    #   attribute :period, :date_range, safe_parse: true
+    def initialize(safe_parse: false)
+      @safe_parse = safe_parse
+      super()
+    end
+
     def cast(value)
+      return ActiveDateRange::DateRange.safe_parse(value) if @safe_parse
+
       ActiveDateRange::DateRange.parse(value)
     end
   end

data/lib/active_date_range/date_range.rb

@@ -41,6 +41,19 @@ module ActiveDateRange
       DateRange.new(parse_date(begin_date), parse_date(end_date, last: true))
     end
 
+    # Parses a date range string like #parse, but returns nil when the input isn't a valid date
+    # range, the same way <tt>safe_constantize</tt> relates to <tt>constantize</tt>. Use this for
+    # input you don't control, like a query parameter or a form field.
+    #
+    #   DateRange.safe_parse("202101..202112") # => DateRange(2021-01-01..2021-12-31)
+    #   DateRange.safe_parse("test")           # => nil
+    #   DateRange.safe_parse("202112..202101") # => nil
+    def self.safe_parse(input)
+      parse(input)
+    rescue InvalidDateRangeFormat, InvalidDateRange
+      nil
+    end
+
     def self.parse_date(input, last: false)
       return if input.blank?
 

data/lib/active_date_range/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveDateRange
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_date_range
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Edwin Vlieg