jekyll-feed 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f496b14be99f01195b0596a64372301542de848c
-  data.tar.gz: 26508eb2dc912d6f367cf2bb7f3ab2296fd45056
+  metadata.gz: 58166be831e447c07a57150717670f140681c3c7
+  data.tar.gz: 8ab3a70938b5752de7bb755891228fcfe9e997c9
 SHA512:
-  metadata.gz: c42e8457ed717e819805c5a2c51511cbfdf036e67d77f92624c3f124d0fe0c701afa7f8ea1e6c7be8996ea59633542999466815e5dfb5d0bac90b53215ff5dad
-  data.tar.gz: da425d708cdeb818e099901dee7e8f54af74a53de02c6a05a45ed39ddec44436bd36ad34b8054ee6488844fcefada623b77380f5a42ea59fce64775342545e66
+  metadata.gz: 793aed59df2ec15981b5a20c378957ecd756ade0d76725243bf06f8071f4c870c6c432c87e02a226b78bf3a5be185cbab26f3c61ec937e398fb87d7b10e01d7c
+  data.tar.gz: fed263171fb20cc8f7015bb00d15778de921556e1c5e38ed4155aa0579d86b5f5789e3d33a84350e193e7915760c6978c6f97dc342c2d9a70acc2a7cf9dfe18b

data/.gitignore

@@ -1,3 +1,4 @@
+/vendor
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -16,3 +17,4 @@ mkmf.log
 Gemfile.lock
 spec/dest
 .bundle
+spec/fixtures/.jekyll-metadata

data/.travis.yml

@@ -1,9 +1,25 @@
 language: ruby
 rvm:
 - 2.1
-- 2.0.0
-- 1.9.3
-before_script: bundle update
+- 2.2
+- 2.0
+- 1.9
 script: "script/cibuild"
-sudo: false
+before_script: bundle update
 cache: bundler
+sudo: false
+
+matrix:
+  exclude:
+    - rvm: 1.9
+      env: JEKYLL_VERSION=3.0.0.beta5
+    - env: JEKYLL_VERSION=2.4
+      rvm: 2.1
+    - rvm: 2.2
+      env: JEKYLL_VERSION=2.4
+
+env:
+  matrix:
+    - ""
+    - JEKYLL_VERSION=2.4
+    - JEKYLL_VERSION=3.0.0.beta5

data/Gemfile

@@ -1,3 +1,6 @@
 source 'https://rubygems.org'
-
 gemspec
+
+if ENV["JEKYLL_VERSION"]
+  gem "jekyll", "~> #{ENV["JEKYLL_VERSION"]}"
+end

data/README.md

@@ -35,6 +35,16 @@ The plugin will automatically use any of the following configuration variables,
   - `email` - Email address of the author
   - `uri` - Webpage where more information about the author can be found
 
+### Already have a feed path?
+
+Do you already have an existing feed someplace other than `/feed.xml`, but are on a host like GitHub Pages that doesn't support machine-friendly redirects? If you simply swap out `jekyll-feed` for your existing template, your existing subscribers won't continue to get updates. Instead, you can specify a non-default path via your site's config.
+
+```yml
+feed:
+  path: atom.xml
+```
+
+To note, you shouldn't have to do this unless you already have a feed you're using, and you can't or wish not to redirect existing subscribers.
 
 ### Optional front matter
 

data/jekyll-feed.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-feed"
-  spec.version       = "0.2.3"
+  spec.version       = "0.3.0"
   spec.authors       = ["Ben Balter"]
   spec.email         = ["ben.balter@github.com"]
   spec.summary       = "A Jekyll plugin to generate an Atom feed of your Jekyll posts"
@@ -14,12 +14,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "jekyll", "~> 2.0"
+  spec.add_development_dependency "jekyll", ">= 2.4.0", "< 3.1.0"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "typhoeus", "~> 0.7"
   spec.add_development_dependency "nokogiri", "~> 1.6"
   spec.add_development_dependency "jekyll-last-modified-at", "0.3.4"
-
 end

data/lib/jekyll-feed.rb

@@ -12,6 +12,14 @@ module Jekyll
       @context.registers[:site].config
     end
 
+    def path
+      if config["feed"] && config["feed"]["path"]
+        config["feed"]["path"]
+      else
+        "feed.xml"
+      end
+    end
+
     def url
       if config["url"]
         config["url"]
@@ -22,7 +30,7 @@ module Jekyll
 
     def render(context)
       @context = context
-      "<link type=\"application/atom+xml\" rel=\"alternate\" href=\"#{url}/feed.xml\" title=\"#{config["name"]}\" />"
+      "<link type=\"application/atom+xml\" rel=\"alternate\" href=\"#{url}/#{path}\" title=\"#{config["name"]}\" />"
     end
   end
 
@@ -30,14 +38,23 @@ module Jekyll
     safe true
     priority :lowest
 
+    # Path to feed from config, or feed.xml for default
+    def path
+      if @site.config["feed"] && @site.config["feed"]["path"]
+        @site.config["feed"]["path"]
+      else
+        "feed.xml"
+      end
+    end
+
     # Main plugin action, called by Jekyll-core
     def generate(site)
       @site = site
-      @site.config["time"]         = Time.new
+      @site.config["time"] = Time.new
       unless feed_exists?
         write
         @site.keep_files ||= []
-        @site.keep_files << "feed.xml"
+        @site.keep_files << path
       end
     end
 
@@ -49,9 +66,9 @@ module Jekyll
     # Destination for feed.xml file within the site source directory
     def destination_path
       if @site.respond_to?(:in_dest_dir)
-        @site.in_dest_dir("feed.xml")
+        @site.in_dest_dir(path)
       else
-        Jekyll.sanitized_path(@site.dest, "feed.xml")
+        Jekyll.sanitized_path(@site.dest, path)
       end
     end
 
@@ -62,7 +79,7 @@ module Jekyll
     end
 
     def feed_content
-      site_map = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", "feed.xml")
+      site_map = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", path)
       site_map.content = File.read(source_path).gsub(/\s*\n\s*/, "\n").gsub(/\n{%/, "{%")
       site_map.data["layout"] = nil
       site_map.render(Hash.new, @site.site_payload)
@@ -72,9 +89,9 @@ module Jekyll
     # Checks if a feed already exists in the site source
     def feed_exists?
       if @site.respond_to?(:in_source_dir)
-        File.exists? @site.in_source_dir("feed.xml")
+        File.exists? @site.in_source_dir(path)
       else
-        File.exists? Jekyll.sanitized_path(@site.source, "feed.xml")
+        File.exists? Jekyll.sanitized_path(@site.source, path)
       end
     end
   end

data/spec/jekyll-feed_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe(Jekyll::JekyllFeed) do
   let(:overrides) do
     {
+      "full_rebuild" => true,
       "source"      => source_dir,
       "destination" => dest_dir,
       "url"         => "http://example.org",
@@ -30,7 +31,7 @@ describe(Jekyll::JekyllFeed) do
   end
 
   it "creates a feed.xml file" do
-    expect(File.exist?(dest_dir("feed.xml"))).to be_truthy
+    expect(Pathname.new(dest_dir("feed.xml"))).to exist
   end
 
   it "doesn't have multiple new lines or trailing whitespace" do
@@ -145,4 +146,20 @@ describe(Jekyll::JekyllFeed) do
       expect(index).to include(expected)
     end
   end
+
+  context "changing the feed path" do
+    let(:config) do
+      Jekyll.configuration(Jekyll::Utils.deep_merge_hashes(overrides, {"feed" => {"path" => "atom.xml"}}))
+    end
+    
+    it "should write to atom.xml" do
+      expect(Pathname.new(dest_dir("atom.xml"))).to exist
+    end
+
+    it "renders the feed meta with custom feed path" do
+      index = File.read(dest_dir("index.html"))
+      expected = '<link type="application/atom+xml" rel="alternate" href="http://example.org/atom.xml" title="My awesome site" />'
+      expect(index).to include(expected)
+    end
+  end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement