mactag 0.3.3 → 0.4.0

data/README.markdown

@@ -44,7 +44,7 @@ Install the gem:
     
 Load the gem in **Gemfile**:
     group :development do
-      gem 'mactag', '0.3.3'
+      gem 'mactag', '0.4.0'
     end
 
 
@@ -64,12 +64,16 @@ examples of how to configure Mactag.
 
 * **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 TAGS -e**
+* **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 TAGS'
+    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
       app 'app/**/*.rb', 'lib/*.rb'
@@ -82,10 +86,28 @@ examples of how to configure Mactag.
       rails :except => :actionmailer, :version => '2.3.5'
     end
 
-
 # Usage
 To create the TAGS file. Simply run:
-    $ rake mactag
+    $ rake mactag:create
+
+
+# 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.
+
+To enable FSSM, add the **fssm** gem to your projects Gemfile.
+
+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>
 
 
 # License

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.0

data/lib/mactag.rb

@@ -1,15 +1,20 @@
-require 'rails'
-
 require 'mactag/railtie'
 require 'mactag/config'
 require 'mactag/builder'
 require 'mactag/dsl'
-require 'mactag/ctags'
 require 'mactag/tag'
+require 'mactag/ctags'
+require 'mactag/server'
+require 'mactag/event_handler'
+require 'mactag/tags_file'
 
 module Mactag
+  autoload :Bundler, 'bundler'
+  autoload :Rails, 'rails'
+  autoload :FSSM, 'fssm'
+
   def self.warn(message)
-    $stderr.puts "Mactag Warning: #{message}"
+    STDERR.puts(message)
   end
 end
 

data/lib/mactag/builder.rb

@@ -8,27 +8,24 @@ module Mactag
       @tags = []
     end
 
-    ##
-    #
-    # Add +tag+ to list of tags.
-    #
     def <<(tags)
       @tags += Array(tags)
     end
 
-    ##
-    #
-    # Returns a string with all files that should be tagged. The
-    # files are separated with a whitespace.
-    #
-    def tags
+    def files
       tags = all
       tags.flatten!
       tags.compact!
       tags.collect! { |file| File.expand_path(file) }
       tags.collect! { |file| Dir.glob(file) }
+      tags.flatten!
       tags.uniq!
-      tags.join(' ')
+      tags.reject! { |file| File.directory?(file) }
+      tags
+    end
+
+    def directories
+      files.collect { |file| File.dirname(file) }.uniq
     end
 
     def all
@@ -39,42 +36,20 @@ module Mactag
       all.flatten.compact.any?
     end
 
-    ##
-    #
-    # Create the TAGS file.
-    #
     def self.create
       unless gem_home_exists?
         Mactag.warn 'Gem home path does not exist on your system'
       end
 
-      tags = Mactag::Ctags.new(@builder)
-      if tags.build
+      if @builder.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'
       end
     end
 
-    ##
-    #
-    # Generates the TAGS-table.
-    #
-    # ==== Example
-    #   Mactag::Builder.generate do
-    #     app 'app/**/*.rb', 'lib/*.rb'
-    #
-    #     plugins 'thinking-sphinx', 'whenever'
-    #
-    #     gems 'paperclip', 'authlogic'
-    #     gem 'formtastic', :version => '0.9.7'
-    #
-    #     rails :except => :actionmailer, :version => '2.3.5'
-    #   end
-    #
-    # See documentation for the methods *app*, *plugins*, *gems* and
-    # *rails* in respective tag class.
-    #
     def self.generate(&block)
       @builder = Mactag::Builder.new
 
@@ -82,13 +57,12 @@ module Mactag
       dsl.instance_eval(&block)
     end
 
-    ##
-    #
-    # Returns true if the specified gem home path exists on the
-    # system, false otherwise.
-    #
     def self.gem_home_exists?
       File.directory?(Mactag::Config.gem_home)
     end
+
+    def self.builder
+      @builder
+    end
   end
 end

data/lib/mactag/config.rb

@@ -2,15 +2,34 @@ module Mactag
   class Config
     ##
     #
-    # The command to run when creating the TAGS-file.
-    #   Mactag::Config.binary = 'etags -o TAGS'
+    # The command to run (replacing {OUTPUT} with Mactag::Config.tags_file
+    # and {INPUT} with the input files) when creating the TAGS-file.
     #
-    @@binary = 'ctags -o TAGS -e'
+    #   Mactag::Config.binary = 'etags -o {OUTPUT} {INPUT}'
+    #
+    @@binary = 'ctags -o {OUTPUT} -e {INPUT}'
     cattr_accessor :binary
 
+    ##
+    #
+    # Name of the output tags file.
+    #
+    # Mactag::Config.binary = 'TAGS_FILE'
+    #
+    @@tags_file = 'TAGS'
+    cattr_accessor :tags_file
+
+    ##
+    #
+    # Directory to store tags in when using Mactag server and FSSM.
+    #
+    @@tags_dir = '.tags'
+    cattr_accessor :tags_dir
+
     ##
     #
     # The system folder where the gems are located.
+    #
     #   Mactag::Config.gem_home = '/Library/Ruby/Gems/1.8/gems'
     #
     @@gem_home = '/Library/Ruby/Gems/1.8/gems'
@@ -28,6 +47,7 @@ module Mactag
     #
     # 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

data/lib/mactag/ctags.rb

@@ -1,23 +1,32 @@
-require 'rails'
-
 module Mactag
   ##
   #
-  # Helper class for creating CTags files.
+  # Wrapper around Ctags command.
   #
   class Ctags
-    def initialize(builder)
-      @builder = builder
+    def initialize(input, output)
+      @input = Array(input)
+      @output = output
+    end
+
+    def create
+      system(command)
     end
 
-    ##
-    #
-    # Creates the tags file. Returns true if anything was tagged,
-    # false otherwise.
-    #
-    def build
-      system "cd #{Rails.root} && #{Mactag::Config.binary} #{@builder.tags}"
-      @builder.gems?
+
+    private
+    
+    def command
+      "cd #{Rails.root} && #{binary}"
+    end
+
+    def binary
+      binary = Mactag::Config.binary
+
+      binary.gsub!('{OUTPUT}', @output)
+      binary.gsub!('{INPUT}', @input.join(' '))
+      
+      binary
     end
   end
 end

data/lib/mactag/event_handler.rb

@@ -0,0 +1,22 @@
+module Mactag
+  class EventHandler
+    def update(file)
+      tags_file = Mactag::TagsFile.new(file)
+      if tags_file.exist?
+        tags_file.delete
+        tags_file.create
+      end
+    end
+    
+    def delete(file)
+      tags_file = Mactag::TagsFile.new(file)
+      if tags_file.exist?
+        tags_file.delete
+      end
+    end
+    
+    def create(file)
+      Mactag::TagsFile.new(file).create
+    end
+  end
+end

data/lib/mactag/railtie.rb

@@ -1,7 +1,7 @@
 module Mactag
   class Railtie < Rails::Railtie
     rake_tasks do
-      load "tasks/mactag.rake"
+      load 'tasks/mactag.rake'
     end
   end
 end

data/lib/mactag/server.rb

@@ -0,0 +1,48 @@
+module Mactag
+  class Server
+    class << self
+      def start
+        create_tags_dir
+        clear_tags
+        init_tags
+        init_monitor
+      end
+
+
+      private
+
+      def create_tags_dir
+        tags_dir = File.join(Rails.root, Mactag::Config.tags_dir)
+        unless File.directory?(tags_dir)
+          Dir.mkdir(tags_dir)
+        end
+      end
+
+      def clear_tags
+        tags_files = File.join(Rails.root, Mactag::Config.tags_dir, '*')
+        Dir.glob(tags_files).each do |file|
+          File.delete(file)
+        end
+      end
+
+      def init_tags
+        Mactag::Builder.builder.files.each do |file|
+          Mactag::TagsFile.new(file).create
+        end
+      end
+
+      def init_monitor
+        event_handler = Mactag::EventHandler.new
+        FSSM.monitor do
+          Mactag::Builder.builder.directories.each do |directory|
+            path(directory) do
+              update { |base, relative| event_handler.update(File.join(base, relative)) }
+              delete { |base, relative| event_handler.delete(File.join(base, relative)) }
+              create { |base, relative| event_handler.create(File.join(base, relative)) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mactag/tag/gem.rb

@@ -6,7 +6,7 @@ module Mactag
     #
     # ==== Examples
     #   Mactag do
-    #     # Tag all gems given by *...*
+    #     # Tags all gems specified in Gemfile.
     #     gems
     #
     #     # Tag the whenever gem, latest version
@@ -20,8 +20,6 @@ module Mactag
     #   do
     #
     class Gem
-      autoload :Bundler, 'bundler'
-
       def initialize(name, version = nil)
         @name = name
         @version = version
@@ -40,10 +38,6 @@ module Mactag
         end
       end
 
-      ##
-      #
-      # Returns all application gems in Bundler default group.
-      #
       def self.all
         gems = {}
         Bundler.load.specs.each do |spec|
@@ -55,10 +49,6 @@ module Mactag
         default.collect { |tmp| Gem.new(tmp, gems[tmp]) }
       end
 
-      ##
-      #
-      # Returns the most recent gem with +name+.
-      #
       def self.most_recent(name)
         versions = Dir.glob(File.join(Mactag::Config.gem_home, name) + "-*")
         unless versions.empty?
@@ -74,10 +64,6 @@ module Mactag
 
       private
 
-      ##
-      #
-      # Returns true if +gem+ exists, false otherwise.
-      #
       def exists?
         if @version
           File.directory?(File.join(Mactag::Config.gem_home, splash))
@@ -86,10 +72,6 @@ module Mactag
         end
       end
 
-      ##
-      #
-      # Returns the gem name, dash, version.
-      #
       def splash
         "#{@name}-#{@version}"
       end

data/lib/mactag/tag/rails.rb

@@ -41,15 +41,7 @@ module Mactag
     #   do
     #
     class Rails
-      PACKAGES = [
-                  :actionmailer,
-                  :actionpack,
-                  :activemodel,
-                  :activerecord,
-                  :activeresource,
-                  :railties,
-                  :activesupport
-                 ]
+      PACKAGES = [:actionmailer, :actionpack, :activemodel, :activerecord, :activeresource, :railties, :activesupport]
 
       def initialize(options)
         @options = options
@@ -70,11 +62,7 @@ module Mactag
 
 
       private
-
-      ##
-      #
-      # Returns a list of all packages that should be included.
-      #
+      
       def packages
         result = []
         unless @only || @except
@@ -88,11 +76,7 @@ module Mactag
         end
         result
       end
-
-      ##
-      #
-      # Packagizes all +pkgs+.
-      #
+      
       def packagize!(pkgs)
         return nil if pkgs.blank?
 
@@ -100,11 +84,7 @@ module Mactag
           "#{pkg}".gsub(/[^a-z]/, '').to_sym
         end
       end
-
-      ##
-      #
-      # Returns what Rails version to use.
-      #
+      
       def version
         @options[:version] || ::Rails.version
       end