Merges branch 'release/0.2.1'

Author: dsawardekar

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+### 0.2.1
+
+* Adds support for nested plugin directories like,
+  `foo-plugin/repo/foo-plugin.`. This detection assumes that the
+  in-between directory contains the keyword `repo`.
+* Improves error messaging if WordPress path is not detected.
+* Improves excludes list passed to `ctags`, better fix for #16.
+
 ### 0.2.0
 
 * Built using @tek's Riml fork.

autoload/wordpress.vim

@@ -752,6 +752,11 @@ function! s:PluginDetector_is_plugin(path) dict
   let dirname = fnamemodify(a:path, ':t')
   if dirname ==# 'plugins' || dirname ==# 'mu-plugins'
     return 1
+  elseif dirname =~# 'repo'
+    let parent_dir = fnamemodify(a:path, ':h')
+    let parent_dirname = fnamemodify(parent_dir, ':t')
+    let plugin_file = parent_dir . "/" . dirname . "/" . parent_dirname . ".php"
+    return self.has_plugin_file(plugin_file) && self.has_plugin_header(plugin_file)
   else
     let plugin_file = a:path . "/" . dirname . ".php"
     return self.has_plugin_file(plugin_file) && self.has_plugin_header(plugin_file)
@@ -1552,7 +1557,7 @@ function! s:CTagsCommandBuilder_build() dict
   let cmd .= " --regex-PHP=" . shellescape(re)
   let dirs = self.get_exclude_dirs()
   for dir in dirs
-    let cmd .= " --exclude " . dir
+    let cmd .= " --exclude=" . dir
   endfor
   let cmd .= " ."
   return cmd
@@ -2544,8 +2549,12 @@ function! s:WordPressPath_get_path(root) dict
     endif
   endfor
   let path = self.find_wp_cli_project_path(a:root)
-  if path ==# '' && exists('g:wordpress_vim_wordpress_path')
-    let path = g:wordpress_vim_wordpress_path
+  if path ==# ''
+    if exists('g:wordpress_vim_wordpress_path')
+      let path = g:wordpress_vim_wordpress_path
+    else
+      call s:echo_error('WordPress not detected, Please set g:wordpress_vim_wordpress_path in your vimrc')
+    endif
   endif
   return path
 endfunction
@@ -3910,6 +3919,10 @@ function! s:ConfigureTagsCommand_generate_ctags(...) dict
     let msg = 'Generating'
   endif
   let ctags_builder = self.lookup('ctags_builder')
+  if ctags_builder.get_project_path() ==# ''
+    call s:echo_error('Could not generate tags, WordPress not detected, Please set g:wordpress_vim_wordpress_path in your vimrc')
+    return 0
+  endif
   if self.needs_tags_generation()
     call s:echo_msg("WordPress: " . msg . " ctags ...")
     call ctags_builder.generate()
@@ -3928,8 +3941,10 @@ function! s:ConfigureTagsCommand_regenerate_ctags() dict
   if filereadable(tags_path)
     call delete(tags_path)
   endif
-  call self.generate_ctags('Regenerating')
-  call s:echo_msg('WordPress: Regenerating ctags DONE')
+  let didGenerate = self.generate_ctags('Regenerating')
+  if didGenerate
+    call s:echo_msg('WordPress: Regenerating ctags DONE')
+  endif
 endfunction
 
 function! s:ConfigureTagsCommand_needs_tags_generation() dict

lib/wordpress/controllers/commands/configure_tags_command.riml

@@ -34,6 +34,10 @@ class ConfigureTagsCommand < WordPressProjectCommand
 
   defm generate_ctags(msg = 'Generating')
     ctags_builder = self.lookup('ctags_builder')
+    if ctags_builder.get_project_path() == ''
+      echo_error('Could not generate tags, WordPress not detected, Please set g:wordpress_vim_wordpress_path in your vimrc')
+      return false
+    end
 
     if self.needs_tags_generation()
       echo_msg("WordPress: #{msg} ctags ...")
@@ -57,8 +61,10 @@ class ConfigureTagsCommand < WordPressProjectCommand
       delete(tags_path)
     end
 
-    self.generate_ctags('Regenerating')
-    echo_msg('WordPress: Regenerating ctags DONE')
+    didGenerate = self.generate_ctags('Regenerating')
+    if didGenerate
+      echo_msg('WordPress: Regenerating ctags DONE')
+    end
   end
 
   defm needs_tags_generation

lib/wordpress/ctags/ctags_command_builder.riml

@@ -27,7 +27,7 @@ class CTagsCommandBuilder
     " exclude files to fix #16
     dirs = self.get_exclude_dirs();
     for dir in dirs
-      cmd .= " --exclude #{dir}"
+      cmd .= " --exclude=#{dir}"
     end
 
     cmd .= " ."

lib/wordpress/models/detectors/plugin_detector.riml

@@ -26,6 +26,11 @@ class PluginDetector < BufferTypeDetector
 
     if dirname == 'plugins' || dirname == 'mu-plugins'
       return true
+    elseif dirname =~ 'repo'
+      parent_dir     = fnamemodify(path, ':h')
+      parent_dirname = fnamemodify(parent_dir, ':t')
+      plugin_file    = "#{parent_dir}/#{dirname}/#{parent_dirname}.php"
+      return self.has_plugin_file(plugin_file) && self.has_plugin_header(plugin_file)
     else
       plugin_file = "#{path}/#{dirname}.php"
       return self.has_plugin_file(plugin_file) && self.has_plugin_header(plugin_file)

lib/wordpress/models/wordpress_path.riml

@@ -26,9 +26,13 @@ class WordPressPath
     " path comes from ~/.wp-cli/config.yml
     path = self.find_wp_cli_project_path(root)
 
-    if path == '' && exists('g:wordpress_vim_wordpress_path')
-      " wp cli missing but has global wordpress vim config
-      path = g:wordpress_vim_wordpress_path
+    if path == ''
+      if exists('g:wordpress_vim_wordpress_path')
+        " wp cli missing but has global wordpress vim config
+        path = g:wordpress_vim_wordpress_path
+      else
+        echo_error('WordPress not detected, Please set g:wordpress_vim_wordpress_path in your vimrc')
+      end
     end
 
     return path

lib/wordpress/version.riml

@@ -1 +1 @@
-g:wordpress_vim_version = '0.2.0'
+g:wordpress_vim_version = '0.2.1'

plugin/wordpress.vim

@@ -196,6 +196,11 @@ function! s:PluginDetector_is_plugin(path) dict
   let dirname = fnamemodify(a:path, ':t')
   if dirname ==# 'plugins' || dirname ==# 'mu-plugins'
     return 1
+  elseif dirname =~# 'repo'
+    let parent_dir = fnamemodify(a:path, ':h')
+    let parent_dirname = fnamemodify(parent_dir, ':t')
+    let plugin_file = parent_dir . "/" . dirname . "/" . parent_dirname . ".php"
+    return self.has_plugin_file(plugin_file) && self.has_plugin_header(plugin_file)
   else
     let plugin_file = a:path . "/" . dirname . ".php"
     return self.has_plugin_file(plugin_file) && self.has_plugin_header(plugin_file)
@@ -382,7 +387,7 @@ function! s:echo_with(args, style)
 endfunction
 
 " included: 'version.riml'
-let g:wordpress_vim_version = '0.2.0'
+let g:wordpress_vim_version = '0.2.1'
 function! s:WordPressPluginConstructor()
   let wordPressPluginObj = {}
   let wordPressPluginObj.start = function('<SNR>' . s:SID() . '_WordPressPlugin_start')

spec/wordpress/ctags/ctags_command_builder_spec.riml

@@ -128,7 +128,7 @@ class CTagsCommandBuilderSpec
     dirs = self.builder.get_exclude_dirs()
 
     for dir in dirs
-      expect(cmd).to_match("--exclude #{dir}")
+      expect(cmd).to_match("--exclude=#{dir}")
     end
   end
 end

spec/wordpress/models/detectors/plugin_detector_spec.riml

@@ -42,6 +42,12 @@ class PluginDetectorSpec
     expect(result).to_be_false()
   end
 
+  defm it_knows_plugin_inside_repo_is_a_wordpress_plugin
+    repo_plugin = "spec/wordpress/projects/plugin-inside-repo/repo"
+    result = self.detector.is_plugin(repo_plugin)
+    expect(result).to_be_true()
+  end
+
   defm it_can_detect_if_path_is_inside_plugin
     result = self.detector.detect('spec/wordpress/projects/sample-wordpress-plugin')
     expect(result.status).to_be_true()
@@ -77,4 +83,10 @@ class PluginDetectorSpec
     expect(result.status).to_be_true()
     expect(result.path).to_match('spec/wordpress/projects/sample-wordpress-plugin$')
   end
+
+  defm it_can_detect_correct_path_for_plugin_inside_repo
+    result = self.detector.detect('spec/wordpress/projects/plugin-inside-repo/repo')
+    expect(result.status).to_be_true()
+    expect(result.path).to_match('spec/wordpress/projects/plugin-inside-repo/repo$')
+  end
 end