active_date_range 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa7f0092dab70e955754434aa37df4f7c0c11c5461d54b377c68d935ad115330
-  data.tar.gz: 44658f76ff5dca0336804ce7b7dc44fee1b96699365bd04e8bbf93741ff77f75
+  metadata.gz: 8f3c8036025bdc70d1d72d08a4d46d5f72ccefc6e072782b15f266fb783b6397
+  data.tar.gz: 8b5dd01d16009fbd7d2df94c3bf65dd71de81f31c610288277bd1dba96cdb610
 SHA512:
-  metadata.gz: e7363eeba6c6e8747afd3e3f576fe2d3b24fbe03b17b30de980458fe4e65b9a13a31344a31207d9ae09fe8d0f7a7e97589e6c697f9564fa7977bbf227e80ac01
-  data.tar.gz: 5a3d15754ce33007ae78e56a0790ac5ede08f34a043d72e0e9866f61f912b2ebec9081af7df285927f83b3d6fd762c20bb4cbb11ae0bf411b7499966f7306e6e
+  metadata.gz: bf8dfe1ba846c42abf2c544819b2938ab477c611d3b8a38775f692fe69e02fdaaa098b5c3634a7369c18cc6ebb4e41cb76b7591acd49736ea2543e146c9764a3
+  data.tar.gz: 4f10617d476efd7275a37e6a3594a2d193bd59aa95c86f25aadc1ae2cc6200e28a0081f55b69b64ed2d1cefc2a7d9a3a938a09b5199c3798c5de0c53c2900d4d

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 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:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    active_date_range (0.5.3)
+    active_date_range (0.6.0)
       activesupport (~> 8.0)
       i18n (~> 1.6)
 

data/README.md

@@ -134,14 +134,14 @@ 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: true`. The attribute then casts to `nil` instead, so a validation can report the problem:
+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: true
+  attribute :period, :date_range, safe_parse: true
 
   validates :period, date_range: { bounded: true }
 end

data/lib/active_date_range/active_model_type.rb

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

data/lib/active_date_range/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveDateRange
-  VERSION = "0.5.3"
+  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.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Edwin Vlieg