bidi2pdf-rails 0.0.1.pre.alpha → 0.1.0

data/spec/dummy/tmp/pids/server.pid

@@ -1 +1 @@
-61431
+37830

data/spec/integration/generators/bidi2pdf_rails/initializer_generator_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "rails_helper"
+require "rails/generators"
+require "ammeter/init"
+require "generators/bidi2pdf_rails/initializer_generator"
+
+RSpec.describe Bidi2pdfRails::InitializerGenerator, type: :generator do
+  destination tmp_file("generators")
+
+  before { prepare_destination }
+
+  after { FileUtils.rm_rf(destination_root) }
+
+  describe 'the generated files' do
+    let(:dev_env_file) { file('config/environments/development.rb') }
+
+    before do
+      FileUtils.mkdir_p dev_env_file.dirname
+
+      # write minimal development.rb file
+      File.write(dev_env_file, <<~RUBY)
+        Rails.application.configure do
+
+        end
+
+      RUBY
+
+      run_generator %w[
+      --general-verbosity medium
+      --proxy-addr=127.0.0.1
+      --proxy-port=8080
+      --quiet
+    ]
+    end
+
+    describe 'the initializer file' do
+      subject(:initializer) { file('config/initializers/bidi2pdf_rails.rb') }
+
+      it { is_expected.to be_readable }
+      it { is_expected.to have_correct_syntax }
+
+      Bidi2pdfRails::Config::CONFIG_OPTIONS.each_pair do |group_key, top_level_option|
+        name = top_level_option[:name]
+        it { is_expected.to contain(name) }
+
+        top_level_option[:options].each do |option|
+          option_accessor = "#{group_key}.#{option[:name]}".to_sym
+          if ["proxy_settings.port", "proxy_settings.addr", "general_options.verbosity"].include?(option_accessor.to_s)
+            it { is_expected.to contain("config.#{option_accessor} = ") }
+          else
+            it { is_expected.to contain("# config.#{option_accessor} = #{option[:default_as_str] ? option[:default_as_str] : option[:default].inspect}") }
+          end
+        end
+      end
+    end
+
+    describe 'the development environment file' do
+      subject(:dev_env_file) { file('config/environments/development.rb') }
+
+      it { is_expected.to contain("config.x.bidi2pdf_rails.headless = false") }
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -1,5 +1,5 @@
 # This file is copied to spec/ when you run 'rails generate rspec:install'
-require './spec_helper'
+require 'spec_helper'
 
 ENV['RAILS_ENV'] ||= 'test'
 require_relative './dummy/config/environment'
@@ -57,4 +57,11 @@ RSpec.configure do |config|
   config.filter_rails_from_backtrace!
   # arbitrary gems may also be filtered via:
   # config.filter_gems_from_backtrace("gem name")
+
+  config.alias_example_group_to :feature, feature: true
+  config.alias_example_group_to :when_, feature: true
+  config.alias_example_group_to :given, feature: true
+  config.alias_example_group_to :scenario, feature: true
+  config.alias_example_to :then_, feature: true
+  config.alias_example_to :and_, feature: true
 end

data/spec/spec_helper.rb

@@ -1,3 +1,29 @@
+require "simplecov"
+
+if ENV["COVERAGE"]
+  SimpleCov.start do
+    command_name "Job #{ENV["GITHUB_JOB"]}" if ENV["GITHUB_JOB"]
+
+    if ENV["CI"]
+      formatter SimpleCov::Formatter::SimpleFormatter
+    else
+      formatter SimpleCov::Formatter::MultiFormatter.new([
+                                                           SimpleCov::Formatter::SimpleFormatter,
+                                                           SimpleCov::Formatter::HTMLFormatter
+                                                         ])
+    end
+
+    add_filter "/spec/"
+    add_filter "/vendor/"
+    add_filter "/lib/bidi2pdf_rails/version.rb"
+    # Add any other paths you want to exclude
+
+    add_group "Lib", "lib"
+
+    track_files "lib/**/*.rb"
+  end
+end
+
 # This file was generated by the `rails generate rspec:install` 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
@@ -44,9 +70,6 @@ RSpec.configure do |config|
   # 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
@@ -57,7 +80,7 @@ RSpec.configure do |config|
   # 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"
+  config.example_status_persistence_file_path = ".rspec_status"
 
   # Limits the available syntax to the non-monkey patched syntax that is
   # recommended. For more details, see:
@@ -90,5 +113,24 @@ RSpec.configure do |config|
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand config.seed
-=end
+
+  config.define_derived_metadata(file_path: %r{/spec/unit/}) do |metadata|
+    metadata[:unit] = true
+  end
+
+  config.define_derived_metadata(file_path: %r{/spec/integration/}) do |metadata|
+    metadata[:integration] = true
+  end
+
+  config.define_derived_metadata(file_path: %r{/spec/acceptance/}) do |metadata|
+    metadata[:acceptance] = true
+  end
+
+  config.add_setting :spec_dir, default: File.expand_path(__dir__)
 end
+
+require_relative "support/default_dirs_helper" # just to ensure that the folder definitions are loaded first
+
+Dir[File.expand_path("support/**/*.rb", __dir__)].each { |f| require f }
+
+require "bidi2pdf/test_helpers"

data/spec/support/default_dirs_helper.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "securerandom"
+module DefaultDirsHelper
+  def spec_dir
+    RSpec.configuration.spec_dir
+  end
+
+  def tmp_dir
+    RSpec.configuration.tmp_dir
+  end
+
+  def tmp_file(*)
+    File.join(tmp_dir, *)
+  end
+
+  def random_tmp_dir(*dirs, prefix: "tmp_")
+    all_dirs = [tmp_dir] + (dirs || []).compact
+
+    File.join(*all_dirs, "#{prefix}#{SecureRandom.hex(8)}")
+  end
+end
+
+RSpec.configure do |config|
+  config.add_setting :spec_dir, default: File.expand_path("..", __dir__)
+
+  config.add_setting :tmp_dir, default: File.join(config.spec_dir, "..", "tmp")
+  config.add_setting :docker_dir, default: File.join(config.spec_dir, "..", "docker")
+
+  config.include DefaultDirsHelper
+  config.extend DefaultDirsHelper
+end

data/spec/support/pdf_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module PdfHelper
+  def get_pdf_response(path)
+    uri = URI("http://localhost:#{@port}#{path}")
+    Net::HTTP.get_response(uri)
+  end
+end
+
+RSpec.configure do |config|
+  config.include PdfHelper, pdf: true
+end

data/spec/support/render_setting_helpers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+#
+module RenderSettingHelpers
+  def with_render_setting(key, value)
+    overridden_render_settings[key] = Bidi2pdfRails.config.render_remote_settings.public_send(key)
+    Bidi2pdfRails.config.render_remote_settings.public_send("#{key}=", value)
+  end
+
+  def overridden_render_settings
+    @__overridden_render_settings ||= {}
+  end
+
+  def reset_render_settings
+    overridden_render_settings.each do |key, original_value|
+      Bidi2pdfRails.config.render_remote_settings.public_send("#{key}=", original_value)
+    end
+    @__overridden_render_settings = {}
+  end
+end
+
+RSpec.configure do |config|
+  config.include RenderSettingHelpers, type: :request
+
+  config.after(:each, type: :request) do
+    reset_render_settings if defined?(reset_render_settings)
+  end
+end

data/spec/support/request_server_bootstrap.rb

@@ -0,0 +1,44 @@
+# spec/support/request_server_bootstrap.rb
+
+module RequestServerBootstrap
+  def find_available_port
+    server = TCPServer.new('127.0.0.1', 0)
+    port = server.addr[1]
+    server.close
+    port
+  end
+
+  def wait_until_server_is_ready(port)
+    loop do
+      begin
+        Net::HTTP.get(URI("http://localhost:#{port}"))
+        break
+      rescue Errno::ECONNREFUSED
+        sleep 0.1
+      end
+    end
+  end
+
+  def capybara_manages_server?
+    defined?(Capybara) && Capybara.current_driver && Capybara.server
+  end
+end
+
+RSpec.configure do |config|
+  config.include RequestServerBootstrap, type: :request
+
+  config.before(:all, type: :request) do
+    next if capybara_manages_server?
+    @port = find_available_port
+    @server_thread = Thread.new do
+      Rack::Handler::Puma.run Rails.application, Port: @port, Silent: true
+    end
+
+    wait_until_server_is_ready(@port)
+  end
+
+  config.after(:all, type: :request) do
+    next if capybara_manages_server?
+    @server_thread&.exit
+  end
+end

data/spec/{bidi2pdf_rails → unit/bidi2pdf_rails}/bidi2pdf_rails_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../rails_helper"
+require_relative "../../rails_helper"
 
 RSpec.describe Bidi2pdfRails do
   it "has a version number" do

data/spec/unit/bidi2pdf_rails/configurable/base_nested_config_spec.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe Bidi2pdfRails::Configurable::BaseNestedConfig do
+  subject(:config) { described_class.new(option_definitions) }
+
+  let(:option_definitions) { self.class.option_definitions }
+
+  def self.option_definitions
+    [
+      { name: :simple_string, default: "default_string", desc: "A simple string option" },
+      { name: :numeric_value, default: 42, desc: "A numeric value" },
+      { name: :boolean_flag, default: true, desc: "A boolean flag" },
+      { name: :lambda_value, default: -> { Date.today }, desc: "A dynamic value from lambda" },
+      { name: :hash_value, default: { key: "value" }, desc: "A hash value" }
+    ]
+  end
+
+  describe "#initialize" do
+    option_definitions.each do |opt|
+      it "creates reader methods for #{opt[:name]}" do
+        expect(config).to respond_to(opt[:name])
+      end
+
+      it "creates writer methods for #{opt[:name]}" do
+        expect(config).to respond_to("#{opt[:name]}=")
+      end
+
+      if !opt[:default].is_a?(Proc)
+        it "sets default values for #{opt[:name]}" do
+          expect(config.send(opt[:name])).to eq(opt[:default])
+        end
+      end
+    end
+
+    it "evaluates lambda defaults when accessed through _value methods" do
+      expect(config.lambda_value_value).to eq(Date.today)
+    end
+  end
+
+  describe "#reset_to_defaults!" do
+    before do
+      config.simple_string = "changed_value"
+      config.numeric_value = 100
+      config.boolean_flag = false
+    end
+
+    option_definitions.reject { |opt| opt[:name] == :lambda_value }.each do |opt|
+      it "resets #{opt[:name]} to their default" do
+        config.reset_to_defaults!
+
+        expect(config.send(opt[:name])).to eq(opt[:default])
+      end
+    end
+  end
+
+  describe "#configure" do
+    it "yields self to the provided block" do
+      yielded_object = nil
+
+      config.configure do |c|
+        yielded_object = c
+        c.simple_string = "configured_value"
+      end
+
+      expect(yielded_object).to eq(config)
+    end
+
+    it "applies the given values" do
+      config.configure do |c|
+        c.simple_string = "configured_value"
+      end
+
+      expect(config.simple_string).to eq("configured_value")
+    end
+  end
+
+  describe "#to_h" do
+    it "returns a hash containing all option values" do
+      result = config.to_h
+
+      expect(result).to include(
+                          simple_string: "default_string",
+                          numeric_value: 42,
+                          boolean_flag: true,
+                          lambda_value: Proc,
+                          boolean_flag: true,
+                          hash_value: { key: "value" }
+                        )
+    end
+  end
+
+  describe "#_value methods" do
+    context "with regular values" do
+      option_definitions.reject { |opt| opt[:name] == :lambda_value }.each do |opt|
+        it "returns the value directly for #{opt[:name]}" do
+          expect(config.send "#{opt[:name]}_value").to eq(config.send(opt[:name]))
+        end
+
+        it "returns updated values for #{opt[:name]}" do
+          config.send "#{opt[:name]}=", "new_string"
+
+          expect(config.send(opt[:name])).to eq("new_string")
+        end
+      end
+    end
+
+    context "with lambda values" do
+      it "calls the lambda and returns its result" do
+        today = Date.today
+        expect(config.lambda_value_value).to eq(today)
+      end
+
+      it "returns updated values" do
+        config.lambda_value = -> { "computed_value" }
+
+        expect(config.lambda_value_value).to eq("computed_value")
+      end
+
+      it "accepts arguments for the _value methods" do
+        args = nil
+        config.lambda_value = ->(*lambda_args) { args = lambda_args }
+
+        provided_args = [1, "a", :thing]
+
+        config.lambda_value_value(*provided_args)
+
+        expect(args).to eq(provided_args)
+      end
+    end
+  end
+end

data/tasks/changelog.rake

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+def cliff_installed?
+  system("which git-cliff > /dev/null 2>&1")
+end
+
+namespace :changelog do
+  desc "Generate unreleased section in CHANGELOG.md (requires git-cliff)"
+  task :update_unreleased do
+    unless cliff_installed?
+      puts "🚫 git-cliff is not installed!"
+      puts "👉 Install it here: https://git-cliff.org/docs/installation/"
+      exit 1
+    end
+
+    generated = `git cliff --unreleased`
+
+    changelog_path = "CHANGELOG.md"
+    changelog = File.read(changelog_path)
+
+    updated = changelog.sub(
+      /<!--.*generated\s+by\s+git-cliff\s+start\s+-->(.*?)<!--\s+generated\s+by\s+git-cliff\s+end\s+-->/m,
+      generated.strip
+    )
+
+    File.write(changelog_path, updated)
+    puts "✅ Replaced generated section in CHANGELOG.md"
+  end
+end

data/tasks/coverage.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+namespace :coverage do
+  desc "Merge simplecov coverage reports"
+  task :merge_reports do
+    require "simplecov"
+
+    SimpleCov.collate Dir["coverage/*-resultset.json"] do
+      formatter SimpleCov::Formatter::MultiFormatter.new([
+                                                           SimpleCov::Formatter::SimpleFormatter,
+                                                           SimpleCov::Formatter::HTMLFormatter,
+                                                           SimpleCov::Formatter::JSONFormatter
+                                                         ])
+    end
+  end
+
+  desc "Run tests with coverage"
+  task :coverage do
+    ENV["COVERAGE"] = "true"
+    Rake::Task["spec"].execute
+    puts "Coverage report generated in coverage/ directory"
+  end
+end