exercise_options 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8525b7df8fecd5a8814480f9ee33726fb430f07cdb20c8a48610f4df98ad27f
+  data.tar.gz: 71f9c1a405aaffd708380aec4ea86b620fd693d7a9ee5430fa5dd0cb77677c84
+SHA512:
+  metadata.gz: 12714c0567994b5b466cbefa1dfc0d4ead9644195b522b804bca2312c042d74b36a110498bb71bad09ee81f6daf4db4a20aa26d5fb98eaaecff23c121b5e8402
+  data.tar.gz: caca9d1c900ab25f927b03a3397466c3d4ce15d5ec1d485762df41ceec7d695341236fb50dcbc259cd7b542fd4993bed15423f763a97f67253c603f91ea9404c

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in exercise_options.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/README.md

@@ -0,0 +1,46 @@
+# ExerciseOptions
+
+An experimental gem for making amendments to upstream dependencies.
+
+This project came about when I was working with Samvera's Actor Stack and needed to add additional variables to a few different classes.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add exercise_options
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install exercise_options
+
+## Usage
+
+```ruby
+class MyObject
+  def initialize(name:)
+    self.name = name
+  end
+  attr_accessor :name
+end
+
+MyObject.prepend(
+  ExerciseOptions.for(
+    default_is_true: true,
+    conditionally_true_with_receiver: ->(obj) { obj.name == "Hello World" },
+  )
+)
+
+obj = MyObject.new(name: "Nobody")
+expect(obj.default_is_true).to be_truthy
+expect(obj.conditionally_true_with_receiver).to be_falsey
+
+
+next_object = MyObject.new(name: "Hello World", default_is_true: false)
+expect(next_object.default_is_true).to be_falsey
+expect(next_object.conditionally_true_with_receiver).to be_truthy
+```
+
+## Development
+
+Let's see if this thing make sense?

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/exercise_options/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ExerciseOptions
+  VERSION = "0.1.0"
+end

data/lib/exercise_options.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative "exercise_options/version"
+require "active_support"
+
+module ExerciseOptions
+  class Error < StandardError; end
+  # Decorate an upstream object with additional attributes.  By including the generated module,
+  # ExerciseOptions will intercept a call to `new` and apply the declared options to the newly
+  # instantiated object.
+  #
+  # @param options [Hash<Symbol, Object>] a Hash with keys that are symbols.  Each value may be
+  #        either a lambda or not.  When it is a lambda, that will be called at object
+  #        initialization.  When it is not a lambda, that will be the default value at object
+  #        initialization.
+  #
+  # @return [Module]
+  #
+  # @example
+  #   class MyObject
+  #     def initialize(name:)
+  #       self.name = name
+  #     end
+  #     attr_accessor :name
+  #   end
+  #
+  #   MyObject.prepend(
+  #     ExerciseOptions.for(
+  #       default_is_true: true,
+  #       conditionally_true_with_receiver: ->(obj) { obj.name == "Hello World" },
+  #     )
+  #   )
+  #
+  #   obj = MyObject.new(name: "Nobody")
+  #   expect(obj.default_is_true).to be_truthy
+  #   expect(obj.conditionally_true_with_receiver).to be_falsey
+  #
+  #
+  #   next_object = MyObject.new(name: "Hello World", default_is_true: false)
+  #   expect(next_object.default_is_true).to be_falsey
+  #   expect(next_object.conditionally_true_with_receiver).to be_truthy
+  def self.for(**options)
+    Module.new do
+      extend ActiveSupport::Concern
+      class_methods do
+        define_method(:new) do |*args, **kwargs, &block|
+          super(*args, **kwargs.except(*options.keys), &block).tap { |instance|
+            options.keys.each do |key|
+              value = if kwargs.key?(key)
+                        kwargs.fetch(key)
+                      else
+                        instance.send("default_#{key}")
+                      end
+              instance.public_send("#{key}=", value)
+            end
+          }
+        end
+      end
+
+      options.each do |key, value|
+        attr_accessor key
+        define_method "default_#{key}" do
+          if value.respond_to?(:call)
+            if value.arity == 1
+              value.call(self)
+            else
+              value.call
+            end
+          else
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/sig/exercise_options.rbs

@@ -0,0 +1,4 @@
+module ExerciseOptions
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: exercise_options
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An experiment in extending object behavior.
+email:
+- jeremy.n.friesen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/exercise_options.rb
+- lib/exercise_options/version.rb
+- sig/exercise_options.rbs
+homepage: https://github.com/jeremyf/exercise_options
+licenses: []
+metadata:
+  homepage_uri: https://github.com/jeremyf/exercise_options
+  source_code_uri: https://github.com/jeremyf/exercise_options
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: An experiment in extending object behavior.
+test_files: []