lanyon 0.3.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6cb7a805a0eb3c37772d55e691f36ac3e1c2ab6
-  data.tar.gz: 3269b6445233679a7aa0f5cdf120950e8674bb78
+  metadata.gz: aefd2bc5a51fecb9a125d2d0fda7727c396bd5f6
+  data.tar.gz: 6a992436a95497be137628d08f07457a2b0c30ad
 SHA512:
-  metadata.gz: ec3bc073134f90350a6b8129c811fae79c6f4284b95c830ee01662e2480f3fbf97eea1e75e232ef5e3a97a83f8a9b8e5fb65d0c94d4988b4b2906c804739fdb4
-  data.tar.gz: 573de99ab0c5d7255dbdde58464797a64f7c2f9f3c54b7bd3e0874b007ea115d6e3cd594e03ff26d534d76a96a54ba6224fdd3b22e584417dd53553dc37ad1af
+  metadata.gz: bdcfb2568a03f545a0044e3ad2acd197e591d77dec45df66a95e4f7afa597c2860e2f1c2599f879b6afbe21734dce572667d1712c53e0e28253a4487fc3f235c
+  data.tar.gz: 5670446e50079db5aac69946e5b3615ac3834705afe993506a35d63a69cf2b6d59edb9dd0f53a0d8afb38192fac82d2b1a59beb8180ff6074b0655036cef4012

data/History.md

@@ -1,6 +1,10 @@
 Release History
 ===============
 
+## 0.4.0
+
+* Support .html extension stripping
+
 ## 0.3.4
 
 * Allow Rack 2

data/README.md

@@ -83,6 +83,20 @@ This can also be a file generated by Jekyll from e.g. Markdown sources.
 
 - Gem dependencies (runtime): `jekyll`, `rack`
 
+## How URLs are resolved
+
+Lanyon maps URLs to corresponding files as follows:
+
+ 1. a `path/` with a trailing slash is changed to `path/index.html`,
+ 2. then, Lanyon checks for an exactly corresponding file,
+ 3. when `path` does not exist but `path/index.html` does,
+    the response will be a redirect to `path/`,
+ 4. when neither 2. nor 3. apply, +path.html+ is tried.
+
+To avoid confusion, it's probably a good idea to have only one
+of `resource`, `resource/index.html`, and `resource.html` present
+as file in your site.
+
 ## Reporting Bugs
 
 Report bugs on the Lanyon home page: <https://github.com/stomar/lanyon/>

data/lib/lanyon/router.rb

@@ -16,9 +16,17 @@ module Lanyon
     # Returns the full file system path of the file corresponding to
     # the given URL +path+, or
     #
-    # - +:not_found+ if no corresponding file exists,
-    # - +:must_redirect+ if the request must be redirected to <tt>path/</tt>.
+    # - +:must_redirect+ if the request must be redirected to +path/+,
+    # - +:not_found+ if no corresponding file exists.
     #
+    # The return value is found as follows:
+    #
+    # 1. a +path/+ with a trailing slash is changed to +path/index.html+,
+    # 2. then, the method checks for an exactly corresponding file,
+    # 3. when +path+ does not exist but +path/index.html+ does,
+    #    a redirect will be indicated,
+    # 4. finally, when no exactly corresponding file or redirect
+    #    can be found, +path.html+ is tried.
     def endpoint(path)
       normalized = normalize_path_info(path)
 
@@ -27,6 +35,8 @@ module Lanyon
                    fullpath
                  elsif needs_redirect_to_dir?(fullpath)
                    :must_redirect
+                 elsif FileTest.file?(fullpath_html = "#{fullpath}.html")
+                   fullpath_html
                  else
                    :not_found
                  end

data/lib/lanyon/version.rb

@@ -1,4 +1,4 @@
 module Lanyon
-  VERSION  = "0.3.4"
-  DATE     = "2016-08-01"
+  VERSION  = "0.4.0"
+  DATE     = "2016-09-01"
 end

data/test/test_router.rb

@@ -17,6 +17,10 @@ describe Lanyon::Router do
       dir-with-index/index.html
       dir-without-index/page.html
       dir1/dir2/dir3/index.html
+      foo
+      foo.html
+      bar.html
+      bar/index.html
     ]
 
     files.each do |path|
@@ -79,6 +83,40 @@ describe Lanyon::Router do
   end
 
 
+  describe "when automatically adding .html extension" do
+
+    it "returns existing path" do
+      filename = File.join(@sitedir, "page.html")
+      @router.endpoint("/page").must_equal filename
+    end
+
+    describe "when both `foo' and `foo.html' exist" do
+
+      it "returns `foo' and not `foo.html' when asked for `foo'" do
+        filename = File.join(@sitedir, "foo")
+        @router.endpoint("/foo").must_equal filename
+      end
+
+      it "can also serve `foo.html'" do
+        filename = File.join(@sitedir, "foo.html")
+        @router.endpoint("/foo.html").must_equal filename
+      end
+    end
+
+    describe "when both `bar.html' and `bar/index.html' exist" do
+
+      it "returns :must_redirect and not `bar.html' when asked for `bar'" do
+        @router.endpoint("/bar").must_equal :must_redirect
+      end
+
+      it "can also serve `bar.html'" do
+        filename = File.join(@sitedir, "bar.html")
+        @router.endpoint("/bar.html").must_equal filename
+      end
+    end
+  end
+
+
   describe "when asked for paths with directory traversal" do
 
     it "discards leading '..' for existing path" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lanyon
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
 platform: ruby
 authors:
 - Marcus Stollsteimer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2016-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll