prop_initializer 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29c51456a07fe5ba7a95870bb2cb7e1a1b586b845c0a74878d3b273bee8dbaae
-  data.tar.gz: a670f466ba0374a53a2f642de194317713a92ea1b081e777f509f354d56a5a67
+  metadata.gz: 9bb678c9eefc27ee47a5f0720957f52e56c5c9931211f063990104e8a9d65b64
+  data.tar.gz: 6ce3741dc658fd661150f61e5578ac21a8a1cb00bf8f4991b0854a2e758b08ce
 SHA512:
-  metadata.gz: d99b4d83625d31aa5c900fc54f3f9251cc7ec389ee11d16bc9d770e736816fc1f549876727500f1a68a53a1e12346ca6637db592457dbd8857ea126f9a45da77
-  data.tar.gz: f68cf05fcc1701e3ca85088b9e41f88622eaf071b20f93d949027899e768aeba05151a364d5e9455472c5e1410c2e93d2429c7060792f5147f424d2b3b213357
+  metadata.gz: abc4edeb2dadfc4e69da6b82ffc648ab9b6ba6c4cd8587ce6f858f94d1ec05293939f059601f9fdb0431de625028b5ba2cf6ff6c212e6e8f095125de05bfbc44
+  data.tar.gz: 90bc565b97a72682d1e896c7b9e51b5f84d3d8a039272baa325181aef16bdda78b45112d71c1dd10bd8a8b4903d217f8b13ecc04e43641c0f5edb7a20bb179c4

data/README.md

@@ -1,28 +1,133 @@
-# PropInitializer
-Short description and motivation.
+# Prop Initializer
 
-## Usage
-How to use my plugin.
+## Overview
+
+The `prop_initializer` gem is a flexible tool for defining properties on Ruby classes.
+
+It's a fork of the [Literal Gem](https://github.com/joeldrapper/literal), with a few tweaks. We sincerely thank [Joel Drapper](https://github.com/joeldrapper) for the inspiration and base code that made this possible.
+
+With `prop_initializer`, you can easily declare properties for any class, giving you flexible options for default values and more. However, the scope is narrowed down by removing strict typing requirements, providing a more lightweight and adaptable interface.
 
 ## Installation
-Add this line to your application's Gemfile:
+
+To use `prop_initializer ` in your Ruby project, add the following to your Gemfile:
 
 ```ruby
 gem "prop_initializer"
 ```
 
-And then execute:
+Then, run the bundle command to install it:
+
 ```bash
-$ bundle
+bundle install
 ```
 
-Or install it yourself as:
-```bash
-$ gem install prop_initializer
+## Usage
+
+To start using `prop_initializer `, you need to include the module in the class where you want to define properties.
+
+### Step 1: Extend the Properties Module
+
+In any class, extend `PropInitializer::Properties` to enable the ability to define properties:
+
+```ruby
+class MyClass
+  extend PropInitializer::Properties
+end
+```
+
+### Step 2: Define Properties
+
+Properties can be declared using the `prop` method, which generates writers and makes them available as instance variables (e.g., `@name`, `@size`, etc.).
+
+#### Basic Syntax:
+
+```ruby
+prop :name                # A simple property, accessible via @name
+prop :size, default: :md  # A property with a default value of :md
+prop :args, kind: :*      # A property for handling splat arguments
+prop :kwargs, kind: :**   # A property for handling keyword arguments
+```
+
+#### Custom Property with Block:
+
+You can define a custom processing block when declaring a property, for example:
+
+```ruby
+prop :icon do |value|
+  value&.to_sym       # Converts the property value to a symbol
+end
+```
+
+### Step 3: Accessing Properties
+
+By default, `PropInitializer` generates a writer for each declared property. The properties are stored as instance variables, which can be accessed within the class:
+
+```ruby
+@name    # Accesses the value of the 'name' property
+@size    # Accesses the value of the 'size' property
+```
+
+#### Public Reader:
+
+If you want to generate a public reader (getter) for a property, use the `reader: :public` option when defining the property:
+
+```ruby
+prop :title, reader: :public
 ```
 
-## Contributing
-Contribution directions go here.
+This will automatically generate a public getter method, allowing you to retrieve the property like so:
+
+```ruby
+my_class_instance.title  # Public getter for the 'title' property
+```
+
+### Example:
+
+```ruby
+class MyComponent
+  extend PropInitializer::Properties
+
+  prop :name, reader: :public
+  prop :size, default: :md, reader: :public
+  prop :args, kind: :*
+  prop :kwargs, kind: :**
+  prop :icon do |value|
+    value&.to_sym
+  end
+end
+
+component = MyComponent.new(name: "Button", size: :lg)
+component.name # => "Button"
+component.size # => :lg
+```
+
+## Key Differences from [Literal](https://github.com/joeldrapper/literal)
+
+While `prop_initializer` is based on the [Literal Gem](https://github.com/joeldrapper/literal), there are some important differences:
+
+- **No Type Requirement:** [Literal](https://github.com/joeldrapper/literal)'s properties system enforces types, while `prop_initializer` omits them for flexibility. You can define properties without needing to specify a type.
+  
+- **Simplified Initializer:** The initialization process has been modified to avoid requiring types at the time of property definition.
+
+## Acknowledgements
+
+Special thanks to the team at [Literal](https://github.com/joeldrapper/literal) for their pioneering work on property-based object initialization. This gem builds upon the foundation laid by their work.
+
+If you're looking for a more type-strict approach to property initialization, we encourage you to check out the original [Literal Gem](https://github.com/joeldrapper/literal).
+
+Thank you for using `prop_initializer`! We hope this tool helps make your property management more efficient and adaptable in your Ruby projects.
+
+## Open Source
+
+ - [`active_storage-blurhash`](https://github.com/avo-hq/active_storage-blurhash) - A plug-n-play [blurhash](https://blurha.sh/) integration for images stored in ActiveStorage
+ - [`avo`](https://github.com/avo-hq/avo) - Build Content management systems with Ruby on Rails
+ - [`class_variants`](https://github.com/avo-hq/class_variants) - Easily configure styles and apply them as classes. Very useful when you're implementing Tailwind CSS components and call them with different states.
+ - [`stimulus-confetti`](https://github.com/avo-hq/stimulus-confetti) - The easiest way to add confetti to your StimulusJS app
+
+## Try Avo ⭐️
+
+If you enjoyed this gem try out [Avo](https://github.com/avo-hq/avo). It helps developers build Internal Tools, Admin Panels, CMSes, CRMs, and any other type of Business Apps 10x faster on top of Ruby on Rails.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/prop_initializer/properties.rb

@@ -44,7 +44,7 @@ module PropInitializer::Properties
   def prop_initializer_properties
     return @prop_initializer_properties if defined?(@prop_initializer_properties)
 
-    if superclass.is_a?(PropInitializer)
+    if superclass.is_a?(PropInitializer::Properties)
       @prop_initializer_properties = superclass.prop_initializer_properties.dup
     else
       @prop_initializer_properties = PropInitializer::Properties::Schema.new

data/lib/prop_initializer/version.rb

@@ -1,3 +1,3 @@
 module PropInitializer
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prop_initializer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Bob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-10 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk