opt_struct 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a55fe71d013b67b97989363367748f78f0cf50ba890aeafdd69183b11c9bcac
-  data.tar.gz: ee9465e01cac7b9978a3860cbabf0e26322246b7eda546b01a23ff6afb9715bf
+  metadata.gz: ef6cb2533d486038390ac0975e38f6c0d3e9486c8c213326f48caf58c57dfb09
+  data.tar.gz: 98c38c235c3e24588f9a3efb7d69ac4e40da9d7d6650ebb1a0aca3c669240f45
 SHA512:
-  metadata.gz: d688e9d507c70fcc588aff5a6b9c7109eff834a7f121f0508796758b29e4c86d93c134c6e43396eca023fadc05113ca79ddae40087f20e049445c4d4343a7335
-  data.tar.gz: 21a4f2a0a46034a18c9973596ff0f4f569d853e02f4c4b98bb3331368baee5af2b4a8718ace0a42b21c6375168cb1b6f9eabd2dff045f09f5aeed681600c69f5
+  metadata.gz: 3f7346d74b2ddcdef6ff61ba638e794247fbc714c9e796a0f13297fae9d77d7482f452e43f5b2830c54129b3d6cf22f19d8315d75c360d1eb575027325a33337
+  data.tar.gz: cbeba0f215a42989eb6124fe095d6d6332fe015b844f972ba63aa15b085b0f7df6812751c736867743f86029187b829e44fd9d8aed88d78e8087076e78192e06

data/README.md

@@ -108,7 +108,7 @@ class AuditLog
 end
 ```
 
-These example results in an `AuditLog` class with identical behavior, but no explicit `Visitable` module.
+These examples result in an `AuditLog` class with identical behavior, but no explicit `Visitable` module.
 
 ```ruby
 class AuditLog
@@ -153,7 +153,7 @@ end
 Passing a Hash to `.new` or `.build` is equivalent to passing the same hash to `options`
 
 ```ruby
-User < OptStruct.new(email: nil, role: "member")
+User = OptStruct.new(email: nil, role: "member")
 ```
 
 Default blocks can also be used and are late evaluated on the each struct instance.

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,74 +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) do
-          if options.key?(key)
-            options[key]
-          elsif defaults.key?(key)
-            options[key] = read_default_value(key)
+        class_eval <<~RUBY
+          #{options[:private] ? "private" : ""} def #{key}
+            options[:#{key}]
           end
-        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)
-      default = options[:default] if options.key?(:default)
-      defaults[key] = default
-      required_keys << key if options[:required]
-      option_accessor key
+    def option(key, default = nil, required: false, **options)
+      default ||= options[:default]
+      add_defaults key => default if default || options.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
@@ -82,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/instance_methods.rb

@@ -4,6 +4,7 @@ module OptStruct
       with_init_callbacks do
         @options = options
         assign_arguments(arguments)
+        assign_defaults
         check_required_keys
       end
     end
@@ -24,23 +25,21 @@ module OptStruct
         raise ArgumentError, "missing required keywords: #{missing.inspect}"
       end
     end
-    
+
+    def assign_defaults
+      defaults.each do |key, default_value|
+        next if options.key?(key) # || default_value.nil?
+        options[key] = read_default_value(default_value)
+      end
+    end
+
     def assign_arguments(args)
       self.class.expected_arguments.map.with_index do |key, i|
-        if args.length > i
-          options[key] = args[i]
-        elsif !options.key?(key)
-          if defaults.key?(key)
-            options[key] = read_default_value(key)
-          else
-            raise ArgumentError, "missing required argument: #{key}"
-          end
-        end
+        options[key] = args[i] if args.length > i
       end
     end
-    
-    def read_default_value(key)
-      default = defaults[key]
+
+    def read_default_value(default)
       case default
       when Proc
         instance_exec(&default)

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.0.0"
+  VERSION = "1.2.1"
 end

data/opt_struct.gemspec

@@ -16,8 +16,4 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split("\n").grep(/^lib/)
   spec.files        += %w(README.md opt_struct.gemspec)
   spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,57 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: opt_struct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Carl Zulauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-06 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
+date: 2021-04-19 00:00:00.000000000 Z
+dependencies: []
 description: Struct with support for keyword params and mixin support
 email:
 - carl@linkleaf.com
@@ -85,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.2.3
 signing_key: 
 specification_version: 4
 summary: The Option Struct