mactag 0.5.4 → 0.6.0

data/lib/mactag/dsl.rb

@@ -4,70 +4,235 @@ module Mactag
   # Mactag DSL.
   #
   class Dsl
+    attr_reader :builder
+
     def initialize(builder)
       @builder = builder
     end
 
     ##
     #
-    # @see Mactag::Tag::App
+    # This is the method used to index. Three different things can be
+    # indexed: the current project, gems and Rails (which really is a
+    # collection of gems).
     #
-    def app(*tags)
-      if tags.empty?
-        raise ArgumentError.new('App requires at least one argument')
-      end
-      
-      tags.each do |tag|
-        @builder << Mactag::Tag::App.new(tag)
+    # = App
+    #
+    # App indexes files in the current project.
+    #
+    # == Examples
+    #
+    #   Mactag do
+    #     # Index single file.
+    #     index 'lib/super_duper.rb'
+    #
+    #     # Index all ruby files in lib, recursive.
+    #     index 'lib/**/*.rb'
+    #
+    #     # Index all helper and model ruby files.
+    #     index 'app/helpers/*.rb', 'app/models/*.rb'
+    #
+    #     # Same as above
+    #     index 'app/{models,helpers}/*.rb'
+    #   end
+    #
+    #
+    # = Gem
+    #
+    # Index Ruby gems.
+    #
+    # == Examples
+    #
+    #   Mactag do
+    #     # Index all gems specified in Gemfile.
+    #     index :gems
+    #
+    #     # Index the gem whenever, latest version.
+    #     index 'whenever'
+    #
+    #     # Index the thinking-sphinx and carrierwave gems, latest versions.
+    #     index 'thinking-sphinx', 'carrierwave'
+    #
+    #     # Index the gem simple_form, version 1.5.2.
+    #     index 'simple_form', :version => '1.5.2'
+    #   end
+    #
+    #
+    # = Rails
+    #
+    # Index Rails.
+    #
+    # == Packages
+    #
+    # These are the packages that can be indexed. Naming does not
+    # matter, so <tt>activerecord</tt> and <tt>active_record</tt> are
+    # the same.
+    #
+    # * actionmailer
+    # * actionpack
+    # * activemodel
+    # * activerecord
+    # * activeresource
+    # * railties
+    # * activesupport
+    #
+    #
+    # == Examples
+    #
+    #   Mactag do
+    #     # Index all packages, same version as application
+    #     index :rails
+    #
+    #     # Index all packages, version 3.1.3
+    #     index :rails, :version => '3.1.3'
+    #
+    #     # Index all packages except activerecord, same version as application
+    #     index :rails, :except => :activerecord
+    #
+    #     # Index only activerecord and actionview, same version as application
+    #     index :rails, :only => [:activerecord, :action_view]
+    #
+    #     # Index all packages except activerecord and actionview,
+    #     # same version as application
+    #     index :rails, :except => ['activerecord', :action_controller]
+    #
+    #     # Index all packages except actionmailer, version 3.1.3
+    #     index :rails, :except => :actionmailer, :version => '3.1.3'
+    #   end
+    #
+    def index(*args)
+      if args.first == :app
+        app_private
+      elsif args.first == :gems
+        gem_private
+      elsif args.first == :rails
+        rails_private(*args)
+      else
+        options = args.last
+
+        if options[:version] && args.size > 2
+          raise ArgumentError.new('The :version option is not valid when specifying more than one gem')
+        end
+
+        if options.is_a?(Hash) || args.all? { |arg| Mactag::Indexer::Gem.exist?(arg) }
+          gem_private(*args)
+        else
+          app_private(*args)
+        end
       end
     end
 
     ##
     #
-    # @see Mactag::Tag::Plugin
+    # <b>DEPRECATED:</b> Please use '#index' instead.
     #
-    def plugin(*plugins)
-      if plugins.empty?
-        plugins = Mactag::Tag::Plugin.all
-      end
+    def app(*args)
+      $stderr.puts '[DEPRECATION] Please use #index instead of #app.'
 
-      plugins.each do |plugin|
-        @builder << Mactag::Tag::Plugin.new(plugin)
+      if args.empty?
+        index(:app)
+      else
+        index(*args)
       end
     end
-    alias :plugins :plugin
 
     ##
     #
-    # @see Mactag::Tag::Gem
+    # <b>DEPRECATED:</b> Please use '#index' instead.
     #
-    def gem(*gems)
-      options = gems.extract_options!
-      
-      if options[:version] && gems.size > 1
-        raise ArgumentError.new('The :version option is not valid when specifying more than one gem')
-      end
+    def gem(*args)
+      $stderr.puts '[DEPRECATION] Please use #index instead of #gems.'
 
-      if gems.empty?
-        @builder << Mactag::Tag::Gem.all
+      if args.empty?
+        index(:gems)
       else
-        gems.each do |gem|
-          @builder << Mactag::Tag::Gem.new(gem, options[:version])
-        end
+        index(*args)
       end
     end
     alias :gems :gem
 
     ##
     #
-    # @see Mactag::Tag::Rails
+    # <b>DEPRECATED:</b> Please use '#index' instead.
+    #
+    def rails(*args)
+      $stderr.puts '[DEPRECATION] Please use #index instead of #rails.'
+
+      if args.empty?
+        index(:rails)
+      else
+        index(*args)
+      end
+    end
+
+
+    ##
+    #
+    # <b>DEPRECATED:</b> Please use gems instead.
+    #
+    # @see Mactag::Indexer::Plugin
     #
-    def rails(options = {})
+    def plugin(*plugins)
+      $stderr.puts '[DEPRECATION] Please use gems instead of plugins.'
+
+      plugin_private(*plugins)
+    end
+    alias :plugins :plugin
+
+
+    private
+
+    def app_private(*tags)
+      if tags.empty?
+        @builder << Mactag::Indexer::App.all
+      else
+        tags.each do |tag|
+          @builder << Mactag::Indexer::App.new(tag)
+        end
+      end
+    end
+
+    def gem_private(*args)
+      if args.empty?
+        @builder << Mactag::Indexer::Gem.all
+      else
+        options = args.last
+
+        if version = options[:version]
+          @builder << Mactag::Indexer::Gem.new(args.first, version)
+        else
+          args.each do |arg|
+            @builder << Mactag::Indexer::Gem.new(arg)
+          end
+        end
+      end
+    end
+
+    def rails_private(*args)
+      args.shift
+
+      if args.size.zero?
+        options = {}
+      else
+        options = args.first
+      end
+
       if options[:only] && options[:except]
         raise ArgumentError.new('Can not specify options :only and :except at the same time')
       end
-      
-      @builder << Mactag::Tag::Rails.new(options)
+
+      @builder << Mactag::Indexer::Rails.new(options)
+    end
+
+    def plugin_private(*plugins)
+      if plugins.empty?
+        @builder << Mactag::Indexer::Plugin.all
+      else
+        plugins.each do |plugin|
+          @builder << Mactag::Indexer::Plugin.new(plugin)
+        end
+      end
     end
   end
 end
+

data/lib/mactag/indexer.rb

@@ -0,0 +1,9 @@
+require 'mactag/indexer/app'
+require 'mactag/indexer/plugin'
+require 'mactag/indexer/gem'
+require 'mactag/indexer/rails'
+
+module Mactag
+  module Indexer
+  end
+end

data/lib/mactag/indexer/app.rb

@@ -0,0 +1,22 @@
+module Mactag
+  module Indexer
+    class App
+      attr_reader :tag
+
+      PATTERNS = ['app/**/*.rb', 'lib/**/*.rb']
+
+      def initialize(tag)
+        @tag = tag
+      end
+
+
+      class << self
+        def all
+          PATTERNS.map do |pattern|
+            new(pattern)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mactag/indexer/gem.rb

@@ -0,0 +1,72 @@
+module Mactag
+  module Indexer
+    class Gem
+      attr_accessor :name
+      attr_writer :version
+
+      def initialize(name, version = nil)
+        @name = name
+        @version = version
+      end
+
+      def tag
+        if exist?
+          File.join(Mactag::Config.gem_home, combo, 'lib', '**', '*.rb')
+        else
+          raise GemNotFoundError.new(self)
+        end
+      end
+
+      def exist?
+        dirs.size > 0
+      end
+
+      def version
+        @version || most_recent
+      end
+
+      def most_recent
+        unless dirs.empty?
+          if dirs.size == 1
+            gem = dirs.first
+          else
+            gem = dirs.sort.last
+          end
+          regex = /#{escaped_name}-([^\/]+)/
+
+          if match = regex.match(gem)
+            match[1]
+          end
+        end
+      end
+
+      def dirs
+        @dirs ||= Dir.glob(File.join(Mactag::Config.gem_home, "#{name}-*"))
+      end
+
+      class << self
+        def all
+          gems = Mactag::Bundler.gems
+          gems.map do |name, version|
+            new(name, version)
+          end
+        end
+
+        def exist?(name)
+          new(name).exist?
+        end
+      end
+
+
+      private
+
+      def combo
+        "#{name}-#{version}"
+      end
+
+      def escaped_name
+        Regexp.escape(name)
+      end
+    end
+  end
+end

data/lib/mactag/{tag → indexer}/plugin.rb

@@ -1,18 +1,19 @@
 module Mactag
-  module Tag
+  module Indexer
     ##
     #
     # Tag plugins in Rails project.
     #
     # ==== Examples
+    #
     #   Mactag do
-    #     # Tag single plugin
+    #     # Index single plugin.
     #     plugin 'whenever'
     #
-    #     # Tag multiple plugins
+    #     # Index multiple plugins.
     #     plugins 'thinking-sphinx', 'formtastic'
     #
-    #     # Tag all plugins
+    #     # Index all plugins.
     #     plugins
     #   do
     #
@@ -26,14 +27,14 @@ module Mactag
       end
 
       def tag
-        if exists?
-          return File.join(PLUGIN_PATH, name, 'lib', '**', '*.rb')
+        if exist?
+          File.join(PLUGIN_PATH, name, 'lib', '**', '*.rb')
         else
           raise PluginNotFoundError.new(self)
         end
       end
 
-      def exists?
+      def exist?
         File.directory?(path)
       end
 
@@ -43,8 +44,8 @@ module Mactag
 
       def self.all
         pattern = File.join(PLUGIN_PATH, '*')
-        Dir.glob(pattern).map do |f|
-          File.basename(f)
+        Dir.glob(pattern).map do |file|
+          new(File.basename(file))
         end
       end
     end

data/lib/mactag/indexer/rails.rb

@@ -0,0 +1,46 @@
+module Mactag
+  module Indexer
+    class Rails
+
+      PACKAGES = %w(actionmailer actionpack activemodel activerecord activeresource activesupport railties)
+
+      attr_accessor :only, :except, :version
+
+      def initialize(options)
+        @only = packagize(options[:only])
+        @except = packagize(options[:except])
+        @version = options[:version]
+      end
+
+      def tag
+        packages.inject([]) do |array, package|
+          array << Gem.new(package, version).tag
+          array
+        end
+      end
+
+      def packages
+        if only || except
+          only || PACKAGES - except
+        else
+          PACKAGES
+        end
+      end
+
+      def version
+        @version || ::Rails.version
+      end
+
+
+      private
+
+      def packagize(pkgs)
+        return nil if pkgs.blank?
+
+        Array(pkgs).map do |pkg|
+          "#{pkg}".gsub(/[^a-z]/, '')
+        end
+      end
+    end
+  end
+end