tarquinn 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b942f4c6eef09e4a94c12a33da00f6c878ebeb30d348dc06dad7aa2274d635b9
-  data.tar.gz: b80da172aef6a2067b97444c53842bed6215afbbba5d885793376f8f8ff8f6a6
+  metadata.gz: 40a2cd722ae376e627aba7f4d4e10b69df45b74593d89dbafd68b9f6e4cb635a
+  data.tar.gz: 7c29d8a9763a3f0ae3e71945ea16b690628b0a3fef4f3603d891dbe791a4a0ca
 SHA512:
-  metadata.gz: cbb0a21142829270e9ac2590ff071ed5dfada57c2bf6ba116543b9c8c735eb88f8170a6550b3badbc56506dbae2dfc109f76c88c7e40efaa90c94a3b3bb61629
-  data.tar.gz: 1b7fe947a50f0ee13e0ef2cdd1842b18f19af51c347d494442f34abf2eb4195f5335fcbdec8794933465652af544fa463b8d3846a49ff4c12835d17ace565d03
+  metadata.gz: 5b63bfd5ba62e690b145bc4394e1913f28e5756b325b8301fb1b467d1386b282950095d36638ee407c2404e30d098a79de7868285a390b643fb2e84b275f16c6
+  data.tar.gz: '0286cd856bbaa74643cf9174952aff220ed75e3b81ff22f07c451b95bf226a78919ac8e306bbde78b9ab2f0577cd7b707bf4b0f4d25da69830b5340d58bfc5d9'

data/.circleci/config.yml

@@ -22,7 +22,7 @@ workflows:
 jobs:
   test:
     docker:
-      - image: darthjee/circleci_rails_gems:0.6.2
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: tarquinn
     steps:
@@ -41,7 +41,7 @@ jobs:
           command: cc-test-reporter after-build --exit-code $?
   checks:
     docker:
-      - image: darthjee/circleci_rails_gems:0.6.2
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: tarquinn
     steps:
@@ -49,12 +49,24 @@ jobs:
       - run:
           name: Bundle Install
           command: bundle install
+      - run:
+          name: Rubocop
+          command: rubocop
+      - run:
+          name: Yardstick coverage check
+          command: bundle exec rake verify_measurements
       - run:
           name: Check version documentation
           command: check_readme.sh
+      - run:
+          name: Rubycritcs check
+          command: rubycritic.sh
+      - run:
+          name: Check unit tests
+          command: check_specs
   build-and-release:
     docker:
-      - image: darthjee/circleci_rails_gems:0.6.2
+      - image: darthjee/circleci_ruby_331:1.0.1
         environment:
           PROJECT: tarquinn
     steps:

data/.gitignore

@@ -1,3 +1,12 @@
 /coverage
 /pkg
 Gemfile.lock
+**/*.swp
+**/*.swo
+spec/dummy/log/*
+spec/dummy/tmp/*
+**/*.sqlite3
+doc
+.yardoc
+measurement
+rubycritic

data/.rubocop.yml

@@ -0,0 +1,29 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 3.3
+  NewCops: enable
+
+Lint/BooleanSymbol:
+  Enabled: false
+
+Lint/EmptyBlock:
+  Exclude:
+    - spec/dummy/db/schema.rb
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/ScriptPermission:
+  Exclude:
+    - spec/dummy/bin/*
+
+Naming/BlockForwarding:
+  Enabled: false
+
+Style/ArgumentsForwarding:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-07-10 16:10:57 UTC using RuboCop version 1.59.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 9
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 87

data/Dockerfile

@@ -1,6 +1,6 @@
-FROM darthjee/scripts:0.1.8 as scripts
+FROM darthjee/scripts:0.4.2 as scripts
 
-FROM darthjee/rails_gems:0.6.2 as base
+FROM darthjee/ruby_331:1.0.1 as base
 
 COPY --chown=app:app ./ /home/app/app/
 

data/Gemfile

@@ -1,3 +1,18 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
+gem 'bundler',     '~> 2.5.13'
+gem 'pry',         '~> 0.14.2'
+gem 'pry-nav',     '~> 1.0.0'
+gem 'rails',       '7.0.4.3'
+gem 'rake',        '~> 13.1.0'
+gem 'rspec',       '~> 3.12.0'
+gem 'rspec-rails', '6.0.2'
+gem 'rubycritic', '4.9.1'
+gem 'simplecov', '~> 0.22.0'
+gem 'sqlite3', '1.4.2'
+gem 'yard', '0.9.36'
+gem 'yardstick', '0.9.9'
+
 gemspec

data/README.md

@@ -11,10 +11,14 @@ Tarquinn
 
 Yard Documentation
 -------------------
-[https://www.rubydoc.info/gems/tarquinn/0.2.0](https://www.rubydoc.info/gems/tarquinn/0.2.0)
+[https://www.rubydoc.info/gems/tarquinn/0.3.0](https://www.rubydoc.info/gems/tarquinn/0.3.0)
 
 This gem makes easier to controll generic redirection
 
+Current Release: [0.3.0](https://github.com/darthjee/tarquinn/tree/0.3.0)
+
+[Next release](https://github.com/darthjee/tarquinn/compare/0.3.0...master)
+
 Getting started
 ---------------
 1. Add Tarquinn to your `Gemfile` and `bundle install`:

data/Rakefile

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'yardstick/rake/measurement'
+require './config/yardstick'
+require './config/rubycritc'
 
 RSpec::Core::RakeTask.new
 

data/config/check_specs.yml

@@ -0,0 +1,3 @@
+ignore:
+  - lib/tarquinn/class_methods.rb
+  - lib/tarquinn/version.rb

data/config/rubycritc.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubycritic/rake_task'
+
+RubyCritic::RakeTask.new do |task|
+  options = %w[
+    --path rubycritic/
+    --no-browser
+  ]
+  task.options = options.join(' ')
+  task.paths   = %w[lib]
+end

data/config/yardstick.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
+require 'yaml'
+
+options = YAML.load_file('config/yardstick.yml')
+
+Yardstick::Rake::Measurement.new(:yardstick_measure, options) do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+Yardstick::Rake::Verify.new(:verify_measurements, options)

data/config/yardstick.yml

@@ -0,0 +1,33 @@
+threshold: 88.1
+require_exact_threshold: false
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: true
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []

data/lib/tarquinn/class_methods.rb

@@ -1,17 +1,48 @@
-module Tarquinn::ClassMethods
-  def skip_redirection(redirection, *actions)
-    redirector_builder.add_skip_action(redirection, *actions)
-  end
+# frozen_string_literal: true
 
-  def redirection_rule(redirection, *methods, &block)
-    redirector_builder.add_redirection_config(redirection, *methods, block)
-  end
+module Tarquinn
+  # @api public
+  #
+  # Methods added by Tarquinn
+  module ClassMethods
+    # Creates a redirection rule
+    #
+    # The rule name defines which method will be called when checking the path of redirection
+    #
+    # @param (see Tarquinn::RequestHandlerBuilder#add_redirection_config)
+    # @return (see Tarquinn::RequestHandlerBuilder#add_redirection_config)
+    def redirection_rule(redirection, *methods, &)
+      redirector_builder.add_redirection_config(redirection, *methods, &)
+    end
 
-  def skip_redirection_rule(redirection, *methods, &block)
-    redirector_builder.add_skip_config(redirection, *methods, block)
-  end
+    # Attaches a condition to skip a redirection based on route (controller action)
+    #
+    # When any of the skip rules is met the redirection is skipped
+    #
+    # @param (see Tarquinn::RequestHandlerBuilder#add_skip_action)
+    # @return (see Tarquinn::RequestHandlerBuilder#add_skip_action)
+    def skip_redirection(redirection, *actions)
+      redirector_builder.add_skip_action(redirection, *actions)
+    end
+
+    # Attaches conditions to skip a redirection
+    #
+    # Methods and blocks are ran and if any returns true, the redirec is skipped
+    #
+    # @param (see Tarquinn::RequestHandlerBuilder#add_skip_config)
+    # @return (see Tarquinn::RequestHandlerBuilder#add_skip_config)
+    def skip_redirection_rule(redirection, *methods, &block)
+      redirector_builder.add_skip_config(redirection, *methods, block)
+    end
 
-  def redirector_builder
-    @redirector_builder ||= Tarquinn::Builder.new
+    # Retruns the RequestHandlerBuilder
+    #
+    # RequestHandlerBuilder will Carry all the configurations and will create
+    # one {RequestHandler} for each request
+    #
+    # @return [RequestHandlerBuilder]
+    def redirector_builder
+      @redirector_builder ||= Tarquinn::RequestHandlerBuilder.new
+    end
   end
 end

data/lib/tarquinn/condition/action_checker.rb

@@ -1,11 +1,28 @@
-class Tarquinn::Condition::ActionChecker
-  attr_accessor :routes
+# frozen_string_literal: true
 
-  def initialize(routes)
-    @routes = [routes].flatten.map(&:to_s)
-  end
+module Tarquinn
+  class Condition
+    # @api private
+    #
+    # Checks condition based on route action
+    class ActionChecker < Tarquinn::Condition
+      def initialize(routes)
+        @routes = [routes].flatten.map(&:to_s)
+      end
+
+      def check?(controller)
+        routes.include? controller.params[:action]
+      end
+
+      def ==(other)
+        return false unless other.class == self.class
+
+        other.routes == routes
+      end
+
+      protected
 
-  def check?(controller)
-    routes.include? controller.params[:action]
+      attr_reader :routes
+    end
   end
 end

data/lib/tarquinn/condition/method_caller.rb

@@ -1,13 +1,30 @@
-class Tarquinn::Condition::MethodCaller
-  attr_accessor :methods
+# frozen_string_literal: true
 
-  def initialize(methods)
-    @methods = [methods].flatten
-  end
+module Tarquinn
+  class Condition
+    # @api private
+    #
+    # Checks condition based on result of method call from controller
+    class MethodCaller < Tarquinn::Condition
+      def initialize(methods)
+        @methods = [methods].flatten
+      end
+
+      def check?(controller)
+        methods.any? do |method|
+          controller.call(method)
+        end
+      end
+
+      def ==(other)
+        return false unless other.class == self.class
+
+        other.methods == methods
+      end
+
+      protected
 
-  def check?(controller)
-    methods.any? do |method|
-      controller.call(method)
+      attr_reader :methods
     end
   end
 end

data/lib/tarquinn/condition/proc_runner.rb

@@ -1,11 +1,22 @@
-class Tarquinn::Condition::ProcRunner
-  attr_reader :block
+# frozen_string_literal: true
 
-  def initialize(&block)
-    @block = block
-  end
+module Tarquinn
+  class Condition
+    # @api private
+    #
+    # Checks condition based on a given block
+    class ProcRunner < Tarquinn::Condition
+      def initialize(&block)
+        @block = block
+      end
+
+      def check?(controller)
+        controller.run(&block)
+      end
+
+      private
 
-  def check?(controller)
-    block.yield(controller)
+      attr_reader :block
+    end
   end
 end

data/lib/tarquinn/condition.rb

@@ -1,5 +1,58 @@
-module Tarquinn::Condition
-  require 'tarquinn/condition/action_checker'
-  require 'tarquinn/condition/method_caller'
-  require 'tarquinn/condition/proc_runner'
+# frozen_string_literal: true
+
+module Tarquinn
+  # @api private
+  # @abstract
+  #
+  # Redirection condition
+  class Condition
+    autoload :ActionChecker, 'tarquinn/condition/action_checker'
+    autoload :MethodCaller,  'tarquinn/condition/method_caller'
+    autoload :ProcRunner,    'tarquinn/condition/proc_runner'
+
+    class << self
+      # Creates a method caller condition
+      #
+      # @param methods [Array<Symbol>] list of methods to be called for condition
+      #
+      # @return [Tarquinn::Condition::MethodCaller] when methods are given
+      # @return [NilClass] when no methods are given
+      def method_caller(methods)
+        return if methods.empty?
+
+        Tarquinn::Condition::MethodCaller.new(methods)
+      end
+
+      # Creates an action checker condition
+      #
+      # @param routes [Array<Symbol>] controller actions that will match the condition
+      #
+      # @return [Tarquinn::Condition::ActionChecker]
+      def action_checker(routes)
+        Tarquinn::Condition::ActionChecker.new(routes)
+      end
+
+      # Cretes a proc checker
+      #
+      # @param block [Proc] block to be ran when condition is checked
+      #
+      # @return [Tarquinn::Condition::ProcRunner] When a block is given
+      # @return [NilClass] when no block is given
+      def proc_runner(&block)
+        return unless block
+
+        Tarquinn::Condition::ProcRunner.new(&block)
+      end
+    end
+
+    # Checks if a condition is matched
+    #
+    # @param _controller [Tarquinn::Controller] the controller with the request params
+    #
+    # @return [TrueClass] When it is a match
+    # @return [FalseClass] When it is not a match
+    def check?(_controller)
+      raise NotImplementedError, 'Needs to be implemented in child class'
+    end
+  end
 end

data/lib/tarquinn/controller.rb

@@ -1,19 +1,62 @@
-class Tarquinn::Controller
-  attr_reader :controller
+# frozen_string_literal: true
 
-  def initialize(controller)
-    @controller = controller
-  end
+module Tarquinn
+  # @api private
+  #
+  # Controller interface
+  class Controller
+    def initialize(controller)
+      @controller = controller
+    end
 
-  def params
-    @params ||= controller.send(:params)
-  end
+    # Returns request parameters
+    #
+    # @return [ActionController::Parameters]
+    def params
+      @params ||= controller.send(:params)
+    end
 
-  def call(method, *args)
-    controller.send(method, *args)
-  end
+    # Calls a method from the controller
+    #
+    # @param method [Symbol] method name to be called
+    # @param args [Array<Symbol>] Method arguments
+    # @param opts [Hash<Symbol,Object>] Method arguments
+    # @param block [Proc] block to be given to the method
+    #
+    # @return [Object]
+    def call(method, *args, **opts, &block)
+      controller.send(method, *args, **opts, &block)
+    end
+
+    # Run a block in teh context of the controller
+    #
+    # @param block [Proc] block to be ran
+    #
+    # @return [Object] the return of the block
+    def run(&block)
+      controller.send(:instance_eval, &block)
+    end
+
+    # Checks if the controller responds to a method
+    #
+    # @param method [Symbol] method name
+    #
+    # @return [TrueClass] the controller responds to this method
+    # @return [FalseClass] the controller does not responds to this method
+    def method?(method)
+      controller.respond_to?(method, true)
+    end
+
+    private
+
+    attr_reader :controller
 
-  def has_method?(method)
-    controller.respond_to?(method, true)
+    # @method controller
+    # @api private
+    # @private
+    #
+    # Returns the controller handling the request
+    #
+    # @return [ActionController::Base]
   end
 end

data/lib/tarquinn/redirection_config.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Tarquinn
+  # @api private
+  #
+  # Redirection configuration
+  #
+  # @see Tarquinn::RequestHandler
+  class RedirectionConfig
+    attr_reader :redirect
+
+    # @param redirect [Symbol] redirection name and redirection method
+    def initialize(redirect)
+      @redirect = redirect
+    end
+
+    # Adds conditions to the rule
+    #
+    # The rule name defines which method will be called when checking the path of redirection
+    #
+    # @param methods [Array<Symbol>] Methods that tell that a redirection should be applied
+    # @param block [Proc] block that tells if a the redirection should be applied
+    #
+    # @return [Array<Tarquinn::Condition>] Current registered conditions
+    def add_redirection_rules(*methods, &block)
+      redirect_on method_caller(methods)
+      redirect_on proc_runner(&block)
+    end
+
+    # Add rule for skipping on some actions / routes
+    #
+    # @param actions [Array<Symbol>] actions / routes to be skipped by redirection rule
+    #
+    # @return [Array<Tarquinn::Condition>]
+    def add_skip_action(*actions)
+      skip action_checker(actions)
+    end
+
+    # Attaches conditions to skip a redirection
+    #
+    # Methods and blocks are ran and if any returns true, the redirec is skipped
+    #
+    # @param methods [Array<Symbol>] Methods that tell that a redirection should be skipped
+    # @param block [Proc] block that tells if a the redirection should be skipped
+    #
+    # @return [Array] Current registered conditions
+    def add_skip_rules(*methods, &block)
+      skip method_caller(methods)
+      skip proc_runner(&block)
+    end
+
+    # All blocks that indicate a redirection
+    #
+    # @return [Array<Tarquinn::Condition>]
+    def redirection_blocks
+      @redirection_blocks ||= []
+    end
+
+    # All blocks that indicate a redirection should be skipped
+    #
+    # @return [Array<Tarquinn::Condition>]
+    def skip_blocks
+      @skip_blocks ||= []
+    end
+
+    private
+
+    delegate :method_caller, :action_checker, :proc_runner, to: Tarquinn::Condition
+
+    # @private
+    #
+    # Adds a condition to skip a redirection
+    #
+    # @return (see #skip_blocks)
+    def skip(condition)
+      return skip_blocks unless condition
+
+      skip_blocks << condition
+    end
+
+    # @private
+    #
+    # Adds a condition to a redirection
+    #
+    # @return (see #redirection_blocks)
+    def redirect_on(condition)
+      return redirection_blocks unless condition
+
+      redirection_blocks << condition
+    end
+  end
+end