mactag 0.0.1

data/README.markdown

@@ -0,0 +1,68 @@
+# Mactag
+
+Mactag is a plugin for Rails developers that do their development in
+an editor that supports Ctags (Emacs, Vim, 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
+
+Install the plugin:
+
+    $ ./script/plugin install git://github.com/rejeep/mactag.git
+
+## Gem
+
+Install the gem:
+
+    $ sudo gem install mactag
+
+If 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:
+
+    $ ./script/generate 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.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.binary = "etags -o TAGS"
+
+    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
+
+# Usage
+
+To create the TAGS file. Simpy run:
+    $ rake mactag
+
+# License
+
+Copyright (c) 2010 Johan Andersson, released under the MIT license

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/features/app.feature

@@ -0,0 +1,35 @@
+Feature: Tag application files
+  In order to create a TAGS file
+  As a user
+  I want to tag application files
+
+  Background:
+    Given a Rails application
+    And mactag is installed
+    
+  Scenario: Tag single file
+    Given a javascript function "show" in "whitebox"
+    And an app mactag config with the following tags
+    | tag                            |
+    | public/javascripts/whitebox.js |
+    When I create the tags file
+    Then the tags file should contain "show"
+
+  Scenario: Tag multiple files
+    Given a javascript function "hide" in "whitebox"
+    And a ruby method "to_s" in the "user" model
+    And an app mactag config with the following tags
+    | tag                            |
+    | public/javascripts/whitebox.js |
+    | app/models/user.rb             |
+    When I create the tags file
+    Then the tags file should contain "hide"
+    And the tags file should contain "to_s"
+
+  Scenario: Tag files recursive
+    Given a ruby method "kill!" in the "user" model
+    And an app mactag config with the following tags
+    | tag         |
+    | app/**/*.rb |
+    When I create the tags file
+    Then the tags file should contain "kill!"

data/features/gem.feature

@@ -0,0 +1,59 @@
+Feature: Tag Gems
+  In order to create a TAGS file
+  As a user
+  I want to tag gems
+
+  Background:
+    Given a Rails application
+    And mactag is installed
+  
+  Scenario: Tag single gem
+    Given the gem "superduper" version "1.0.0" is installed
+    And an acts as method for the "superduper-1.0.0" gem
+    And a gem mactag config with the following tags
+    | tag        |
+    | superduper |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+
+  Scenario: Tag multiple gems
+    Given the gem "superduper" version "1.0.0" is installed
+    And the gem "dunder" version "1.0.0" is installed
+    And an acts as method for the "superduper-1.0.0" gem
+    And an acts as method for the "dunder-1.0.0" gem
+    And a gem mactag config with the following tags
+    | tag        |
+    | superduper |
+    | dunder     |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+    Then the tags file should contain "acts_as_dunder"
+
+  Scenario: Tag specific version
+    Given the gem "superduper" version "1.0.0" is installed
+    And the gem "superduper" version "1.0.1" is installed
+    And an acts as method for the "superduper-1.0.0" gem
+    And an acts as method for the "superduper-1.0.1" gem
+    And a gem mactag config with the following tags
+    | tag        | version |
+    | superduper |   1.0.0 |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+    And the tags file should contain "1.0.0"
+    And the tags file should not contain "1.0.1"
+
+  Scenario: Tag latest version
+    Given the gem "superduper" version "1.0.2" is installed
+    And the gem "superduper" version "1.0.1" is installed
+    And the gem "superduper" version "1.0.0" is installed
+    And an acts as method for the "superduper-1.0.2" gem
+    And an acts as method for the "superduper-1.0.1" gem
+    And an acts as method for the "superduper-1.0.0" gem
+    And a gem mactag config with the following tags
+    | tag        |
+    | superduper |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+    And the tags file should contain "1.0.2"
+    And the tags file should not contain "1.0.0"
+    And the tags file should not contain "1.0.1"

data/features/plugin.feature

@@ -0,0 +1,41 @@
+Feature: Tag Plugins
+  In order to create a TAGS file
+  As a user
+  I want to tag plugins
+
+  Background:
+    Given a Rails application
+    And mactag is installed
+  
+  Scenario: Tag single plugin
+    Given the plugin "superduper" is installed
+    And an acts as method for the "superduper" plugin
+    And a plugin mactag config with the following tags
+    | tag        |
+    | superduper |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+
+  Scenario: Tag multiple plugins
+    Given the plugin "superduper" is installed
+    And the plugin "dunder" is installed
+    And an acts as method for the "superduper" plugin
+    And an acts as method for the "dunder" plugin
+    And a plugin mactag config with the following tags
+    | tag        |
+    | superduper |
+    | dunder     |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+    Then the tags file should contain "acts_as_dunder"
+
+  Scenario: Tag all plugins
+    Given the plugin "superduper" is installed
+    And the plugin "dunder" is installed
+    And an acts as method for the "superduper" plugin
+    And an acts as method for the "dunder" plugin
+    And a plugin mactag config with the following tags
+    | tag |
+    When I create the tags file
+    Then the tags file should contain "acts_as_superduper"
+    Then the tags file should contain "acts_as_dunder"

data/features/rails/actionmailer/lib/action_mailer/base.rb

@@ -0,0 +1,9 @@
+module ActionMailer #:nodoc:
+  class Base
+    class << self
+      def deliver(mail)
+        # ...
+      end
+    end
+  end
+end

data/features/rails/actionpack/lib/action_controller/caching/actions.rb

@@ -0,0 +1,11 @@
+module ActionController
+  module Caching
+    module Actions
+      module ClassMethods
+        def caches_action(*actions)
+          # ...
+        end
+      end
+    end
+  end
+end

data/features/rails/actionpack/lib/action_view/action_view/helpers/form_tag_helper.rb

@@ -0,0 +1,9 @@
+module ActionView
+  module Helpers
+    module FormTagHelper
+      def form_tag(url_for_options = {}, options = {}, *parameters_for_url, &block)
+        # ...
+      end
+    end
+  end
+end

data/features/rails/activerecord/lib/active_record/associations.rb

@@ -0,0 +1,9 @@
+module ActiveRecord
+  module Association
+    module ClassMethods
+      def has_many(association_id, options = {}, &extension)
+        # ...
+      end
+    end
+  end
+end

data/features/rails/activeresource/lib/active_resource/connection.rb

@@ -0,0 +1,7 @@
+module ActiveResource
+  class Connection
+    def get(path, headers = {})
+      # ...
+    end
+  end
+end

data/features/rails/activesupport/lib/active_support/core_ext/hash/diff.rb

@@ -0,0 +1,5 @@
+class Hash
+  def diff(h2)
+    # ...
+  end
+end

data/features/rails_gem.feature

@@ -0,0 +1,69 @@
+Feature: Tag Rails as a Gem
+  In order to create a TAGS file
+  As a user
+  I want to tag Rails
+  
+  Background:
+    Given a Rails application
+    And mactag is installed
+    
+  Scenario: Tag all packages
+    Given rails is installed as a gem
+    And a rails mactag config with the following tags
+    | tag |
+    When I create the tags file
+    Then the tags file should contain "diff"
+    And the tags file should contain "get"
+    And the tags file should contain "has_many"
+    And the tags file should contain "deliver"
+    And the tags file should contain "caches_action"
+    And the tags file should contain "form_tag"
+    
+  Scenario: Tag only some packages
+    Given rails is installed as a gem
+    And a rails mactag config with the following tags
+    | only          |
+    | activerecord  |
+    | activesupport |
+    When I create the tags file
+    Then the tags file should contain "diff"
+    And the tags file should contain "has_many"
+    And the tags file should not contain "get"
+    And the tags file should not contain "deliver"
+    And the tags file should not contain "caches_action"
+    And the tags file should not contain "form_tag"
+
+  Scenario: Tag all except some packages
+    Given rails is installed as a gem
+    And a rails mactag config with the following tags
+    | except            |
+    | actioncontroller  |
+    | actionview        |
+    When I create the tags file
+    Then the tags file should contain "diff"
+    And the tags file should contain "has_many"
+    And the tags file should contain "get"
+    And the tags file should contain "deliver"
+    And the tags file should not contain "caches_action"
+    And the tags file should not contain "form_tag"
+
+  Scenario: Tag specific version
+    Given rails version "3.0.0" is installed as a gem
+    And rails version "2.3.5" is installed as a gem
+    And a rails mactag config with the following tags
+    | version |
+    |   3.0.0 |
+    When I create the tags file
+    Then the tags file should contain "3.0.0"
+    And the tags file should not contain "2.3.5"
+
+  Scenario: Tag latest version
+    Given rails version "3.0.0" is installed as a gem
+    And rails version "2.3.5" is installed as a gem
+    And rails version "2.3.2" is installed as a gem
+    And a rails mactag config with the following tags
+    | tag |
+    When I create the tags file
+    Then the tags file should contain "3.0.0"
+    And the tags file should not contain "2.3.2"
+    And the tags file should not contain "2.3.5"

data/features/rails_vendor.feature

@@ -0,0 +1,46 @@
+Feature: Tag Rails in vendor
+  In order to create a TAGS file
+  As a user
+  I want to tag Rails
+  
+  Background:
+    Given a Rails application
+    And mactag is installed
+    And rails lives in vendor
+
+  Scenario: Tag all packages
+    Given a rails mactag config with the following tags
+    | tag |
+    When I create the tags file
+    Then the tags file should contain "diff"
+    And the tags file should contain "get"
+    And the tags file should contain "has_many"
+    And the tags file should contain "deliver"
+    And the tags file should contain "caches_action"
+    And the tags file should contain "form_tag"
+    
+  Scenario: Tag only some packages
+    Given a rails mactag config with the following tags
+    | only           |
+    | activerecord   |
+    | active_support |
+    When I create the tags file
+    Then the tags file should contain "diff"
+    And the tags file should contain "has_many"
+    And the tags file should not contain "get"
+    And the tags file should not contain "deliver"
+    And the tags file should not contain "caches_action"
+    And the tags file should not contain "form_tag"
+
+  Scenario: Tag all except some packages
+    Given a rails mactag config with the following tags
+    | except            |
+    | action_controller |
+    | actionview        |
+    When I create the tags file
+    Then the tags file should contain "diff"
+    And the tags file should contain "has_many"
+    And the tags file should contain "get"
+    And the tags file should contain "deliver"
+    And the tags file should not contain "caches_action"
+    And the tags file should not contain "form_tag"

data/features/step_definitions/app_steps.rb

@@ -0,0 +1,11 @@
+Given /^an app mactag config with the following tags$/ do |table|
+  tags = table.rows.flatten.collect(&:quote).join(", ")
+
+  @app.puts "config/mactag.rb" do
+    <<-eos
+      Mactag::Table.generate do
+        app #{tags}
+      end
+    eos
+  end
+end

data/features/step_definitions/gem_steps.rb

@@ -0,0 +1,40 @@
+Given /^the gem "([^\"]*)" version "([^\"]*)" is installed$/ do |gem, version|
+  @app.install_gem(gem, version)
+end
+
+Given /^an acts as method for the "([^\"]*)" gem$/ do |gem|
+  file = File.join("vendor", "gems", gem, "lib", "#{gem}.rb")
+  @app.puts file do
+    <<-eos
+      module #{gem.camelize}
+        def self.included(base)
+          base.send :extend, ClassMethods
+        end
+
+        module ClassMethods
+          def acts_as_#{gem}
+            # ...
+          end
+        end
+      end
+    eos
+  end
+end
+
+Given /^a gem mactag config with the following tags$/ do |table|
+  if version = table.hashes.first["version"]
+    tags = "#{table.hashes.first["tag"].quote}, :version => #{version.quote}"
+  else
+    tags = table.rows.flatten.collect(&:quote).join(", ")
+  end
+
+  @app.puts "config/mactag.rb" do
+    <<-eos
+      Mactag::Config.gem_home = File.join("vendor", "gems")
+
+      Mactag::Table.generate do
+        gems #{tags}
+      end
+    eos
+  end
+end

data/features/step_definitions/mactab_steps.rb

@@ -0,0 +1,53 @@
+Given /^a Rails application$/ do
+  @app = RailsApp.new
+end
+
+Given /^mactag is installed$/ do
+  mactag = File.join(@app.rails_root, "vendor", "plugins", "mactag")
+
+  FileUtils.mkdir_p(mactag)
+
+  [ "lib", "tasks", "Rakefile", "init.rb" ].each do |name|
+    file = File.join(File.dirname(__FILE__), "..", "..", name)
+
+    FileUtils.cp_r(file, mactag)
+  end
+end
+
+Given /^a javascript function "([^\"]*)" in "([^\"]*)"$/ do |function, file|
+  @app.puts "public/javascripts/#{file}.js" do
+    <<-eos
+      function #{function}() {
+        // ...
+      }
+    eos
+  end
+end
+
+Given /^a ruby method "([^\"]*)" in the "([^\"]*)" model$/ do |method, model|
+  @app.puts "app/models/#{model}.rb" do
+    <<-eos
+      class #{model.camelize}
+        def #{method}
+          # ...
+        end
+      end
+    eos
+  end
+end
+
+When /^I create the tags file$/ do
+  @tags = TagsFile.new(@app)
+end
+
+Then /^the tags file should contain "([^\"]*)"$/ do |tag|
+  assert @tags.contain?(tag)
+end
+  
+Then /^the tags file should not contain "([^\"]*)"$/ do |tag|
+  assert !@tags.contain?(tag)
+end
+
+After do
+  @app.destroy
+end