dot_options 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb3d62c652e1453a6a6d4fcc5df1334c3998c257089fe8ac455bee3b93a7a3b2
+  data.tar.gz: d52505910635b560f397d91d59a49001a625011eff3971e246791d46c62e65bd
+SHA512:
+  metadata.gz: 8c1e1384ad4a64014e35921c903a7994e38c97cab01441e3716ce659b5e1051390d9755065e6e6c4f8ec5af2507c34f32011569b5a080908ff219100c3c8f75d
+  data.tar.gz: 2e6a4e3df06791a9eae4b10d2eac41b29bb814b0392f0ae600ee6d47fc8e99616aa975f37b8c1dd6e40b4df4ff53f0d3bb32ed46f735d70364df22b623c194ff

data/README.md

@@ -0,0 +1,44 @@
+# DotOptions - Options object with dot-notation access
+
+Convert any hash to a an object with deep read/write dot-notation access.
+
+[![Gem Version](https://badge.fury.io/rb/dot_options.svg)](https://badge.fury.io/rb/dot_options)
+[![Build Status](https://github.com/DannyBen/dot_options/workflows/Test/badge.svg)](https://github.com/DannyBen/dot_options/actions?query=workflow%3ATest)
+
+---
+
+## Install
+
+```
+$ gem install dot_options
+```
+
+## Usage
+
+```ruby
+# Initialize a DotOptions object with a hash:
+opts = {
+  debug:  true,
+  output: { color: true },
+  skin:   { background: { color: :black, texture: 'Stripes' } },
+}
+options = DotOptions.new opts
+
+# Read any option with dot-notation:
+p options.skin.background.color  # => :black
+
+# Update any option with dot-notation:
+options.skin.background.color = :black
+
+# ... or create an entire branch by providing a hash
+options.skin.foreground = { color: :white, font: 'JetBrains Mono' }
+p options.skin.foreground.font  # => 'JetBrains Mono'
+```
+
+## Contributing / Support
+
+If you experience any issue, have a question or a suggestion, or if you wish
+to contribute, feel free to [open an issue][issues].
+
+
+[issues]: https://github.com/DannyBen/dot_options/issues

data/lib/dot_options/version.rb

@@ -0,0 +1,3 @@
+class DotOptions
+  VERSION = '0.1.0'
+end

data/lib/dot_options.rb

@@ -0,0 +1,66 @@
+class DotOptions
+  OptionNotFoundError = Class.new StandardError
+
+  attr_reader :options, :key, :parent
+
+  def initialize(options = {}, key: nil, parent: nil)
+    @options = options
+    @key = key
+    @parent = parent
+    build_options
+  end
+
+  def inspect
+    "{ #{options.map { |key, value| "#{key}: #{value.inspect}" }.join(', ')} }"
+  end
+
+  def to_s
+    flat_options.map { |key, value| "#{key} = #{value.inspect}" }.join "\n"
+  end
+
+  def flat_options(prefix = nil)
+    result = {}
+    options.each do |key, value|
+      full_key = [prefix, key].compact.join '.'
+      opts = value.is_a?(DotOptions) ? value.flat_options(full_key) : { full_key => value }
+      result.merge! opts
+    end
+
+    result
+  end
+
+  def method_missing(name, *args)
+    if name.to_s.end_with?('=')
+      key = name.to_s.chomp('=').to_sym
+      options[key] = args.first
+      build_options if args.first.is_a? Hash
+    elsif options.has_key? name
+      options[name]
+    else
+      raise OptionNotFoundError, "Option '#{full_path(name)}' not found"
+    end
+  end
+
+  def respond_to_missing?(name, include_private = false)
+    options.has_key?(name.to_s.chomp('=').to_sym) || super
+  end
+
+private
+
+  def build_options
+    options.each do |key, value|
+      options[key] = DotOptions.new(value, key: key, parent: self) if value.is_a?(Hash)
+    end
+  end
+
+  def full_path(name)
+    ancestors = [name]
+    current = self
+    while current.is_a? DotOptions
+      ancestors.unshift(current.key) if current.key
+      current = current.parent
+    end
+
+    ancestors.join '.'
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: dot_options
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-30 00:00:00.000000000 Z
+dependencies: []
+description: Convert any hash to a deep dot-notation object
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/dot_options.rb
+- lib/dot_options/version.rb
+homepage: https://github.com/dannyben/dot_notation
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/DannyBen/dot_options/issues
+  changelog_uri: https://github.com/DannyBen/dot_options/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/DannyBen/dot_options
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: Options object with dot-notation support
+test_files: []