mactag 0.0.1

data/lib/mactag/tag/rails.rb

@@ -0,0 +1,138 @@
+module Mactag
+  module Tag
+
+    # Tag for the Rails source.
+    #
+    # ==== Packages
+    # Naming does not matter. So *activerecord* and *active_record* are the same.
+    #
+    # * activesupport
+    # * activeresource
+    # * activerecord
+    # * actionmailer
+    # * actioncontroller
+    # * actionview
+    #
+    # ==== Examples
+    #   Mactag::Table.generate do
+    #     # Tag all rails packages, latest version
+    #     rails
+    #
+    #     # Tag all rails packages, version 2.3.5
+    #     rails :version => "2.3.5"
+    #
+    #     # Tag only activerecord, latest version
+    #     rails :only => :active_record
+    #
+    #     # Tag all packages except activerecord, latest version
+    #     rails :except => :activerecord
+    #
+    #     # Tag only activerecord and actionview, latest version
+    #     rails :only => [:activerecord, :action_view]
+    #
+    #     # Tag all packages except activerecord and actionview, latest version
+    #     rails :except => ["activerecord", :action_controller]
+    #
+    #     # Tag all packages except actionmailer, version 2.3.4
+    #     rails :except => :actionmailer, :version => "2.3.4"
+    #   do
+    class Rails
+
+      VENDOR = File.join("vendor", "rails")
+
+      PACKAGES = {
+        :activesupport    => ["activesupport", "active_support"],
+        :activeresource   => ["activeresource", "active_resource"],
+        :activerecord     => ["activerecord", "active_record"],
+        :actionmailer     => ["actionmailer", "action_mailer"],
+        :actioncontroller => ["actionpack", "action_controller"],
+        :actionview       => ["actionpack", "action_view"]
+      }
+
+      def initialize(options)
+        @options = options
+
+        @only = packagize!(options[:only])
+        @except = packagize!(options[:except])
+      end
+
+      def files
+        result = []
+
+        packages.each do |package|
+          path = []
+          path << rails_home
+          path << package_path(package)
+          path << "**"
+          path << "*.rb"
+          path.flatten!
+
+          result << Dir.glob(File.join(path))
+        end
+
+        result.flatten
+      end
+
+
+      private
+
+      def packages
+        result = []
+
+        unless @only || @except
+          result = PACKAGES.keys
+        else
+          if @only
+            result = @only
+          elsif @except
+            result = PACKAGES.keys - @except
+          end
+        end
+
+        result
+      end
+
+      def package_path(package)
+        paths = PACKAGES[package].dup
+        paths.insert(1, "lib")
+
+        unless Mactag::Tag::Rails.vendor?
+          top = paths.first
+          if version = @options[:version]
+            top = "#{top}-#{version}"
+          else
+            versions = Dir.glob(File.join(Mactag::Config.gem_home, "#{top}-*"))
+
+            if versions.size == 1
+              top = versions.first
+            else
+              top = versions.sort.last
+            end
+
+            top = File.basename(top)
+          end
+          paths[0] = top
+        end
+
+        File.join(paths)
+      end
+
+      def self.vendor?
+        File.exist?(VENDOR)
+      end
+
+      def rails_home
+        @rails_home ||= Mactag::Tag::Rails.vendor? ? VENDOR : Mactag::Config.gem_home
+      end
+
+      def packagize!(pkgs)
+        return nil if pkgs.blank?
+
+        Array(pkgs).collect do |pkg|
+          "#{pkg}".gsub(/[^a-z]/, '').to_sym
+        end
+      end
+
+    end
+  end
+end

data/lib/mactag/tasks.rb

@@ -0,0 +1,10 @@
+Rake::Task[:environment].invoke
+
+require 'mactag'
+
+require File.join(Rails.root, "config", "mactag")
+
+desc "Creates an Ctags file"
+task :mactag do
+  system "cd #{Rails.root} && #{Mactag::Config.binary} #{Mactag::Table.tags}"
+end

data/tasks/mactag_tasks.rake

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

data/test/mactag/config_test.rb

@@ -0,0 +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
+  end
+  
+end

data/test/mactag/tag/app_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class AppTest < ActiveSupport::TestCase
+
+  context "an app tag" do
+    setup do
+      @tags = [ "app/**/*.rb", "public/javascripts/*.js" ]
+      @app = Mactag::Tag::App.new(@tags)
+    end
+
+    should "return the correct files" do
+      assert_same_elements [@tags], @app.files
+    end
+  end
+
+end

data/test/mactag/tag/gem_test.rb

@@ -0,0 +1,42 @@
+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
+        Dir.stubs(:glob).returns("whenever")
+
+        @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
+  
+end

data/test/mactag/tag/plugin_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+
+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
+      @plugin = Mactag::Tag::Plugin.new
+    end
+
+    should "return all plugins as path" do
+      assert_equal @plugin.files, "vendor/plugins/*/lib/**/*.rb"
+    end
+  end
+  
+  context "with one plugin argument" do
+    setup do
+      @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
+      @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
+  
+end

data/test/mactag/tag/rails_test.rb

@@ -0,0 +1,182 @@
+require 'test_helper'
+
+class RailsTest < ActiveSupport::TestCase
+
+  should "have correct vendor path" do
+    assert_equal "vendor/rails", Mactag::Tag::Rails::VENDOR
+  end
+
+  should "have correct packages" do
+    packages = Mactag::Tag::Rails::PACKAGES
+    keys = packages.keys
+
+    assert_contains keys, :activesupport
+    assert_contains keys, :activeresource
+    assert_contains keys, :activerecord
+    assert_contains keys, :actionmailer
+    assert_contains keys, :actioncontroller
+    assert_contains keys, :actionview
+  end
+
+  should "have the correct paths" do
+    packages = Mactag::Tag::Rails::PACKAGES
+
+    assert_equal ["activesupport", "active_support"]  , packages[:activesupport]
+    assert_equal ["activeresource", "active_resource"], packages[:activeresource]
+    assert_equal ["activerecord", "active_record"]    , packages[:activerecord]
+    assert_equal ["actionmailer", "action_mailer"]    , packages[:actionmailer]
+    assert_equal ["actionpack", "action_controller"]  , packages[:actioncontroller]
+    assert_equal ["actionpack", "action_view"]        , packages[:actionview]
+  end
+
+  context "packages" do
+    context "without arguments" do
+      setup do
+        @rails = Mactag::Tag::Rails.new({})
+      end
+
+      should "return all packages" do
+        assert_same_elements Mactag::Tag::Rails::PACKAGES.keys, @rails.send(:packages)
+      end
+    end
+
+    context "with some packages only" do
+      setup do
+        @rails = Mactag::Tag::Rails.new(:only => [:active_support, :activerecord])
+      end
+
+      should "return only those packages" do
+        assert_same_elements [:activesupport, :activerecord], @rails.send(:packages)
+      end
+    end
+
+    context "except some packages" do
+      setup do
+        @rails = Mactag::Tag::Rails.new(:except => [:active_support, :activerecord])
+      end
+
+      should "return all except those packages" do
+        assert_same_elements Mactag::Tag::Rails::PACKAGES.keys - [:activesupport, :activerecord], @rails.send(:packages)
+      end
+    end
+  end
+
+  context "rails in vendor" do
+    setup do
+      File.stubs(:exist?).returns(true)
+    end
+
+    should "be in vendor since file exist" do
+      assert Mactag::Tag::Rails.send(:vendor?)
+    end
+  end
+
+  context "rails home" do
+    context "when rails is in vendor" do
+      setup do
+        Mactag::Tag::Rails.stubs(:vendor?).returns(true)
+
+        @rails = Mactag::Tag::Rails.new({})
+      end
+
+      should "return vendor" do
+        assert_equal Mactag::Tag::Rails::VENDOR, @rails.send(:rails_home)
+      end
+    end
+
+    context "when rails is installed as a gem" do
+      setup do
+        Mactag::Tag::Rails.stubs(:vendor?).returns(false)
+
+        @rails = Mactag::Tag::Rails.new({})
+      end
+
+      should "return gem home" do
+        assert_equal Mactag::Config.gem_home, @rails.send(:rails_home)
+      end
+    end
+  end
+  
+  context "packagize" do
+    setup do
+      @rails = Mactag::Tag::Rails.new({})
+    end
+    
+    context "one package" do
+      setup do
+        @packagized = @rails.send(:packagize!, "active_record")
+      end
+      
+      should "be packagized" do
+        assert_equal [:activerecord], @packagized
+      end
+    end
+    
+    context "several packages" do
+      setup do
+        @packagized = @rails.send(:packagize!, ["_active_support_", "action_view"])
+      end
+      
+      should "be packagized" do
+        assert_equal [:activesupport, :actionview], @packagized
+      end
+    end
+  end
+  
+  context "package paths" do
+    context "when rails is in vendor" do
+      setup do
+        Mactag::Tag::Rails.stubs(:vendor?).returns(true)
+        
+        @rails = Mactag::Tag::Rails.new({})
+      end
+      
+      should "return the correct path" do
+        assert_equal "activerecord/lib/active_record", @rails.send(:package_path, :activerecord)
+      end
+    end
+    
+    context "when rails is installed as a gem" do
+      setup do
+        Mactag::Tag::Rails.stubs(:vendor?).returns(false)
+      end
+      
+      context "and there is a specific version" do
+        setup do
+          @rails = Mactag::Tag::Rails.new(:version => "3.0.0")
+        end
+        
+        should "return the correct path" do
+          assert_equal "activerecord-3.0.0/lib/active_record", @rails.send(:package_path, :activerecord)
+        end
+      end
+      
+      context "and there is no version specified" do
+        setup do
+          @rails = Mactag::Tag::Rails.new({})
+        end
+        
+        context "and there is only one version of rails" do
+          setup do
+            Dir.stubs(:glob).returns("activerecord-2.3.5")
+          end
+          
+          should "return the correct path" do
+            assert_equal "activerecord-2.3.5/lib/active_record", @rails.send(:package_path, :activerecord)
+          end
+        end
+        
+        context "and there are two versions of rails" do
+          setup do
+            Dir.stubs(:glob).returns(["activerecord-2.3.5", "activerecord-2.3.4"])
+          end
+          
+          should "return the correct path" do
+            assert_equal "activerecord-2.3.5/lib/active_record", @rails.send(:package_path, :activerecord)
+          end
+        end
+      end
+    end
+  end
+  
+end