simple-annotations 0.9.0 → 1.0.0

data/lib/simple-annotations.rb

@@ -1,129 +1,122 @@
+# frozen_string_literal: true
+
+require 'version'
+
 module Annotations
-  
+  # the version of simple_annotations
+  VERSION = Version.current
 
+  RESERVED_ANNOTATIONS = %i[after before].freeze
 
-    RESERVED_ANNOTATIONS = [:after, :before]
-  
-    def self.included(klass)
-      klass.extend(ClassMethods)
-    end
-  
-    def annotations(meth=nil)
-  
-      annotation = AnnotationMonitor::registered[self.class.to_s.to_sym]
-      return annotation[meth] if meth
-      annotation
-    end
-  
-  
-    def hooks(meth=nil) 
-      if meth then
-        return annotations(meth).select {|item,val| RESERVED_ANNOTATIONS.include? item }
-      else
-        res = Hash::new
-        annotations.keys.each {|val| res[val] = annotations[val].select{|item,val| RESERVED_ANNOTATIONS.include? item }}
-        return res
-      end
-    end
-  
-    def fields(meth=nil)
-      if meth then
-        return annotations(meth).select {|item,val| RESERVED_ANNOTATIONS.include? item }
-      else
-        res = Hash::new
-        annotations.keys.each {|val| res[val] = annotations[val].select{|item,val| not RESERVED_ANNOTATIONS.include? item }}
-        return res
-      end
-    end
-  
-  
-    module ClassMethods
-      def annotations(meth=nil)
-   
-        return AnnotationMonitor::registered[self.class.to_s.to_sym][meth] if meth
-        AnnotationMonitor::registered[self.to_s.to_sym]
-      end
-      
-      private
-      
-      def method_added(m)
-        AnnotationMonitor::registered[self.to_s.to_sym][m] = @last_annotations if @last_annotations
-        @last_annotations = nil
-        super
-      end
-      
-      def method_missing(meth, *args)
-        return super unless /\A§/ =~ meth
-        @last_annotations ||= {}
-        if args.size == 0
-          @last_annotations[meth[1..-1].to_sym] = true 
-        elsif args.size == 1
-          @last_annotations[meth[1..-1].to_sym] = args.first
-        else
-          @last_annotations[meth[1..-1].to_sym] = args
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  def annotations(meth = nil)
+    annotation = AnnotationMonitor.registered[self.class.to_s.to_sym]
+    return annotation[meth] if meth
+
+    annotation
+  end
+
+  def hooks(meth = nil)
+    if meth
+      annotations(meth).slice(*RESERVED_ANNOTATIONS)
+    else
+      res = {}
+      annotations.each_key do |val|
+        res[val] = annotations[val].select do |item, _val|
+          RESERVED_ANNOTATIONS.include? item
         end
       end
-      
+      res
     end
   end
-  
-  
-  class AnnotationMonitor
-    @@annotated ={}
-    @@before = TracePoint.new(:call) do |tp|
-        
-      selected_class = tp.defined_class.to_s.to_sym
-      called_method = tp.method_id
-      if AnnotationMonitor::registered.include? selected_class then
-        annotations = AnnotationMonitor::registered[selected_class][called_method]
-        if annotations.include? :before then
-          annotations[:before].call
-        end
-  
+
+  def fields(meth = nil)
+    if meth
+      annotations(meth).except(*RESERVED_ANNOTATIONS)
+    else
+      res = {}
+      annotations.each_key do |val|
+        res[val] = annotations[val].except(*RESERVED_ANNOTATIONS)
       end
-     
+      res
     end
-    @@after = TracePoint.new(:return) do |tp|
-        
-      selected_class = tp.defined_class.to_s.to_sym
-      called_method = tp.method_id
-      if AnnotationMonitor::registered.include? selected_class then
-        annotations = AnnotationMonitor::registered[selected_class][called_method]
-        if annotations.include? :after then
-          annotations[:after].call
-        end
-  
-      end
-     
+  end
+
+  module ClassMethods
+    def annotations(meth = nil)
+      return AnnotationMonitor.registered[self.class.to_s.to_sym][meth] if meth
+
+      AnnotationMonitor.registered[to_s.to_sym]
+    end
+
+    private
+
+    def method_added(m)
+      AnnotationMonitor.registered[to_s.to_sym][m] = @last_annotations if @last_annotations
+      @last_annotations = nil
+      super
     end
-    @@after.enable unless @@after.enabled?
-    @@before.enable unless @@before.enabled?
-  
-    def AnnotationMonitor::register(aClass)
-      @@annotated[aClass] = {}
-    end 
-  
-    def AnnotationMonitor::registered
-      return @@annotated
+
+    def method_missing(meth, *args)
+      return super unless /\A§/ =~ meth
+
+      @last_annotations ||= {}
+      @last_annotations[meth[1..].to_sym] = if args.empty?
+                                              true
+                                            elsif args.size == 1
+                                              args.first
+                                            else
+                                              args
+                                            end
     end
-  
   end
-  
-
-  module AnnotationRefinement
-    refine Module do
-        private
-  
-        def annotate!
-          AnnotationMonitor::register(self.to_s.to_sym)
-          include Annotations
-        end
+end
 
+class AnnotationMonitor
 
+  def AnnotationMonitor::register(aClass)
+    @@annotated[aClass] = {}
+  end
+
+  def AnnotationMonitor::registered
+    @@annotated
+  end
+
+  @@annotated = {}
+  @@before = TracePoint.new(:call) do |tp|
+    selected_class = tp.defined_class.to_s.to_sym
+    called_method = tp.method_id
+    if AnnotationMonitor.registered.include? selected_class
+      annotations = AnnotationMonitor.registered[selected_class][called_method]
+      annotations[:before].call if annotations.include? :before
+
+    end
+  end
+  @@after = TracePoint.new(:return) do |tp|
+    selected_class = tp.defined_class.to_s.to_sym
+    called_method = tp.method_id
+    if AnnotationMonitor.registered.include? selected_class
+      annotations = AnnotationMonitor.registered[selected_class][called_method]
+      annotations[:after].call if annotations.include? :after
 
     end
   end
+  @@after.enable unless @@after.enabled?
+  @@before.enable unless @@before.enabled?
 
  
-  
-  
+end
+
+module AnnotationRefinement
+  refine Module do
+    private
+
+    def annotate!
+      AnnotationMonitor.register(to_s.to_sym)
+      include Annotations
+    end
+  end
+end

data/samples/test_base.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'simple-annotations'
+
+class A
+  using AnnotationRefinement
+
+  annotate!
+
+  §test 'string'
+  def method
+    return annotations(__callee__)
+  end
+
+  
+end
+
+
+
+anA = A.new
+pp anA.method

data/samples/test_class_method.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'simple-annotations'
+
+class A
+  using AnnotationRefinement
+
+  annotate!
+
+  §test 1234
+  def m1
+
+  end
+
+  §foo 12
+  §bar
+  def m2; end
+
+  §foobar color: 'cyan'
+  def m3; end
+
+  def m4; end
+
+  §after -> { puts 'm5 after' }
+  def m5; end
+
+  §test 10, {}, [], 'string'
+  def m6; end
+end
+
+
+pp A.annotations
+
+pp A.annotations[:m3]
+
+

data/samples/test_fields.rb

@@ -0,0 +1,21 @@
+require 'rubygems'
+require 'simple-annotations'
+
+class A
+  using AnnotationRefinement
+
+  annotate!
+
+  §test 1234                    # Numeric
+  §foobar color: 'cyan'         # Hash by double splat, like keyword
+  §testbar 10, {}, [], 'string' # Hybrid by splat
+  §barfoo                       # Boolean set true
+  §footest 'string'             # String                    
+  def method
+      
+  end
+
+end
+
+
+pp A.annotations[:method]

data/samples/test_hook.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'simple-annotations'
+
+class A
+  using AnnotationRefinement
+
+  annotate!
+
+  
+  §after -> { puts 'after' }
+  §before -> { puts 'before' }
+  def m1
+    puts 'test'
+  end
+
+  
+end
+
+
+
+anA = A.new
+anA.m1

data/simple-annotations.gemspec

@@ -1,24 +1,31 @@
+# frozen_string_literal: true
+
+require 'English'
 Gem::Specification.new do |s|
-    s.name = %q{simple-annotations}
-    s.author = "Romain GEORGES"
-    s.version = "0.9.0"
-    s.date = "2021-12-27"
-    s.summary = "Simple method annotations like in java or Python methods decorators"
-    s.email = "romain@ultragreen.net"
-    s.homepage = "http://www.ultragreen.net"
-    s.description = "Simple method annotations like in java or Python methods decorators"
-    s.files = `git ls-files`.split($/)
-    s.required_ruby_version = '~> 2.7.0'
-    s.add_development_dependency "rspec", "~> 3.10"
-    s.add_development_dependency "roodi", "~> 5.0"
-    s.add_development_dependency "rake", "~> 12.3"
-    s.add_development_dependency "yard", "~> 0.9"
-    s.add_development_dependency "yard-rspec", "~> 0.1"
-    s.require_paths = ["lib"]
-    s.require_paths << 'bin'
-    s.bindir = 'bin'
-    s.executables = Dir["bin/*"].map!{|item| item.gsub("bin/","")}
-    s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-    s.license = "BSD-2-Clause"
+  s.name = 'simple-annotations'
+  s.author = 'Romain GEORGES'
+  s.version = `cat VERSION`.chomp
+  s.summary = 'Simple method annotations like in java or Python methods decorators'
+  s.email = 'romain@ultragreen.net'
+  s.homepage = 'https://github.com/lecid/simple-annotations'
+  s.description = 'Simple method annotations like in java or Python methods decorators'
+  s.required_ruby_version = Gem::Requirement.new('>= 3.2.3')
+  s.license = 'BSD-3-Clause'
+  s.metadata['rubygems_mfa_required'] = 'true'
+  s.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
   end
-  
+  s.require_paths = ['lib']
+  s.add_development_dependency 'bundle-audit', '~> 0.1.0'
+  s.add_development_dependency 'code_statistics', '~> 0.2.13'
+  s.add_development_dependency 'rake', '~> 13.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+  s.add_development_dependency 'rspec-expectations', '~> 3.13.0'
+  s.add_development_dependency 'rubocop', '~> 1.32'
+  s.add_development_dependency 'yard', '~> 0.9.27'
+  s.add_development_dependency 'yard-rspec', '~> 0.1'
+  s.add_dependency 'version', '~> 1.1'
+  s.add_development_dependency 'cyclonedx-ruby', '~> 1.1'
+  s.add_development_dependency 'debride', '~> 1.12'
+  s.add_development_dependency 'diff-lcs', '~> 1.5.1'
+end

metadata

@@ -1,71 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: simple-annotations
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Romain GEORGES
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-27 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundle-audit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 0.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
-  name: roodi
+  name: code_statistics
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.2.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.2.13
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.13.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.32'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '1.32'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.27
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.27
 - !ruby/object:Gem::Dependency
   name: yard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,40 +122,107 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: cyclonedx-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: debride
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: diff-lcs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 description: Simple method annotations like in java or Python methods decorators
 email: romain@ultragreen.net
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".debride_whitelist"
+- ".github/workflows/main.yml"
+- ".rspec"
+- ".rubocop.yml"
 - AUTHORS
 - COPYRIGHT
 - Gemfile
+- LICENSE.txt
+- README.md
 - Rakefile
-- coding_convention.yml
+- VERSION
+- bom.xml
 - lib/simple-annotations.rb
+- samples/test_base.rb
+- samples/test_class_method.rb
+- samples/test_fields.rb
+- samples/test_hook.rb
 - simple-annotations.gemspec
-homepage: http://www.ultragreen.net
+homepage: https://github.com/lecid/simple-annotations
 licenses:
-- BSD-2-Clause
-metadata: {}
+- BSD-3-Clause
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
-- bin
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.2.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Simple method annotations like in java or Python methods decorators

data/coding_convention.yml

@@ -1,25 +0,0 @@
-AssignmentInConditionalCheck:
-CaseMissingElseCheck:
-ClassLineCountCheck:             
-  line_count: 300
-ClassNameCheck:                  
-  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
-#ClassVariableCheck:
-CyclomaticComplexityBlockCheck:  
-  complexity: 4
-CyclomaticComplexityMethodCheck: 
-  complexity: 10
-EmptyRescueBodyCheck:
-ForLoopCheck:
-MethodLineCountCheck:            
-  line_count: 30 
-MethodNameCheck:                 
-  pattern: !ruby/regexp /^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/ 
-# MissingForeignKeyIndexCheck:
-ModuleLineCountCheck:            
-  line_count: 500
-ModuleNameCheck:          
-  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
-ParameterNumberCheck:            
-  parameter_count: 5
-