remove_bg 1.4.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 728a996008009c54dc10d72f0b0db353b1156182a8379c51ed0cf5f9fbe4b27e
-  data.tar.gz: 991a7201af58af739e73af965d082b43a0427d79878e0db2f17d13c3ac575053
+  metadata.gz: ef5b34e46cd2739b86ea655145faa5984a5a3ceae1767e9a6ea4a8d5ad950182
+  data.tar.gz: 95146d0326251ec59a60843a4cecc2b0b8ebbdbfdb047b33b3b1684db62b2506
 SHA512:
-  metadata.gz: 2800e1a449e12e3168c7e15d9fd85b8424434ff568821600464a05d6448529e22514ab1e80cdd7c76c7a6ab91e45db01f99b7a7e7dab617d00b797f6788aa872
-  data.tar.gz: 556b0ded824694cffb639cab278eb00ffea8df314c5beee20a2565528671d8548fb856a3d14a52af73c5147f54d016b457268101046ce6c75647fb0a6b606c61
+  metadata.gz: 6ece195e014cc84b8fc6843d31f6a311499fd267da4e6e8c70c5b1d5b8c08521fa665d7347b5f4a6c55a74daa2dfbbc1cf99c59c6bdf5bd6d8001839371b7d9a
+  data.tar.gz: 68cdac8ec969b29b842955e24a14b160b3e5b33b766e1835dce9ddb49e05f0b61beedd7471a2dd395166823b9709fee580185bdb0a451c810b32b2b0626e2102

data/.circleci/config.yml

@@ -1,70 +1,311 @@
 ---
-version: 2
-
-base_job: &base_job
-  steps:
-    - checkout
-
-    - restore_cache:
-        keys:
-          - v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-    - run:
-        name: install dependencies
-        command: |
-          gem install bundler --version '~> 2.0'
-          bundle config set path vendor/bundle
-          bundle install --jobs=4 --retry=3
-
-    - run:
-        name: install image processsing dependencies
-        command: |
-          sudo apt-get update
-          sudo apt install imagemagick libvips
-
-    - save_cache:
-        paths:
-          - ./vendor/bundle
-        key: v1-dependencies-{{ checksum "Gemfile.lock" }}
-
-    - run:
-        name: run tests
-        command: |
-          bundle exec rspec --format progress \
-                            --format RspecJunitFormatter \
-                            --out test-results/rspec.xml
-
-    - run:
-        name: run appraisals
-        command: |
-          bundle exec appraisal install --jobs 4 --retry 3
-          bundle exec appraisal rspec
-
-    - store_test_results:
-        path: test-results
+version: 2.1
 
-################################################################################
+# Used Orbs (https://circleci.com/docs/2.0/using-orbs/)
+orbs:
+  ruby: circleci/ruby@2.1
+  sonarcloud: sonarsource/sonarcloud@2.0
+  asdf: rynkowsg/asdf@0.1
+  codecov: codecov/codecov@4.1
+  gcr: circleci/gcp-gcr@0.16
+  github: circleci/github-cli@2.3
+
+# Pipeline parameters
+parameters:
+  # The main branch of the repository (e.g. main)
+  main-branch:
+    type: string
+    default: main
+  default-ruby:
+    type: string
+    default: "3.3.3"
+
+# Define common YAML anchors
+x-common-auth: &common-auth
+  auth:
+    username: ${DOCKERHUB_USER}
+    password: ${DOCKERHUB_PASSWORD}
+
+# Define executors
+executors:
+  docker:  # Docker using the Base Convenience Image
+    docker:
+      - image: cimg/base:stable
+        <<: *common-auth
+  macos:  # macOS executor running Xcode
+    macos:
+      # https://circleci.com/developer/machine/image/xcode
+      xcode: 15.4.0
 
 jobs:
-  ruby-2.5:
-    <<: *base_job
+  # Lint Job
+  lint:
     docker:
-      - image: circleci/ruby:2.5
-  ruby-2.6:
-    <<: *base_job
+      - image: cimg/base:stable
+        <<: *common-auth
+    resource_class: small
+    steps:
+      # Check out code
+      - checkout
+      # Install requested Ruby version
+      - ruby/install:
+          version: "<< pipeline.parameters.default-ruby >>"
+      # Install dependencies using bundler
+      - ruby/install-deps:
+          pre-install-steps:
+            - run: bundle config set jobs $(nproc)
+          key: gems-v{{ .Environment.CACHE_VERSION }}
+      # Run Rubocop
+      - run:
+          name: Run Rubocop
+          command: |
+            bash -c "bundle exec rubocop --format=json --out=rubocop-result.json; [[ \$? -ne 2 ]]"
+      - store_artifacts:
+          path: rubocop-result.json
+          destination: rubocop-result.json
+      - persist_to_workspace:
+          root: .
+          paths:
+            - rubocop-result.json
+
+  # Test Job
+  test:
+    parameters:
+      # The OS to run the jobs on
+      os:
+        type: string
+        default: docker
+      # The OS to run the jobs on
+      ruby-version:
+        type: string
+        default: "3.3.3"
+    executor: << parameters.os >>
+    environment:
+      RUBY_VERSION: << parameters.ruby-version >>
+    steps:
+      # Install dependencies based on the OS
+      - when:
+          condition:
+            equal: ["docker", "<< parameters.os >>"]
+          steps:
+            - run:
+                name: Install ImageMagick, libvips and libffi
+                command: |
+                  sudo apt-get update
+                  sudo apt-get -y --no-install-recommends install openssl imagemagick \
+                    libvips42 libffi-dev libreadline-dev libtool libyaml-dev
+            - asdf/install
+      - when:
+          condition:
+            equal: ["macos", "<< parameters.os >>"]
+          steps:
+            - run:
+                name: Install ImageMagick, libvips and libffi
+                command: |
+                  brew install openssl@3 imagemagick vips asdf libffi
+      # Install requested Ruby version
+      - run:
+          name: Install Ruby << parameters.ruby-version >>
+          command: |
+            asdf plugin-add ruby
+            asdf install ruby << parameters.ruby-version >>
+            asdf global ruby << parameters.ruby-version >>
+            gem install --user-install executable-hooks
+      # Check out code
+      - checkout
+      # Install dependencies using bundler
+      - ruby/install-deps:
+          pre-install-steps:
+            - run: bundle config set jobs $(nproc)
+          key: gems-v{{ .Environment.CACHE_VERSION }}
+      # Run RSpec tests
+      - run:
+          name: Run tests
+          command: |
+            bundle exec rspec spec
+      # Run appraisals
+      - run:
+          name: Run appraisals
+          command: |
+            bundle exec appraisal install --jobs=$(nproc) --retry 3
+            bundle exec appraisal rspec
+      # Store test results
+      - store_test_results:
+          path: rspec/rspec.xml
+      # Persist test results to workspace and upload to CodeCov for default Ruby
+      - when:
+          condition:
+            and:
+              - equal: ["docker", "<< parameters.os >>"]
+              - equal: ["<< pipeline.parameters.default-ruby >>", "<< parameters.ruby-version >>"]
+          steps:
+            - persist_to_workspace:
+                root: .
+                paths:
+                  - rspec
+                  - coverage
+            - when:
+                condition:
+                  equal: ["<< pipeline.git.tag >>", ""]
+                steps:
+                  - codecov/upload:
+                      cli_args: --verbose
+                      validate: true
+
+  # Sonarcloud Job
+  sonarcloud:
     docker:
-      - image: circleci/ruby:2.6
-  ruby-2.7:
-    <<: *base_job
+      - image: cimg/openjdk:21.0-node
+        <<: *common-auth
+    resource_class: small
+    steps:
+      - checkout
+      - attach_workspace:
+          at: .
+      - run:
+          name: Replace Version
+          command: |
+            if [ -n "${CIRCLE_TAG}" ] && [ ! -z "${CIRCLE_TAG}" ] ; then
+              export APP_VERSION="${CIRCLE_TAG}"
+            elif [ -n "${CIRCLE_BRANCH}" ] && [ ! -z "${CIRCLE_BRANCH}" ] ; then
+              export APP_VERSION="${CIRCLE_BRANCH}"
+            else
+              export APP_VERSION="${CIRCLE_SHA1:0:7}"
+            fi
+            echo "Setting version to ${APP_VERSION}"
+            sed -i -e "s\\sonar.projectVersion=.*$\\sonar.projectVersion=${APP_VERSION}\\g" sonar-project.properties
+      - sonarcloud/scan
+
+  # Release Job
+  release:
     docker:
-      - image: circleci/ruby:2.7
+      - image: cimg/base:stable
+        <<: *common-auth
+    resource_class: small
+    environment:
+      GIT_MAIN_BRANCH: << pipeline.parameters.main-branch >>
+      CHANGELOG_FILENAME: CHANGELOG.md
+    steps:
+      - setup_remote_docker
+      - checkout
+      - attach_workspace:
+          at: .
+      - github/install:
+          version: 2.47.0
+      - ruby/install:
+          version: "<< pipeline.parameters.default-ruby >>"
+      # Install dependencies using bundler
+      - ruby/install-deps:
+          pre-install-steps:
+            - run: bundle config set jobs $(nproc)
+          key: gems-v{{ .Environment.CACHE_VERSION }}
+      - run:
+          name: Build and push gem
+          command: |
+            bundle config set frozen false
+            bundle exec rake version["${CIRCLE_TAG}"]
+            bundle exec gem build --strict
+            GEM_HOST_API_KEY="${REMOVE_BG_GEM_PUSH_KEY}" gem push "remove_bg-${CIRCLE_TAG}.gem"
+
+            # Update version to next beta version
+            NEXT_PATCH_TAG=$(echo "${CIRCLE_TAG:-0.0.0}" | awk 'BEGIN{FS=OFS="."} {$3+=1} 1')
+            BETA_TAG="${NEXT_PATCH_TAG}.pre"
+            bundle exec rake version["${BETA_TAG}"]
+      - gcr/gcr-auth
+      - run:
+          name: Edit Release
+          command: |
+            # Update release
+            docker run --rm -it --name=gren -v $(pwd)/.grenrc.json:/.grenrc.json \
+              eu.gcr.io/removebg-226919/github-release-notes:latest \
+              release --tags "${CIRCLE_TAG}" --override --token ${GITHUB_AUTH_TOKEN} --username ${CIRCLE_PROJECT_USERNAME} --repo ${CIRCLE_PROJECT_REPONAME}
+
+            # Get current release description
+            gh release view ${CIRCLE_TAG} --repo ${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME} --json body --jq '.body' > release-body.txt
+
+            # Append to release description
+            echo "Updating release description"
+            gh release edit ${CIRCLE_TAG} --repo ${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME} --notes-file release-body.txt --latest --title ${CIRCLE_TAG}
+      - run:
+          name: Generate CHANGELOG.md
+          command: |
+            # Configure git
+            git config --global credential.helper cache
+            git config --global user.email "${GITHUB_USER_EMAIL}"
+            git config --global user.name "${GITHUB_USER_NAME}"
+
+            # Check out main branch
+            git checkout --force "${GIT_MAIN_BRANCH}"
+
+            # Generate changelog
+            docker run -it --name=gren -v $(pwd)/.grenrc.json:/.grenrc.json \
+              eu.gcr.io/removebg-226919/github-release-notes:latest \
+              changelog --override --token ${GITHUB_AUTH_TOKEN} --username ${CIRCLE_PROJECT_USERNAME} --repo ${CIRCLE_PROJECT_REPONAME}
+
+            docker cp "gren:/${CHANGELOG_FILENAME}" "${CHANGELOG_FILENAME}"
+            docker rm gren
+
+            # Remove Windows line endings
+            sed -i $'s/\r$//' "${CHANGELOG_FILENAME}"
+
+            # Commit changelog and bumped version to git
+            git add "${CHANGELOG_FILENAME}"
+            git add lib/remove_bg/version.rb
+            git add Gemfile.lock
+            git commit -m "📝 Update ${CHANGELOG_FILENAME} for ${CIRCLE_TAG}" -m "[skip ci]"
+            git push -q --set-upstream origin ${GIT_MAIN_BRANCH}
 
 ################################################################################
 
 workflows:
-  version: 2
   multiple-rubies:
     jobs:
-      - ruby-2.5
-      - ruby-2.6
-      - ruby-2.7
+      # Test Job
+      - test:
+          context:
+            - DockerHub
+          matrix:
+            parameters:
+              os: ["docker", "macos"]
+              ruby-version: ["3.1.6", "3.2.3", "3.3.3"]
+          filters:
+            tags:
+              only: /^\d+\.\d+\.\d+$/
+
+      # Lint Job
+      - lint:
+          context:
+            - DockerHub
+          requires:
+            - test
+          filters:
+            tags:
+              only: /^\d+\.\d+\.\d+$/
+
+      # Sonarcloud Job
+      - sonarcloud:
+          context:
+            - DockerHub
+            - SonarCloud
+          requires:
+            - lint
+            - test
+          filters:
+            tags:
+              only: /^\d+\.\d+\.\d+$/
+
+      # Release Job
+      - release:
+          context:
+            - DockerHub
+            - rubygems.org
+            - Google Cloud kaleido
+          requires:
+            - lint
+            - test
+            - sonarcloud
+          filters:
+            tags:
+              only: /^\d+\.\d+\.\d+$/
+            branches:
+              ignore: /^.*$/

data/.depfu.yml

@@ -0,0 +1,21 @@
+---
+update_strategy: security
+
+bundler:
+  update_strategy: grouped
+  update_out_of_spec: false
+  reasonably_up_to_date: true
+  automerge_method: squash
+  engine_update_strategy: minor
+  commit_message: ⬆️ Update {{dependency}} to version {{version}}
+  commit_message_grouped: ⬆️ Update {{update_type}} {{project_type}} dependencies ({{date}})
+  labels:
+    - dependencies
+    - depfu
+  security_labels:
+    - 🚨 security
+  auto_assign: otherguy
+  auto_review_team_assign: platform
+  grouped_update_schedule: biweekly
+  grouped_update_start_date: '2022-01-05'  # First wednesday of the year
+  grouped_update_time: '6:00'

data/.editorconfig

@@ -0,0 +1,19 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# Unix-style newlines with a newline ending every file
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+charset = utf-8
+
+[*.rb]
+quote_type = double
+
+[*.md]
+indent_size = 4

data/.gitignore

@@ -7,16 +7,16 @@
 /spec/reports/
 /tmp/
 
-# rspec failure tracking
-spec/examples.txt
-
-.env.*.local
+# Rubocop
+.rubocop-*
+rubocop-result.json
 
-# CircleCI / RSpec JUnit formatter
-test-results
+# RSpec
+rspec/
+spec/examples.txt
 
+# Appraisals
 gemfiles/*.gemfile.lock
 
+# Examples
 examples/output
-
-.ruby-version

data/.grenrc.json

@@ -0,0 +1,20 @@
+{
+    "dataSource": "prs",
+    "prefix": "v",
+    "onlyMilestones": false,
+    "groupBy": {
+      "🚀 Enhancements:": ["enhancement", "feature", "internal"],
+      "🐞 Bugfixes:": ["bug", "fix"],
+      "🔧 Changes:": ["closed", "documentation"],
+      "🚨 Security": ["🚨 security", "security"],
+      "🔀 Dependencies": ["dependencies", "depfu"]
+    },
+    "template": {
+      "noLabel": "closed",
+      "changelogTitle": "# Changelog\n\n",
+      "release": "## {{release}}\n\n{{body}}\n",
+      "releaseSeparator": "\n",
+      "issue": "- {{name}} [{{text}}]({{url}})"
+    },
+    "changelogFilename": "CHANGELOG.md"
+}

data/.rspec

@@ -1,2 +1,7 @@
 --require spec_helper
 --color
+--format documentation
+--format RspecJunitFormatter
+--out rspec/rspec.xml
+--format RspecSonarqubeFormatter
+--out rspec/test-report.xml

data/.rubocop.yml

@@ -0,0 +1,43 @@
+---
+inherit_from: https://raw.githubusercontent.com/remove-bg/code-style/main/ruby/.rubocop.yml
+
+require:
+  - rubocop-performance
+  - rubocop-rspec
+  - rubocop-rake
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.1
+  Exclude:
+    - gemfiles/**/*
+    - vendor/bundle/**/*
+
+Layout/LineLength:
+  Max: 180
+
+Gemspec/DevelopmentDependencies:
+  EnforcedStyle: gemspec
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Bundler/OrderedGems:
+  Enabled: true
+
+RSpec/DescribeClass:
+  Exclude:
+    - spec/integration/*
+
+RSpec/ExampleLength:
+  Max: 25
+
+RSpec/MultipleExpectations:
+  Max: 10

data/Appraisals

@@ -1,17 +1,56 @@
-# Oldest supported Faraday version
-appraise "faraday-0-15" do
-  gem "faraday", "~> 0.15.0"
+# frozen_string_literal: true
+
+# Faraday 2.0
+appraise "faraday-2-0" do
+  gem "faraday", "~> 2.0.0"
+end
+
+# Faraday 2.1
+appraise "faraday-2-1" do
+  gem "faraday", "~> 2.1.0"
+end
+
+# Faraday 2.2
+appraise "faraday-2-2" do
+  gem "faraday", "~> 2.2.0"
+end
+
+# Faraday 2.3
+appraise "faraday-2-3" do
+  gem "faraday", "~> 2.3.0"
+end
+
+# Faraday 2.4
+appraise "faraday-2-4" do
+  gem "faraday", "~> 2.4.0"
+end
+
+# Faraday 2.5
+appraise "faraday-2-5" do
+  gem "faraday", "~> 2.5.0"
+end
+
+# Faraday 2.6
+appraise "faraday-2-6" do
+  gem "faraday", "~> 2.6.0"
+end
+
+# Faraday 2.7
+appraise "faraday-2-7" do
+  gem "faraday", "~> 2.7.0"
 end
 
-appraise "faraday-0-16" do
-  gem "faraday", "~> 0.16.0"
+# Faraday 2.8
+appraise "faraday-2-8" do
+  gem "faraday", "~> 2.8.0"
 end
 
-appraise "faraday-0-17" do
-  gem "faraday", "~> 0.17.0"
+# Faraday 2.9
+appraise "faraday-2-9" do
+  gem "faraday", "~> 2.9.0"
 end
 
-# Latest in Faraday 1.x series
-appraise "faraday-1-x" do
-  gem "faraday", "~> 1.0"
+# Latest in Faraday 2.x series
+appraise "faraday-2-x" do
+  gem "faraday", "~> 2", "< 3"
 end

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.0.0
+
+- Deprecate `overwrite: true` in favour of `save!` and `save_zip!`
+- Remove support for Ruby 2.5, 2.6, 2.7 and 3.0 which are EOL
+- Deprecate Faraday < 2, add support for all Faraday 2.x versions
+- Increase default timeout to 20 seconds
+
+## 1.5.0
+
+- Auto-detect any available image processing libraries
+- Reduce bandwidth usage by using ZIP format where possible
+
 ## 1.4.1
 
 - Fixes binary encoding issue - via [#15](https://github.com/remove-bg/ruby/pull/15)

data/Gemfile

@@ -1,7 +1,4 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
+source "https://rubygems.org"
 gemspec
-
-group :development do
-  gem "appraisal", git: "https://github.com/thoughtbot/appraisal.git", ref: "5868643"
-end