opt_struct 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e02d02b33fd0c94b79f6e08079fdd1df45deb62fae647d764fd72d6703b6eb00
-  data.tar.gz: '06682687240b5cd22eddb32f0ca2b5682eee3c701f96b769b77dc9343df41463'
+  metadata.gz: 4c47c60bff407dea977e1408716b9d47e0f4b05a16128734601ce2f6e4fbbe50
+  data.tar.gz: 10a2da04669533bafa82384ce79a43083202e0692a93956ef731efc0c5932963
 SHA512:
-  metadata.gz: 43728c868888b3f3506ae75c49a25c01b67bb8e2ff49f58f0944fdda7d37549f9f3f33bf88a6b3fde6ff8ed1add1ea846fbd40439e19c0c4e46384379bc44d9a
-  data.tar.gz: b6546f89c3d8b82167afb694eb2589db67c431d77af45cf6874b4d87d9907a5944fb87088ff7e57e3a899a9cc5594bda50e4fc71ed91181a7d40e883a2b43324
+  metadata.gz: 344f1d25a46748a08c60650f706f4f50697324e6985c6d0c6d57aeb1d0de3cb1ec36f82313aac2d5eaf1733d116ed549818b1d9aa472d725cec88c2209b8e5b8
+  data.tar.gz: c763bced17752180653844b5d6893f477542fe913eceea3d0be084d7a78d1e8d23d94287302f494a743a1da502f04bf86746f0c1e94d9468fd50153c82377133

data/README.md

@@ -1,7 +1,4 @@
-# The Opt Struct [![Build Status][travis-image]][travis-link]
-
-[travis-image]: https://travis-ci.org/carlzulauf/opt_struct.svg?branch=master
-[travis-link]: http://travis-ci.org/carlzulauf/opt_struct
+# The Opt Struct
 
 A struct around a hash. Great for encapsulating actions with complex configuration, like interactor/action classes.
 
@@ -17,7 +14,7 @@ gem "opt_struct"
 class User < OptStruct.new
   required :email, :name
   option :role, default: "member"
-  
+
   def formatted_email
     %{"#{name}" <#{email}>}
   end
@@ -156,7 +153,7 @@ Passing a Hash to `.new` or `.build` is equivalent to passing the same hash to `
 User = OptStruct.new(email: nil, role: "member")
 ```
 
-Default blocks can also be used and are late evaluated on the each struct instance.
+Default blocks can also be used and are late evaluated within the struct instance.
 
 ```ruby
 class User < OptStruct.new
@@ -175,9 +172,9 @@ end
 class User < OptStruct.new
   option :email, nil
   option :role, -> { default_role }
-  
+
   private
-  
+
   def default_role
     "member"
   end
@@ -189,7 +186,7 @@ Default symbols are treated as method calls if the struct `#respond_to?` the met
 ```ruby
 class User < OptStruct.new
   options :email, :role => :default_role
-  
+
   def default_role
     "member"
   end
@@ -268,7 +265,7 @@ end
 
 Expected arguments are similar to required arguments, except they are in `.expected_arguments` collection, which is checked when an OptStruct is initialized.
 
-Expected arguments can also be supplied using keywords. An `ArgumentError` is only raised if the expected argument is not in the list of arguments passed to `OptStruct#new` **and** the argument is not present in the `#options` Hash.
+Expected arguments can also be supplied using keywords. An `ArgumentError` is only raised if the expected argument is not in the list of arguments passed to `OptStruct#new` **and** the argument is not present in the optional Hash passed to `OptStruct#new`.
 
 The following examples will initialize any of the `User` class examples above without error.
 
@@ -294,7 +291,7 @@ Feel free to write your own accessor methods for things like dependent options o
 class Person < OptStruct.new
   option :given_name
   option :family_name
-  
+
   def name
     options.fetch(:name) { "#{given_name} #{family_name}" }
   end
@@ -310,7 +307,7 @@ OptStruct classes are initialized in an `initialize` method (in `OptStruct::Inst
 ```ruby
 class UserReportBuilder < OptStruct.new(:user)
   attr_reader :report
-  
+
   def initialize(*)
     super
     @report = []
@@ -318,7 +315,7 @@ class UserReportBuilder < OptStruct.new(:user)
 end
 ```
 
-`OptStruct` also provides initialization callbacks to make hooking into and customizing the initialization of OptStruct classes easier and require less code.
+`OptStruct` also provides initialization callbacks to make hooking into and customizing the initialization of OptStruct classes easier, less brittle, and require less code.
 
 ```ruby
 class UserReportBuilder < OptStruct.new(:user)
@@ -330,7 +327,7 @@ end
 ```ruby
 class UserReportBuilder < OptStruct.new(:user)
   attr_reader :report
-  
+
   around_init do |instance|
     instance.call
     @report = []
@@ -348,3 +345,7 @@ Available callbacks
 ## Inheritance, Expanded
 
 See `spec/inheritance_spec.rb` for examples of just how crazy you can get.
+
+## Ruby Versions
+
+This gem is expected to work with rubies as old as ~2.0, though official support and automated testing only covers non-EOL (End of Life) versions. Currently, that's ruby 3.3+. Tests are also performed against jruby and truffleruby to ensure portability.

data/lib/opt_struct/class_methods.rb

@@ -59,9 +59,14 @@ module OptStruct
       option_writer *keys, **options
     end
 
-    def option(key, default = OptStruct::DEFAULT, required: false, **options)
-      default = options[:default] if options.key?(:default)
-      defaults[key] = default unless default == OptStruct::DEFAULT
+    def option(key, default = OptStruct::DEFAULT, required: false, **options, &default_block)
+      if options.key?(:default)
+        defaults[key] = options[:default]
+      elsif default != OptStruct::DEFAULT
+        defaults[key] = default
+      elsif default_block
+        defaults[key] = default_block
+      end
       required_keys << key if required
       option_accessor key, **options
     end

data/lib/opt_struct/instance_methods.rb

@@ -17,6 +17,10 @@ module OptStruct
       self.class.defaults
     end
 
+    def ==(other)
+      options == other.options
+    end
+
     private
 
     def check_required_keys
@@ -32,7 +36,11 @@ module OptStruct
         options[key] =
           case default_value
           when Proc
-            instance_exec(&default_value)
+            if default_value.arity == 0
+              instance_exec(&default_value)
+            else
+              instance_exec(self, &default_value)
+            end
           when Symbol
             respond_to?(default_value, true) ? send(default_value) : default_value
           else

data/lib/opt_struct/version.rb

@@ -1,3 +1,3 @@
 module OptStruct
-  VERSION = "1.6.0"
+  VERSION = "1.8.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: opt_struct
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Carl Zulauf
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: Struct with support for keyword params and mixin support
 email:
@@ -28,7 +27,6 @@ homepage: https://github.com/carlzulauf/opt_struct
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -43,8 +41,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.22
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: The Option Struct
 test_files: []