jekyll-admin 0.8.0 → 0.10.2

data/lib/jekyll-admin/data_file.rb

@@ -1,103 +1,106 @@
-module JekyllAdmin
-  class DataFile
-    METHODS_FOR_LIQUID = %w(path relative_path slug ext title).freeze
-    EXTENSIONS = %w(yaml yml json csv).freeze
-
-    include APIable
-    include URLable
-    include PathHelper
-    extend PathHelper
-
-    attr_reader :id
-
-    # Initialize a new DataFile object
-    #
-    # id - the file ID as passed from the API. This may or may not have an extension
-    def initialize(id)
-      @id ||= File.extname(id).empty? ? "#{id}.yml" : id
-    end
-    alias_method :relative_path, :id
-
-    def exists?
-      @exists ||= File.exist?(absolute_path)
-    end
-
-    # Returns unparsed content as it exists on disk
-    def raw_content
-      @raw_content ||= File.open(absolute_path, "r:UTF-8", &:read)
-    end
-
-    # Returnes (re)parsed content using Jekyll's native parsing mechanism
-    def content
-      @content ||= data_reader.read_data_file(absolute_path)
-    end
-
-    # Returns the file's extension with preceeding `.`
-    def ext
-      @ext ||= if File.extname(id).to_s.empty?
-                 ".yml"
-               else
-                 File.extname(id)
-               end
-    end
-    alias_method :extension, :ext
-
-    # Returns the file's sanitized slug (as used in `site.data[slug]`)
-    def slug
-      @slug ||= data_reader.sanitize_filename(basename)
-    end
-
-    # Returns the human-readable title of the data file
-    def title
-      @title ||= Jekyll::Utils.titleize_slug(slug.tr("_", "-"))
-    end
-
-    # Returns path relative to site source
-    def path
-      ensure_leading_slash(File.join(DataFile.data_dir, relative_path))
-    end
-
-    def absolute_path
-      sanitized_path(path)
-    end
-    alias_method :file_path, :absolute_path
-
-    # Mimics Jekyll's native to_liquid functionality by returning a hash
-    # of data file metadata
-    def to_liquid
-      @to_liquid ||= METHODS_FOR_LIQUID.map { |key| [key, public_send(key)] }.to_h
-    end
-
-    def self.all
-      data_dir = Jekyll.sanitized_path(JekyllAdmin.site.source, DataFile.data_dir)
-      data_dir = Pathname.new(data_dir)
-      Dir["#{data_dir}/**/*.{#{EXTENSIONS.join(",")}}"].map do |path|
-        new(Pathname.new(path).relative_path_from(data_dir).to_s)
-      end
-    end
-
-    # Relative path to data directory within site source
-    def self.data_dir
-      JekyllAdmin.site.config["data_dir"]
-    end
-
-    private
-
-    def data_reader
-      @data_reader = Jekyll::DataReader.new(JekyllAdmin.site)
-    end
-
-    def basename
-      @basename ||= File.basename(id, ".*")
-    end
-
-    def basename_with_extension
-      [basename, extension].join
-    end
-    alias_method :filename, :basename_with_extension
-
-    def namespace
-      "data"
-    end
-  end
-end
+# frozen_string_literal: true
+
+module JekyllAdmin
+  class DataFile
+    METHODS_FOR_LIQUID = %w(name path relative_path slug ext title).freeze
+    EXTENSIONS = %w(yaml yml json csv).freeze
+
+    include APIable
+    include URLable
+    include PathHelper
+    extend PathHelper
+
+    attr_reader :id, :ext
+
+    # Initialize a new DataFile object
+    #
+    # id - the file ID as passed from the API. This may or may not have an extension
+    def initialize(id)
+      extname = File.extname(id)
+      if extname.empty?
+        @id  = "#{id}.yml"
+        @ext = ".yml"
+      else
+        @id  = id
+        @ext = extname
+      end
+    end
+    alias_method :relative_path, :id
+
+    # Returns the file's extension with preceeding `.`
+    alias_method :extension, :ext
+
+    def exists?
+      @exists ||= File.exist?(absolute_path)
+    end
+
+    # Returns unparsed content as it exists on disk
+    def raw_content
+      @raw_content ||= File.open(absolute_path, "r:UTF-8", &:read)
+    end
+
+    # Returnes (re)parsed content using Jekyll's native parsing mechanism
+    def content
+      @content ||= data_reader.read_data_file(absolute_path)
+    end
+
+    # Returns the file's sanitized slug (as used in `site.data[slug]`)
+    def slug
+      @slug ||= data_reader.sanitize_filename(basename)
+    end
+
+    # Returns the human-readable title of the data file
+    def title
+      @title ||= Jekyll::Utils.titleize_slug(slug.tr("_", "-"))
+    end
+
+    # Returns path relative to site source
+    def path
+      @path ||= File.join(DataFile.data_dir, relative_path)
+    end
+
+    def absolute_path
+      sanitized_path(path)
+    end
+    alias_method :file_path, :absolute_path
+
+    # Mimics Jekyll's native to_liquid functionality by returning a hash
+    # of data file metadata
+    def to_liquid
+      @to_liquid ||= METHODS_FOR_LIQUID.map { |key| [key, public_send(key)] }.to_h
+    end
+
+    def self.all
+      data_dir = Jekyll.sanitized_path(JekyllAdmin.site.source, DataFile.data_dir)
+      data_dir = Pathname.new(data_dir)
+      Dir["#{data_dir}/**/*.{#{EXTENSIONS.join(",")}}"].map do |path|
+        new(Pathname.new(path).relative_path_from(data_dir).to_s)
+      end
+    end
+
+    # Relative path to data directory within site source
+    def self.data_dir
+      JekyllAdmin.site.config["data_dir"]
+    end
+
+    private
+
+    def data_reader
+      @data_reader = Jekyll::DataReader.new(JekyllAdmin.site)
+    end
+
+    def basename
+      @basename ||= File.basename(id, ".*")
+    end
+
+    def basename_with_extension
+      "#{basename}#{extension}"
+    end
+    alias_method :name, :basename_with_extension
+    public :name
+
+    def namespace
+      "data"
+    end
+  end
+end

data/lib/jekyll-admin/directory.rb

@@ -1,73 +1,72 @@
-module JekyllAdmin
-  class Directory
-    extend Forwardable
-    def_delegator :@path, :basename, :name
-    def_delegator :@path, :mtime, :modified_time
-    attr_reader :path, :splat, :content_type, :base
-
-    include Enumerable
-    include JekyllAdmin::URLable
-    include JekyllAdmin::APIable
-
-    TYPE = :directory
-
-    # Arguments:
-    #
-    # path - full path of the directory which its entries will be listed
-    #
-    # base - passes site.source to generate `relative_path` needed for `to_api`
-    #
-    # content_type - type of the requested directory entries, this is used to generate
-    # API endpoint of the directory along with `splat`
-    #
-    # splat - the requested directory path relative to content namespace
-    def initialize(path, base: nil, content_type: nil, splat: nil)
-      @base = Pathname.new base
-      @content_type = content_type
-      @splat = Pathname.new splat
-      @path = Pathname.new path
-    end
-
-    def to_liquid
-      {
-        :name          => name,
-        :modified_time => modified_time,
-        :path          => relative_path,
-        :type          => TYPE,
-      }
-    end
-
-    def relative_path
-      if content_type == "drafts"
-        path.relative_path_from(base).to_s.sub("_drafts/", "")
-      else
-        path.relative_path_from(base).to_s
-      end
-    end
-
-    def resource_path
-      types = %w(pages data drafts)
-      if types.include?(content_type)
-        "/#{content_type}/#{splat}/#{name}"
-      else
-        "/collections/#{content_type}/entries/#{splat}/#{name}"
-      end
-    end
-    alias_method :url, :resource_path
-
-    def http_url
-      nil
-    end
-
-    def directories
-      path.entries.map do |entry|
-        next if [".", ".."].include? entry.to_s
-        next unless path.join(entry).directory?
-        self.class.new(
-          path.join(entry),
-          :base => base, :content_type => content_type, :splat => splat
-        )
-      end.compact!
-    end
-  end
-end
+# frozen_string_literal: true
+
+module JekyllAdmin
+  class Directory
+    extend Forwardable
+    def_delegator :@path, :basename, :name
+    def_delegator :@path, :mtime, :modified_time
+    attr_reader :path, :splat, :content_type, :base
+
+    include Enumerable
+    include JekyllAdmin::URLable
+    include JekyllAdmin::APIable
+
+    RESOURCE_TYPES  = %w(pages data drafts static_files).freeze
+    DOT_DIRECTORIES = [".", ".."].freeze
+
+    private_constant :RESOURCE_TYPES, :DOT_DIRECTORIES
+
+    # Parameters:
+    #   path - The full path of the directory at which its entries will be listed.
+    #
+    # Named parameters:
+    #           base: - The full path to the directory from source.
+    #          splat: - The requested directory path relative to content namespace.
+    #   content_type: - The type of the requested directory entries. Corresponds to
+    #                   the resources' API namespace.
+    def initialize(path, base:, splat:, content_type:)
+      @path  = Pathname.new path
+      @base  = Pathname.new base
+      @splat = Pathname.new splat
+      @content_type = content_type
+    end
+
+    def to_liquid
+      {
+        "name"          => name,
+        "modified_time" => modified_time,
+        "path"          => relative_path,
+        "type"          => "directory",
+      }
+    end
+
+    def relative_path
+      @relative_path ||= path.relative_path_from(base).to_s
+    end
+
+    def resource_path
+      if RESOURCE_TYPES.include?(content_type)
+        "/#{content_type}/#{splat}/#{name}"
+      else
+        "/collections/#{content_type}/entries/#{splat}/#{name}"
+      end
+    end
+    alias_method :url, :resource_path
+
+    def http_url
+      nil
+    end
+
+    def directories
+      path.entries.map do |entry|
+        next if DOT_DIRECTORIES.include? entry.to_s
+        next unless path.join(entry).directory?
+
+        self.class.new(
+          path.join(entry),
+          :base => base, :content_type => content_type, :splat => splat
+        )
+      end.compact!
+    end
+  end
+end

data/lib/jekyll-admin/file_helper.rb

@@ -1,78 +1,91 @@
-module JekyllAdmin
-  module FileHelper
-
-    # The file the user requested in the URL
-    def requested_file
-      find_by_path(path)
-    end
-
-    # The file ultimately written to disk
-    # This may be the requested file, or in the case of a rename will be read
-    # from the new path that was actually written to disk
-    def written_file
-      find_by_path(write_path)
-    end
-
-    # Write a file to disk with the given content
-    def write_file(path, content)
-      Jekyll.logger.debug "WRITING:", path
-      path = sanitized_path(path)
-      FileUtils.mkdir_p File.dirname(path)
-      File.open(path, "wb") do |file|
-        file.write(content)
-      end
-      # we should fully process in dev mode for tests to pass
-      if ENV["RACK_ENV"] == "production"
-        site.read
-      else
-        site.process
-      end
-    end
-
-    # Delete the file at the given path
-    def delete_file(path)
-      Jekyll.logger.debug "DELETING:", path
-      FileUtils.rm_f sanitized_path(path)
-      site.process
-    end
-
-    def delete_file_without_process(path)
-      Jekyll.logger.debug "DELETING:", path
-      FileUtils.rm_f sanitized_path(path)
-    end
-
-    private
-
-    def ensure_requested_file
-      ensure_file(requested_file)
-    end
-
-    def ensure_written_file
-      ensure_file(written_file)
-    end
-
-    def find_by_path(path)
-      files = case namespace
-              when "collections"
-                collection.docs
-              when "data"
-                DataFile.all
-              when "drafts"
-                drafts
-              when "pages", "static_files"
-                site.public_send(namespace.to_sym)
-              else
-                []
-              end
-      files.find { |f| sanitized_path(f.path) == path }
-    end
-
-    def ensure_file(file)
-      render_404 if file.nil?
-    end
-
-    def ensure_directory
-      render_404 unless Dir.exist?(directory_path)
-    end
-  end
-end
+# frozen_string_literal: true
+
+module JekyllAdmin
+  module FileHelper
+    # The file the user requested in the URL
+    def requested_file
+      find_by_path(path)
+    end
+
+    # The file ultimately written to disk
+    # This may be the requested file, or in the case of a rename will be read
+    # from the new path that was actually written to disk
+    def written_file
+      find_by_path(write_path)
+    end
+
+    # Write a file to disk with the given content
+    def write_file(path, content)
+      Jekyll.logger.debug "WRITING:", path
+      path = sanitized_path(path)
+      FileUtils.mkdir_p File.dirname(path)
+      File.open(path, "wb") do |file|
+        file.write(content)
+      end
+      # we should fully process in dev mode for tests to pass
+      if ENV["RACK_ENV"] == "production"
+        site.read
+      else
+        site.process
+      end
+    end
+
+    # Delete the file at the given path
+    def delete_file(path)
+      Jekyll.logger.debug "DELETING:", path
+      FileUtils.rm_f sanitized_path(path)
+      site.process
+    end
+
+    def delete_file_without_process(path)
+      Jekyll.logger.debug "DELETING:", path
+      FileUtils.rm_f sanitized_path(path)
+    end
+
+    private
+
+    def ensure_requested_file
+      ensure_file(requested_file)
+    end
+
+    def ensure_written_file
+      ensure_file(written_file)
+    end
+
+    def ensure_not_overwriting_existing_file
+      ensure_not_file(written_file)
+    end
+
+    def find_by_path(path)
+      files = case namespace
+              when "collections"
+                collection.docs
+              when "data"
+                DataFile.all
+              when "drafts"
+                drafts
+              when "pages", "static_files"
+                site.public_send(namespace.to_sym)
+              else
+                []
+              end
+      files.find { |f| sanitized_path(f.path) == path }
+    end
+
+    def ensure_file(file)
+      render_404 if file.nil?
+    end
+
+    def ensure_not_file(file)
+      return if file.nil?
+
+      Jekyll.logger.warn "Jekyll Admin:", "Could not create file."
+      Jekyll.logger.warn "", "Path #{file.relative_path.inspect} already exists!"
+      render_404
+    end
+
+    def ensure_directory
+      render_404 unless Dir.exist?(directory_path)
+    end
+  end
+end