yiffspace-config 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd4b38dbf53747f6a11d19eee67a466ef257d5be641ed96ac04367582ae1e2db
+  data.tar.gz: 4d730250f89f9e52ddf1727f59486804f78dbce5415565b2c868a524bc4b92a2
+SHA512:
+  metadata.gz: 31fccac5adfd9589fa22c84076cf798ee2763427735ea8d104b4eaa828181fc14149474ee91ace45ba1c587aa841ccbe78bfa0b3046a8f5b71a3d5a58c818c80
+  data.tar.gz: 385a6b2e1065488ca3d841683e1db9a0a8adaf6163a02fcf4fc0f0b9331b3b98e505501afb561717dbcb5fff6c5132913b8b6a06690ce3f3b6f00258cd96db95

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.0.1
+
+- Initial release, extracted from the `yiffspace` gem's `YiffSpace::Config::Builder`.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright Donovan_DMC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# YiffSpace::Config
+
+Standalone ENV-backed config DSL (`YiffSpace::Config::Builder`), for
+https://yiff.space and related projects. Not a Rails engine - no dependency
+on `yiffspace` itself, only ActiveSupport.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "yiffspace-config"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+```ruby
+class Config < YiffSpace::Config::Builder
+  config(:some_value, required: true)
+  config(:some_flag, :boolean) { false }
+end
+```
+
+See `YiffSpace::Config::Builder` for the full API.
+
+## Contributing
+
+Go away
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require("bundler/gem_tasks")

data/lib/yiffspace/config/builder.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require("singleton")
+require("active_support/core_ext/module/attribute_accessors")
+require("active_support/hash_with_indifferent_access")
+
+# This is intended to only be used externally, it is NOT reusable, do not use it within this project, or attempt to use it multiple times!!
+module YiffSpace
+  module Config
+    class Builder
+      include(Singleton)
+
+      cattr_accessor(:list, default: [])
+      cattr_accessor(:env_set, default: ActiveSupport::HashWithIndifferentAccess.new)
+      cattr_accessor(:unset, default: [])
+      cattr_accessor(:required, default: [])
+      cattr_accessor(:reviver_map, default: ActiveSupport::HashWithIndifferentAccess.new)
+      cattr_accessor(:subconfigs, default: ActiveSupport::HashWithIndifferentAccess.new { |h, k| h[k] = {} })
+      cattr_accessor(:env_name, default: "CONFIG")
+
+      def self.config(name, type = :string, env: true, required: false, blank: false, &block)
+        name = name.to_sym
+        remove_config(name) if list.include?(name)
+        list << name
+        self.required << name if required
+        if block.nil?
+          unset << name
+          block = -> { raise(NotImplementedError, "Config option #{name} is not set") }
+        end
+        define_method(name) do |*args|
+          env_or_value(name, args, blank: blank, &block)
+        end
+        if type == :boolean
+          define_method("#{name}?") do |*args|
+            public_send(name, *args)
+          end
+        end
+        reviver(name, type) if type && type != :string
+        env_set[name] = env
+      end
+
+      def self.remove_config(name, reviver: false)
+        name = name.to_sym
+        list.delete(name)
+        required.delete(name)
+        unset.delete(name)
+        reviver_map.delete(name) if reviver
+        env_set.delete(name)
+        remove_method(name)
+        remove_method("#{name}?") if method_defined?("#{name}?")
+      end
+
+      def env_or_value(name, args, blank: false, &)
+        value = env(name)
+        value = nil if !value.nil? && value.blank? && !blank
+        if value.nil?
+          instance_exec(*args, &)
+        else
+          reviver = reviver_map.fetch(name, proc(&:itself))
+          instance_exec(value, *args, &reviver)
+        end
+      end
+
+      def env(name)
+        ENV.fetch("#{self.class.env_name}_#{name.to_s.upcase}", nil)
+      end
+
+      def self.reviver(name, type = nil, &block)
+        name = name.to_sym
+        if block
+          reviver_map[name] = block
+          return
+        end
+        method            = case type
+                            when :boolean
+                              ->(v) { !v.match?(/\A(false|f|no|n|off|0)\z/i) }
+                            when :integer, :number
+                              ->(v) { v.to_i }
+                            when :symbol
+                              ->(v) { v.to_sym }
+                            when :array
+                              ->(v) { v.split(/\s*,\s*/) }
+                            else
+                              raise(ArgumentError, "not sure how to revive #{type} for #{method}")
+                            end
+        reviver_map[name] = method
+      end
+
+      def self.subconfig(prefix, parent: [], &block)
+        raise(ArgumentError, "block required") unless block
+
+        prefix = prefix.to_sym
+        path   = parent + [prefix]
+
+        node = subconfigs
+        path.each do |p|
+          node[p] ||= {}
+          node    = node[p]
+        end
+
+        define_method(prefix) { SubconfigProxy.new(self, path) } unless method_defined?(prefix)
+
+        collector = Module.new do
+          def self.collected
+            @collected ||= []
+          end
+
+          def self.config(name, type = :string, env: true, required: false, blank: false, &block)
+            collected << [:config, name, type, env, required, blank, block]
+          end
+
+          def self.reviver(name, type = nil, &block)
+            collected << [:reviver, name, type, block]
+          end
+
+          def self.subconfig(name, &block)
+            collected << [:subconfig, name, block]
+          end
+        end
+
+        collector.module_eval(&block)
+
+        collector.collected.each do |kind, name, *args|
+          case kind
+          when :config
+            full = (path + [name]).join("_").to_sym
+            config(full, args[0], env: args[1], required: args[2], blank: args[3], &args[4])
+          when :reviver
+            full = (path + [name]).join("_").to_sym
+            reviver(full, args[0], &args[1])
+          when :subconfig
+            subconfig(name, parent: path, &args[0])
+          end
+        end
+      end
+
+      def self.ensure_required_set!
+        unset = []
+        required.each do |name|
+          value = begin
+            instance.public_send(name)
+          rescue StandardError
+            nil
+          end
+          unset << name if value.blank?
+        end
+
+        raise("Missing required configuration options: #{unset.join(', ')}") if unset.any?
+      end
+
+      def present?(*names)
+        names.flatten.all? { |name| public_send(name).present? }
+      end
+
+      class SubconfigProxy
+        def initialize(owner, path)
+          @owner = owner
+          @path  = path
+        end
+
+        def method_missing(name, *, &)
+          name      = name.to_sym
+          full_path = @path + [name]
+
+          flat = full_path.join("_").to_sym
+          return @owner.public_send(flat, *, &) if @owner.respond_to?(flat)
+
+          return SubconfigProxy.new(@owner, full_path) if subconfig_path?(full_path)
+
+          super
+        end
+
+        def respond_to_missing?(name, include_private = false)
+          name = name.to_sym
+          flat = (@path + [name]).join("_").to_sym
+
+          @owner.respond_to?(flat, include_private) ||
+            subconfig_path?(@path + [name]) ||
+            super
+        end
+
+        private
+
+        def subconfig_path?(path)
+          node = Builder.subconfigs
+          path.each do |p|
+            return false unless node.key?(p)
+
+            node = node[p]
+          end
+          true
+        end
+      end
+    end
+  end
+end

data/lib/yiffspace/config/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module YiffSpace
+  module Config
+    VERSION = "0.0.1"
+  end
+end

data/lib/yiffspace/config.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require("zeitwerk")
+
+module YiffSpace
+  module Config
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem_extension(YiffSpace)
+loader.setup

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: yiffspace-config
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Donovan_DMC
+bindir: bin
+cert_chain: []
+date: 2026-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Standalone ENV-backed config DSL (YiffSpace::Config::Builder), for https://yiff.space
+  and related projects
+email:
+- hewwo@yiff.rocks
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/yiffspace/config.rb
+- lib/yiffspace/config/builder.rb
+- lib/yiffspace/config/version.rb
+homepage: https://yiff.space
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://yiff.space
+  source_code_uri: https://github.com/YiffSpace/Gem/tree/master/yiffspace-config
+  changelog_uri: https://github.com/YiffSpace/Gem/blob/master/yiffspace-config/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Standalone ENV-backed config DSL (YiffSpace::Config::Builder), for https://yiff.space
+  and related projects
+test_files: []