annotable 0.1.2

data/lib/annotable.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+require_relative "annotable/annotation"
+require_relative "annotable/method"
+require_relative "annotable/version"
+
+#
+# Annotable is a module that can extend any class or module to add the ability to annotate its methods.
+#
+#   class Needy
+#     extend Annotable # Extend your class or module with Annotable
+#     annotable :my_annotation, :my_other_annotation # Declare your annotations
+#
+#     my_annotation 42, hello: "world!" # Annotate your methods
+#     def method_needing_meta_data
+#       # ...
+#     end
+#
+#     def regular_method
+#       # ...
+#     end
+#   end
+#
+# `Annotable` adds several methods to your class or module, providing access to annotations and their metadata:
+#
+#   Needy.annotated_method_exist? :method_needing_meta_data # => true
+#   Needy.annotated_method_exist? :regular_method # => false
+#   Needy.annotated_methods
+#   # => [#<Annotable::Method
+#   #   @annotations=[
+#   #     #<Annotable::Annotation
+#   #       @name=:my_annotation,
+#   #       @options={:hello=>"world!"},
+#   #       @params=[42]>
+#   #   ],
+#   #   @name=:method_needing_meta_data>
+#   # ]
+#
+# `Annotable::Method` represents a method name along with its annotations:
+#
+#   method = Needy.annotated_methods.first
+#   method.name # => :method_needing_meta_data
+#   method.annotations
+#   # => [
+#   #   #<Annotable::Annotation
+#   #     @name=:my_annotation,
+#   #     @options={:hello=>"world!"},
+#   #     @params=[42]>
+#   # ]
+#
+# `Annotable::Annotation` contains annotation's name and metadata:
+#
+#   annotation = method.annotations.first
+#   annotation.name # => :my_annotation
+#   annotation.params # => [42]
+#   annotation.options # => {:hello => "world!"}
+#
+module Annotable
+  #
+  # Declares annotations usable in the module or class.
+  #
+  #   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.
+  #
+  # @param [Array<Symbol>] annotation_names The names of annotations to declare
+  #
+  # @return [void]
+  #
+  def annotable(*annotation_names)
+    raise ArgumentError, "You must provide at least one annotation name" if annotation_names.empty?
+
+    annotation_names.each do |name|
+      define_singleton_method(name) do |*params, **options|
+        current_annotations.push Annotable::Annotation.new(name, params, options)
+      end
+    end
+  end
+
+  #
+  # Return all annotated methods or those matching the given annotation names.
+  #
+  # @param [Array<Symbol>] names The annotation names to find
+  #
+  # @return [Array<Annotable::Method>] The annotated methods
+  #
+  def annotated_methods(*names)
+    return @annotated_methods if @annotated_methods.empty? || names.empty?
+
+    @annotated_methods.select do |method|
+      annotation_found = false
+
+      names.each do |name|
+        annotation_found = method.annotation_exist?(name)
+        break if annotation_found
+      end
+
+      annotation_found
+    end
+  end
+
+  #
+  # Check if an annotated method exists based in its name.
+  #
+  # @param [Symbol] name The name to check
+  #
+  # @return [Boolean] True if the annotated method exists, false otherwise
+  #
+  def annotated_method_exist?(name)
+    !annotated_methods.find { |am| am.name == name }.nil?
+  end
+
+  private
+
+  #
+  # A callback called by Ruby when a method is added into the class or module.
+  #
+  # @param [Symbol] name The name of the created method
+  #
+  # @return [void]
+  #
+  def method_added(name)
+    super
+    @annotated_methods ||= []
+    return if current_annotations.empty?
+
+    remove_annotated_method(name) if annotated_method_exist?(name)
+    @annotated_methods.push Annotable::Method.new(name, *current_annotations)
+
+    reset_current_annotations
+  end
+
+  #
+  # Remove an annotated method based on its name.
+  #
+  # @param [Symbol] name The name of the method to delete
+  #
+  # @return [void]
+  #
+  def remove_annotated_method(name)
+    @annotated_methods.reject! do |annotated_method|
+      annotated_method.name == name
+    end
+  end
+
+  #
+  # Annotation found for the current method declaration.
+  #
+  # @return [Array<Annotable::Annotation>] The annotations for the current method declaration
+  #
+  def current_annotations
+    @current_annotations ||= []
+  end
+
+  #
+  # Empty the current annotation array.
+  #
+  # @return [void]
+  #
+  def reset_current_annotations
+    @current_annotations = []
+  end
+end

data/sig/annotable.rbs

@@ -0,0 +1,168 @@
+# 
+# Annotable is a module that can extend any class or module to add the ability to annotate its methods.
+# 
+#   class Needy
+#     extend Annotable # Extend your class or module with Annotable
+#     annotable :my_annotation, :my_other_annotation # Declare your annotations
+# 
+#     my_annotation 42, hello: "world!" # Annotate your methods
+#     def method_needing_meta_data
+#       # ...
+#     end
+# 
+#     def regular_method
+#       # ...
+#     end
+#   end
+# 
+# `Annotable` adds several methods to your class or module, providing access to annotations and their metadata:
+# 
+#   Needy.annotated_method_exist? :method_needing_meta_data # => true
+#   Needy.annotated_method_exist? :regular_method # => false
+#   Needy.annotated_methods
+#   # => [#<Annotable::Method
+#   #   @annotations=[
+#   #     #<Annotable::Annotation
+#   #       @name=:my_annotation,
+#   #       @options={:hello=>"world!"},
+#   #       @params=[42]>
+#   #   ],
+#   #   @name=:method_needing_meta_data>
+#   # ]
+# 
+# `Annotable::Method` represents a method name along with its annotations:
+# 
+#   method = Needy.annotated_methods.first
+#   method.name # => :method_needing_meta_data
+#   method.annotations
+#   # => [
+#   #   #<Annotable::Annotation
+#   #     @name=:my_annotation,
+#   #     @options={:hello=>"world!"},
+#   #     @params=[42]>
+#   # ]
+# 
+# `Annotable::Annotation` contains annotation's name and metadata:
+# 
+#   annotation = method.annotations.first
+#   annotation.name # => :my_annotation
+#   annotation.params # => [42]
+#   annotation.options # => {:hello => "world!"}
+module Annotable
+  VERSION: String
+
+  # Declares annotations usable in the module or class.
+  # 
+  #   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.
+  # 
+  # _@param_ `annotation_names` — The names of annotations to declare
+  def annotable: (*::Array[Symbol] annotation_names) -> void
+
+  # Return all annotated methods or those matching the given annotation names.
+  # 
+  # _@param_ `names` — The annotation names to find
+  # 
+  # _@return_ — The annotated methods
+  def annotated_methods: (*::Array[Symbol] names) -> ::Array[Annotable::Method]
+
+  # Check if an annotated method exists based in its name.
+  # 
+  # _@param_ `name` — The name to check
+  # 
+  # _@return_ — True if the annotated method exists, false otherwise
+  def annotated_method_exist?: (Symbol name) -> bool
+
+  # A callback called by Ruby when a method is added into the class or module.
+  # 
+  # _@param_ `name` — The name of the created method
+  def method_added: (Symbol name) -> void
+
+  # Remove an annotated method based on its name.
+  # 
+  # _@param_ `name` — The name of the method to delete
+  def remove_annotated_method: (Symbol name) -> void
+
+  # Annotation found for the current method declaration.
+  # 
+  # _@return_ — The annotations for the current method declaration
+  def current_annotations: () -> ::Array[Annotable::Annotation]
+
+  # Empty the current annotation array.
+  def reset_current_annotations: () -> void
+
+  # 
+  # An annotated method with its annotations.
+  # 
+  #   one = Annotation.new(:one)
+  #   two = Annotation.new(:two)
+  #   some_method = Method.new(:some_method, one, two)
+  # 
+  #   some_method.annotation_exist?(:one) # => true
+  #   some_method.annotation_exist?(:no) # => false
+  #   some_method.select_annotations(:one) # => [#<Annotable::Annotation @name=:one, @options={}, @params=[]>]
+  class Method
+    # Creates a new annotated method.
+    # 
+    # _@param_ `name` — The method name
+    # 
+    # _@param_ `annotations` — The annotations linked to this method
+    def initialize: (Symbol name, *::Array[Annotation] annotations) -> void
+
+    # Determines whether annotation exists based on its name.
+    # 
+    # _@param_ `name` — The annotation's name to check for
+    # 
+    # _@return_ — True if the annotation exists, false otherwise
+    def annotation_exist?: (Symbol name) -> bool
+
+    # Returns all annotations matching the given names.
+    # 
+    # _@param_ `names` — Names of the annotations to select
+    # 
+    # _@return_ — The matching annotations
+    def select_annotations: (*::Array[Symbol] names) -> ::Array[Annotation]
+
+    # Finds the first annotation matching one of the given names.
+    # 
+    # _@param_ `*names` — The annotation names to find
+    # 
+    # _@return_ — The matching annotation
+    def find_annotation: (*::Array[Symbol] names) -> Annotation
+
+    # _@return_ — The method name
+    attr_reader name: Symbol
+
+    # _@return_ — The annotations declared for this method
+    attr_reader annotations: ::Array[Annotation]
+  end
+
+  # 
+  # Encapsulates annotation data: name, params & options.
+  # 
+  #   my_annotation = Annotation.new(:name, ["some", "params"], {some: "options"})
+  #   my_annotation.name # => :name
+  #   my_annotation.params # => ["some", "params"]
+  #   my_annotation.options # => {some: "options"}
+  class Annotation
+    # Creates an new annotation.
+    # 
+    # _@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
+
+    # _@return_ — The annotation's name
+    attr_reader name: Symbol
+
+    # _@return_ — The annotation's params
+    attr_reader params: ::Array[Object]
+
+    # _@return_ — The annotation's options
+    attr_reader options: ::Hash[Symbol, Object]
+  end
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: annotable
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Mathieu MOREL
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.11'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.29'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: sord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Provides a simple way to add annotations to your method declarations.
+email:
+- mathieu@lamanufacture.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".vscode/settings.json"
+- COPYING
+- COPYING.LESSER
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- annotable.gemspec
+- lib/annotable.rb
+- lib/annotable/annotation.rb
+- lib/annotable/method.rb
+- lib/annotable/version.rb
+- sig/annotable.rbs
+homepage: https://github.com/ductr-io/annotable
+licenses:
+- LGPL-3.0-or-later
+metadata:
+  allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
+  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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A simple zero-dependency method annotation gem
+test_files: []