magic-decorator 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 673fe3ecf73066b97e1076dfb9a41e7fb31732396e9c39a5f97561d1ec2e616f
-  data.tar.gz: 44c33204523d4022f8b2b1c1eb28dd51f5a3499d5001cdfae97fff59568d89d1
+  metadata.gz: 84b46e61d09d011e36bfd527b1e99bf9b83a7d3d4844f9afcd11304abd5c7990
+  data.tar.gz: 22f50120c5b4b8b2887d28b3e909f698128c04a37293c9409d93411dddb1f2e3
 SHA512:
-  metadata.gz: 309f3a70d8ce2ae726375e59e152a77d044b7ffe52d8f7064e4baefe964aecc90c4a835dbf3e5474a56e0c7de08e0cb0e975e3e65bc3872a2cc2a18f2a401885
-  data.tar.gz: 595d311692d8db65bb29e0adc44222a48abea98b7b869a62d6b823cb436801be1317cddfc9c4caacf9a6514ec8cc0a1182a1b26c005f9efe2c52fa0d48cca2fc
+  metadata.gz: 0ad5fc1e9e7cf8fab9a75a792cc31f027e113e95f7968ee2f6502b113c4f8f943bf7f111fa599929896e6bf7a3a77cf7cf13d46c6fe58dd52e770fc109278d42
+  data.tar.gz: 743f50f6835be84d59028240ec9c306df79f8647c90d4b4c34d39eb9e462741cbfc3f0ebde4bea447c0a94b731e61a8e370c497d84821bfe9dfa4272771f3d8b

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [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/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.0'
 	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.0
 platform: ruby
 authors:
 - Alexander Senko
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 2024-11-23 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.0/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib