jekyll-compose 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ca9572a408add00659eda3cf8a665db468237f764891adc47e99e12402d189d
-  data.tar.gz: a93e1531716af74a8c3cf3b014654c32d84cca05a6261613c29b7e4ff0a82ed1
+  metadata.gz: f9995b4922a0106ef44e69e728eec77c84c8aed6bc7d3aac7e010f22b6793f45
+  data.tar.gz: 02361f4e0b266ceffefeedcd9878b4722d2506bf254a15676f5f506ee4b5dcb7
 SHA512:
-  metadata.gz: e6791215e2abbcd23e6e9a83e8fa0002e2f3d6a1f9326655b30bd674d937a1b76d655a8ccfc3963da80cd81afa82a1c15e7b69ac2cdd83f0fdb9ce93b3933561
-  data.tar.gz: ecfc55570fbae9dd1d71940ec0a7019c25497f445118c3fd4973ef42b1d318f6dfa600d6c835aad364393cb0dfff9de0d4bee430698aaf6d3ab2693dec8fd451
+  metadata.gz: 6fac7f63a40345d1ea77a85a2d2416a7acca893c4b70286b80dcc5e98ba09f0f5528dd8a1262b684275d7fbde09d6206d573414516c2f98544d5f0f65fb9968b
+  data.tar.gz: c7987e77b4b08d12bb5ffbe5ec181016079d494912a901d2b1187dfc0a6a087de10fa17f17f389ec32d03fe4e71a414d56fe20e55c9c5717bd895271936ba685

data/lib/jekyll-compose.rb

@@ -10,9 +10,11 @@ require "jekyll-compose/file_editor"
 
 module Jekyll
   module Compose
-    DEFAULT_TYPE = "md".freeze
-    DEFAULT_LAYOUT = "post".freeze
-    DEFAULT_LAYOUT_PAGE = "page".freeze
+    DEFAULT_TYPE = "md"
+    DEFAULT_LAYOUT = "post"
+    DEFAULT_LAYOUT_PAGE = "page"
+    DEFAULT_DATESTAMP_FORMAT = "%Y-%m-%d"
+    DEFAULT_TIMESTAMP_FORMAT = "%Y-%m-%d %H:%M %z"
   end
 end
 

data/lib/jekyll-compose/arg_parser.rb

@@ -1,34 +1,41 @@
 # frozen_string_literal: true
 
-class Jekyll::Compose::ArgParser
-  attr_reader :args, :options, :config
-  def initialize(args, options)
-    @args = args
-    @options = options
-    @config = Jekyll.configuration(options)
-  end
+module Jekyll
+  module Compose
+    class ArgParser
+      attr_reader :args, :options, :config
 
-  def validate!
-    raise ArgumentError, "You must specify a name." if args.empty?
-  end
+      # TODO: Remove `nil` parameter in v1.0
+      def initialize(args, options, config = nil)
+        @args = args
+        @options = options
+        @config = config || Jekyll.configuration(options)
+      end
 
-  def type
-    options["extension"] || Jekyll::Compose::DEFAULT_TYPE
-  end
+      def validate!
+        raise ArgumentError, "You must specify a name." if args.empty?
+      end
 
-  def layout
-    options["layout"] || Jekyll::Compose::DEFAULT_LAYOUT
-  end
+      def type
+        options["extension"] || Jekyll::Compose::DEFAULT_TYPE
+      end
 
-  def title
-    args.join " "
-  end
+      def layout
+        options["layout"] || Jekyll::Compose::DEFAULT_LAYOUT
+      end
 
-  def force?
-    !!options["force"]
-  end
+      def title
+        args.join " "
+      end
+
+      def force?
+        !!options["force"]
+      end
 
-  def source
-    config["source"].gsub(%r!^#{Regexp.quote(Dir.pwd)}!, "")
+      def source
+        File.join(config["source"], config["collections_dir"])
+          .gsub(%r!^#{Regexp.quote(Dir.pwd)}/*!, "")
+      end
+    end
   end
 end

data/lib/jekyll-compose/file_creator.rb

@@ -11,25 +11,31 @@ module Jekyll
       end
 
       def create!
-        validate_should_write!
+        return unless create?
+
         ensure_directory_exists
         write_file
       end
 
       def file_path
         return file.path if root.nil? || root.empty?
-        return File.join(root, file.path)
+
+        File.join(root, file.path)
       end
 
       private
 
-      def validate_should_write!
-        raise ArgumentError, "A #{file.resource_type} already exists at #{file_path}" if File.exist?(file_path) && !force
+      def create?
+        return true if force
+        return true unless File.exist?(file_path)
+
+        Jekyll.logger.warn "A #{file.resource_type} already exists at #{file_path}"
+        false
       end
 
       def ensure_directory_exists
         dir = File.dirname file_path
-        Dir.mkdir(dir) unless Dir.exist?(dir)
+        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
       end
 
       def write_file
@@ -37,7 +43,7 @@ module Jekyll
           f.puts(file.content)
         end
 
-        puts "New #{file.resource_type} created at #{file_path}."
+        Jekyll.logger.info "New #{file.resource_type} created at #{file_path.cyan}"
       end
     end
   end

data/lib/jekyll-compose/file_editor.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 #
 # This class is aimed to open the created file in the selected editor.
 # To use this feature specify at Jekyll config:
@@ -15,6 +16,13 @@ module Jekyll
   module Compose
     class FileEditor
       class << self
+        attr_reader  :compose_config
+        alias_method :jekyll_compose_config, :compose_config
+
+        def bootstrap(config)
+          @compose_config = config["jekyll_compose"] || {}
+        end
+
         def open_editor(filepath)
           run_editor(post_editor, File.expand_path(filepath)) if post_editor
         end
@@ -25,18 +33,14 @@ module Jekyll
 
         def post_editor
           return unless auto_open?
-          ENV['JEKYLL_EDITOR'] || ENV['EDITOR']
-        end
 
-        def auto_open?
-          jekyll_compose_config && jekyll_compose_config['auto_open']
+          ENV["JEKYLL_EDITOR"] || ENV["EDITOR"]
         end
 
-        def jekyll_compose_config
-          @jekyll_compose_config ||= Jekyll.configuration['jekyll_compose']
+        def auto_open?
+          compose_config["auto_open"]
         end
       end
     end
   end
 end
-

data/lib/jekyll-compose/file_info.rb

@@ -1,22 +1,26 @@
 # frozen_string_literal: true
 
-class Jekyll::Compose::FileInfo
-  attr_reader :params
-  def initialize(params)
-    @params = params
-  end
+module Jekyll
+  module Compose
+    class FileInfo
+      attr_reader :params
+      def initialize(params)
+        @params = params
+      end
 
-  def file_name
-    name = Jekyll::Utils.slugify params.title
-    "#{name}.#{params.type}"
-  end
+      def file_name
+        name = Jekyll::Utils.slugify params.title
+        "#{name}.#{params.type}"
+      end
 
-  def content(custom_front_matter = {})
-    front_matter = YAML.dump({
-      "layout" => params.layout,
-      "title"  => params.title,
-    }.merge(custom_front_matter))
+      def content(custom_front_matter = {})
+        front_matter = YAML.dump({
+          "layout" => params.layout,
+          "title"  => params.title,
+        }.merge(custom_front_matter))
 
-    front_matter + "---\n"
+        front_matter + "---\n"
+      end
+    end
   end
 end

data/lib/jekyll-compose/file_mover.rb

@@ -19,8 +19,8 @@ module Jekyll
       end
 
       def move
-        validate_source
-        validate_should_write!
+        return unless valid_source? && valid_destination?
+
         ensure_directory_exists
         move_file
       end
@@ -40,10 +40,29 @@ module Jekyll
 
       def move_file
         FileUtils.mv(from, to)
-        puts "#{resource_type_from.capitalize} #{from} was moved to #{to}"
+        Jekyll.logger.info "#{resource_type_from.capitalize} #{from} was moved to #{to}"
       end
 
       private
+
+      def valid_source?
+        return true if File.exist?(from)
+
+        invalidate_with "There was no #{resource_type_from} found at '#{from}'."
+      end
+
+      def valid_destination?
+        return true if force
+        return true unless File.exist?(to)
+
+        invalidate_with "A #{resource_type_to} already exists at #{to}"
+      end
+
+      def invalidate_with(msg)
+        Jekyll.logger.warn msg
+        false
+      end
+
       def from
         movement.from
       end
@@ -54,7 +73,8 @@ module Jekyll
 
       def file_path(path)
         return path if root.nil? || root.empty?
-        return File.join(root, path)
+
+        File.join(root, path)
       end
     end
   end

data/lib/jekyll-compose/movement_arg_parser.rb

@@ -3,13 +3,12 @@
 module Jekyll
   module Compose
     class MovementArgParser < ArgParser
-
       def validate!
         raise ArgumentError, "You must specify a #{resource_type} path." if args.empty?
       end
 
       def path
-        args.join " "
+        File.join(source, args.join(" ")).sub(%r!\A/!, "")
       end
     end
   end

data/lib/jekyll-compose/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Compose
-    VERSION = "0.8.0".freeze
+    VERSION = "0.9.0"
   end
 end

data/lib/jekyll/commands/draft.rb

@@ -25,12 +25,17 @@ module Jekyll
       end
 
       def self.process(args = [], options = {})
-        params = Compose::ArgParser.new args, options
+        config = configuration_from_options(options)
+        params = Compose::ArgParser.new args, options, config
         params.validate!
 
         draft = DraftFileInfo.new params
 
-        Compose::FileCreator.new(draft, params.force?, params.source).create!
+        file_creator = Compose::FileCreator.new(draft, params.force?, params.source)
+        file_creator.create!
+
+        Compose::FileEditor.bootstrap(config)
+        Compose::FileEditor.open_editor(file_creator.file_path)
       end
 
       class DraftFileInfo < Compose::FileInfo
@@ -41,6 +46,13 @@ module Jekyll
         def path
           "_drafts/#{file_name}"
         end
+
+        def content(custom_front_matter = {})
+          default_front_matter = params.config.dig("jekyll_compose", "draft_default_front_matter")
+          custom_front_matter.merge!(default_front_matter) if default_front_matter.is_a?(Hash)
+
+          super(custom_front_matter)
+        end
       end
     end
   end

data/lib/jekyll/commands/page.rb

@@ -25,7 +25,8 @@ module Jekyll
       end
 
       def self.process(args = [], options = {})
-        params = PageArgParser.new args, options
+        config = configuration_from_options(options)
+        params = PageArgParser.new args, options, config
         params.validate!
 
         page = PageFileInfo.new params

data/lib/jekyll/commands/post.rb

@@ -26,13 +26,16 @@ module Jekyll
       end
 
       def self.process(args = [], options = {})
-        params = PostArgParser.new args, options
+        config = configuration_from_options(options)
+        params = PostArgParser.new args, options, config
         params.validate!
 
         post = PostFileInfo.new params
 
         file_creator = Compose::FileCreator.new(post, params.force?, params.source)
         file_creator.create!
+
+        Compose::FileEditor.bootstrap(config)
         Compose::FileEditor.open_editor(file_creator.file_path)
       end
 
@@ -56,14 +59,17 @@ module Jekyll
         end
 
         def _date_stamp
-          @params.date.strftime "%Y-%m-%d"
+          @params.date.strftime Jekyll::Compose::DEFAULT_DATESTAMP_FORMAT
         end
 
         def _time_stamp
-          @params.date.strftime("%Y-%m-%d %H:%M %z")
+          @params.date.strftime Jekyll::Compose::DEFAULT_TIMESTAMP_FORMAT
         end
 
         def content(custom_front_matter = {})
+          default_front_matter = params.config.dig("jekyll_compose", "post_default_front_matter")
+          custom_front_matter.merge!(default_front_matter) if default_front_matter.is_a?(Hash)
+
           super({ "date" => _time_stamp }.merge(custom_front_matter))
         end
       end

data/lib/jekyll/commands/publish.rb

@@ -20,7 +20,8 @@ module Jekyll
       end
 
       def self.process(args = [], options = {})
-        params = PublishArgParser.new args, options
+        config = configuration_from_options(options)
+        params = PublishArgParser.new args, options, config
         params.validate!
 
         movement = DraftMovementInfo.new params
@@ -55,7 +56,7 @@ module Jekyll
       end
 
       def to
-        date_stamp = params.date.strftime "%Y-%m-%d"
+        date_stamp = params.date.strftime Jekyll::Compose::DEFAULT_DATESTAMP_FORMAT
         "_posts/#{date_stamp}-#{params.name}"
       end
     end
@@ -64,6 +65,7 @@ module Jekyll
       def resource_type_from
         "draft"
       end
+
       def resource_type_to
         "post"
       end

data/lib/jekyll/commands/unpublish.rb

@@ -19,7 +19,8 @@ module Jekyll
       end
 
       def self.process(args = [], options = {})
-        params = UnpublishArgParser.new args, options
+        config = configuration_from_options(options)
+        params = UnpublishArgParser.new args, options, config
         params.validate!
 
         movement = PostMovementInfo.new params
@@ -58,6 +59,7 @@ module Jekyll
       def resource_type_from
         "post"
       end
+
       def resource_type_to
         "draft"
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-compose
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-24 00:00:00.000000000 Z
+date: 2018-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rubocop-jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.51'
+        version: '0.4'
 description: Streamline your writing in Jekyll with these commands.
 email:
 - parkrmoore@gmail.com
@@ -112,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -120,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.0.beta3
 signing_key: 
 specification_version: 4
 summary: Streamline your writing in Jekyll with these commands.