opt_struct 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13aeb90dc88ca1e4eabb9ab9f0a82b595cae5953
-  data.tar.gz: bb6faaad48a7fe17a7963b85f7612d2321f1e973
+  metadata.gz: 20cc3d259d8f9a17a7804fa4022e01862483a8b8
+  data.tar.gz: 92344e5ac8ec8d8abd8a4512fed58584c67041ff
 SHA512:
-  metadata.gz: 917067f619231d3575b0d2ddeb3cf921e749e5d12191fa7ab58844630e34059c8823d8b1dc5415c63b623d6a6da53c8f3376fdc2dfa2c88a262bf930455b2988
-  data.tar.gz: 49a85c43f919def4a677898dd83a67f68944262314fae1a316106ef3a6a9c84fb3005c1f44254eb5cbc18cfacac676acf8384b694e3d85a75fa34391e0f9cf34
+  metadata.gz: 349c78d63e1f56eaa801de15ad3294de2e2877c5345997e68568b5a4c985ffcbaee11abf0b01584a5d5a81bc022aa48e8a87e20bf6ca343c1858f37ac6f3ff1e
+  data.tar.gz: d2d65670ac1c8a1f4e0a09a0ad1836a67190ad6d81d06b5a50613c4921b49431436cc24f1aac7eec69503bad4db5ac2497a203df4f9837342e131a6d402eb19f

data/README.md

@@ -1,6 +1,6 @@
 # The Opt Struct
 
-A struct around a hash
+A struct around a hash. Great for encapsulating actions with complex configuration, like interactor/action classes.
 
 ```ruby
 gem "opt_struct"
@@ -19,6 +19,9 @@ MyClass.new
 MyClass.new "foo", "bar"
 # => #<MyClass>
 
+MyClass.new foo: "foo", bar: "bar"
+# => #<MyClass>
+
 i = MyClass.new "foo", "bar", yin: "yang"
 i.options
 # => {yin: "yang"}
@@ -85,3 +88,45 @@ i = MyClass.new("something", bar: "foo")
 [i.foo, i.bar]
 # => ["something", "foo"]
 ```
+
+## Example 5
+
+Both `build` and `new` accept a block.
+
+```ruby
+PersonClass = OptStruct.new do
+  required :first_name
+  option :last_name
+
+  def name
+    [first_name, last_name].compact.join(" ")
+  end
+end
+
+t = PersonClass.new(first_name: "Trish")
+# => #<PersonClass>
+t.name
+# => "Trish"
+t.last_name = "Smith"
+t.name
+# => "Trish Smith"
+
+class CarClass
+  include OptStruct.build do
+    required :make, :model
+    options :year, transmission: "Automatic"
+
+    def name
+      [year, make, model].compact.join(" ")
+    end
+  end
+end
+
+c = CarClass.new(make: "Infiniti", model: "G37", year: 2012)
+c.name
+# => "2012 Infinit G37"
+
+c = CarClass.new(model: "WRX", make: "Subaru")
+c.name
+# => "Subaru WRX"
+```

data/lib/opt_struct.rb

@@ -16,28 +16,32 @@ module OptStruct
     inject_struct(klass)
   end
 
-  def self.new(*args, **defaults)
+  def self.new(*args, **defaults, &callback)
     check_for_invalid_args(args)
     args.map!(&:to_sym)
-    inject_struct(Class.new) do
+    klass = inject_struct(Class.new) do
       expect_arguments *args
       options defaults
     end
+    klass.class_exec(&callback) if callback
+    klass
   end
 
-  def self.build(*args, **defaults)
+  def self.build(*args, **defaults, &callback)
     check_for_invalid_args(args)
     args.map!(&:to_sym)
     Module.new do
       @arguments = args
       @defaults = defaults
+      @callback = callback
 
       def self.included(klass)
-        arguments, defaults = @arguments, @defaults
+        arguments, defaults, callback = @arguments, @defaults, @callback
         OptStruct.inject_struct(klass) do
           expect_arguments *arguments
           options defaults
         end
+        klass.class_exec(&callback) if callback
       end
     end
   end

data/lib/opt_struct/class_methods.rb

@@ -67,16 +67,18 @@ module OptStruct
     def expect_arguments(*arguments)
       @expected_arguments = arguments
       attr_accessor *arguments
-      lines = []
+      assignment_lines = String.new
       arguments.each_with_index do |arg, i|
-        lines << "@#{arg} = @options.delete(:#{arg}) if @options.key?(:#{arg})"
-        lines << "@#{arg} = values[#{i}] if values.length > #{i}"
-        lines << %[raise ArgumentError, "missing required argument: #{arg}" unless defined?(@#{arg})]
+        assignment_lines << <<~RUBY
+          @#{arg} = @options.delete(:#{arg}) if @options.key?(:#{arg})
+          @#{arg} = values[#{i}] if values.length > #{i}
+          raise ArgumentError, "missing required argument: #{arg}" unless defined?(@#{arg})
+        RUBY
       end
       self.class_eval <<~RUBY
         def initialize(*values, **options)
           @options = self.class.defaults.merge(options)
-          #{lines.join("\n  ")}
+          #{assignment_lines}
           check_required_keys
         end
       RUBY

data/opt_struct.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "opt_struct"
-  spec.version       = "0.3.0"
+  spec.version       = "0.4.0"
   spec.authors       = ["Carl Zulauf"]
   spec.email         = ["carl@linkleaf.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opt_struct
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Carl Zulauf
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-28 00:00:00.000000000 Z
+date: 2017-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler