convenient_service.gemspec

# frozen_string_literal: true

require_relative "lib/convenient_service/specification"
require_relative "lib/convenient_service/version"

require_relative "lib/convenient_service/dependencies/only_queries"

Gem::Specification.new do |spec|
  spec.name = ConvenientService::Specification::NAME
  spec.authors = ConvenientService::Specification::AUTHORS
  spec.email = ConvenientService::Specification::EMAIL
  spec.homepage = ConvenientService::Specification::HOMEPAGE
  spec.summary = ConvenientService::Specification::SUMMARY
  spec.description = ConvenientService::Specification::DESCRIPTION

  spec.version = ConvenientService::VERSION

  ##
  # Sets licence. See also `LICENSE.txt` and `COMM-LICENSE.txt` for more details.
  #
  # - https://guides.rubygems.org/specification-reference/#license=
  # - https://github.com/sidekiq/sidekiq/blob/main/sidekiq.gemspec
  # - https://github.com/rmosolgo/graphql-ruby/blob/master/graphql.gemspec
  # - https://github.com/thbar/kiba/blob/master/kiba.gemspec
  # - https://github.com/mbj/mutant/blob/main/mutant.gemspec
  # - https://github.com/github/licensed/tree/main?tab=readme-ov-file#disclaimer
  # - https://github.com/sergey-alekseev/bundler-licensed
  #
  spec.license = "LGPL-3.0"

  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")

  spec.metadata["homepage_uri"] = spec.homepage
  spec.metadata["source_code_uri"] = spec.homepage
  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"

  ##
  # Includes the minimal possible amount of files to the bundled Convenient Service version.
  #
  # NOTE: At the moment of writing this comment, Convenient Service weighed 170+ MB.
  # That was a problem in the space limited environments.
  #
  # NOTE: If you would like to play with Convenient Service specs, consider to `git clone` the gem.
  # - https://github.com/marian13/convenient_service
  #
  # NOTE: More thoughts on what should be included in the production version of a gem.
  # - https://github.com/rubocop/rubocop/blob/v1.60.1/rubocop.gemspec
  # - https://github.com/rails/rails/blob/v7.1.3/activerecord/activerecord.gemspec#L20
  # - https://github.com/mvz/gir_ffi/blob/master/gir_ffi.gemspec#L27
  # - https://github.com/payolapayments/payola/issues/292
  # - https://github.com/rubocop/rubocop/issues/1555
  #
  spec.files = ::Dir["COMM-LICENSE.txt", "LICENSE.txt", "README.md", "lib/**/*"] - ::Dir["lib/convenient_service/examples/**/*"]

  spec.require_paths = ["lib"]

  ##
  # Used for pretty printing when debugging Ruby code. `amazing_print` is `awesome_print` successor.
  # - https://github.com/amazing-print/amazing_print
  #
  spec.add_development_dependency "amazing_print", "~> 1.5.0"

  ##
  # Used to run specs with multiple versions of gems.
  # - https://github.com/thoughtbot/appraisal
  #
  spec.add_development_dependency "appraisal", "~> 2.5.0"

  ##
  # Used for pretty printing when debugging Ruby code. `awesome_print` is NOT maintained anymore.
  # - https://github.com/awesome-print/awesome_print
  #
  spec.add_development_dependency "awesome_print", "~> 1.9.2"

  ##
  # Used inside examples (internally by Active Model).
  # - https://github.com/ruby/base64
  #
  spec.add_development_dependency "base64"

  ##
  # Used for benchmarking (iteration per second). See `benchmark` directory.
  # - https://github.com/evanphx/benchmark-ips
  # - https://www.johnnunemaker.com/how-to-benchmark-your-ruby-gem
  #
  spec.add_development_dependency "benchmark-ips", "~> 2.12.0"

  ##
  # Used for benchmarking (memory allocation). See `benchmark` directory.
  # - https://github.com/michaelherold/benchmark-memory
  # - https://medium.com/swlh/benchmarking-in-ruby-86a6c28c1e97
  # - https://thoughtbot.com/blog/a-crash-course-in-analyzing-memory-usage-in-ruby
  #
  spec.add_development_dependency "benchmark-memory", "~> 0.2.0"

  ##
  # Used for debugging any Ruby code (CRuby, JRuby, etc), since it written in plain Ruby.
  # Has minimalistic interface.
  # Does NOT support frame filtering.
  # - https://github.com/gsamokovarov/break
  #
  spec.add_development_dependency "break"

  ##
  # Used for debugging CRuby code.
  # Check `debug` if you need frame filtering.
  # Check `break` if you need to debug JRuby.
  # - https://github.com/deivid-rodriguez/byebug
  #
  # NOTE: `byebug` has C extensions, that is why it is NOT supported in JRuby.
  # - https://github.com/deivid-rodriguez/byebug/tree/master/ext/byebug
  # - https://github.com/deivid-rodriguez/byebug/issues/179#issuecomment-152727003
  #
  spec.add_development_dependency "byebug", "~> 10.0" if ConvenientService::Dependencies.ruby.mri?

  ##
  # Used for parsing Markdown in YARD docs.
  # - https://github.com/gjtorikian/commonmarker
  #
  # NOTE: `commonmarker` has C extensions, that is why it is NOT supported in JRuby.
  # - https://github.com/gjtorikian/commonmarker/tree/main/ext/commonmarker
  #
  # TODO: `commonmarker` v1 does NOT work with `yard-junk`.
  #
  spec.add_development_dependency "commonmarker", "~> 0.23.10" if ConvenientService::Dependencies.ruby.mri?

  ##
  # Used for debugging CRuby code.
  # Has almost the same public API as `byebug`, but supports frame filtering.
  # Check `break` if you need to debug JRuby.
  # - https://github.com/ruby/debug
  # - https://st0012.dev/from-byebug-to-ruby-debug
  # - https://st0012.dev/from-byebug-to-ruby-debug#heading-configuration
  # - https://github.com/ruby/debug#configuration
  # - ENV["RUBY_DEBUG_SKIP_PATH"]
  #
  # NOTE: `debug` has C extensions, that is why it is NOT supported in JRuby.
  # - https://github.com/ruby/debug/tree/master/ext/debug
  #
  spec.add_development_dependency "debug" if ConvenientService::Dependencies.ruby.mri?

  ##
  # Used for finding diffs between strings. Useful in console or specs.
  # - https://github.com/samg/diffy
  #
  spec.add_development_dependency "diffy", "~> 3.4.0"

  spec.add_development_dependency "faker"

  ##
  # Used internally by `rerun`.
  #
  spec.add_development_dependency "ffi", "~> 1.16.0"

  spec.add_development_dependency "gem-release"

  ##
  # Used as console/playground with loaded Convenient Service.
  # - https://github.com/ruby/irb
  #
  spec.add_development_dependency "irb", "~> 1.13.1"

  spec.add_development_dependency "inch"

  spec.add_development_dependency "json"

  ##
  # Used for memory profiling of Ruby code.
  # - https://github.com/SamSaffron/memory_profiler
  # - https://thoughtbot.com/blog/a-crash-course-in-analyzing-memory-usage-in-ruby
  # - https://www.toptal.com/ruby/hunting-ruby-memory-issues
  #
  spec.add_development_dependency "memory_profiler"

  ##
  # Used for testing Ruby code outside RSpec.
  # - https://github.com/minitest/minitest
  # - https://semaphoreci.com/community/tutorials/getting-started-with-minitest
  # - https://cloudbees.com/blog/getting-started-with-minitest
  #
  spec.add_development_dependency "minitest", "~> 5.18.0"

  ##
  # Used for mutation testing of Ruby code.
  # - https://github.com/mbj/mutant
  # - https://github.com/mbj/mutant/blob/main/docs/nomenclature.md
  # - https://github.com/mbj/mutant/blob/main/docs/mutant-rspec.md
  # - https://github.com/mbj/mutant/blob/main/docs/incremental.md
  #
  # NOTE: How to get a licence key?
  # - https://github.com/mbj/mutant/issues/1396
  #
  if ::ENV["CONVENIENT_SERVICE_MUTANT_LICENCE_KEY"]
    spec.add_development_dependency "mutant", "~> 0.11.21"
    spec.add_development_dependency "mutant-rspec", "~> 0.11.21"
  end

  ##
  # Used inside examples (internally by Active Model).
  # - https://github.com/ruby/mutex_m
  #
  spec.add_development_dependency "mutex_m"

  ##
  # Used for coloring logs.
  # - https://github.com/janlelis/paint
  #
  spec.add_development_dependency "paint"

  spec.add_development_dependency "progressbar"

  ##
  # Used as console/playground with loaded Convenient Service.
  # - https://github.com/pry/pry
  #
  spec.add_development_dependency "pry", "~> 0.14.2"

  ##
  # Used as Ruby task runner.
  # - https://github.com/ruby/rake
  #
  spec.add_development_dependency "rake", "~> 12.3.3"

  spec.add_development_dependency "rerun"

  spec.add_development_dependency "rouge"

  ##
  # Used for testing Ruby code.
  # https://rspec.info
  #
  spec.add_development_dependency "rspec", "~> 3.11.0"

  ##
  # Used for performance testing with RSpec.
  # https://github.com/piotrmurach
  #
  spec.add_development_dependency "rspec-benchmark", "~> 0.6.0"

  ##
  # Used for linting Ruby files.
  # - https://github.com/rubocop/rubocop
  #
  spec.add_development_dependency "rubocop", "~> 1.61.0"

  ##
  # Used as a set of rules for rubocop for linting common performance issues in Ruby files.
  # - https://github.com/rubocop/rubocop-performance
  #
  # NOTE:
  #   `rubocop-performance` is automatically bundled with Standard.
  #    That is why it is NOT listed as a separate dependency for now.
  #   Once the need for a specific version becomes mandatory, the following line should be uncommented
  #
  # spec.add_development_dependency "rubocop-performance"
  ##

  ##
  # Used as a set of rules for rubocop for linting magic numbers in Ruby files.
  # - https://github.com/rubocop/rubocop-magic_numbers
  #
  spec.add_development_dependency "rubocop-magic_numbers", "~> 0.4.0"

  ##
  # Used as a set of rules for rubocop for linting RSpec files.
  # - https://github.com/rubocop/rubocop-rspec
  #
  spec.add_development_dependency "rubocop-rspec", "~> 2.27.0"

  ##
  # Used as a set of rules for rubocop for enforcing Ruby gem packaging best practices.
  # - https://github.com/utkarsh2102/rubocop-packaging
  #
  spec.add_development_dependency "rubocop-packaging", "~> 0.5.2"

  ##
  # Used as a set of rules for rubocop for linting common thread-safety issues in Ruby files.
  # - https://github.com/rubocop/rubocop-thread_safety
  #
  spec.add_development_dependency "rubocop-thread_safety", "~> 0.5.1"

  spec.add_development_dependency "tty-prompt"

  ##
  # Used as a set of rules for robocop for linting source files.
  # - https://github.com/testdouble/standard
  #
  spec.add_development_dependency "standard", "~> 1.34.0"

  spec.add_development_dependency "simplecov"

  spec.add_development_dependency "simplecov-lcov"

  ##
  # Used to have a simplified public API of minitest.
  # - https://github.com/thoughtbot/shoulda-context
  #
  spec.add_development_dependency "shoulda-context", "~> 2.0.0"

  ##
  # Used for benchmarking (call-stack profiler). See `benchmark` directory.
  # - https://github.com/tmm1/stackprof
  # - https://www.johnnunemaker.com/how-to-benchmark-your-ruby-gem
  #
  spec.add_development_dependency "stackprof", "~> 0.2.25" if ConvenientService::Dependencies.ruby.mri?

  ##
  # Used inside examples (internally by Webrick).
  # - https://github.com/ruby/uri
  #
  if ConvenientService::Dependencies.ruby.version >= 3.0
    spec.add_development_dependency "uri", "~> 0.13.0"
  else
    spec.add_development_dependency "uri", "0.10.0.2"
  end

  ##
  # Used inside examples.
  # - https://github.com/ruby/mutex_m
  #
  spec.add_development_dependency "webrick"

  ##
  # Used for generation of API docs for Ruby code.
  # - https://github.com/lsegal/yard
  # - https://yardoc.org
  #
  spec.add_development_dependency "yard", "~> 0.9.34"

  ##
  # Used for linting YARD docs.
  # - https://github.com/zverok/yard-junk
  #
  spec.add_development_dependency "yard-junk", "~> 0.0.9"

  ##
  # The following gems are Convenient Service alternatives.
  # Used for performance comparisons.
  # See `benchmark/empty_service`.
  # - https://github.com/sunny/actor
  # - https://github.com/collectiveidea/interactor
  # - https://github.com/trailblazer/trailblazer-operation
  # - https://github.com/AaronLasseigne/active_interaction
  # - https://github.com/adomokos/light-service
  # - https://github.com/cypriss/mutations
  #
  spec.add_development_dependency "service_actor", "~> 3.7.0"
  spec.add_development_dependency "interactor", "~> 3.1.2"
  spec.add_development_dependency "trailblazer-operation", "~> 0.10.1"
  spec.add_development_dependency "active_interaction", "~> 5.3.0"
  spec.add_development_dependency "light-service", "~> 0.18.0"
  spec.add_development_dependency "mutations", "~> 0.9.1"
end