versioncake 4.0.2 → 4.1.0

data/gemfiles/rails7.0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "actionpack", "~> 7.0.0"
+gem "activesupport", "~> 7.0.0"
+gem "railties", "~> 7.0.0"
+
+gemspec path: "../"

data/gemfiles/rails7.0.gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: ..
+  specs:
+    versioncake (4.1.0)
+      actionpack (> 5.0)
+      activesupport (> 5.0)
+      railties (> 5.0)
+      tzinfo (> 1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.1)
+      actionview (= 7.0.1)
+      activesupport (= 7.0.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    erubi (1.10.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    json (2.6.1)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.7.1)
+    minitest (5.15.0)
+    nokogiri (1.13.1)
+      mini_portile2 (~> 2.7.0)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-rails (3.9.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.2.1)
+    tins (1.24.1)
+      sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 7.0.0)
+  activesupport (~> 7.0.0)
+  appraisal (~> 2.2)
+  coveralls (~> 0.8)
+  railties (~> 7.0.0)
+  rake (> 12.0)
+  rspec (~> 3.6)
+  rspec-rails (~> 3.6)
+  versioncake!
+
+BUNDLED WITH
+   2.2.15

data/lib/versioncake/response_strategy/http_content_type_strategy.rb

@@ -4,8 +4,10 @@ module VersionCake
       def execute(context, _status, headers, _response)
         return if headers['Content-Type'].nil?
 
-        headers['Content-Type'] << ';' unless headers['Content-Type'].end_with? ';'
-        headers['Content-Type'] << " #{version_key}=#{context.version.to_s}"
+        content_type = headers['Content-Type']
+        content_type << ';' unless headers['Content-Type'].end_with?(';')
+
+        headers['Content-Type'] = "#{content_type} #{version_key}=#{context.version.to_s}"
       end
     end
   end

data/lib/versioncake/strategies/extraction_strategy.rb

@@ -2,6 +2,10 @@ require 'active_support/core_ext/string/inflections.rb'
 
 module VersionCake
   class ExtractionStrategy
+    class InvalidStrategyError < StandardError
+    end
+    class InvalidVersionError < ArgumentError
+    end
 
     def extract(request)
       version = execute(request)
@@ -12,7 +16,7 @@ module VersionCake
       elsif version_blank?(version)
         nil
       else
-        raise Exception, "Invalid format for version number."
+        raise InvalidVersionError, "Invalid format for version number."
       end
     end
 
@@ -28,7 +32,7 @@ module VersionCake
     # If no version is found, nil should be returned. Any other results returned will raise
     # an exception.
     def execute(request)
-      raise Exception, "ExtractionStrategy requires execute to be implemented"
+      raise StandardError, "ExtractionStrategy requires execute to be implemented"
     end
 
     def self.list(*strategies)
@@ -44,24 +48,24 @@ module VersionCake
           begin
             VersionCake.const_get(strategy_name).new
           rescue
-            raise Exception, "Unknown VersionCake extraction strategy #{strategy_name}"
+            raise InvalidStrategyError, "Unknown VersionCake extraction strategy #{strategy_name}"
           end
         when Proc
           if strategy.arity == 1
             VersionCake::CustomStrategy.new(strategy)
           else
-            raise Exception, "Custom proc extraction strategy requires a single parameter"
+            raise InvalidStrategyError, "Custom proc extraction strategy requires a single parameter"
           end
         when Object
           if !strategy.methods.include?(:execute)
-            raise Exception, "Custom extraction strategy requires an execute method"
+            raise InvalidStrategyError, "Custom extraction strategy requires an execute method"
           elsif strategy.method(:execute).arity != 1
-            raise Exception, "Custom extraction strategy requires an execute method with a single parameter"
+            raise InvalidStrategyError, "Custom extraction strategy requires an execute method with a single parameter"
           else
             VersionCake::CustomStrategy.new(strategy)
           end
         else
-          raise Exception, "Invalid extration strategy"
+          raise InvalidStrategyError, "Invalid extraction strategy"
       end
     end
   end

data/lib/versioncake/version.rb

@@ -1,3 +1,3 @@
 module VersionCake
-  VERSION = '4.0.2'
+  VERSION = '4.1.0'
 end

data/lib/versioncake/version_checker.rb

@@ -2,7 +2,8 @@ module VersionCake
   class VersionChecker
     attr_reader :result
     def initialize(version, resource)
-      @version, @resource = resource, version
+      @version = version
+      @resource = resource
     end
 
     def execute

data/lib/versioncake/version_context_service.rb

@@ -43,7 +43,7 @@ module VersionCake
     private
 
     def check_version(resource, version)
-      VersionCake::VersionChecker.new(resource, version).execute
+      VersionCake::VersionChecker.new(version, resource).execute
     end
 
     def find_resource(uri)

data/lib/versioncake/versioned_request.rb

@@ -15,7 +15,7 @@ module VersionCake
         else
           @version = extracted_version
         end
-      rescue Exception
+      rescue VersionCake::ExtractionStrategy::InvalidVersionError
         @failed = true
       end
     end

data/lib/versioncake/view_additions.rb

@@ -1,91 +1,11 @@
 require 'action_view'
 
-# register an addition detail for the lookup context to understand,
-# this will allow us to have the versions available upon lookup in
-# the resolver.
-ActionView::LookupContext.register_detail(:versions){ [] }
-
-ActionView::PathResolver.class_eval do
-  if ActionPack::VERSION::MAJOR >= 6
-    ActionView::PathResolver::EXTENSIONS.replace({
-      locale: ".",
-      formats: ".",
-      versions: ".",
-      variants: "+",
-      handlers: "."
-    })
-    Kernel::silence_warnings {
-      ActionView::PathResolver::DEFAULT_PATTERN = ":prefix/:action{.:locale,}{.:formats,}{.:versions,}{+:variants,}{.:handlers,}"
-    }
-  elsif ActionPack::VERSION::MAJOR >= 4 && ActionPack::VERSION::MINOR >= 1 || ActionPack::VERSION::MAJOR >= 5
-    ActionView::PathResolver::EXTENSIONS.replace({
-                                                     locale: ".",
-                                                     formats: ".",
-                                                     versions: ".",
-                                                     variants: "+",
-                                                     handlers: "."
-                                                 })
-
-    def initialize(pattern = nil)
-      @pattern = pattern || ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:versions,}{.:handlers,}"
-      super()
-    end
-  end
-
-  # The default extract handler expects that the handler is the last extension and
-  # the format is the next one. Since we are replacing the DEFAULT_PATTERN, we need to
-  # make sure that we extract the format from the correct position.
-  #
-  # The version may be stuck inbetween the format and the handler. This is actually pretty tricky
-  # because the version is optional and the locale is optional-which means when there are 3 'pieces'
-  # it may be the locale, format and handler or the format, version and handler. To check this, we will
-  # try one additional time if there are more pieces, which should cover all the cases:
-  #
-  # Cases:
-  #  1: assume version is in the extension, pieces = ['html','erb']
-  #  2: assume version is in the extension, pieces = ['html','v1','erb']
-  #  3: assume version is in the extension, pieces = ['en','html','erb']
-  #  4: assume version is in the extension, pieces = ['en','html','v1','erb']
-  #
-  def extract_handler_and_format(path, default_formats)
-    pieces = File.basename(path).split(".")
-    pieces.shift
-
-    extension = pieces.pop
-    if ActionPack::VERSION::MAJOR == 4
-      unless extension
-        message = "The file #{path} did not specify a template handler. The default is currently ERB, " \
-                    "but will change to RAW in the future."
-        ActiveSupport::Deprecation.warn message
-      end
-    end
-    handler = ActionView::Template.handler_for_extension(extension)
-    format  = get_format_from_pieces(pieces, (ActionPack::VERSION::MAJOR == 4 ? ActionView::Template::Types : Mime))
-
-    [handler, format]
-  end
-
-  # If there are still pieces and we didn't find a valid format, we may
-  # have a version in the extension, so try one more time to pop the format.
-  def get_format_from_pieces(pieces, format_list)
-    format = nil
-    pieces.reverse.each do |piece|
-      if ActionView::PathResolver::EXTENSIONS.is_a?(Hash) &&
-          ActionView::PathResolver::EXTENSIONS.include?(:variants)
-        piece = piece.split(ActionView::PathResolver::EXTENSIONS[:variants], 2).first # remove variant from format
-      end
-
-      format = format_list[piece]
-      break unless format.nil?
-    end
-    format
-  end
-end
-
-ActionView::Template.class_eval do
-  # the identifier method name filters out numbers,
-  # but we want to preserve them for v1 etc.
-  def identifier_method_name #:nodoc:
-    inspect.gsub(/[^a-z0-9_]/, '_')
-  end
+if ActionPack::VERSION::MAJOR >= 7
+  require_relative 'view_additions_rails7'
+elsif ActionPack::VERSION::MAJOR >= 6
+  require_relative 'view_additions_rails6'
+elsif ActionPack::VERSION::MAJOR >= 5
+  require_relative 'view_additions_rails5'
+else
+  raise StandardError.new('Unsupported Rails version')
 end

data/lib/versioncake/view_additions_rails5.rb

@@ -0,0 +1,70 @@
+require 'action_view'
+
+# register an addition detail for the lookup context to understand,
+# this will allow us to have the versions available upon lookup in
+# the resolver.
+ActionView::LookupContext.register_detail(:versions) { [] }
+
+ActionView::PathResolver.class_eval do
+  ActionView::PathResolver::EXTENSIONS.replace({
+    locale: ".",
+    formats: ".",
+    versions: ".",
+    variants: "+",
+    handlers: "."
+  })
+
+  def initialize(pattern = nil)
+    @pattern = pattern || ":prefix/:action{.:locale,}{.:formats,}{+:variants,}{.:versions,}{.:handlers,}"
+    super()
+  end
+
+  # The default extract handler expects that the handler is the last extension and
+  # the format is the next one. Since we are replacing the DEFAULT_PATTERN, we need to
+  # make sure that we extract the format from the correct position.
+  #
+  # The version may be stuck inbetween the format and the handler. This is actually pretty tricky
+  # because the version is optional and the locale is optional-which means when there are 3 'pieces'
+  # it may be the locale, format and handler or the format, version and handler. To check this, we will
+  # try one additional time if there are more pieces, which should cover all the cases:
+  #
+  # Cases:
+  #  1: assume version is in the extension, pieces = ['html','erb']
+  #  2: assume version is in the extension, pieces = ['html','v1','erb']
+  #  3: assume version is in the extension, pieces = ['en','html','erb']
+  #  4: assume version is in the extension, pieces = ['en','html','v1','erb']
+  #
+  def extract_handler_and_format_and_variant(path, default_formats=nil)
+    pieces = File.basename(path).split('.'.freeze)
+    pieces.shift
+
+    extension = pieces.pop
+
+    handler = ActionView::Template.handler_for_extension(extension)
+    format, variant = get_format_and_variant_from_pieces(pieces, Mime)
+    format &&= ActionView::Template::Types[format]
+
+    [handler, format, variant]
+  end
+
+  # If there are still pieces and we didn't find a valid format, we may
+  # have a version in the extension, so try one more time to pop the format.
+  def get_format_and_variant_from_pieces(pieces, format_list)
+    variant, format = nil
+    pieces.reverse.each do |piece|
+      piece, variant = piece.split(ActionView::PathResolver::EXTENSIONS[:variants], 2)
+
+      format = format_list[piece]
+      break unless format.nil?
+    end
+    [format, variant]
+  end
+end
+
+ActionView::Template.class_eval do
+  # the identifier method name filters out numbers,
+  # but we want to preserve them for v1 etc.
+  def identifier_method_name #:nodoc:
+    inspect.gsub(/[^a-z0-9_]/, '_')
+  end
+end

data/lib/versioncake/view_additions_rails6.rb

@@ -0,0 +1,69 @@
+require 'action_view'
+
+# register an addition detail for the lookup context to understand,
+# this will allow us to have the versions available upon lookup in
+# the resolver.
+ActionView::LookupContext.register_detail(:versions){ [] }
+
+ActionView::PathResolver.class_eval do
+  ActionView::PathResolver::EXTENSIONS.replace({
+    locale: ".",
+    formats: ".",
+    versions: ".",
+    variants: "+",
+    handlers: "."
+  })
+  Kernel::silence_warnings {
+    ActionView::PathResolver::DEFAULT_PATTERN = ":prefix/:action{.:locale,}{.:formats,}{.:versions,}{+:variants,}{.:handlers,}"
+  }
+
+  # The default extract handler expects that the handler is the last extension and
+  # the format is the next one. Since we are replacing the DEFAULT_PATTERN, we need to
+  # make sure that we extract the format from the correct position.
+  #
+  # The version may be stuck inbetween the format and the handler. This is actually pretty tricky
+  # because the version is optional and the locale is optional-which means when there are 3 'pieces'
+  # it may be the locale, format and handler or the format, version and handler. To check this, we will
+  # try one additional time if there are more pieces, which should cover all the cases:
+  #
+  # Cases:
+  #  1: assume version is in the extension, pieces = ['html','erb']
+  #  2: assume version is in the extension, pieces = ['html','v1','erb']
+  #  3: assume version is in the extension, pieces = ['en','html','erb']
+  #  4: assume version is in the extension, pieces = ['en','html','v1','erb']
+  #
+  def extract_handler_and_format(path, default_formats)
+    pieces = File.basename(path).split(".")
+    pieces.shift
+
+    extension = pieces.pop
+    handler = ActionView::Template.handler_for_extension(extension)
+    format  = get_format_from_pieces(pieces, Mime)
+
+    [handler, format]
+  end
+
+  # If there are still pieces and we didn't find a valid format, we may
+  # have a version in the extension, so try one more time to pop the format.
+  def get_format_from_pieces(pieces, format_list)
+    format = nil
+    pieces.reverse.each do |piece|
+      if ActionView::PathResolver::EXTENSIONS.is_a?(Hash) &&
+          ActionView::PathResolver::EXTENSIONS.include?(:variants)
+        piece = piece.split(ActionView::PathResolver::EXTENSIONS[:variants], 2).first # remove variant from format
+      end
+
+      format = format_list[piece]
+      break unless format.nil?
+    end
+    format
+  end
+end
+
+ActionView::Template.class_eval do
+  # the identifier method name filters out numbers,
+  # but we want to preserve them for v1 etc.
+  def identifier_method_name #:nodoc:
+    inspect.gsub(/[^a-z0-9_]/, '_')
+  end
+end

data/lib/versioncake/view_additions_rails7.rb

@@ -0,0 +1,155 @@
+require 'action_view'
+
+# register an addition detail for the lookup context to understand,
+# this will allow us to have the versions available upon lookup in
+# the resolver.
+ActionView::LookupContext.register_detail(:versions){ [] }
+
+ActionView::Resolver::PathParser.class_eval do
+    def build_path_regex
+      handlers = ActionView::Template::Handlers.extensions.map { |x| Regexp.escape(x) }.join("|")
+      formats = ActionView::Template::Types.symbols.map { |x| Regexp.escape(x) }.join("|")
+      locales = "[a-z]{2}(?:-[A-Z]{2})?"
+      variants = "[^.]*"
+
+      %r{
+          \A
+          (?:(?<prefix>.*)/)?
+          (?<partial>_)?
+          (?<action>.*?)
+          (?:\.(?<locale>#{locales}))??
+          (?:\.(?<format>#{formats}))??
+          (?:\+(?<variant>#{variants}))??
+          (?:\.(?<versions>v[0-9]+))??
+          (?:\.(?<handler>#{handlers}))?
+          \z
+        }x
+    end
+
+    def parse(path)
+      @regex ||= build_path_regex
+      match = @regex.match(path)
+      path = ActionView::TemplatePath.build(match[:action], match[:prefix] || "", !!match[:partial])
+      details = ActionView::TemplateDetails.new(
+        match[:locale]&.to_sym,
+        match[:handler]&.to_sym,
+        match[:format]&.to_sym,
+        match[:variant]&.to_sym,
+        match[:versions]&.to_sym,
+      )
+
+      ActionView::Resolver::PathParser::ParsedPath.new(path, details)
+    end
+  end
+
+ActionView::TemplateDetails::Requested.class_eval do
+  attr_reader :locale, :handlers, :formats, :variants, :versions
+  attr_reader :locale_idx, :handlers_idx, :formats_idx, :variants_idx, :versions_idx
+
+  def initialize(locale:, handlers:, formats:, variants:, versions:)
+    @locale = locale
+    @handlers = handlers
+    @formats = formats
+    @variants = variants
+    @versions = versions
+
+    @locale_idx   = build_idx_hash(locale)
+    @handlers_idx = build_idx_hash(handlers)
+    @formats_idx  = build_idx_hash(formats)
+    @versions_idx  = build_idx_hash(versions)
+    if variants == :any
+      @variants_idx = ANY_HASH
+    else
+      @variants_idx = build_idx_hash(variants)
+    end
+  end
+end
+
+ActionView::TemplateDetails.class_eval do
+  attr_reader :locale, :handler, :format, :variant, :version
+
+  def initialize(locale, handler, format, variant, version)
+    @locale = locale
+    @handler = handler
+    @format = format
+    @variant = variant
+    @version = version
+  end
+
+  def matches?(requested)
+    requested.formats_idx[@format] &&
+      requested.locale_idx[@locale] &&
+      requested.versions_idx[@version] &&
+      requested.variants_idx[@variant] &&
+      requested.handlers_idx[@handler]
+  end
+
+  def sort_key_for(requested)
+    [
+      requested.formats_idx[@format],
+      requested.locale_idx[@locale],
+      requested.versions_idx[@version],
+      requested.variants_idx[@variant],
+      requested.handlers_idx[@handler]
+    ]
+  end
+end
+
+ActionView::Template.class_eval do
+  def initialize(source, identifier, handler, locals:, format: nil, variant: nil, virtual_path: nil, version: nil)
+    @source            = source
+    @identifier        = identifier
+    @handler           = handler
+    @compiled          = false
+    @locals            = locals
+    @virtual_path      = virtual_path
+
+    @variable = if @virtual_path
+      base = @virtual_path.end_with?("/") ? "" : ::File.basename(@virtual_path)
+      base =~ /\A_?(.*?)(?:\.\w+)*\z/
+      $1.to_sym
+    end
+
+    @format            = format
+    @version           = version
+    @variant           = variant
+    @compile_mutex     = Mutex.new
+  end
+
+  def marshal_dump # :nodoc:
+    [ @source, @identifier, @handler, @compiled, @locals, @virtual_path, @format, @variant, @version ]
+  end
+
+  def marshal_load(array) # :nodoc:
+    @source, @identifier, @handler, @compiled, @locals, @virtual_path, @format, @variant, @version = *array
+    @compile_mutex = Mutex.new
+  end
+
+  # the identifier method name filters out numbers,
+  # but we want to preserve them for v1 etc.
+  # TODO: Consider updating to match current implementation:
+  # short_identifier.tr("^a-z_", "_")
+  def identifier_method_name #:nodoc:
+    short_identifier.gsub(/[^a-z0-9_]/, '_')
+  end
+end
+
+ActionView::UnboundTemplate.class_eval do
+  delegate :version, to: :@details
+
+  def build_template(locals)
+    ActionView::Template.new(
+      @source,
+      @identifier,
+      details.handler_class,
+
+      format: details.format_or_default,
+      variant: variant&.to_s,
+      virtual_path: @virtual_path,
+      version: version&.to_s,
+
+      locals: locals.map(&:to_s)
+    )
+  end
+end
+

data/spec/integration/controller/unversioned_controller_spec.rb

@@ -6,7 +6,7 @@ describe UnversionedController, type: :controller do
   context '#index' do
     render_views
 
-    it { expect(response).to be_success }
+    it { expect(response).to be_successful }
     it { expect(response.body).to eq 'unversioned index' }
   end
 end

data/spec/integration/view/render_spec.rb

@@ -3,7 +3,14 @@ require './spec/rails_helper'
 describe ActionView::Base do
   let(:path) { ActionView::FileSystemResolver.new('./spec/fixtures') }
   let(:view_paths) { ActionView::PathSet.new([path]) }
-  let(:view) { ActionView::Base.new(view_paths) }
+  let(:view) do
+    clazz = if ActionPack::VERSION::MAJOR >= 7
+      ActionView::Base.with_empty_template_cache
+    else
+      ActionView::Base
+    end
+    clazz.new(ActionView::LookupContext.new(view_paths), [], nil)
+  end
   let(:version_override) { nil }
   subject { view.render(template: 'templates/versioned', versions: version_override) }