fig_tree 0.0.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeed3763d9c3d8589a8ff0426ef7bcbc6b27ead3b61a4e930fc4c043a3243ab2
-  data.tar.gz: 99530c56bbed379a3a8ccdf8558fda0ff89d32eff73d3b33d95fa483c30945d8
+  metadata.gz: 434800cb06edc670398ffd76cd43a2464bbaed074fa333e0c5dbd0bad01a7301
+  data.tar.gz: b744f1fe4e76f2d14e7beb18b78ebe2e916dd159cd011c29bb729418c98fcca8
 SHA512:
-  metadata.gz: 123fb1d12ecdc117a89e0f1b1c8cc8dcce7a124307d4b2ec6f1d9f89f80d0e727018f43f0b235a4919c46065b1b7396814625710302e5345871f44aa199b64df
-  data.tar.gz: 755b79c660b3c2c72c9fd6389102164ff129f6d35cbe818f1538630d88e5cbcc57ee69b80839bd18c0e56eac0db85f89cb9cce82df743b2b64de6abb401c55b0
+  metadata.gz: f456847c8fada09cb5b116aae97fe28d8292b8ad0845cde50576d6604bb72fa76ed26c5812b41306319162433d64ad713151ca601c8f21ef45d8cb7263585ce6
+  data.tar.gz: '09b8090d10adcd029531a93be4d29067b6e9b2a99fd41a155d2acae3c4d390e04d796c59bf7a2cdfbb60cd55402c6476c576ea4585784fa8674cf14a2906957b'

data/.ruby-version

@@ -1 +1 @@
-3.0.0
+3.2.2

data/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## UNRELEASED
 
+## [0.2.0] - 2024-05-31
+- Add `removed` and `keep_removed_configs`
+- Add `trap_config`
+
+## [0.0.6] - 2023-08-29
+- Add RBI files and DSL compiler for Sorbet
+
 ## [0.0.5] - 2023-04-04
 - Remove Deimos-specific Rake Task skip
 

data/lib/fig_tree/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FigTree
-  VERSION = '0.0.5'
+  VERSION = '0.2.0'
 end

data/lib/fig_tree.rb

@@ -9,14 +9,19 @@ require 'active_support/callbacks'
 
 # Configuration module.
 module FigTree
+
+  class << self
+    attr_accessor :keep_removed_configs
+  end
+
   extend ActiveSupport::Concern
 
-  ConfigValue = Struct.new(:value, :default_value, :default_proc, :deprecation) do
+  ConfigValue = Struct.new(:value, :default_value, :default_proc, :deprecation, :removed) do
 
     # Reset value back to default.
-    def reset!
+    def reset_values
       if self.value.is_a?(ConfigStruct)
-        self.value.reset!
+        self.value.reset_values
       else
         self.value = self.default_value
       end
@@ -24,12 +29,19 @@ module FigTree
 
     # :nodoc:
     def clone_and_reset
-      setting = ConfigValue.new(self.value, self.default_value,
+      val = self.value.respond_to?(:clone_and_reset) ? self.value.clone_and_reset : self.value
+      setting = ConfigValue.new(val, self.default_value,
                                 self.default_proc, self.deprecation)
-      setting.reset!
+      setting.reset_values
       setting
     end
 
+    # @return [Boolean]
+    def default_value?
+      val = self.default_proc ? self.default_proc.call : self.default_value
+      val == self.value
+    end
+
   end
 
   # Class that defines and keeps the configuration values.
@@ -46,10 +58,15 @@ module FigTree
       @setting_templates = {}
     end
 
+    def reset_values
+      @setting_objects = @setting_templates.map { |k, _| [k, []] }.to_h
+      @settings.values.each(&:reset_values)
+    end
+
     # Reset config back to default values.
     def reset!
-      @setting_objects = @setting_templates.map { |k, _| [k, []] }.to_h
-      @settings.values.each(&:reset!)
+      reset_values
+      run_callbacks(:configure)
     end
 
     # Mark a configuration as deprecated and replaced with the new config.
@@ -70,6 +87,20 @@ module FigTree
       @settings.map { |k, v| [k, v.value] }.to_h
     end
 
+    def clear_removed_fields!
+      return if FigTree.keep_removed_configs
+
+      @settings.delete_if.each do |setting|
+        if setting.value.is_a?(ConfigStruct)
+          setting.value.clear_removed_fields!
+          false
+        else
+          setting.removed
+        end
+      end
+      @setting_objects.values.flatten.each(&:clear_removed_fields!)
+    end
+
     # :nodoc:
     def clone_and_reset
       new_config = self.clone
@@ -88,16 +119,16 @@ module FigTree
     # @param name [Symbol]
     def setting_object(name, &block)
       new_config = ConfigStruct.new("#{@name}.#{name}")
-      @setting_objects[name] = []
-      @setting_templates[name] = new_config
-      new_config.instance_eval(&block)
+      @setting_objects[name] ||= []
+      @setting_templates[name] ||= new_config
+      @setting_templates[name].instance_eval(&block)
     end
 
     # Define a setting with the given name.
     # @param name [Symbol]
     # @param default_value [Object]
     # @param default_proc [Proc]
-    def setting(name, default_value=nil, default_proc: nil, &block)
+    def setting(name, default_value=nil, default_proc: nil, removed: false, &block)
       if block_given?
         # Create a nested setting
         setting_config = @settings[name]&.value || ConfigStruct.new("#{@name}.#{name}")
@@ -109,11 +140,37 @@ module FigTree
         setting = ConfigValue.new
         setting.default_proc = default_proc
         setting.default_value = default_value
-        setting.reset!
+        setting.reset_values
+        setting.removed = removed
         @settings[name] = setting
       end
     end
 
+    # @param field [String]
+    # @return [Boolean]
+    def default_value?(field)
+      @settings[field].default_value?
+    end
+
+    # Cuts down the config to only values that don't match the default values.
+    # Used to generate a representation of current config only via the changes.
+    def non_default_settings!
+      @settings.delete_if do |key, setting|
+        if setting.value.is_a?(ConfigStruct)
+          setting.value.non_default_settings!
+          setting.value.settings.empty?
+        else
+          setting.default_value?
+        end
+      end
+      @setting_objects.each do |_, list|
+        list.select! do |setting|
+          setting.non_default_settings!
+          setting.settings.none?
+        end
+      end
+    end
+
     # :nodoc:
     def respond_to_missing?(method, include_all=true)
       method = method.to_s.sub(/=$/, '')
@@ -139,6 +196,10 @@ module FigTree
 
       setting = @settings[config_key]
 
+      if setting&.removed && !FigTree.keep_removed_configs
+        puts "[Config] #{config_key} has been removed: #{setting.removed}"
+      end
+
       if setting&.deprecation
         return _deprecated_config_method(method, *args)
       end
@@ -152,6 +213,14 @@ module FigTree
       _default_config_method(config_key, *args)
     end
 
+    def trap_config(&block)
+      old_settings = @settings.deep_dup
+      old_setting_objects = @setting_objects.deep_dup
+      block.call
+      @settings = old_settings
+      @setting_objects = old_setting_objects
+    end
+
   protected
 
     # Only for the clone method
@@ -234,6 +303,10 @@ module FigTree
       @config ||= ConfigStruct.new('config')
     end
 
+    def trap_config(&block)
+      config.trap_config(&block)
+    end
+
     # Evaluate a block with the given configuration values. Reset back to the original values
     # when done.
     # @param values [Hash]
@@ -267,6 +340,7 @@ module FigTree
       mod = self
       config.class.set_callback(:configure, :after,
                                 proc { mod.instance_eval(&block) })
+      config.clear_removed_fields!
     end
   end
 end

data/lib/tapioca/dsl/compilers/fig_tree.rb

@@ -0,0 +1,75 @@
+# typed: true
+
+module Tapioca
+  module Compilers
+    class FigTree < Tapioca::Dsl::Compiler
+      extend T::Sig
+
+      ConstantType = type_member {{ fixed: T.all(T::Class[::FigTree], ::FigTree::ClassMethods) }}
+
+      sig { override.returns(T::Enumerable[Module]) }
+      def self.gather_constants
+        all_modules.select { |m| m < ::FigTree}
+      end
+
+      sig { params(path: String, struct: ::FigTree::ConfigStruct).void }
+      def decorate_struct(path, struct)
+        class_name = struct.instance_variable_get(:@name)
+        constant_name = "Private#{path}#{class_name.tr('.', '_').classify}"
+        config_class = Class.new
+        Object.const_set(constant_name, config_class)
+        root.create_path(config_class) do |klass|
+          settings = struct.instance_variable_get(:@settings)
+          if settings
+            settings.each do |name, value|
+              if value.value.is_a?(::FigTree::ConfigStruct)
+                decorate_struct(path, value.value)
+                klass.create_method(name, return_type: "#{constant_name}#{name.to_s.classify}")
+              else
+                type = value.default_value
+                type = if type.nil?
+                         'T.untyped'
+                       elsif type == true || type == false
+                         'T::Boolean'
+                       else
+                         type.class.to_s
+                       end
+                klass.create_method(name, return_type: type)
+                klass.create_method("#{name}=",
+                                    return_type: "void",
+                                    parameters: [create_param("value", type: type)])
+              end
+            end
+          end
+          templates = struct.instance_variable_get(:@setting_templates)
+          if templates
+            templates.each do |name, value|
+              klass.create_method(name,
+                                  return_type: "void",
+                                  parameters: [create_block_param("blk", type: "T.proc.bind(#{constant_name}#{name.to_s.classify}).void")])
+              decorate_struct(path, value)
+            end
+          end
+
+        end
+      end
+
+      sig { override.void }
+      def decorate
+        root.create_path(constant) do |klass|
+          constant_name = T.must(constant.name).gsub('::', '')
+          class_name = "Private#{constant_name}Config"
+          klass.create_include('::FigTree')
+          klass.create_method("config", return_type: class_name, class_method: true)
+          proc_type = "T.proc.bind(#{class_name}).params(config: #{class_name}).void"
+          klass.create_method("configure",
+                              class_method: true,
+                              return_type: "void",
+                              parameters: [create_block_param("blk", type: proc_type)])
+          decorate_struct(constant_name, constant.config)
+        end
+      end
+
+    end
+  end
+end

data/rbi/fig_tree.rbi

@@ -0,0 +1,91 @@
+# typed: true
+
+module FigTree
+  extend ::ActiveSupport::Concern
+
+  mixes_in_class_methods ::FigTree::ClassMethods
+end
+
+module FigTree::ClassMethods
+  sig { params(block: T.proc.bind(::FigTree::ConfigStruct).void).void }
+  def after_configure(&block); end
+
+  sig { returns(::FigTree::ConfigStruct) }
+  def config; end
+
+  sig { params(block: T.proc.bind(::FigTree::ConfigStruct).void).void }
+  def configure(&block); end
+
+  sig { params(block: T.proc.bind(::FigTree::ConfigStruct).void).void }
+  def define_settings(&block); end
+
+  sig { params(values: T.nilable(Hash), block: T.proc).void }
+  def with_config(values = T.unsafe(nil), &block); end
+end
+
+class FigTree::ConfigStruct
+  include ::ActiveSupport::Callbacks
+  extend ::ActiveSupport::Callbacks::ClassMethods
+  extend ::ActiveSupport::DescendantsTracker
+
+  sig { params(name: String) }
+  def initialize(name); end
+
+  # source://fig_tree//lib/fig_tree.rb#74
+  def clone_and_reset; end
+
+  sig { params(old_config: String, new_config: String).void }
+  def deprecate(old_config, new_config); end
+
+  sig { returns(String) }
+  def inspect; end
+
+  sig { void }
+  def reset!; end
+
+  sig { params(name: Symbol, default_value: T.untyped, default_proc: T.proc, block: T.proc).void }
+  def setting(name, default_value = T.unsafe(nil), default_proc: T.unsafe(nil), &block); end
+
+  sig {params(name: Symbol, block: T.proc.bind(::FigTree::ConfigStruct).void).void }
+  def setting_object(name, &block); end
+
+  sig { returns(Hash) }
+  def to_h; end
+end
+
+class FigTree::ConfigValue < ::Struct
+  sig { void }
+  def clone_and_reset; end
+
+  sig { returns(T.untyped) }
+  def default_proc; end
+
+  sig { params(_: T.untyped).void }
+  def default_proc=(_); end
+
+  sig { returns(T.untyped) }
+  def default_value; end
+
+  sig { params(_: T.untyped).void }
+  def default_value=(_); end
+
+  sig { void }
+  def reset!; end
+
+  sig { returns(T.untyped) }
+  def value; end
+
+  sig { params(_: T.untyped).void }
+  def value=(_); end
+
+  class << self
+    def [](*_arg0); end
+    def inspect; end
+    def keyword_init?; end
+    def members; end
+    def new(*_arg0); end
+  end
+end
+
+# source://fig_tree//lib/fig_tree/version.rb#4
+FigTree::VERSION = T.let(T.unsafe(nil), String)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fig_tree
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Orner
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2024-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,7 +133,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-gemset"
 - ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -144,6 +143,8 @@ files:
 - fig_tree.gemspec
 - lib/fig_tree.rb
 - lib/fig_tree/version.rb
+- lib/tapioca/dsl/compilers/fig_tree.rb
+- rbi/fig_tree.rbi
 - spec/fig_tree_spec.rb
 - spec/spec_helper.rb
 - support/flipp-logo.png
@@ -166,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Configuration framework for Ruby.

data/.ruby-gemset

@@ -1 +0,0 @@
-fig_tree