tarquinn 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 472e75e26a2d619f0284c9eb797c5e47f717a9f9a6e52757fc1c5ad7272a174f
-  data.tar.gz: efb31ef0021491a3b99c48cb8c3a34026493a10500636449195c1070d281dc91
+  metadata.gz: bedf2c09afd835b6b2b70a2f83a6f3e81c15822105b27a50f482bb81fbdd9d89
+  data.tar.gz: 7592837ef041e0b83e9ffa5cec438859cf7be9cc6c9d16819a50d6242d1ae27b
 SHA512:
-  metadata.gz: 9391c038495ea739fee48b43a9c104bcb0dfb887aa87ecb75be3d1378ee2c11649cc68725fd8beea215036065b5deb1aeca08babea956d77b42628b887ead261
-  data.tar.gz: 59ccde1cade0e2b76b82f89073409cf9ced274d7346214ae08f2d4e6f06e11269feb9b768c219064bcec0e748205c1ce6a5eb45515e21dbe404a53459cb6643b
+  metadata.gz: 998e736f046dee05cd716719d7bd6dd212840c3c6d4caaddf4178e3027ce9962a3ce9fc5ac4c9a480f0df8ebc7ac4c4dd689c58151ddf268f01ad1468b33fb19
+  data.tar.gz: 5175105a808ef43c98a54fc9b0a4e8831bef7bbe561b99db04f1a746bda0480cd871720173b61cf59505a47bc390b9567e655e2a2dccf7cac1d0e56dca1a2544

data/.circleci/config.yml

@@ -33,6 +33,9 @@ jobs:
       - run:
           name: RSpec
           command: bundle exec rspec
+      - run:
+          name: Upload coverage to Codacy
+          command: bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r coverage/lcov/project.lcov
   checks:
     docker:
       - image: darthjee/circleci_ruby_331:1.0.1

data/Gemfile

@@ -2,17 +2,18 @@
 
 source 'https://rubygems.org'
 
-gem 'bundler',     '~> 2.5.13'
-gem 'pry',         '~> 0.14.2'
-gem 'pry-nav',     '~> 1.0.0'
-gem 'rails',       '7.2.3'
-gem 'rake',        '~> 13.1.0'
-gem 'rspec',       '~> 3.12.0'
-gem 'rspec-rails', '6.1.1'
-gem 'rubycritic',  '4.9.1'
-gem 'simplecov',   '~> 0.22.0'
-gem 'sqlite3',     '1.4.2'
-gem 'yard',        '0.9.38'
-gem 'yardstick',   '0.9.9'
+gem 'bundler',        '~> 2.5.13'
+gem 'pry',            '~> 0.14.2'
+gem 'pry-nav',        '~> 1.0.0'
+gem 'rails',          '7.2.3'
+gem 'rake',           '~> 13.1.0'
+gem 'rspec',          '~> 3.12.0'
+gem 'rspec-rails',    '6.1.1'
+gem 'rubycritic',     '4.9.1'
+gem 'simplecov',      '~> 0.22.0'
+gem 'simplecov-lcov', '0.9.0'
+gem 'sqlite3',        '1.4.2'
+gem 'yard',           '0.9.38'
+gem 'yardstick',      '0.9.9'
 
 gemspec

data/README.md

@@ -1,7 +1,8 @@
 Tarquinn
 ========
 [![Build Status](https://circleci.com/gh/darthjee/tarquinn.svg?style=shield)](https://circleci.com/gh/darthjee/tarquinn)
-[![Code Climate](https://codeclimate.com/github/darthjee/tarquinn/badges/gpa.svg)](https://codeclimate.com/github/darthjee/tarquinn)
+[![Codacy Badge](https://app.codacy.com/project/badge/Grade/4e950bac9e434e8db64448da42e78793)](https://app.codacy.com/gh/darthjee/tarquinn/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/4e950bac9e434e8db64448da42e78793)](https://app.codacy.com/gh/darthjee/tarquinn/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 [![Gem Version](https://badge.fury.io/rb/tarquinn.svg)](https://badge.fury.io/rb/tarquinn)
 [![Inline docs](http://inch-ci.org/github/darthjee/tarquinn.svg)](http://inch-ci.org/github/darthjee/tarquinn)
 
@@ -9,13 +10,13 @@ Tarquinn
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/tarquinn/0.4.0](https://www.rubydoc.info/gems/tarquinn/0.4.0)
+[https://www.rubydoc.info/gems/tarquinn/0.5.0](https://www.rubydoc.info/gems/tarquinn/0.5.0)
 
 This gem makes easier to controll generic redirection
 
-Current Release: [0.4.0](https://github.com/darthjee/tarquinn/tree/0.4.0)
+Current Release: [0.5.0](https://github.com/darthjee/tarquinn/tree/0.5.0)
 
-Next Version [0.4.1](https://github.com/darthjee/tarquinn/compare/0.4.0...main)
+Next Version [0.5.1](https://github.com/darthjee/tarquinn/compare/0.45.0...main)
 
 Getting started
 ---------------
@@ -143,7 +144,9 @@ bundle exec rake verify_measurements
 
 You can specify a `domain` option in your `redirection_rule` to allow cross-domain redirection. When set, the redirection will be allowed to external hosts and the specified domain will be used for validation.
 
-**Example:**
+The `domain:` option accepts either a **String** (static domain) or a **Symbol** (dynamic domain resolved at runtime by calling the named method on the controller).
+
+**Static domain (String):**
 
 ```ruby
 class ExternalRedirectController < ApplicationController
@@ -161,5 +164,30 @@ class ExternalRedirectController < ApplicationController
 end
 ```
 
+**Dynamic domain (Symbol):**
+
+```ruby
+class ExternalRedirectController < ApplicationController
+  include Tarquinn
+
+  redirection_rule :redirect_external, domain: :current_domain do
+    params[:should_redirect]
+  end
+
+  private
+
+  def redirect_external
+    '/external_path'
+  end
+
+  def current_domain
+    # resolved at request time
+    request.subdomain == 'admin' ? 'admin.example.com' : 'example.com'
+  end
+end
+```
+
 - If `domain` is not set, redirection is only allowed for the same host.
-- If `domain` is set, redirection to the specified domain is allowed.
+- If `domain` is a String, it is used directly as the domain prefix.
+- If `domain` is a Symbol and the controller responds to that method, the method is called and its return value is used as the domain.
+- If `domain` is a Symbol but the controller does not respond to it, the Symbol's string representation is used as the domain.

data/lib/tarquinn/controller.rb

@@ -52,6 +52,23 @@ module Tarquinn
       controller.respond_to?(method, true)
     end
 
+    # Resolves a value that may reference a controller method
+    #
+    # If the value is a Symbol and the controller responds to it, calls the
+    # method and returns its result. Otherwise, returns the original value.
+    #
+    # @overload resolve_callable(method_name)
+    #   @param method_name [Symbol] method name
+    # @overload resolve_callable(value)
+    #   @param value [String] value to be returned
+    #
+    # @return [Object] resolved method return or original value
+    def resolve_callable(value)
+      return value unless value.is_a?(Symbol) && method?(value)
+
+      call(value)
+    end
+
     private
 
     # @api private

data/lib/tarquinn/redirection_config/options.rb

@@ -19,40 +19,19 @@ module Tarquinn
       # and not allowed for external hosts.
       #
       # if set, the redirection will be allowed for external
-      # hosts and the domain will be used for validation
+      # hosts and the domain will be used for validation.
+      # A Symbol value is resolved at runtime via the controller method.
       #
-      # @return [String, nil] the domain for cross-domain redirection
+      # @return [String, Symbol, nil] the domain for cross-domain redirection
       # @see RedirectionHandler#redirect
-      # @see #redirection_options
 
       # @method initialize(domain: nil)
       # @api private
       # Initializes a new Options object
-      # @param domain [String, nil] the domain for cross-domain redirection
+      # @param domain [String, Symbol, nil] the domain for cross-domain redirection.
+      #   A String is used as-is; a Symbol is resolved by calling the matching
+      #   method on the controller at runtime (via {Tarquinn::RedirectionHandler}).
       # @return [Tarquinn::RedirectionConfig::Options]
-
-      # Options to be passed for the controller on redirect_to
-      # @return [Hash] the options for the redirection
-      def redirection_options
-        {
-          allow_other_host:
-        }.compact
-      end
-
-      # Checks if the domain option is set
-      # @return [TrueClass] when the domain option is set
-      # @return [FalseClass] when the domain option is not set
-      def domain?
-        domain.present?
-      end
-
-      private
-
-      # Returns the value of the allow_other_host option
-      # @return [TrueClass, nil] the value of the allow_other_host option
-      def allow_other_host
-        domain? || nil
-      end
     end
   end
 end

data/lib/tarquinn/redirection_config.rb

@@ -76,16 +76,7 @@ module Tarquinn
       @skip_blocks ||= []
     end
 
-    delegate :redirection_options, :domain, :domain?, to: :options
-
-    # @method redirection_options
-    # @api private
-    # @private
-    #
-    # Options to be passed for the controller on redirect_to
-    #
-    # @return [Hash] the options for the redirection
-    # @see Tarquinn::RedirectionConfig::Options#redirection_options
+    delegate :domain, to: :options
 
     # @method domain
     # @api private
@@ -96,18 +87,11 @@ module Tarquinn
     # if not set, the redirection be for the same host
     # and not allowed for external hosts.
     # if set, the redirection will be allowed for external
-    # hosts and the domain will be used for validation
-    # @return [String, nil] the domain for cross-domain redirection
+    # hosts and the domain will be used for validation.
+    # A Symbol value is resolved at runtime via the controller method.
+    # @return [String, Symbol, nil] the domain for cross-domain redirection
     # @see Tarquinn::RedirectionConfig::Options#domain
 
-    # @method domain?
-    # @api private
-    # @private
-    # Checks if the domain option is set
-    # @return [TrueClass] when the domain option is set
-    # @return [FalseClass] when the domain option is not set
-    # @see Tarquinn::RedirectionConfig::Options#domain?
-
     private
 
     # @api private

data/lib/tarquinn/redirection_handler.rb

@@ -33,14 +33,12 @@ module Tarquinn
       controller.call(:redirect_to, redirect_full_path, **redirection_options)
     end
 
-    delegate :redirection_options, to: :config
-
-    # @method redirection_options
-    # @api private
-    # @private
-    # Options to be passed for the controller on {Tarquinn::Controller#call}(:redirect_to)
-    # @return (see Tarquinn::RedirectionConfig::Options#redirection_options)
-    # @see Tarquinn::RedirectionConfig::Options#redirection_options
+    # Options to be passed for the controller on redirect_to
+    #
+    # @return [Hash] the options for the redirection
+    def redirection_options
+      { allow_other_host: }.compact
+    end
 
     private
 
@@ -68,42 +66,64 @@ module Tarquinn
     # @return [Boolean]
     attr_reader :perform_redirect
 
-    delegate :redirection_blocks, :domain, :domain?, :skip_blocks, to: :config
+    delegate :redirection_blocks, :skip_blocks, to: :config
+    delegate :domain, to: :config, prefix: true
+
+    # @method config_domain
+    # @api private
+    # @private
+    # The configured domain for cross-domain redirection
+    # @return [String, Symbol, nil] the configured domain for cross-domain redirection
 
     # @method redirection_blocks
     # @api private
     # @private
-    # Options to be passed for the controller on redirect_to
+    # All blocks that indicate a redirection
     # @return [Array<Tarquinn::Condition>] all blocks that indicate a redirection
-    # @see Tarquinn::RedirectionConfig::Options#redirection_options
 
-    # @method domain
+    # @method skip_blocks
+    # @api private
+    # @private
+    # All blocks that indicate a redirection should be skipped
+    # @return (see Tarquinn::RedirectionConfig#skip_blocks)
+    # @see Tarquinn::RedirectionConfig#skip_blocks
+
     # @api private
     # @private
     #
-    # The domain when a redirection is cross-domain
+    # Resolves the domain for cross-domain redirection
     #
-    # if not set, the redirection be for the same host
-    # and not allowed for external hosts.
-    # if set, the redirection will be allowed for external
-    # hosts and the domain will be used for validation
-    # @return [String, nil] the domain for cross-domain redirection
-    # @see Tarquinn::RedirectionConfig::Options#domain
+    # When the configured domain is a Symbol and the controller responds to
+    # that method, the method is called and its return value is used.
+    # Otherwise, the configured value is returned as-is (a String is used
+    # directly; a Symbol that the controller does not respond to is converted
+    # to a String via `#to_s`).
+    #
+    # @return [String, nil] the resolved domain
+    def domain
+      controller.resolve_callable(config_domain).to_s.presence
+    end
 
-    # @method domain?
     # @api private
     # @private
-    # Checks if the domain option is set
-    # @return [TrueClass] when the domain option is set
-    # @return [FalseClass] when the domain option is not set
-    # @see Tarquinn::RedirectionConfig::Options#domain?
+    #
+    # Checks if the resolved domain is set
+    #
+    # @return [TrueClass] when the domain is set
+    # @return [FalseClass] when the domain is not set
+    def domain?
+      domain.present?
+    end
 
-    # @method skip_blocks
     # @api private
     # @private
-    # All blocks that indicate a redirection should be skipped
-    # @return (see Tarquinn::RedirectionConfig#skip_blocks)
-    # @see Tarquinn::RedirectionConfig#skip_blocks
+    #
+    # Returns the value of the allow_other_host option
+    #
+    # @return [TrueClass, nil] the value of the allow_other_host option
+    def allow_other_host
+      domain? || nil
+    end
 
     # @api private
     # @private
@@ -134,9 +154,7 @@ module Tarquinn
     #
     # @return [String]
     def redirect_path
-      return redirect_method unless controller.method?(redirect_method)
-
-      controller.call redirect_method
+      controller.resolve_callable(redirect_method)
     end
 
     # @api private

data/lib/tarquinn/version.rb

@@ -4,5 +4,5 @@ module Tarquinn
   # @api public
   #
   # Current version of the Tarquinn gem
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/spec/dummy/app/controllers/tarquinn/dummy_controller.rb

@@ -39,5 +39,9 @@ module Tarquinn
     def should_skip_redirect?
       false
     end
+
+    def dynamic_domain
+      'dynamic.example.com'
+    end
   end
 end

data/spec/lib/tarquinn/controller_spec.rb

@@ -109,4 +109,24 @@ describe Tarquinn::Controller do
       end
     end
   end
+
+  describe '#resolve_callable' do
+    context 'when value is a symbol and method exists' do
+      it 'returns method call result' do
+        expect(subject.resolve_callable(:redirection_path)).to eq('/path')
+      end
+    end
+
+    context 'when value is a symbol and method does not exist' do
+      it 'returns the original symbol' do
+        expect(subject.resolve_callable(:non_existing)).to eq(:non_existing)
+      end
+    end
+
+    context 'when value is not a symbol' do
+      it 'returns the original value' do
+        expect(subject.resolve_callable('redirection_path')).to eq('redirection_path')
+      end
+    end
+  end
 end

data/spec/lib/tarquinn/redirection_config/options_spec.rb

@@ -3,42 +3,28 @@
 require 'spec_helper'
 
 RSpec.describe Tarquinn::RedirectionConfig::Options do
-  describe '#redirection_options' do
-    subject(:redirection_options) { options.redirection_options }
-
+  describe '#domain' do
     context 'when domain is not set' do
       subject(:options) { described_class.new }
 
-      it 'returns an empty hash' do
-        expect(redirection_options).to eq({})
+      it 'returns nil' do
+        expect(options.domain).to be_nil
       end
     end
 
-    context 'when domain is set' do
+    context 'when domain is set to a string' do
       subject(:options) { described_class.new(domain: 'example.com') }
 
-      it 'returns allow_other_host: true' do
-        expect(redirection_options).to eq({ allow_other_host: true })
-      end
-    end
-  end
-
-  describe '#domain?' do
-    subject(:options) { described_class.new(domain: domain_value) }
-
-    context 'when domain is not set' do
-      let(:domain_value) { nil }
-
-      it 'returns false' do
-        expect(options.domain?).to be false
+      it 'returns the configured string' do
+        expect(options.domain).to eq('example.com')
       end
     end
 
-    context 'when domain is set' do
-      let(:domain_value) { 'example.com' }
+    context 'when domain is set to a symbol' do
+      subject(:options) { described_class.new(domain: :some_domain_method) }
 
-      it 'returns true' do
-        expect(options.domain?).to be true
+      it 'returns the configured symbol' do
+        expect(options.domain).to eq(:some_domain_method)
       end
     end
   end

data/spec/lib/tarquinn/redirection_handler_spec.rb

@@ -138,8 +138,43 @@ describe Tarquinn::RedirectionHandler do
           )
         end
 
-        it 'calls for redirection using full path' do
+        it 'calls for redirection using full path with allow_other_host' do
           subject.redirect
+
+          expect(controller).to have_received(:redirect_to)
+            .with('example.com/path', allow_other_host: true)
+        end
+      end
+
+      context 'when configured with a symbol domain that the controller responds to' do
+        let(:config) do
+          Tarquinn::RedirectionConfig.new(
+            redirection: :redirection_path,
+            domain: :dynamic_domain
+          )
+        end
+
+        it 'resolves the domain by calling the controller method' do
+          subject.redirect
+
+          expect(controller).to have_received(:redirect_to)
+            .with('dynamic.example.com/path', allow_other_host: true)
+        end
+      end
+
+      context 'when configured with a symbol domain that the controller does not respond to' do
+        let(:config) do
+          Tarquinn::RedirectionConfig.new(
+            redirection: :redirection_path,
+            domain: :unknown_domain_method
+          )
+        end
+
+        it 'treats the symbol as a static domain string' do
+          subject.redirect
+
+          expect(controller).to have_received(:redirect_to)
+            .with('unknown_domain_method/path', allow_other_host: true)
         end
       end
     end

data/spec/lib/tarquinn_spec.rb

@@ -125,6 +125,36 @@ describe Tarquinn, type: :controller do
         end
       end
     end
+
+    context 'when passing domain option as a symbol' do
+      controller(Tarquinn::DummyRouteController) do
+        redirection_rule :redirection, domain: :dynamic_domain do
+          params[:should_redirect]
+        end
+
+        def dynamic_domain
+          'dynamic.example.com'
+        end
+      end
+
+      before { get :index, params: parameters }
+
+      context 'when request indicates a redirection' do
+        let(:parameters) { { should_redirect: true } }
+
+        it 'performs a redirect using the value returned by the domain method' do
+          expect(response).to redirect_to('dynamic.example.com/path')
+        end
+      end
+
+      context 'when request does not indicate a redirection' do
+        let(:parameters) { {} }
+
+        it 'does not perform a redirect' do
+          expect(response).not_to redirect_to('/path')
+        end
+      end
+    end
   end
 
   describe '.skip_redirection' do

data/spec/spec_helper.rb

@@ -2,6 +2,12 @@
 
 require 'simplecov'
 
+if ENV['CI']
+  require 'simplecov-lcov'
+  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
+  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
+end
+
 SimpleCov.start do
   add_filter '/spec/'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tarquinn
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2026-02-27 00:00:00.000000000 Z
+date: 2026-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport