middleman-blog 4.0.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6437136847c6ca3dfc732f0585d154969a140967
-  data.tar.gz: 7d6a917c2f463b52a95a6b1e5c5fc73ff4e0b120
+SHA256:
+  metadata.gz: 02acc65e0b298f6a99ef12beb14728ce8b38a62d7bd4efb7f18c19c9a374bde0
+  data.tar.gz: 87d8c68a9f577326e49297d95e13cb38ec768b138c882debfab26caa0263eef7
 SHA512:
-  metadata.gz: 6b27cbe706b043afb84067b974bdf574bf70e006abb0c111b006c12e9a489f114255456a2152a13d68ae816b3abd9eb02c77c4efc16b5833fcc902ca45106180
-  data.tar.gz: 2b26df677ed97f8806102ae623b7d193820e44175b64d7a1d5bbda4b9c48897ddbf39f6f823ba66f1a6020659304010d788978dd7f668a0ece97a6e77faaecba
+  metadata.gz: ff9a0742dd98a22d3709c787977fbf23337b1fde7bebe42cd47ce7fd3f3ec9bef2dde7b2607775a660af381034fb5f82a4a220a74116c30428b976c008de610c
+  data.tar.gz: 68847383fc5fbce0753ac74ebf66b1f7988ea59a08ee7010a52fd19ea5fecd1e2723be23363d5300b098d6903df67cce1758b000d972d46f96c5c649b8337363

data/.editorconfig

@@ -0,0 +1,16 @@
+# editorconfig.org
+root = true
+
+[*]
+indent_style             = space
+indent_size              = 2
+charset                  = utf-8
+trim_trailing_whitespace = true
+insert_final_newline     = true
+end_of_line              = lf
+
+# editorconfig-tools is unable to ignore longs strings or urls
+max_line_length          = null
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -6,9 +6,13 @@ pkg/*
 .DS_Store
 .rbenv-version
 .ruby-version
+.ruby-gemset
 tmp
 doc
 .yardoc
 build/
 .sass-cache
-coverage
+coverage
+.byebug_history
+bin/
+.config

data/.rubocop.yml

@@ -0,0 +1,69 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  Include:
+    - '**/*.rb'
+    - '**/Rakefile'
+    - '**/Gemfile'
+    - '**/config.ru'
+  Exclude:
+    - 'vendor/**/*'
+    - '**/tmp/**/*'
+    - 'middleman-cli/lib/middleman-cli/templates/**/*'
+Security/YAMLLoad:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ModuleLength:
+  Enabled: false
+Metrics/PerceivedComplexity:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+Lint/AmbiguousBlockAssociation:
+  Enabled: false
+Lint/UriEscapeUnescape:
+  Enabled: false
+Lint/HandleExceptions:
+  Enabled: false
+Lint/ShadowedException:
+  Enabled: false
+Naming/FileName:
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+Naming/MemoizedInstanceVariableName:
+  Enabled: false
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+Security/Eval:
+  Enabled: false
+Style/RegexpLiteral:
+  Enabled: false
+Style/ClassAndModuleChildren:
+  Enabled: false
+Style/MissingRespondToMissing:
+  Enabled: false
+Style/MethodMissingSuper:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/EvalWithLocation:
+  Enabled: false
+Style/ClassVars:
+  Enabled: false
+Style/GlobalVars:
+  Enabled: false

data/.travis.yml

@@ -1,24 +1,30 @@
+language: ruby
+cache: bundler
+
 rvm:
   - ruby-head
-  - jruby-head
-  - jruby-19mode
-  - 2.2.2
-  - 2.1
-  - 2.0
+  - 2.6.0
+  - 2.5.3
+  - 2.4.5
+  - 2.3.8
+
 os:
   - linux
-  - osx
-sudo: false
-matrix:
+
+gemfile:
+  - Gemfile
+  - Gemfile-4.x
+
+matrix :
   fast_finish: true
   allow_failures:
     - rvm: ruby-head
-    - rvm: jruby-19mode
-    - rvm: jruby-head
 
-gemfile:
-  - Gemfile
+script: bundle exec rake test
 
-script: "bundle exec rake test"
+env:
+  global:
+    - TEST=true
 
-env: TEST=true
+notifications:
+  email: false

data/.yardopts

@@ -1,3 +1,3 @@
-lib/**/*.rb 
+lib/**/*.rb
 --no-private
---hide-void-return
+--hide-void-return

data/CHANGELOG.md

@@ -1,15 +1,48 @@
-4.0.0.rc.1
-===
+# Changelog
+
+## 4.0.3
+
+* Loosen dependencies and test against Middlman v5 betas
+* Adapt to core Rubocop standards
+* Title should be always a string (#351)
+* Fixed multibyte tags.
+
+## 4.0.2
+
+* Pushed Gem 2017-05-22
+* Updated safe_parameterize - needs heavy testing from community
+* Deprecating previous_article and next_article in favour of article_previous article_next
+* Deprecating local_articles in favour of articles_by_locale
+* Pull request #336 Add article_locale_next and article_locale_previous
+* Pull request #312 Generating a blog article can optional create article subdirectory added manually
+* Updated Gemfile for testing tools to remove the deprecation warnings from Aruba
+* Added myself to GemSpec so I can push Gem live
+* Edited Travis.yml to be inline with middleman core and the Ruby versions it tests against
+* Created an GitHub Issue Template
+* Created an Editor config
+* Ruby 2.3.1 - middleman-core (master/4.2.1) - middleman-cli (master/4.2.1) - middleman-blog (local) - All tests pass
+* Updated the Gemfile to use https to remove security warning - upped gem versions to match core
+* Updated the license and readme
+
+## 4.0.1
+
+* Pull in article command from v3.5.3 tag
+* Summary fix
+* Add address parse cache
+* Add filter option
+* Make sure to not generate invalid html when creating article summary
+* If a summary_generator is defined, always use it to generate summaries
+* Fix issue #269: duplicated key
+
+## 4.0.0.rc.1
 
 * Removed `article` sub command.
 
-3.5.3
-===
+## 3.5.3
 
 * Update blog_article active_support requires. Fixes #205
 
-3.5.2
-===
+## 3.5.2
 
 * Ignored pages won't be processed by the blog extension.
 * Avoid creating an empty-string collection when a post does not have a custom collection property set. #192
@@ -18,16 +51,14 @@
 * An article's language can be set via the {lang} parameter in its sources URL template. #187
 * Tags that are just a number work now. #188
 
-3.5.1
-===
+## 3.5.1
 
 * Remove a broken bracket in the blog template. #181
 * Fix transliteration of strings into URL slugs to still transliterate when it can but not smash multibyte chars. #183
 * Only match source URI templates if the date components match what a date would look like, and avoid throwing when companion files do not have an article. #184
 * Re-support spaces in blog article source paths. #185
 
-3.5.0
-===
+## 3.5.0
 
 * Add support for internationalization and locale-specific articles. #156
 * Drop support for Ruby 1.8 and Middleman 3.0.
@@ -40,13 +71,11 @@
 * The template used to generate new articles via "middleman article" can be overridden by setting :new_article_template.
 * Removed `:blog_name`, `:blog_author`, `:blog_avatar` options and the `page_title` helper.
 
-3.4.1
-====
+## 3.4.1
 
 * Require Middleman 3.2
 
-3.4.0
-====
+## 3.4.0
 
 * Add `inspect` methods to `BlogData` and `BlogArticle` to avoid hangs on exceptions. #157
 * Generated feed.xml now works on blogs with no posts. #155
@@ -55,8 +84,7 @@
 * Support for including arbitrary frontmatter data in blog permalinks. #164
 * When using multiblog, fail immediately if the blog name isn't specified. #168
 
-3.3.0
-====
+## 3.3.0
 
 * Experimental support for multiple blogs in a single site by activating
   `:blog` multiple times.
@@ -78,8 +106,7 @@
 * Pages can choose which blog to use in multi-blog mode by specifying the correct
   blog in frontmatter. #150
 
-3.2.0
-====
+## 3.2.0
 
 * The `summary` method on articles is now HTML-aware, and can be provided with
   a different summary length or ellipsis string: `summary(1000, '…')`.
@@ -91,13 +118,13 @@
 * The `summary_separator` option no longer needs to have a capturing group, or
   even be a regexp.
 
-3.1.1
-====
+## 3.1.1
+
 * Correctly handle time zone, allow setting time zone with `set :time_zone`. #76
 * Fix using `page_articles` in when `paginate` is false. #78
 
-3.1.0
-====
+## 3.1.0
+
 * Don't publish future-dated articles. #74
 * Create summary from source instead of output. #70
 * Deprecate instance variables in templates in favor of locals. #66
@@ -108,8 +135,8 @@
 * Use `link_to` in blog templates. #62
 * Pagination for index, tag, and calendar pages. #57
 
-3.0.0
-====
+## 3.0.0
+
 * Middleman-3.0 compatible release. Complete overhaul.
 * Tag and calendar pages.
 * Sitemap integration.

data/CONTRIBUTING.md

@@ -1,4 +1,5 @@
 # Contributing
+
 In the spirit of [free software][free-sw], **everyone** is encouraged to help
 improve this project.
 
@@ -6,12 +7,12 @@ improve this project.
 
 Here are some ways *you* can contribute:
 
-* by using alpha, beta, and prerelease versions
+* by using alpha, beta, and pre-release versions
 * by reporting bugs
 * by suggesting new features
 * by writing or editing documentation
 * by writing specifications
-* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent whitespace )
+* by writing code ( **no patch is too small** : fix typos, add comments, clean up inconsistent white space )
 * by refactoring code
 * by closing [issues][]
 * by reviewing patches
@@ -19,6 +20,7 @@ Here are some ways *you* can contribute:
 [issues]: https://github.com/middleman/middleman-blog/issues
 
 ## Submitting an Issue
+
 We use the [GitHub issue tracker][issues] to track bugs and features. Before
 submitting a bug report or feature request, check to make sure it hasn't
 already been submitted. When submitting a bug report, please include a [Gist][]
@@ -29,6 +31,7 @@ Ideally, a bug report should include a pull request with failing specs.
 [gist]: https://gist.github.com/
 
 ## Submitting a Pull Request
+
 1. [Fork the repository.][fork]
 2. [Create a topic branch.][branch]
 3. Add specs for your unimplemented feature or bug fix.

data/Gemfile

@@ -1,31 +1,37 @@
 source 'https://rubygems.org'
 
-gem "middleman-cli", github: "middleman/middleman", branch: 'master'
-gem "middleman-core", github: "middleman/middleman", branch: 'master'
+# Middleman Gems
+gem 'middleman-cli',  git: 'https://github.com/middleman/middleman.git', branch: 'master'
+gem 'middleman-core', git: 'https://github.com/middleman/middleman.git', branch: 'master'
 
 # Specify your gem's dependencies in middleman-blog.gemspec
 gemspec
 
 # Build and doc tools
-gem 'rake', '~> 10.3', require: false
-gem 'yard', '~> 0.8', require: false
+gem 'rake', '~> 12.3', require: false
+gem 'yard', '~> 0.9.11', require: false
 
 # Test tools
-gem 'pry', '~> 0.10', group: :development, require: false
-gem 'aruba', '~> 0.7.4', require: false
+gem 'aruba', '~> 0.14.0', require: false
+gem 'byebug'
+gem 'capybara', '~> 2.5.0', require: false
+gem 'cucumber', '~> 3.0', require: false
 gem 'rspec', '~> 3.0', require: false
-gem 'cucumber', '~> 2.0', require: false
 
-gem "timecop",  "~> 0.6.3"
-gem "nokogiri"
-gem "kramdown"
+# Pry tools
+gem 'pry'
+gem 'pry-rescue'
+gem 'pry-stack_explorer'
+
+gem 'kramdown'
+gem 'nokogiri', '~> 1.9.1'
+gem 'timecop', '~> 0.6.3'
 
 # Code Quality
-gem 'rubocop', '~> 0.24', require: false
-gem 'simplecov', '~> 0.9', require: false
-gem 'coveralls', '~> 0.8', require: false
-gem 'codeclimate-test-reporter', '~> 0.3', require: false, group: :test
+gem 'rubocop', '~> 0.61.1', require: false
+gem 'simplecov', '~> 0.10', require: false
 
+# Set the ruby platform - not windows
 platforms :ruby do
-  gem "redcarpet", "~> 3.0"
+  gem 'redcarpet', '~> 3.1' # Latest 3.4.0
 end

data/Gemfile-4.x

@@ -0,0 +1,38 @@
+
+source 'https://rubygems.org'
+
+# Middleman Gems
+gem 'middleman-cli', '~> 4.2'
+gem 'middleman-core', '~> 4.2'
+
+# Specify your gem's dependencies in middleman-blog.gemspec
+gemspec
+
+# Build and doc tools
+gem 'rake', '~> 12.3', require: false
+gem 'yard', '~> 0.9.11', require: false
+
+# Test tools
+gem 'aruba', '~> 0.14.0', require: false
+gem 'byebug'
+gem 'capybara', '~> 2.5.0', require: false
+gem 'cucumber', '~> 3.0', require: false
+gem 'rspec', '~> 3.0', require: false
+
+# Pry tools
+gem 'pry'
+gem 'pry-rescue'
+gem 'pry-stack_explorer'
+
+gem 'kramdown'
+gem 'nokogiri', '~> 1.9.1'
+gem 'timecop', '~> 0.6.3'
+
+# Code Quality
+gem 'rubocop', '~> 0.61.1', require: false
+gem 'simplecov', '~> 0.10', require: false
+
+# Set the ruby platform - not windows
+platforms :ruby do
+  gem 'redcarpet', '~> 3.1' # Latest 3.4.0
+end

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Expected behaviour
+
+## Actual behaviour
+
+## Steps to reproduce the problem
+
+- Please provide a repository or some tests we can run through
+
+## Additional information
+
+- Ruby version:
+- Middleman version:
+- Middleman Blog version:
+- OS version:

data/LICENSE.md

@@ -1,20 +1,18 @@
-Copyright (c) 2010-2013 Thomas Reynolds
+Copyright (c) 2010-2017 Thomas Reynolds
 
-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:
+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 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.
+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.

data/README.md

@@ -1,27 +1,36 @@
-# Middleman-Blog
+# Middleman-Blog extension
 
-`middleman-blog` is an extension for the [Middleman] static site generator that adds blog-specific functionality. This includes handling blog articles, helpers for listing articles, and tagging support.
+middleman-blog is an extension for the [Middleman] static site generator that
+adds blog-specific functionality. This includes :
+
+- Handling blog articles
+- Helpers for listing articles
+- Tagging support
 
 ## Installation
 
-If you're just getting started, install the `middleman` gem and generate a new project:
+If you're just getting started, install the `middleman` gem and generate a new
+project:
 
 ```
 gem install middleman
 middleman init MY_PROJECT --template=blog
 ```
 
-If you already have a Middleman project: Add `gem "middleman-blog"` to your `Gemfile` and run `bundle install`
+If you already have a Middleman project: Add `gem "middleman-blog"` to your
+`Gemfile` and run `bundle install`
 
 ## Configuration
 
+Within the config.rb of the middleman project, include the line
+
 ```
 activate :blog
 ```
 
-## Learn More
-
-See [the blog extension guide](http://middlemanapp.com/basics/blogging/) for detailed information on configuring and using the blog extension.
+A more extensive guide can be found here :
+[Middleman blogging guide](http://middlemanapp.com/basics/blogging/) it includes
+more detailed information on configuring and using the blog extension.
 
 Additionally, up-to-date generated code documentation is available on [RubyDoc].
 
@@ -29,39 +38,62 @@ Additionally, up-to-date generated code documentation is available on [RubyDoc].
 
 [![Gem Version](https://badge.fury.io/rb/middleman-blog.svg)][gem]
 [![Build Status](https://travis-ci.org/middleman/middleman-blog.svg)][travis]
-[![Dependency Status](https://gemnasium.com/middleman/middleman-blog.svg?travis)][gemnasium]
-[![Code Quality](https://codeclimate.com/github/middleman/middleman-blog.svg)][codeclimate]
-[![Code Coverage](https://coveralls.io/repos/middleman/middleman-blog/badge.svg?branch=master)][coveralls]
+
 ## Community
 
-The official community forum is available at: http://forum.middlemanapp.com
+Please also visit the the official [Middleman community forum](http://forum.middlemanapp.com)
 
 ## Bug Reports
 
-Github Issues are used for managing bug reports and feature requests. If you run into issues, please search the issues and submit new problems: https://github.com/middleman/middleman-blog/issues
+Github Issues are used for managing bug reports and feature requests.
+
+If you run into issues or have an idea; please search and then submit the ticket
+[here](https://github.com/middleman/middleman-blog/issues)
+
+The best way to get quick responses to your issues and swift fixes to your bugs
+is to submit detailed bug reports, include test cases and respond to developer
+questions in a timely manner. Even better, if you know Ruby, you can submit
+[Pull Requests](https://help.github.com/articles/using-pull-requests) containing
+Cucumber Features which describe how your feature should work or exploit the bug
+you are submitting.
+
+## Testing
 
-The best way to get quick responses to your issues and swift fixes to your bugs is to submit detailed bug reports, include test cases and respond to developer questions in a timely manner. Even better, if you know Ruby, you can submit [Pull Requests](https://help.github.com/articles/using-pull-requests) containing Cucumber Features which describe how your feature should work or exploit the bug you are submitting.
+Our internal tests are passed through Travis, testing against the following
+Ruby versions on Linux :
 
-## How to Run Cucumber Tests
+- ruby-head
+- 2.4.0
+- 2.3.1
+- 2.2.4
+
+### Running tests
 
 1. Checkout Repository: `git clone https://github.com/middleman/middleman-blog.git`
 2. Install Bundler: `gem install bundler`
 3. Run `bundle install` inside the project root to install the gem dependencies.
 4. Run test cases: `bundle exec rake test`
 
+NB// To run an individual test use :
+
+1. `bundle exec cucumber features/blog_sources.feature`
+
+If you have suggestions for testing practices please submit a request.
+
+## Creating documentation
+
+1. `bundle exec rake doc`
+
 ## Donate
 
-[Click here to lend your support to Middleman](https://spacebox.io/s/4dXbHBorC3)
+[Click here to lend your support to Middleman](https://plasso.com/s/4dXbHBorC3)
 
 ## License
 
-Copyright (c) 2010-2013 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
+Copyright (c) 2010-2017 Thomas Reynolds. MIT Licensed, see [LICENSE] for details.
 
 [middleman]: http://middlemanapp.com
 [gem]: https://rubygems.org/gems/middleman-blog
 [travis]: http://travis-ci.org/middleman/middleman-blog
-[gemnasium]: https://gemnasium.com/middleman/middleman-blog
-[codeclimate]: https://codeclimate.com/github/middleman/middleman-blog
-[coveralls]: https://coveralls.io/r/middleman/middleman-blog
-[rubydoc]: http://rubydoc.info/github/middleman/middleman-blog
+[rubydoc]: http://rubydoc.info/github/middleman/middleman-blog/master
 [LICENSE]: https://github.com/middleman/middleman-blog/blob/master/LICENSE.md

data/Rakefile

@@ -6,27 +6,32 @@ require 'cucumber/rake/task'
 require 'middleman-core'
 
 Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
-  ENV["TEST"] = "true"
+  ENV['TEST'] = 'true'
 
-  exempt_tags = ""
-  exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
+  exempt_tags = ''
+  exempt_tags << '--tags ~@nojava ' if RUBY_PLATFORM == 'java'
 
   t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
 end
 
 require 'rake/clean'
 
-desc "Run tests, both RSpec and Cucumber"
-task :test => [:spec, :cucumber]
+desc 'Run tests, both RSpec and Cucumber'
+task test: %i[rubocop spec cucumber]
 
 require 'rspec/core/rake_task'
-desc "Run RSpec"
+
+desc 'Run RSpec'
 RSpec::Core::RakeTask.new do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
+  spec.pattern    = 'spec/**/*_spec.rb'
   spec.rspec_opts = ['--color', '--format documentation']
 end
 
-desc "Build HTML documentation"
+require 'rubocop/rake_task'
+desc 'Run RuboCop to check code consistency'
+RuboCop::RakeTask.new(:rubocop)
+
+desc 'Build HTML documentation'
 task :doc do
   sh 'bundle exec yard'
 end