philosophal 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 560c41ed6154b813e0475f754e2e54de3c2fe0a2664983de21bcead6d281bfa8
-  data.tar.gz: 5ae413ecbd701f3a14a8d80210aa2b01a9ab9f53c70dbf577591a1f3178c7a85
+  metadata.gz: 1df7f3c754eeef6776d0e3a18bcfdb81124e413187beb2f580dd550cbdcd046e
+  data.tar.gz: 03ed60c26e12f8225145e6f00a138da84e3d1aa11ffd1ab1be878df0032e6896
 SHA512:
-  metadata.gz: ff0f7ba5322a942f64467fd87db1e801887668f4fe50a701d0c0b6798e82baf00ffa21559ea5404ae356400f88d6f3a1d1d1ce9b7ab78f530f8ea91dacccdd9a
-  data.tar.gz: 15e28d5afe28ee4c674d05f8b663b9dbe59392df42ba82c857e32dab2ff8fefa82c816c9a56afc8c6de1ade6fbbba53c5202551ac1433403a6b0cf6e30a5baf0
+  metadata.gz: ab3fd3bf30dbaba5d2936979b832b2f9a715b7dbab19eba5d08c7feb4e84aa5affd41247b294ffc7ff9a4c054dcaba932ba2cb98d9c8699b5825d1dbad4c0a9b
+  data.tar.gz: 2b372e50b9bcf123531cdc0df806061893e86a3ddc70eddc2cc47731a017cff18dea606aea8c3477c2d8f2adf1faaa051c3728ad8645b166a0c5c120e583f951

data/.rubocop.yml

@@ -6,4 +6,7 @@ require:
 
 AllCops:
   TargetRubyVersion: 3.1
-  NewCops: enable
+  NewCops: enable
+
+Style/Documentation:
+  Enabled: false

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.2.0

data/lib/philosophal/loaders/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philosophal
+  module Loaders
+    class LoadError < StandardError; end
+  end
+end

data/lib/philosophal/loaders/json_loader.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Philosophal
+  module Loaders
+    class JsonLoader
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def load(json)
+        return load_from_hash(json) if json.is_a?(Hash)
+        return load_from_array(json) if json.is_a?(Array)
+
+        raise LoadError, 'invalid json parameter' unless json.is_a?(String)
+
+        first_char = json[0]
+
+        return load_from_json(json) if first_char == '{'
+
+        return load_from_json_collection(json) if first_char == '['
+
+        load_from_path(json)
+      end
+
+      private
+
+      def load_from_array(array)
+        raise LoadError, 'invalid json parameter' if array.find { |hash| !hash.is_a?(Hash) }
+
+        array.map! do |hash|
+          load_from_hash(hash)
+        end
+      end
+
+      def load_from_hash(hash)
+        obj = @klass.new
+
+        hash.each_key do |key|
+          setter = setter_from_key(key)
+          next unless obj.respond_to?(setter)
+
+          obj.public_send(setter, hash.delete(key))
+        end
+
+        obj
+      end
+
+      def setter_from_key(key)
+        real_key = @klass.philosophal_properties.json_names_h[key]
+        property = @klass.philosophal_properties[real_key]
+
+        return :"#{property.name}=" if property
+
+        :"#{key}="
+      end
+
+      def load_from_json(str)
+        hash = JSON.parse(str, symbolize_names: true)
+        load_from_hash(hash)
+      end
+
+      def load_from_json_collection(json)
+        array = JSON.parse(json, symbolize_names: true)
+        load_from_array(array)
+      end
+
+      def load_from_path(path)
+        raise LoadError, "no such file #{path}" unless File.exist?(path)
+
+        str = File.read(path)
+        load_from_json(str)
+      end
+    end
+  end
+end

data/lib/philosophal/loaders.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Philosophal
+  module Loaders
+    autoload :JsonLoader, 'philosophal/loaders/json_loader'
+    autoload :LoadError, 'philosophal/loaders/errors'
+  end
+end

data/lib/philosophal/properties/schema.rb

@@ -29,11 +29,23 @@ module Philosophal
       end
 
       def immutables
-        @properties_index.select { |_, v| v.immutable }
+        return @immutables if defined?(@immutables)
+
+        @immutables = @properties_index.select { |_, v| v.immutable }
       end
 
       def mutables
-        @properties_index.reject { |_, v| v.immutable }
+        return @mutables if defined?(@mutables)
+
+        @mutables = @properties_index.reject { |_, v| v.immutable }
+      end
+
+      def json_names_h
+        return @json_names_h if defined?(@json_names_h)
+
+        @json_names_h = @properties_index.to_h do |key, property|
+          [property.json_name, key]
+        end
       end
     end
   end

data/lib/philosophal/properties.rb

@@ -3,10 +3,11 @@
 module Philosophal
   module Properties
     autoload :Schema, 'philosophal/properties/schema'
+    autoload :JSONLoader, 'philosophal/loaders/json_loader'
 
     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, json: false)
       default.freeze if default && !(default.is_a?(Proc) || default.frozen?)
 
       if transform && !(transform.is_a?(Proc) || transform.is_a?(Symbol))
@@ -17,7 +18,21 @@ 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
+
+      if json
+        unless json.is_a?(TrueClass) || json.is_a?(String) || json.is_a?(Symbol)
+          raise Philosophal::ArgumentError, 'json param must be true or a String or a Symbol.'
+        end
+
+        json = json.to_sym if json.is_a?(String)
+      end
+
+      property = __philosophal_property_class__.new(name:, type:, default:, transform:, immutable:, description:, json:)
 
       philosophal_properties << property
       __define_philosophal_methods__(property)
@@ -34,6 +49,26 @@ 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
+
+    def json
+      return @json if defined?(@json)
+
+      @json = Philosophal::Loaders::JsonLoader.new(self)
+    end
+
     private
 
     def __philosophal_property_class__
@@ -68,12 +103,12 @@ module Philosophal
             end
 
             keys_str = keys_map.map { |k, v| [k, v.inspect].join(': ') }.join(', ')
-            "#{self.class}:#{format('0x00%x', (object_id << 1))} #{keys_str}"
+            "#{self.class}:#{format('0x00%x', object_id << 1)} #{keys_str}"
           end
           alias cprop_inspect philosophal_inspect
 
           def philosophal_inspect_map
-            self.class.philosophal_properties.properties_index.values.to_h do |property|
+            philosophal_values.to_h do |property|
               [
                 property.name,
                 send(property.name)
@@ -81,6 +116,23 @@ module Philosophal
             end
           end
           alias cprop_inspect_map philosophal_inspect_map
+
+          def philosophal_values
+            self.class.philosophal_properties.properties_index.values
+          end
+
+          def to_json_hash
+            philosophal_values.select(&:json).to_h do |property|
+              [
+                property.json_name,
+                send(property.name)
+              ]
+            end
+          end
+
+          def to_json(*_args)
+            to_json_hash.to_json
+          end
         end
       end
     end
@@ -94,8 +146,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,23 @@
 
 module Philosophal
   class Property
-    def initialize(name:, type:, default:, transform:, immutable:)
+    def initialize(name:, type:, default:, transform:, immutable:, description:, json:)
       @name = name
       @type = type
       @default = default
       @transform = transform
       @immutable = immutable
+      @description = description
+      @json = json
     end
 
-    attr_reader :name, :type, :default, :transform, :immutable
+    attr_reader :name, :type, :default, :transform, :immutable, :description, :json
+
+    def json_name
+      return @json if @json.is_a?(Symbol)
+
+      @name
+    end
 
     def default?
       @default != nil
@@ -74,5 +82,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

data/lib/philosophal.rb

@@ -4,6 +4,7 @@ require 'date'
 require 'pathname'
 require 'set'
 require 'time'
+require 'json'
 
 module Philosophal
   autoload :Convertor, 'philosophal/convertor'
@@ -13,6 +14,7 @@ module Philosophal
   autoload :Property, 'philosophal/property'
 
   autoload :Types, 'philosophal/types'
+  autoload :Loaders, 'philosophal/loaders'
 
   autoload :TypeError, 'philosophal/errors/type_error'
   autoload :ArgumentError, 'philosophal/errors/argument_error'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philosophal
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.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-29 00:00:00.000000000 Z
 dependencies: []
 description: Auto convert value on setter method call
 email:
@@ -29,6 +29,9 @@ files:
 - lib/philosophal/convertor.rb
 - lib/philosophal/errors/argument_error.rb
 - lib/philosophal/errors/type_error.rb
+- lib/philosophal/loaders.rb
+- lib/philosophal/loaders/errors.rb
+- lib/philosophal/loaders/json_loader.rb
 - lib/philosophal/properties.rb
 - lib/philosophal/properties/schema.rb
 - lib/philosophal/property.rb
@@ -61,7 +64,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