Make :skip_links option apply to pages instead of individual links

Thibaut committed 12 years ago

Commit 47eb7ee1 parent 6c8eea17 files · +59 −43Browse files

Unified · Split

7 files

lib/docs/filters/core/internal_urls.rb +5 −5
lib/docs/scrapers/backbone.rb +1 −1
lib/docs/scrapers/coffeescript.rb +1 −1
lib/docs/scrapers/less.rb +1 −1
lib/docs/scrapers/lodash.rb +1 −1
lib/docs/scrapers/underscore.rb +1 −1
test/lib/docs/filters/core/internal_urls_test.rb +49 −33

lib/docs/filters/core/internal_urls.rb+5−5

 module Docs
   class InternalUrlsFilter < Filter
     def call
+      return doc if skip_links?
       internal_urls = Set.new if follow_links?
       css('a').each do |link|
-        next if skip_link?(link)
         next unless url = parse_href(link['href'])
         next unless subpath = subpath_to(url)
       doc
     end
-    def follow_links?
+    def skip_links?
-      !(context[:follow_links] && context[:follow_links].call(self) == false)
+      context[:skip_links] && context[:skip_links].call(self)
     end
-    def skip_link?(link)
+    def follow_links?
-      context[:skip_links] && context[:skip_links].call(link)
+      !(context[:follow_links] && context[:follow_links].call(self) == false)
     end
     def parse_href(str)

lib/docs/scrapers/backbone.rb+1−1

@@ -10,7 +10,7 @@ module Docs · 9 unmodified lines
10		10
11	options[:title] = 'Backbone.js'	11	options[:title] = 'Backbone.js'
12	options[:container] = '.container'	12	options[:container] = '.container'
13	options[:skip_links] = -> (_) { true }	13	options[:skip_links] = ->(filter) { true }
14		14
15	options[:attribution] = <<-HTML	15	options[:attribution] = <<-HTML
16	© 2010–2013 Jeremy Ashkenas, DocumentCloud<br>	16	© 2010–2013 Jeremy Ashkenas, DocumentCloud<br>

lib/docs/scrapers/coffeescript.rb+1−1

@@ -9,7 +9,7 @@ module Docs · 8 unmodified lines
9		9
10	options[:title] = 'CoffeeScript'	10	options[:title] = 'CoffeeScript'
11	options[:container] = '.container'	11	options[:container] = '.container'
12	options[:skip_links] = -> (_) { true }	12	options[:skip_links] = ->(filter) { true }
13		13
14	options[:attribution] = <<-HTML	14	options[:attribution] = <<-HTML
15	© 2009–2013 Jeremy Ashkenas<br>	15	© 2009–2013 Jeremy Ashkenas<br>

lib/docs/scrapers/less.rb+1−1

@@ -8,7 +8,7 @@ module Docs · 7 unmodified lines
8		8
9	options[:title] = 'LESS'	9	options[:title] = 'LESS'
10	options[:container] = 'section'	10	options[:container] = 'section'
11	options[:skip_links] = -> (_) { true }	11	options[:skip_links] = ->(filter) { true }
12		12
13	options[:attribution] = <<-HTML	13	options[:attribution] = <<-HTML
14	© 2009–2013 Alexis Sellier & The Core Less Team<br>	14	© 2009–2013 Alexis Sellier & The Core Less Team<br>

lib/docs/scrapers/lodash.rb+1−1

@@ -10,7 +10,7 @@ module Docs · 9 unmodified lines
10		10
11	options[:title] = 'Lo-Dash'	11	options[:title] = 'Lo-Dash'
12	options[:container] = 'h1+div+div'	12	options[:container] = 'h1+div+div'
13	options[:skip_links] = -> (_) { true }	13	options[:skip_links] = ->(filter) { true }
14		14
15	options[:attribution] = <<-HTML	15	options[:attribution] = <<-HTML
16	© 2012–2013 The Dojo Foundation<br>	16	© 2012–2013 The Dojo Foundation<br>

lib/docs/scrapers/underscore.rb+1−1

@@ -10,7 +10,7 @@ module Docs · 9 unmodified lines
10		10
11	options[:title] = 'Underscore.js'	11	options[:title] = 'Underscore.js'
12	options[:container] = '#documentation'	12	options[:container] = '#documentation'
13	options[:skip_links] = -> (_) { true }	13	options[:skip_links] = ->(filter) { true }
14		14
15	options[:attribution] = <<-HTML	15	options[:attribution] = <<-HTML
16	© 2009–2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors<br>	16	© 2009–2013 Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors<br>

test/lib/docs/filters/core/internal_urls_test.rb+49−33

   include FilterTestHelper
   self.filter_class = Docs::InternalUrlsFilter
-  describe ":internal_urls" do
+  before do
-    before do
+    context[:base_url] = context[:root_url] = context[:url] = 'http://example.com/dir'
-      context[:base_url] = context[:root_url] = 'http://example.com/dir'
+  end
-      context[:url] = 'http://example.com/dir'
-    end
-    let :internal_urls do
+  let :internal_urls do
-      filter_result[:internal_urls]
+    filter_result[:internal_urls]
-    end
+  end
+  describe ":internal_urls" do
     it "is an array" do
       assert_instance_of Array, internal_urls
     end
       end
     end
-    context "when context[:skip_links] is a block" do
-      let :block do
-        context[:skip_links] = Proc.new {}
-      end
-      it "passes all links to the block" do
-        @body = link_to 'http://example.com'
-        context[:skip_links] = ->(arg) { @arg = arg }
-        internal_urls
-        assert_equal @body, @arg.to_s
-      end
-      it "doesn't include urls from links where the block returns true" do
-        @body = link_to 'http://example.com/dir/path'
-        context[:skip_links] = ->(_) { true }
-        assert_empty internal_urls
-      end
-      it "includes urls from links where the block returns false" do
-        @body = link_to 'http://example.com/dir/path'
-        context[:skip_links] = ->(_) { false }
-        assert_equal 1, internal_urls.length
-      end
-    end
     context "when context[:follow_links] is a block" do
       before do
         @body = link_to context[:url]
       end
     end
   end
+  context "context[:skip_links]" do
+    before do
+      @body = link_to context[:url]
+    end
+    context "when it is a block" do
+      it "calls the block with the filter instance" do
+        context[:skip_links] = ->(arg) { @arg = arg; nil }
+        filter.call
+        assert_equal filter, @arg
+      end
+      context "and the block returns true" do
+        before do
+          context[:skip_links] = ->(_) { true }
+        end
+        it "doesn't set :internal_urls" do
+          refute internal_urls
+        end
+        it "doesn't replace urls" do
+          assert_equal @body, filter_output_string
+        end
+      end
+      context "and the block returns false" do
+        before do
+          context[:skip_links] = ->(_) { false }
+        end
+        it "set :internal_urls" do
+          assert internal_urls
+        end
+        it "replaces urls" do
+          refute_equal @body, filter_output_string
+        end
+      end
+    end
+  end
 end