yard 0.9.17 → 0.9.22

data/lib/yard/server/commands/library_index_command.rb

@@ -1,28 +1,28 @@
-# frozen_string_literal: true
-module YARD
-  module Server
-    module Commands
-      class LibraryIndexOptions < CLI::YardocOptions
-        attr_accessor :adapter, :libraries
-        default_attr :template, :doc_server
-        default_attr :type, :library_list
-        default_attr :serialize, false
-      end
-
-      # Returns the index of libraries served by the server.
-      class LibraryIndexCommand < Base
-        attr_accessor :options
-
-        def run
-          return unless path.empty?
-
-          self.options = LibraryIndexOptions.new
-          options.adapter = adapter
-          options.libraries = adapter.libraries
-          options.reset_defaults
-          render
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Server
+    module Commands
+      class LibraryIndexOptions < CLI::YardocOptions
+        attr_accessor :adapter, :libraries
+        default_attr :template, :doc_server
+        default_attr :type, :library_list
+        default_attr :serialize, false
+      end
+
+      # Returns the index of libraries served by the server.
+      class LibraryIndexCommand < Base
+        attr_accessor :options
+
+        def run
+          return unless path.empty?
+
+          self.options = LibraryIndexOptions.new
+          options.adapter = adapter
+          options.libraries = adapter.libraries
+          options.reset_defaults
+          render
+        end
+      end
+    end
+  end
+end

data/lib/yard/server/commands/list_command.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-module YARD
-  module Server
-    module Commands
-      # Returns a list of objects of a specific type
-      class ListCommand < LibraryCommand
-        include Templates::Helpers::BaseHelper
-
-        def run
-          Registry.load_all
-          options.update(:objects => run_verifier(Registry.all(:class, :module)))
-          list_type = request.path.split('/').last
-          meth = "generate_#{list_type}_list"
-          tpl = fulldoc_template
-          if tpl.respond_to?(meth)
-            tpl.send(meth)
-            cache(tpl.contents)
-          else
-            not_found
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Server
+    module Commands
+      # Returns a list of objects of a specific type
+      class ListCommand < LibraryCommand
+        include Templates::Helpers::BaseHelper
+
+        def run
+          Registry.load_all
+          options.update(:objects => run_verifier(Registry.all(:class, :module)))
+          list_type = request.path.split('/').last
+          meth = "generate_#{list_type}_list"
+          tpl = fulldoc_template
+          if tpl.respond_to?(meth)
+            tpl.send(meth)
+            cache(tpl.contents)
+          else
+            not_found
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard/server/commands/root_request_command.rb

@@ -1,15 +1,15 @@
-# frozen_string_literal: true
-module YARD
-  module Server
-    module Commands
-      # Serves requests from the root of the server
-      class RootRequestCommand < Base
-        include StaticFileHelpers
-
-        def run
-          static_template_file? || favicon? || not_found
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Server
+    module Commands
+      # Serves requests from the root of the server
+      class RootRequestCommand < Base
+        include StaticFileHelpers
+
+        def run
+          static_template_file? || favicon? || not_found
+        end
+      end
+    end
+  end
+end

data/lib/yard/server/commands/search_command.rb

@@ -1,79 +1,79 @@
-# frozen_string_literal: true
-module YARD
-  module Server
-    module Commands
-      # Performs a search over the objects inside of a library and returns
-      # the results as HTML or plaintext
-      class SearchCommand < LibraryCommand
-        include Templates::Helpers::BaseHelper
-        include Templates::Helpers::ModuleHelper
-        include DocServerHelper
-
-        attr_accessor :results, :query
-
-        def run
-          Registry.load_all
-          self.query = request.query['q']
-          redirect(abs_url(adapter.router.docs_prefix, single_library ? library : '')) if query.nil? || query =~ /\A\s*\Z/
-
-          found = Registry.at(query)
-          redirect(url_for(found)) if found
-
-          search_for_object
-          request.xhr? ? serve_xhr : serve_normal
-        end
-
-        def visible_results
-          results[0, 10]
-        end
-
-        private
-
-        def url_for(object)
-          abs_url(base_path(router.docs_prefix),
-            serializer.serialized_path(object))
-        end
-
-        def serve_xhr
-          headers['Content-Type'] = 'text/plain'
-          self.body = visible_results.map {|o|
-            [(o.type == :method ? o.name(true) : o.name).to_s,
-             o.path,
-             o.namespace.root? ? '' : o.namespace.path,
-             url_for(o)].join(",")
-          }.join("\n")
-        end
-
-        def serve_normal
-          options.update(
-            :visible_results => visible_results,
-            :query => query,
-            :results => results,
-            :template => :doc_server,
-            :type => :search
-          )
-          self.body = Templates::Engine.render(options)
-        end
-
-        def search_for_object
-          # rubocop:disable Style/MultilineBlockChain
-          self.results = run_verifier(Registry.all).select do |o|
-            o.path.downcase.include?(query.downcase)
-          end.reject do |o|
-            name = (o.type == :method ? o.name(true) : o.name).to_s.downcase
-            !name.include?(query.downcase) ||
-              case o.type
-              when :method
-                !(query =~ /[#.]/) && query.include?("::")
-              when :class, :module, :constant, :class_variable
-                query =~ /[#.]/
-              end
-          end.sort_by do |o|
-            name = (o.type == :method ? o.name(true) : o.name).to_s
-            name.length.to_f / query.length.to_f
-          end
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Server
+    module Commands
+      # Performs a search over the objects inside of a library and returns
+      # the results as HTML or plaintext
+      class SearchCommand < LibraryCommand
+        include Templates::Helpers::BaseHelper
+        include Templates::Helpers::ModuleHelper
+        include DocServerHelper
+
+        attr_accessor :results, :query
+
+        def run
+          Registry.load_all
+          self.query = request.query['q']
+          redirect(abs_url(adapter.router.docs_prefix, single_library ? library : '')) if query.nil? || query =~ /\A\s*\Z/
+
+          found = Registry.at(query)
+          redirect(url_for(found)) if found
+
+          search_for_object
+          request.xhr? ? serve_xhr : serve_normal
+        end
+
+        def visible_results
+          results[0, 10]
+        end
+
+        private
+
+        def url_for(object)
+          abs_url(base_path(router.docs_prefix),
+            serializer.serialized_path(object))
+        end
+
+        def serve_xhr
+          headers['Content-Type'] = 'text/plain'
+          self.body = visible_results.map {|o|
+            [(o.type == :method ? o.name(true) : o.name).to_s,
+             o.path,
+             o.namespace.root? ? '' : o.namespace.path,
+             url_for(o)].join(",")
+          }.join("\n")
+        end
+
+        def serve_normal
+          options.update(
+            :visible_results => visible_results,
+            :query => query,
+            :results => results,
+            :template => :doc_server,
+            :type => :search
+          )
+          self.body = Templates::Engine.render(options)
+        end
+
+        def search_for_object
+          # rubocop:disable Style/MultilineBlockChain
+          self.results = run_verifier(Registry.all).select do |o|
+            o.path.downcase.include?(query.downcase)
+          end.reject do |o|
+            name = (o.type == :method ? o.name(true) : o.name).to_s.downcase
+            !name.include?(query.downcase) ||
+              case o.type
+              when :method
+                !(query =~ /[#.]/) && query.include?("::")
+              when :class, :module, :constant, :class_variable
+                query =~ /[#.]/
+              end
+          end.sort_by do |o|
+            name = (o.type == :method ? o.name(true) : o.name).to_s
+            name.length.to_f / query.length.to_f
+          end
+        end
+      end
+    end
+  end
+end

data/lib/yard/server/commands/static_file_command.rb

@@ -1,23 +1,23 @@
-# frozen_string_literal: true
-module YARD
-  module Server
-    module Commands
-      # Serves static content when no other router matches a request
-      class StaticFileCommand < LibraryCommand
-        include StaticFileHelpers
-
-        DefaultMimeTypes['js'] = 'text/javascript'
-
-        # Defines the paths used to search for static assets. To define an
-        # extra path, use {YARD::Server.register_static_path} rather than
-        # modifying this constant directly. Also note that files in the
-        # document root will always take precedence over these paths.
-        STATIC_PATHS = []
-
-        def run
-          static_template_file? || not_found
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+module YARD
+  module Server
+    module Commands
+      # Serves static content when no other router matches a request
+      class StaticFileCommand < LibraryCommand
+        include StaticFileHelpers
+
+        DefaultMimeTypes['js'] = 'text/javascript'
+
+        # Defines the paths used to search for static assets. To define an
+        # extra path, use {YARD::Server.register_static_path} rather than
+        # modifying this constant directly. Also note that files in the
+        # document root will always take precedence over these paths.
+        STATIC_PATHS = []
+
+        def run
+          static_template_file? || not_found
+        end
+      end
+    end
+  end
+end

data/lib/yard/server/commands/static_file_helpers.rb

@@ -1,62 +1,61 @@
-# frozen_string_literal: true
-require 'webrick/httputils'
-
-module YARD
-  module Server
-    module Commands
-      # Include this module to get access to {#static_template_file?}
-      # and {favicon?} helpers.
-      module StaticFileHelpers
-        include WEBrick::HTTPUtils
-
-        # Serves an empty favicon.
-        # @raise [FinishRequest] finalizes an empty body if the path matches
-        #   /favicon.ico so browsers don't complain.
-        def favicon?
-          return unless request.path == '/favicon.ico'
-          headers['Content-Type'] = 'image/png'
-          self.status = 200
-          self.body = ''
-          raise FinishRequest
-        end
-
-        # Attempts to route a path to a static template file.
-        #
-        # @raise [FinishRequest] if a file was found and served
-        # @return [void]
-        def static_template_file?
-          # this const was defined in StaticFileCommand originally
-          default_mime_types = StaticFileCommand::DefaultMimeTypes
-
-          file = find_file(adapter, path)
-
-          if file
-            ext = "." + (path[/\.(\w+)$/, 1] || "html")
-            headers['Content-Type'] = mime_type(ext, default_mime_types)
-            self.body = File.read(file)
-            raise FinishRequest
-          end
-        end
-
-        module_function
-
-        def find_file(adapter, url)
-          # this const was defined in StaticFileCommand originally
-          static_paths = StaticFileCommand::STATIC_PATHS
-
-          file = nil
-          ([adapter.document_root] + static_paths.reverse).compact.each do |path_prefix|
-            file = File.join(path_prefix, url)
-            p file
-            break if File.exist?(file)
-            file = nil
-          end
-
-          # Search in default/fulldoc/html template if nothing in static asset paths
-          assets_template = Templates::Engine.template(:default, :fulldoc, :html)
-          file || assets_template.find_file(url)
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+require 'webrick/httputils'
+
+module YARD
+  module Server
+    module Commands
+      # Include this module to get access to {#static_template_file?}
+      # and {favicon?} helpers.
+      module StaticFileHelpers
+        include WEBrick::HTTPUtils
+
+        # Serves an empty favicon.
+        # @raise [FinishRequest] finalizes an empty body if the path matches
+        #   /favicon.ico so browsers don't complain.
+        def favicon?
+          return unless request.path == '/favicon.ico'
+          headers['Content-Type'] = 'image/png'
+          self.status = 200
+          self.body = ''
+          raise FinishRequest
+        end
+
+        # Attempts to route a path to a static template file.
+        #
+        # @raise [FinishRequest] if a file was found and served
+        # @return [void]
+        def static_template_file?
+          # this const was defined in StaticFileCommand originally
+          default_mime_types = StaticFileCommand::DefaultMimeTypes
+
+          file = find_file(adapter, path)
+
+          if file
+            ext = "." + (path[/\.(\w+)$/, 1] || "html")
+            headers['Content-Type'] = mime_type(ext, default_mime_types)
+            self.body = File.read(file)
+            raise FinishRequest
+          end
+        end
+
+        module_function
+
+        def find_file(adapter, url)
+          # this const was defined in StaticFileCommand originally
+          static_paths = StaticFileCommand::STATIC_PATHS
+
+          file = nil
+          ([adapter.document_root] + static_paths.reverse).compact.each do |path_prefix|
+            file = File.join(path_prefix, url)
+            break if File.exist?(file)
+            file = nil
+          end
+
+          # Search in default/fulldoc/html template if nothing in static asset paths
+          assets_template = Templates::Engine.template(:default, :fulldoc, :html)
+          file || assets_template.find_file(url)
+        end
+      end
+    end
+  end
+end