mactag 0.2.0 → 0.3.0

data/README.markdown

@@ -31,7 +31,7 @@ Load the gem in **config/environments/development.rb**:
 
 
 ## Rails 3.x
-Version 0.1.1 is the latest version supporting Rails 3.x.
+Version 0.2.0 is the latest version supporting Rails 3.x.
 
 ### Plugin
 Install the plugin:
@@ -43,7 +43,7 @@ Install the gem:
     
 Load the gem in **Gemfile**:
     group :development do
-      gem 'mactag', '0.1.1'
+      gem 'mactag', '0.2.0'
     end
 
 
@@ -76,7 +76,7 @@ examples of how to configure Mactag.
     Mactag::Config.gem_home = '/usr/lib/ruby/gems/1.8/gems'
     Mactag::Config.binary = 'etags -o TAGS'
 
-    Mactag::Table.generate do
+    Mactag do # This is "Mactag::Table.generate do" in Rails 2 applications
       app 'app/**/*.rb', 'lib/*.rb'
 
       plugins 'thinking-sphinx', 'whenever'

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

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

@@ -29,7 +29,7 @@
 #
 # Example configuration. Change according to your application.
 #
-Mactag::Table.generate do
+Mactag do
   ##
   #
   # Index all ruby files in app recursive and all ruby files directly under lib.

data/lib/mactag.rb

@@ -1,5 +1,7 @@
 require 'mactag/config'
-require 'mactag/table'
+require 'mactag/builder'
+require 'mactag/parser'
+require 'mactag/ctags'
 require 'mactag/tag'
 
 module Mactag
@@ -7,3 +9,7 @@ module Mactag
     $stderr.puts "Mactag Warning: #{message}"
   end
 end
+
+def Mactag(&block)
+  Mactag::Builder.generate(&block)
+end

data/lib/mactag/builder.rb

@@ -0,0 +1,90 @@
+module Mactag
+  class Builder
+    def initialize
+      @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
+      tags = all
+      tags.flatten!
+      tags.compact!
+      tags.collect! { |file| File.expand_path(file) }
+      tags.collect! { |file| Dir.glob(file) }
+      tags.uniq!
+      tags.join(' ')
+    end
+
+    def all
+      @all_tags ||= @tags.collect!(&:tag)
+    end
+
+    def gems?
+      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
+        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
+
+      parser = Mactag::Parser.new(@builder)
+      parser.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
+  end
+end

data/lib/mactag/ctags.rb

@@ -0,0 +1,23 @@
+require 'rails'
+
+module Mactag
+  ##
+  #
+  # Helper class for creating CTags files.
+  #
+  class Ctags
+    def initialize(builder)
+      @builder = builder
+    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?
+    end
+  end
+end

data/lib/mactag/parser.rb

@@ -0,0 +1,61 @@
+module Mactag
+  ##
+  #
+  # Parser for builder.
+  #
+  class Parser
+    def initialize(builder)
+      @builder = builder
+    end
+
+    ##
+    #
+    # @see Mactag::Tag::App
+    #
+    def app(*tags)
+      tags.each do |tag|
+        @builder << Mactag::Tag::App.new(tag)
+      end
+    end
+
+    ##
+    #
+    # @see Mactag::Tag::Plugin
+    #
+    def plugin(*plugins)
+      if plugins.empty?
+        plugins = Mactag::Tag::Plugin.all
+      end
+
+      plugins.each do |plugin|
+        @builder << Mactag::Tag::Plugin.new(plugin)
+      end
+    end
+    alias_method :plugins, :plugin
+
+    ##
+    #
+    # @see Mactag::Tag::Gem
+    #
+    def gem(*gems)
+      options = gems.extract_options!
+
+      if gems.empty?
+        @builder << Mactag::Tag::Gem.all
+      else
+        gems.each do |name|
+          @builder << Mactag::Tag::Gem.new(name, options[:version])
+        end
+      end
+    end
+    alias_method :gems, :gem
+
+    ##
+    #
+    # @see Mactag::Tag::Rails
+    #
+    def rails(options = {})
+      @builder << Mactag::Tag::Rails.new(options)
+    end
+  end
+end

data/lib/mactag/tag.rb

@@ -1,4 +1,3 @@
-require 'mactag/tag/parser'
 require 'mactag/tag/app'
 require 'mactag/tag/plugin'
 require 'mactag/tag/gem'

data/lib/mactag/tag/app.rb

@@ -5,7 +5,7 @@ module Mactag
     # Tags files in current Rails application.
     #
     # ==== Examples
-    #   Mactag::Table.generate do
+    #   Mactag do
     #     # Tag single file
     #     app 'lib/super_duper.rb'
     #
@@ -20,10 +20,10 @@ module Mactag
     #   do
     #
     class App
-      attr_reader :files
+      attr_reader :tag
 
-      def initialize(*files)
-        @files = files
+      def initialize(tag)
+        @tag = tag
       end
     end
   end

data/lib/mactag/tag/gem.rb

@@ -5,7 +5,7 @@ module Mactag
     # Tags ruby gems.
     #
     # ==== Examples
-    #   Mactag::Table.generate do
+    #   Mactag do
     #     # Tag all gems given by *...*
     #     gems
     #
@@ -20,66 +20,71 @@ module Mactag
     #   do
     #
     class Gem
-      def initialize(*gems)
-        if gems.blank?
-          @gems = all
-          @options = {}
-        else
-          @gems = gems
-          @options = gems.extract_options!
-        end
-      end
+      autoload :Bundler, 'bundler'
 
-      def files
-        result = []
-        @gems.each do |gem_name|
-          if version = @options[:version]
-            gem = File.join(Mactag::Config.gem_home, "#{gem_name}-#{version}")
-          else
-            gem = latest(gem_name)
-          end
+      def initialize(name, version = nil)
+        @name = name
+        @version = version
+      end
 
-          if exists?(gem)
-            result << File.join(gem, "lib", "**", "*.rb")
+      def tag
+        if exists?
+          if @version
+            gem = splash
           else
-            Mactag.warn "Gem #{gem_name} not found"
+            gem = Gem.most_recent(@name)
           end
+          File.join(Mactag::Config.gem_home, gem, 'lib', '**', '*.rb')
+        else
+          Mactag.warn "Gem #{@name} not found"
         end
-        result
       end
 
-
-      private
+      ##
+      #
+      # Returns all application gems.
+      #
+      def self.all
+        Bundler.load.specs.collect { |spec| Gem.new(spec.name, spec.version.to_s) }
+      end
 
       ##
       #
-      # Returns the latest version of +gem+. If only one gem, that gem
-      # is returned.
+      # Returns the most recent gem with +name+.
       #
-      def latest(gem)
-        versions = Dir.glob(File.join(Mactag::Config.gem_home, gem) + "-*")
-        if versions.size == 1
-          gem = versions.first
-        else
-          gem = versions.sort.last
+      def self.most_recent(name)
+        versions = Dir.glob(File.join(Mactag::Config.gem_home, name) + "-*")
+        unless versions.empty?
+          if versions.size == 1
+            gem = versions.first
+          else
+            gem = versions.sort.last
+          end
+          File.basename(gem)
         end
-        gem
       end
 
+
+      private
+
       ##
       #
       # Returns true if +gem+ exists, false otherwise.
       #
-      def exists?(gem)
-        gem && File.directory?(gem)
+      def exists?
+        if @version
+          File.directory?(File.join(Mactag::Config.gem_home, splash))
+        else
+          Gem.most_recent(@name)
+        end
       end
 
       ##
       #
-      # Returns all gems in this application.
+      # Returns the gem name, dash, version.
       #
-      def all
-        Bundler.environment.dependencies.select { |d| d.groups.include?(:default) }.collect(&:name)
+      def splash
+        "#{@name}-#{@version}"
       end
     end
   end

data/lib/mactag/tag/plugin.rb

@@ -5,7 +5,7 @@ module Mactag
     # Tags plugins in current Rails application.
     #
     # ==== Examples
-    #   Mactag::Table.generate do
+    #   Mactag do
     #     # Tag single plugin
     #     plugin 'whenever'
     #
@@ -19,22 +19,27 @@ module Mactag
     class Plugin
       PLUGIN_PATH = File.join('vendor', 'plugins')
 
-      def initialize(*plugins)
-        @plugins = plugins
+      def initialize(plugin)
+        @plugin = plugin
       end
 
-      def files
-        return File.join(PLUGIN_PATH, '*', 'lib', '**', '*.rb') if @plugins.empty?
-
-        result = []
-        @plugins.each do |plugin|
-          if File.exist?(File.join(PLUGIN_PATH, plugin))
-            result << File.join(PLUGIN_PATH, plugin, 'lib', '**', '*.rb')
-          else
-            Mactag.warn "Plugin #{plugin} not found"
-          end
+      def tag
+        if exists?
+          return File.join(PLUGIN_PATH, @plugin, 'lib', '**', '*.rb')
+        else
+          Mactag.warn "Plugin #{@plugin} not found"
         end
-        result
+      end
+      
+      def self.all
+        Dir.glob(File.join(PLUGIN_PATH, '*')).collect { |f| File.basename(f) }
+      end
+      
+      
+      private
+      
+      def exists?
+        File.directory?(File.join(PLUGIN_PATH, @plugin))
       end
     end
   end

data/lib/mactag/tag/rails.rb

@@ -17,7 +17,7 @@ module Mactag
     #
     #
     # ==== Examples
-    #   Mactag::Table.generate do
+    #   Mactag do
     #     # Tag all rails packages, latest version
     #     rails
     #
@@ -58,16 +58,11 @@ module Mactag
         @except = packagize!(options[:except])
       end
 
-      def files
+      def tag
         result = []
         packages.each do |package|
           if PACKAGES.include?(package)
-            if version = @options[:version]
-              gem = Gem.new(package.to_s, :version => version)
-            else
-              gem = Gem.new(package.to_s)
-            end
-            result << gem.files
+            result << Gem.new(package.to_s, @options[:version]).tag
           end
         end
         result