mactag 0.1.0 → 0.1.1

data/README.markdown

@@ -5,46 +5,72 @@ an editor that supports Ctags (Emacs, Vim, TextMate, jEdit, ...). With
 Ctags you can follow tags (of functions, variables, macros, whatever)
 to 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 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
+## Rails 2.x
+Version 0.0.5 is the latest version supporting Rails 2.x.
 
+### Plugin
 Install the plugin:
+    $ ./script/plugin install git://github.com/rejeep/mactag.git --revision 'tags/v0.0.5'
 
-    $ ./script/plugin install git://github.com/rejeep/mactag.git
-
-## Gem
-
+### Gem
 Install the gem:
+    $ sudo gem install mactag --version='0.0.5'
+    
+Load the gem in **config/environments/development.rb**:
+    config.gem 'mactag'
 
-    $ sudo gem install mactag
+## Rails 3.x
+Version 0.1.1 is the only version supporting Rails 3.x.
 
-If you install mactag as a gem you must also include it's rake tasks in your *Rakefile*.
+### Plugin
+Install the plugin:
+    $ rails plugin install git://github.com/rejeep/mactag.git --revision 'tags/v0.1.1'
+
+### Gem
+Install the gem:
+    $ sudo gem install mactag --version='0.1.1'
+    
+Load the gem in **Gemfile**:
+    group :development do
+      gem 'mactag'
+    end
 
+## Note when installing as Gem
+When you install mactag as a gem you must also include it's rake tasks
+in your **Rakefile**.
     require 'mactag/tasks'
+    
 
 # Configuration
-
 Generate a basic configuration file:
 
+## Rails 2.x
     $ ./script/generate mactag
+    
+## Rails 3.x
+    $ rails generate mactag
+
+This will create the file **config/mactag.rb**, which contains some
+examples of how to configure Mactag.
 
-This will create the file **config/mactag.rb**, which contains
-some examples of how to set it up.
 
 ## Options
 
-* **Mactag::Config.gem_home:** The path where the gems are located. Defaults to **/usr/lib/ruby/gems/1.8/gems**
+* **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**
 
 ## Example mactag.rb file
-    Mactag::Config.gem_home = "/usr/lib/ruby/gems/1.9/gems"
+    Mactag::Config.gem_home = "/usr/lib/ruby/gems/1.8/gems"
     Mactag::Config.binary = "etags -o TAGS"
 
     Mactag::Table.generate do
@@ -58,11 +84,11 @@ some examples of how to set it up.
       rails :except => :actionmailer, :version => "2.3.5"
     end
 
-# Usage
 
+# Usage
 To create the TAGS file. Simply run:
     $ rake mactag
 
-# License
 
+# License
 Copyright (c) 2010 Johan Andersson, released under the MIT license

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/features/step_definitions/mactab_steps.rb

@@ -7,7 +7,7 @@ Given /^mactag is installed$/ do
 
   FileUtils.mkdir_p(mactag)
 
-  [ "lib", "tasks", "Rakefile", "init.rb" ].each do |name|
+  [ "lib", "Rakefile", "init.rb" ].each do |name|
     file = File.join(File.dirname(__FILE__), "..", "..", name)
 
     FileUtils.cp_r(file, mactag)

data/features/support/env.rb

@@ -1,10 +1,10 @@
 require 'rubygems'
 require 'active_support'
 require 'active_support/test_case'
+require 'active_support/core_ext'
+require 'test/unit/assertions'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
-
 require 'mactag'
-require 'test/unit/assertions'
 
 World(Test::Unit::Assertions)

data/features/support/rails_app.rb

@@ -19,7 +19,7 @@ class RailsApp
   end
 
   def install_plugin(plugin)
-    system "cd #{rails_root} && ./script/generate plugin #{plugin} &> /dev/null"
+    system "cd #{rails_root} && rails generate plugin #{plugin} &> /dev/null"
   end
 
   def install_gem(gem, version)

data/lib/generators/mactag/mactag_generator.rb

@@ -0,0 +1,11 @@
+require 'rails/generators'
+
+class MactagGenerator < Rails::Generators::Base
+  def install_mactag
+    copy_file 'mactag.rb', 'config/mactag.rb'
+  end
+
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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.
+#
+# Most GNU/Linux systems:
+#   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"
+
+# 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"
+
+  # Index the plugins thinking-sphinx and formtastic.
+  #  plugins "thinking-sphinx", "formtastic"
+
+  # Index the gems paperclip and authlogic.
+  #   gems "paperclip", "authlogic"
+  
+  # Index the 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"
+end

data/lib/mactag.rb

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

data/lib/mactag/config.rb

@@ -1,19 +1,14 @@
 module Mactag
-  # Configuration options.
-  #
-  # ==== Binary
-  # The command to run when creating the TAGS-file.
-  #   Mactag::Config.binary = "etags -o TAGS"
-  #
-  # ==== Gem Home
-  # The folder where the gems are stored.
-  #   Mactag::Config.gem_home = "/usr/lib/ruby/gems/1.9/gems"
   class Config
 
+    # The command to run when creating the TAGS-file.
+    #   Mactag::Config.binary = "etags -o TAGS"
     @@binary = "ctags -o TAGS -e"
     cattr_accessor :binary
-    
-    @@gem_home = "/usr/lib/ruby/gems/1.8/gems"
+
+    # 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
 
   end

data/lib/mactag/table.rb

@@ -9,12 +9,12 @@ module Mactag
       # ==== Example
       #   Mactag::Table.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
       #
@@ -39,6 +39,14 @@ module Mactag
         @@tags.uniq!
         @@tags.join(' ')
       end
+
+      def create
+        unless File.directory?(Mactag::Config.gem_home)
+          Mactag.warn "Gem home path does not exist on your system"
+        end
+
+        system "cd #{Rails.root} && #{Mactag::Config.binary} #{Mactag::Table.tags}"
+      end
     end
 
   end

data/lib/mactag/tag/gem.rb

@@ -1,8 +1,9 @@
 require 'mactag/tag/versioned'
 
+
 module Mactag
   module Tag
-    
+
     # Tag for gems.
     #
     # ==== Examples
@@ -22,22 +23,28 @@ module Mactag
     class Gem
 
       include Versioned
-      
+
       def initialize(*gems)
         @options = gems.extract_options!
         @gems = gems.blank? ? ::Rails.configuration.gems.collect(&:name) : gems
       end
 
       def files
-        @gems.collect do |gem|
+        result = []
+        @gems.each do |gem_name|
           if version = @options[:version]
-            gem = File.join(Mactag::Config.gem_home, "#{gem}-#{version}")
+            gem = File.join(Mactag::Config.gem_home, "#{gem_name}-#{version}")
           else
-            gem = latest(gem)
+            gem = latest(gem_name)
           end
 
-          File.join(gem, "lib", "**", "*.rb")
+          if gem
+            result << File.join(gem, "lib", "**", "*.rb")
+          else
+            $stderr.puts "Gem #{gem_name} not found"
+          end
         end
+        result
       end
 
     end

data/lib/mactag/tag/plugin.rb

@@ -1,6 +1,6 @@
 module Mactag
   module Tag
-    
+
     # Tag for the current project plugins.
     #
     # ==== Examples
@@ -12,21 +12,27 @@ module Mactag
     #     plugins "thinking-sphinx", "formtastic"
     #   do
     class Plugin
-      
+
       PLUGIN_PATH = File.join("vendor", "plugins")
-      
+
       def initialize(*plugins)
         @plugins = plugins
       end
-      
+
       def files
         return File.join(PLUGIN_PATH, "*", "lib", "**", "*.rb") if @plugins.empty?
 
-        @plugins.collect do |plugin|
-          File.join(PLUGIN_PATH, plugin, "lib", "**", "*.rb")
+        result = []
+        @plugins.each do |plugin|
+          if File.exist?(File.join(PLUGIN_PATH, plugin))
+            result << File.join(PLUGIN_PATH, plugin, "lib", "**", "*.rb")
+          else
+            $stderr.puts "Plugin #{plugin} not found"
+          end
         end
+        result
       end
-      
+
     end
   end
 end

data/lib/{mactag/tasks.rb → tasks/mactag.rake}

@@ -4,5 +4,5 @@ desc "Creates a Ctags file"
 task :mactag => :environment do
   require File.join(Rails.root, "config", "mactag")
 
-  system "cd #{Rails.root} && #{Mactag::Config.binary} #{Mactag::Table.tags}"
+  Mactag::Table.create
 end

data/test/mactag/config_test.rb

@@ -1,10 +1,10 @@
 require 'test_helper'
 
 class ConfigTest < ActiveSupport::TestCase
-  
+
   should "have correct default options" do
     assert_equal "ctags -o TAGS -e", Mactag::Config.binary
-    assert_equal "/usr/lib/ruby/gems/1.8/gems", Mactag::Config.gem_home
+    assert_equal "/Library/Ruby/Gems/1.8/gems", Mactag::Config.gem_home
   end
-  
+
 end

data/test/mactag/tag/gem_test.rb

@@ -1,17 +1,17 @@
 require 'test_helper'
 
 class GemTest < ActiveSupport::TestCase
-  
+
   context "gem with version" do
     setup do
       @gem = Mactag::Tag::Gem.new("thinking-sphinx", :version => "1.0.0")
     end
-    
+
     should "return the gem with that version" do
       assert_contains @gem.files, File.join(Mactag::Config.gem_home, "thinking-sphinx-1.0.0", "lib", "**", "*.rb")
     end
   end
-  
+
   context "gem without version" do
     context "one gem" do
       setup do
@@ -19,24 +19,38 @@ class GemTest < ActiveSupport::TestCase
 
         @gem = Mactag::Tag::Gem.new("whenever")
       end
-      
+
       should "return that gem" do
         assert_contains @gem.files, "whenever/lib/**/*.rb"
       end
     end
-    
+
     context "multiple gems" do
       setup do
         Dir.stubs(:glob).returns(["whenever-0.3.7", "whenever-0.3.6"])
-        
+
         @gem = Mactag::Tag::Gem.new("whenever")
       end
-      
+
       should "return the gem with the latest version" do
         assert_contains @gem.files, "whenever-0.3.7/lib/**/*.rb"
         assert_does_not_contain @gem.files, "whenever-0.3.6/lib/**/*.rb"
       end
     end
   end
-  
+
+  context "gem that does not exist" do
+    setup do
+      Dir.stubs(:glob).returns([nil])
+
+      @gem = Mactag::Tag::Gem.new("whenever")
+    end
+
+    should "not raise exception because no such gem" do
+      assert_nothing_raised do
+        assert_equal [], @gem.files
+      end
+    end
+  end
+
 end

data/test/mactag/tag/plugin_test.rb

@@ -5,9 +5,11 @@ class PluginTest < ActiveSupport::TestCase
   should "have correct plugin path" do
     assert_equal "vendor/plugins", Mactag::Tag::Plugin::PLUGIN_PATH
   end
-  
+
   context "without arguments" do
     setup do
+      File.stubs(:exist?).returns(true)
+      
       @plugin = Mactag::Tag::Plugin.new
     end
 
@@ -15,26 +17,44 @@ class PluginTest < ActiveSupport::TestCase
       assert_equal @plugin.files, "vendor/plugins/*/lib/**/*.rb"
     end
   end
-  
+
   context "with one plugin argument" do
     setup do
+      File.stubs(:exist?).returns(true)
+      
       @plugin = Mactag::Tag::Plugin.new("thinking-sphinx")
     end
-    
+
     should "return the path to that plugin" do
       assert_equal ["vendor/plugins/thinking-sphinx/lib/**/*.rb"], @plugin.files
     end
   end
-  
+
   context "with more thatn one plugin argument" do
     setup do
+      File.stubs(:exist?).returns(true)
+      
       @plugin = Mactag::Tag::Plugin.new("thinking-sphinx", "formtastic")
     end
-    
+
     should "return the paths to those plugins" do
       assert_contains @plugin.files, "vendor/plugins/thinking-sphinx/lib/**/*.rb"
       assert_contains @plugin.files, "vendor/plugins/formtastic/lib/**/*.rb"
     end
   end
-  
+
+  context "plugin that does not exist" do
+    setup do
+      File.stubs(:exist?).returns(false)
+      
+      @plugin = Mactag::Tag::Plugin.new("typo")
+    end
+
+    should "not raise exception because no such plugin" do
+      assert_nothing_raised do
+        assert_equal [], @plugin.files
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: mactag
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Johan Andersson
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-13 00:00:00 +00:00
+date: 2010-03-11 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -25,8 +30,8 @@ extra_rdoc_files:
 files: 
 - README.markdown
 - VERSION
-- generators/mactag/mactag_generator.rb
-- generators/mactag/templates/mactag.rb
+- lib/generators/mactag/mactag_generator.rb
+- lib/generators/mactag/templates/mactag.rb
 - lib/mactag.rb
 - lib/mactag/config.rb
 - lib/mactag/table.rb
@@ -37,8 +42,7 @@ files:
 - lib/mactag/tag/plugin.rb
 - lib/mactag/tag/rails.rb
 - lib/mactag/tag/versioned.rb
-- lib/mactag/tasks.rb
-- tasks/mactag_tasks.rake
+- lib/tasks/mactag.rake
 - TODO
 has_rdoc: true
 homepage: http://github.com/rejeep/mactag
@@ -53,18 +57,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Ctags for Rails
@@ -82,7 +88,6 @@ test_files:
 - features/step_definitions/rails_steps.rb
 - features/step_definitions/gem_steps.rb
 - features/step_definitions/mactab_steps.rb
-- features/support/core_ext.rb
 - features/support/tags_file.rb
 - features/support/env.rb
 - features/support/rails_app.rb

data/features/support/core_ext.rb

@@ -1,5 +0,0 @@
-class String
-  def quote
-    "\"#{self}\""
-  end
-end

data/generators/mactag/mactag_generator.rb

@@ -1,10 +0,0 @@
-class MactagGenerator < Rails::Generator::Base
-
-  def manifest
-    record do |m|
-      m.directory "config"
-      m.template "mactag.rb", File.join("config", "mactag.rb")
-    end
-  end
-
-end

data/generators/mactag/templates/mactag.rb

@@ -1,11 +0,0 @@
-Mactag::Table.generate do
-  app "app/**/*.rb", "lib/*.rb"
-
-  plugins "thinking-sphinx", "formtastic"
-
-  gems "paperclip", "authlogic"
-  gem "formtastic", :version => "0.9.7"
-
-  rails :except => :actionmailer
-  rails :only => [:activerecord, :active_support]
-end

data/tasks/mactag_tasks.rake

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), '/../lib/mactag/tasks')