philosophal 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 560c41ed6154b813e0475f754e2e54de3c2fe0a2664983de21bcead6d281bfa8
-  data.tar.gz: 5ae413ecbd701f3a14a8d80210aa2b01a9ab9f53c70dbf577591a1f3178c7a85
+  metadata.gz: d09ac65f9fd7fa000c82fa1d9e77c85e22866d2a9a1ffdfa1a63e19b36cb909b
+  data.tar.gz: bdf93344392beabea229e214b1403e88749fd51839e68c9e675fb9566fad5e52
 SHA512:
-  metadata.gz: ff0f7ba5322a942f64467fd87db1e801887668f4fe50a701d0c0b6798e82baf00ffa21559ea5404ae356400f88d6f3a1d1d1ce9b7ab78f530f8ea91dacccdd9a
-  data.tar.gz: 15e28d5afe28ee4c674d05f8b663b9dbe59392df42ba82c857e32dab2ff8fefa82c816c9a56afc8c6de1ade6fbbba53c5202551ac1433403a6b0cf6e30a5baf0
+  metadata.gz: f729b3f0a820e25d39e9de2eecd47cc7cd7bc12fa32cdc6306c81b02418f98507a3d814582f638822834dc3f9cae055b00db909a3cc66c3112c7ccb8118aaf90
+  data.tar.gz: a1ab12ea326c278c6d7eab6b555605642f0ce34d30d27782efe4a6991cbd3fc3b63917cbef00a8b21133b47e096056b2ba34234b40017239d556880960fa67f0

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.1.7

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.1.7

data/README.md

@@ -22,9 +22,9 @@ class Person
 end
 
 maxime = Person.new
-maxime.first_name = "Maxime"
-maxime.last_name = "Désécot"
-maxime.age = "40" 
+maxime.first_name = 'Maxime'
+maxime.last_name = 'Désécot'
+maxime.age = '40'
 puts maxime.inspect
 #<Person:0x00007da7088eed88 @first_name="maxime", @last_name="DÉSÉCOT", @age=40>
 ````

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.1.0

data/lib/philosophal/properties.rb

@@ -6,7 +6,7 @@ module Philosophal
 
     include Philosophal::Types
 
-    def cprop(name, type, default: nil, transform: nil, immutable: false)
+    def cprop(name, type, default: nil, transform: nil, immutable: false, description: nil)
       default.freeze if default && !(default.is_a?(Proc) || default.frozen?)
 
       if transform && !(transform.is_a?(Proc) || transform.is_a?(Symbol))
@@ -17,7 +17,13 @@ module Philosophal
         raise Philosophal::ArgumentError, 'immutable param must be true or false.'
       end
 
-      property = __philosophal_property_class__.new(name:, type:, default:, transform:, immutable:)
+      if description
+        raise Philosophal::ArgumentError, 'description param must be a string.' unless description.is_a?(String)
+
+        description.freeze unless description.frozen?
+      end
+
+      property = __philosophal_property_class__.new(name:, type:, default:, transform:, immutable:, description:)
 
       philosophal_properties << property
       __define_philosophal_methods__(property)
@@ -34,6 +40,18 @@ module Philosophal
                                 end
     end
 
+    def philosophal_descriptions
+      return @philosophal_descriptions if defined?(@philosophal_descriptions)
+
+      @philosophal_descriptions = philosophal_properties.properties_index.values.select(&:description).to_h do |property|
+        [
+          property.name,
+          property.description
+        ]
+      end
+    end
+    alias cprop_descriptions philosophal_descriptions
+
     private
 
     def __philosophal_property_class__
@@ -94,8 +112,11 @@ module Philosophal
       end
 
       new_property.generate_reader_method(buffer)
+
       new_property.generate_boolean_method(buffer) if new_property.type == Philosophal::Types::BooleanType::Instance
 
+      new_property.generate_description_method(buffer) if new_property.description
+
       # puts buffer
 
       buffer

data/lib/philosophal/property.rb

@@ -2,15 +2,16 @@
 
 module Philosophal
   class Property
-    def initialize(name:, type:, default:, transform:, immutable:)
+    def initialize(name:, type:, default:, transform:, immutable:, description:)
       @name = name
       @type = type
       @default = default
       @transform = transform
       @immutable = immutable
+      @description = description
     end
 
-    attr_reader :name, :type, :default, :transform, :immutable
+    attr_reader :name, :type, :default, :transform, :immutable, :description
 
     def default?
       @default != nil
@@ -74,5 +75,14 @@ module Philosophal
         '!!@' << @name.name <<
         "\nend\n"
     end
+
+    def generate_description_method(buffer = +'')
+      buffer <<
+        ' def ' <<
+        @name.name <<
+        "_description\n  " \
+        '%(' << @description << ')' \
+        "\nend\n"
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philosophal
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Maxime Désécot
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-23 00:00:00.000000000 Z
+date: 2026-06-26 00:00:00.000000000 Z
 dependencies: []
 description: Auto convert value on setter method call
 email:
@@ -61,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: Philosophal setter convertor