vcdry 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 185f278d99a71c67953d1453a9b2c62ee2afac0c914d3a4c8793c5677396b232
-  data.tar.gz: 84290611068e8991a71164cdd11ca4d2e318ce364975905b1ece0c75e5a2dada
+  metadata.gz: 23e7e6597fb4e286a35c06290cce1efbc90421cf7b9272e6927060ec7afa1836
+  data.tar.gz: 1d85c66ceaa4402ba2b2132cf0659c45e8d28aafa99ec9297a925ecee2c1c860
 SHA512:
-  metadata.gz: 95dd05bd5d0654374b46a99d43cb0029e9302a3b38a0d60e4278b64a2e0edb2e5dce528a91a0c732ab494fafa9e2cf287977960f31cc4d4411ec19947f80eb7b
-  data.tar.gz: c47f92e3d43e7b96f7901b37a4633d6a8e9a96a787e8fc9e2ad0d4d922d76bcfe532eb623059305b3c7c348f629e22bf580baafaba39cba3737927bf45a2b7c1
+  metadata.gz: 5100e330ab5256cdc3bc7449543265f6334034be7876370f0f007b3cc5f51f96dd5ad99e98efa5d7a75029fc7a01487d2285b9294ea180cfb6329abf808085e1
+  data.tar.gz: c09be2d8cbc5188d80c82ebd693530ee9cc51e12018f08ea388d662ce9fd93a8d27b3e2b629094e089eb3371c16a11a2fdb3cf099ff1a561749ee83e1f16fe07

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-## [Unreleased]
+## [1.1.1] - 2023-05-25
+
+- Breakout `VCDry::Core` from `VCDry::DSL` to better support mixing in `keyword`
+  behavior in other gems like `vcfb`.
+
+## [1.0.1] - 2023-04-28
+
+- Added initializer callbacks.
+- Treat `default: nil` and `optional: true` identically.
+- Fix for `other_keywords` to accept the optional type as intended.
+- Fix for inheritance issues when including VCDry::DSL on a parent component.
+- Fix to allow passing `nil` to an optional keyword.
 
 ## [1.0.0] - 2023-04-16
 

data/README.md

@@ -40,6 +40,7 @@ end
     - [other_keywords](#other_keywords)
     - [strict_keywords](#strict_keywords)
     - [remove_keyword](#remove_keyword)
+    - [Callbacks](#callbacks)
   - [Types](#types)
   - [Development](#development)
   - [Contributing](#contributing)
@@ -260,6 +261,25 @@ class MyOtherComponent < MyComponent
 end
 ```
 
+### Callbacks
+
+Including `VCDry::DSL` adds support through `ActiveModel::Callbacks` for the
+`before_initialize`, `after_initialization`, and `around_initialize` callbacks
+to minimize the need to override the initlialize method.
+
+```ruby
+class MyComponent < MyComponent
+  before_initialize ->() { @links = [] }
+  after_intialize :some_method
+
+  private
+
+  def some_method
+    # do something fancy
+  end
+end
+```
+
 ## Types
 
 The following types are built-in to `vcdry`.
@@ -280,6 +300,32 @@ VCDry::Types.add_type(:boolean, ->(value) { ActiveRecord::Type::Boolean.new.cast
 VCDry::Types.add_type(:custom_hash, ->(value) { CustomHash.new(value) })
 ```
 
+## Mix-in Behavior
+
+To mix-in the `keyword` behavior without using the `VCDry::DSL` (and its
+initialize method), you can call include `VCDry::Core` instead and then call
+`vcdry_parse_keywords` against the hash you wish to parse out keywords from.
+
+The `vcdry_parse_keywords` accepts a hash and returns a hash of all key/value
+pairs that were not pulled out as a `keyword`.
+
+> **Note**: Including `VCDry::Core` does not include support for
+> `other_keywords`, `strict_keywords`, or enable support for callbacks.
+
+```ruby
+class HeadingComponent
+  include VCDry::Core
+
+  keyword :size, :symbol, default: :md
+  other_keywords :options
+
+  def initialize(text, **options)
+    @text = text
+    @options = vcdry_parse_keywords(options)
+  end
+end
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/lib/vcdry/config.rb

@@ -13,6 +13,12 @@ module VCDry
       @name = name.to_sym
       @type = (type.nil? || type.respond_to?(:call)) ? type : VCDry::Types[type]
       @options = options
+
+      # Translate default: nil to optional: true
+      if @options.key?(:default) && @options[:default].nil?
+        @options.delete(:default)
+        @options[:optional] = true
+      end
     end
 
     def array?
@@ -48,7 +54,7 @@ module VCDry
     end
 
     def optional?
-      default? || !!@options[:optional]
+      default? || @options[:optional]
     end
 
     def required?
@@ -72,6 +78,7 @@ module VCDry
     def type_cast_value(value)
       return if value == NOT_DEFINED
       return value if @type.nil?
+      return if value.nil? && @options[:optional]
 
       value = @type.call(value)
       if enum? && enum_values.exclude?(value)

data/lib/vcdry/core.rb

@@ -0,0 +1,59 @@
+require "active_support/concern"
+require "active_support/core_ext/hash"
+require "active_support/core_ext/module/delegation"
+
+require_relative "error"
+require_relative "registry"
+
+module VCDry
+  module Core
+    extend ActiveSupport::Concern
+
+    def vcdry_parse_keywords(kwargs = {})
+      kwargs = kwargs.symbolize_keys
+      self.class.vcdry.keyword_configs.each do |config|
+        if config.required? && !kwargs.key?(config.name)
+          raise MissingRequiredKeywordError.new(config.name)
+        end
+
+        value = kwargs.fetch(config.name, config.default)
+        instance_variable_set(config.instance_variable, config.type_cast(value))
+      end
+      kwargs.except(*self.class.vcdry.keywords)
+    end
+
+    class_methods do
+      delegate :remove_keyword, to: :vcdry
+
+      def inherited(subclass)
+        subclass.instance_variable_set(:@vcdry, @vcdry&.dup)
+        super
+      end
+
+      def keyword(name, type = nil, **options)
+        name = name.to_sym
+        config = vcdry.keyword(name, type, options)
+        vcutils_define_helper_methods(config)
+      end
+
+      def vcdry
+        @vcdry ||= Registry.new
+      end
+
+      def vcutils_define_helper_methods(config)
+        if config.enum?
+          config.enum_values.each do |value|
+            define_method "#{config.name}_#{value}?" do
+              instance_variable_get(config.instance_variable) == value
+            end
+          end
+        end
+        if config.optional?
+          define_method "#{config.name}?" do
+            instance_variable_get(config.instance_variable).present?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vcdry/dsl.rb

@@ -1,33 +1,29 @@
+require "active_model/callbacks"
 require "active_support/concern"
-require "active_support/core_ext/hash"
-require "active_support/core_ext/module/delegation"
 
+require_relative "core"
 require_relative "error"
-require_relative "registry"
 
 module VCDry
   module DSL
     extend ActiveSupport::Concern
+    include Core
 
-    def initialize(**kwargs)
-      kwargs = kwargs.symbolize_keys
-      vcdry_parse_keywords(**kwargs)
-      vcdry_parse_unknown_keywords(**kwargs)
-    end
+    included do
+      extend ActiveModel::Callbacks
 
-    def vcdry_parse_keywords(**kwargs)
-      self.class.vcdry.keyword_configs.each do |config|
-        if config.required? && !kwargs.key?(config.name)
-          raise MissingRequiredKeywordError.new(config.name)
-        end
+      define_model_callbacks :initialize
+    end
 
-        value = kwargs.fetch(config.name, config.default)
-        instance_variable_set(config.instance_variable, config.type_cast(value))
+    def initialize(**kwargs)
+      run_callbacks :initialize do
+        unknown_kwargs = vcdry_parse_keywords(kwargs)
+        vcdry_parse_unknown_keywords(unknown_kwargs)
+        super
       end
     end
 
-    def vcdry_parse_unknown_keywords(**kwargs)
-      unknown_kwargs = kwargs.except(*self.class.vcdry.keywords)
+    def vcdry_parse_unknown_keywords(unknown_kwargs = {})
       raise UnknownArgumentError.new(*unknown_kwargs.keys) if self.class.vcdry.strict? && unknown_kwargs.present?
       return unless self.class.vcdry.gather_unknown_keywords?
 
@@ -36,36 +32,7 @@ module VCDry
     end
 
     class_methods do
-      delegate :other_keywords, :remove_keyword, :strict_keywords, to: :vcdry
-
-      def inherited(subclass)
-        subclass.instance_variable_set(:@vcdry, @vcdry&.dup)
-      end
-
-      def keyword(name, type = nil, **options)
-        name = name.to_sym
-        config = vcdry.keyword(name, type, options)
-        vcutils_define_helper_methods(config)
-      end
-
-      def vcdry
-        @vcdry ||= Registry.new
-      end
-
-      def vcutils_define_helper_methods(config)
-        if config.enum?
-          config.enum_values.each do |value|
-            define_method "#{config.name}_#{value}?" do
-              instance_variable_get(config.instance_variable) == value
-            end
-          end
-        end
-        if config.optional?
-          define_method "#{config.name}?" do
-            instance_variable_get(config.instance_variable).present?
-          end
-        end
-      end
+      delegate :other_keywords, :strict_keywords, to: :vcdry
     end
   end
 end

data/lib/vcdry/registry.rb

@@ -41,7 +41,7 @@ module VCDry
       @keywords.keys
     end
 
-    def other_keywords(name, type: :hash)
+    def other_keywords(name, type = :hash)
       @other_keywords_config = Config.new(name, type)
     end
 

data/lib/vcdry/version.rb

@@ -1,3 +1,3 @@
 module VCDry
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/vcdry.rb

@@ -1,9 +1,7 @@
+require_relative "vcdry/config"
+require_relative "vcdry/core"
 require_relative "vcdry/dsl"
 require_relative "vcdry/error"
-require_relative "vcdry/config"
 require_relative "vcdry/registry"
 require_relative "vcdry/types"
 require_relative "vcdry/version"
-
-module VCDry
-end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vcdry
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-16 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,6 +76,7 @@ files:
 - Rakefile
 - lib/vcdry.rb
 - lib/vcdry/config.rb
+- lib/vcdry/core.rb
 - lib/vcdry/dsl.rb
 - lib/vcdry/error.rb
 - lib/vcdry/registry.rb