annotable 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c994186b8487d47a54dd1379d33e54e25f53117458c33317119bb2c9e57e9b2
-  data.tar.gz: 32b4e9043b9162ceb1710283998e802baf8d977e711a084a7215d096713ab6ac
+  metadata.gz: 400e3451d726f63e94de8f930e030ad5d59ea7d331ad1676a5877e17190a5074
+  data.tar.gz: 20a5d99733b9d0a0a22d5891fc6741de340f67ea9ce2ab152cfbbcd7d4e7fe14
 SHA512:
-  metadata.gz: e0299fc20ed9c02ac517ca7be9e7ec6aa0170bdb8690c8bd1437c3b8e13d7bbd3ecf2dd3c16b2dedd5a2444f31724358c7a506a5c3b5e189f85fb1b0bfb51902
-  data.tar.gz: da8f86804d96c76055a369e83032c3fbad2891a325bcf9b1274a05e634d9ed26445fd25e3e58d5e749d672e4f6bd9f7a92d15b9d372c93b0e0394a45086e569c
+  metadata.gz: e447fc5c32676723bc2f8c1da58770266ac801ffb8065f9a03e15aa32fe5ed45d961c54335e5abad8541247cbec6904f335c0ee7c942edd8489bc9d98e322ae6
+  data.tar.gz: 7f6cc87158f6e3fc9a0cf09557f11d085e8678b2b2f6374059845c3c2e5941e2c9eb766f4fe9a034b5c539d1e107c1f7b4ed266975bfa44797ba8609aee8a985

data/Gemfile.lock

@@ -1,72 +1,86 @@
 PATH
   remote: .
   specs:
-    annotable (0.1.2)
+    annotable (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.2)
-    commander (4.6.0)
-      highline (~> 2.0.0)
-    diff-lcs (1.5.0)
+    ast (2.4.3)
+    commander (5.0.0)
+      highline (~> 3.0.0)
+    diff-lcs (1.6.2)
     docile (1.4.0)
-    highline (2.0.3)
-    parallel (1.22.1)
-    parlour (5.0.0)
-      commander (~> 4.5)
+    highline (3.0.1)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    logger (1.7.0)
+    parallel (1.27.0)
+    parlour (9.1.2)
+      commander (~> 5.0)
       parser
       rainbow (~> 3.0)
       sorbet-runtime (>= 0.5)
-    parser (3.1.2.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.4.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rake (13.3.0)
+    rbs (3.9.4)
+      logger
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.30.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.78.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-rspec (2.11.1)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-rspec (3.6.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.72, >= 1.72.1)
+    ruby-progressbar (1.13.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    sorbet-runtime (0.5.10184)
-    sord (4.0.0)
-      commander (~> 4.5)
-      parlour (~> 5.0)
+    sorbet-runtime (0.5.12222)
+    sord (7.1.0)
+      commander (~> 5.0)
+      parlour (~> 9.1)
+      parser
+      rbs (>= 3.0, < 5)
       sorbet-runtime
       yard
-    unicode-display_width (2.1.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    yard (0.9.37)
 
 PLATFORMS
   x86_64-linux
@@ -74,12 +88,12 @@ PLATFORMS
 
 DEPENDENCIES
   annotable!
-  rake (~> 13.0)
-  rspec (~> 3.11)
-  rubocop (~> 1.29)
-  rubocop-rspec (~> 2.11)
+  rake (~> 13.3)
+  rspec (~> 3.13)
+  rubocop (~> 1.78)
+  rubocop-rspec (~> 3.6)
   simplecov (~> 0.21)
-  sord (~> 4.0)
+  sord (~> 7.1)
 
 BUNDLED WITH
    2.3.7

data/README.md

@@ -37,6 +37,36 @@ class Needy
 end
 ```
 
+You can use `annotation` to declare one annotation along with it's validation block:
+
+```ruby
+require "annotable" # Require the gem
+
+class Needy
+  extend Annotable # Extend your class or module with Annotable
+  annotation :my_annotation do |params, options| # Declare your annotations with a validation block
+    raise ArgumentError, "my_annotation doesn't accept parameters" unless params.empty?
+
+    case options
+    in foo:
+      raise ArgumentError, "foo must be a String" unless foo.is_a? String
+    else
+      raise ArgumentError, "foo is mandatory"
+    end
+  end
+
+  my_annotation foo: "world!" # Annotate your methods
+  def method_needing_meta_data
+    # ...
+  end
+
+  my_annotation foo: 42 # Raises an error
+  def regular_method
+    # ...
+  end
+end
+```
+
 `Annotable` adds several methods to your class or module, providing access to annotations and their metadata:
 ```ruby
 Needy.annotated_method_exist? :method_needing_meta_data

data/annotable.gemspec

@@ -32,10 +32,10 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.11"
-  spec.add_development_dependency "rubocop", "~> 1.29"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.11"
+  spec.add_development_dependency "rake", "~> 13.3"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "rubocop", "~> 1.78"
+  spec.add_development_dependency "rubocop-rspec", "~> 3.6"
   spec.add_development_dependency "simplecov", "~> 0.21"
-  spec.add_development_dependency "sord", "~> 4.0"
+  spec.add_development_dependency "sord", "~> 7.1"
 end

data/lib/annotable/annotation.rb

@@ -24,10 +24,17 @@ module Annotable
     # @param [Array<Object>] params The annotation's params
     # @param [Hash<Symbol, Object>] options The annotation's options
     #
-    def initialize(name, params = [], options = {})
+    #
+    # [params, options] params and/or options validation block
+    # @yieldparam [Array<Object>] params the annotation parameters
+    # @yieldparam [Hash<Symbol, Object>] options the annotation options
+    #
+    def initialize(name, params = [], options = {}, &)
       @name = name
       @params = params
       @options = options
+
+      yield(params, options) if block_given?
     end
   end
 end

data/lib/annotable/version.rb

@@ -2,5 +2,5 @@
 
 module Annotable
   # @return [String] The gem version number
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/annotable.rb

@@ -62,7 +62,7 @@ module Annotable
   #   annotable :my_annotation, :my_other_annotation
   #
   # This will generate two class methods named after the given symbols.
-  # These methods, will push a new `Annotation` in the `current_annotation` array.
+  # These methods will push a new `Annotation` instance in the `current_annotation` array.
   #
   # @param [Array<Symbol>] annotation_names The names of annotations to declare
   #
@@ -78,6 +78,39 @@ module Annotable
     end
   end
 
+  #
+  # Declares one annotation usable in the module or class.
+  # The annotation can be validated using a block.
+  #
+  #   annotation :my_annotation do |params, options|
+  #     raise ArgumentError, "my_annotation doesn't accept parameters" unless params.empty?
+  #
+  #     case options
+  #     in foo:
+  #       raise ArgumentError, "foo must be a String" unless foo.is_a? String
+  #     else
+  #       raise ArgumentError, "foo is mandatory"
+  #     end
+  #   end
+  #
+  # This will generate a class method named after the given symbol.
+  # This method intialize a new `Annotation` which then execute the validation block.
+  # The annotation instance will be pushed in the `current_annotation` array.
+  #
+  # @param [Symbol] name The names of annotations to declare
+  #
+  # @yield [params, options] params and/or options validation block
+  # @yieldparam [Array<Object>] params the annotation parameters
+  # @yieldparam [Hash<Symbol, Object>] options the annotation options
+  #
+  # @return [void]
+  #
+  def annotation(name, &validator)
+    define_singleton_method(name) do |*params, **options|
+      current_annotations.push Annotable::Annotation.new(name, params, options, &validator)
+    end
+  end
+
   #
   # Return all annotated methods or those matching the given annotation names.
   #

data/sig/annotable.rbs

@@ -56,11 +56,32 @@ module Annotable
   #   annotable :my_annotation, :my_other_annotation
   # 
   # This will generate two class methods named after the given symbols.
-  # These methods, will push a new `Annotation` in the `current_annotation` array.
+  # These methods will push a new `Annotation` instance in the `current_annotation` array.
   # 
   # _@param_ `annotation_names` — The names of annotations to declare
   def annotable: (*::Array[Symbol] annotation_names) -> void
 
+  # Declares one annotation usable in the module or class.
+  # The annotation can be validated using a block.
+  # 
+  #   annotation :my_annotation do |params, options|
+  #     raise ArgumentError, "my_annotation doesn't accept parameters" unless params.empty?
+  # 
+  #     case options
+  #     in foo:
+  #       raise ArgumentError, "foo must be a String" unless foo.is_a? String
+  #     else
+  #       raise ArgumentError, "foo is mandatory"
+  #     end
+  #   end
+  # 
+  # This will generate a class method named after the given symbol.
+  # This method intialize a new `Annotation` which then execute the validation block.
+  # The annotation instance will be pushed in the `current_annotation` array.
+  # 
+  # _@param_ `name` — The names of annotations to declare
+  def annotation: (Symbol name) ?{ (::Array[Object] params, ::Hash[Symbol, Object] options) -> void } -> void
+
   # Return all annotated methods or those matching the given annotation names.
   # 
   # _@param_ `names` — The annotation names to find
@@ -149,12 +170,14 @@ module Annotable
   class Annotation
     # Creates an new annotation.
     # 
+    # [params, options] params and/or options validation block
+    # 
     # _@param_ `name` — The annotation's name
     # 
     # _@param_ `params` — The annotation's params
     # 
     # _@param_ `options` — The annotation's options
-    def initialize: (Symbol name, ?::Array[Object] params, ?::Hash[Symbol, Object] options) -> void
+    def initialize: (Symbol name, ?::Array[Object] params, ?::Hash[Symbol, Object] options) ?{ (::Array[Object] params, ::Hash[Symbol, Object] options) -> void } -> void
 
     # _@return_ — The annotation's name
     attr_reader name: Symbol

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: annotable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Mathieu MOREL
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-14 00:00:00.000000000 Z
+date: 2025-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,56 +15,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.11'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.78'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.29'
+        version: '1.78'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.11'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '7.1'
 description: Provides a simple way to add annotations to your method declarations.
 email:
 - mathieu@lamanufacture.dev
@@ -125,7 +124,6 @@ metadata:
   homepage_uri: https://github.com/ductr-io/annotable
   source_code_uri: https://github.com/ductr-io/annotable
   changelog_uri: https://github.com/ductr-io/annotable/releases
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: A simple zero-dependency method annotation gem
 test_files: []