middleman-blog 4.0.1 → 4.0.2

data/lib/middleman-blog/blog_data.rb

@@ -1,14 +1,18 @@
 require 'middleman-blog/uri_templates'
 
 module Middleman
+
   module Blog
+
+    ##
     # A store of all the blog articles in the site, with accessors
     # for the articles by various dimensions. Accessed via "blog" in
     # templates.
+    ##
     class BlogData
-      include UriTemplates
 
-      DEFAULT_FILTER = proc {|a| a}
+      include UriTemplates
+      extend Gem::Deprecate
 
       # A URITemplate for the source file path relative to :source_dir
       # @return [URITemplate]
@@ -20,10 +24,12 @@ module Middleman
 
       attr_reader :controller
 
+      ##
       # @private
+      ##
       def initialize(app, controller, options)
-        @app = app
-        @options = options
+        @app        = app
+        @options    = options
         @controller = controller
 
         # A list of resources corresponding to blog articles
@@ -34,60 +40,94 @@ module Middleman
           subdir: {}
         }
 
-        @source_template = uri_template options.sources
-        @permalink_template = uri_template options.permalink
-        @subdir_template = uri_template options.sources.sub(/\.[^.]+$/, "/{+path}")
-        @subdir_permalink_template = uri_template options.permalink.sub(/\.[^.]+$/, "/{+path}")
+        @source_template           = uri_template options.sources
+        @permalink_template        = uri_template options.permalink
+        @subdir_template           = uri_template options.sources.sub(/(\.[^.{}\/]+)?$/, "/{+path}" )
+        @subdir_permalink_template = uri_template options.permalink.sub(/(\.[^.{}\/]+)?$/, "/{+path}" )
       end
 
+      ##
       # A list of all blog articles, sorted by descending date
+      #
       # @return [Array<Middleman::Sitemap::Resource>]
+      ##
       def articles
-        @_articles.select(&(options.filter || DEFAULT_FILTER)).sort_by(&:date).reverse
+        @_articles.select( &( options.filter || proc { | a | a } ) ).sort_by( &:date ).reverse
       end
 
-      # A list of all blog articles with the given language,
-      # sorted by descending date
+      ##
+      # A list of all blog articles with the given language, sorted by
+      # descending date
+      #
+      # @deprecated Use {#articles_by_locale} instead.
       #
-      # @param [Symbol] locale 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(locale=::I18n.locale)
+      ##
+      def local_articles( locale = ::I18n.locale )
+          articles_by_locale( locale )
+      end
+      deprecate :local_articles, :articles_by_locale, 2017, 5
+
+      ##
+      # A list of all blog articles with the given language, sorted by
+      # descending date
+      #
+      # @param  [Symbol] locale Language to match (optional, defaults to I18n.locale).
+      # @return [Array<Middleman::Sitemap::Resource>]
+      #
+      # @todo should use the @_articles if represented in this method.
+      ##
+      def articles_by_locale( locale = ::I18n.locale )
         locale = locale.to_sym if locale.kind_of? String
-        articles.select {|article| article.locale == locale }
+        articles.select { | article | article.locale == locale }
       end
 
-      # Returns a map from tag name to an array
-      # of BlogArticles associated with that tag.
+      ##
+      # Returns a map from tag name to an array of BlogArticles associated with
+      # that tag and assigns the tag array back into it.
+      #
       # @return [Hash<String, Array<Middleman::Sitemap::Resource>>]
+      ##
       def tags
+
         tags = {}
 
-        @_articles.each do |article|
+        # Reference the filtered articles
+        articles.each do |article|
+
+          # Reference the tags assigned to an article
           article.tags.each do |tag|
+            # tag = safe_parameterize(tag)
             tags[tag] ||= []
             tags[tag] << article
           end
-        end
 
-        # Sort each tag's list of articles
-        tags.each do |tag, articles|
-          tags[tag] = articles.sort_by(&:date).reverse
         end
 
+        # Return tags
         tags
       end
 
+      ##
+      #
+      ##
       def extract_source_params(path)
         @_parsed_url_cache[:source][path] ||= extract_params(@source_template, path)
       end
 
+      ##
+      #
+      ##
       def extract_subdir_params(path)
         @_parsed_url_cache[:subdir][path] ||= extract_params(@subdir_template, path)
       end
 
-      # Updates' blog articles destination paths to be the
-      # permalink.
+      ##
+      # Updates' blog articles destination paths to be the permalink.
+      #
       # @return [void]
+      ##
       def manipulate_resource_list(resources)
         @_articles = []
         used_resources = []
@@ -107,17 +147,15 @@ module Middleman
             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
+            # compute output path: substitute date parts to path pattern
             article.destination_path = template_path @permalink_template, article, extra_data
 
             @_articles << article
 
           elsif (params = extract_subdir_params(resource.path))
-            # It's not an article, but it's thhe companion files for an article
+            # It's not an article, but it's the companion files for an article
             # (in a subdirectory named after the article)
             # figure out the matching article for this subdirectory file
-
             article_path = @source_template.expand(params).to_s
 
             if article = @app.sitemap.find_resource_by_path(article_path)
@@ -143,24 +181,33 @@ module Middleman
         used_resources
       end
 
+      ##
+      #
+      ##
       def inspect
         "#<Middleman::Blog::BlogData: #{articles.inspect}>"
       end
 
+      ##
       # Whether or not a given article should be included in the sitemap.
       # Skip articles that are not published unless the environment is +:development+.
+      #
       # @param [BlogArticle] article A blog article
       # @return [Boolean] whether it should be published
+      ##
       def publishable?(article)
         @app.environment == :development || article.published?
       end
 
       private
 
+      ##
       # Generate a hash of options for substituting into the permalink URL template.
+      #
       # @param [Sitemap::Resource] resource The resource to generate options for.
       # @param [Hash] extra More options to be merged in on top.
       # @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.map(&:to_sym)
@@ -175,8 +222,11 @@ module Middleman
           merge(extra)
       end
 
-      def convert_to_article(resource)
-        return resource if resource.is_a?(BlogArticle)
+      ##
+      #
+      ##
+      def convert_to_article( resource )
+        return resource if resource.is_a?( BlogArticle )
 
         resource.extend BlogArticle
         resource.blog_controller = controller
@@ -188,9 +238,13 @@ module Middleman
         resource
       end
 
+      ##
+      #
+      ##
       def template_path(template, article, extras={})
         apply_uri_template template, permalink_options(article, extras)
       end
+
     end
   end
 end

data/lib/middleman-blog/calendar_pages.rb

@@ -109,4 +109,4 @@ module Middleman
       end
     end
   end
-end
+end

data/lib/middleman-blog/commands/article.rb

@@ -1,11 +1,24 @@
-require 'middleman-core/cli'
+require 'middleman-core/cli'
 require 'date'
 require 'middleman-blog/uri_templates'
 
 module Middleman
+
   module Cli
+
+    ##
     # This class provides an "article" command for the middleman CLI.
+    #
+    # @usage bundle exec middleman article --help
+    # @usage bundle exec middleman article "Article Title"
+    # @usage bundle exec middleman article "Article Title" -t "test,test1" -c "<b>String</b>" -d 2017-03-25 -l fr-be -b blog_fr-be -s -e
+    #
+    # @see   https://middlemanapp.com/basics/blogging/#generating-articles
+    #
+    # @todo Tags should be removed from the template if they are not required
+    ##
     class Article < ::Thor::Group
+
       include Thor::Actions
       include Blog::UriTemplates
 
@@ -14,65 +27,110 @@ module Middleman
       # Template files are relative to this file
       # @return [String]
       def self.source_root
-        File.dirname(__FILE__)
+        File.dirname( __FILE__ )
       end
 
       argument :title, type: :string
 
+      class_option "blog",
+        aliases: "-b",
+        desc:    "The name of the blog to create the post inside (for multi-blog apps, defaults to the only blog in single-blog apps)"
+
+      class_option "content",
+        aliases: "-c",
+        desc: "Content of the post"
+
       class_option "date",
         aliases: "-d",
-        desc: "The date to create the post with (defaults to now)"
-      class_option "lang",
-        desc: "Deprecated, use locale"
+        desc:    "The date to create the post with (defaults to now)"
+
       class_option "locale",
         aliases: "-l",
-        desc: "The locale to create the post with (defaults to I18n.default_locale if avaliable)"
-      class_option "blog",
-        aliases: "-b",
-        desc: "The name of the blog to create the post inside (for multi-blog apps, defaults to the only blog in single-blog apps)"
+        desc:    "The locale to create the post with (defaults to I18n.default_locale if available)"
+
+      class_option "edit",
+        aliases: "-e",
+        desc:    "Edit the newly created blog post",
+        default: false,
+        type:    :boolean
+
+      class_option "subdirectory",
+        aliases: "-s",
+        desc:    "Generate an article subdirectory (for directory indexes, defaults to false)",
+        default: false,
+        type:    :boolean
+
+      class_option "tags",
+        aliases: "-t",
+        desc: "A list of comma-separated tags for the post"
+
       def article
-        config = ::Middleman::Cli.config
 
-        @title = title
-        @slug = safe_parameterize(title)
-        @date = options[:date] ? ::Time.zone.parse(options[:date]) : Time.zone.now
-        @lang = options[:lang] || options[:locale] || (::I18n.default_locale if defined? ::I18n )
+        @content = options[:content] || ""
+        @date    = options[ :date ] ? ::Time.zone.parse( options[ :date ] ) : Time.zone.now
+        @locale  = options[ :locale ] || ( ::I18n.default_locale if defined? ::I18n )
+        @slug    = safe_parameterize( title )
+        @tags    = options[:tags] && options[:tags].split(/\s*,\s*/) || []
+        @title   = title
 
         app = ::Middleman::Application.new do
-          config[:mode] = :config
-          config[:disable_sitemap] = true
-          config[:watcher_disable] = true
-          config[:exit_before_ready] = true
+          config[ :mode ]              = :config
+          config[ :disable_sitemap ]   = true
+          config[ :watcher_disable ]   = true
+          config[ :exit_before_ready ] = true
         end
 
-        blog_inst = if options[:blog]
-          app.extensions[:blog][options[:blog]]
+        blog_inst = if options[ :blog ]
+          app.extensions[ :blog ].find { | key, instance | instance.options[ :name ] == options[ :blog ] }[ 1 ]
         else
-          app.extensions[:blog].values.first
+          app.extensions[ :blog ].values.first
         end
 
         unless blog_inst
           msg = "Could not find an active blog instance"
-          msg << " named #{options[:blog]}" if options[:blog]
+          msg << " named #{ options[ :blog ] }" if options[ :blog ]
           throw msg
         end
 
-        path_template = blog_inst.data.source_template
-        params = date_to_params(@date).merge(lang: @lang.to_s, locale: @locale.to_s, title: @slug)
-        article_path = apply_uri_template path_template, params
+        path_template         = blog_inst.data.source_template
+        params                = date_to_params( @date ).merge( locale: @locale.to_s, title: @slug )
+        article_path          = apply_uri_template path_template, params
+        absolute_article_path = File.join( app.source_dir, article_path + blog_inst.options.default_extension )
+
+        template blog_inst.options.new_article_template, absolute_article_path
+
+        # Edit option process
+        if options[ :edit ]
+
+          editor = ENV.fetch( 'MM_EDITOR', ENV.fetch( 'EDITOR', nil ) )
+
+          if editor
+            system( "#{ editor } #{ absolute_article_path }" )
+          else
+            throw "Could not find a suitable editor. Try setting the environment variable MM_EDITOR."
+          end
+
+        end
+
+        # Subdirectory option process
+        if options[ :subdirectory ]
+          empty_directory extract_directory_path( File.join( app.source_dir, article_path ) )
+        end
 
-        template blog_inst.options.new_article_template, File.join(app.source_dir, article_path + blog_inst.options.default_extension)
       end
 
       protected
 
-      def blog_instance(key)
-        return nil unless app.extensions[:blog]
-        return app.extensions[:blog][key]
+      def blog_instance( key )
+        return nil unless app.extensions[ :blog ]
+        return app.extensions[ :blog ][ key ]
       end
 
       # Add to CLI
-      Base.register(self, 'article', 'article TITLE [options]', 'Create a new blog article')
+      Base.register( self, 'article', 'article TITLE [options]', 'Create a new blog article' )
+
     end
+
   end
+
 end

data/lib/middleman-blog/commands/article.tt

@@ -1,6 +1,9 @@
 ---
+
 title: <%= @title %>
 date: <%= @date.strftime('%F %R %Z') %>
-tags:
+tags: <%= @tags.join(",") %>
+
 ---
 
+<%= @content %>

data/lib/middleman-blog/custom_pages.rb

@@ -49,4 +49,4 @@ module Middleman
       end
     end
   end
-end
+end

data/lib/middleman-blog/helpers.rb

@@ -130,7 +130,7 @@ module Middleman
         # "articles" local variable is populated by Calendar and Tag page generators
         # If it's not set then use the complete list of articles
         articles = meta[:locals]["articles"] || blog(blog_name).articles
-        
+
         limit ? articles.first(limit) : articles
       end
 
@@ -159,4 +159,4 @@ module Middleman
       end
     end
   end
-end
+end

data/lib/middleman-blog/paginator.rb

@@ -7,11 +7,11 @@ module Middleman
     class Paginator
       include UriTemplates
 
-      def initialize(app, blog_controller)
-        @app = app
+      def initialize( app, blog_controller )
+        @app             = app
         @blog_controller = blog_controller
-        @per_page = blog_controller.options.per_page
-        @page_link = blog_controller.options.page_link
+        @per_page        = blog_controller.options.per_page
+        @page_link       = blog_controller.options.page_link
       end
 
       # Update the main sitemap resource list
@@ -34,6 +34,7 @@ module Middleman
           # If it's not set then use the complete list of articles
           # TODO: Some way to allow the frontmatter to specify the article filter?
           articles = md[:locals]["articles"] || @blog_controller.data.articles
+          articles.select!{|article| article.lang == md[:options][:locale]} if md.fetch(:options, false) and md[:options].fetch(:locale, false)
 
           # Allow blog.per_page and blog.page_link to be overridden in the frontmatter
           per_page  = md[:page][:per_page] || @per_page