Commit a1e68a91 authored by Robert Speicher's avatar Robert Speicher

Rename RefExtractor to ExtractsPath

Update docs a bit
parent a8ea8d98
# Controller for viewing a file's blame
class BlameController < ApplicationController
include RefExtractor
include ExtractsPath
layout "project"
......
# Controller for viewing a file's blame
class BlobController < ApplicationController
# Thrown when given an invalid path
class InvalidPathError < StandardError; end
include RefExtractor
include ExtractsPath
include Gitlab::Encode
layout "project"
......
# Controller for viewing a repository's file structure
class TreeController < ApplicationController
include RefExtractor
include ExtractsPath
layout "project"
......
# Module providing an extract_ref method for controllers working with Git
# tree-ish + path params
module RefExtractor
# Raised when given an invalid path
# Module providing methods for dealing with separating a tree-ish string and a
# file path string when combined in a request parameter
module ExtractsPath
extend ActiveSupport::Concern
# Raised when given an invalid file path
class InvalidPathError < StandardError; end
# Given a string containing both a Git ref - such as a branch or tag - and a
# filesystem path joined by forward slashes, attempts to separate the two.
included do
if respond_to?(:before_filter)
before_filter :assign_ref_vars
end
end
# Given a string containing both a Git tree-ish, such as a branch or tag, and
# a filesystem path joined by forward slashes, attempts to separate the two.
#
# Expects a @project instance variable to contain the active project. Used to
# check the input against a list of valid repository refs.
# Expects a @project instance variable to contain the active project. This is
# used to check the input against a list of valid repository refs.
#
# Examples
#
......@@ -78,8 +86,11 @@ module RefExtractor
# - @commit - A CommitDecorator representing the commit from the given ref
# - @tree - A TreeDecorator representing the tree at the given ref/path
#
# Automatically renders `not_found!` if a valid tree could not be resolved
# (e.g., when a user inserts an invalid path or ref).
# If the :id parameter appears to be requesting a specific response format,
# that will be handled as well.
#
# Automatically renders `not_found!` if a valid tree path could not be
# resolved (e.g., when a user inserts an invalid path or ref).
def assign_ref_vars
# Handle formats embedded in the id
if params[:id].ends_with?('.atom')
......
require 'spec_helper'
describe ExtractsPath do
include ExtractsPath
let(:project) { double('project') }
before do
@project = project
project.stub(:branches).and_return(['master', 'foo/bar/baz'])
project.stub(:tags).and_return(['v1.0.0', 'v2.0.0'])
end
describe '#extract_ref' do
it "returns an empty pair when no @project is set" do
@project = nil
extract_ref('master/CHANGELOG').should == ['', '']
end
context "without a path" do
it "extracts a valid branch" do
extract_ref('master').should == ['master', '']
end
it "extracts a valid tag" do
extract_ref('v2.0.0').should == ['v2.0.0', '']
end
it "extracts a valid commit ref without a path" do
extract_ref('f4b14494ef6abf3d144c28e4af0c20143383e062').should ==
['f4b14494ef6abf3d144c28e4af0c20143383e062', '']
end
it "falls back to a primitive split for an invalid ref" do
extract_ref('stable').should == ['stable', '']
end
end
context "with a path" do
it "extracts a valid branch" do
extract_ref('foo/bar/baz/CHANGELOG').should == ['foo/bar/baz', 'CHANGELOG']
end
it "extracts a valid tag" do
extract_ref('v2.0.0/CHANGELOG').should == ['v2.0.0', 'CHANGELOG']
end
it "extracts a valid commit SHA" do
extract_ref('f4b14494ef6abf3d144c28e4af0c20143383e062/CHANGELOG').should ==
['f4b14494ef6abf3d144c28e4af0c20143383e062', 'CHANGELOG']
end
it "falls back to a primitive split for an invalid ref" do
extract_ref('stable/CHANGELOG').should == ['stable', 'CHANGELOG']
end
end
end
end
require 'spec_helper'
describe RefExtractor do
include RefExtractor
describe ExtractsPath do
include ExtractsPath
let(:project) { double('project') }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment