Class: Redmine::Scm::Adapters::AbstractAdapter

Inherits:
Object
  • Object
show all
Defined in:
lib/redmine/scm/adapters/abstract_adapter.rb

Overview

:nodoc:

Direct Known Subclasses

BazaarAdapter, CvsAdapter, DarcsAdapter, FilesystemAdapter, GitAdapter, MercurialAdapter, SubversionAdapter

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (AbstractAdapter) initialize(url, root_url = nil, login = nil, password = nil, path_encoding = nil)

Returns a new instance of AbstractAdapter



63
64
65
66
67
68
69
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 63

def initialize(url, root_url=nil, =nil, password=nil,
               path_encoding=nil)
  @url = url
  @login =  if  && !.empty?
  @password = (password || "") if @login
  @root_url = root_url.blank? ? retrieve_root_url : root_url
end

Class Method Details

+ (Object) client_available



50
51
52
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 50

def client_available
  true
end

+ (Object) client_command



25
26
27
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 25

def client_command
  ""
end

+ (Object) client_version

Returns the version of the scm client Eg: [1, 5, 0] or [] if unknown



31
32
33
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 31

def client_version
  []
end

+ (Boolean) client_version_above?(v, options = {})

Returns true if the current client version is above or equals the given one If option is :unknown is set to true, it will return true if the client version is unknown

Returns:

  • (Boolean)


46
47
48
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 46

def client_version_above?(v, options={})
  ((client_version <=> v) >= 0) || (client_version.empty? && options[:unknown])
end

+ (Object) client_version_string

Returns the version string of the scm client Eg: '1.5.0' or 'Unknown version' if unknown



37
38
39
40
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 37

def client_version_string
  v = client_version || 'Unknown version'
  v.is_a?(Array) ? v.join('.') : v.to_s
end

+ (Object) shell_quote(str)



54
55
56
57
58
59
60
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 54

def shell_quote(str)
  if Redmine::Platform.mswin?
    '"' + str.gsub(/"/, '\\"') + '"'
  else
    "'" + str.gsub(/'/, "'\"'\"'") + "'"
  end
end

Instance Method Details

- (Object) adapter_name



71
72
73
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 71

def adapter_name
  'Abstract'
end

- (Object) branches



118
119
120
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 118

def branches
  return nil
end

- (Object) cat(path, identifier = nil)



142
143
144
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 142

def cat(path, identifier=nil)
  return nil
end

- (Object) default_branch



126
127
128
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 126

def default_branch
  return nil
end

- (Object) diff(path, identifier_from, identifier_to = nil)



138
139
140
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 138

def diff(path, identifier_from, identifier_to=nil)
  return nil
end

- (Object) entries(path = nil, identifier = nil)

Returns an Entries collection or nil if the given path doesn't exist in the repository



114
115
116
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 114

def entries(path=nil, identifier=nil)
  return nil
end

- (Object) entry(path = nil, identifier = nil)

Returns the entry identified by path and revision identifier or nil if entry doesn't exist in the repository



98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 98

def entry(path=nil, identifier=nil)
  parts = path.to_s.split(%r{[\/\\]}).select {|n| !n.blank?}
  search_path = parts[0..-2].join('/')
  search_name = parts[-1]
  if search_path.blank? && search_name.blank?
    # Root entry
    Entry.new(:path => '', :kind => 'dir')
  else
    # Search for the entry in the parent directory
    es = entries(search_path, identifier)
    es ? es.detect {|e| e.name == search_name} : nil
  end
end

- (Object) info

get info about the svn repository



92
93
94
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 92

def info
  return nil
end

- (Object) properties(path, identifier = nil)



130
131
132
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 130

def properties(path, identifier=nil)
  return nil
end

- (Object) revisions(path = nil, identifier_from = nil, identifier_to = nil, options = {})



134
135
136
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 134

def revisions(path=nil, identifier_from=nil, identifier_to=nil, options={})
  return nil
end

- (Object) root_url



83
84
85
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 83

def root_url
  @root_url
end

- (Object) shell_quote(str)



166
167
168
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 166

def shell_quote(str)
  self.class.shell_quote(str)
end

- (Boolean) supports_annotate?

Returns:

  • (Boolean)


79
80
81
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 79

def supports_annotate?
  respond_to?('annotate')
end

- (Boolean) supports_cat?

Returns:

  • (Boolean)


75
76
77
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 75

def supports_cat?
  true
end

- (Object) tags



122
123
124
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 122

def tags
  return nil
end

- (Object) url



87
88
89
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 87

def url
  @url
end

- (Object) with_leading_slash(path)



146
147
148
149
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 146

def with_leading_slash(path)
  path ||= ''
  (path[0,1]!="/") ? "/#{path}" : path
end

- (Object) with_trailling_slash(path)



151
152
153
154
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 151

def with_trailling_slash(path)
  path ||= ''
  (path[-1,1] == "/") ? path : "#{path}/"
end

- (Object) without_leading_slash(path)



156
157
158
159
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 156

def without_leading_slash(path)
  path ||= ''
  path.gsub(%r{^/+}, '')
end

- (Object) without_trailling_slash(path)



161
162
163
164
# File 'lib/redmine/scm/adapters/abstract_adapter.rb', line 161

def without_trailling_slash(path)
 path ||= ''
 (path[-1,1] == "/") ? path[0..-2] : path
end