magic-decorator 0.3.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 673fe3ecf73066b97e1076dfb9a41e7fb31732396e9c39a5f97561d1ec2e616f
-  data.tar.gz: 44c33204523d4022f8b2b1c1eb28dd51f5a3499d5001cdfae97fff59568d89d1
+  metadata.gz: c39be12629f5b9ec85cdd45ab16d09816dbb5ff3ea7f52c56b6dbf237009ec42
+  data.tar.gz: 34244c6e8bea2cc79d9405ecd74093c563bc74af001b041e17caefa41831834e
 SHA512:
-  metadata.gz: 309f3a70d8ce2ae726375e59e152a77d044b7ffe52d8f7064e4baefe964aecc90c4a835dbf3e5474a56e0c7de08e0cb0e975e3e65bc3872a2cc2a18f2a401885
-  data.tar.gz: 595d311692d8db65bb29e0adc44222a48abea98b7b869a62d6b823cb436801be1317cddfc9c4caacf9a6514ec8cc0a1182a1b26c005f9efe2c52fa0d48cca2fc
+  metadata.gz: cd24960b368a753b1137933a06a350dde8f6cb86adcd717cf1d8a064127ddde66d97d1f806ae9d68befa37898b2ad8d557780629412c40886f26ab03aa146176
+  data.tar.gz: e28df69e1bc1d3ad2354db3b20cd89c583ca5f45ea67954c362573eda0140e874c9e1963b7b9126a72d3764096fbbfe0d3d41ad1376cdb41c02d1bcf84c25630

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## [1.0.1] — 2025-05-13
+
+### Fixed
+
+- `Magic::Decoratable.classes` shouldn’t include singleton ones.
+
+
+## [1.0.0] — 2024-11-23
+
+This release marks the gem to be stable enough.
+
+> [!NOTE]
+> Nothing notable was changed in the code since the last version.
+
+### Documentation
+
+- Added a section about overriding the defaults.
+- Added a section about testing.
+
+
 ## [0.3.0] — 2024-10-27
 
 ### Added

data/README.md

@@ -165,6 +165,51 @@ It automagically decorates all its decoratable items.
 - enables _double-splat_ operator: `**decorated`,
 - enumerating methods yield decorated items.
 
+## Overriding the magic
+
+When one needs more complicated behavior than the default one or feels like [_explicit is better than implicit_](
+	https://peps.python.org/pep-0020/#the-zen-of-python
+).
+
+### Decorator class inference
+
+One may override `#decorator` for any decoratable class, to be used instead of Magic Lookup.
+
+- That could be as straightforward as a constant:
+
+	```ruby
+	class Guest
+	  private
+	
+	  def decorator = UserDecorator
+	end
+	
+	guest.decorate # => instance of UserDecorator
+	```
+
+- Or, that could be virtually any logic:
+
+	```ruby
+	class User
+	  private
+	
+	  def decorator = admin? ? AdminDecorator : super
+	end
+	
+	user.decorate  # => instance of UserDecorator
+	admin.decorate # => instance of AdminDecorator
+	```
+
+## Testing decorators
+
+Testing a decorator is much like testing any other class.
+
+To test whether an object is decorated one can use `#decorated?` method.
+
+> [!NOTE]
+> A decorated object equals the original one (`object.decorated == object`).
+> Thus, any existing tests shouldn’t break when the objects being tested get decorated.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/magic/decoratable.rb

@@ -10,6 +10,7 @@ module Magic
 			def classes
 				ObjectSpace.each_object(Class)
 						.select { _1 < self }
+						.reject(&:singleton_class?)
 			end
 		end
 

data/lib/magic/decorator/base.rb

@@ -34,6 +34,8 @@ module Magic
 					deconstruct_keys
 			]
 
+			private
+
 			def method_missing(method, ...)
 				return super if method.start_with? 'to_' # converter
 				return super if method.start_with? '_'   # system

data/lib/magic/decorator/version.rb

@@ -2,6 +2,6 @@
 
 module Magic
 	module Decorator
-		VERSION = '0.3.0'
+		VERSION = '1.0.1'
 	end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: magic-decorator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Alexander Senko
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2025-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: magic-lookup
@@ -69,7 +69,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/Alexander-Senko/magic-decorator
   source_code_uri: https://github.com/Alexander-Senko/magic-decorator
-  changelog_uri: https://github.com/Alexander-Senko/magic-decorator/blob/v0.3.0/CHANGELOG.md
+  changelog_uri: https://github.com/Alexander-Senko/magic-decorator/blob/v1.0.1/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -84,7 +84,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Decorators with some internal magic
 test_files: []