classprop 1.3 → 1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49f81f6217d7baf2cc2b6ba28f2582d4629d9d5908202cd81a45c50389bb6e1c
-  data.tar.gz: 6e2d0a8268b7855097494f0fbef6f034bf329a57232fcdd9162b49de19d5b5f1
+  metadata.gz: 66c01968cae6780a152ab327e772168e8e7cab31b06257d888da56668c6a757e
+  data.tar.gz: dc4fb6f077418bf7d80c526ff5fbdbb11c75e8cd5c5b0fc0c2966fb406528901
 SHA512:
-  metadata.gz: 2512ef8e519934c69754b52ae963fe47776bed2c60ff57038c3db8025015c9362cd7304b82a403b53fc6fd88a25f12cf3a4160f62a2bec96a0ef2de8cafa79a1
-  data.tar.gz: 0bb016fe201c86dd457b84ef446df6eead64057c7de4124ed8fae96ba5d0bb2a0ca22e603ad9ce840277e6e5b98a2a9e26247781e0e2073c8f5e5723357d6c7a
+  metadata.gz: 82dc692237e50f5ed7bf52a08672b1ddd4b70f8aeb40ec2d966583c26dcbcf8bfc39e92d9acf1a4db44be1fa8a87824efcf38f8112f1fdee9b1107920b85e8d6
+  data.tar.gz: c7742d1933eae5d9bda92dde3dfc872e4832183c80b0058c92d2a92927f87c1a376b672065ef7c9f174d7dca687c51a7857dd9afa47f8faab54ccc59562ce1c2

data/README.md

@@ -8,15 +8,15 @@ called `fco`. Finally, it sets the value of that property to *base*.
 ```ruby
 class Base
     include ClassProp
-    define_class_prop 'fco'
-    self.fco = 'base'
+    define_class_prop 'independent'
+    self.independent = 'base'
 end
 ```
 
 The `fco` property is now available from `Base`.
 
 ```ruby
-puts Base.fco # => 'base'
+puts Base.independent # => 'base'
 ```
 
 Another class can inherit from `Base`.
@@ -30,21 +30,21 @@ If `X1` does not define its own `fco` property, then when that property is
 retrieved from `X1` it returns `Base.fco`.
 
 ```ruby
-puts X1.fco # => 'base'
+puts X1.independent # => 'base'
 ```
 
 `X1` can set its own value for `fco`.
 
 ```ruby
 class X1
-    self.fco = 'x1'
+    self.independent = 'x1'
 end
 ```
 
 That gives us this output.
 
 ```ruby
-puts X1.fco # => 'x1'
+puts X1.independent # => 'x1'
 ```
 
 To delete a class property (so that the property is again inherited from the
@@ -52,10 +52,10 @@ superclass) use `delete_class_prop`.
 
 ```ruby
 class X1
-    delete_class_prop 'fco'
+    delete_class_prop 'independent'
 end
 
-puts X1.fco # => 'base'
+puts X1.independent # => 'base'
 ```
 
 You can set a property so that it must be defined by subclasses. To do so, set
@@ -65,16 +65,36 @@ that property then an error is raised when the property is retrieved.
 ```ruby
 class Base
     include ClassProp
-    define_class_prop 'fco'
-    self.fco = ClassProp::MustDefine
+    define_class_prop 'independent'
+    self.independent = ClassProp::MustDefine
 end
 
 class X1 < Base
 end
 
-X1.fco # raises exception 'must-define-class-property: fco'
+X1.independent # raises exception 'must-define-class-property: independent'
 ```
 
+If you want to normalize or check a property, use the `before_set` option.
+
+```ruby
+class Base
+    include ClassProp
+    
+    # upper
+    define_class_prop(
+        'upper',
+        'before_set' => proc do |val|
+            val.to_s.upcase
+        end
+    );
+end
+
+Base.upper = 'whatever'
+puts Base.upper #=> WHATEVER
+```
+
+
 ## Install
 
 ```
@@ -93,4 +113,5 @@ mike@idocs.com
 | 1.0     | Feb 24, 2020 | Initial upload.                                       |
 | 1.1     | Feb 24, 2020 | Reworked interface.                                   |
 | 1.2     | Feb 24, 2020 | Fixed minor problem with exception id.                |
-| 1.3     | Feb 26, 2020 | Added options to define_class_prop: init and inherit. |
+| 1.3     | Feb 26, 2020 | Added options to define_class_prop: init and inherit. |
+| 1.3     | Mar 13, 2020 | Added option to define_class_prop: before_set.        |

data/lib/classprop.rb

@@ -3,7 +3,7 @@
 #
 module ClassProp
 	# version
-	VERSION = '1.3'
+	VERSION = '1.4'
 	
 	# private
 	private
@@ -23,14 +23,14 @@ module ClassProp
 	#
 	#    class Base
 	#        include ClassProp
-	#        define_class_prop 'fco'
-	#        self.fco = ClassProp::MustDefine
+	#        define_class_prop 'independent'
+	#        self.independent = ClassProp::MustDefine
 	#    end
 	#
 	#    class X1 < Base
 	#    end
 	#
-	#    X1.fco # raises exception 'must-define-class-property: fco'
+	#    X1.independent # raises exception 'must-define-class-property: independent'
 	module MustDefine
 	end
 	
@@ -50,12 +50,29 @@ module ClassProp
 		#
 		# option: inherit
 		# If set to false, the property is not inherited by subclasses.
+		#
+		# option: before_set
+		# If set, must be a Proc. The proc is called and val is set to the
+		# proc's return value.
 		def define_class_prop(prop_name, opts={})
 			# default options
 			opts = {'inherit'=>true}.merge(opts)
 			
+			# TESTING
+			# $tm.show opts
+			
 			# set
 			self.define_singleton_method("#{prop_name}=") do |val|
+				# run before_set if necessary
+				if before_set = opts['before_set']
+					if not before_set.is_a?(Proc)
+						raise 'before-set-not-proc'
+					end
+					
+					val = opts['before_set'].call(val)
+				end
+				
+				# set property
 				instance_variable_set "@#{prop_name}", val
 			end
 			
@@ -97,4 +114,4 @@ module ClassProp
 end
 #
 # ClassProp
-#===============================================================================
+#===============================================================================

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classprop
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: '1.4'
 platform: ruby
 authors:
 - Mike O'Sullivan