guard-ctags-composer 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+/vendor/ruby
+/test/test_project/tags
+/test/test_project/gems.tags

data/LICENSE

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) 2011 Ivan Tkalin
+              2012 Konstantin Kudryashov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,72 @@
+###### Guard-CTags-Composer
+=
+
+Guard-CTags-Composer generates [ctags](http://ctags.sourceforge.net) for your PHP project and for `vendor` libs.
+For project tags file `tags` is generated, for vendor tags file `gems.tags` is generated.
+
+Features
+-
+
+* When you run `composer install` in your project, `vendor.tags` file is automatically is generated or updated.
+* When you save one of you project's php files, `tags` file is automatically generated or updated.
+
+## Install
+
+Make sure you have [Guard](http://github.com/guard/guard) installed.
+
+Install the gem:
+
+    $ gem install guard-ctags-composer
+
+Add a basic setup to your `Guardfile`:
+
+    $ guard init ctags-composer
+
+## 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 `src`)
+:vendor_path => ".", # source path to be scanned for vendor tags (default `vendor`)
+: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-composer', :src_path => ["src"], :vendor_path => ["vendor"] do
+      watch(/^(src)\/.*\.php/)
+      watch('composer.lock')
+    end
+
+## CTags
+
+[Ctags](http://ctags.sourceforge.net) generates an index (or tag) file of language objects found in
+source files that allows these items to be quickly and easily located by a text editor or other utility.
+A tag signifies a language object for which an index entry is available (or, alternatively, the index
+entry created for that object). 
+
+In ubuntu you can install ctags by running
+
+    $ sudo apt-get install exuberant-ctags
+
+## Vim
+
+Vim supports ctags by default. All you need to do is add your `gems.tags` file to the Vim's tag stack.
+
+    set tags+=vendor.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-composer', :emacs => true do
+      watch(/^(src)\/.*\.php/)
+      watch('composer.lock')
+    end
+
+## Fork
+
+This version is a forked edition of `guard-ctags-bundler` gem.

data/guard-ctags-composer.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = "guard-ctags-composer"
+  s.version     = "0.0.1"
+  s.authors     = ["Konstantin Kudryashov"]
+  s.email       = ["ever.zet@gmail.com"]
+  s.homepage    = "https://github.com/everzet/guard-ctags-composer"
+  s.summary     = %q{Guard gem for generating ctags for project files and vendor libraries.}
+  s.description = %q{Guard::CtagsComposer uses ctags utility and generates 2 files: tags -- with tags generated from project's source tree and vendor.tags -- with tags generated from vendor folder.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_dependency 'guard', '>= 1.0.0'
+
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "purdytest"
+end

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

@@ -0,0 +1,32 @@
+module Guard
+  module Ctags
+    module Composer
+      class CtagsGenerator
+        def initialize(opts = {})
+          @opts = opts
+        end
+
+        def generate_project_tags
+          generate_tags(@opts[:src_path] || "src", "tags")
+        end
+
+        def generate_vendor_tags
+          generate_tags(@opts[:vendor_path] || "vendor", "vendor.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 \\*.php | ctags -f #{tag_file} -L -"
+          cmd << " -e" if @opts[:emacs]
+          system(cmd)
+          system("cat tags vendor.tags > TAGS") if @opts[:emacs]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+guard 'ctags-composer', :src_path => ["src"], :vendor_path => ["vendor"] do
+  watch(/^(src|tests)\/.*\.php$/)
+  watch('composer.lock')
+end

data/lib/guard/ctags-composer.rb

@@ -0,0 +1,32 @@
+require "guard/ctags-composer/ctags_generator"
+require 'guard'
+require 'guard/guard'
+
+module Guard
+  class CtagsComposer < Guard
+    def initialize(watchers = [], options = {})
+      super(watchers, options)
+      @ctags_generator = ::Guard::Ctags::Composer::CtagsGenerator.new(options)
+    end
+
+    def start
+      UI.info 'Guard::CtagsComposer is running!'
+      @ctags_generator.generate_vendor_tags
+      @ctags_generator.generate_project_tags
+    end
+
+    def run_on_changes(paths)
+      if paths.include?('composer.lock')
+        UI.info "regenerating vendor tags..."
+        @ctags_generator.generate_vendor_tags
+      end
+
+      ruby_files = paths.reject {|f| f == 'composer.lock'}
+
+      if ruby_files.any?
+        UI.info "regenerating project tags..."
+        @ctags_generator.generate_project_tags
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: guard-ctags-composer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Konstantin Kudryashov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: purdytest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "Guard::CtagsComposer uses ctags utility and generates 2 files: tags -- with tags generated from project's source tree and vendor.tags -- with tags generated from vendor folder."
+email: 
+- ever.zet@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- guard-ctags-composer.gemspec
+- lib/guard/ctags-composer.rb
+- lib/guard/ctags-composer/ctags_generator.rb
+- lib/guard/ctags-composer/templates/Guardfile
+has_rdoc: true
+homepage: https://github.com/everzet/guard-ctags-composer
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Guard gem for generating ctags for project files and vendor libraries.
+test_files: []
+