opt_struct 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33f00177f26d90bc4c9407bfb63860b7ef223f73545311fd26e0e64039f9da92
-  data.tar.gz: 6d5a5f91b1955e81607abb22c1704b36c3dbb9870a76fa6b26e494e19ccb3b4b
+  metadata.gz: 824012017028badde180165fa6280f398cbf138f09f8600319625e92fbaf67ed
+  data.tar.gz: 2c612d601c220eb88aaaf656917cd06d0edc7a87b70f84c67cda6b17e6cbbe94
 SHA512:
-  metadata.gz: e11a757d9319851bddcc69052076996d618fe2f281822abd281fcfa4cefda3a4d2cda3c424e9ef3882800f76ff7435ddc327f71bfab69742e8ca5dfae98e1003
-  data.tar.gz: f9174dce367fee3f1fea9bed17c8c004e1b6a8b73d4597e3bcb6bfb02d08d3e36b0b76e3bb0989d66e05983f4d895c6b4e0392a08555edf71887053548972782
+  metadata.gz: f7cf9e8c1d9e0b9c40a2f08c1f32784fa61b38a14edac39f4bef3f887845827a57f9b813e2f8df6dbb0436734c8f5895d7b25f45adb2bff3fa82eb7e87766fee
+  data.tar.gz: aea1084efba08f15951e7d8629c1a8211d66bddd720dfee19a1c1ec5a8eb52d6c73f047ac4ae8c5b7a969912113b0093249f48f991415ca932170d64e69b956d

data/lib/opt_struct.rb

@@ -3,10 +3,11 @@ require "opt_struct/module_methods"
 require "opt_struct/instance_methods"
 
 module OptStruct
+  RESERVED_WORDS = %i(class defaults options fetch check_required_args check_required_keys).freeze
 
-  def self._inject_struct(target, source, args = [], defaults = {}, &callback)
+  def self._inject_struct(target, source, args = [], **defaults, &callback)
     structs = Array(source.instance_variable_get(:@_opt_structs)).dup
-    if args.any? || defaults.any? || callback
+    if args.any? || defaults.any? || block_given?
       structs << [args, defaults, callback]
     end
     target.instance_variable_set(:@_opt_structs, structs)
@@ -18,7 +19,7 @@ module OptStruct
       end
       structs.each do |s_args, s_defaults, s_callback|
         target.expect_arguments *s_args if s_args.any?
-        target.options s_defaults       if s_defaults.any?
+        target.options **s_defaults     if s_defaults.any?
         target.class_exec(&s_callback)  if s_callback
       end
     else
@@ -38,10 +39,10 @@ module OptStruct
   end
 
   def self.new(*args, **defaults, &callback)
-    _inject_struct(Class.new, self, args.map(&:to_sym), defaults, &callback)
+    _inject_struct(Class.new, self, args.map(&:to_sym), **defaults, &callback)
   end
 
   def self.build(*args, **defaults, &callback)
-    _inject_struct(Module.new, self, args.map(&:to_sym), defaults, &callback)
+    _inject_struct(Module.new, self, args.map(&:to_sym), **defaults, &callback)
   end
 end

data/lib/opt_struct/class_methods.rb

@@ -1,68 +1,82 @@
 module OptStruct
   module ClassMethods
     def inherited(subclass)
-      instance_variables.each do |v|
-        ivar = instance_variable_get(v)
-        subclass.send(:instance_variable_set, v, ivar.dup) if ivar
+      opt_struct_class_constants.each do |c|
+        subclass.const_set(c, const_get(c)) if const_defined?(c)
       end
     end
 
+    # overwritten if `required` is called
     def required_keys
-      @required_keys ||= []
+      [].freeze
     end
 
-    def required(*keys)
-      required_keys.concat keys
-      option_accessor *keys
+    def required(*keys, **options)
+      add_required_keys *keys
+      option_accessor *keys, **options
     end
 
-    def option_reader(*keys)
+    def option_reader(*keys, **options)
       keys.each do |key|
-        define_method(key) { options[key] }
+        class_eval <<~RUBY
+          #{options[:private] ? "private" : ""} def #{key}
+            options[:#{key}]
+          end
+        RUBY
       end
     end
 
-    def option_writer(*keys)
+    def option_writer(*keys, **options)
       keys.each do |key|
-        define_method("#{key}=") { |value| options[key] = value }
+        class_eval <<~RUBY
+          #{options[:private] ? "private" : ""} def #{key}=(value)
+            options[:#{key}] = value
+          end
+        RUBY
       end
     end
 
-    def option_accessor(*keys)
+    def option_accessor(*keys, **options)
       check_reserved_words(keys)
-      option_reader *keys
-      option_writer *keys
+      option_reader *keys, **options
+      option_writer *keys, **options
     end
 
-    def option(key, default = nil, **options)
+    def option(key, default = nil, required: false, **options)
       default = options[:default] if options.key?(:default)
-      defaults[key] = default
-      required_keys << key if options[:required]
-      option_accessor key
+      add_defaults key => default
+      add_required_keys key if required
+      option_accessor key, **options
     end
 
     def options(*keys, **keys_defaults)
       option_accessor *keys if keys.any?
       if keys_defaults.any?
-        defaults.merge!(keys_defaults)
+        add_defaults keys_defaults
         option_accessor *(keys_defaults.keys - expected_arguments)
       end
     end
 
     def defaults
-      @defaults ||= {}
+      const_defined?(:OPT_DEFAULTS) ? const_get(:OPT_DEFAULTS) : {}
+    end
+
+    # overwritten if `expect_arguments` is called
+    def expected_arguments
+      [].freeze
     end
 
     def expect_arguments(*arguments)
       required(*arguments)
-      expected_arguments.concat(arguments)
+      combined = expected_arguments + arguments
+      class_eval <<~EVAL
+        def self.expected_arguments
+          #{combined.inspect}.freeze
+        end
+      EVAL
     end
     alias_method :expect_argument, :expect_arguments
 
-    def expected_arguments
-      @expected_arguments ||= []
-    end
-
     def init(meth = nil, &blk)
       add_callback(:init, meth || blk)
     end
@@ -76,23 +90,60 @@ module OptStruct
       add_callback(:around_init, meth || blk)
     end
 
-    def add_callback(name, callback)
-      @_callbacks ||= {}
-      @_callbacks[name] ||= []
-      @_callbacks[name] << callback
+    def all_callbacks
+      const_defined?(:OPT_CALLBACKS) ? const_get(:OPT_CALLBACKS) : {}.freeze
     end
 
-    def all_callbacks
-      @_callbacks
+    def shareable?
+      const_defined?(:SHAREABLE) && const_get(:SHAREABLE)
+    end
+
+    def shareable!
+      return if shareable?
+      const_set(:SHAREABLE, true)
     end
 
     private
 
-    RESERVED_WORDS = %i(class defaults options fetch check_required_args check_required_keys)
+    def share(value)
+      return value unless shareable?
+      defined?(Ractor) ? Ractor.make_shareable(value) : value
+    end
+
+    def add_required_keys(*keys)
+      combined = required_keys + keys
+      class_eval <<~RUBY
+        def self.required_keys
+          #{combined.inspect}.freeze
+        end
+      RUBY
+    end
+
+    def add_defaults(defaults_to_add)
+      freezer = defaults.dup
+      defaults_to_add.each { |k, v| freezer[k] = share(v) }
+      remove_const(:OPT_DEFAULTS) if const_defined?(:OPT_DEFAULTS)
+      const_set(:OPT_DEFAULTS, freezer.freeze)
+    end
+
+    def add_callback(name, callback)
+      if const_defined?(:OPT_CALLBACKS)
+        callbacks_for_name = (all_callbacks[name] || []) + [callback]
+        callbacks_hash = all_callbacks.merge(name => callbacks_for_name).freeze
+        remove_const(:OPT_CALLBACKS)
+        const_set(:OPT_CALLBACKS, callbacks_hash)
+      else
+        const_set(:OPT_CALLBACKS, { name => [ callback ] })
+      end
+    end
+
+    def opt_struct_class_constants
+      [:OPT_DEFAULTS, :OPT_CALLBACKS]
+    end
 
     def check_reserved_words(words)
       Array(words).each do |word|
-        if RESERVED_WORDS.member?(word)
+        if OptStruct::RESERVED_WORDS.member?(word)
           raise ArgumentError, "Use of reserved word is not permitted: #{word.inspect}"
         end
       end

data/lib/opt_struct/module_methods.rb

@@ -22,8 +22,8 @@ module OptStruct
       options
       expect_arguments
     ).each do |class_method|
-      define_method(class_method) do |*args|
-        @_opt_structs << [[], {}, -> { send(class_method, *args) }]
+      define_method(class_method) do |*args, **options|
+        @_opt_structs << [[], {}, -> { send(class_method, *args, **options) }]
       end
     end
   end

data/lib/opt_struct/version.rb

@@ -1,3 +1,3 @@
 module OptStruct
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_struct
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Carl Zulauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2021-03-30 00:00:00.000000000 Z
 dependencies: []
 description: Struct with support for keyword params and mixin support
 email:
@@ -43,7 +43,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: The Option Struct