Class: Vim::Flavor::Facade

Inherits:
Object
  • Object
show all
Defined in:
lib/vim-flavor/facade.rb

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Facade

Returns a new instance of Facade.



7
8
9
 
# File 'lib/vim-flavor/facade.rb', line 7

def initialize
  @target_repo_names = []
end

Instance Method Details

#choose_a_flavor(nfg) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/vim-flavor/facade.rb', line 96

def choose_a_flavor(nfg)
  vs = nfg.map {|nf| nf.locked_version}.uniq
  if vs.length == 1
    nfg.first
  else
    lv = find_latest_version(vs)
    if lv and nfg.all? {|nf| nf.satisfied_with?(lv)}
      nf = nfg.first
      nf.use_specific_version(lv)
      nf
    else
      stop_by_incompatible_declarations(nfg)
    end
  end
end

#complete(current_flavor_table, locked_flavor_table, mode, groups) ⇒ Object 



86
87
88
89
90
91
92
93
94
 
# File 'lib/vim-flavor/facade.rb', line 86

def complete(current_flavor_table, locked_flavor_table, mode, groups)
  nfs = complete_flavors(current_flavor_table, locked_flavor_table, mode, groups, 1, 'you')

  Hash[
    nfs.group_by {|nf| nf.repo_name}.map {|repo_name, nfg|
      [repo_name, choose_a_flavor(nfg)]
    }
  ]
end

#complete_a_flavor(nf, locked_flavor_table, mode, groups, level, requirer) ⇒ Object 



135
136
137
138
139
 
# File 'lib/vim-flavor/facade.rb', line 135

def complete_a_flavor(nf, locked_flavor_table, mode, groups, level, requirer)
  lf = locked_flavor_table[nf.repo_name]
  [complete_a_flavor_itself(nf, lf, mode, level, requirer)] +
    complete_a_flavor_dependencies(nf, locked_flavor_table, mode, groups, level)
end

#complete_a_flavor_dependencies(nf, locked_flavor_table, mode, groups, level) ⇒ Object 



176
177
178
179
180
 
# File 'lib/vim-flavor/facade.rb', line 176

def complete_a_flavor_dependencies(nf, locked_flavor_table, mode, groups, level)
  nf.checkout()
  ff = FlavorFile.load_or_new(nf.cached_repo_path.to_flavorfile_path)
  complete_flavors(ff.flavor_table, locked_flavor_table, mode, groups, level + 1, nf.repo_name)
end

#complete_a_flavor_itself(nf, lf, mode, level, requirer) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/vim-flavor/facade.rb', line 149

def complete_a_flavor_itself(nf, lf, mode, level, requirer)
  trace "#{'  ' * level}Use #{nf.repo_name} ..."

  already_cached = nf.cached?
  nf.clone() unless already_cached

  e_mode = effective_mode(mode, nf.repo_name)
  if e_mode == :install and lf and nf.satisfied_with?(lf.locked_version)
    if not nf.cached_version?(lf.locked_version)
      nf.fetch()
      if not nf.cached_version?(lf.locked_version)
        raise RuntimeError, "#{nf.repo_name} is locked to #{lf.locked_version}, but no such version exists"
      end
    end
    nf.use_specific_version(lf.locked_version)
  else
    nf.fetch() if already_cached
    nf.use_appropriate_version()
  end

  nf.requirer = requirer

  trace " #{nf.locked_version}\n"

  nf
end

#complete_flavors(current_flavor_table, locked_flavor_table, mode, groups, level, requirer) ⇒ Object 



126
127
128
129
130
131
132
133
 
# File 'lib/vim-flavor/facade.rb', line 126

def complete_flavors(current_flavor_table, locked_flavor_table, mode, groups, level, requirer)
  current_flavor_table.values.map(&:dup).sort_by(&:repo_name).
  select {|nf| groups.include?(nf.group)}.
  on_failure {trace " failed\n"}.
  flat_map {|nf|
    complete_a_flavor(nf, locked_flavor_table, mode, groups, level, requirer)
  }
end

#create_vim_script_for_bootstrap(flavors_path) ⇒ Object 



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/vim-flavor/facade.rb', line 231

def create_vim_script_for_bootstrap(flavors_path)
  bootstrap_path = flavors_path.to_bootstrap_path
  FileUtils.mkdir_p(File.dirname(bootstrap_path))
  File.open(bootstrap_path, 'w') do |f|
    f.write(<<-'END')
      function! s:bootstrap()
        let current_rtp = &runtimepath
        let current_rtps = split(current_rtp, ',')
        set runtimepath&
        let default_rtp = &runtimepath
        let default_rtps = split(default_rtp, ',')
        let user_dir = default_rtps[0]
        let user_after_dir = default_rtps[-1]
        let base_rtps =
        \ filter(copy(current_rtps),
        \        'v:val !=# user_dir && v:val !=# user_after_dir')
        let flavor_dirs =
        \ filter(split(glob(user_dir . '/flavors/*'), '\n'),
        \        'isdirectory(v:val)')
        let new_rtps =
        \ []
        \ + [user_dir]
        \ + flavor_dirs
        \ + base_rtps
        \ + map(reverse(copy(flavor_dirs)), 'v:val . "/after"')
        \ + [user_after_dir]
        let &runtimepath = join(new_rtps, ',')
      endfunction

      call s:bootstrap()
    END
  end
end

#deploy_flavors(flavors, flavors_path) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/vim-flavor/facade.rb', line 182

def deploy_flavors(flavors, flavors_path)
  trace "Deploying plugins...\n"

  a_flavors_path = File.absolute_path(flavors_path)
  deployment_memo = LockFile.load_or_new(a_flavors_path.to_lockfile_path)

  # To uninstall flavors which were deployed by vim-flavor 1.0.2 or
  # older, the whole deployed flavors have to be removed.  Because
  # deployment_memo is recorded since 1.0.3.
  FileUtils.rm_rf(
    [a_flavors_path],
    :secure => true
  ) if deployment_memo.flavors.empty?

  create_vim_script_for_bootstrap(a_flavors_path)

  flavors.
  before_each {|f| trace "  #{f.repo_name} #{f.locked_version} ..."}.
  on_failure {trace " failed\n"}.
  each do |f|
    df = deployment_memo.flavor_table[f.repo_name]
    deployed_version = (df and df.locked_version)
    if f.locked_version == deployed_version
      trace " skipped (already deployed)\n"
    else
      FileUtils.rm_rf(
        [f.make_deployment_path(a_flavors_path)],
        :secure => true
      )
      f.deploy(a_flavors_path)
      trace " done\n"
    end
  end

  deployment_memo.flavors.each do |df|
    if flavors.all? {|f| f.repo_name != df.repo_name}
      trace "  #{df.repo_name} ..."
      FileUtils.rm_rf(
        [df.make_deployment_path(a_flavors_path)],
        :secure => true
      )
      trace " uninstalled\n"
    end
  end

  deployment_memo.flavors = flavors
  deployment_memo.save()
end

#effective_mode(mode, repo_name) ⇒ Object 



141
142
143
144
145
146
147
 
# File 'lib/vim-flavor/facade.rb', line 141

def effective_mode(mode, repo_name)
  return :install if
    mode == :update and
    not @target_repo_names.empty? and
    not @target_repo_names.member?(repo_name)
  mode
end

#find_latest_version(vs) ⇒ Object 



112
113
114
 
# File 'lib/vim-flavor/facade.rb', line 112

def find_latest_version(vs)
  vs.all? {|v| PlainVersion === v} and vs.max() or nil
end

#install(vimfiles_path) ⇒ Object 



11
12
13
 
# File 'lib/vim-flavor/facade.rb', line 11

def install(vimfiles_path)
  install_or_update(:install, vimfiles_path)
end

#install_or_update(mode, vimfiles_path) ⇒ Object 



53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/vim-flavor/facade.rb', line 53

def install_or_update(mode, vimfiles_path)
  flavorfile = FlavorFile.load(Dir.getwd().to_flavorfile_path)
  lockfile = LockFile.load_or_new(Dir.getwd().to_lockfile_path)
  refresh_flavors(
    mode,
    flavorfile,
    lockfile,
    [:runtime],
    vimfiles_path.to_flavors_path
  )
end

#refresh_flavors(mode, flavorfile, lockfile, groups, flavors_path) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/vim-flavor/facade.rb', line 65

def refresh_flavors(mode, flavorfile, lockfile, groups, flavors_path)
  trace "Checking versions...\n"

  lockfile.update(
    complete(
      flavorfile.flavor_table,
      lockfile.flavor_table,
      mode,
      groups
    )
  )
  lockfile.save()

  deploy_flavors(
    lockfile.flavors,
    File.absolute_path(flavors_path)
  )

  trace "Completed.\n"
end

#stop_by_incompatible_declarations(nfg) ⇒ Object 



116
117
118
119
120
121
122
123
124
 
# File 'lib/vim-flavor/facade.rb', line 116

def stop_by_incompatible_declarations(nfg)
  ss = []
  ss << 'Found incompatible declarations:'
  nfg.each do |nf|
    ss << "  #{nf.repo_name} #{nf.version_constraint} is required by #{nf.requirer}"
  end
  ss << 'Please resolve the conflict.'
  abort ss.join("\n")
end

#test(files_or_dirs, options) ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/vim-flavor/facade.rb', line 20

def test(files_or_dirs, options)
  trace "-------- Preparing dependencies\n"

  flavorfile = FlavorFile.load_or_new(Dir.getwd().to_flavorfile_path)
  flavorfile.flavor 'kana/vim-vspec', '~> 1.5', :group => :development unless
    flavorfile.flavor_table.has_key?('kana/vim-vspec')
  lockfile = LockFile.load_or_new(Dir.getwd().to_lockfile_path)

  refresh_flavors(
    options[:update_dependencies] ? :update : :install,
    flavorfile,
    lockfile,
    [:runtime, :development],
    Dir.getwd().to_stash_path.to_deps_path
  )

  trace "-------- Testing a Vim plugin\n"

  this_path = Dir.getwd()
  deps_path = this_path.to_stash_path.to_deps_path
  runner = "#{deps_path}/#{'kana/vim-vspec'.zap}/bin/prove-vspec"
  plugin_paths = lockfile.flavors.map {|f|
    "#{deps_path}/#{f.repo_name.zap}"
  }
  runtime_paths = ([this_path] + plugin_paths).flat_map {|p| ['-d', p]}
  command =
    %Q{ '#{runner}' \
        #{runtime_paths.flat_map {|p| ['-d', p]}.shelljoin} \
        #{files_or_dirs.shelljoin} }
  succeeded = system(command)
  exit(1) unless succeeded
end

#trace(message) ⇒ Object 



265
266
267
 
# File 'lib/vim-flavor/facade.rb', line 265

def trace message
  print message
end

#update(vimfiles_path, target_repo_names) ⇒ Object 



15
16
17
18
 
# File 'lib/vim-flavor/facade.rb', line 15

def update(vimfiles_path, target_repo_names)
  @target_repo_names = target_repo_names
  install_or_update(:update, vimfiles_path)
end