nxt_support 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 469fc9a13f4a9363e12d67a2640d9b28bdde711acf66fecbb2b42da9ab2a3824
-  data.tar.gz: 46a8fbd8d133be5e79e6d5652dc4ecfcc23d7550f47a06396149216accf85848
+  metadata.gz: 3f951700c6299147ea96c2065fc17079862d4cbf1c42a18f7b7cd93a4b0b14fb
+  data.tar.gz: 19ccfbd579f45fdd335a3ebe5033fe5c697172df65a758ce825d88f97ea18e27
 SHA512:
-  metadata.gz: 1c34b8ea6c57ddfac5861d6c5aac8baf42c5d51f93441ae1605384f2ab4ecfbe0dcebc3e749e4db396e8b529047962d0bf2b49d346e5e54515824db90a158ca8
-  data.tar.gz: 7a24934f8045dcbc45dfa6ee9bc48ebc023502ee66208e55bb4d0ebbc273d31271857b04e1d699567549e08c82bd49c41e417c72a353c3451e931da48312d09e
+  metadata.gz: '084dbc6eec41a7b755a5b762494f063e0f02676adc34740554e30e3f32b73999521e76fdacd64e6a90ab61f81028bf9c123c29932c898414c8df549ef7e23cb3'
+  data.tar.gz: fd42adb4583b76b9bfa08302b0ebed82489e31a7e17fd2eee4f98bab6fa0f8becc85cd585ac1e38b1fadf4fdf41c8572d4307c666b5c72170f8292e111afdbf6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# v0.1.3 2020-02-19
+
+- Added `NxtSupport::IndifferentlyAccessibleJsonAttrs`
+- Added `NxtSupport::HasTimeAttributes`.
+
 # v0.1.2 2020-02-12
 
 - Added `NxtSupport::Email`.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nxt_support (0.1.2)
+    nxt_support (0.1.3)
       rails
 
 GEM

data/README.md

@@ -32,6 +32,18 @@ Enjoy support for your models.
 
 This class collects useful tools around working with email addresses. Use `NxtSupport::Email::REGEXP` to match email address strings. See the sources for a list of criteria it validates.
 
+#### NxtSupport::IndifferentlyAccessibleJsonAttrs
+
+This mixin provides the `indifferently_accessible_json_attrs` class method which serializes and deserializes JSON database columns with `ActiveSupport::HashWithIndifferentAccess` instead of `Hash`.
+
+```ruby
+class MyModel < ApplicationRecord
+  include IndifferentlyAccessibleJsonAttrs
+  
+  indifferently_accessible_json_attrs :data
+end
+```
+
 #### NxtSupport::SafelyFindOrCreateable
 
 The `NxtSupport::Models::SafelyFindOrCreateable` concern is aimed at ActiveRecord models with a uniqueness database constraint. If you use `find_or_create_by` from ActiveRecord, it can happen that the `find_by` call returns `nil` (because no record for the given conditions exists), but in the small timeframe between the `find_by` and the `create` call, another thread inserts a record, so that the `create` call raises an error.
@@ -46,6 +58,22 @@ end
 Book.safely_find_or_create_by!(market: 'de', title: 'Moche!')
 ```
 
+### NxtSupport/Serializers
+
+Enjoy mixins for your serializers.
+
+#### NxtSupport::HasTimeAttributes
+
+This mixin provides your serializer classes with a `attribute_as_iso8601` and a `attributes_as_iso8601` method. They behave almost the same as the `attribute` method of [active_model_serializers](https://github.com/rails-api/active_model_serializers) (in fact they call it behind the scenes), but they convert the values of the given attributes to an ISO8601 string. This is useful for `Date`, `Time` or `ActiveSupport::Duration` values.
+
+```ruby
+class MySerializer < ActiveModel::Serializer
+  include NxtSupport::HasTimeAttributes
+  
+  attributes_as_iso8601 :created_at, :updated_at
+end
+```
+
 ### NxtSupport/Util
 
 Enjoy some useful utilities

data/lib/nxt_support.rb

@@ -1,6 +1,7 @@
 require 'active_support/all'
 require "nxt_support/version"
 require "nxt_support/models"
+require "nxt_support/serializers"
 require "nxt_support/util"
 
 module NxtSupport

data/lib/nxt_support/models.rb

@@ -1,2 +1,3 @@
 require "nxt_support/models/email"
 require "nxt_support/models/safely_find_or_createable"
+require "nxt_support/models/indifferently_accessible_json_attrs"

data/lib/nxt_support/models/indifferently_accessible_json_attrs.rb

@@ -0,0 +1,41 @@
+module NxtSupport
+  module IndifferentlyAccessibleJsonAttrs
+    extend ActiveSupport::Concern
+
+    class JsonSerializer
+      class << self
+        def load(str)
+          indifferent_accessable(JSON.load(str))
+        end
+
+        def dump(obj)
+          JSON.dump(obj)
+        end
+
+        private
+
+        def indifferent_accessable(obj)
+          if obj.is_a?(Array)
+            obj.map! { |o| indifferent_accessable(o) }
+          elsif obj.is_a?(Hash)
+            obj.with_indifferent_access
+          elsif obj.is_a?(NilClass)
+            obj
+          else
+            raise ArgumentError, "Cant deserialize '#{obj}'"
+          end
+        end
+      end
+    end
+
+    class_methods do
+      def indifferently_accessible_json_attrs(*attrs)
+        attrs.each do |attr|
+          serialize attr, JsonSerializer
+        end
+      end
+
+      alias_method :indifferently_accessible_json_attr, :indifferently_accessible_json_attrs
+    end
+  end
+end

data/lib/nxt_support/serializers.rb

@@ -0,0 +1 @@
+require "nxt_support/serializers/has_time_attributes"

data/lib/nxt_support/serializers/has_time_attributes.rb

@@ -0,0 +1,21 @@
+module NxtSupport
+  module HasTimeAttributes
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def attributes_as_iso8601(*attr_names)
+        attr_names.each do |attr_name|
+          attribute_as_iso8601(attr_name)
+        end
+      end
+
+      def attribute_as_iso8601(attr_name)
+        define_method(attr_name) do
+          object.send(attr_name)&.iso8601
+        end
+
+        attribute attr_name
+      end
+    end
+  end
+end

data/lib/nxt_support/version.rb

@@ -1,3 +1,3 @@
 module NxtSupport
-  VERSION = "0.1.2".freeze
+  VERSION = "0.1.3".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_support
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nils Sommer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-12 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -121,7 +121,10 @@ files:
 - lib/nxt_support.rb
 - lib/nxt_support/models.rb
 - lib/nxt_support/models/email.rb
+- lib/nxt_support/models/indifferently_accessible_json_attrs.rb
 - lib/nxt_support/models/safely_find_or_createable.rb
+- lib/nxt_support/serializers.rb
+- lib/nxt_support/serializers/has_time_attributes.rb
 - lib/nxt_support/util.rb
 - lib/nxt_support/util/enum_hash.rb
 - lib/nxt_support/version.rb