mactag 0.5.4 → 0.6.0

data/README.markdown

@@ -7,23 +7,21 @@ 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
+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.
 
 
 # Installation
 
-## Plugin
-Install the plugin:
-    $ rails plugin install git://github.com/rejeep/mactag.git
-
-## Gem
 Install the gem:
+
     $ gem install mactag
     
-Add mactag to the **Gemfile**:
+Add `mactag` to the `Gemfile`:
+
     group :development do
       gem 'mactag'
     end
@@ -31,55 +29,62 @@ Add mactag to the **Gemfile**:
 
 # Configuration
 
-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:
+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.
+
     $ rails generate mactag
 
 ## 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.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'
+    end
 
     Mactag do
-      app 'app/**/*.rb', 'lib/*.rb'
-
-      plugins 'thinking-sphinx', 'whenever'
+      index 'app/models/*.rb'
+      
+      index 'carrerwave', 'simple_form'
+      index 'redcarpet', :version => '1.17.2'
 
-      gems 'paperclip', 'authlogic'
-      gem 'formtastic', :version => '0.9.7'
-
-      rails :except => :actionmailer, :version => '2.3.5'
+      index :rails, :except => :actionmailer, :version => '3.1.3'
     end
     
-## Options
+## Configuration Options
 The available configuration options are described below.
 
-### Mactag::Config.rvm
+### rvm
 If true, use [Rvm](http://rvm.beginrescueend.com/) when indexing gems.  
 Defaults to: `true`
 
-### Mactag::Config.gem_home
-Path to gems. No need to set this when using **Mactag::Config.rvm**.  
+### gem_home
+Path to gems. No need to set this when using `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}**
+### 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}`
 
-### Mactag::Config.tags_file
+### tags_file
 Name of the output tags file.  
 Defaults to: `TAGS`
 
 
 # Usage
 To create the TAGS file, simply run:
+
     $ rake mactag
 
 
 # License
-Copyright (c) 2010 Johan Andersson, released under the MIT license
+Copyright (c) 2010-2012 Johan Andersson, released under the MIT license

data/Rakefile

@@ -1,12 +1,14 @@
 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
+require 'yard'
+require 'rspec/core/rake_task'
 
 task :default => :spec
 task :test => :spec
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = %w[--color]
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end

data/VERSION

@@ -1 +1 @@
-0.5.4
+0.6.0

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

@@ -1,98 +1,39 @@
-##
-#
-# Rvm support or not. Mactag will automatically set path to gems.
-#
-# Defaults to: true
-#
-# Example:
-#   Mactag::Config.rvm = false
-#
+Mactag.configure do |config|
+  # Use RVM to locate project gems.
+  # config.rvm = 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'
-#
-# Example:
-#   Mactag::Config.gem_home = '/usr/lib/ruby/gems/1.8/gems'
-#
+  # 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.
-#
-# Defaults to: 'TAGS'
-#
-# Example:
-#   Mactag::Config.tags_file = '.tags'
-#
+  # Name of tags file to create.
+  # config.tags_file = '.tags'
 
-##
-#
-# 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}'
-#
+  # 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 all ruby files in app recursive and all ruby files directly under lib.
-  #   app 'app/**/*.rb', 'lib/*.rb'
-  #
+  # Index current project.
+  # index :app
 
-  ##
-  #
-  # Index the plugins thinking-sphinx and formtastic.
-  #  plugins 'thinking-sphinx', 'formtastic'
-  #
+  # Index all models and helpers.
+  # index 'app/models/*.rb', 'app/helpers/*.rb'
 
-  ##
-  #
-  # Index the gems paperclip and authlogic.
-  #   gems 'paperclip', 'authlogic'
-  #
+  # Index the gems carrierwave and redcarpet.
+  # index 'carrierwave', 'redcarpet'
 
-  ##
-  #
-  # Index the gem formtastic version 0.9.7.
-  #   gem 'formtastic', :version => '0.9.7'
-  #
+  # Index the gem simple_form version 1.5.2.
+  # index 'simple_form', :version => '1.5.2'
 
-  ##
-  #
-  # Index all rails packages, except actionmailer.
-  #   rails :except => :actionmailer
-  #
+  # Index rails.
+  # index :rails
 
-  ##
-  #
-  # Index only rails packages activerecord and activesupport.
-  #   rails :only => [:activerecord, :active_support]
-  #
+  # Index rails except action mailer.
+  # index :rails, :except => :actionmailer
 
-  ##
-  #
-  # Index all rails packages, version 3.0.0.
-  #   rails :version => '3.0.0'
-  #
+  # Index only rails packages activerecord and activesupport.
+  # index :rails, :only => %w(activerecord activesupport)
 
-  ##
-  #
-  # Index all rails packages, same version as current application.
-  #   rails
-  #
+  # Index rails, version 3.1.3.
+  # index :rails, :version => '3.1.3'
 end

data/lib/mactag.rb

@@ -2,7 +2,7 @@ require 'mactag/railtie'
 require 'mactag/config'
 require 'mactag/builder'
 require 'mactag/dsl'
-require 'mactag/tag'
+require 'mactag/indexer'
 require 'mactag/ctags'
 require 'mactag/bundler'
 require 'mactag/errors'
@@ -10,6 +10,12 @@ require 'mactag/errors'
 module Mactag
   autoload :Bundler, 'bundler'
   autoload :Rails, 'rails'
+
+  class << self
+    def configure(&block)
+      Mactag::Config.configure(&block)
+    end
+  end
 end
 
 def Mactag(&block)

data/lib/mactag/builder.rb

@@ -1,9 +1,7 @@
 module Mactag
-  ##
-  #
-  # Tag builder.
-  #
   class Builder
+    attr_reader :tags
+
     def initialize
       @tags = []
     end
@@ -39,13 +37,13 @@ module Mactag
     class << self
       def create
         unless gem_home_exists?
-          raise Mactag::MactagError.new("Specified gem home directory does not exist: #{Mactag::Config.gem_home}")
+          raise Mactag::MactagError.new("Gem home directory '#{Mactag::Config.gem_home}' does not exist")
         end
 
         if builder.has_gems?
           Mactag::Ctags.new(@builder.files, Mactag::Config.tags_file).create
 
-          puts 'Successfully generated TAGS file'
+          puts "Successfully generated #{Mactag::Config.tags_file} file"
         else
           raise Mactag::MactagError.new('Nothing to tag')
         end

data/lib/mactag/bundler.rb

@@ -5,32 +5,34 @@ module Mactag
   # used.
   #
   class Bundler
-    def gems
-      dependencies.map do |dependency|
-        Mactag::Tag::Gem.new(dependency, specs[dependency])
+    class << self
+      def gems
+        dependencies.map do |dependency|
+          [dependency, specs[dependency]]
+        end
       end
-    end
 
 
-    private
+      private
 
-    def specs
-      @specs ||= runtime.specs.inject({}) do |hash, spec|
-        hash[spec.name] = spec.version.to_s
-        hash
+      def specs
+        @specs ||= runtime.specs.inject({}) do |hash, spec|
+          hash[spec.name] = spec.version.to_s
+          hash
+        end
       end
-    end
 
-    def dependencies
-      default = runtime.dependencies.select { |dependency|
-        dependency.groups.include?(:default)
-      }.collect(&:name)
-      default.delete('rails')
-      default
-    end
+      def dependencies
+        default = runtime.dependencies.select { |dependency|
+          dependency.groups.include?(:default)
+        }.map(&:name)
+        default.delete('rails')
+        default
+      end
 
-    def runtime
-      @runtime ||= ::Bundler.load
+      def runtime
+        @runtime ||= ::Bundler.load
+      end
     end
   end
 end

data/lib/mactag/config.rb

@@ -2,20 +2,16 @@ module Mactag
   class Config
     ##
     #
-    # The command to run (replacing {OUTPUT} with Mactag::Config.tags_file
-    # and {INPUT} with the input files) when creating the TAGS-file.
-    #
-    #   Mactag::Config.binary = 'etags -o {OUTPUT} {INPUT}'
+    # 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_accessor :binary
+    cattr_reader :binary
 
     ##
     #
     # Name of the output tags file.
     #
-    # Mactag::Config.binary = 'TAGS_FILE'
-    #
     @@tags_file = 'TAGS'
     cattr_accessor :tags_file
 
@@ -24,8 +20,6 @@ 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
     cattr_accessor :rvm
 
@@ -33,16 +27,28 @@ module Mactag
     #
     # 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
+    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}'")
+        end
+      end
+
+      def gem_home
+        if rvm
+          File.join(ENV['GEM_HOME'], 'gems')
+        else
+          @@gem_home
+        end
+      end
+
+      def configure(&block)
+        yield self
       end
     end
   end

data/lib/mactag/ctags.rb

@@ -4,6 +4,8 @@ module Mactag
   # Wrapper around Ctags command.
   #
   class Ctags
+    attr_reader :input, :output
+    
     def initialize(input, output)
       @input = Array(input)
       @output = output