dot_options 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb3d62c652e1453a6a6d4fcc5df1334c3998c257089fe8ac455bee3b93a7a3b2
-  data.tar.gz: d52505910635b560f397d91d59a49001a625011eff3971e246791d46c62e65bd
+  metadata.gz: dcf63d2712a4a74313dbe914f5e52254243205f52c4715630a5dd84143dca366
+  data.tar.gz: 9be1281cc5d72168f23cb520d2d1e2a9a2c2a1427a3ff7298c48e8721de9a7a6
 SHA512:
-  metadata.gz: 8c1e1384ad4a64014e35921c903a7994e38c97cab01441e3716ce659b5e1051390d9755065e6e6c4f8ec5af2507c34f32011569b5a080908ff219100c3c8f75d
-  data.tar.gz: 2e6a4e3df06791a9eae4b10d2eac41b29bb814b0392f0ae600ee6d47fc8e99616aa975f37b8c1dd6e40b4df4ff53f0d3bb32ed46f735d70364df22b623c194ff
+  metadata.gz: fab0a8b1da7745406234335c7fe511df4f27e2149bfacc070fb72ed7116e3af794e1ab83659e5a7694a43c05599b0dde1f7fe4af038ff4b2d15d7052ce3f6d82
+  data.tar.gz: 17e1499a88d9a172fa07d265f765619840b22ff680bbfe0650777abfc3da049e9a0d1b767721fc18969d1b1ded40f7db949d418e175387173fa90fe450c6261f

data/README.md

@@ -4,6 +4,7 @@ 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)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9506098f88fd04fdefae/maintainability)](https://codeclimate.com/github/DannyBen/dot_options/maintainability)
 
 ---
 
@@ -16,6 +17,9 @@ $ gem install dot_options
 ## Usage
 
 ```ruby
+# Usage
+require 'dot_options'
+
 # Initialize a DotOptions object with a hash:
 opts = {
   debug:  true,
@@ -25,14 +29,78 @@ opts = {
 options = DotOptions.new opts
 
 # Read any option with dot-notation:
-p options.skin.background.color  # => :black
+p options.skin.background.color
+#=> :black
 
-# Update any option with dot-notation:
+# Update any option leaf 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'
+# Print a flat view of all options
+puts options
+#=> debug = true
+#=> output.color = true
+#=> skin.background.color = :black
+#=> skin.background.texture = "Stripes"
+
+# ... or a compact inspection string for any branch
+p options.skin
+#=> <background: <color: :black, texture: "Stripes">>
+
+# Access is also possible using []
+p options.skin[:background].color
+p options.skin[:background][:color]
+#=> :black
+#=> :black
+```
+
+### Subclassing
+
+Subclassing `DotOptions` is a useful way to have an object with default options.
+
+```ruby
+# Subclassing
+require 'dot_options'
+
+class Skin < DotOptions
+  def initialize(options = nil)
+    super defaults.merge(options || {})
+  end
+
+  def defaults
+    {
+      color: :black,
+      border: { color: :red, width: 3 },
+      background: { color: :lime, texture: 'Stripes' },
+    }
+  end
+end
+
+# Get an object with the default options
+skin = Skin.new 
+p skin.background.color
+#=> :lime
+
+# Get an object and override some root options using a hash
+skin = Skin.new color: :blue
+p skin.color
+#=> :blue
+
+# Get an object and update some deep options using a block
+skin = Skin.new { border.color = :yellow }
+puts skin.border
+#=> color = :yellow
+#=> width = 3
+
+# The initialization block receives the object itself which can be useful
+# in some cases
+skin = Skin.new do |skin|
+  skin.color = :cyan
+  skin.border.width = 10
+end
+p skin.color
+p skin.border
+#=> :cyan
+#=> <color: :red, width: 10>
 ```
 
 ## Contributing / Support

data/lib/dot_options/version.rb

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

data/lib/dot_options.rb

@@ -1,66 +1,71 @@
 class DotOptions
-  OptionNotFoundError = Class.new StandardError
+  attr_reader :_options
+  attr_accessor :_key, :_parent, :_full_path
 
-  attr_reader :options, :key, :parent
+  def initialize(base_options = nil, &block)
+    @_key = nil
+    @_parent = nil
+    @_options = []
+    @_full_path = []
+    _build_options(base_options || {})
+    instance_eval(&block) if block
+  end
 
-  def initialize(options = {}, key: nil, parent: nil)
-    @options = options
-    @key = key
-    @parent = parent
-    build_options
+  def [](key)
+    _options.include?(key.to_sym) ? send(key.to_sym) : nil
   end
 
   def inspect
-    "{ #{options.map { |key, value| "#{key}: #{value.inspect}" }.join(', ')} }"
+    "<#{_options.map { |key| "#{key}: #{send(key).inspect}" }.join(', ')}>"
   end
 
   def to_s
-    flat_options.map { |key, value| "#{key} = #{value.inspect}" }.join "\n"
+    _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
+  def to_h
+    _options.to_h do |key|
+      value = send key
+      value = value.to_h if value.is_a? DotOptions
+      [key, value]
     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
+protected
 
-  def respond_to_missing?(name, include_private = false)
-    options.has_key?(name.to_s.chomp('=').to_sym) || super
+  def _flat_options(prefix = nil)
+    result = {}
+    _options.each do |key|
+      value = send key
+      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
 
 private
 
-  def build_options
+  def _build_options(options)
     options.each do |key, value|
-      options[key] = DotOptions.new(value, key: key, parent: self) if value.is_a?(Hash)
+      _define_accessor key
+      if value.is_a? Hash
+        value = DotOptions.new value
+        value._full_path = _full_path + [key]
+        value._key = key
+        value._parent = self
+      end
+
+      send :"#{key}=", value
     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
+  def _define_accessor(key)
+    raise NameError, "invalid attribute name `#{key}'" unless key.respond_to?(:to_sym)
 
-    ancestors.join '.'
+    _options.push key.to_sym
+    singleton_class.class_eval do
+      attr_accessor key.to_sym
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dot_options
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-30 00:00:00.000000000 Z
+date: 2024-08-13 00:00:00.000000000 Z
 dependencies: []
 description: Convert any hash to a deep dot-notation object
 email: db@dannyben.com
@@ -45,5 +45,5 @@ requirements: []
 rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
-summary: Options object with dot-notation support
+summary: Options object with dot-notation access
 test_files: []