classprop 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 97ebdc34c9de6444609a82b228cc26cef04e7ca4e0c062d6786b2d919c9ed2f3
+  data.tar.gz: 30ef0193b6f77837fa86a0444c597eb82976b469a8837bbd4b8d43069a05e6ab
+SHA512:
+  metadata.gz: cf4fd42454b349e131394d1c13cf1ef10856106345a07a29e2f0317099990aee672b8bfd1b8d7f6668517c94e6ea536ac5cfd8eeec92964c205a71dbe07c0b0c
+  data.tar.gz: 54c19c2c4ba81023250118f75a1f5d6723ccc8910dc832999a993fc38b895f8db7266aca0bcfee8f1cbea0af4d87a1546dd7d2071bbcb471c9db849a04251f05

data/README.md

@@ -0,0 +1,93 @@
+# ClassProp
+
+ClassProp allows you to set properties of a class which can be inherited or
+overridden by subclasses. For example, in the following code, the `Base` class
+is created and includes `ClassProp`. Then it defines an inheritable property
+called `fco`. Finally, it sets the value of that property to *base*.
+
+```ruby
+class Base
+    include ClassProp
+    define_class_prop 'fco'
+    @fco = 'base'
+end
+```
+
+The `fco` property is now available from `Base`.
+
+```ruby
+puts Base.fco # => 'base'
+```
+
+Another class can inherit from `Base`.
+
+```ruby
+class X1 < Base
+end
+```
+
+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'
+```
+
+`X1` can set its own value for `fco`.
+
+```ruby
+class X1
+    @fco = 'x1'
+end
+```
+
+That gives us this output.
+
+```ruby
+puts X1.fco # => 'x1'
+```
+
+To delete a class property (so that the property is again inherited from the
+superclass) use `delete_class_prop`.
+
+```ruby
+class X1
+    delete_class_prop 'fco'
+end
+
+puts X1.fco # => 'base'
+```
+
+You can set a property so that it must be defined by subclasses. To do so, set
+the property to `ClassProp::MustDefine`. If an inheriting class does not define
+that property then an error is raised when the property is retrieved.
+
+```ruby
+class Base
+    include ClassProp
+    define_class_prop 'fco'
+    @fco = ClassProp::MustDefine
+end
+
+class X1 < Base
+end
+
+X1.fco # raises exception 'must-define-class-class-property: fco'
+```
+
+## Install
+
+```
+gem install classprop
+```
+
+## Author
+
+Mike O'Sullivan
+mike@idocs.com
+
+## History
+
+| version | date         | notes                         |
+|---------|--------------|-------------------------------|
+| 1.0     | Feb 24, 2020 | Initial upload.               |

data/lib/classprop.rb

@@ -0,0 +1,99 @@
+#===============================================================================
+# ClassProp
+#
+module ClassProp
+	# version 1.0
+	VERSION = '1.0'
+	
+	# private
+	private
+	
+	# Adds class methods when module is included.
+	def self.included(base)
+		base.extend ClassMethods
+	end
+	
+	#---------------------------------------------------------------------------
+	# MustDefine
+	#
+	
+	# This module itself does not do anything. If you set a class property to
+	# ClassProp::MustDefine then subclasses must define that property. For
+	# example, the following code raise an exception.
+	#
+	#    class Base
+	#        include ClassProp
+	#        define_class_prop 'fco'
+	#        self.fco = ClassProp::MustDefine
+	#    end
+	#
+	#    class X1 < Base
+	#    end
+	#
+	#    X1.fco # raises exception 'must-define-class-class-property: fco'
+	module MustDefine
+	end
+	
+	#
+	# MustDefine
+	#---------------------------------------------------------------------------
+	
+	
+	#---------------------------------------------------------------------------
+	# ClassMethods
+	#
+	module ClassMethods
+		# Normalizes a property name so that any leading @ is removed.
+		def normalize(prop_name)
+			prop_name = prop_name.to_s
+			prop_name = prop_name.sub(/\A\@/mu, '')
+			return prop_name
+		end
+		
+		# Defines the set and get methods for the given property.
+		def define_class_prop(prop_name)
+			prop_name = normalize(prop_name)
+			
+			# set
+			self.define_singleton_method("#{prop_name}=") do |val|
+				instance_variable_set "@#{prop_name}", val
+			end
+			
+			# get
+			self.define_singleton_method(prop_name) do
+				if instance_variable_defined?("@#{prop_name}")
+					rv = instance_variable_get("@#{prop_name}")
+					
+					if rv == ClassProp::MustDefine
+						raise "must-define-class-class-property: #{prop_name}" 
+					else
+						return rv
+					end
+				else
+					if superclass.respond_to?(prop_name)
+						return superclass.public_send(prop_name)
+					else
+						return nil
+					end
+				end
+			end
+		end
+		
+		# delete_class_prop
+		def delete_class_prop(prop_name)
+			prop_name = normalize(prop_name)
+			
+			if instance_variable_defined?("@#{prop_name}")
+				remove_instance_variable "@#{prop_name}"
+			end
+		end
+		
+		
+	end
+	#
+	# ClassMethods
+	#---------------------------------------------------------------------------
+end
+#
+# ClassProp
+#===============================================================================

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: classprop
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Mike O'Sullivan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-24 00:00:00.000000000 Z
+dependencies: []
+description: Set attributes of a class that can be inherited and overridden
+email: mike@idocs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/classprop.rb
+homepage: https://rubygems.org/gems/classprop
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Inheritable class attributes
+test_files: []