property_string 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1599cc1dcb3a805c49f5d128df2d3c0a2a1d6de8d8f1348dba0e75a39d28827a
-  data.tar.gz: 4d62dcd17afbb2463114cb26a676b56ac25ea3f8da4adfdda0fadcdc5b7d48fb
+  metadata.gz: 51ee8a1498b474f470fe167dd6e522edc6027fd09bfa036322c9ac6cd3de233c
+  data.tar.gz: 6ab9cd09fa918b1fd2b383c52e04b41f9677db59beee66081077d45040834637
 SHA512:
-  metadata.gz: 06d7eb0788c96fcd4a63d06f423b17568c1237f7070ffa19834cf4cde5036824d01da0cf5205dde497fb3e7f4bb5c75bd79bb5a92eb1cfadecbe69db32de82da
-  data.tar.gz: ab9f57a4adc63d312fc1acd376617e35ff170732174277ce85624a8563757202d600670a684cffe35d71e785500b662b9230135bfd71c4e89c0ab194080fa646
+  metadata.gz: 1993da29de7e214db0be4de670f298e2effe63be7ecb610b5f7d8aa3dcf97ec3a3b639cfac54a65be50bda16dfbdb7705fb6d22af5df93974381c021cd5ecdb3
+  data.tar.gz: 9f8ca4eb9d4fcc5765dc29c53f6ac7f10064c9fe5d5d9f7b782d19b8a4f5da856d8940fc2e492dcc53a61d2d8b61e2889da8367d8c11850c679f00bd8d9d3c09

data/README.md

@@ -36,24 +36,37 @@ ps["company.does_not_exist!"] # NoMethodError
 # Can work with a Hash
 h.dig(:some, "nested", :hash)   # foo
 
-ph = PropertyString(h)
-ph["some.nested.hash"]
+ps = PropertyString(h)
+ps["some.nested.hash"]
 
 # Or an Array
 a[0][0][0]
 
-ph = PropertyString(a)
-ph["0.0.0"]
+ps = PropertyString(a)
+ps["0.0.0"]
 
-# Ignore MethodMissing errors for unknown properties
+# Fetching
+ps.fetch("posts.9999", "your default")
+ps.fetch("posts.9999") { |key| "some_default_for_#{key}" }
+```
+
+### Ignore `NoMethodError` for Unknown Properties
+
+```rb
 ps = PropertyString.new(product, :raise_if_method_missing => false)
 ps["company.does_not_exist!"] # nil
+```
 
-# Fetching
-ps.fetch("posts.9999", "your default") # shaw
-ps.fetch("posts.9999") { |key| "some_default_for_#{key}" }
+### Restrict Methods That Can Be Called
+
+```rb
+ps = PropertyString.new(product, :whitelist => { Product => %w[company], Company => %w[name] })
+ps["id"] # PropertyString::MethodNotAllowed
+ps["company.id"] # PropertyString::MethodNotAllowed
 ```
 
+Currently does not work when a superclass is whitelisted but trivial to add.
+
 ## See Also
 
 - [PropertyHash](https://github.com/sshaw/property_hash) - Access a nested Ruby Hash using Java-style properties as keys.

data/lib/property_string.rb

@@ -1,14 +1,22 @@
 # frozen_string_literal: true
 
 class PropertyString
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
   KEY_NOT_FOUND = "__#{object_id}-not-found-placeholder-#{object_id}__"
 
+  class MethodNotAllowed < StandardError
+    def initialize(object, method)
+      target = object.is_a?(Class) ? "#{object}.#{method}" : "#{object.class}##{method}"
+      super "Access to #{target} is not allowed"
+    end
+  end
+
   def initialize(object, options = nil)
     @object = object
 
     @options = (options || {}).dup
     @options[:raise_if_method_missing] = true unless @options.include?(:raise_if_method_missing)
+    @options[:whitelist] = @options[:whitelist] || {}
   end
 
   def [](property)
@@ -57,8 +65,12 @@ class PropertyString
   def find_non_index_value(value, prop)
     if value.is_a?(Hash)
       value = find_hash_value(value, prop)
-      value == KEY_NOT_FOUND ? nil : value
-    elsif @options[:raise_if_method_missing]
+      return value == KEY_NOT_FOUND ? nil : value
+    end
+
+    raise_if_method_not_allowed(value, prop)
+
+    if @options[:raise_if_method_missing]
       value.public_send(prop)
     elsif value.respond_to?(prop)
       value.public_send(prop)
@@ -94,4 +106,13 @@ class PropertyString
 
     KEY_NOT_FOUND
   end
+
+  def raise_if_method_not_allowed(value, prop)
+    klass = value.is_a?(Class) ? value : value.class
+    # Make sure we do not raise this if the object does not respond_to? prop
+    # TODO: class hierarchy
+    if @options[:whitelist].include?(klass) && !@options[:whitelist][klass].include?(prop) && value.respond_to?(prop)
+      raise MethodNotAllowed.new(value, prop)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: property_string
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - sshaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-04 00:00:00.000000000 Z
+date: 2024-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler