guard-ctags-bundler 0.0.5 → 0.1.0

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 /vendor/ruby
+/test/test_project/tags
+/test/test_project/gems.tags

data/Gemfile

@@ -2,3 +2,5 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in guard-ctags-bundler.gemspec
 gemspec
+
+gem "rake", :require => false

data/README.md

@@ -1,4 +1,4 @@
-Guard-CTags-Bundler
+###### Guard-CTags-Bundler
 =
 
 Guard-CTags-Bundler generates [ctags](http://ctags.sourceforge.net) for your project and for gems in your bundle. For project tags file `tags` is generated, for gems tags file `gems.tags` is generated.
@@ -27,6 +27,23 @@ And then add a basic setup to your `Guardfile`:
 
     $ guard init ctags-bundler
 
+## Usage
+
+Please, read [Guard usage doc](https://github.com/guard/guard#readme)
+
+## Guardfile Options
+
+``` ruby
+:src_path => ".", # source path to be scanned for tags (default .)
+:emacs => false, # run ctags in emacs mode and merge tags and gems.tags into TAGS file
+```
+
+For a typical Rails application, `Guardfile` can look like this (default):
+
+    guard 'ctags-bundler', :src_path => ["app", "lib", "spec/support"] do
+      watch(/^(app|lib|spec\/support)\/.*\.rb$/)
+      watch('Gemfile.lock')
+    end
 
 ## CTags
 
@@ -42,14 +59,13 @@ Vim supports ctags by default. All you need to do is add your `gems.tags` file t
 
     set tags+=gems.tags
 
-
 ## Emacs
 
 Ctags can be used with emacs too. Add `:emacs => true` option to your Guardfile and ctags will be generated with `-e` option:
 
-    guard 'ctags-bundler', :emacs => true do
-      watch(%r{^(app|lib|spec/support)/.*\.rb$})  { ["app", "lib", "spec/support"] }
+    guard 'ctags-bundler', :emacs => true, :src_path => ["app", "lib", "spec/support"] do
+      watch(/^(app|lib|spec\/support)\/.*\.rb$/)
       watch('Gemfile.lock')
     end
 
-Thanks to [Jorge Dias](https://github.com/diasjorge) for this patch.
+Thanks to [Jorge Dias](https://github.com/diasjorge) and [Antono Vasiljev](https://github.com/antono) for emacs support.

data/Rakefile

@@ -1 +1,11 @@
 require "bundler/gem_tasks"
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  #t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end

data/guard-ctags-bundler.gemspec

@@ -19,8 +19,10 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  s.add_dependency 'guard', '>= 0.4.0'
+  s.add_dependency 'guard', '>= 1.0.0'
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "purdytest"
 
-  # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
 end

data/lib/guard/ctags-bundler.rb

@@ -1,4 +1,5 @@
 require "guard/ctags-bundler/version"
+require "guard/ctags-bundler/ctags_generator"
 require 'guard'
 require 'guard/guard'
 require 'bundler'
@@ -8,41 +9,27 @@ module Guard
   class CtagsBundler < Guard
     def initialize(watchers = [], options = {})
       super(watchers, options)
+      @ctags_generator = ::Guard::Ctags::Bundler::CtagsGenerator.new(options)
     end
 
     def start
       UI.info 'Guard::CtagsBundler is running!'
+      @ctags_generator.generate_bundler_tags
+      @ctags_generator.generate_project_tags
     end
 
-    def run_on_change(paths)
+    def run_on_changes(paths)
       if paths.include?('Gemfile.lock')
         UI.info "regenerating bundler tags..."
-        generate_bundler_tags
+        @ctags_generator.generate_bundler_tags
       end
+
       ruby_files = paths.reject {|f| f == 'Gemfile.lock'}
+
       if ruby_files.any?
         UI.info "regenerating project tags..."
-        generate_project_tags(ruby_files)
+        @ctags_generator.generate_project_tags
       end
     end
-
-    private
-
-    def generate_project_tags(paths)
-      generate_tags(paths, "tags")
-    end
-
-    def generate_bundler_tags
-      runtime = ::Bundler::Runtime.new Dir.pwd, ::Bundler.definition
-      paths = runtime.specs.map(&:full_gem_path)
-      generate_tags(paths, "gems.tags")
-    end
-
-    def generate_tags(paths, tag_file)
-      paths = paths.join(' ').strip
-      cmd = "find #{paths} -type f -name \\*.rb | ctags -f #{tag_file} -L -"
-      cmd << " -e" if options[:emacs]
-      system(cmd)
-    end
   end
 end

data/lib/guard/ctags-bundler/ctags_generator.rb

@@ -0,0 +1,29 @@
+class Guard::Ctags::Bundler::CtagsGenerator
+  def initialize(opts = {})
+    @opts = opts
+  end
+
+  def generate_project_tags
+    generate_tags(@opts[:src_path] || ".", "tags")
+  end
+
+  def generate_bundler_tags
+    definition = Bundler::Definition.build("Gemfile", "Gemfile.lock", nil)
+    runtime = Bundler::Runtime.new(Dir.pwd, definition)
+    paths = runtime.requested_specs.map(&:full_gem_path)
+    generate_tags(paths, "gems.tags")
+  end
+
+  private
+
+  def generate_tags(path, tag_file)
+    if path.instance_of?(Array)
+      path = path.join(' ').strip
+    end
+
+    cmd = "find #{path} -type f -name \\*.rb | ctags -f #{tag_file} -L -"
+    cmd << " -e" if @opts[:emacs]
+    system(cmd)
+    system("cat tags gems.tags > TAGS") if @opts[:emacs]
+  end
+end

data/lib/guard/ctags-bundler/templates/Guardfile

@@ -1,4 +1,4 @@
-guard 'ctags-bundler' do
-  watch(%r{^(app|lib|spec/support)/.*\.rb$})  { ["app", "lib", "spec/support"] }
+guard 'ctags-bundler', :src_path => ["app", "lib", "spec/support"] do
+  watch(/^(app|lib|spec\/support)\/.*\.rb$/)
   watch('Gemfile.lock')
 end

data/lib/guard/ctags-bundler/version.rb

@@ -1,7 +1,7 @@
 module Guard
   module Ctags
     module Bundler
-      VERSION = "0.0.5"
+      VERSION = "0.1.0"
     end
   end
 end

data/test/ctags-bundler/ctags_generator_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+require 'guard/ctags-bundler/ctags_generator'
+
+class CtagsGeneratorTest < MiniTest::Unit::TestCase
+  def setup
+    clean_tags
+    Dir.chdir(test_project_path)
+  end
+
+  def test_generate_project_tags
+    generator.generate_project_tags
+    assert File.exists?(test_tags_file)
+  end
+
+  def test_generate_project_tags_for_src_path_only
+    generator(src_path: ["app", "lib"]).generate_project_tags
+    result = File.read(test_tags_file)
+    assert_match("method_of_class_1", result)
+    assert_match("method_of_class_2", result)
+    refute_match("method_of_class_3", result)
+    refute_match("Rake", result)
+  end
+
+  def test_generate_bundler_tags
+    generator.generate_bundler_tags
+    assert File.exists?(test_gems_tags_file)
+    result = File.read(test_gems_tags_file)
+    assert_match("Rake", result)
+    refute_match("method_of_class_1", result)
+    refute_match("method_of_class_2", result)
+    refute_match("method_of_class_3", result)
+  end
+
+  private
+
+  def generator(opts = {})
+    Guard::Ctags::Bundler::CtagsGenerator.new(opts)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'purdytest'
+
+def test_project_path
+  File.expand_path("test_project", File.dirname(__FILE__))
+end
+
+def test_tags_file
+  File.join(test_project_path, "tags")
+end
+
+def test_gems_tags_file
+  File.join(test_project_path, "gems.tags")
+end
+
+def clean_tags
+  [test_tags_file, test_gems_tags_file].each do |file|
+    File.delete(file) if File.exists?(file)
+  end
+end

data/test/test_project/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gem "rake", :require => false

data/test/test_project/app/class1.rb

@@ -0,0 +1,4 @@
+class Class1
+  def method_of_class_1
+  end
+end

data/test/test_project/lib/class2.rb

@@ -0,0 +1,4 @@
+class Class2
+  def method_of_class_2
+  end
+end

data/test/test_project/vendor/class3.rb

@@ -0,0 +1,4 @@
+class Class3
+  def method_of_class_3
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: guard-ctags-bundler
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,56 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-02 00:00:00.000000000 Z
+date: 2012-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &7474100 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *7474100
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: purdytest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! 'Guard::CtagsBundler uses ctags utility and generates 2 files: tags
   -- with tags generated from project''s source tree and gems.tags -- with tags generated
   from rubygems from project''s bundle.'
@@ -38,8 +75,15 @@ files:
 - Rakefile
 - guard-ctags-bundler.gemspec
 - lib/guard/ctags-bundler.rb
+- lib/guard/ctags-bundler/ctags_generator.rb
 - lib/guard/ctags-bundler/templates/Guardfile
 - lib/guard/ctags-bundler/version.rb
+- test/ctags-bundler/ctags_generator_test.rb
+- test/test_helper.rb
+- test/test_project/Gemfile
+- test/test_project/app/class1.rb
+- test/test_project/lib/class2.rb
+- test/test_project/vendor/class3.rb
 homepage: https://github.com/ivalkeen/guard-ctags-bundler
 licenses: []
 post_install_message: 
@@ -52,15 +96,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 974875642901378133
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 974875642901378133
 requirements: []
 rubyforge_project: guard-ctags-bundler
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Guard gem for generating ctags for project files and gems from project's