mactag 0.4.0 → 0.5.3

data/README.markdown

@@ -1,81 +1,49 @@
 # Mactag
 
 Mactag is a plugin for Rails developers that do their development in
-an editor that supports Ctags (Emacs, Vim, TextMate, jEdit, ...). With
-Ctags you can follow tags (of functions, variables, macros, whatever)
-to their definitions.
+an editor that supports Ctags (Emacs, Vim, TextMate, ...). With Ctags
+you can follow tags (of functions, variables, macros, whatever) to
+their definitions.
 
 
 # Exuberant Ctags
 First off, you must install [Ctags](http://ctags.sourceforge.net/).
-Some systems comes with a ctags command already. If you have the ctags
-executable, but have problems creating the tags file. Then make sure
-that you are using **Exuberant Ctags** and not some other version.
+Some systems comes with a **ctags** command already. If you have the
+ctags executable, but have problems creating the tags file. Then make
+sure that you are using **Exuberant Ctags** and not some other version.
 
 
 # Installation
 
-## Rails 2.x
-
-### Plugin
-Install the plugin:
-    $ ./script/plugin install git://github.com/rejeep/mactag.git --revision 'tags/v0.0.5'
-
-### Gem
-Install the gem:
-    $ gem install mactag --version='0.0.5'
-    
-Load the gem in **config/environments/development.rb**:
-    config.gem 'mactag'
-    
-Load the rake tasks in **Rakefile**.
-    require 'mactag/tasks'
-
-
-## Rails 3.x
-
-### Plugin
+## Plugin
 Install the plugin:
     $ rails plugin install git://github.com/rejeep/mactag.git
 
-### Gem
+## Gem
 Install the gem:
     $ gem install mactag
     
-Load the gem in **Gemfile**:
+Add mactag to the **Gemfile**:
     group :development do
-      gem 'mactag', '0.4.0'
+      gem 'mactag'
     end
 
 
 # Configuration
-Generate a basic configuration file:
 
-## Rails 2.x
-    $ ./script/generate mactag
-    
-## Rails 3.x
+To generate a template configuration file (**config/mactag.rb**),
+which contains a basic setup and some examples of how to configure
+Mactag, use the **mactag** generator:
     $ rails generate mactag
 
-This will create the file **config/mactag.rb**, which contains some
-examples of how to configure Mactag.
-
-## Options
-
-* **Mactag::Config.rvm:** If true, use RVM gems. Defaults to **true**
-* **Mactag::Config.gem_home:** The path where the gems are located. Defaults to **/Library/Ruby/Gems/1.8/gems**
-* **Mactag::Config.binary:** The command to run when creating the TAGS-file. Defaults to **ctags -o {OUTPUT} -e {INPUT}**
-* **Mactag::Config.tags_file:** Name of output file. Defaults to **TAGS**
-* **Mactag::Config.tags_dir:** Name of output directory to store tags files when using FSSM. Defaults to **.tags**
-
 ## Example mactag.rb file
+
     Mactag::Config.rvm = false
     Mactag::Config.gem_home = '/usr/lib/ruby/gems/1.8/gems'
     Mactag::Config.binary = 'etags -o {OUTPUT} {INPUT}'
     Mactag::Config.tags_file = 'TAGS'
-    Mactag::Config.tags_dir = '.tags' # See FSSM
 
-    Mactag do # This is "Mactag::Table.generate do" in Rails 2 applications
+    Mactag do
       app 'app/**/*.rb', 'lib/*.rb'
 
       plugins 'thinking-sphinx', 'whenever'
@@ -85,29 +53,32 @@ examples of how to configure Mactag.
 
       rails :except => :actionmailer, :version => '2.3.5'
     end
+    
+## Options
+The available configuration options are described below.
 
-# Usage
-To create the TAGS file. Simply run:
-    $ rake mactag:create
-
+### Mactag::Config.rvm
+If true, use [Rvm](http://rvm.beginrescueend.com/) when indexing gems.  
+Defaults to: `true`
 
-# FSSM
-A problem with tags, is that when your project's code changes, your
-tags file will not keep up. Mactag can solve this by using FSSM, which
-is a tool that notice file system modifications.
+### Mactag::Config.gem_home
+Path to gems. No need to set this when using **Mactag::Config.rvm**.  
+Defaults to: `/Library/Ruby/Gems/1.8/gems`
+ 
+### Mactag::Config.binary
+The command to run when creating the TAGS-file. **{OUTPUT}** will be
+replaced with the value of **Mactag::Config.tags_file**. **{INPUT}**
+will be replaced with all files to index.  
+Defaults to: `ctags -o {OUTPUT} -e {INPUT}`
 
-To enable FSSM, add the **fssm** gem to your projects Gemfile.
+### Mactag::Config.tags_file
+Name of the output tags file.  
+Defaults to: `TAGS`
 
-Then start the server that keeps track of changes
-    rake mactag:server
-    
-This creates a couple of tags files in **Mactag::Config.tags_dir**
-(one for each source file). This means your editor must support
-multiple tags files.
 
-## Editor support
-
-* Emacs - <http://github.com/rejeep/mactag.el>
+# Usage
+To create the TAGS file, simply run:
+    $ rake mactag
 
 
 # License

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end
+
+task :default => :spec
+task :test => :spec

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.1

data/lib/generators/mactag/templates/mactag.rb

@@ -1,34 +1,52 @@
 ##
 #
-# Use RVM gem path. Mactag will automatically find this.
-# Defaults to *true*.
-#   Mactag::Config.rvm = true
+# Rvm support or not. Mactag will automatically set path to gems.
+#
+# Defaults to: true
+#
+# Example:
+#   Mactag::Config.rvm = false
 #
 
 ##
 #
-# Path to gems. This options is only interesting if Mactag::Config.rvm
-# is false.
+# Path to gems.
+#
+# Change to whatever your system is using, if not the default. Most
+# GNU/Linux systems use: /usr/lib/ruby/gems/1.8/gems
+#
+# (You don't need to set this when Mactag::Config.rvm is true)
+#
+# Defaults to: '/Library/Ruby/Gems/1.8/gems'
 #
-# Default is */Library/Ruby/Gems/1.8/gems* (standard path on Mac OS).
-# 
-# Change to whatever your system is using, if not the default.
-# Most GNU/Linux systems:
+# Example:
 #   Mactag::Config.gem_home = '/usr/lib/ruby/gems/1.8/gems'
 #
 
 ##
 #
-# Change the binary option if you are not satisfied with the standard
-# command (ctags -o TAGS -e) used to create the TAGS table.
-# Default is *ctags -o TAGS -e*
-#   Mactag::Config.binary = 'etags -o TAGS'
+# Name of tags file.
+#
+# Defaults to: 'TAGS'
+#
+# Example:
+#   Mactag::Config.tags_file = '.tags'
 #
 
 ##
 #
-# Example configuration. Change according to your application.
+# This is the command used to create the TAGS table.
+#
+# The command must specify:
+#   {INPUT}  - replaced by the input files to tag
+#   {OUTPUT} - replaced by Mactag::Config.tags_file
+#
+# Defaults to: 'ctags -o {OUTPUT} -e {INPUT}'
 #
+# Example:
+#   Mactag::Config.binary = '/usr/local/Cellar/ctags/5.8/bin/ctags -e -o {OUTPUT} {INPUT}'
+#
+
 Mactag do
   ##
   #
@@ -47,7 +65,7 @@ Mactag do
   # Index the gems paperclip and authlogic.
   #   gems 'paperclip', 'authlogic'
   #
-  
+
   ##
   #
   # Index the gem formtastic version 0.9.7.
@@ -59,16 +77,22 @@ Mactag do
   # Index all rails packages, except actionmailer.
   #   rails :except => :actionmailer
   #
-  
+
   ##
   #
   # Index only rails packages activerecord and activesupport.
   #   rails :only => [:activerecord, :active_support]
   #
-  
+
+  ##
+  #
+  # Index all rails packages, version 3.0.0.
+  #   rails :version => '3.0.0'
+  #
+
   ##
   #
-  # Index all rails packages, version 2.3.5.
-  #   rails :version => '2.3.5'
+  # Index all rails packages, same version as current application.
+  #   rails
   #
 end

data/lib/mactag.rb

@@ -4,18 +4,12 @@ require 'mactag/builder'
 require 'mactag/dsl'
 require 'mactag/tag'
 require 'mactag/ctags'
-require 'mactag/server'
-require 'mactag/event_handler'
-require 'mactag/tags_file'
+require 'mactag/bundler'
+require 'mactag/errors'
 
 module Mactag
   autoload :Bundler, 'bundler'
   autoload :Rails, 'rails'
-  autoload :FSSM, 'fssm'
-
-  def self.warn(message)
-    STDERR.puts(message)
-  end
 end
 
 def Mactag(&block)

data/lib/mactag/builder.rb

@@ -29,40 +29,42 @@ module Mactag
     end
 
     def all
-      @all_tags ||= @tags.collect!(&:tag)
+      @all ||= @tags.collect!(&:tag)
     end
 
-    def gems?
+    def has_gems?
       all.flatten.compact.any?
     end
 
-    def self.create
-      unless gem_home_exists?
-        Mactag.warn 'Gem home path does not exist on your system'
-      end
+    class << self
+      def create
+        unless gem_home_exists?
+          raise Mactag::MactagError.new("Specified gem home directory does not exist: #{Mactag::Config.gem_home}")
+        end
 
-      if @builder.gems?
-        Mactag::Ctags.new(@builder.files, Mactag::Config.tags_file).create
+        if builder.has_gems?
+          Mactag::Ctags.new(@builder.files, Mactag::Config.tags_file).create
 
-        puts "Successfully generated TAGS file"
-      else
-        Mactag.warn 'You did not specify anything to tag'
+          puts 'Successfully generated TAGS file'
+        else
+          raise Mactag::MactagError.new('Nothing to tag')
+        end
       end
-    end
 
-    def self.generate(&block)
-      @builder = Mactag::Builder.new
+      def generate(&block)
+        @builder = Mactag::Builder.new
 
-      dsl = Mactag::Dsl.new(@builder)
-      dsl.instance_eval(&block)
-    end
+        dsl = Mactag::Dsl.new(@builder)
+        dsl.instance_eval(&block)
+      end
 
-    def self.gem_home_exists?
-      File.directory?(Mactag::Config.gem_home)
-    end
+      def gem_home_exists?
+        File.directory?(Mactag::Config.gem_home)
+      end
 
-    def self.builder
-      @builder
+      def builder
+        @builder
+      end
     end
   end
 end

data/lib/mactag/bundler.rb

@@ -0,0 +1,36 @@
+module Mactag
+  ##
+  #
+  # For fetching information from Bundler regarding what gems are
+  # used.
+  #
+  class Bundler
+    def gems
+      dependencies.map do |dependency|
+        Mactag::Tag::Gem.new(dependency, specs[dependency])
+      end
+    end
+
+
+    private
+
+    def specs
+      @specs ||= runtime.specs.inject({}) do |hash, spec|
+        hash[spec.name] = spec.version.to_s
+        hash
+      end
+    end
+
+    def dependencies
+      default = runtime.dependencies.select { |dependency|
+        dependency.groups.include?(:default)
+      }.collect(&:name)
+      default.delete('rails')
+      default
+    end
+
+    def runtime
+      @runtime ||= ::Bundler.load
+    end
+  end
+end

data/lib/mactag/config.rb

@@ -21,10 +21,13 @@ module Mactag
 
     ##
     #
-    # Directory to store tags in when using Mactag server and FSSM.
+    # If using Ruby Version Manager (RVM), setting this option to true
+    # will enable Mactag to find out the gem path automatically.
+    #
+    #   Mactag::Config.rvm = false
     #
-    @@tags_dir = '.tags'
-    cattr_accessor :tags_dir
+    @@rvm = true
+    cattr_accessor :rvm
 
     ##
     #
@@ -42,15 +45,5 @@ module Mactag
         @@gem_home
       end
     end
-
-    ##
-    #
-    # If using Ruby Version Manager (RVM), setting this option to true
-    # will enable Mactag to find out the gem path automatically.
-    #
-    #   Mactag::Config.rvm = false
-    #
-    @@rvm = true
-    cattr_accessor :rvm
   end
 end

data/lib/mactag/ctags.rb

@@ -15,7 +15,7 @@ module Mactag
 
 
     private
-    
+
     def command
       "cd #{Rails.root} && #{binary}"
     end
@@ -25,7 +25,7 @@ module Mactag
 
       binary.gsub!('{OUTPUT}', @output)
       binary.gsub!('{INPUT}', @input.join(' '))
-      
+
       binary
     end
   end

data/lib/mactag/dsl.rb

@@ -13,6 +13,10 @@ module Mactag
     # @see Mactag::Tag::App
     #
     def app(*tags)
+      if tags.empty?
+        raise ArgumentError.new('App requires at least one argument')
+      end
+      
       tags.each do |tag|
         @builder << Mactag::Tag::App.new(tag)
       end
@@ -31,7 +35,7 @@ module Mactag
         @builder << Mactag::Tag::Plugin.new(plugin)
       end
     end
-    alias_method :plugins, :plugin
+    alias :plugins :plugin
 
     ##
     #
@@ -39,22 +43,30 @@ module Mactag
     #
     def gem(*gems)
       options = gems.extract_options!
+      
+      if options[:version] && gems.size > 1
+        raise ArgumentError.new('The :version option is not valid when specifying more than one gem')
+      end
 
       if gems.empty?
         @builder << Mactag::Tag::Gem.all
       else
-        gems.each do |name|
-          @builder << Mactag::Tag::Gem.new(name, options[:version])
+        gems.each do |gem|
+          @builder << Mactag::Tag::Gem.new(gem, options[:version])
         end
       end
     end
-    alias_method :gems, :gem
+    alias :gems :gem
 
     ##
     #
     # @see Mactag::Tag::Rails
     #
     def rails(options = {})
+      if options[:only] && options[:except]
+        raise ArgumentError.new('Can not specify options :only and :except at the same time')
+      end
+      
       @builder << Mactag::Tag::Rails.new(options)
     end
   end