File ex_doc-0.7.1-git.patch of Package ex_doc

Overview Repositories Revisions Requests Users Attributes Meta

File ex_doc-0.7.1-git.patch of Package ex_doc (Revision dc3769337afbbb5e8c60d97817207ab6)

Currently displaying revision dc3769337afbbb5e8c60d97817207ab6 , Show latest

diff --git a/LICENSE b/LICENSE
index c60e749..02d3a9c 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,3 +1,4 @@
+ExDoc
 Copyright (c) 2012 Plataformatec
 
   Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,27 +14,80 @@ Copyright (c) 2012 Plataformatec
   limitations under the License.
 
 ==========================================================================
-CSS Templates
 
+CSS Template: lib/ex_doc/formatter/html/templates/css/style.css
 Copyright (c) 2007 Loren Segal
 
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file
+	Permission is hereby granted, free of charge, to any person
+	obtaining a copy of this software and associated documentation
+	files (the "Software"), to deal in the Software without
+	restriction, including without limitation the rights to use,
+	copy, modify, merge, publish, distribute, sublicense, and/or sell
+	copies of the Software, and to permit persons to whom the
+	Software is furnished to do so, subject to the following
+	conditions:
+
+	The above copyright notice and this permission notice shall be
+	included in all copies or substantial portions of the Software.
+
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+	OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+	HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+	WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+	OTHER DEALINGS IN THE SOFTWARE.
+
+==========================================================================
+
+highlight.js
+Copyright (c) 2006, Ivan Sagalaev
+
+  All rights reserved.
+  Redistribution and use in source and binary forms, with or without
+  modification, are permitted provided that the following conditions are met:
+
+      * Redistributions of source code must retain the above copyright
+        notice, this list of conditions and the following disclaimer.
+      * Redistributions in binary form must reproduce the above copyright
+        notice, this list of conditions and the following disclaimer in the
+        documentation and/or other materials provided with the distribution.
+      * Neither the name of highlight.js nor the names of its contributors 
+        may be used to endorse or promote products derived from this software 
+        without specific prior written permission.
+
+  THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+  EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+  DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+==========================================================================
+
+lib/ex_doc/formatter/html/templates/css/elixir.css 
+(c) Vasily Polovnyov <vast@whiteants.net>
+
+  Released under the same license as highlight.js
+
+==========================================================================
+
+jQuery JavaScript Library
+Copyright 2011, John Resig
+
+  Dual licensed under the MIT or GPL Version 2 licenses.
+  http://jquery.org/license
+
+
+Includes Sizzle.js
+Copyright 2011, The Dojo Foundation
+
+  Released under the MIT, BSD, and GPL Licenses.
+  https://github.com/jquery/sizzle/blob/master/LICENSE.txt
+
+==========================================================================
diff --git a/README.md b/README.md
index 7c39096..0b55989 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,7 @@ To use ExDoc in your Mix projects, first add ExDoc as a dependency:
 ```elixir
 def deps do
   [{:earmark, "~> 0.1", only: :dev},
-   {:ex_doc, "~> 0.6", only: :dev}]
+   {:ex_doc, "~> 0.7", only: :dev}]
 end
 ```
 
@@ -79,4 +79,4 @@ To see all options available when generating docs, just run `mix help docs`.
 
 ExDoc source code is released under Apache 2 License with snippets under MIT-LICENSE.
 
-Check LICENSE file for more information.
+Check [LICENSE](LICENSE) file for more information.
diff --git a/lib/ex_doc/formatter/html/autolink.ex b/lib/ex_doc/formatter/html/autolink.ex
index 24aa0a9..bc045fc 100644
--- a/lib/ex_doc/formatter/html/autolink.ex
+++ b/lib/ex_doc/formatter/html/autolink.ex
@@ -19,7 +19,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   end
 
   defp all_docs(module, modules) do
-    locals = Enum.map module.docs, &(&1.id)
+    locals = Enum.map module.docs, &(doc_prefix(&1) <> &1.id)
 
     if moduledoc = module.moduledoc do
       moduledoc = moduledoc |> local_doc(locals) |> project_doc(modules)
@@ -42,7 +42,6 @@ defmodule ExDoc.Formatter.HTML.Autolink do
     %{module | moduledoc: moduledoc, docs: docs, typespecs: typedocs}
   end
 
-
   defp all_typespecs(module, aliases) do
     locals = Enum.map module.typespecs, fn
       %ExDoc.TypeNode{name: name, arity: arity} -> { name, arity }
@@ -154,11 +153,17 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   Creates links to modules and functions defined in the project.
   """
   def project_doc(bin, modules) when is_binary(bin) do
-    project_funs = for m <- modules, d <- m.docs, do: m.id <> "." <> d.id
+    project_funs = for m <- modules, d <- m.docs, do: doc_prefix(d) <> m.id <> "." <> d.id
     project_modules = modules |> Enum.map(&module_to_string/1) |> Enum.uniq
-    bin |> project_functions(project_funs) |> project_modules(project_modules) |> erlang_functions
+    bin
+    |> project_functions(project_funs)
+    |> project_modules(project_modules)
+    |> erlang_functions
   end
 
+  defp doc_prefix(%{type: c}) when c in [:defcallback, :defmacrocallback], do: "c:"
+  defp doc_prefix(%{type: _}), do: ""
+
   @doc """
   Create links to functions defined in the project, specified in `project_funs`
   as a list of `Module.fun/arity` tuples.
@@ -169,15 +174,15 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   will get translated to the new href of the function.
   """
   def project_functions(bin, project_funs) when is_binary(bin) do
-    Regex.scan(~r{(?<!\[)`\s*((([A-Z][A-Za-z]+)\.)+([a-z_!\?>\|=&<!~+\.\+*^@-]+)/\d+)\s*`(?!\])}, bin)
+    Regex.scan(~r{(?<!\[)`\s*((c:)?(([A-Z][A-Za-z]+)\.)+([a-z_!\?>\|=&<!~+\.\+*^@-]+)/\d+)\s*`(?!\])}, bin)
     |> Enum.uniq
     |> List.flatten
     |> Enum.filter(&(&1 in project_funs))
     |> Enum.reduce(bin, fn (x, acc) ->
-         { mod_str, function_name, arity } = split_function(x)
+         { prefix, mod_str, function_name, arity } = split_function(x)
          escaped = Regex.escape(x)
          Regex.replace(~r/(?<!\[)`(\s*#{escaped}\s*)`(?!\])/, acc,
-           "[`\\1`](#{mod_str}.html##{function_name}/#{arity})")
+           "[`#{mod_str}.#{function_name}/#{arity}`](#{mod_str}.html##{prefix}#{function_name}/#{arity})")
        end)
   end
 
@@ -202,13 +207,18 @@ defmodule ExDoc.Formatter.HTML.Autolink do
        end)
   end
 
+  defp split_function("c:" <> bin) do
+    {"", mod, fun, arity} = split_function(bin)
+    {"c:", mod, fun, arity}
+  end
+
   defp split_function(bin) do
     [modules, arity] = String.split(bin, "/")
     { mod, name } = modules
       |> String.replace(~r{([^\.])\.}, "\\1 ") # this handles the case of the ".." function
       |> String.split(" ")
       |> Enum.split(-1)
-    { Enum.join(mod, "."), hd(name), arity }
+    { "", Enum.join(mod, "."), hd(name), arity }
   end
 
   @doc """
@@ -231,7 +241,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
     |> Enum.filter(&valid_erlang_beam?(&1, lib_dir))
     |> Enum.filter(&module_exports_function?/1)
     |> Enum.reduce(bin, fn (x, acc) ->
-         { mod_str, function_name, arity } = split_function(x)
+         { _, mod_str, function_name, arity } = split_function(x)
          escaped = Regex.escape(x)
          Regex.replace(~r/(?<!\[)`(\s*:#{escaped}\s*)`(?!\])/, acc,
            "[`\\1`](#{@erlang_docs}#{mod_str}.html##{function_name}-#{arity})")
@@ -239,7 +249,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   end
 
   defp valid_erlang_beam?(function_str, lib_dir) do
-    { mod_str, _function_name, _arity } = split_function(function_str)
+    { _, mod_str, _function_name, _arity } = split_function(function_str)
     '#{mod_str}.beam'
     |> :code.where_is_file
     |> on_lib_path?(lib_dir)
@@ -255,7 +265,7 @@ defmodule ExDoc.Formatter.HTML.Autolink do
   end
 
   defp module_exports_function?(function_str) do
-    { mod_str, function_name, arity_str } = split_function(function_str)
+    { _, mod_str, function_name, arity_str } = split_function(function_str)
     module = String.to_atom(mod_str)
     function_name = String.to_atom(function_name)
     {arity, _} = Integer.parse(arity_str)
diff --git a/lib/ex_doc/formatter/html/templates/css/elixir.css b/lib/ex_doc/formatter/html/templates/css/elixir.css
index 11142ea..fba639e 100644
--- a/lib/ex_doc/formatter/html/templates/css/elixir.css
+++ b/lib/ex_doc/formatter/html/templates/css/elixir.css
@@ -1,3 +1,7 @@
+/*
+github.com style (c) Vasily Polovnyov <vast@whiteants.net>
+*/
+
 .hljs {
   overflow-x: auto;
   color: #333;
diff --git a/lib/ex_doc/formatter/html/templates/index_template.eex b/lib/ex_doc/formatter/html/templates/index_template.eex
index 064468d..5459a2c 100644
--- a/lib/ex_doc/formatter/html/templates/index_template.eex
+++ b/lib/ex_doc/formatter/html/templates/index_template.eex
@@ -8,8 +8,8 @@
 		window.onload = function frame_redirect() {
 			if ( window.location.href.match(/\/#!/, window.location.hash)  ) {
 				document.querySelector('#main').src = window.location.href.replace(/\/#!/, '/');
-			} else if ( window.location.href.match(/\/<%= config.main %>.html#!/, window.location.hash)  ) {
-				document.querySelector('#main').src = window.location.href.replace(/\/<%= config.main %>.html#!/, '/');
+			} else if ( window.location.href.match(/\/index.html#!/, window.location.hash)  ) {
+				document.querySelector('#main').src = window.location.href.replace(/\/index.html#!/, '/');
 			}
 		}
 	</script>	
diff --git a/lib/ex_doc/formatter/html/templates/js/full_list.js b/lib/ex_doc/formatter/html/templates/js/full_list.js
index b48afb3..678c934 100644
--- a/lib/ex_doc/formatter/html/templates/js/full_list.js
+++ b/lib/ex_doc/formatter/html/templates/js/full_list.js
@@ -31,7 +31,7 @@ function fullListSearch() {
   });
 
   //$('#search input').keyup(function(evnt) {
-  $('#search input').bind("keyup search reset", function(evnt) {
+  $('#search input').bind("keyup search reset change propertychange input paste", function(evnt) {
     if ((evnt.keyCode > ignoreKeyCodeMin && evnt.keyCode < ignoreKeyCodeMax)
          || evnt.keyCode == commandKey) {
       return;
diff --git a/lib/ex_doc/retriever.ex b/lib/ex_doc/retriever.ex
index 2a7bebd..495c365 100644
--- a/lib/ex_doc/retriever.ex
+++ b/lib/ex_doc/retriever.ex
@@ -90,10 +90,10 @@ defmodule ExDoc.Retriever do
     source_path = source_path(module, config)
 
     specs = Enum.into(Kernel.Typespec.beam_specs(module) || [], %{})
-    callbacks = callbacks_implemented_by(module)
+    impls = callbacks_implemented_by(module)
 
     docs = Enum.filter_map Code.get_docs(module, :docs), &has_doc?(&1, type),
-                           &get_function(&1, source_path, source_url, specs, callbacks)
+                           &get_function(&1, source_path, source_url, specs, impls)
 
     if type == :behaviour do
       callbacks = Enum.into(Kernel.Typespec.beam_callbacks(module) || [], %{})
@@ -145,7 +145,7 @@ defmodule ExDoc.Retriever do
 
     doc =
       if is_nil(doc) && behaviour do
-        "Callback implementation of `#{inspect behaviour}.#{name}/#{arity}`."
+        "Callback implementation for `c:#{inspect behaviour}.#{name}/#{arity}`."
       else
         doc
       end
@@ -167,7 +167,7 @@ defmodule ExDoc.Retriever do
   end
 
   defp get_callback(callback, source_path, source_url, callbacks) do
-    { { name, arity }, line, _kind, doc } = callback
+    { { name, arity }, line, kind, doc } = callback
 
     specs = Dict.get(callbacks, { name, arity }, [])
             |> Enum.map(&Kernel.Typespec.spec_to_ast(name, &1))
@@ -180,7 +180,7 @@ defmodule ExDoc.Retriever do
       signature: "#{name}/#{arity}",
       specs: specs,
       source: source_link(source_path, source_url, line),
-      type: :defcallback
+      type: :"#{kind}callback"
     }
   end
 
diff --git a/test/ex_doc/formatter/html/autolink_test.exs b/test/ex_doc/formatter/html/autolink_test.exs
index 97a6188..5bf49d2 100644
--- a/test/ex_doc/formatter/html/autolink_test.exs
+++ b/test/ex_doc/formatter/html/autolink_test.exs
@@ -47,7 +47,7 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
     assert Autolink.project_functions("`Mod.example/2` then `Mod.example/2`",
       ["Mod.example/2"]) == "[`Mod.example/2`](Mod.html#example/2) then [`Mod.example/2`](Mod.html#example/2)"
     assert Autolink.project_functions("`  MyModule.spaces/0  `", ["MyModule.spaces/0"]) ==
-      "[`  MyModule.spaces/0  `](MyModule.html#spaces/0)"
+      "[`MyModule.spaces/0`](MyModule.html#spaces/0)"
     assert Autolink.project_functions("`ModA.example/1` and `ModB.example/2`",
       ["ModA.example/1", "ModB.example/2"]) ==
       "[`ModA.example/1`](ModA.html#example/1) and [`ModB.example/2`](ModB.html#example/2)"
@@ -56,13 +56,18 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
       "[`Mod.funny_name\?/1`](Mod.html#funny_name\?/1) and [`Mod.funny_name!/2`](Mod.html#funny_name!/2)"
   end
 
-  test "autolink creates links for Module special forms" do
+  test "autolink creates links for modules special forms" do
     assert Autolink.project_functions("`Mod.++/2`", ["Mod.++/2"]) === "[`Mod.++/2`](Mod.html#++/2)"
     assert Autolink.project_functions("`Mod.!/1`", ["Mod.!/1"]) === "[`Mod.!/1`](Mod.html#!/1)"
     assert Autolink.project_functions("`Mod.../2`", ["Mod.../2"]) === "[`Mod.../2`](Mod.html#../2)"
     assert Autolink.project_functions("`Mod.--/2`", ["Mod.--/2"]) === "[`Mod.--/2`](Mod.html#--/2)"
   end
 
+  test "autolink creates links for callbacks" do
+    assert Autolink.project_functions("`c:Mod.++/2`", ["c:Mod.++/2"]) ===
+           "[`Mod.++/2`](Mod.html#c:++/2)"
+  end
+
   test "autolink doesn't create links for undefined Mod.functions in docs" do
     assert Autolink.project_functions("`Mod.example/1`", ["Mod.example/2"]) == "`Mod.example/1`"
     assert Autolink.project_functions("`Mod.example/1`", []) == "`Mod.example/1`"
@@ -73,14 +78,14 @@ defmodule ExDoc.Formatter.HTML.AutolinkTest do
     assert Autolink.project_functions("[the `Mod.example/1`]()", ["Mod.example/1"]) == "[the `Mod.example/1`]()"
   end
 
-  test "autolink Modules in docs" do
+  test "autolink modules in docs" do
     assert Autolink.project_modules("`MyModule`", ["MyModule"]) == "[`MyModule`](MyModule.html)"
     assert Autolink.project_modules("`MyModule.Nested`", ["MyModule.Nested"]) == "[`MyModule.Nested`](MyModule.Nested.html)"
     assert Autolink.project_modules("`MyModule.Nested.Deep`", ["MyModule.Nested.Deep"]) ==
       "[`MyModule.Nested.Deep`](MyModule.Nested.Deep.html)"
   end
 
-  test "autolink Modules doesn't link functions" do
+  test "autolink modules doesn't link functions" do
     assert Autolink.project_modules("`Mod.example/1`", ["Mod"]) == "`Mod.example/1`"
   end
 
diff --git a/test/ex_doc/retriever_test.exs b/test/ex_doc/retriever_test.exs
index 7829a47..b3dc800 100644
--- a/test/ex_doc/retriever_test.exs
+++ b/test/ex_doc/retriever_test.exs
@@ -135,9 +135,9 @@ defmodule ExDoc.RetrieverTest do
     docs = node.docs
     assert Enum.map(docs, &(&1.id)) == ["bye/1", "hello/1"]
     assert Enum.at(docs, 0).doc ==
-      "A doc for this so it doesn't use 'Callback implementation of'"
+      "A doc for this so it doesn't use 'Callback implementation for'"
     assert Enum.at(docs, 1).doc ==
-      "Callback implementation of `CustomBehaviour.hello/1`."
+      "Callback implementation for `c:CustomBehaviour.hello/1`."
   end
 
   ## PROTOCOLS
diff --git a/test/fixtures/behaviour.ex b/test/fixtures/behaviour.ex
index 6fcb62c..e489718 100644
--- a/test/fixtures/behaviour.ex
+++ b/test/fixtures/behaviour.ex
@@ -22,6 +22,6 @@ defmodule CustomBehaviourImpl do
 
   def hello(i), do: i
 
-  @doc "A doc for this so it doesn't use 'Callback implementation of'"
+  @doc "A doc for this so it doesn't use 'Callback implementation for'"
   def bye(i), do: i
 end

Places

File ex_doc-0.7.1-git.patch of Package ex_doc (Revision dc3769337afbbb5e8c60d97817207ab6)

Places