diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..c4a5586 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,41 @@ + +name: is_dark + +on: [push, pull_request] + +jobs: + test: + strategy: + matrix: + os: ['ubuntu-20.04'] + ruby: + - 3.0 + - 3.1 + - 3.2 + - 3.3 + - head + + runs-on: ${{ matrix.os }} + continue-on-error: true + + steps: + - name: Change ImageMagick policy to allow pdf->png conversion. + run: sudo sed -i 's/^.*policy.*coder.*none.*PDF.*//' /etc/ImageMagick-6/policy.xml + + - name: Install Ghostscript + run: sudo apt-get install -y ghostscript + + - uses: actions/checkout@v4 + + - uses: ruby/setup-ruby@v1 + with: + ruby-version: ${{ matrix.ruby }} + + - name: Install dependencies + run: bundle install + + - name: Display Ruby version + run: ruby -v + + - name: Test + run: bundle exec rspec diff --git a/.rspec b/.rspec new file mode 100644 index 0000000..c99d2e7 --- /dev/null +++ b/.rspec @@ -0,0 +1 @@ +--require spec_helper diff --git a/Gemfile b/Gemfile index 7fcf3c2..6c5845c 100644 --- a/Gemfile +++ b/Gemfile @@ -2,5 +2,8 @@ source "https://rubygems.org" git_source(:github) { |repo| "https://github.com/butteff/is_dark_ruby_gem.git" } gem "rmagick" -gem "rspec" -gem "minitest" \ No newline at end of file + +group :development, :test do + gem "rspec" + gem "minitest" +end diff --git a/is_dark.gemspec b/is_dark.gemspec index 8544193..2016483 100644 --- a/is_dark.gemspec +++ b/is_dark.gemspec @@ -12,5 +12,6 @@ Gem::Specification.new do |s| s.metadata = { "source_code_uri" => "https://github.com/butteff/is_dark_ruby_gem" } s.required_ruby_version = '>= 2.7.0' s.add_dependency 'rmagick', '~> 5.2' - #s.add_development_dependency 'rmagick', '~> 5.2' -end \ No newline at end of file + s.add_development_dependency 'rspec', "~> 3.13" + s.add_development_dependency 'minitest', "~> 5.16" +end diff --git a/spec/test_is_dark.rb b/spec/lib/is_dark_spec.rb similarity index 94% rename from spec/test_is_dark.rb rename to spec/lib/is_dark_spec.rb index 7fb9422..d6c4c22 100644 --- a/spec/test_is_dark.rb +++ b/spec/lib/is_dark_spec.rb @@ -1,28 +1,28 @@ -require "rspec" require "rmagick" -require "../lib/is_dark.rb" +require 'spec_helper' +require_relative '../../lib/is_dark' -TEST_FILE_PATH = '../color_card.pdf' +TEST_FILE_PATH = 'color_card.pdf' describe IsDark do - + describe ".color" do context "dark colors tests" do it "this color #000000 is dark, returns true" do expect(IsDark.color('#000000')).to eq(true) end - + it "this color #111111 is dark, returns true" do expect(IsDark.color('#111111')).to eq(true) end it "this color #102694 is dark, returns true" do expect(IsDark.color('#102694')).to eq(true) - end + end it "this color #ff2e17 is dark, returns true" do expect(IsDark.color('#800f03')).to eq(true) - end + end end context "not dark colors tests" do @@ -50,15 +50,15 @@ x = 120 y = 120 expect(IsDark.magick_pixel_from_blob(x, y, TEST_FILE_PATH)).to eq(true) - end - end + end + end context "test not dark pixel" do it "this pixel is not dark, returns false" do x = 720 y = 120 expect(IsDark.magick_pixel_from_blob(x, y, TEST_FILE_PATH)).to eq(false) - end + end end end @@ -68,22 +68,22 @@ image = Magick::Image.read(TEST_FILE_PATH).first pix = image.pixel_color(80, 320) expect(IsDark.magick_pixel(pix)).to eq(true) - end - end + end + end context "test not dark pixel" do it "this pixel is not dark, returns false" do image = Magick::Image.read(TEST_FILE_PATH).first pix = image.pixel_color(720, 120) expect(IsDark.magick_pixel(pix)).to eq(false) - end + end end end describe ".magick_area_from_blob" do context "test dark area" do it "this area is dark, returns true" do - x = 120 #coordinate of a left corner of the area's rectangle X + x = 120 #coordinate of a left corner of the area's rectangle X y = 120 #coordinate of a left corner of the area's rectangle Y cf_height = 64 #height of the area's rectangle cf_width = 128 #height of the area's rectangle @@ -91,12 +91,12 @@ matrix = (1..10) #matrix of dots. Range of matrix to build dots 1..10 - means 10x10 with_not_detected = false #Sometimes Imagick can't detect a pixel or it has no color, so it detects it as (RGB: 0,0,0), the gem has an option to consider pixels like this as "white", but if you need to disable this option add true or false expect(IsDark.magick_area_from_blob(x, y, TEST_FILE_PATH, cf_height, cf_width, percent, matrix, with_not_detected)).to eq(false) - end - end + end + end context "test bright area" do it "this area is not dark, returns false" do - x = 720 #coordinate of a left corner of the area's rectangle X + x = 720 #coordinate of a left corner of the area's rectangle X y = 120 #coordinate of a left corner of the area's rectangle Y cf_height = 64 #height of the area's rectangle cf_width = 128 #height of the area's rectangle @@ -104,12 +104,12 @@ matrix = (1..10) #matrix of dots. Range of matrix to build dots 1..10 - means 10x10 with_not_detected = false #Sometimes Imagick can't detect a pixel or it has no color, so it detects it as (RGB: 0,0,0), the gem has an option to consider pixels like this as "white", but if you need to disable this option add true or false expect(IsDark.magick_area_from_blob(x, y, TEST_FILE_PATH, cf_height, cf_width, percent, matrix, with_not_detected)).to eq(false) - end - end + end + end context "test debug output" do it "test area with logs and debug file" do - x = 120 #coordinate of a left corner of the area's rectangle X + x = 120 #coordinate of a left corner of the area's rectangle X y = 120 #coordinate of a left corner of the area's rectangle Y cf_height = 64 #height of the area's rectangle cf_width = 128 #height of the area's rectangle @@ -118,8 +118,8 @@ with_not_detected = false #Sometimes Imagick can't detect a pixel or it has no color, so it detects it as (RGB: 0,0,0), the gem has an option to consider pixels like this as "white", but if you need to disable this option add true or false IsDark.set_debug_data(true, './is_dark_debug_output.pdf') expect(IsDark.magick_area_from_blob(x, y, TEST_FILE_PATH, cf_height, cf_width, percent, matrix, with_not_detected)).to eq(false) - end - end + end + end end -end \ No newline at end of file +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb new file mode 100644 index 0000000..7388169 --- /dev/null +++ b/spec/spec_helper.rb @@ -0,0 +1,92 @@ + +# This file was generated by the `rspec --init` command. Conventionally, all +# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`. +# The generated `.rspec` file contains `--require spec_helper` which will cause +# this file to always be loaded, without a need to explicitly require it in any +# files. +# +# Given that it is always loaded, you are encouraged to keep this file as +# light-weight as possible. Requiring heavyweight dependencies from this file +# will add to the boot time of your test suite on EVERY test run, even for an +# individual file that may not need all of that loaded. Instead, consider making +# a separate helper file that requires the additional dependencies and performs +# the additional setup, and require it from the spec files that actually need +# it. +# +# See https://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration +RSpec.configure do |config| + # rspec-expectations config goes here. You can use an alternate + # assertion/expectation library such as wrong or the stdlib/minitest + # assertions if you prefer. + config.expect_with :rspec do |expectations| + # This option will default to `true` in RSpec 4. It makes the `description` + # and `failure_message` of custom matchers include text for helper methods + # defined using `chain`, e.g.: + # be_bigger_than(2).and_smaller_than(4).description + # # => "be bigger than 2 and smaller than 4" + # ...rather than: + # # => "be bigger than 2" + expectations.include_chain_clauses_in_custom_matcher_descriptions = true + end + + # rspec-mocks config goes here. You can use an alternate test double + # library (such as bogus or mocha) by changing the `mock_with` option here. + config.mock_with :rspec do |mocks| + # Prevents you from mocking or stubbing a method that does not exist on + # a real object. This is generally recommended, and will default to + # `true` in RSpec 4. + mocks.verify_partial_doubles = true + end + + # This option will default to `:apply_to_host_groups` in RSpec 4 (and will + # have no way to turn it off -- the option exists only for backwards + # compatibility in RSpec 3). It causes shared context metadata to be + # inherited by the metadata hash of host groups and examples, rather than + # triggering implicit auto-inclusion in groups with matching metadata. + config.shared_context_metadata_behavior = :apply_to_host_groups + +# The settings below are suggested to provide a good initial experience +# with RSpec, but feel free to customize to your heart's content. +=begin + # This allows you to limit a spec run to individual examples or groups + # you care about by tagging them with `:focus` metadata. When nothing + # is tagged with `:focus`, all examples get run. RSpec also provides + # aliases for `it`, `describe`, and `context` that include `:focus` + # metadata: `fit`, `fdescribe` and `fcontext`, respectively. + config.filter_run_when_matching :focus + # Allows RSpec to persist some state between runs in order to support + # the `--only-failures` and `--next-failure` CLI options. We recommend + # you configure your source control system to ignore this file. + config.example_status_persistence_file_path = "spec/examples.txt" + # Limits the available syntax to the non-monkey patched syntax that is + # recommended. For more details, see: + # https://rspec.info/features/3-12/rspec-core/configuration/zero-monkey-patching-mode/ + config.disable_monkey_patching! + # This setting enables warnings. It's recommended, but in some cases may + # be too noisy due to issues in dependencies. + config.warnings = true + # Many RSpec users commonly either run the entire suite or an individual + # file, and it's useful to allow more verbose output when running an + # individual spec file. + if config.files_to_run.one? + # Use the documentation formatter for detailed output, + # unless a formatter has already been configured + # (e.g. via a command-line flag). + config.default_formatter = "doc" + end + # Print the 10 slowest examples and example groups at the + # end of the spec run, to help surface which specs are running + # particularly slow. + config.profile_examples = 10 + # Run specs in random order to surface order dependencies. If you find an + # order dependency and want to debug it, you can fix the order by providing + # the seed, which is printed after each run. + # --seed 1234 + config.order = :random + # Seed global randomization in this process using the `--seed` CLI option. + # Setting this allows you to use `--seed` to deterministically reproduce + # test failures related to randomization by passing the same `--seed` value + # as the one that triggered the failure. + Kernel.srand config.seed +=end +end