annotable 0.1.2

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify all your gem's dependencies in annotable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    annotable (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    commander (4.6.0)
+      highline (~> 2.0.0)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    highline (2.0.3)
+    parallel (1.22.1)
+    parlour (5.0.0)
+      commander (~> 4.5)
+      parser
+      rainbow (~> 3.0)
+      sorbet-runtime (>= 0.5)
+    parser (3.1.2.0)
+      ast (~> 2.4.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)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      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)
+      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)
+    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
+      yard
+    unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.28)
+      webrick (~> 1.7.0)
+
+PLATFORMS
+  x86_64-linux
+  x86_64-linux-musl
+
+DEPENDENCIES
+  annotable!
+  rake (~> 13.0)
+  rspec (~> 3.11)
+  rubocop (~> 1.29)
+  rubocop-rspec (~> 2.11)
+  simplecov (~> 0.21)
+  sord (~> 4.0)
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,95 @@
+# Annotable
+
+Annotable is a module that can extend any class or module to add the ability to annotate its methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "annotable"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install annotable
+
+## Usage
+```ruby
+require "annotable" # Require the gem
+
+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:
+```ruby
+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:
+```ruby
+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:
+```ruby
+annotation = method.annotations.first
+annotation.name
+# => :my_annotation
+annotation.params
+# => [42]
+annotation.options
+# => {:hello => "world!"}
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ductr-io/annotable.
+
+## License
+
+The gem is available as open source under the terms of the [LGPLv3 or later](https://opensource.org/license/lgpl-3-0/).

data/Rakefile

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "sord"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]
+
+desc "Generates RBS file from the yard documentation"
+task :sord do
+  options = {
+    rbs: true,
+    sord_comments: true,
+    regenerate: true,
+    break_params: 4,
+    replace_errors_with_untyped: false,
+    replace_unresolved_with_untyped: false,
+    exclude_messages: nil,
+    include_messages: nil,
+    keep_original_comments: false,
+    skip_constants: false,
+    use_original_initialize_return: false,
+    exclude_untyped: false
+  }
+
+  plugin = Sord::ParlourPlugin.new(options)
+  plugin.parlour = Parlour::RbsGenerator.new(break_params: options[:break_params])
+  plugin.generate(plugin.parlour.root)
+
+  File.write("sig/annotable.rbs", plugin.parlour.send(:rbs))
+end

data/annotable.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/annotable/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "annotable"
+  spec.version = Annotable::VERSION
+  spec.authors = ["Mathieu MOREL"]
+  spec.email = ["mathieu@lamanufacture.dev"]
+
+  spec.summary = "A simple zero-dependency method annotation gem"
+  spec.description = "Provides a simple way to add annotations to your method declarations."
+  spec.homepage = "https://github.com/ductr-io/annotable"
+  spec.license = "LGPL-3.0-or-later"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  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 "simplecov", "~> 0.21"
+  spec.add_development_dependency "sord", "~> 4.0"
+end

data/lib/annotable/annotation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Annotable
+  #
+  # 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
+    # @return [Symbol] The annotation's name
+    attr_reader :name
+    # @return [Array<Object>] The annotation's params
+    attr_reader :params
+    # @return [Hash<Symbol, Object>] The annotation's options
+    attr_reader :options
+
+    #
+    # Creates an new annotation.
+    #
+    # @param [Symbol] name The annotation's name
+    # @param [Array<Object>] params The annotation's params
+    # @param [Hash<Symbol, Object>] options The annotation's options
+    #
+    def initialize(name, params = [], options = {})
+      @name = name
+      @params = params
+      @options = options
+    end
+  end
+end

data/lib/annotable/method.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Annotable
+  #
+  # 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
+    # @return [Symbol] The method name
+    attr_reader :name
+    # @return [Array<Annotation>] The annotations declared for this method
+    attr_reader :annotations
+
+    #
+    # Creates a new annotated method.
+    #
+    # @param [Symbol] name The method name
+    # @param [Array<Annotation>] annotations The annotations linked to this method
+    #
+    def initialize(name, *annotations)
+      raise ArgumentError, "You must provide at least one annotation" if annotations.empty?
+
+      @name = name
+      @annotations = annotations
+    end
+
+    #
+    # Determines whether annotation exists based on its name.
+    #
+    # @param [Symbol] name The annotation's name to check for
+    #
+    # @return [Boolean] True if the annotation exists, false otherwise
+    #
+    def annotation_exist?(name)
+      !annotations.find { |a| a.name == name }.nil?
+    end
+
+    #
+    # Returns all annotations matching the given names.
+    #
+    # @param [Array<Symbol>] names Names of the annotations to select
+    #
+    # @return [Array<Annotation>] The matching annotations
+    #
+    def select_annotations(*names)
+      raise ArgumentError, "You must provide at least one name to select" if names.empty?
+
+      annotations.select do |a|
+        names.include? a.name
+      end
+    end
+
+    #
+    # Finds the first annotation matching one of the given names.
+    #
+    # @param [Array<Symbol>] *names The annotation names to find
+    #
+    # @return [Annotation] The matching annotation
+    #
+    def find_annotation(*names)
+      raise ArgumentError, "You must provide at least one name to find" if names.empty?
+
+      annotations.find do |a|
+        names.include? a.name
+      end
+    end
+  end
+end

data/lib/annotable/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Annotable
+  # @return [String] The gem version number
+  VERSION = "0.1.2"
+end