optify-config 0.7.0-arm64-darwin → 0.8.0-arm64-darwin

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26e13c114d43d7ec709b17fec27915f06dfaa4c181a3ae48ea44465563a0cf74
-  data.tar.gz: 4bc469738ebba83a34d12e43ff77386b11f0359ebd3ef7d92cbb34f251ada859
+  metadata.gz: 8809dd37472d1416cb39d809ea61f5c9aaff225ca963942d658266196451c7dd
+  data.tar.gz: 6b3aea9faa9e7a3cb736442161cc9b3a83a68e3e27117fa093769bf037066050
 SHA512:
-  metadata.gz: 213631c0e929f1da0c8caea040b53c90a25a734c4445550cddae01a72303c48925224a0457ab681ec08ae9284f95ff668cefccb14e20c8747e502bab1cead847
-  data.tar.gz: 9d53de661a86c0182b82f3e0886b9fdab7fdce249efad637db8776979f124d1f49d62659e0a64a9d2eadc93c00994ce75ea2af8a9a793ffef738130419887d6a
+  metadata.gz: 29c7194f1b9ae79297b01877ab70b605ea4ecca59c23abcc61466a01a4ee42af041b5840aa889592f7c5bac53481c5eba985f8efc1e97bf420853ca4a14d25fe
+  data.tar.gz: '09984dfb9cb8f5805832423840ea11e75261aa32a5dda886429907429bb944ed1181fb101a626408bc1085eb6dede595af1b4e214f8a76d7293faa1dd18887c9'

data/lib/optify_ruby/base_config.rb

@@ -38,16 +38,12 @@ module Optify
     def self._convert_value(value, type)
       case value
       when Array
-        type = if type.type.respond_to?(:unwrap_nilable)
-                 # Handle nilable array.
-                 type.type.unwrap_nilable
-               else
-                 # Handle array of 1 type.
-                 type.type
-               end
-        return value.map { |v| _convert_value(v, type) }.freeze
+        # Handle `T.nilable(T::Array[...])`
+        type = type.unwrap_nilable if type.respond_to?(:unwrap_nilable)
+        inner_type = type.type
+        return value.map { |v| _convert_value(v, inner_type) }.freeze
       when Hash
-        # Handle nilable hash.
+        # Handle `T.nilable(T::Hash[...])`
         type = type.unwrap_nilable if type.respond_to?(:unwrap_nilable)
         return _convert_hash(value, type).freeze
       end

data/lib/optify_ruby/implementation.rb

@@ -6,6 +6,7 @@ require 'json'
 require 'sorbet-runtime'
 
 require_relative './base_config'
+require_relative './options_metadata'
 
 # Tools for working with configurations declared in files.
 module Optify
@@ -18,6 +19,28 @@ module Optify
   class OptionsProvider
     extend T::Sig
 
+    #: -> Hash[String, OptionsMetadata]
+    def features_with_metadata
+      return @features_with_metadata if @features_with_metadata
+
+      result = JSON.parse(features_with_metadata_json)
+      result.each do |key, value|
+        result[key] = OptionsMetadata.from_hash(value)
+      end
+      result.freeze
+
+      @features_with_metadata = T.let(result, T.nilable(T::Hash[String, OptionsMetadata]))
+      result
+    end
+
+    #: (String canonical_feature_name) -> Optify::OptionsMetadata?
+    def get_feature_metadata(canonical_feature_name)
+      metadata_json = get_feature_metadata_json(canonical_feature_name)
+      return nil if metadata_json.nil?
+
+      OptionsMetadata.from_hash(JSON.parse(metadata_json))
+    end
+
     # Fetches options based on the provided key and feature names.
     #
     # @param key The key to fetch options for.

data/lib/optify_ruby/options_metadata.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'sorbet-runtime'
+
+require_relative './base_config'
+
+module Optify
+  # Information about a feature.
+  class OptionsMetadata < BaseConfig
+    sig { returns(T.nilable(T::Array[String])) }
+    attr_reader :aliases
+
+    sig { returns(T.untyped) }
+    attr_reader :details
+
+    sig { returns(String) }
+    attr_reader :name
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :owners
+  end
+end

data/rbi/optify.rbi

@@ -26,6 +26,21 @@ module Optify
   class CacheOptions < BaseConfig
   end
 
+  # Information about a feature.
+  class OptionsMetadata < BaseConfig
+    sig { returns(T.nilable(T::Array[String])) }
+    def aliases; end
+
+    sig { returns(T.untyped) }
+    def details; end
+
+    sig { returns(String) }
+    def name; end
+
+    sig { returns(T.nilable(String)) }
+    def owners; end
+  end
+
   # Preferences when getting options.
   class GetOptionsPreferences
     sig { params(value: T::Boolean).returns(GetOptionsPreferences) }
@@ -40,6 +55,10 @@ module Optify
     sig { returns(T::Array[String]) }
     def features; end
 
+    # @return All of the keys and values for the the features.
+    sig { returns(T::Hash[String, OptionsMetadata]) }
+    def features_with_metadata; end
+
     # @return All of the keys and values for the the features.
     sig do
       params(feature_names: T::Array[String], preferences: GetOptionsPreferences)
@@ -55,6 +74,10 @@ module Optify
     sig { params(feature_name: String).returns(String) }
     def get_canonical_feature_name(feature_name); end
 
+    # @return The metadata for the feature.
+    sig { params(canonical_feature_name: String).returns(T.nilable(OptionsMetadata)) }
+    def get_feature_metadata(canonical_feature_name); end
+
     # Fetches options based on the provided key and feature names.
     #
     # @param key The key to fetch options for.
@@ -101,6 +124,16 @@ module Optify
     # @return [OptionsProvider] `self`.
     sig { returns(OptionsProvider) }
     def init; end
+
+    private
+
+    # @return The metadata for the feature.
+    sig { params(canonical_feature_name: String).returns(T.nilable(String)) }
+    def get_feature_metadata_json(canonical_feature_name); end
+
+    # @return All of the keys and values for the the features.
+    sig { returns(String) }
+    def features_with_metadata_json; end
   end
 
   # A builder for creating an `OptionsProvider` instance.

data/sig/optify.rbs

@@ -22,6 +22,17 @@ end
 class Optify::CacheOptions < BaseConfig
 end
 
+# Information about a feature.
+class Optify::OptionsMetadata < BaseConfig
+  def aliases: () -> ::Array[String]?
+
+  def details: () -> untyped
+
+  def name: () -> String
+
+  def owners: () -> String?
+end
+
 # Preferences when getting options.
 class Optify::GetOptionsPreferences
   def skip_feature_name_conversion=: (bool value) -> GetOptionsPreferences
@@ -34,6 +45,9 @@ class Optify::OptionsProvider
   # @return All of the canonical feature names.
   def features: () -> ::Array[String]
 
+  # @return All of the keys and values for the the features.
+  def features_with_metadata: () -> ::Hash[String, OptionsMetadata]
+
   def get_all_options_json: (::Array[String] feature_names, GetOptionsPreferences preferences) -> String
 
   # Map an alias or canonical feature name (perhaps derived from a file name) to a canonical feature name.
@@ -43,6 +57,9 @@ class Optify::OptionsProvider
   # @return The canonical feature name.
   def get_canonical_feature_name: (String feature_name) -> String
 
+  # @return The metadata for the feature.
+  def get_feature_metadata: (String canonical_feature_name) -> OptionsMetadata?
+
   def get_options: [Config] (String key, ::Array[String] feature_names, T::Class[Config] config_class, ?CacheOptions? cache_options, ?Optify::GetOptionsPreferences? preferences) -> Config
 
   # Fetches options in JSON format based on the provided key and feature names.
@@ -57,6 +74,12 @@ class Optify::OptionsProvider
   # (Optional) Eagerly initializes the cache.
   # @return [OptionsProvider] `self`.
   def init: () -> OptionsProvider
+
+  # @return The metadata for the feature.
+  def get_feature_metadata_json: (String canonical_feature_name) -> String?
+
+  # @return All of the keys and values for the the features.
+  def features_with_metadata_json: () -> String
 end
 
 # A builder for creating an `OptionsProvider` instance.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: optify-config
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: arm64-darwin
 authors:
 - Justin D. Harris
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11851
+        version: 0.5.11911
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11851
+        version: 0.5.11911
 - !ruby/object:Gem::Dependency
   name: rake-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11851
+        version: 0.5.11911
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.11851
+        version: 0.5.11911
 - !ruby/object:Gem::Dependency
   name: tapioca
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +108,7 @@ files:
 - lib/optify_ruby/3.4/optify_ruby.bundle
 - lib/optify_ruby/base_config.rb
 - lib/optify_ruby/implementation.rb
+- lib/optify_ruby/options_metadata.rb
 - rbi/optify.rbi
 - sig/optify.rbs
 homepage: https://github.com/juharris/optify