simple-annotations 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d62a412404c8d41cb4230098c827cba940e6362353a20dd02da71a40acb15f7
-  data.tar.gz: 993681e8e609eec8994bc7d2083e0509d57d871ceb4ffa3692c458cded56cd75
+  metadata.gz: bb8dd5c29e7e0c93d2462675fdce3029c205cebce502703edcac597fe2786497
+  data.tar.gz: e2b68572f27da1eabc468250616455db8b6325299ec1daa01d7197cec3127f54
 SHA512:
-  metadata.gz: fedf3e96c67d342b2aab34c89ebe0aa7aa433420fd4cb9d74abc1115fc06ed36aaf6d22f72b1b103eb0f9db1e9bdb29ac6cbe7976e240a369897653ab2cddcd6
-  data.tar.gz: 51575e47217422cf4eb9aaa904a58ae3b80bcd8f4695d6fc12fdbb03c45e99b3874d68cc065f7e2a05070a9934bb7ff4b88a694db4ccb4a95c732841f4bffaef
+  metadata.gz: 4d0f0a2eaab17864cf63deeb7ab16dc19c0b95c5b6e2b85149a9b5a81efbf09a010441722b6fea57209705a57c6c4e4556ed37f06bd95c5b3f0a9a7dd22886f5
+  data.tar.gz: 9673641541d4389035e43a3ea4fa4ec9db9d50a190e6a49016bd125db8a496dff199bdef36c6bfddc5eaff95c7cc1fe6b414e9c4e4fee4821923bb8b8b562bda

data/.debride_whitelist

@@ -0,0 +1,11 @@
+annotate!
+fields
+hooks
+included
+method_added
+method_missing
+m2
+m3
+m4
+m5
+m6

data/.github/workflows/main.yml

@@ -0,0 +1,23 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2.3
+    - name: Getting dependencies (Bundle)
+      run: |
+        gem install bundler -v 2.2.3
+        bundle install
+    - name: Running test Rspec
+      run: |
+        bundle exec rake
+    - name: Running CVE security audit 
+      run: |
+        bundle exec rake audit

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,99 @@
+AllCops:
+    NewCops: enable
+    SuggestExtensions: false
+
+
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'simple-annotations.gemspec'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 11
+
+# Offense count: 8
+# Configuration parameters: AsciiConstants.
+Naming/AsciiIdentifiers:
+  Exclude:
+    - 'sample/test.rb'
+    - 'samples/test.rb'
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'Rakefile.rb'
+    - 'spec/simple-annotations_spec.rb'
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 2
+# Configuration parameters: MinNameLength, AllowNamesEndingInNumbers, AllowedNames, ForbiddenNames.
+# AllowedNames: as, at, by, cc, db, id, if, in, io, ip, of, on, os, pp, to
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, AllowedIdentifiers, AllowedPatterns.
+# SupportedStyles: snake_case, camelCase
+Naming/VariableName:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+    - 'samples/test.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/ClassMethods:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 3
+Style/ClassVars:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Style/ColonMethodDefinition:
+  Exclude:
+    - 'lib/simple-annotations.rb'
+
+# Offense count: 5
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/simple-annotations.rb'
+    - 'samples/test.rb'
+
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: always, always_true, never
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'samples/test.rb'
+
+# Offense count: 1
+Style/MissingRespondToMissing:
+  Exclude:
+    - 'lib/simple-annotations.rb'

data/Gemfile

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
 
-
-source 'https://artifactory-iva.si.francetelecom.fr/artifactory/api/gems/gemsproxy/'
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Romain GEORGES
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,137 @@
+# Simple Annotations 4 Ruby
+
+Simple method annotations like in java or Python methods decorators
+
+
+![GitHub](https://img.shields.io/github/license/Ultragreen/simple-annotations)
+
+[![Documentation](https://img.shields.io/badge/docs-rubydoc.info-brightgreen)](https://rubydoc.info/gems/simple-annotations)
+![GitHub issues](https://img.shields.io/github/issues/Ultragreen/simple-annotations)
+![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/Ultragreen/simple-annotations)
+![GitHub top language](https://img.shields.io/github/languages/top/Ultragreen/simple-annotations)
+![GitHub milestones](https://img.shields.io/github/milestones/open/Ultragreen/simple-annotations)
+
+![Gem](https://img.shields.io/gem/dt/simple-annotations)
+[![Gem Version](https://badge.fury.io/rb/sc4ry.svg)](https://badge.fury.io/rb/simple-annotations)
+![Twitter Follow](https://img.shields.io/twitter/follow/Ultragreen?style=social)
+![GitHub Org's stars](https://img.shields.io/github/stars/Ultragreen?style=social)
+![GitHub watchers](https://img.shields.io/github/watchers/Ultragreen/simple-annotations?style=social)
+
+
+<noscript><a href="https://liberapay.com/ruydiaz/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install carioca
+
+
+
+
+##  Usage
+
+## Adding annotations to a class
+
+
+```ruby 
+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
+
+```
+
+Display 
+
+```
+{:test=>"string"}
+```
+
+
+### Getting fields
+
+```ruby 
+require 'rubygems'
+require 'simple-annotations'
+
+class A
+  using AnnotationRefinement
+  annotate!
+
+  §foobar {:color => 'cyan' }   # Hash
+  §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]
+
+```
+
+Display
+
+```
+{:test=>1234, :foobar=>{:color=>"cyan"}, :testbar=>[10, {}, [], "string"], :barfoo=>true, :footest=>"string"}
+```
+
+### Defining Hooks
+
+Supporting 2 Hooks :
+
+- §after
+- §before
+
+Like :
+
+```ruby 
+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
+```
+
+Display
+
+```
+before
+test
+after
+```

data/Rakefile

@@ -1,58 +1,61 @@
-require 'rubygems'
+# frozen_string_literal: true
 
-require 'rspec'
-require 'rake'
-require "rake/clean"
-require "rubygems/package_task"
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-require 'yard'
-require 'yard/rake/yardoc_task.rb'
-require "rake/tasklib"
-require "roodi"
-require "roodi_task"
- 
-require "bundler/gem_tasks"
-
-
-RoodiTask.new() do | t |
-t.patterns = %w(lib/**/*.rb)
-t.config = "coding_convention.yml"
-end
-
-
-CLEAN.include('*.tmp','*.old')
-CLOBBER.include('*.tmp', 'build/*','#*#')
+require 'rubocop//rake_task'
 
+require 'yard'
+require 'yard/rake/yardoc_task'
 
-content = File::readlines(File.join(File.dirname(__FILE__), 'simple-annotations.gemspec')).join
-spec = eval(content)
+require 'code_statistics'
 
-RSpec::Core::RakeTask.new('spec')
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
 
+task default: :spec
 
+require 'version'
+require 'rake/version_task'
+Rake::VersionTask.new
 
 YARD::Rake::YardocTask.new do |t|
-  t.files   = [ 'lib/**/*.rb', '-', 'doc/**/*','spec/**/*_spec.rb']			   
-  t.options += ['--title', "Gem Documentation"]
-  t.options += ['-o', "yardoc"]
-  t.options += ['-r', "doc/manual.rdoc"]
+  t.files = ['lib/**/*.rb', '-', 'doc/**/*', 'spec/**/*_spec.rb']
+  t.options += ['-o', 'yardoc']
 end
-YARD::Config.load_plugin('yard-rspec') 
+YARD::Config.load_plugin('yard-rspec')
 
 namespace :yardoc do
   task :clobber do
-    rm_r "yardoc" rescue nil
-    rm_r ".yardoc" rescue nil
+    begin
+      rm_r 'yardoc'
+    rescue StandardError
+      nil
+    end
+    begin
+      rm_r '.yardoc'
+    rescue StandardError
+      nil
+    end
+    begin
+      rm_r 'pkg'
+    rescue StandardError
+      nil
+    end
   end
 end
-task :clobber => "yardoc:clobber"
-
+task clobber: 'yardoc:clobber'
 
-Gem::PackageTask.new(spec) do |pkg|
-  pkg.need_tar = true
-  pkg.need_zip = true
+desc 'Run CVE security audit over bundle'
+task :audit do
+  system('bundle audit')
 end
 
+desc 'Run dead line of code detection'
+task :debride do
+  system('debride -w .debride_whitelist .')
+end
 
-
-task :default => [:gem]
+desc 'Run SBOM CycloneDX Xml format file'
+task :sbom do
+  system('cyclonedx-ruby -p .')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0