Merge pull request #64 from rosette-api/devops-306-refresh-for-1.28-release

DEVOPS-306: refresh for 1.28 release

Author: seth-mg

.gitignore

@@ -3,6 +3,7 @@
 *.rbc
 /.config
 /coverage/
+coverage
 /InstalledFiles
 /pkg/
 /spec/reports/

.rubocop.yml

@@ -1 +1,4 @@
 inherit_from: .rubocop_todo.yml
+AllCops:
+  TargetRubyVersion: 3.0
+  NewCops: enable

.rubocop_todo.yml

@@ -1,46 +1,45 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-11-07 23:26:30 +0000 using RuboCop version 0.76.0.
+# on 2024-01-11 22:13:12 UTC using RuboCop version 1.59.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
 # Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 44
+  Max: 45
 
 # Offense count: 10
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
 Metrics/BlockLength:
   Max: 786
 
 # Offense count: 2
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 228
+  Max: 232
 
 # Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns.
 Metrics/CyclomaticComplexity:
   Max: 8
 
 # Offense count: 11
-# Configuration parameters: CountComments, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 51
 
 # Offense count: 1
-# Configuration parameters: CountKeywordArgs.
+# Configuration parameters: CountKeywordArgs, MaxOptionalParameters.
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 1
-Metrics/PerceivedComplexity:
-  Max: 8
-
 # Offense count: 3
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# 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:
@@ -49,6 +48,7 @@ Naming/FileName:
     - 'examples/morphology_parts-of-speech.rb'
 
 # Offense count: 10
+# This cop supports unsafe autocorrection (--autocorrect-all).
 Style/CommentedKeyword:
   Exclude:
     - 'lib/address_parameter.rb'
@@ -62,31 +62,16 @@ Style/CommentedKeyword:
     - 'lib/name_translation_parameters.rb'
     - 'lib/rosette_api_error.rb'
 
-# Offense count: 4
-# Configuration parameters: MinBodyLength.
-Style/GuardClause:
-  Exclude:
-    - 'lib/document_parameters.rb'
-    - 'lib/name_deduplication_parameters.rb'
-    - 'lib/name_similarity_parameters.rb'
-    - 'lib/name_translation_parameters.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-Style/IfUnlessModifier:
-  Exclude:
-    - 'lib/rosette_api.rb'
-
 # Offense count: 14
-# Cop supports --auto-correct.
-# Configuration parameters: .
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowedCompactTypes.
 # SupportedStyles: compact, exploded
 Style/RaiseArgs:
   EnforcedStyle: compact
 
-# Offense count: 25
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# Offense count: 11
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https
-Metrics/LineLength:
+Layout/LineLength:
   Max: 772

.travis.yml

@@ -0,0 +1,94 @@
+
+
+def versions = [3.0, 3.1, 3.2, 3.3]
+
+def runSonnarForPythonVersion(sourceDir, ver){
+    mySonarOpts="-Dsonar.sources=/source -Dsonar.host.url=${env.SONAR_HOST_URL} -Dsonar.login=${env.SONAR_AUTH_TOKEN}"
+    if("${env.CHANGE_ID}" != "null"){
+        mySonarOpts = "$mySonarOpts -Dsonar.pullrequest.key=${env.CHANGE_ID} -Dsonar.pullrequest.branch=${env.BRANCH_NAME}"
+    } else {
+        mySonarOpts = "$mySonarOpts -Dsonar.branch.name=${env.BRANCH_NAME}"
+    } 
+    if ("${env.CHANGE_BRANCH}" != "null") {
+        mySonarOpts="$mySonarOpts -Dsonar.pullrequest.base=${env.CHANGE_TARGET} -Dsonar.pullrequest.branch=${env.CHANGE_BRANCH}"
+    }
+
+    // Only run Sonar once.
+    // Check for new versions at https://binaries.sonarsource.com/?prefix=Distribution/sonar-scanner-cli/
+    if(ver == 3.3) {
+        sonarExec="cd /root/ && \
+                   wget -q https://binaries.sonarsource.com/Distribution/sonar-scanner-cli/sonar-scanner-cli-4.8.1.3023-linux.zip && \
+                   unzip -q sonar-scanner-cli-4.8.1.3023-linux.zip && \
+                   cd /source && \
+                   /root/sonar-scanner-4.8.1.3023-linux/bin/sonar-scanner ${mySonarOpts}"
+    } else {
+        sonarExec="echo Skipping Sonar for this version."
+    }
+
+    //
+    //
+    // NOTE:  The test coverage data is not making it into Sonar.
+    //        I don't think it is worth spending more time on until
+    //        Sonar is upgraded.
+    //
+    //
+    sh "docker run \
+            --pull always \
+            --rm --volume ${sourceDir}:/source \
+            ruby:${ver}-slim \
+            bash -c \"echo && \
+            echo [INFO] Testing with Ruby ${ver} && \
+            echo && \
+            echo [INFO] Updating package manager database. && \
+            apt-get update -qq && \
+            echo && \
+            echo [INFO] Installing required OS packages. && \
+            apt-get -qq install -y gcc make wget unzip > /dev/null && \
+            echo && \
+            echo [INFO] Installing gems needed for CI. && \
+            gem install --silent --quiet bundler rspec rubocop && \
+            cd /source && \
+            echo && \
+            echo [INFO] Running rubocop. && \
+            rubocop && \
+            echo && \
+            echo [INFO] Running bundle install. && \
+            bundle install --quiet && \
+            echo && \
+            echo [INFO] Removing any coverage data from prior executions. && \
+            rm -rf coverage && \
+            echo [INFO] Running unit tests. && \
+            rspec tests && \
+            echo && \
+            echo [INFO] Building gem. && \
+            gem build rosette_api.gemspec && \
+            echo && \
+            echo [INFO] Installing gem. && \
+            gem install rosette_api-*.gem && \
+            echo && \
+            echo [INFO] Executing Sonar if required. && \
+            ${sonarExec}\""
+}
+
+node ("docker-light") {
+    def sourceDir = pwd()
+    try {
+        stage("Clean up") {
+            step([$class: 'WsCleanup'])
+        }
+        stage("Checkout Code") {
+            checkout scm
+        }
+        stage("Build & Test") {
+            withSonarQubeEnv {
+                
+                versions.each { ver ->
+                    runSonnarForPythonVersion(sourceDir, ver)
+                }
+            }
+        }
+    } catch (e) {
+        currentBuild.result = "FAILED"
+        throw e
+    }
+}

CI.Jenkinsfile

@@ -4,23 +4,25 @@ Modify `.rubocop_todo.yml` as you fix issues.
 Generate a new config file with `rubocop --auto-gen-config` as needed.
 
 ```
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 apt-get update
 apt-get install -y gcc make
 
 gem install rubocop
+cd /source
 rubocop
 
 ```
 
 #### Run tests locally
 
 ```
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 apt-get update
 apt-get install -y gcc make
 
 gem install rspec
+cd /source
 bundle install
 rspec tests
 
@@ -29,9 +31,12 @@ rspec tests
 #### Run a single example
 
 ```
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 
+cd /source
 bundle install
+gem build rosette_api.gemspec
+gem install rosette_api-*.gem
 cd examples
 
 ruby ping.rb ${API_KEY}
@@ -42,9 +47,12 @@ ruby ping.rb ${API_KEY}
 #### Run all examples
 
 ```
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 
+cd /source
 bundle install
+gem build rosette_api.gemspec
+gem install rosette_api-*.gem
 cd examples
 
 for example in $(ls *.rb); do ruby ${example} ${API_KEY}; done

DEVELOPER.md

@@ -2,8 +2,10 @@
 
 source 'https://rubygems.org'
 
-gem 'rdoc', '6.2.0'
+gem 'rdoc', '6.6.2'
 gem 'rubysl-securerandom', '2.0.0'
 
-gem 'rspec', '3.9.0', group: [:test]
-gem 'webmock', '3.7.6', group: [:test]
+gem 'rspec', '3.12.0', group: [:test]
+gem 'simplecov', require: false, group: :test
+gem 'simplecov_json_formatter', require: false, group: :test
+gem 'webmock', '3.19.1', group: [:test]

Gemfile

@@ -1,4 +1,4 @@
-Copyright (c) 2016-2019 Basis Technology Corporation.
+Copyright (c) 2016-2024 Basis Technology Corporation.
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

Jenkinsfile

@@ -13,7 +13,7 @@ A note on prerequisites. Rosette API only suports TLS 1.2 so ensure your toolcha
 ```
 git clone [email protected]:rosette-api/ruby.git
 cd ruby
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 
 gem install rosette_api
 
@@ -25,7 +25,7 @@ ruby ping.rb $API_KEY
 ```
 git clone [email protected]:rosette-api/ruby.git
 cd ruby
-docker run -it -v $(pwd):/source --entrypoint bash ruby:2.6-slim-stretch
+docker run -it -v $(pwd):/source --entrypoint bash ruby:3.3-slim
 
 cd /source
 gem build rosette_api.gemspec