jekyll-compose 0.11.0 → 0.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1017cc00ab44265c4d810de87d46661bdf7feecacbe6da5a54f1b11b9bf3edf
-  data.tar.gz: c6e896c66c7e5c4be5bb613a84307c2cff9bb872a687764a12e5c147422028bc
+  metadata.gz: f35d4f81f06174cdacefa7f2f2fe3fb898ff6d2c8b8f2d0e46aefcfd65cbba30
+  data.tar.gz: 0e0b229dc0ac7dd8bcdd3ad86b256efa3b3e3d598ca32ffb645ff831e0585013
 SHA512:
-  metadata.gz: b4aaf2b87dbb6d61a8c5710b9c8a2b239116517dc946b36c09d802021f1233fc5c906a94c9a0723536ff970e8b588481cd0501a5cf03ceae58e7c9cf62b13ded
-  data.tar.gz: c5878411cdc0255d180839c4798c6b86d438a08b466f502cbea4c2de048dcba7f77f3f0df187ff14874eb95907a2027b547add8d5667afc2bc7f300ff5c543ea
+  metadata.gz: aa508789af2d826d4484cd55ba6d683d1873f2e057012fd8db7ef5c1e4015f601be03c58e796ee8d3c57291b4ae187260456dc862862222e5b68e5311507f4f1
+  data.tar.gz: e4af651d1996f403268202a1ce27e595881ed25dc10fbfef5d354abba16d9bcc70f3461a104754e187dd9268d6549bf50c1be9cb25260f142c30882a8fb6061b

data/lib/jekyll-compose.rb

@@ -18,6 +18,6 @@ module Jekyll
   end
 end
 
-%w(draft post publish unpublish page).each do |file|
+%w(draft post publish unpublish page rename compose).each do |file|
   require File.expand_path("jekyll/commands/#{file}.rb", __dir__)
 end

data/lib/jekyll-compose/arg_parser.rb

@@ -32,6 +32,10 @@ module Jekyll
         !!options["force"]
       end
 
+      def timestamp_format
+        options["timestamp_format"] || Jekyll::Compose::DEFAULT_TIMESTAMP_FORMAT
+      end
+
       def source
         File.join(config["source"], config["collections_dir"])
           .gsub(%r!^#{Regexp.quote(Dir.pwd)}/*!, "")

data/lib/jekyll-compose/file_editor.rb

@@ -9,7 +9,7 @@
 #    auto_open: true
 # ```
 #
-# And make sure, that you have JEKYLL_EDITOR or EDITOR environment variables set up.
+# And make sure, that you have JEKYLL_EDITOR, VISUAL, or EDITOR environment variables set up.
 # This will allow to open the file in your default editor automatically.
 
 module Jekyll
@@ -34,7 +34,7 @@ module Jekyll
         def post_editor
           return unless auto_open?
 
-          ENV["JEKYLL_EDITOR"] || ENV["EDITOR"]
+          ENV["JEKYLL_EDITOR"] || ENV["VISUAL"] || ENV["EDITOR"]
         end
 
         def auto_open?

data/lib/jekyll-compose/file_info.rb

@@ -21,6 +21,12 @@ module Jekyll
 
         front_matter + "---\n"
       end
+
+      private
+
+      def front_matter_defaults_for(key)
+        params.config.dig("jekyll_compose", "default_front_matter", key)
+      end
     end
   end
 end

data/lib/jekyll-compose/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Compose
-    VERSION = "0.11.0"
+    VERSION = "0.12.0"
   end
 end

data/lib/jekyll/commands/compose.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Commands
+    class ComposeCommand < Command
+      def self.init_with_program(prog)
+        prog.command(:compose) do |c|
+          c.syntax "compose NAME"
+          c.description "Creates a new document with the given NAME"
+
+          options.each { |opt| c.option(*opt) }
+
+          c.action { |args, options| process(args, options) }
+        end
+      end
+
+      def self.options
+        [
+          ["extension", "-x EXTENSION", "--extension EXTENSION", "Specify the file extension"],
+          ["layout", "-l LAYOUT", "--layout LAYOUT", "Specify the document layout"],
+          ["force", "-f", "--force", "Overwrite a document if it already exists"],
+          ["date", "-d DATE", "--date DATE", "Specify the document date"],
+          ["collection", "-c COLLECTION", "--collection COLLECTION", "Specify the document collection"],
+          ["post", "--post", "Create a new post (default)"],
+          ["draft", "--draft", "Create a new draft"],
+          ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
+        ]
+      end
+
+      def self.process(args = [], options = {})
+        config = configuration_from_options(options)
+        params = ComposeCommandArgParser.new(args, options, config)
+        params.validate!
+
+        document = ComposeCommandFileInfo.new(params)
+
+        file_creator = Compose::FileCreator.new(document, params.force?, params.source)
+        file_creator.create!
+
+        Compose::FileEditor.bootstrap(config)
+        Compose::FileEditor.open_editor(file_creator.file_path)
+      end
+
+      class ComposeCommandArgParser < Compose::ArgParser
+        def validate!
+          if options.values_at("post", "draft", "collection").compact.length > 1
+            raise ArgumentError, "You can only specify one of --post, --draft, or --collection COLLECTION."
+          end
+
+          super
+        end
+
+        def date
+          @date ||= options["date"] ? Date.parse(options["date"]) : Time.now
+        end
+
+        def collection
+          if (coll = options["collection"])
+            coll
+          elsif options["draft"]
+            "drafts"
+          else
+            "posts"
+          end
+        end
+      end
+
+      class ComposeCommandFileInfo < Compose::FileInfo
+        def initialize(params)
+          @params = params
+          @collection = params.collection
+        end
+
+        def resource_type
+          case @collection
+          when "posts"  then "post"
+          when "drafts" then "draft"
+          else
+            "file"
+          end
+        end
+
+        def path
+          File.join("_#{@collection}", file_name)
+        end
+
+        def file_name
+          @collection == "posts" ? "#{date_stamp}-#{super}" : super
+        end
+
+        def content(custom_front_matter = {})
+          default_front_matter = front_matter_defaults_for(@collection)
+          custom_front_matter.merge!(default_front_matter) if default_front_matter.is_a?(Hash)
+
+          super({ "date" => time_stamp }.merge!(custom_front_matter))
+        end
+
+        private
+
+        def date_stamp
+          @params.date.strftime(Jekyll::Compose::DEFAULT_DATESTAMP_FORMAT)
+        end
+
+        def time_stamp
+          @params.date.strftime(Jekyll::Compose::DEFAULT_TIMESTAMP_FORMAT)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/commands/draft.rb

@@ -8,9 +8,9 @@ module Jekyll
           c.syntax "draft NAME"
           c.description "Creates a new draft post with the given NAME"
 
-          options.each { |opt| c.option *opt }
+          options.each { |opt| c.option(*opt) }
 
-          c.action { |args, options| process args, options }
+          c.action { |args, options| process(args, options) }
         end
       end
 
@@ -20,16 +20,15 @@ module Jekyll
           ["layout", "-l LAYOUT", "--layout LAYOUT", "Specify the draft layout"],
           ["force", "-f", "--force", "Overwrite a draft if it already exists"],
           ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
-          ["source", "-s", "--source SOURCE", "Custom source directory"],
         ]
       end
 
       def self.process(args = [], options = {})
         config = configuration_from_options(options)
-        params = Compose::ArgParser.new args, options, config
+        params = Compose::ArgParser.new(args, options, config)
         params.validate!
 
-        draft = DraftFileInfo.new params
+        draft = DraftFileInfo.new(params)
 
         file_creator = Compose::FileCreator.new(draft, params.force?, params.source)
         file_creator.create!
@@ -48,7 +47,7 @@ module Jekyll
         end
 
         def content(custom_front_matter = {})
-          default_front_matter = params.config.dig("jekyll_compose", "draft_default_front_matter")
+          default_front_matter = front_matter_defaults_for("drafts")
           custom_front_matter.merge!(default_front_matter) if default_front_matter.is_a?(Hash)
 
           super(custom_front_matter)

data/lib/jekyll/commands/page.rb

@@ -8,9 +8,9 @@ module Jekyll
           c.syntax "page NAME"
           c.description "Creates a new page with the given NAME"
 
-          options.each { |opt| c.option *opt }
+          options.each { |opt| c.option(*opt) }
 
-          c.action { |args, options| process args, options }
+          c.action { |args, options| process(args, options) }
         end
       end
 
@@ -20,16 +20,15 @@ module Jekyll
           ["layout", "-l LAYOUT", "--layout LAYOUT", "Specify the page layout"],
           ["force", "-f", "--force", "Overwrite a page if it already exists"],
           ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
-          ["source", "-s", "--source SOURCE", "Custom source directory"],
         ]
       end
 
       def self.process(args = [], options = {})
         config = configuration_from_options(options)
-        params = PageArgParser.new args, options, config
+        params = PageArgParser.new(args, options, config)
         params.validate!
 
-        page = PageFileInfo.new params
+        page = PageFileInfo.new(params)
 
         Compose::FileCreator.new(page, params.force?, params.source).create!
       end

data/lib/jekyll/commands/post.rb

@@ -8,9 +8,9 @@ module Jekyll
           c.syntax "post NAME"
           c.description "Creates a new post with the given NAME"
 
-          options.each { |opt| c.option *opt }
+          options.each { |opt| c.option(*opt) }
 
-          c.action { |args, options| process args, options }
+          c.action { |args, options| process(args, options) }
         end
       end
 
@@ -21,16 +21,16 @@ module Jekyll
           ["force", "-f", "--force", "Overwrite a post if it already exists"],
           ["date", "-d DATE", "--date DATE", "Specify the post date"],
           ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
-          ["source", "-s", "--source SOURCE", "Custom source directory"],
+          ["timestamp_format", "--timestamp-format FORMAT", "Custom timestamp format"],
         ]
       end
 
       def self.process(args = [], options = {})
         config = configuration_from_options(options)
-        params = PostArgParser.new args, options, config
+        params = PostArgParser.new(args, options, config)
         params.validate!
 
-        post = PostFileInfo.new params
+        post = PostFileInfo.new(params)
 
         file_creator = Compose::FileCreator.new(post, params.force?, params.source)
         file_creator.create!
@@ -41,7 +41,7 @@ module Jekyll
 
       class PostArgParser < Compose::ArgParser
         def date
-          options["date"].nil? ? Time.now : Date.parse(options["date"])
+          @date ||= options["date"] ? Date.parse(options["date"]) : Time.now
         end
       end
 
@@ -63,11 +63,11 @@ module Jekyll
         end
 
         def _time_stamp
-          @params.date.strftime Jekyll::Compose::DEFAULT_TIMESTAMP_FORMAT
+          @params.date.strftime @params.timestamp_format
         end
 
         def content(custom_front_matter = {})
-          default_front_matter = params.config.dig("jekyll_compose", "post_default_front_matter")
+          default_front_matter = front_matter_defaults_for("posts")
           custom_front_matter.merge!(default_front_matter) if default_front_matter.is_a?(Hash)
 
           super({ "date" => _time_stamp }.merge(custom_front_matter))

data/lib/jekyll/commands/publish.rb

@@ -8,17 +8,21 @@ module Jekyll
           c.syntax "publish DRAFT_PATH"
           c.description "Moves a draft into the _posts directory and sets the date"
 
-          c.option "date", "-d DATE", "--date DATE", "Specify the post date"
-          c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"
-          c.option "force", "-f", "--force", "Overwrite a post if it already exists"
-          c.option "source", "-s", "--source SOURCE", "Custom source directory"
-
-          c.action do |args, options|
-            Jekyll::Commands::Publish.process(args, options)
-          end
+          options.each { |opt| c.option(*opt) }
+
+          c.action { |args, options| process(args, options) }
         end
       end
 
+      def self.options
+        [
+          ["date", "-d DATE", "--date DATE", "Specify the post date"],
+          ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
+          ["force", "-f", "--force", "Overwrite a post if it already exists"],
+          ["timestamp_format", "--timestamp-format FORMAT", "Custom timestamp format"],
+        ]
+      end
+
       def self.process(args = [], options = {})
         config = configuration_from_options(options)
         params = PublishArgParser.new args, options, config
@@ -37,7 +41,7 @@ module Jekyll
       end
 
       def date
-        options["date"].nil? ? Time.now : Date.parse(options["date"])
+        @date ||= options["date"] ? Date.parse(options["date"]) : Time.now
       end
 
       def name
@@ -61,7 +65,7 @@ module Jekyll
       end
 
       def front_matter(data)
-        data["date"] ||= params.date.strftime("%Y-%m-%d %H:%M %z")
+        data["date"] ||= params.date.strftime(params.timestamp_format)
         data
       end
     end

data/lib/jekyll/commands/rename.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Commands
+    class Rename < Command
+      def self.init_with_program(prog)
+        prog.command(:rename) do |c|
+          c.syntax "rename PATH NAME"
+          c.description "Moves a file to a given NAME and sets the title and date"
+
+          options.each { |opt| c.option(*opt) }
+
+          c.action { |args, options| process(args, options) }
+        end
+      end
+
+      def self.options
+        [
+          ["force", "-f", "--force", "Overwrite a post if it already exists"],
+          ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
+          ["date", "-d DATE", "--date DATE", "Specify the date"],
+          ["now", "--now", "Specify the date as now"],
+        ]
+      end
+
+      def self.process(args = [], options = {})
+        config = configuration_from_options(options)
+        params = RenameArgParser.new(args, options, config)
+        params.validate!
+
+        movement = RenameMovementInfo.new(params)
+
+        mover = RenameMover.new(movement, params.force?, params.source)
+        mover.move
+      end
+    end
+
+    class RenameArgParser < Compose::ArgParser
+      def validate!
+        raise ArgumentError, "You must specify current path and the new title." if args.length < 2
+
+        if options.values_at("date", "now").compact.length > 1
+          raise ArgumentError, "You can only specify one of --date DATE or --now."
+        end
+      end
+
+      def current_path
+        @current_path ||= args[0]
+      end
+
+      def path
+        File.join(source, current_path).sub(%r!\A/!, "")
+      end
+
+      def dirname
+        @dirname ||= File.dirname(current_path)
+      end
+
+      def basename
+        @basename ||= File.basename(current_path)
+      end
+
+      def title
+        @title ||= args.drop(1).join(" ")
+      end
+
+      def touch?
+        !!options["date"] || options["now"]
+      end
+
+      def date
+        @date ||= if options["now"]
+                    Time.now
+                  elsif options["date"]
+                    Date.parse(options["date"])
+                  end
+      end
+
+      def date_from_filename
+        Date.parse(Regexp.last_match(1)) if basename =~ Jekyll::Document::DATE_FILENAME_MATCHER
+      end
+
+      def post?
+        dirname == "_posts"
+      end
+
+      def draft?
+        dirname == "_drafts"
+      end
+    end
+
+    class RenameMovementInfo < Compose::FileInfo
+      attr_reader :params
+      def initialize(params)
+        @params = params
+      end
+
+      def from
+        params.path
+      end
+
+      def resource_type
+        if @params.post?
+          "post"
+        elsif @params.draft?
+          "draft"
+        else
+          "file"
+        end
+      end
+
+      def to
+        if @params.post?
+          File.join(@params.dirname, "#{date_stamp}-#{file_name}")
+        else
+          File.join(@params.dirname, file_name)
+        end
+      end
+
+      def front_matter(data)
+        data["title"] = params.title
+        data["date"] = time_stamp if @params.touch?
+        data
+      end
+
+      private
+
+      def date_stamp
+        if @params.touch?
+          @params.date.strftime Jekyll::Compose::DEFAULT_DATESTAMP_FORMAT
+        else
+          @params.date_from_filename.strftime Jekyll::Compose::DEFAULT_DATESTAMP_FORMAT
+        end
+      end
+
+      def time_stamp
+        @params.date.strftime Jekyll::Compose::DEFAULT_TIMESTAMP_FORMAT
+      end
+    end
+
+    class RenameMover < Compose::FileMover
+      def resource_type_from
+        @movement.resource_type
+      end
+      alias_method :resource_type_to, :resource_type_from
+    end
+  end
+end

data/lib/jekyll/commands/unpublish.rb

@@ -8,24 +8,27 @@ module Jekyll
           c.syntax "unpublish POST_PATH"
           c.description "Moves a post back into the _drafts directory"
 
-          c.option "config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"
-          c.option "force", "-f", "--force", "Overwrite a draft if it already exists"
-          c.option "source", "-s", "--source SOURCE", "Custom source directory"
+          options.each { |opt| c.option(*opt) }
 
-          c.action do |args, options|
-            process(args, options)
-          end
+          c.action { |args, options| process(args, options) }
         end
       end
 
+      def self.options
+        [
+          ["config", "--config CONFIG_FILE[,CONFIG_FILE2,...]", Array, "Custom configuration file"],
+          ["force", "-f", "--force", "Overwrite a draft if it already exists"],
+        ]
+      end
+
       def self.process(args = [], options = {})
         config = configuration_from_options(options)
-        params = UnpublishArgParser.new args, options, config
+        params = UnpublishArgParser.new(args, options, config)
         params.validate!
 
-        movement = PostMovementInfo.new params
+        movement = PostMovementInfo.new(params)
 
-        mover = PostMover.new movement, params.force?, params.source
+        mover = PostMover.new(movement, params.force?, params.source)
         mover.move
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-compose
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -101,10 +101,12 @@ files:
 - lib/jekyll-compose/file_mover.rb
 - lib/jekyll-compose/movement_arg_parser.rb
 - lib/jekyll-compose/version.rb
+- lib/jekyll/commands/compose.rb
 - lib/jekyll/commands/draft.rb
 - lib/jekyll/commands/page.rb
 - lib/jekyll/commands/post.rb
 - lib/jekyll/commands/publish.rb
+- lib/jekyll/commands/rename.rb
 - lib/jekyll/commands/unpublish.rb
 homepage: https://github.com/jekyll/jekyll-compose
 licenses:
@@ -118,14 +120,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Streamline your writing in Jekyll with these commands.