mactag 0.1.1 → 0.2.0

data/lib/mactag/tag/parser.rb

@@ -1,33 +1,43 @@
 module Mactag
   module Tag
     class Parser
-
       def initialize(table)
         @table = table
       end
 
+      ##
+      #
       # @see Mactag::Tag::App
+      #
       def app(*files)
         @table << Mactag::Tag::App.new(*files)
       end
 
+      ##
+      #
       # @see Mactag::Tag::Plugin
+      #
       def plugin(*plugins)
         @table << Mactag::Tag::Plugin.new(*plugins)
       end
       alias_method :plugins, :plugin
 
+      ##
+      #
       # @see Mactag::Tag::Gem
+      #
       def gem(*gems)
         @table << Mactag::Tag::Gem.new(*gems)
       end
       alias_method :gems, :gem
 
+      ##
+      #
       # @see Mactag::Tag::Rails
+      #
       def rails(options = {})
         @table << Mactag::Tag::Rails.new(options)
       end
-
     end
   end
 end

data/lib/mactag/tag/plugin.rb

@@ -1,38 +1,41 @@
 module Mactag
   module Tag
-
-    # Tag for the current project plugins.
+    ##
+    #
+    # Tags plugins in current Rails application.
     #
     # ==== Examples
     #   Mactag::Table.generate do
-    #     # Tag the whenever plugin
-    #     plugin "whenever"
+    #     # Tag single plugin
+    #     plugin 'whenever'
+    #
+    #     # Tag multiple plugins
+    #     plugins 'thinking-sphinx', 'formtastic'
     #
-    #     # Tag the thinking-sphinx and formtastic plugins
-    #     plugins "thinking-sphinx", "formtastic"
+    #     # Tag all plugins
+    #     plugins
     #   do
+    #
     class Plugin
-
-      PLUGIN_PATH = File.join("vendor", "plugins")
+      PLUGIN_PATH = File.join('vendor', 'plugins')
 
       def initialize(*plugins)
         @plugins = plugins
       end
 
       def files
-        return File.join(PLUGIN_PATH, "*", "lib", "**", "*.rb") if @plugins.empty?
+        return File.join(PLUGIN_PATH, '*', 'lib', '**', '*.rb') if @plugins.empty?
 
         result = []
         @plugins.each do |plugin|
           if File.exist?(File.join(PLUGIN_PATH, plugin))
-            result << File.join(PLUGIN_PATH, plugin, "lib", "**", "*.rb")
+            result << File.join(PLUGIN_PATH, plugin, 'lib', '**', '*.rb')
           else
-            $stderr.puts "Plugin #{plugin} not found"
+            Mactag.warn "Plugin #{plugin} not found"
           end
         end
         result
       end
-
     end
   end
 end

data/lib/mactag/tag/rails.rb

@@ -1,19 +1,20 @@
-require 'mactag/tag/versioned'
-
 module Mactag
   module Tag
-
-    # Tag for the Rails source.
+    ##
+    #
+    # Tags Rails gem.
     #
     # ==== Packages
-    # Naming does not matter. So *activerecord* and *active_record* are the same.
+    # Naming does not matter, so *activerecord* and *active_record* are the same.
     #
-    # * activesupport
-    # * activeresource
-    # * activerecord
     # * actionmailer
-    # * actioncontroller
-    # * actionview
+    # * actionpack
+    # * activemodel
+    # * activerecord
+    # * activeresource
+    # * railties
+    # * activesupport
+    #
     #
     # ==== Examples
     #   Mactag::Table.generate do
@@ -21,7 +22,7 @@ module Mactag
     #     rails
     #
     #     # Tag all rails packages, version 2.3.5
-    #     rails :version => "2.3.5"
+    #     rails :version => '2.3.5'
     #
     #     # Tag only activerecord, latest version
     #     rails :only => :active_record
@@ -33,25 +34,22 @@ module Mactag
     #     rails :only => [:activerecord, :action_view]
     #
     #     # Tag all packages except activerecord and actionview, latest version
-    #     rails :except => ["activerecord", :action_controller]
+    #     rails :except => ['activerecord', :action_controller]
     #
     #     # Tag all packages except actionmailer, version 2.3.4
-    #     rails :except => :actionmailer, :version => "2.3.4"
+    #     rails :except => :actionmailer, :version => '2.3.4'
     #   do
+    #
     class Rails
-      
-      include Versioned
-
-      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"]
-      }
+      PACKAGES = [
+                  :actionmailer,
+                  :actionpack,
+                  :activemodel,
+                  :activerecord,
+                  :activeresource,
+                  :railties,
+                  :activesupport
+                 ]
 
       def initialize(options)
         @options = options
@@ -62,65 +60,44 @@ module Mactag
 
       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))
+          if PACKAGES.include?(package)
+            if version = @options[:version]
+              gem = Gem.new(package.to_s, :version => version)
+            else
+              gem = Gem.new(package.to_s)
+            end
+            result << gem.files
+          end
         end
-
-        result.flatten
+        result
       end
 
 
       private
 
+      ##
+      #
+      # Returns a list of all packages that should be included.
+      #
       def packages
         result = []
-
         unless @only || @except
-          result = PACKAGES.keys
+          result = PACKAGES
         else
           if @only
             result = @only
           elsif @except
-            result = PACKAGES.keys - @except
+            result = PACKAGES - @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
-            top = File.basename(latest(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
-
+      ##
+      #
+      # Packagizes all +pkgs+.
+      #
       def packagize!(pkgs)
         return nil if pkgs.blank?
 
@@ -128,7 +105,6 @@ module Mactag
           "#{pkg}".gsub(/[^a-z]/, '').to_sym
         end
       end
-
     end
   end
 end

data/test/mactag/config_test.rb

@@ -1,10 +1,40 @@
 require 'test_helper'
 
 class ConfigTest < ActiveSupport::TestCase
+  context 'binary' do
+    setup do
+      @binary = Mactag::Config.binary
+    end
 
-  should "have correct default options" do
-    assert_equal "ctags -o TAGS -e", Mactag::Config.binary
-    assert_equal "/Library/Ruby/Gems/1.8/gems", Mactag::Config.gem_home
+    should 'be right command' do
+      assert_equal 'ctags -o TAGS -e', @binary
+    end
   end
 
+  context 'gem home' do
+    context 'when using RVM' do
+      setup do
+        Mactag::Config.stubs(:rvm).returns(true)
+        File.stubs(:join).returns('/path/to/rvm/gems')
+
+        @gem_home = Mactag::Config.gem_home
+      end
+
+      should 'correct' do
+        assert_equal '/path/to/rvm/gems', @gem_home
+      end
+    end
+
+    context 'when not using RVM' do
+      setup do
+        Mactag::Config.stubs(:rvm).returns(false)
+
+        @gem_home = Mactag::Config.gem_home
+      end
+
+      should 'correct' do
+        assert_equal '/Library/Ruby/Gems/1.8/gems', @gem_home
+      end
+    end
+  end
 end

data/test/mactag/tag/app_test.rb

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

data/test/mactag/tag/gem_test.rb

@@ -1,56 +1,83 @@
 require 'test_helper'
 
 class GemTest < ActiveSupport::TestCase
+  def setup
+    File.stubs(:directory?).returns(true)
+  end
 
-  context "gem with version" do
+  context 'gem with version' do
     setup do
-      @gem = Mactag::Tag::Gem.new("thinking-sphinx", :version => "1.0.0")
+      Mactag::Config.stubs(:gem_home).returns('GEM_HOME')
+
+      @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")
+    should 'return the gem with that version' do
+      assert_contains @gem.files, File.join('GEM_HOME', 'thinking-sphinx-1.0.0', 'lib', '**', '*.rb')
     end
   end
 
-  context "gem without version" do
-    context "one gem" do
+  context 'gem without version' do
+    context 'single gem' do
       setup do
-        Dir.stubs(:glob).returns("whenever")
+        Dir.stubs(:glob).returns(['whenever-0.3.7'])
 
-        @gem = Mactag::Tag::Gem.new("whenever")
+        @gem = Mactag::Tag::Gem.new('whenever')
       end
 
-      should "return that gem" do
-        assert_contains @gem.files, "whenever/lib/**/*.rb"
+      should 'return that gem' do
+        assert_contains @gem.files, File.join('whenever-0.3.7', 'lib', '**', '*.rb')
       end
     end
 
-    context "multiple gems" do
+    context 'multiple gems' do
       setup do
-        Dir.stubs(:glob).returns(["whenever-0.3.7", "whenever-0.3.6"])
+        Dir.stubs(:glob).returns(['whenever-0.3.7', 'whenever-0.3.6'])
 
-        @gem = Mactag::Tag::Gem.new("whenever")
+        @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"
+      should 'return the gem with the latest version' do
+        assert_contains @gem.files, File.join('whenever-0.3.7', 'lib', '**', '*.rb')
+        assert_does_not_contain @gem.files, File.join('whenever-0.3.6', 'lib', '**', '*.rb')
       end
     end
   end
 
-  context "gem that does not exist" do
+  context 'gem that does not exist' do
     setup do
-      Dir.stubs(:glob).returns([nil])
+      Dir.stubs(:glob).returns([])
+      File.stubs(:directory?).returns(false)
 
-      @gem = Mactag::Tag::Gem.new("whenever")
+      @gem = Mactag::Tag::Gem.new('whenever')
     end
 
-    should "not raise exception because no such gem" do
+    should 'not raise exception because no such gem' do
       assert_nothing_raised do
         assert_equal [], @gem.files
       end
     end
   end
 
+  context '#exists?' do
+    setup do
+      @gem = Mactag::Tag::Gem.new('whatever')
+    end
+
+    context 'with valid gem' do
+      setup do
+        File.stubs(:directory?).returns(true)
+      end
+
+      should 'exist' do
+        assert @gem.send(:exists?, 'whatever')
+      end
+    end
+    
+    context 'with no gem' do
+      should 'exist' do
+        assert !@gem.send(:exists?, nil)
+      end
+    end
+  end
 end

data/test/mactag/tag/plugin_test.rb

@@ -1,60 +1,58 @@
 require 'test_helper'
 
 class PluginTest < ActiveSupport::TestCase
-  
-  should "have correct plugin path" do
-    assert_equal "vendor/plugins", Mactag::Tag::Plugin::PLUGIN_PATH
+  should 'have correct plugin path' do
+    assert_equal 'vendor/plugins', Mactag::Tag::Plugin::PLUGIN_PATH
   end
 
-  context "without arguments" do
+  context 'with no arguments' do
     setup do
-      File.stubs(:exist?).returns(true)
-      
       @plugin = Mactag::Tag::Plugin.new
     end
 
-    should "return all plugins as path" do
-      assert_equal @plugin.files, "vendor/plugins/*/lib/**/*.rb"
+    should 'return all plugins as path' do
+      assert_equal @plugin.files, 'vendor/plugins/*/lib/**/*.rb'
     end
   end
 
-  context "with one plugin argument" do
+  context 'with single plugin' do
     setup do
       File.stubs(:exist?).returns(true)
-      
-      @plugin = Mactag::Tag::Plugin.new("thinking-sphinx")
+
+      @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
+    should 'return the path to that plugin' do
+      assert_same_elements ['vendor/plugins/thinking-sphinx/lib/**/*.rb'], @plugin.files
     end
   end
 
-  context "with more thatn one plugin argument" do
+  context 'with multiple plugins' do
     setup do
       File.stubs(:exist?).returns(true)
-      
-      @plugin = Mactag::Tag::Plugin.new("thinking-sphinx", "formtastic")
+
+      @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"
+    should 'return the paths to those plugins' do
+      assert_same_elements @plugin.files, [
+                                           'vendor/plugins/thinking-sphinx/lib/**/*.rb',
+                                           'vendor/plugins/formtastic/lib/**/*.rb'
+                                          ]
     end
   end
 
-  context "plugin that does not exist" do
+  context 'plugin that does not exist' do
     setup do
       File.stubs(:exist?).returns(false)
-      
-      @plugin = Mactag::Tag::Plugin.new("typo")
+
+      @plugin = Mactag::Tag::Plugin.new('typo')
     end
 
-    should "not raise exception because no such plugin" do
+    should 'not raise exception because no such plugin' do
       assert_nothing_raised do
-        assert_equal [], @plugin.files
+        assert_same_elements [], @plugin.files
       end
     end
   end
-
 end