serialize_attributes 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 336ab0663fe21a1f3750663a41aec451f209bf1141f233f3043c914aefd0ebf9
-  data.tar.gz: c80f05ff696c4292571c5ae613343687377bb10e1235790ea332dc80e6e15230
+  metadata.gz: c505eb52395e2c8fe3786c3ef97dd04e5a56f978072d839ba517c0069f9dce93
+  data.tar.gz: 5ea660579c45ebd3cca56da5c3ea7e07fe9af5fb38a05fd62d3133f118f3d8df
 SHA512:
-  metadata.gz: c3f9f7d020b7002f2b83e816452f4166a26cb4a1f2fdfaf3271977bfb8c80d8f075456ebeeeec042a1c544786f5fa2a5f80a16f7353596eb4817cdc76e768b95
-  data.tar.gz: 6c0133edf56b9a396cfe011f4abda01d3ac61b1c95dca5329dcaa1d8a29b2bd366ac28f691b8e1d6aa4c565398781131921a6645f8b69a8051565bfabc9b1676
+  metadata.gz: 311846e88d0c92cf41bf5adbd32c1515fbd1d131df0d733cfd444963bedc8594620d05cb12cfe701b40fba851195931f6f53673dcbe25593bf257e2b28c183dc
+  data.tar.gz: c5e2e60ba000e0afe423cee6c37e20fae5b590a39bcadab76d65712db712359e1d4ae3c0532e44565d673cb1c8f55cd4d535b9fdc057f50d11d3e3744f0803e9

data/README.md

@@ -7,6 +7,7 @@ class MyModel
   serialize_attributes :settings do
     attribute :user_name, :string
     attribute :subscribed, :boolean, default: false
+    attribute :subscriptions, :string, array: true 
   end
 end
 ```
@@ -83,6 +84,13 @@ MyModel.serialized_attribute_names(:settings)
 #=> [:user_name, :subscribed]
 ```
 
+You can also get a list of the attributes filtered by a type specifier:
+
+```ruby
+MyModel.serialized_attribute_names(:settings, :boolean)
+#=> [:subscribed]
+```
+
 ### Complex types
 
 Underneath, we use the `ActiveModel::Type` mechanism for type coercion, which means

data/lib/serialize_attributes/store.rb

@@ -4,7 +4,8 @@ module SerializeAttributes
   # SerializeAttributes::Store is the individual store, keyed by name. You can get a
   # reference to the store by calling `Model.serialized_attributes_store(column_name)`.
   class Store
-    def initialize(model_class, column_name, &block) # :nodoc:
+    def initialize(model_class, column_name, &block)
+      # :nodoc:
       @model_class = model_class
       @column_name = column_name
       @attributes = {}
@@ -15,8 +16,31 @@ module SerializeAttributes
       [self, @attributes, @defaults].each(&:freeze)
     end
 
-    # Get a list of the attributes managed by this store
-    def attribute_names = @attributes.keys
+    # Get a list of the attributes managed by this store. Pass an optional `type` argument
+    # to filter attributes by their type.
+    #
+    #   Model.serialize_attributes_store(:settings).attribute_names
+    #   => [:user_name, :subscribed, :subscriptions]
+    #
+    #   Model.serialize_attributes_store(:settings).attribute_names(type: :string)
+    #   => [:user_name, :subscriptions]
+    #
+    #  Model.serialize_attributes_store(:settings).attribute_names(type: :string, array: true)
+    #  => [:subscriptions]
+    #
+    #  Model.serialize_attributes_store(:settings).attribute_names(type: :string, array: false)
+    #  => [:user_name]
+    #
+    #
+    def attribute_names(type: nil, array: nil)
+      attributes = @attributes
+      attributes = @attributes.select { |_, v| v.is_a?(ArrayWrapper) == array } unless array.nil?
+      if type
+        attributes_for_type(attributes, type)
+      else
+        attributes
+      end.keys
+    end
 
     # Cast a stored attribute against a given name
     #
@@ -48,9 +72,17 @@ module SerializeAttributes
 
     private
 
+    def attributes_for_type(attributes, type)
+      type = ActiveModel::Type.lookup(type)&.class if type.is_a?(Symbol)
+      attributes.select do |_, v|
+        v = v.__getobj__ if v.is_a?(ArrayWrapper)
+        v.is_a?(type)
+      end
+    end
+
     def attribute(name, type, **options)
       name = name.to_sym
-      arr  = options.delete(:array) { false }
+      arr = options.delete(:array) { false }
       type = ActiveModel::Type.lookup(type, **options.except(:default)) if type.is_a?(Symbol)
       type = ArrayWrapper.new(type) if arr
 
@@ -126,14 +158,18 @@ module SerializeAttributes
 
     # This method wraps the original store column and catches the `deserialize` call -
     # this gives us a chance to convert the data in the database back into our types.
+    #
+    # We're using the block form of `.attribute` to avoid loading the database schema just
+    # to figure out our wrapping type.
     def wrap_store_column
       return unless @model_class.respond_to?(:attribute_types)
 
-      original_store_column_type = @model_class.attribute_types.fetch(@column_name.to_s)
-      @model_class.attribute(@column_name, StoreColumnWrapper.new(
-                                             original_store_column_type,
-                                             self
-                                           ))
+      store = self
+
+      @model_class.attribute(@column_name) do
+        original_type = @model_class.attribute_types.fetch(@column_name.to_s)
+        StoreColumnWrapper.new(original_type, store)
+      end
     end
   end
 end

data/lib/serialize_attributes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SerializeAttributes
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/serialize_attributes.rb

@@ -34,9 +34,10 @@ module SerializeAttributes
 
     # Get a list of the attributes registered in a given store
     #
-    #   Person.serialized_attribute_names(:settings)
-    def serialized_attribute_names(column_name)
-      serialized_attributes_store(column_name).attribute_names
+    #   Person.serialized_attribute_names(:settings, :string)
+    #   => [:user_name]
+    def serialized_attribute_names(column_name, type = nil)
+      serialized_attributes_store(column_name).attribute_names(type: type)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serialize_attributes
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Zaikio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel