fig_tree 0.0.1

data/fig_tree.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fig_tree/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fig_tree'
+  spec.version       = FigTree::VERSION
+  spec.authors       = ['Daniel Orner']
+  spec.email         = ['daniel.orner@flipp.com']
+  spec.summary       = 'Configuration framework for Ruby.'
+  spec.homepage      = ''
+  spec.license       = 'Apache-2.0'
+  spec.required_ruby_version = '2.3'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activesupport', '>= 3.0.0')
+
+  spec.add_development_dependency('guard', '~> 2')
+  spec.add_development_dependency('guard-rspec', '~> 4')
+  spec.add_development_dependency('guard-rubocop', '~> 1')
+  spec.add_development_dependency('rspec', '~> 3')
+  spec.add_development_dependency('rspec_junit_formatter', '~>0.3')
+  spec.add_development_dependency('rubocop', '~> 0.72')
+  spec.add_development_dependency('rubocop-rspec', '~> 1.27')
+end

data/lib/fig_tree.rb

@@ -0,0 +1,251 @@
+# frozen_string_literal: true
+
+require 'fig_tree/version'
+
+# frozen_string_literal: true
+
+require 'active_support/concern'
+require 'active_support/callbacks'
+
+# Configuration module.
+module FigTree
+  extend ActiveSupport::Concern
+
+  ConfigValue = Struct.new(:value, :default_value, :default_proc, :deprecation) do
+
+    # Reset value back to default.
+    def reset!
+      if self.value.is_a?(ConfigStruct)
+        self.value.reset!
+      else
+        self.value = self.default_value
+      end
+    end
+
+    # :nodoc:
+    def clone_and_reset
+      setting = ConfigValue.new(self.value, self.default_value,
+                                self.default_proc, self.deprecation)
+      setting.reset!
+      setting
+    end
+
+  end
+
+  # Class that defines and keeps the configuration values.
+  class ConfigStruct
+    include ActiveSupport::Callbacks
+
+    define_callbacks :configure
+
+    # @param name [String]
+    def initialize(name)
+      @name = name
+      @settings = {}
+      @setting_objects = {}
+      @setting_templates = {}
+    end
+
+    # Reset config back to default values.
+    def reset!
+      @setting_objects = @setting_templates.map { |k, _| [k, []] }.to_h
+      @settings.values.each(&:reset!)
+    end
+
+    # Mark a configuration as deprecated and replaced with the new config.
+    # @param old_config [String]
+    # @param new_config [String]
+    def deprecate(old_config, new_config)
+      @settings[old_config.to_sym] ||= ConfigValue.new
+      @settings[old_config.to_sym].deprecation = new_config
+    end
+
+    # :nodoc:
+    def inspect
+      "#{@name}: #{@settings.inspect} #{@setting_objects.inspect}"
+    end
+
+    # @return [Hash]
+    def to_h
+      @settings.map { |k, v| [k, v.value] }.to_h
+    end
+
+    # :nodoc:
+    def clone_and_reset
+      new_config = self.clone
+      new_config.setting_objects = new_config.setting_objects.clone
+      new_config.settings = new_config.settings.map { |k, v| [k, v.clone_and_reset] }.to_h
+      new_config
+    end
+
+    # Define a setting template for an array of objects via a block:
+    #   setting_object :producer do
+    #     setting :topic
+    #     setting :class_name
+    #   end
+    # This will create the `producer` method to define these values as well
+    # as the `producer_objects` method to retrieve them.
+    # @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)
+    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)
+      if block_given?
+        # Create a nested setting
+        setting_config = @settings[name]&.value || ConfigStruct.new("#{@name}.#{name}")
+        setting = ConfigValue.new
+        setting.value = setting_config
+        @settings[name] = setting
+        setting_config.instance_eval(&block)
+      else
+        setting = ConfigValue.new
+        setting.default_proc = default_proc
+        setting.default_value = default_value
+        setting.reset!
+        @settings[name] = setting
+      end
+    end
+
+    # :nodoc:
+    def respond_to_missing?(method, include_all=true)
+      method = method.to_s.sub(/=$/, '')
+      method.ends_with?('objects') ||
+        @setting_templates.key?(method.to_sym) ||
+        @settings.key?(method.to_sym) ||
+        super
+    end
+
+    # :nodoc:
+    def method_missing(method, *args, &block)
+      config_key = method.to_s.sub(/=$/, '').to_sym
+
+      # Return the list of setting objects with the given name
+      if config_key.to_s.end_with?('objects')
+        return _setting_object_method(config_key)
+      end
+
+      # Define a new setting object with the given name
+      if @setting_templates.key?(config_key) && block_given?
+        return _new_setting_object_method(config_key, &block)
+      end
+
+      setting = @settings[config_key]
+
+      if setting&.deprecation
+        return _deprecated_config_method(method, *args)
+      end
+
+      return super unless setting
+
+      if block_given?
+        return _block_config_method(config_key, &block)
+      end
+
+      _default_config_method(config_key, *args)
+    end
+
+  protected
+
+    # Only for the clone method
+    attr_accessor :settings, :setting_objects
+
+  private
+
+    def _deprecated_config_method(method, *args)
+      config_key = method.to_s.sub(/=$/, '').to_sym
+      new_config = @settings[config_key].deprecation
+      equals = method.to_s.end_with?('=') ? '=' : ''
+      warning = "config.#{config_key}#{equals} is deprecated - use config.#{new_config}#{equals}"
+      ActiveSupport::Deprecation.warn(warning)
+      obj = self
+      messages = new_config.split('.')
+      messages[0..-2].each do |message|
+        obj = obj.send(message)
+      end
+      if args.length.positive?
+        obj.send(messages[-1], args[0])
+      else
+        obj.send(messages[-1])
+      end
+    end
+
+    # Get or set a value.
+    def _default_config_method(config_key, *args)
+      if args.length.positive?
+        # Set the value
+        @settings[config_key].value = args[0]
+      else
+        # Get the value
+        setting = @settings[config_key]
+        if setting.default_proc && setting.value.nil?
+          setting.value = setting.default_proc.call
+        end
+        setting.value
+      end
+    end
+
+    # Define a new setting object and use the passed block to define values.
+    def _new_setting_object_method(config_key, &block)
+      new_config = @setting_templates[config_key].clone_and_reset
+      new_config.instance_eval(&block)
+      @setting_objects[config_key] << new_config
+    end
+
+    # Return a setting object.
+    def _setting_object_method(config_key)
+      key = config_key.to_s.sub(/_objects$/, '').to_sym
+      @setting_objects[key]
+    end
+
+    # Define new values inside a block.
+    def _block_config_method(config_key, &block)
+      unless @settings[config_key].value.is_a?(ConfigStruct)
+        raise "Block called for #{config_key} but it is not a nested config!"
+      end
+
+      @settings[config_key].value.instance_eval(&block)
+    end
+  end
+
+  # :nodoc:
+  module ClassMethods
+    # Define and redefine settings.
+    def define_settings(&block)
+      config.instance_eval(&block)
+    end
+
+    # Configure the settings with values.
+    def configure(&block)
+      if defined?(Rake) && defined?(Rake.application)
+        tasks = Rake.application.top_level_tasks
+        if tasks.any? { |t| %w(assets webpacker yarn).include?(t.split(':').first) }
+          puts 'Skipping Deimos configuration since we are in JS/CSS compilation'
+          return
+        end
+      end
+      config.run_callbacks(:configure) do
+        config.instance_eval(&block)
+      end
+    end
+
+    # @return [ConfigStruct]
+    def config
+      @config ||= ConfigStruct.new('config')
+    end
+
+    # Pass a block to run after configuration is done.
+    def after_configure(&block)
+      mod = self
+      config.class.set_callback(:configure, :after,
+                                proc { mod.instance_eval(&block) })
+    end
+  end
+end

data/lib/fig_tree/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+RSpec.configure do |config|
+  config.full_backtrace = true
+
+  # true by default for RSpec 4.0
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  config.mock_with(:rspec) do |mocks|
+    mocks.yield_receiver_to_any_instance_implementation_blocks = true
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification
+name: fig_tree
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Orner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.27'
+description:
+email:
+- daniel.orner@flipp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.md
+- README.md
+- fig_tree.gemspec
+- lib/fig_tree.rb
+- lib/fig_tree/version.rb
+- spec/spec_helper.rb
+- support/flipp-logo.png
+homepage: ''
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '='
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Configuration framework for Ruby.
+test_files:
+- spec/spec_helper.rb