mactag 0.6.0 → 0.7.0

data/README.markdown

@@ -1,90 +1,104 @@
 # Mactag
 
-Mactag is a plugin for Rails developers that do their development in
+Mactag is a Ruby gem for Ruby developers that do their development in
 an editor that supports Ctags (Emacs, Vim, TextMate, ...). With Ctags
 you can follow tags (of functions, variables, macros, whatever) to
 their definitions.
 
+Mactag works with both Ruby projects and Rails applications.
 
-# Exuberant Ctags
 
-First off, you must install [Ctags](http://ctags.sourceforge.net/).
-Some systems comes with a `ctags` binary 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.
+# Exuberant Ctags
 
+Mactag requires a tool called
+[Exuberant Ctags](http://ctags.sourceforge.net/), which is used to
+create the tags file. Install it if you don't have it already. Some
+systems includes a `ctags` exectuable. If you use that and you have
+trouble creating the tags file, then install it from your package
+manager instead. The package is called `ctags` in Homebrew and
+`exuberant-ctags` in Ubuntu.
 
 # Installation
 
 Install the gem:
 
     $ gem install mactag
-    
+
 Add `mactag` to the `Gemfile`:
 
-    group :development do
-      gem 'mactag'
-    end
+    gem 'mactag'
+
+Then run `bundle install`.
 
 
 # Configuration
 
-To generate the configuration file `config/mactag.rb`, use the
-`mactag` generator. The generated file contains a basic setup and some
-examples of how to configure Mactag.
+You specify what you want to index in the configuration file (default
+is `config/mactag.rb`). To generate such as file with a basic setup,
+run the command:
 
-    $ rails generate mactag
+     $ mactag new
 
-## Example mactag.rb file
+Or if you want the config file someplace else:
+
+     $ mactag new conf/mactag.rb
+
+That will generate a configuration file looking something like this:
 
     Mactag.configure do |config|
-      # Do not use RVM
-      config.rvm = false
-      config.gem_home = '/usr/lib/ruby/gems/1.8/gems'
-      
-      # Binary when installing ctags from Homebrew
-      config.binary = '/usr/local/Cellar/ctags/5.8/bin/ctags -e -o {OUTPUT} {INPUT}'
-      
-      # Change name of output file
-      config.tags_file = 'DA-TAGS'
+      # Use RVM to locate project gems.
+      # config.rvm = false
+
+      # Path to gems. No need to set this when RVM is used!
+      # config.gem_home = '/Library/Ruby/Gems/1.8/gems'
+
+      # Name of tags file to create.
+      # config.tags_file = '.tags'
+
+      # Command used to create the tags table. {INPUT} and {OUTPUT} are required!
+      # config.binary = '/usr/local/Cellar/ctags/5.8/bin/ctags -e -o {OUTPUT} {INPUT}'
     end
 
     Mactag do
-      index 'app/models/*.rb'
-      
-      index 'carrerwave', 'simple_form'
-      index 'redcarpet', :version => '1.17.2'
+      # Index current project.
+      # index :lib
 
-      index :rails, :except => :actionmailer, :version => '3.1.3'
-    end
-    
-## Configuration Options
-The available configuration options are described below.
+      # Index current Rails project.
+      # index :app
+
+      # Index all models and helpers.
+      # index 'app/models/*.rb', 'app/helpers/*.rb'
+
+      # Index the gems carrierwave and redcarpet.
+      # index 'carrierwave', 'redcarpet'
+
+      # Index the gem simple_form version 1.5.2.
+      # index 'simple_form', :version => '1.5.2'
 
-### rvm
-If true, use [Rvm](http://rvm.beginrescueend.com/) when indexing gems.  
-Defaults to: `true`
+      # Index rails.
+      # index :rails
 
-### gem_home
-Path to gems. No need to set this when using `rvm`.  
-Defaults to: `/Library/Ruby/Gems/1.8/gems`
- 
-### binary
-The command to run when creating the TAGS-file. `{OUTPUT}` will be
-replaced with the value of `tags_file` configuration option. `{INPUT}`
-will be replaced with all files to index.  
-Defaults to: `ctags -o {OUTPUT} -e {INPUT}`
+      # Index rails except action mailer.
+      # index :rails, :except => :actionmailer
 
-### tags_file
-Name of the output tags file.  
-Defaults to: `TAGS`
+      # Index only rails packages activerecord and activesupport.
+      # index :rails, :only => %w(activerecord activesupport)
+
+      # Index rails, version 3.1.3.
+      # index :rails, :version => '3.1.3'
+    end
 
 
 # Usage
-To create the TAGS file, simply run:
 
-    $ rake mactag
+When you are done configuring, create the tags file with the command:
 
+    $ mactag
+    
+Or if the config file is someplace else than `config/mactag.rb`.
+
+    $ mactag conf/mactag.rb
 
 # License
+
 Copyright (c) 2010-2012 Johan Andersson, released under the MIT license

data/bin/mactag

@@ -0,0 +1,95 @@
+#!/usr/bin/env ruby
+
+require 'fileutils'
+
+if ARGV.include?('-h') || ARGV.include?('--help') || ARGV.include?('help')
+  $stderr.puts 'Usage: mactag [new] [configuration_file]'
+else
+  default_config_file = File.join('config', 'mactag.rb')
+
+  if ARGV.first == 'new'
+    config_file = ARGV[1] || default_config_file
+
+    config_dir = File.dirname(config_file)
+    if File.exists?(config_dir)
+      if File.exists?(config_file)
+        $stderr.puts "[skip] file `#{config_file}' already exists"
+      else
+        content = <<-CONFIG
+Mactag.configure do |config|
+  # Use RVM to locate project gems.
+  # config.rvm = false
+
+  # Path to gems. No need to set this when RVM is used!
+  # config.gem_home = '/Library/Ruby/Gems/1.8/gems'
+
+  # Name of tags file to create.
+  # config.tags_file = '.tags'
+
+  # Command used to create the tags table. {INPUT} and {OUTPUT} are required!
+  # config.binary = '/usr/local/Cellar/ctags/5.8/bin/ctags -e -o {OUTPUT} {INPUT}'
+end
+
+Mactag do
+  # Index current project.
+  # index :lib
+
+  # Index current Rails project.
+  # index :app
+
+  # Index all models and helpers.
+  # index 'app/models/*.rb', 'app/helpers/*.rb'
+
+  # Index the gems carrierwave and redcarpet.
+  # index 'carrierwave', 'redcarpet'
+
+  # Index the gem simple_form version 1.5.2.
+  # index 'simple_form', :version => '1.5.2'
+
+  # Index rails.
+  # index :rails
+
+  # Index rails except action mailer.
+  # index :rails, :except => :actionmailer
+
+  # Index only rails packages activerecord and activesupport.
+  # index :rails, :only => %w(activerecord activesupport)
+
+  # Index rails, version 3.1.3.
+  # index :rails, :version => '3.1.3'
+end
+CONFIG
+
+        File.open(config_file, 'w') do |f|
+          f.write(content)
+        end
+
+        puts "[done] created `#{config_file}'"
+      end
+    else
+      $stderr.puts "[skip] directory `#{config_dir}' does not exist"
+    end
+  else
+    config_file = ARGV[0] || default_config_file
+
+    if File.exists?(config_file)
+      require 'mactag'
+
+      environment = File.expand_path(File.join(ENV['PWD'], 'config', 'environment.rb'))
+      if File.exists?(environment)
+        require environment
+      end
+
+      begin
+        require config_file
+
+        Mactag::Builder.create
+      rescue Mactag::MactagError => e
+        $stderr.puts "[error] #{e.message}"
+      end
+
+    else
+      $stderr.puts "[skip] file `#{config_file}' does not exist"
+    end
+  end
+end

data/lib/mactag.rb

@@ -1,4 +1,3 @@
-require 'mactag/railtie'
 require 'mactag/config'
 require 'mactag/builder'
 require 'mactag/dsl'
@@ -8,16 +7,39 @@ require 'mactag/bundler'
 require 'mactag/errors'
 
 module Mactag
-  autoload :Bundler, 'bundler'
-  autoload :Rails, 'rails'
-
   class << self
     def configure(&block)
       Mactag::Config.configure(&block)
     end
+
+    def rails_app?
+      defined?(::Rails)
+    end
+
+    def rails_version
+      if rails_app?
+        ::Rails.version
+      end
+    end
+
+    def project_root
+      if rails_app?
+        ::Rails.root
+      else
+        ENV['PWD']
+      end
+    end
+    
+    def current_project
+      File.basename(project_root)
+    end
   end
 end
 
 def Mactag(&block)
   Mactag::Builder.generate(&block)
 end
+
+if Mactag.rails_app?
+  require 'mactag/railtie'
+end

data/lib/mactag/builder.rb

@@ -43,7 +43,7 @@ module Mactag
         if builder.has_gems?
           Mactag::Ctags.new(@builder.files, Mactag::Config.tags_file).create
 
-          puts "Successfully generated #{Mactag::Config.tags_file} file"
+          puts "[done] Successfully generated #{Mactag::Config.tags_file} file"
         else
           raise Mactag::MactagError.new('Nothing to tag')
         end

data/lib/mactag/bundler.rb

@@ -1,3 +1,5 @@
+require 'bundler'
+
 module Mactag
   ##
   #
@@ -26,7 +28,13 @@ module Mactag
         default = runtime.dependencies.select { |dependency|
           dependency.groups.include?(:default)
         }.map(&:name)
-        default.delete('rails')
+        if Mactag.rails_app?
+          default.delete('rails')
+        else
+          if project = Mactag.current_project
+            default.delete(project)
+          end
+        end
         default
       end
 

data/lib/mactag/config.rb

@@ -1,41 +1,25 @@
 module Mactag
-  class Config
-    ##
-    #
-    # The command to run (replacing <tt>{OUTPUT}</tt> with <tt>tags_file</tt>
-    # and <tt>{INPUT}</tt> with the input files) when creating the tags file.
-    #
-    @@binary = 'ctags -o {OUTPUT} -e {INPUT}'
-    cattr_reader :binary
-
-    ##
-    #
-    # Name of the output tags file.
-    #
-    @@tags_file = 'TAGS'
-    cattr_accessor :tags_file
-
-    ##
-    #
-    # If using Ruby Version Manager (RVM), setting this option to true
-    # will enable Mactag to find out the gem path automatically.
-    #
-    @@rvm = true
-    cattr_accessor :rvm
-
-    ##
-    #
-    # The system folder where the gems are located.
-    #
-    @@gem_home = '/Library/Ruby/Gems/1.8/gems'
-    cattr_writer :gem_home
-
+  module Config
     class << self
-      def binary=(binary)
-        if binary.include?('{INPUT}') && binary.include?('{OUTPUT}')
-          @@binary = binary
-        else
-          raise Mactag::MactagError.new("Binary command must include '{INPUT}' and '{OUTPUT}'")
+      def configure(&block)
+        yield self
+      end
+
+      def add_config(name, &block)
+        unless respond_to?(name)
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def self.#{name}
+              @#{name}
+            end
+          RUBY
+        end
+
+        unless respond_to?("#{name}=")
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def self.#{name}=(value)
+              @#{name} = value
+            end
+          RUBY
         end
       end
 
@@ -43,13 +27,41 @@ module Mactag
         if rvm
           File.join(ENV['GEM_HOME'], 'gems')
         else
-          @@gem_home
+          @gem_home
         end
       end
 
-      def configure(&block)
-        yield self
+      def rvm=(rvm)
+        if rvm == true || rvm == false
+          @rvm = rvm
+        else
+          raise Mactag::MactagError.new("RVM must be either true or false")
+        end
+      end
+
+      def binary=(binary)
+        if binary.include?('{INPUT}') && binary.include?('{OUTPUT}')
+          @binary = binary
+        else
+          raise Mactag::MactagError.new("Binary command must include '{INPUT}' and '{OUTPUT}'")
+        end
+      end
+
+      def reset_config
+        configure do |config|
+          config.binary = 'ctags -o {OUTPUT} -e {INPUT}'
+          config.tags_file = 'TAGS'
+          config.rvm = true
+          config.gem_home = '/Library/Ruby/Gems/1.8/gems'
+        end
       end
     end
+
+    add_config :binary
+    add_config :tags_file
+    add_config :rvm
+    add_config :gem_home
+
+    reset_config
   end
 end

data/lib/mactag/ctags.rb

@@ -19,7 +19,7 @@ module Mactag
     private
 
     def command
-      "cd #{Rails.root} && #{binary}"
+      "cd #{Mactag.project_root} && #{binary}"
     end
 
     def binary

data/lib/mactag/dsl.rb

@@ -18,18 +18,21 @@ module Mactag
     #
     # = App
     #
-    # App indexes files in the current project.
+    # App indexes files in the current Rails project.
     #
     # == Examples
     #
     #   Mactag do
-    #     # Index single file.
+    #     # Index all ruby files in app and lib, recursive
+    #     index :app
+    #
+    #     # Index single file
     #     index 'lib/super_duper.rb'
     #
-    #     # Index all ruby files in lib, recursive.
+    #     # Index all ruby files in lib, recursive
     #     index 'lib/**/*.rb'
     #
-    #     # Index all helper and model ruby files.
+    #     # Index all helper and model ruby files
     #     index 'app/helpers/*.rb', 'app/models/*.rb'
     #
     #     # Same as above
@@ -44,16 +47,16 @@ module Mactag
     # == Examples
     #
     #   Mactag do
-    #     # Index all gems specified in Gemfile.
+    #     # Index all gems specified in Gemfile
     #     index :gems
     #
-    #     # Index the gem whenever, latest version.
+    #     # Index the gem whenever, latest version
     #     index 'whenever'
     #
-    #     # Index the thinking-sphinx and carrierwave gems, latest versions.
+    #     # Index the thinking-sphinx and carrierwave gems, latest versions
     #     index 'thinking-sphinx', 'carrierwave'
     #
-    #     # Index the gem simple_form, version 1.5.2.
+    #     # Index the gem simple_form, version 1.5.2
     #     index 'simple_form', :version => '1.5.2'
     #   end
     #
@@ -77,6 +80,24 @@ module Mactag
     # * activesupport
     #
     #
+    # = Lib
+    #
+    # Lib indexes files in the current project.
+    #
+    # == Examples
+    #
+    #   Mactag do
+    #     # Index all ruby files in lib, recursive
+    #     index :lib
+    #
+    #     # Index single file
+    #     index 'lib/super_duper.rb'
+    #
+    #     # Index all ruby files in lib, recursive
+    #     index 'lib/**/*.rb'
+    #   end
+    #
+    #
     # == Examples
     #
     #   Mactag do
@@ -103,6 +124,8 @@ module Mactag
     def index(*args)
       if args.first == :app
         app_private
+      elsif args.first == :lib
+        lib_private
       elsif args.first == :gems
         gem_private
       elsif args.first == :rails
@@ -110,14 +133,18 @@ module Mactag
       else
         options = args.last
 
-        if options[:version] && args.size > 2
+        if options.is_a?(Hash) && options[:version] && args.size > 2
           raise ArgumentError.new('The :version option is not valid when specifying more than one gem')
         end
 
         if options.is_a?(Hash) || args.all? { |arg| Mactag::Indexer::Gem.exist?(arg) }
-          gem_private(*args)
+            gem_private(*args)
         else
-          app_private(*args)
+          if Mactag.rails_app?
+            app_private(*args)
+          else
+            lib_private(*args)
+          end
         end
       end
     end
@@ -182,7 +209,25 @@ module Mactag
 
     private
 
+    def lib_private(*tags)
+      if Mactag.rails_app?
+        raise MactagError.new('Can not index :lib when in a Rails application')
+      end
+      
+      if tags.empty?
+        @builder << Mactag::Indexer::Lib.all
+      else
+        tags.each do |tag|
+          @builder << Mactag::Indexer::Lib.new(tag)
+        end
+      end
+    end
+
     def app_private(*tags)
+      unless Mactag.rails_app?
+        raise MactagError.new('Can not index :app when not a Rails application')
+      end
+      
       if tags.empty?
         @builder << Mactag::Indexer::App.all
       else
@@ -198,8 +243,8 @@ module Mactag
       else
         options = args.last
 
-        if version = options[:version]
-          @builder << Mactag::Indexer::Gem.new(args.first, version)
+        if options.is_a?(Hash) && options[:version]
+          @builder << Mactag::Indexer::Gem.new(args.first, options[:version])
         else
           args.each do |arg|
             @builder << Mactag::Indexer::Gem.new(arg)
@@ -209,6 +254,10 @@ module Mactag
     end
 
     def rails_private(*args)
+      unless Mactag.rails_app?
+        raise MactagError.new('You can not index :rails when not in a Rails application')
+      end
+
       args.shift
 
       if args.size.zero?
@@ -235,4 +284,3 @@ module Mactag
     end
   end
 end
-