vcdry 1.0.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ea70c4d286339f58ec30b1c77ae5ecc1579c52ec511d17aed9ba7afb82b68e36
-  data.tar.gz: 2c0209b85f1175c3f2463b7b8c821eaa30829c88c10ea2b354d5b656079c7391
+  metadata.gz: 23e7e6597fb4e286a35c06290cce1efbc90421cf7b9272e6927060ec7afa1836
+  data.tar.gz: 1d85c66ceaa4402ba2b2132cf0659c45e8d28aafa99ec9297a925ecee2c1c860
 SHA512:
-  metadata.gz: 3f118fe1853440ed1f5fe649851f7801000cd81787022c5ae0cafdab688330a8a3ac452f82321810dbb9906ecbc68b1b8eb5c763d0e9a256a290d59840ca470b
-  data.tar.gz: b4bfbb7e38542cf36bd28503612e8cc4305e3120328e5b13df0305c24d4325f4f8bad71ebf63d879b497dcaff223537b662c3645c80a09dfeaa4e31a110eea43
+  metadata.gz: 5100e330ab5256cdc3bc7449543265f6334034be7876370f0f007b3cc5f51f96dd5ad99e98efa5d7a75029fc7a01487d2285b9294ea180cfb6329abf808085e1
+  data.tar.gz: c09be2d8cbc5188d80c82ebd693530ee9cc51e12018f08ea388d662ce9fd93a8d27b3e2b629094e089eb3371c16a11a2fdb3cf099ff1a561749ee83e1f16fe07

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [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.

data/README.md

@@ -300,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/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,36 +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
+
+    included do
+      extend ActiveModel::Callbacks
+
+      define_model_callbacks :initialize
+    end
 
     def initialize(**kwargs)
       run_callbacks :initialize do
-        kwargs = kwargs.symbolize_keys
-        vcdry_parse_keywords(**kwargs)
-        vcdry_parse_unknown_keywords(**kwargs)
+        unknown_kwargs = vcdry_parse_keywords(kwargs)
+        vcdry_parse_unknown_keywords(unknown_kwargs)
         super
       end
     end
 
-    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
-
-        value = kwargs.fetch(config.name, config.default)
-        instance_variable_set(config.instance_variable, config.type_cast(value))
-      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?
 
@@ -38,44 +31,8 @@ module VCDry
       instance_variable_set(config.instance_variable, config.type_cast(unknown_kwargs))
     end
 
-    included do
-      extend ActiveModel::Callbacks
-
-      define_model_callbacks :initialize
-    end
-
     class_methods do
-      delegate :other_keywords, :remove_keyword, :strict_keywords, 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
+      delegate :other_keywords, :strict_keywords, to: :vcdry
     end
   end
 end

data/lib/vcdry/version.rb

@@ -1,3 +1,3 @@
 module VCDry
-  VERSION = "1.0.1"
+  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.1
+  version: 1.1.1
 platform: ruby
 authors:
 - Alex Monroe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-28 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