middleman-blog 3.6.0.beta.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fd8e5447b47c113fc7c58ae2cd7555cc070adcf
-  data.tar.gz: d4586b9545fc038a1af9d415255952b0e3cdda76
+  metadata.gz: a954456dd37131a13ebabbdb3cb2cd2876f31c83
+  data.tar.gz: 9fe2db291d746b24bef90d3acfd16e966f1381c0
 SHA512:
-  metadata.gz: f35f5e4c6bb2c3b56e3bde38ff60928ecd49b56656acba2a338b7752ad6406d707b323fbea63e82041ad2fa5837205cdcefedbd791b65defd7741138814aa8c0
-  data.tar.gz: d8fbcc07cce2c0c330e1b0969ffe0eee303d1964752398d2d5f4d028394f6a09df65b43932c943fb41c6bd8c279fe7460968b0d07d60cef6fb870840ab5bccdc
+  metadata.gz: 97feb50f6597a1123b1e9f06d5a95d7a1479997b921da68ff15d84ba484607bb664de385f7fef4f6547dd972871bc3ff62521f346dcc2d00e4e48f88b7e4248a
+  data.tar.gz: 6be516bced8dba93bd1320f5b00e69d31466fd41286cb71422e3afc1a03fbda4814ff23f512e610bb27698f056ea3d0ec77ad70c7c39f9299a711f8eb6d73ffc

data/.travis.yml

@@ -1,7 +1,23 @@
 rvm:
-  - 1.9.3
-  - 2.0.0
+  - ruby-head
+  - jruby-head
   - jruby-19mode
+  - 2.2.2
+  - 2.1
+  - 2.0
+os:
+  - linux
+  - osx
+sudo: false
+matrix:
+  fast_finish: true
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-19mode
+    - rvm: jruby-head
+
+gemfile:
+  - Gemfile
 
 script: "bundle exec rake test"
 

data/CHANGELOG.md

@@ -1,7 +1,12 @@
+4.0.0.rc.1
+===
+
+* Removed `article` sub command.
+
 3.5.3
 ===
 
-Update blog_article active_support requires. Fixes #205
+* Update blog_article active_support requires. Fixes #205
 
 3.5.2
 ===

data/Gemfile

@@ -1,27 +1,30 @@
 source 'https://rubygems.org'
 
-gem "middleman-core", :github => "middleman/middleman", :branch => 'v3-stable'
+gem "middleman-cli", github: "middleman/middleman", branch: 'master'
+gem "middleman-core", github: "middleman/middleman", branch: 'master'
 
 # Specify your gem's dependencies in middleman-blog.gemspec
 gemspec
 
-gem "rake",     "~> 10.1.0", :require => false
-gem "yard",     "~> 0.8.0", :require => false
+# Build and doc tools
+gem 'rake', '~> 10.3', require: false
+gem 'yard', '~> 0.8', require: false
 
 # Test tools
-gem "cucumber", "~> 1.3.1"
-gem "fivemat"
-gem "aruba",    "~> 0.5.1"
-gem "rspec",    "~> 2.12"
-gem "simplecov"
+gem 'pry', '~> 0.10', group: :development, require: false
+gem 'aruba', '~> 0.7.4', require: false
+gem 'rspec', '~> 3.0', require: false
+gem 'cucumber', '~> 2.0', require: false
 
 gem "timecop",  "~> 0.6.3"
 gem "nokogiri"
 gem "kramdown"
 
 # Code Quality
-gem "cane", :platforms => [:mri_19, :mri_20], :require => false
-gem 'coveralls', :require => false
+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
 
 platforms :ruby do
   gem "redcarpet", "~> 3.0"

data/README.md

@@ -8,7 +8,7 @@ If you're just getting started, install the `middleman` gem and generate a new p
 
 ```
 gem install middleman
-middleman init MY_PROJECT
+middleman init MY_PROJECT --template=blog
 ```
 
 If you already have a Middleman project: Add `gem "middleman-blog"` to your `Gemfile` and run `bundle install`
@@ -27,11 +27,11 @@ Additionally, up-to-date generated code documentation is available on [RubyDoc].
 
 ## Build & Dependency Status
 
-[![Gem Version](https://badge.fury.io/rb/middleman-blog.png)][gem]
-[![Build Status](https://travis-ci.org/middleman/middleman-blog.png)][travis]
-[![Dependency Status](https://gemnasium.com/middleman/middleman-blog.png?travis)][gemnasium]
-[![Code Quality](https://codeclimate.com/github/middleman/middleman-blog.png)][codeclimate]
-[![Code Coverage](https://coveralls.io/repos/middleman/middleman-blog/badge.png?branch=master)][coveralls]
+[![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

data/Rakefile

@@ -10,7 +10,6 @@ Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
 
   exempt_tags = ""
   exempt_tags << "--tags ~@nojava " if RUBY_PLATFORM == "java"
-  exempt_tags << "--tags ~@three_one " unless ::Middleman::VERSION.match(/^3\.1\./)
 
   t.cucumber_opts = "--color --tags ~@wip #{exempt_tags} --strict --format #{ENV['CUCUMBER_FORMAT'] || 'pretty'}"
 end
@@ -24,20 +23,7 @@ require 'rspec/core/rake_task'
 desc "Run RSpec"
 RSpec::Core::RakeTask.new do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
-  spec.rspec_opts = ['--color', '--format nested']
-end
-
-begin
-  require 'cane/rake_task'
-
-  desc "Run cane to check quality metrics"
-  Cane::RakeTask.new(:quality) do |cane|
-    cane.no_style = true
-    cane.no_doc = true
-    cane.abc_glob = "lib/middleman-blog/**/*.rb"
-  end
-rescue LoadError
-  # warn "cane not available, quality task not provided."
+  spec.rspec_opts = ['--color', '--format documentation']
 end
 
 desc "Build HTML documentation"

data/features/calendar.feature

@@ -87,3 +87,26 @@ Feature: Calendar pages
     And the file "index.html" should contain "Month Path: '/2011/01.html'"
     And the file "index.html" should contain "Day Path: '/2011/01/01.html'"
 
+  Scenario: Calendar pages for months and days are not added when disabled in the config
+    Given a fixture app "calendar-app"
+    And app "calendar-app" is using config "only-year"
+    And I run `middleman build`
+    And was successfully built
+
+    When I cd to "build"
+    Then the following files should exist:
+    | 2011.html       |
+    And the following files should not exist:
+    | 2011/01.html    |
+    | 2011/01/01.html |
+    | 2011/01/02.html |
+
+    And the file "2011.html" should contain "/2011-01-01-new-article.html"
+    And the file "2011.html" should contain "/2011-01-02-another-article.html"
+    And the file "2011.html" should contain "Year: '2011'"
+    And the file "2011.html" should contain "Month: ''"
+    And the file "2011.html" should contain "Day: ''"
+
+    And the file "index.html" should contain "Year Path: '/2011.html'"
+    And the file "index.html" should contain "Month Path: ''"
+    And the file "index.html" should contain "Day Path: ''"

data/features/calendar_multiblog.feature

@@ -1,5 +1,3 @@
-@three_one
-
 Feature: Calendar pages
   Scenario: Calendar pages are accessible from preview server
     Given the Server is running at "calendar-multiblog-app"

data/features/language.feature

@@ -42,7 +42,7 @@ Feature: Internationalized articles
     When I go to "/index.html"
     Then I should see "Some text in English. All is OK."
     When I go to "/ru/index.html"
-    Then I should see "Некоторый текст на русском языке. Всё OK."
+    Then I should see "Некоторый текст на русском языке. Всё отлично."
 
   Scenario: Layout's locale match article's locale on article page
     Given a fixture app "language-app"
@@ -76,15 +76,3 @@ Feature: Internationalized articles
     Then I should see "Hello, world!"
     Then I should not see "Язык: ru"
     Then I should not see "Привет, мир!"
-
-  Scenario: Creating article with lang from CLI
-    Given a fixture app "language-app"
-    And a file named "config.rb" with:
-      """
-      activate :i18n
-      activate :blog, prefix: ":lang"
-      """
-    And I run `middleman article "My New Article" --date 2013-09-07 --lang ru`
-    Then the exit status should be 0
-    Then the following files should exist:
-      | source/ru/2013-09-07-my-new-article.html.markdown |

data/features/multiblog.feature

@@ -1,5 +1,3 @@
-@three_one
-
 Feature: Host Multiple Blogs with Middleman 3.1+
 
   Scenario: Preview

data/features/paginate_multiblog.feature

@@ -1,5 +1,3 @@
-@three_one
-
 Feature: Pagination with Multiblog
   Scenario: Index pages are accessible from preview server
     Given the Server is running at "paginate-multiblog-app"

data/features/tags.feature

@@ -81,3 +81,17 @@ Feature: Tag pages
       """
     When I go to "/tags/☆☆☆.html"
     Then I should see "/2011-01-01-new-article.html"
+
+  Scenario: Tag pages are not added when disabled in configuration
+    Given a fixture app "tags-app"
+    And app "tags-app" is using config "no-tags"
+    And I run `middleman build`
+    And was successfully built
+
+    When I cd to "build"
+    Then the following files should not exist:
+    | tags.html |
+    | tags/foo.html |
+    | tags/bar.html |
+
+    And the file "index.html" should contain "Tag Path: ''"

data/features/tags_multiblog.feature

@@ -1,5 +1,3 @@
-@three_one
-
 Feature: Tag pages with multiple blogs
   Scenario: Tag pages are accessible from preview server
     Given the Server is running at "tags-multiblog-app"

data/fixtures/blog-sources-subdirs-app/config.rb

@@ -1,4 +1,4 @@
 activate :blog do |blog|
   blog.sources = "blog/:title.html"
-  blog.permalink = "blog/{title}"
+  blog.permalink = "blog/{title}.html"
 end

data/fixtures/blog-sources-subdirs-app/source/blog.html.erb

@@ -1,3 +1,3 @@
 <% page_articles.each do |post| %>
   <li><%= link_to post.title, post %></li>
-<% end %>
+<% end %>

data/fixtures/calendar-app/config-only-year.rb

@@ -0,0 +1,9 @@
+Time.zone = "Pacific Time (US & Canada)"
+
+activate :blog do |blog|
+  blog.sources              = "blog/:year-:month-:day-:title.html"
+  blog.permalink            = "blog/:year-:month-:day-:title.html"
+  blog.calendar_template    = 'calendar.html'
+  blog.generate_month_pages = false
+  blog.generate_day_pages   = false
+end

data/fixtures/custom-collections-sources-app/source/index.html.erb

@@ -1,5 +1,5 @@
- <% blog.articles[0...12].each do |article| %>
-      <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
-    <% end %>
+<% blog.articles[0...12].each do |article| %>
+  <li><a href="<%= article.url %>"><%= article.title %></a> <time><%= article.date.strftime('%b %e') %></time></li>
+<% end %>
 
 Category Path: '<%= category_path("articles") %>'

data/fixtures/permalink-data-app/source/layout.erb

@@ -5,7 +5,7 @@
   <body>
     <% if is_blog_article? %>
       URL: <%= current_article.url %>
-      Category: <%= current_article.metadata[:page]['category'] %>
+      Category: <%= current_article.data[:category] %>
       <%= yield %>
     <% else %>
       <%= yield %>

data/fixtures/tags-app/config-no-tags.rb

@@ -0,0 +1,6 @@
+activate :blog do |blog|
+  blog.sources            = "blog/:year-:month-:day-:title.html"
+  blog.permalink          = "blog/:year-:month-:day-:title.html"
+  blog.tag_template       = "/tag.html"
+  blog.generate_tag_pages = false
+end

data/lib/middleman-blog.rb

@@ -1,15 +1,6 @@
 require "middleman-core"
-
 require "middleman-blog/version"
 
-begin
-  require "middleman-blog/template"
-rescue LoadError
-  # v4
-end
-
-require "middleman-blog/commands/article"
-
 ::Middleman::Extensions.register(:blog) do
   require "middleman-blog/extension"
   ::Middleman::BlogExtension

data/lib/middleman-blog/blog_article.rb

@@ -30,7 +30,7 @@ module Middleman
       # Called automatically by Middleman.
       # @return [String]
       def render(opts={}, locs={}, &block)
-        if opts[:layout].nil?
+        unless opts.has_key?(:layout)
           opts[:layout] = metadata[:options][:layout]
           opts[:layout] = blog_options.layout if opts[:layout].nil?
           # Convert to a string unless it's a boolean
@@ -136,20 +136,22 @@ module Middleman
       # activated at all, +nil+ will be returned.
       #
       # @return [Symbol] Language code (for example, +:en+ or +:de+)
-      def lang
-        frontmatter_lang = data['lang']
-        filename_lang = path_part('lang')
+      def locale
+        frontmatter_locale = data['locale'] || data['lang']
+        filename_locale = path_part('locale') || path_part('lang')
 
-        if frontmatter_lang && filename_lang && frontmatter_lang != filename_lang
-          raise "The lang in #{path}'s filename (#{filename_lang.inspect}) doesn't match the lang in its frontmatter (#{frontmatter_lang.inspect})"
+        if frontmatter_locale && filename_locale && frontmatter_locale != filename_locale
+          raise "The locale in #{path}'s filename (#{filename_locale.inspect}) doesn't match the lang in its frontmatter (#{frontmatter_locale.inspect})"
         end
 
-        locale_lang = I18n.default_locale if defined? I18n
+        default_locale = I18n.default_locale if defined? ::I18n
 
-        lang = frontmatter_lang || filename_lang || locale_lang
-        lang && lang.to_sym
+        found_locale = frontmatter_locale || filename_locale || default_locale
+        found_locale && found_locale.to_sym
       end
 
+      alias_method :lang, :locale
+
       # Attempt to figure out the date of the post. The date should be
       # present in the source path, but users may also provide a date
       # in the frontmatter in order to provide a time of day for sorting

data/lib/middleman-blog/blog_data.rb

@@ -42,12 +42,11 @@ module Middleman
       # A list of all blog articles with the given language,
       # sorted by descending date
       #
-      # @param [Symbol] lang Language to match (optional, defaults to I18n.locale).
+      # @param [Symbol] locale Language to match (optional, defaults to I18n.locale).
       # @return [Array<Middleman::Sitemap::Resource>]
-      def local_articles(lang=nil)
-        lang ||= I18n.locale
-        lang = lang.to_sym if lang.kind_of? String
-        articles.select {|article| article.lang == lang }
+      def local_articles(locale=::I18n.locale)
+        locale = locale.to_sym if locale.kind_of? String
+        articles.select {|article| article.locale == locale }
       end
 
       # Returns a map from tag name to an array
@@ -55,6 +54,7 @@ module Middleman
       # @return [Hash<String, Array<Middleman::Sitemap::Resource>>]
       def tags
         tags = {}
+
         @_articles.each do |article|
           article.tags.each do |tag|
             tags[tag] ||= []
@@ -89,12 +89,12 @@ module Middleman
             next unless publishable?(article)
 
             # Add extra parameters from the URL to the page metadata
-            extra_data = params.except *%w(year month day title lang)
+            extra_data = params.except *%w(year month day title lang locale)
             article.add_metadata page: extra_data unless extra_data.empty?
 
             # compute output path:
             #   substitute date parts to path pattern
-            article.destination_path = template_path @permalink_template, article
+            article.destination_path = template_path @permalink_template, article, extra_data
 
             @_articles << article
 
@@ -110,10 +110,13 @@ module Middleman
               article = convert_to_article(article)
               next unless publishable?(article)
 
+              # Add extra parameters from the URL to the page metadata
+              extra_data = params.except *%w(year month day title lang locale)
+              article.add_metadata page: extra_data unless extra_data.empty?
+
               # The subdir path is the article path with the index file name
               # or file extension stripped off.
-              path = params.fetch('path')
-              new_destination_path = template_path @subdir_permalink_template, article, path: path
+              new_destination_path = template_path @subdir_permalink_template, article, extra_data
 
               resource.destination_path = Middleman::Util.normalize_path(new_destination_path)
             end
@@ -145,14 +148,15 @@ module Middleman
       # @return [Hash] options
       def permalink_options(resource, extra={})
         # Allow any frontmatter data to be substituted into the permalink URL
-        params = resource.metadata[:page].slice *@permalink_template.variables
+        params = resource.metadata[:page].slice *@permalink_template.variables.map(&:to_sym)
+
         params.each do |k, v|
           params[k] = safe_parameterize(v)
         end
 
         params.
           merge(date_to_params(resource.date)).
-          merge(lang: resource.lang.to_s, title: resource.slug).
+          merge(lang: resource.lang.to_s, locale: resource.locale.to_s, title: resource.slug).
           merge(extra)
       end
 
@@ -162,8 +166,8 @@ module Middleman
         resource.extend BlogArticle
         resource.blog_controller = controller
 
-        if !options.preserve_locale && (lang = resource.lang)
-          resource.add_metadata options: { lang: lang }, locals: { lang: lang }
+        if !options.preserve_locale && (locale = resource.locale || resource.lang)
+          resource.add_metadata options: { lang: locale, lang: locale }, locals: { lang: locale, locale: locale }
         end
 
         resource