mactag 0.1.1 → 0.2.0

data/features/rails.feature

@@ -0,0 +1,6 @@
+Feature: Tag Rails
+  In order to create a TAGS file
+  As a user
+  I want to tag Rails
+
+  # Rails is only a couple of gems, see gems.feature for Cucumber features.

data/features/step_definitions/mactag_steps.rb

@@ -0,0 +1,43 @@
+Given /^a Rails application$/ do
+  @app = RailsApp.new
+end
+
+Given /^mactag is installed$/ do
+  mactag = File.join(@app.root, "vendor", "plugins", "mactag")
+
+  FileUtils.mkdir_p(mactag)
+
+  [ "lib", "Rakefile", "init.rb" ].each do |file|
+    file = File.join(File.dirname(__FILE__), "..", "..", file)
+
+    FileUtils.cp_r(file, mactag)
+  end
+end
+
+Given /^this mactag config file:$/ do |config|
+  @app.inject "config/mactag.rb", config
+end
+
+When /^I create the tags file$/ do
+  @tags = TagsFile.new(@app)
+end
+
+Then /^"([^"]*)" should be tagged$/ do |definition|
+  assert @tags.include?(definition)
+end
+
+Then /^"([^"]*)" should not be tagged$/ do |definition|
+  assert !@tags.include?(definition)
+end
+
+Given /^the plugin "([^"]*)" is installed$/ do |plugin|
+  @app.install_plugin(plugin)
+end
+
+Given /^the gem "([^"]*)" version "([^"]*)" is installed$/ do |gem, version|
+  @app.install_gem(gem, version)
+end
+
+Given /^file "([^"]*)" with contents:$/ do |file, contents|
+  @app.inject file, contents
+end

data/features/support/env.rb

@@ -8,3 +8,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 require 'mactag'
 
 World(Test::Unit::Assertions)
+
+After do
+  @app.destroy unless ENV['DEBUG'] == 'true'
+end

data/features/support/rails_app.rb

@@ -1,74 +1,46 @@
 class RailsApp
+  NAME = 'rails_app'
 
-  attr_reader :name
-
-  def initialize(name = "rails_app")
-    @name = name
-
+  def initialize
     create
   end
 
+  def root
+    @root ||= File.join(File.dirname(__FILE__), '..', '..', NAME)
+  end
+
   def destroy
-    FileUtils.rm_rf(rails_root)
+    FileUtils.rm_rf(root)
   end
 
-  def puts(file, contents = nil, &block)
-    file = File.join(rails_root, file)
-    text = contents || (block_given? ? instance_eval(&block) : "")
-    File.open(file, "a") { |f| f.write(text) }
+  def inject(file, contents)
+    to = File.join(root, file)
+    File.open(to, 'a') { |f| f.write("#{contents}\n") }
   end
 
   def install_plugin(plugin)
-    system "cd #{rails_root} && rails generate plugin #{plugin} &> /dev/null"
+    cmd = "cd #{root}"
+    cmd << " && rails generate plugin #{plugin}"
+    cmd << ' -q' unless ENV['DEBUG'] == 'true'
+    system cmd
   end
 
   def install_gem(gem, version)
     install_plugin(gem)
 
-    plugins = File.join(rails_root, "vendor", "plugins")
-    gems = File.join(rails_root, "vendor", "gems")
+    plugins = File.join(root, 'vendor', 'plugins')
+    gems = File.join(root, 'vendor', 'gems')
 
     FileUtils.mkdir_p(gems)
     FileUtils.mv(File.join(plugins, gem), File.join(gems, "#{gem}-#{version}"))
   end
-
-  def install_rails_vendor
-    from = File.join("features", "rails")
-    to = File.join(rails_root, "vendor", "rails-temp")
-
-    FileUtils.cp_r(from, to)
-  end
-
-  def install_rails_gem(version = "3.0.0")
-    from = File.join("features", "rails", "*")
-    to = File.join(rails_root, "vendor", "rails-temp")
-
-    FileUtils.mkdir_p(to)
-
-    Dir.glob(from).each do |file|
-      FileUtils.cp_r(file, to)
-    end
-
-    Dir.glob(File.join(to, "*[a-z]")).each do |file|
-      FileUtils.mv(file, "#{file}-#{version}")
-    end
-  end
-
-  def gsub(file, from, to)
-    text = File.read(file)
-    File.open(file, 'w+') do |f|
-      f << text.gsub(from, to)
-    end
-  end
-
-  def rails_root
-    @rails_root ||= File.join(File.dirname(__FILE__), "..", "..", @name)
-  end
-
+  
 
   private
 
   def create
-    system "rails #{rails_root} -q"
+    cmd = "rails new #{NAME}"
+    cmd << ' -q' unless ENV['DEBUG'] == 'true'
+    system cmd
   end
 end

data/features/support/tags_file.rb

@@ -1,14 +1,14 @@
 class TagsFile
   def initialize(app)
     @app = app
-    @tags_file = File.join(@app.rails_root, "TAGS")
+    @file = File.join(@app.root, "TAGS")
 
     create
   end
 
-  def contain?(tag)
-    File.open(@tags_file) do |file|
-      return file.read =~ /#{tag}/
+  def include?(definition)
+    File.open(@file) do |file|
+      return file.read =~ /#{definition}/
     end
   end
 
@@ -16,6 +16,9 @@ class TagsFile
   private
 
   def create
-    system "cd #{@app.rails_root} && rake mactag --trace"
+    cmd = "cd #{@app.root}"
+    cmd << " && rake mactag"
+    cmd << " --trace" if ENV['DEBUG'] == 'true'
+    system cmd
   end
 end

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

@@ -1,33 +1,74 @@
-# Default gem home is the standard one on Mac OS (/Library/Ruby/Gems/1.8/gems).
-# Change to whatever your system is using, if not the default.
+##
+#
+# Use RVM gem path. Mactag will automatically find this.
+# Defaults to *true*.
+#   Mactag::Config.rvm = true
+#
+
+##
+#
+# Path to gems. This options is only interesting if Mactag::Config.rvm
+# is false.
 #
+# 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:
-#   Mactag::Config.gem_home = "/usr/lib/ruby/gems/1.8/gems"
+#   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.
-#   Mactag::Config.binary = "etags -o TAGS"
+# Default is *ctags -o TAGS -e*
+#   Mactag::Config.binary = 'etags -o TAGS'
+#
 
+##
+#
 # Example configuration. Change according to your application.
+#
 Mactag::Table.generate do
+  ##
+  #
   # Index all ruby files in app recursive and all ruby files directly under lib.
-  #   app "app/**/*.rb", "lib/*.rb"
+  #   app 'app/**/*.rb', 'lib/*.rb'
+  #
 
+  ##
+  #
   # Index the plugins thinking-sphinx and formtastic.
-  #  plugins "thinking-sphinx", "formtastic"
+  #  plugins 'thinking-sphinx', 'formtastic'
+  #
 
+  ##
+  #
   # Index the gems paperclip and authlogic.
-  #   gems "paperclip", "authlogic"
+  #   gems 'paperclip', 'authlogic'
+  #
   
+  ##
+  #
   # Index the gem formtastic version 0.9.7.
-  #   gem "formtastic", :version => "0.9.7"
+  #   gem 'formtastic', :version => '0.9.7'
+  #
 
+  ##
+  #
   # 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 2.3.5.
-  #   rails :version => "2.3.5"
+  #   rails :version => '2.3.5'
+  #
 end

data/lib/mactag.rb

@@ -4,6 +4,6 @@ require 'mactag/tag'
 
 module Mactag
   def self.warn(message)
-    puts "MACTAG WARNING: #{message}"
+    $stderr.puts "Mactag Warning: #{message}"
   end
 end

data/lib/mactag/config.rb

@@ -1,15 +1,36 @@
 module Mactag
   class Config
-
+    ##
+    #
     # The command to run when creating the TAGS-file.
-    #   Mactag::Config.binary = "etags -o TAGS"
-    @@binary = "ctags -o TAGS -e"
+    #   Mactag::Config.binary = 'etags -o TAGS'
+    #
+    @@binary = 'ctags -o TAGS -e'
     cattr_accessor :binary
 
-    # The folder where the gems are stored.
-    #   Mactag::Config.gem_home = "/Library/Ruby/Gems/1.8/gems"
-    @@gem_home = "/Library/Ruby/Gems/1.8/gems"
-    cattr_accessor :gem_home
+    ##
+    #
+    # 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'
+    cattr_writer :gem_home
+
+    def self.gem_home
+      if rvm
+        File.join(ENV['GEM_HOME'], 'gems')
+      else
+        @@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/table.rb

@@ -1,25 +1,27 @@
 module Mactag
   class Table
-
     @@tags = []
 
     class << self
+      ##
+      #
       # Generates the TAGS-table.
       #
       # ==== Example
       #   Mactag::Table.generate do
-      #     app "app/**/*.rb", "lib/*.rb"
+      #     app 'app/**/*.rb', 'lib/*.rb'
       #
-      #     plugins "thinking-sphinx", "whenever"
+      #     plugins 'thinking-sphinx', 'whenever'
       #
-      #     gems "paperclip", "authlogic"
-      #     gem "formtastic", :version => "0.9.7"
+      #     gems 'paperclip', 'authlogic'
+      #     gem 'formtastic', :version => '0.9.7'
       #
-      #     rails :except => :actionmailer, :version => "2.3.5"
+      #     rails :except => :actionmailer, :version => '2.3.5'
       #   end
       #
       # See documentation for the methods *app*, *plugins*, *gems* and
       # *rails* in respective tag class.
+      #
       def generate(&block)
         parser = Mactag::Tag::Parser.new(self)
         parser.instance_eval(&block)
@@ -29,8 +31,11 @@ module Mactag
         @@tags << tag
       end
 
+      ##
+      #
       # Returns a string with all files that should be tagged. The
       # files are separated with a whitespace.
+      #
       def tags
         @@tags.collect!(&:files)
         @@tags.flatten!
@@ -40,14 +45,22 @@ module Mactag
         @@tags.join(' ')
       end
 
+      ##
+      #
+      # Create the TAGS file.
+      #
       def create
         unless File.directory?(Mactag::Config.gem_home)
-          Mactag.warn "Gem home path does not exist on your system"
+          Mactag.warn 'Gem home path does not exist on your system'
         end
 
-        system "cd #{Rails.root} && #{Mactag::Config.binary} #{Mactag::Table.tags}"
+        if @@tags.collect(&:files).flatten.empty?
+          Mactag.warn 'You did not specify anything to tag'
+        else
+          system "cd #{Rails.root} && #{Mactag::Config.binary} #{Mactag::Table.tags}"
+          puts "Successfully generated TAGS file"
+        end
       end
     end
-
   end
 end

data/lib/mactag/tag/app.rb

@@ -1,30 +1,30 @@
 module Mactag
   module Tag
-    
-    # Tag for files in the current application.
+    ##
+    #
+    # Tags files in current Rails application.
     #
     # ==== Examples
     #   Mactag::Table.generate do
-    #     # Tag only one file
-    #     app "lib/super_duper.rb"
+    #     # Tag single file
+    #     app 'lib/super_duper.rb'
     #
     #     # Tag all files in lib, recursive
-    #     app "lib/**/*.rb"
+    #     app 'lib/**/*.rb'
     #
     #     # Tag all helpers and models
-    #     app "app/helpers/*.rb", "app/models/*.rb"
+    #     app 'app/helpers/*.rb', 'app/models/*.rb'
     #
     #     # Same as above
-    #     app "app/{models,helpers}/*.rb"
+    #     app 'app/{models,helpers}/*.rb'
     #   do
+    #
     class App
-      
       attr_reader :files
-      
+
       def initialize(*files)
         @files = files
       end
-      
     end
   end
 end

data/lib/mactag/tag/gem.rb

@@ -1,32 +1,33 @@
-require 'mactag/tag/versioned'
-
-
 module Mactag
   module Tag
-
-    # Tag for gems.
+    ##
+    #
+    # Tags ruby gems.
     #
     # ==== Examples
     #   Mactag::Table.generate do
-    #     # Tag all gems given by *Rails.configuration.gems*
+    #     # Tag all gems given by *...*
     #     gems
     #
     #     # Tag the whenever gem, latest version
-    #     gem "whenever"
+    #     gem 'whenever'
     #
     #     # Tag the thinking-sphinx and formtastic gems, latest versions
-    #     gems "thinking-sphinx", "formtastic"
+    #     gems 'thinking-sphinx', 'formtastic'
     #
-    #     # Tag the formtastic gem version 0.8.2
-    #     gem "formtastic", :version => "0.8.2"
+    #     # Tag the formtastic gem, version 0.8.2
+    #     gem 'formtastic', :version => '0.8.2'
     #   do
+    #
     class Gem
-
-      include Versioned
-
       def initialize(*gems)
-        @options = gems.extract_options!
-        @gems = gems.blank? ? ::Rails.configuration.gems.collect(&:name) : gems
+        if gems.blank?
+          @gems = all
+          @options = {}
+        else
+          @gems = gems
+          @options = gems.extract_options!
+        end
       end
 
       def files
@@ -38,15 +39,48 @@ module Mactag
             gem = latest(gem_name)
           end
 
-          if gem
+          if exists?(gem)
             result << File.join(gem, "lib", "**", "*.rb")
           else
-            $stderr.puts "Gem #{gem_name} not found"
+            Mactag.warn "Gem #{gem_name} not found"
           end
         end
         result
       end
 
+
+      private
+
+      ##
+      #
+      # Returns the latest version of +gem+. If only one gem, that gem
+      # is returned.
+      #
+      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
+        end
+        gem
+      end
+
+      ##
+      #
+      # Returns true if +gem+ exists, false otherwise.
+      #
+      def exists?(gem)
+        gem && File.directory?(gem)
+      end
+
+      ##
+      #
+      # Returns all gems in this application.
+      #
+      def all
+        Bundler.environment.dependencies.select { |d| d.groups.include?(:default) }.collect(&:name)
+      end
     end
   end
 end