confi 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 972b6f8e7309328bd9857eab968434da275e9c753c5a64d82cf0c039a460bbe4
+  data.tar.gz: 265e5a20d66bb72bb005c51461307947dc71e97bbbe887612dc36e39d75adfdb
+SHA512:
+  metadata.gz: a4b7cee86b97bf348d33c9659f69e434f7b5dbcacf0aaf22cb1573885c9d6637b1f620b1c685b0133a1bc53004170d5efc07cc0cb6779c91e4230607505bd95f
+  data.tar.gz: 78bf046e3f95bf8a2bb3c61a56cd6df1b2a9611daa7290c1552e8f003397f496a4c39ff646c47205d224525443ac5a55560458781913ad5aac1951864afcbd2e

data/.github/workflows/rake.yml

@@ -0,0 +1,31 @@
+name: Rake
+
+on: [push]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+#        ruby_version: [head, "3.4", "3.0"]
+        ruby_version: ["3.4"]
+        gemfile:
+          - Gemfile
+#        exclude:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler-cache: true # 'bundle install' and cache
+#      - name: Bundle install
+#        run: |
+#          bundle config set frozen false
+#          bundle config path /home/runner/bundle
+#          bundle install
+#          bundle update
+      - name: Build and test with Rake
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,3 @@
+# ~/.gitignore included
+
+*.log

data/.ruby-gemset

@@ -0,0 +1 @@
+rails-8.0

data/.ruby-version

@@ -0,0 +1 @@
+ruby-3.4.4

data/.watchr

@@ -0,0 +1 @@
+/home/dk/shared/.watchr-simple

data/BENCHMARKS

@@ -0,0 +1,46 @@
+2025-05-27
+==========
+ruby 3.4.4 (2025-05-14 revision a38531fd3f) +PRISM [x86_64-linux]
+Warming up --------------------------------------
+          ** (empty)     2.724M i/100ms
+               hsh:      2.611M i/100ms
+        hsh[:hugo]:      1.976M i/100ms
+ hsh[:hugo] = true:      1.341M i/100ms
+          hsh["b"]:      1.898M i/100ms
+      hsh["b"] = 3:      1.265M i/100ms
+    ** Confi (empty)     2.733M i/100ms
+ Confi.hugo = true:      1.294M i/100ms
+        Confi.hugo:      1.700M i/100ms
+     ** User (empty)     2.739M i/100ms
+              user:      2.577M i/100ms
+  user.hugo = true:      1.695M i/100ms
+         user.hugo:      1.813M i/100ms
+Calculating -------------------------------------
+          ** (empty)     26.870M (± 0.5%) i/s   (37.22 ns/i) -    136.212M in   5.069431s
+               hsh:      26.171M (± 0.4%) i/s   (38.21 ns/i) -    133.162M in   5.088175s
+        hsh[:hugo]:      19.633M (± 0.6%) i/s   (50.94 ns/i) -     98.822M in   5.033765s
+ hsh[:hugo] = true:      13.429M (± 0.4%) i/s   (74.46 ns/i) -     68.393M in   5.092913s
+          hsh["b"]:      19.057M (± 0.5%) i/s   (52.48 ns/i) -     96.824M in   5.081001s
+      hsh["b"] = 3:      12.595M (± 1.1%) i/s   (79.39 ns/i) -     63.253M in   5.022507s
+    ** Confi (empty)     26.773M (± 0.4%) i/s   (37.35 ns/i) -    133.895M in   5.001222s
+ Confi.hugo = true:      12.842M (± 0.9%) i/s   (77.87 ns/i) -     64.706M in   5.039055s
+        Confi.hugo:      16.972M (± 0.6%) i/s   (58.92 ns/i) -     84.978M in   5.007025s
+     ** User (empty)     27.079M (± 0.5%) i/s   (36.93 ns/i) -    136.961M in   5.057976s
+              user:      25.655M (± 0.5%) i/s   (38.98 ns/i) -    128.853M in   5.022659s
+  user.hugo = true:      16.842M (± 0.4%) i/s   (59.38 ns/i) -     84.743M in   5.031835s
+         user.hugo:      17.932M (± 0.4%) i/s   (55.77 ns/i) -     90.670M in   5.056536s
+
+Comparison:
+     ** User (empty): 27078912.1 i/s
+          ** (empty): 26870068.1 i/s - same-ish: difference falls within error
+    ** Confi (empty): 26772970.4 i/s - 1.01x  slower
+               hsh: : 26171272.6 i/s - 1.03x  slower
+              user: : 25654956.6 i/s - 1.06x  slower
+        hsh[:hugo]: : 19632521.2 i/s - 1.38x  slower
+          hsh["b"]: : 19056544.7 i/s - 1.42x  slower
+         user.hugo: : 17931506.3 i/s - 1.51x  slower
+        Confi.hugo: : 16972414.8 i/s - 1.60x  slower
+  user.hugo = true: : 16841777.7 i/s - 1.61x  slower
+ hsh[:hugo] = true: : 13429358.2 i/s - 2.02x  slower
+ Confi.hugo = true: : 12841938.3 i/s - 2.11x  slower
+      hsh["b"] = 3: : 12595451.2 i/s - 2.15x  slower

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "benchmark", require: false
+  gem "benchmark-ips", require: false
+  gem "byebug", require: false
+  gem "minitest"
+  gem "rake"
+  gem "ricecream", require: false
+end

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    confi (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    benchmark (0.4.0)
+    benchmark-ips (2.14.0)
+    byebug (12.0.0)
+    docile (1.4.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.10.0)
+    ricecream (0.2.1)
+    rubocop (1.75.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.44.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-performance (1.25.0)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
+    standard (1.50.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.75.5)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.8.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.25.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  benchmark
+  benchmark-ips
+  byebug
+  confi!
+  minitest
+  rake
+  ricecream
+  simplecov
+  standard
+
+BUNDLED WITH
+   2.6.7

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Dittmar Krall (www.matiq.com)
+
+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,71 @@
+# Confi
+
+[![Gem Version](https://badge.fury.io/rb/confi.svg)](http://badge.fury.io/rb/confi)
+[![GEM Downloads](https://img.shields.io/gem/dt/confi?color=168AFE&logo=ruby&logoColor=FE1616)](https://rubygems.org/gems/confi)
+[![rake](https://github.com/matique/confi/actions/workflows/rake.yml/badge.svg)](https://github.com/matique/confi/actions/workflows/rake.yml)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/standardrb/standard)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](http://choosealicense.com/licenses/mit/)
+
+A simple and efficient "configuration" gem for Ruby
+(can be used in Rails as well).
+Options can be initialized as required and later be accessed.
+
+A global *Confi* (the usual usage)
+as well as an instance (not recommended) configuration
+are supported.
+
+See *Usage* below.
+
+
+## Installation
+
+~~~~ruby
+# Gemfile
+...
+gem "confi"
+...
+~~~~
+
+## Usage
+
+~~~~ruby
+require "confi"
+...
+Confi.debug = true
+...
+if Confi.debug
+  ...
+end
+...
+~~~~
+
+~~~~ruby
+require "confi"
+
+class User
+include Confi
+end
+...
+user = User.new
+user.debug = false
+...
+if user.debug
+  ...
+end
+...
+~~~~
+
+~~~~ruby
+...
+# Not yet initialized attribute
+if Confi.debug  # NoMethodError: undefined method 'debug'
+  ...
+end
+...
+~~~~
+
+
+## Miscellaneous
+
+Copyright (c) 2025 Dittmar Krall (www.matiq.com),
+released under the [MIT license](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require "rake"
+require "rake/testtask"
+require "bundler/gem_tasks"
+
+Rake::TestTask.new do |t|
+  t.libs.push "test"
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Default: run unit tests."
+task default: :test

data/confi.gemspec

@@ -0,0 +1,22 @@
+# $LOAD_PATH.push File.expand_path("lib", __dir__)
+
+VERSION = "0.1.1"
+
+Gem::Specification.new do |s|
+  s.name = "confi"
+  s.version = VERSION
+  s.summary = "Auto attr_accessor for a kind of configuration"
+  s.description = s.summary
+
+  s.authors = ["Dittmar Krall"]
+  s.email = "dittmar.krall@gmail.com"
+  s.homepage = "https://github.com/matique/confi"
+  s.license = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.required_ruby_version = "~> 3"
+
+  s.add_development_dependency "simplecov", ">= 0"
+  s.add_development_dependency "standard", ">= 0"
+end

data/lib/confi.rb

@@ -0,0 +1,46 @@
+require "yaml"
+
+module Confi
+  extend self
+
+  def configure(source = {})
+    source.each { |key, value| accessors(key, value) }
+    yield self if block_given?
+  end
+
+  private
+
+  def dump
+    res = {}
+    @keys.uniq.each { |key| res[key] = send(key) }
+    res
+  end
+
+  def accessors(key, value)
+    @keys ||= []
+    @keys << key.to_sym
+    name = key.to_s
+    writer = "#{name}="
+    var_name = "@AWE_#{name}"
+
+    self.class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{name};     #{var_name}; end
+      def #{name}=(x); #{var_name} = x; end
+    RUBY
+    send(writer, value)
+  end
+
+  def method_missing(method_name, *args)
+    if method_name.end_with?("=")
+      name = method_name[0..-2]
+      accessors(name, args.first)
+    else
+      super
+    end
+    nil
+  end
+
+  def respond_to_missing?(method_name, include_private = false)
+    method_name.end_with?("=") || super
+  end
+end

data/test/benchmark_test.rb

@@ -0,0 +1,45 @@
+# For development purposes; do not waste your tine reading it!
+
+require "test_helper"
+require_relative "../lib/confi"
+require "benchmark"
+require "benchmark/ips"
+# ENV["MORE"] = "true"
+
+class User
+  include Confi
+end
+
+describe "ConfigWe timings" do
+  it "times ips" do
+    return unless ENV["MORE"]
+
+    p "********************** Confi timings"
+    hsh = {"a" => 1, "b" => 2, :hugo => 3}
+    user = User.new
+    user.configure(hsh)
+
+    Benchmark.ips do |x|
+      x.report("** (empty)") {}
+      x.report("hsh: ") { hsh }
+      x.report("hsh[:hugo]: ") { hsh[:hugo] }
+      x.report("hsh[:hugo] = true: ") { hsh[:hugo] = true }
+      x.report("hsh[\"b\"]: ") { hsh["b"] }
+      x.report("hsh[\"b\"] = 3: ") { hsh["b"] = 3 }
+
+      x.report("** Confi (empty)") {}
+      # x.report("Confi.b: ") { Confi.b } # expected fail
+      x.report("Confi.hugo = true: ") { Confi.hugo = true }
+      x.report("Confi.hugo: ") { Confi.hugo }
+      # x.report("Confi.a: ") { Confi.a } # expected fail
+
+      x.report("** User (empty)") {}
+      x.report("user: ") { user }
+      # x.report("user.unknown: ") { user.unknown } # expected fail
+      x.report("user.hugo = true: ") { user.hugo = true }
+      x.report("user.hugo: ") { user.hugo }
+
+      x.compare!
+    end
+  end
+end

data/test/confi_test.rb

@@ -0,0 +1,54 @@
+require "test_helper"
+require_relative "../lib/confi"
+
+describe Confi do
+  let(:int) { 123 }
+  let(:list) { [1, 2, 3] }
+  let(:hsh) { {"a" => 1, "b" => 2, "c" => 3} }
+  let(:symb) { :symbol }
+
+  it "putter & getter" do
+    Confi.a = symb
+    assert_equal symb, Confi.a
+    Confi.a = int
+    assert_equal int, Confi.a
+  end
+
+  it "configures with hash" do
+    Confi.configure(hsh)
+    check hsh
+  end
+
+  it "configures with block" do
+    Confi.configure do |m|
+      m.aa = int
+      m.bb = list
+    end
+    assert_equal int, Confi.aa
+    assert_equal list, Confi.bb
+  end
+
+  it "dumps (private method)" do
+    Confi.configure(hsh)
+    res = Confi.send(:dump)
+    assert res
+    check hsh
+  end
+
+  it "round trip with a YAML file" do
+    Tempfile.create do |f|
+      f.puts YAML.dump(hsh)
+      f.rewind
+      Confi.configure(YAML.load(f.read))
+      check hsh
+    end
+  end
+
+  private
+
+  def check(hsh)
+    hsh.each { |key, value|
+      assert_equal hsh[key], Confi.send(key)
+    }
+  end
+end

data/test/include_test.rb

@@ -0,0 +1,59 @@
+require "test_helper"
+require "yaml"
+require_relative "../lib/confi"
+
+class User
+  include Confi
+end
+
+describe User do
+  let(:int) { rand 1..10 }
+  let(:symb) { :symbol }
+  let(:hsh) { {"a" => 1, "b" => 2} }
+  let(:user) { User.new }
+
+  it "rejects uninitialized attribute" do
+    assert_raises {
+      user.unknown
+    }
+  end
+
+  it "putter & getter" do
+    user.a = symb
+    assert_equal symb, user.a
+  end
+
+  it "configures with hash" do
+    user.configure(hsh)
+
+    assert_equal 1, user.a
+    assert_equal 2, user.b
+  end
+
+  it "configures with block" do
+    user.configure do |spec|
+      spec.c = :c
+    end
+
+    assert_equal :c, user.c
+  end
+
+  it "configures with hash & block" do
+    user.configure(hsh) do |spec|
+      spec.c = :c
+    end
+
+    assert_equal 1, user.a
+    assert_equal :c, user.c
+  end
+
+  it "configure independent instances" do
+    user2 = User.new
+    user.a = symb
+    user2.a = int
+
+    assert_equal symb, user.a
+    assert_equal int, user2.a
+    refute_equal user.a, user2.a
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+if ENV["COVERAGE"]
+  require "simplecov"
+  SimpleCov.start do
+    add_filter "/test/"
+  end
+end
+
+require "minitest/autorun"
+require "ricecream"

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: confi
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Dittmar Krall
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Auto attr_accessor for a kind of configuration
+email: dittmar.krall@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".watchr"
+- BENCHMARKS
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- confi.gemspec
+- lib/confi.rb
+- test/benchmark_test.rb
+- test/confi_test.rb
+- test/include_test.rb
+- test/test_helper.rb
+homepage: https://github.com/matique/confi
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Auto attr_accessor for a kind of configuration
+test_files: []