lazy_init 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c64fcdc54aff938649a72d27f052323186594ae0811c797af886a8f50592c885
-  data.tar.gz: 0d63513a82a948a865275cd22de4baaaaa33c594fed332f8398fd5f05a856e41
+  metadata.gz: 4c3c12be25d5a45b0b5d70589b47c4335e8e610b809ee80647e0230c7778c6a5
+  data.tar.gz: 50dcdd14ca0228e4c202cd886cb17c622c2b677e0cb041f8f39f36eb14bc08cb
 SHA512:
-  metadata.gz: 8c2db87b2eb8bfb3c30ef12be6c2967a7172f2de3e74818271d44767f0484bf68c493aab388aa84963bd14703a6a606a9e761fdd4831d55472e2ffae575c0401
-  data.tar.gz: 456a5e3b90199ef2687ec2b27ceee6eee751a3d311c365ed5e8b1e5aca786c00b1f9199ece268a8d0368a82e02f11bc17a6035421b19528e8c0810386022751b
+  metadata.gz: e7cfa817d7c404168dd8237410edd85453d71334b16b31dba4d63b2fecf5374080595c4db983798bddca2883704b8dc07639a861d8113fff4f7a24875bfb5340
+  data.tar.gz: 4c8ff04962ac7b59f6ecb9749faa6993814749fa9d146fc2eb482ffb9059ab03facc84430ceef04c07afc3484c5c041e833b8429a0ab523c6c352eef86659148

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--readme README.md
+--title "LazyInit - Thread-safe Lazy Initialization"
+--output-dir doc
+lib/**/*.rb
+- CHANGELOG.md
+- LICENSE

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+
+
+### 0.1.1 (2025/06/07)
+
+* Added YARD configuration for automatic documentation generation
+* Enhanced code comments for better API documentation
+
+### 0.1.0 (2025/06/07)
+
+* Initial public release

data/README.md

@@ -4,7 +4,7 @@ Thread-safe lazy initialization patterns for Ruby with automatic dependency reso
 
 [![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.6-red.svg)](https://www.ruby-lang.org/)
 [![Gem Version](https://badge.fury.io/rb/lazy_init.svg)](https://badge.fury.io/rb/lazy_init)
-[![Build Status](https://github.com/N3BCKN/lazy_init/workflows/CI/badge.svg)](https://github.com/N3BCKN/lazy_init/actions)
+[![Downloads](https://img.shields.io/gem/dt/lazy_init.svg)](https://rubygems.org/gems/lazy_init)
 
 ## Table of Contents
 
@@ -164,20 +164,20 @@ lazy_attr_reader(name, **options, &block)
 Defines a thread-safe lazy-initialized attribute.
 #### Parameters:
 
-- name (Symbol/String): Attribute name
-- timeout (Numeric, optional): Timeout in seconds for computation
-- depends_on (Array<Symbol>/Symbol, optional): Dependencies to resolve first
-- block (Proc): Computation block
+- `name` (Symbol/String): Attribute name
+- `timeout` (Numeric, optional): Timeout in seconds for computation
+- `depends_on` (Array<Symbol>/Symbol, optional): Dependencies to resolve first
+- `block` (Proc): Computation block
 
 #### Generated Methods:
 
-- #{name}: Returns the computed value
-- #{name}_computed?: Returns true if value has been computed
-- reset_#{name}!: Resets to uncomputed state
+- `#{name}`: Returns computed value
+- `#{name}_computed?`: Returns true if value has been computed
+- `reset_#{name}!`: Resets to uncomputed state
 
 #### Examples:
 ```ruby
-rubyclass ServiceManager
+class ServiceManager
   extend LazyInit
   
   # Simple lazy attribute
@@ -210,12 +210,12 @@ lazy_class_variable(name, **options, &block)
 Defines a thread-safe lazy-initialized class variable shared across all instances.
 #### Parameters:
 
- - Same as lazy_attr_reader
+ - Same as `lazy_attr_reader`
 
 #### Generated Methods:
 
-- Class-level: ClassName.#{name}, ClassName.#{name}\_computed?, ClassName.reset\_#{name}!
-- Instance-level: #{name}, #{name}\_computed?, reset\_#{name}! (delegates to class)
+- Class-level: `ClassName.#{name}`, `ClassName.#{name}\_computed?`, `ClassName.reset\_#{name}!`
+- Instance-level: `#{name}`, `#{name}\_computed?`, `reset\_#{name}!` (delegates to class)
 
 #### Example:
 ```ruby
@@ -244,7 +244,7 @@ class DataProcessor
   include LazyInit  # Note: include, not extend
 end
 ```
-**lazy(&block)**
+`lazy(&block)`
 
  Creates a standalone lazy value container.
 ```ruby
@@ -255,13 +255,13 @@ end
 ```
 
 
-__lazy_once(**options, &block)__
+`lazy_once(**options, &block)`
 
  Method-scoped lazy initialization with automatic cache key generation.
 #### Parameters:
 
-- max_entries (Integer): Maximum cache entries before LRU eviction
-- ttl (Numeric): Time-to-live in seconds for cache entries
+- `max_entries` (Integer): Maximum cache entries before LRU eviction
+- `ttl` (Numeric): Time-to-live in seconds for cache entries
 
 #### Example:
 ``` ruby
@@ -276,11 +276,11 @@ class DataAnalyzer
 end
 ```
 
-**clear_lazy_once_values!**
+`clear_lazy_once_values!`
 
 Clears all cached lazy_once values for the instance.
 
-**lazy_once_statistics**
+`lazy_once_statistics`
 
 Returns cache statistics for debugging and monitoring.
 
@@ -308,15 +308,15 @@ end
 
 #### Configuration Options:
 
-- **default_timeout**: Default timeout for all lazy attributes (default: nil)
-- **max_lazy_once_entries**: Maximum entries in lazy_once cache (default: 1000)
-- **lazy_once_ttl**: Default TTL for lazy_once entries (default: nil)
+- `default_timeout`: Default timeout for all lazy attributes (default: nil)
+- `max_lazy_once_entries`: Maximum entries in lazy_once cache (default: 1000)
+- `lazy_once_ttl`: Default TTL for lazy_once entries (default: nil)
 
 ## Advanced Usage
 ### Dependency Resolution
 #### LazyInit automatically resolves dependencies in the correct order:
 ```ruby
-rubyclass ComplexService
+class ComplexService
   extend LazyInit
   
   lazy_attr_reader :config do
@@ -534,7 +534,7 @@ Realistic benchmark results (x86_64-darwin19, Ruby 3.0.2):
 - Initial computation: ~identical (LazyInit setup overhead negligible)
 - Cached access: 3.5x slower than manual ||= 
 -100,000 calls: Manual 13ms, LazyInit 45ms
-- In practice: For expensive operations (5-50ms), the 0.0004ms per call overhead is negligible.
+- In practice: For expensive operations (5-50ms), 0.0004ms per call overhead is negligible.
 - Trade-off: 3.5x cached access cost for 100% thread safety
 
 [Full details can be found here](https://github.com/N3BCKN/lazy_init/blob/main/benchmarks/benchmark_performance.rb)
@@ -735,7 +735,7 @@ A: Minimal - about 1 mutex + 3 instance variables per lazy attribute.
 
 Q: Can I use lazy_attr_reader with private methods?
 
-A: Yes, the generated methods respect the same visibility as where they're defined.
+A: Yes, generated methods respect the same visibility as where they're defined.
 
 Q: How do I debug dependency resolution issues?
 
@@ -746,7 +746,7 @@ Q: Does this work with inheritance?
 A: Yes, lazy attributes are inherited and can be overridden in subclasses.
 ## Contributing
 
-1. Fork the repository
+1. Fork repository
 2. Create your feature branch (git checkout -b my-new-feature)
 3. Write tests for your changes
 4. Ensure all tests pass (bundle exec rspec)
@@ -762,4 +762,4 @@ bundle install
 bundle exec rspec  # Run tests
 ```
 ## License
-The gem is available as open source under the terms of the MIT License.
+Gem is available as open source under the terms of the MIT License.

data/lib/lazy_init/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LazyInit
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lazy_init
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Konstanty Koszewski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-05 00:00:00.000000000 Z
+date: 2025-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -90,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - GEMFILE
 - LICENSE