much-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b57448869dc7209d8ddd1469c8ba8a24fab607d9a43f03f851e4ae4acdc633da
+  data.tar.gz: b3246844ed8b0002c3b184e5fb1a8fa080e8837cd02cfeda41a522892cbc8378
+SHA512:
+  metadata.gz: 39f371597e408694f420b6a84dcb04f2a21e48bf83f970e3f418a851926f37263dff8de8e37472971cfc52fb1d8e34bbc685ce43c2e6e115b27d78c6babea62c
+  data.tar.gz: b7803e2b769fd7fcbb5a1ceab9f102efedd34265b19e26fdd7f08890a0fd3221e8ff865a3d5aef50c6b85f716854a190eb8e25f44aee177b41e86b039729ebd6

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "~> 2.5"
+
+gemspec
+
+gem "pry"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2021-Present Kelly Redding and Collin Redding
+
+MIT License
+
+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,114 @@
+# MuchConfig
+
+Configuration for Ruby objects.
+
+## Usage
+
+Mixin MuchConfig in your e.g. `MyClass` Ruby object. Call the `add_config` DSL method and define `MyClass::Config`:
+
+```ruby
+module MyClass
+  include MuchConfig
+
+  add_config
+
+  def self.value1
+    config.value1
+  end
+
+  class Config
+    attr_accessor :value1
+
+    def initialize
+      @value1 = "default value for `value1`"
+    end
+  end
+end
+```
+
+Configure MyClass using the MuchConfig API:
+
+```ruby
+MyClass.config.value1 = "a custom value"
+
+# OR
+
+MyClass.configure do |config|
+  config.value1 = "a custom value"
+end
+```
+
+### Define multiple named configs
+
+You can define multiple named configs, e.g.:
+
+```ruby
+module MyClass
+  include MuchConfig
+
+  add_config :values
+  add_config :settings
+
+  def self.value1
+    values_config.value1
+  end
+
+  def self.setting1
+    settings_config.setting1
+  end
+
+  class ValuesConfig
+    attr_accessor :value1
+
+    def initialize
+      @value1 = "default value for `value1`"
+    end
+  end
+
+  class SettingsConfig
+    attr_accessor :setting1
+
+    def initialize
+      @setting1 = "default value for `setting1`"
+    end
+  end
+end
+```
+
+Configure using the MuchConfig API:
+
+```ruby
+MyClass.values_config.value1 = "a custom value"
+MyClass.settings_config.setting1 = "a custom value"
+
+# OR
+
+MyClass.configure_values do |config|
+  config.value1 = "a custom value"
+end
+MyClass.configure_settings do |config|
+  config.setting1 = "a custom value"
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "much-config"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install much-config
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am "Added some feature"`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/lib/much-config.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require "much-config/version"
+require "much-mixin"
+
+module MuchConfig
+  include MuchMixin
+
+  def self.classify(term)
+    # prefer to ActiveSupport if present
+    return term.classify if term.respond_to?(:classify)
+
+    value = term.sub(/^[a-z\d]*/, &:capitalize)
+    value.gsub!(%r{(?:_|(/))([a-z\d]*)}i) do
+      "#{Regexp.last_match(1)}#{Regexp.last_match(2).capitalize}"
+    end
+    value.gsub!("/", "::")
+    value
+  end
+
+  def self.underscore(cased_term)
+    # prefer to ActiveSupport if present
+    return cased_term.underscore if cased_term.respond_to?(:underscore)
+
+    return cased_term unless /[A-Z-]|::/.match?(cased_term)
+
+    term = cased_term.to_s.gsub("::", "/")
+    term.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+    term.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+    term.tr!("-", "_")
+    term.downcase!
+    term
+  end
+
+  mixin_class_methods do
+    def add_config(name = nil, method_name: nil)
+      config_method_name, config_class_name, configure_method_name =
+        much_config_names(name, method_name)
+
+      instance_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        def #{config_method_name}
+          @#{config_method_name} ||= self::#{config_class_name}.new
+        end
+
+        def #{configure_method_name}
+          yield(#{config_method_name}) if block_given?
+        end
+      RUBY
+    end
+
+    def add_instance_config(name = nil, method_name: nil)
+      config_method_name, config_class_name, configure_method_name =
+        much_config_names(name, method_name)
+
+      instance_eval(<<~RUBY, __FILE__, __LINE__ + 1)
+        define_method(:#{config_method_name}) do
+          @#{config_method_name} ||= self.class::#{config_class_name}.new
+        end
+
+        define_method(:#{configure_method_name}) do |&block|
+          block.call(#{config_method_name}) if block
+        end
+      RUBY
+    end
+
+    private
+
+    def much_config_names(name, method_name)
+      name_prefix = name.nil? ? "" : "#{MuchConfig.underscore(name.to_s)}_"
+      config_method_name = (method_name || "#{name_prefix}config").to_s
+      config_class_name = "#{MuchConfig.classify(name_prefix)}Config"
+
+      name_suffix = name.nil? ? "" : "_#{MuchConfig.underscore(name.to_s)}"
+      configure_method_name = "configure#{name_suffix}"
+
+      [config_method_name, config_class_name, configure_method_name]
+    end
+  end
+end

data/lib/much-config/version.rb

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

data/much-config.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "much-config/version"
+
+Gem::Specification.new do |gem|
+  gem.name        = "much-config"
+  gem.version     = MuchConfig::VERSION
+  gem.authors     = ["Kelly Redding", "Collin Redding"]
+  gem.email       = ["kelly@kellyredding.com", "collin.redding@me.com"]
+  gem.summary     = "Configuration for Ruby objects."
+  gem.description = "Configuration for Ruby objects."
+  gem.homepage    = "https://github.com/redding/much-config"
+  gem.license     = "MIT"
+
+  gem.files = `git ls-files | grep "^[^.]"`.split($INPUT_RECORD_SEPARATOR)
+
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.required_ruby_version = "~> 2.5"
+
+  gem.add_development_dependency("much-style-guide", ["~> 0.6.4"])
+  gem.add_development_dependency("assert",           ["~> 2.19.6"])
+
+  gem.add_dependency("much-mixin", ["~> 0.2.4"])
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# This file is automatically required when you run `assert`; put any test
+# helpers here.
+
+# Add the root dir to the load path.
+$LOAD_PATH.unshift(File.expand_path("../..", __FILE__))
+
+# Require pry for debugging (`binding.pry`).
+require "pry"
+
+require "test/support/factory"

data/test/support/factory.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "assert/factory"
+
+module Factory
+  extend Assert::Factory
+end

data/test/unit/much-config_tests.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "assert"
+require "much-config"
+
+require "much-mixin"
+
+module MuchConfig
+  class UnitTests < Assert::Context
+    desc "MuchConfig"
+    subject{ unit_class }
+
+    let(:unit_class){ MuchConfig }
+
+    should "be configured as expected" do
+      assert_that(subject).includes(MuchMixin)
+    end
+  end
+
+  class ReceiverTests < UnitTests
+    desc "receiver"
+    subject{ receiver_class }
+
+    setup do
+      class receiver_class::Config
+        attr_accessor :value
+      end
+
+      class receiver_class::AnotherConfig
+        include MuchConfig
+
+        add_instance_config :sub, method_name: :sub
+
+        attr_accessor :another_value
+
+        class SubConfig
+          attr_accessor :sub_value
+        end
+      end
+    end
+
+    let(:receiver_class) do
+      Class.new do
+        include MuchConfig
+
+        add_config
+        add_config :another
+      end
+    end
+
+    should have_imeths :config, :another_config
+
+    should "know its attributes" do
+      assert_that(subject.config).is_instance_of(subject::Config)
+      subject.configure{ |config| config.value = "VALUE 1" }
+      assert_that(subject.config.value).equals("VALUE 1")
+
+      assert_that(subject.another_config).is_instance_of(subject::AnotherConfig)
+      subject.configure_another{ |config| config.another_value = "VALUE 2" }
+      assert_that(subject.another_config.another_value).equals("VALUE 2")
+
+      assert_that(subject.another_config.sub)
+        .is_instance_of(subject::AnotherConfig::SubConfig)
+      subject.another_config.configure_sub do |sub|
+        sub.sub_value = "VALUE 3"
+      end
+      assert_that(subject.another_config.sub.sub_value).equals("VALUE 3")
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: much-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kelly Redding
+- Collin Redding
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-06-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: much-style-guide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+- !ruby/object:Gem::Dependency
+  name: assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.6
+- !ruby/object:Gem::Dependency
+  name: much-mixin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+description: Configuration for Ruby objects.
+email:
+- kelly@kellyredding.com
+- collin.redding@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- lib/much-config.rb
+- lib/much-config/version.rb
+- log/.keep
+- much-config.gemspec
+- test/helper.rb
+- test/support/factory.rb
+- test/system/.keep
+- test/unit/much-config_tests.rb
+- tmp/.keep
+homepage: https://github.com/redding/much-config
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Configuration for Ruby objects.
+test_files:
+- test/helper.rb
+- test/support/factory.rb
+- test/system/.keep
+- test/unit/much-config_tests.rb