yard 0.6.8 → 0.7.0

data/lib/yard/cli/diff.rb

@@ -9,27 +9,34 @@ module YARD
     # @since 0.6.0
     class Diff < Command
       def initialize
-        require_rubygems
         super
         @list_all = false
+        @use_git = false
+        @old_git_commit = nil
+        @old_path = Dir.pwd
         log.show_backtraces = true
       end
-      
+
       def description
         'Returns the object diff of two gems or .yardoc files'
       end
-      
+
       def run(*args)
         registry = optparse(*args).map do |gemfile|
-          if load_gem_data(gemfile)
-            log.info "Found #{gemfile}"
+          if @use_git
+            load_git_commit(gemfile)
             Registry.all.map {|o| o.path }
           else
-            log.error "Cannot find gem #{gemfile}"
-            nil
+            if load_gem_data(gemfile)
+              log.info "Found #{gemfile}"
+              Registry.all.map {|o| o.path }
+            else
+              log.error "Cannot find gem #{gemfile}"
+              nil
+            end
           end
         end.compact
-        
+
         return if registry.size != 2
 
         [   ["Added objects", registry[1] - registry[0]],
@@ -54,12 +61,27 @@ module YARD
           puts
         end
       end
-      
+
       private
       
+      def load_git_commit(commit)
+        commit_path = 'git_commit' + commit.gsub(/\W/, '_')
+        tmpdir = File.join(Dir.tmpdir, commit_path)
+        log.info "Expanding #{commit} to #{tmpdir}..."
+        Dir.chdir(@old_path)
+        FileUtils.mkdir_p(tmpdir)
+        FileUtils.cp_r('.', tmpdir)
+        Dir.chdir(tmpdir)
+        log.info("git says: " + `git reset --hard #{commit}`.chomp)
+        generate_yardoc(tmpdir)
+        Dir.chdir(@old_path)
+        cleanup(commit_path)
+      end
+
       def load_gem_data(gemfile)
+        require_rubygems
         Registry.clear
-        
+
         # First check for argument as .yardoc file
         [File.join(gemfile, '.yardoc'), gemfile].each do |yardoc|
           log.info "Searching for .yardoc db at #{yardoc}"
@@ -69,11 +91,11 @@ module YARD
             return true
           end
         end
-        
+
         # Next check installed RubyGems
         gemfile_without_ext = gemfile.sub(/\.gem$/, '')
         log.info "Searching for installed gem #{gemfile_without_ext}"
-        Gem.source_index.find_name('').find do |spec| 
+        Gem.source_index.find_name('').find do |spec|
           if spec.full_name == gemfile_without_ext
             if yardoc = Registry.yardoc_file_for_gem(spec.name, "= #{spec.version}")
               Registry.load_yardoc(yardoc)
@@ -88,7 +110,7 @@ module YARD
             return true
           end
         end
-        
+
         # Look for local .gem file
         gemfile += '.gem' unless gemfile =~ /\.gem$/
         log.info "Searching for local gem file #{gemfile}"
@@ -98,7 +120,7 @@ module YARD
           end
           return true
         end
-        
+
         # Remote gemfile from rubygems.org
         url = "http://rubygems.org/downloads/#{gemfile}"
         log.info "Searching for remote gem file #{url}"
@@ -109,20 +131,20 @@ module YARD
         end
         false
       end
-      
+
       def expand_and_parse(gemfile, io)
         dir = expand_gem(gemfile, io)
         generate_yardoc(dir)
         cleanup(gemfile)
       end
-      
+
       def generate_yardoc(dir)
         olddir = Dir.pwd
         Dir.chdir(dir)
         log.enter_level(Logger::ERROR) { Yardoc.run('-n', '--no-save') }
         Dir.chdir(olddir)
       end
-      
+
       def expand_gem(gemfile, io)
         tmpdir = File.join(Dir.tmpdir, gemfile)
         log.info "Expanding #{gemfile} to #{tmpdir}..."
@@ -142,13 +164,13 @@ module YARD
         log.error "Missing RubyGems, cannot run this command."
         raise(e)
       end
-      
+
       def cleanup(gemfile)
         dir = File.join(Dir.tmpdir, gemfile)
         log.info "Cleaning up #{dir}..."
         FileUtils.rm_rf(dir)
       end
-      
+
       def optparse(*args)
         opts = OptionParser.new
         opts.banner = "Usage: yard diff [options] oldgem newgem"
@@ -158,17 +180,20 @@ module YARD
         opts.separator "If the files don't exist locally, they will be grabbed using the `gem fetch`"
         opts.separator "command. If the gem is a .yardoc directory, it will be used. Finally, if the"
         opts.separator "gem name matches an installed gem (full name-version syntax), that gem will be used."
-        
+
         opts.on('-a', '--all', 'List all objects, even if they are inside added/removed module/class') do
           @list_all = true
         end
+        opts.on('--git', 'Compare versions from two git commit/branches') do
+          @use_git = true
+        end
         common_options(opts)
         parse_options(opts, args)
         unless args.size == 2
           puts opts.banner
           exit(0)
         end
-          
+
         args
       end
     end

data/lib/yard/cli/gems.rb

@@ -6,22 +6,22 @@ module YARD
         @rebuild = false
         @gems = []
       end
-      
+
       def description; "Builds YARD index for gems" end
-      
+
       # Runs the commandline utility, parsing arguments and generating
       # YARD indexes for gems.
-      # 
+      #
       # @param [Array<String>] args the list of arguments
-      # @return [void] 
+      # @return [void]
       def run(*args)
         require 'rubygems'
         optparse(*args)
         build_gems
       end
-      
+
       private
-      
+
       # Builds .yardoc files for all non-existing gems
       # @param [Array] gems
       def build_gems
@@ -42,7 +42,7 @@ module YARD
           end
         end
       end
-      
+
       def add_gems(gems)
         0.step(gems.size - 1, 2) do |index|
           gem, ver_require = gems[index], gems[index + 1] || ">= 0"
@@ -54,7 +54,7 @@ module YARD
           end
         end
       end
-      
+
       # Parses options
       def optparse(*args)
         opts = OptionParser.new
@@ -66,12 +66,12 @@ module YARD
         opts.on('--rebuild', 'Rebuilds index') do
           @rebuild = true
         end
-        
+
         common_options(opts)
         parse_options(opts, args)
         add_gems(args)
-        
-        
+
+
         if !args.empty? && @gems.empty?
           log.error "No specified gems could be found for command"
         elsif @gems.empty?

data/lib/yard/cli/graph.rb

@@ -2,7 +2,7 @@ module YARD
   module CLI
     # A command-line utility to generate Graphviz graphs from
     # a set of objects
-    # 
+    #
     # @see Graph#run
     # @since 0.6.0
     class Graph < Command
@@ -10,7 +10,7 @@ module YARD
       # Default options are:
       #   :format => :dot
       attr_reader :options
-      
+
       # The set of objects to include in the graph.
       attr_reader :objects
 
@@ -20,13 +20,13 @@ module YARD
         @serializer = YARD::Serializers::StdoutSerializer.new
         @options = SymbolHash[:format => :dot]
       end
-      
+
       def description
         "Graphs class diagram using Graphviz"
       end
-    
+
       # Runs the command-line utility.
-      # 
+      #
       # @example
       #   grapher = Graph.new
       #   grapher.run('--private')
@@ -34,15 +34,15 @@ module YARD
       def run(*args)
         Registry.load
         optparse(*args)
-        
+
         contents = objects.map {|o| o.format(options) }.join("\n")
         Templates::Engine.render(:format => :dot, :type => :layout,
           :verifier => @verifier, :serializer => @serializer,
           :contents => contents)
       end
-      
+
       private
-      
+
       # Parses commandline options.
       # @param [Array<String>] args each tokenized argument
       def optparse(*args)
@@ -63,8 +63,8 @@ module YARD
         opts.on('-d', '--dependencies', 'Show mixins in dependency graph.') do
           options[:dependencies] = true
         end
-        
-        opts.on('--no-public', "Don't show public methods. (default shows public)") do 
+
+        opts.on('--no-public', "Don't show public methods. (default shows public)") do
           visibilities.delete(:public)
         end
 
@@ -72,7 +72,7 @@ module YARD
           visibilities.push(:protected)
         end
 
-        opts.on('--private', "Show or don't show private methods. (default hides private)") do 
+        opts.on('--private', "Show or don't show private methods. (default hides private)") do
           visibilities.push(:private)
         end
 
@@ -82,12 +82,12 @@ module YARD
         opts.on('--dot [OPTIONS]', 'Send the results directly to `dot` with optional arguments.') do |dotopts|
           @serializer = Serializers::ProcessSerializer.new('dot ' + dotopts.to_s)
         end
-        
+
         opts.on('-f', '--file [FILE]', 'Writes output to a file instead of stdout.') do |file|
           @serializer = Serializers::FileSystemSerializer.new(:basepath => '.', :extension => nil)
           @serializer.instance_eval "def serialized_path(object) #{file.inspect} end"
         end
-        
+
         common_options(opts)
         parse_options(opts, args)
 

data/lib/yard/cli/help.rb

@@ -4,7 +4,7 @@ module YARD
     # @since 0.6.0
     class Help < Command
       def description; "Retrieves help for a command" end
-      
+
       def run(*args)
         if args.first && cmd = CommandParser.commands[args.first.to_sym]
           cmd.run('--help')

data/lib/yard/cli/list.rb

@@ -0,0 +1,22 @@
+module YARD
+  module CLI
+    # Lists all constant and method names in the codebase. Uses {Yardoc} --list.
+    class List < Command
+      def description; 'Lists all constant and methods. Uses `yard doc --list`' end
+      
+      # Runs the commandline utility, parsing arguments and displaying a
+      # list of objects
+      #
+      # @param [Array<String>] args the list of arguments.
+      # @return [void]
+      def run(*args)
+        if args.include?('--help')
+          puts "Usage: yard list [yardoc_options]"
+          puts "Takes the same arguments as yardoc. See yardoc --help"
+        else
+          Yardoc.run('--list', *args)
+        end
+      end
+    end
+  end
+end

data/lib/yard/cli/server.rb

@@ -5,28 +5,28 @@ module YARD
     class Server < Command
       # @return [Hash] a list of options to pass to the doc server
       attr_accessor :options
-      
+
       # @return [Hash] a list of options to pass to the web server
       attr_accessor :server_options
-      
+
       # @return [Hash] a list of library names and yardoc files to serve
       attr_accessor :libraries
-      
+
       # @return [Adapter] the adapter to use for loading the web server
       attr_accessor :adapter
-      
+
       # @return [Array<String>] a list of scripts to load
       # @since 0.6.2
       attr_accessor :scripts
-      
+
       # @return [Array<String>] a list of template paths to register
       # @since 0.6.2
       attr_accessor :template_paths
-      
+
       def description
         "Runs a local documentation server"
       end
-      
+
       def run(*args)
         self.scripts = []
         self.template_paths = []
@@ -37,24 +37,24 @@ module YARD
         )
         self.server_options = {:Port => 8808}
         optparse(*args)
-        
+
         select_adapter.setup
         load_scripts
         load_template_paths
         adapter.new(libraries, options, server_options).start
       end
-      
+
       private
-      
+
       def load_scripts
         scripts.each {|file| load_script(file) }
       end
-      
+
       def load_template_paths
         return if YARD::Config.options[:safe_mode]
         Templates::Engine.template_paths |= template_paths
       end
-      
+
       def select_adapter
         return adapter if adapter
         require 'rubygems'
@@ -63,7 +63,7 @@ module YARD
       rescue LoadError
         self.adapter = YARD::Server::WebrickAdapter
       end
-      
+
       def add_libraries(args)
         (0...args.size).step(2) do |index|
           library, yardoc = args[index], args[index + 1]
@@ -76,7 +76,7 @@ module YARD
           end
         end
       end
-      
+
       def add_gems
         require 'rubygems'
         Gem.source_index.find_name('').each do |spec|
@@ -84,7 +84,7 @@ module YARD
           libraries[spec.name] << YARD::Server::LibraryVersion.new(spec.name, spec.version.to_s, nil, :gem)
         end
       end
-      
+
       def optparse(*args)
         opts = OptionParser.new
         opts.banner = 'Usage: yard server [options] [[library yardoc_file] ...]'
@@ -108,7 +108,7 @@ module YARD
         opts.on('-g', '--gems', 'Serves documentation for installed gems') do
           add_gems
         end
-        opts.on('-t', '--template-path PATH', 
+        opts.on('-t', '--template-path PATH',
                 'The template path to look for templates in. (used with -t).') do |path|
           self.template_paths << path
         end
@@ -140,7 +140,7 @@ module YARD
           self.scripts << file
         end
         parse_options(opts, args)
-        
+
         if args.empty? && libraries.empty?
           if !File.exist?('.yardoc')
             log.enter_level(Logger::INFO) do