jekyll-feed 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fff077f51b1b4b3b1e983bf5c211944916274d26
-  data.tar.gz: f260cd7fbca8361948de81c0724147a846843d8f
+SHA256:
+  metadata.gz: fc06c19cf7a822a53cc32bbf9cce036aeca5bf709a111830442897033811850d
+  data.tar.gz: c4729a2bfe3abb4490f32dcc04c6080259d3189c060f35af06242f5fa995ef7b
 SHA512:
-  metadata.gz: 44ba9ce96ae0d11b7fe7d65c15100d2bb0eab713c9f0a0d6519068771ba063d733078870445000eb80700e68bf9cd0b4ee1cb01f0d6fd11417914a0555c9d686
-  data.tar.gz: '0491a6e21f94f30906678bde1449c8a63a961499c78f01311555687eebd25f1232c494e0500c71ac51c0d848e6d7c8d259efb7feb22af9fce80c15863138ab78'
+  metadata.gz: 844acc55c1bc3d14bc9fe1f061acc6ed8be1f425dcb86eaa1a51de6ccbb590f4424a77203a0f6faf6791f9a6302fbcbd213f297768835fa6ae4323a873feb63b
+  data.tar.gz: 944201044de4e0efdcc0ac5fe5a8cb122a15f72c2b3526e757ce1f1a15c8771676978e506a1d7d2d1792a748ef73340c2602e41fdeef9f3f371cff7dbe485e91

data/.rubocop.yml

@@ -2,7 +2,7 @@ inherit_gem:
   jekyll: .rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 2.0
+  TargetRubyVersion: 2.3
   Include:
     - lib/*.rb
 

data/.travis.yml

@@ -1,13 +1,18 @@
 language: ruby
+cache: bundler
+sudo: false
 rvm:
+- 2.5
+- 2.4
+- 2.3
 - 2.2
 env:
   global:
   - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
-cache: bundler
-sudo: false
+before_install:
+- gem update --system
 before_script: bundle update
-script: "./script/cibuild"
+script: script/cibuild
 notifications:
   email: false
 deploy:

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
+
+source "https://rubygems.org"
 gemspec
 
 if ENV["JEKYLL_VERSION"]

data/History.markdown

@@ -1,13 +1,29 @@
-## HEAD
+## 0.9.3 / 2018-02-04
+
+  * Define path with __dir (#187)
+  * Bump Ruby for Travis (#188)
 
 ### Documentation
 
-  * Use `https` in more places. (#165)
+  * Fix: Add note about using plugins instead of gems key (#197)
+  * Add documentation for disabling smartify filter (#205)
+
+### Development Fixes
+
+  * Rubocop: Target Ruby 2.2 (#195)
+  * Test feeds that have a `site.lang` (#164)
+  * Test against Ruby 2.5 (#201)
+
+## 0.9.3 / 2017-03-28
 
 ### Minor Enhancements
 
   * fix <entry> template for posts with post.lang defined (#168)
 
+### Documentation
+
+  * Use `https` in more places. (#165)
+
 ## 0.9.1 / 2017-02-17
 
 ### Minor Enhancements

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Ben Balter
+Copyright (c) 2015-present Ben Balter and jekyll-feed contributors
 
 MIT License
 

data/README.md

@@ -15,10 +15,12 @@ gem 'jekyll-feed'
 And then add this line to your site's `_config.yml`:
 
 ```yml
-gems:
+plugins:
   - jekyll-feed
 ```
 
+:warning: If you are using Jekyll < 3.5.0 use the `gems` key instead of `plugins`.
+
 ## Usage
 
 The plugin will automatically generate an Atom feed at `/feed.xml`.
@@ -122,6 +124,14 @@ The plugin exposes a helper tag to expose the appropriate meta tags to support a
 
 The plugin uses [Jekyll's `smartify` filter](https://jekyllrb.com/docs/templates/) for processing the site title and post titles. This will translate plain ASCII punctuation into "smart" typographic punctuation. This will not render or strip any Markdown you may be using in a title.
 
+Jekyll's `smartify` filter uses [kramdown](https://kramdown.gettalong.org/options.html) as a processor.  Accordingly, if you do not want "smart" typographic punctuation, disabling them in kramdown in your `_config.yml` will disable them in your feed. For example:
+
+   ```yml
+   kramdown:
+     smart_quotes:               apos,apos,quot,quot
+     typographic_symbols:        {hellip: ...}
+   ```
+
 ### Custom styling
 
 Want to style what your feed looks like in the browser? Simply add an XSLT at `/feed.xslt.xml` and Jekyll Feed will link to the stylesheet.

data/Rakefile

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 

data/jekyll-feed.gemspec

@@ -1,8 +1,12 @@
-# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jekyll-feed/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "jekyll-feed"
-  spec.version       = "0.9.2"
+  spec.version       = Jekyll::Feed::VERSION
   spec.authors       = ["Ben Balter"]
   spec.email         = ["ben.balter@github.com"]
   spec.summary       = "A Jekyll plugin to generate an Atom feed of your Jekyll posts"
@@ -10,16 +14,16 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r!^bin/!) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r!^(test|spec|features)/!)
   spec.require_paths = ["lib"]
 
   spec.add_dependency "jekyll", "~> 3.3"
 
-  spec.add_development_dependency "bundler", "~> 1.6"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "nokogiri", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop", "0.51"
   spec.add_development_dependency "typhoeus", "~> 0.7"
-  spec.add_development_dependency "nokogiri", "~> 1.6"
-  spec.add_development_dependency "rubocop"
 end

data/lib/jekyll-feed.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "jekyll"
 require "fileutils"
 require "jekyll-feed/generator"

data/lib/jekyll-feed/generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllFeed
   class Generator < Jekyll::Generator
     safe true
@@ -29,7 +31,7 @@ module JekyllFeed
 
     # Path to feed.xml template file
     def feed_source_path
-      File.expand_path "./feed.xml", File.dirname(__FILE__)
+      File.expand_path "feed.xml", __dir__
     end
 
     # Checks if a file already exists in the site source
@@ -43,7 +45,7 @@ module JekyllFeed
 
     # Generates contents for a file
     def content_for_file(file_path, file_source_path)
-      file = PageWithoutAFile.new(@site, File.dirname(__FILE__), "", file_path)
+      file = PageWithoutAFile.new(@site, __dir__, "", file_path)
       file.content = File.read(file_source_path).gsub(MINIFY_REGEX, "")
       file.data["layout"] = nil
       file.data["sitemap"] = false

data/lib/jekyll-feed/meta-tag.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllFeed
   class MetaTag < Liquid::Tag
     # Use Jekyll's native relative_url filter

data/lib/jekyll-feed/page-without-a-file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module JekyllFeed
   class PageWithoutAFile < Jekyll::Page
     def read_yaml(*)

data/lib/jekyll-feed/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Feed
+    VERSION = "0.9.3"
+  end
+end

data/script/cibuild

@@ -2,6 +2,6 @@
 
 set -e
 
-bundle exec rspec
-bundle exec rubocop -S -D
+script/test
+script/fmt
 bundle exec rake build

data/script/fmt

@@ -0,0 +1,10 @@
+#!/bin/bash
+set -e
+
+echo "Rubocop $(bundle exec rubocop --version)"
+bundle exec rubocop -D -E $@
+success=$?
+if ((success != 0)); then
+   echo -e "\nTry running \`script/fmt -a\` to automatically fix errors"
+fi
+exit $success

data/script/test

@@ -0,0 +1,4 @@
+#!/bin/bash
+set -ex
+
+bundle exec rspec "$@"

data/spec/jekyll-feed_spec.rb

@@ -104,6 +104,8 @@ describe(JekyllFeed) do
       expect(feed.feed_type).to eql("atom")
       expect(feed.feed_version).to eql("1.0")
       expect(feed.encoding).to eql("UTF-8")
+      expect(feed.lang).to be_nil
+      expect(feed.valid?).to eql(true)
     end
 
     it "outputs the link" do
@@ -136,6 +138,31 @@ describe(JekyllFeed) do
       expect(post.summary).to be_nil
     end
 
+    context "with site.lang set" do
+      lang = "en_US"
+      let(:overrides) { {"lang" => lang} }
+      it "outputs a valid feed" do
+        expect(feed.feed_type).to eql("atom")
+        expect(feed.feed_version).to eql("1.0")
+        expect(feed.encoding).to eql("UTF-8")
+        expect(feed.valid?).to eql(true)
+      end
+
+      it "outputs the correct language" do
+        expect(feed.lang).to eql(lang)
+      end
+
+      it "sets the language of entries" do
+        post = feed.items.first
+        expect(post.lang).to eql(lang)
+      end
+
+      it "renders the feed meta" do
+        expected = %r!<link href="http://example.org/" rel="alternate" type="text/html" hreflang="#{lang}" />!
+        expect(contents).to match(expected)
+      end
+    end
+
     context "with site.title set" do
       let(:site_title) { "My Site Title" }
       let(:overrides) { {"title" => site_title} }

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ require 'jekyll'
 require 'typhoeus'
 require 'nokogiri'
 require 'rss'
-require File.expand_path('../lib/jekyll-feed', File.dirname(__FILE__))
+require File.expand_path('../lib/jekyll-feed', __dir__)
 
 Jekyll.logger.log_level = :error
 
@@ -11,8 +11,8 @@ RSpec.configure do |config|
   config.filter_run :focus
   config.order = 'random'
 
-  SOURCE_DIR = File.expand_path("../fixtures", __FILE__)
-  DEST_DIR   = File.expand_path("../dest",     __FILE__)
+  SOURCE_DIR = File.expand_path("fixtures", __dir__)
+  DEST_DIR   = File.expand_path("dest",     __dir__)
 
   def source_dir(*files)
     File.join(SOURCE_DIR, *files)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2018-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,84 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.51'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: '0.51'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: typhoeus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 description: 
 email:
 - ben.balter@github.com
@@ -130,9 +130,12 @@ files:
 - lib/jekyll-feed/generator.rb
 - lib/jekyll-feed/meta-tag.rb
 - lib/jekyll-feed/page-without-a-file.rb
+- lib/jekyll-feed/version.rb
 - script/bootstrap
 - script/cibuild
+- script/fmt
 - script/release
+- script/test
 - spec/fixtures/_config.yml
 - spec/fixtures/_data/authors.yml
 - spec/fixtures/_drafts/2015-01-12-a-draft.md
@@ -170,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts