hyde-decap 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 119633369fb206009d1dd12a167aef53e238e673ed5626d1d60004a251e961d7
+  data.tar.gz: 9e51474833f9230f55a3fbb36cbfe1aebe4e6a81ace1741cb4aa07e70c147e71
+SHA512:
+  metadata.gz: 416b16fa1aa019a5208dffe2d275f9fb9d167a0bf6307d176cd4a2a492681fcbb8902af9a9c084e2d8c14ab8a83a61467e8241fd104554eb3e5ed080f2da65ae
+  data.tar.gz: a93e38465858b70ba3c323e1606d55f495a5968fc6db61ade28223311b0904c13a3c883459643841aa61b264bffc3f61630060b4f03aa53f9c6042bbe9b43f98

data/lib/hyde_decap/generated_file.rb

@@ -0,0 +1,33 @@
+module Hyde
+  # Alternative class for jekyll's static files
+  # this allows the creation of files without a source file
+
+  class GeneratedFile < Jekyll::StaticFile
+    attr_accessor :file_contents
+    attr_reader :generator
+
+    def initialize(site, dir, name)
+      @site = site
+      @dir  = dir
+      @name = name
+      @relative_path = File.join(*[@dir, @name].compact)
+      @extname = File.extname(@name)
+      @type = @collection&.label&.to_sym
+      @generator = 'hyde_fonts'
+    end
+
+    def write(dest)
+      dest_path = destination(dest)
+      return false if File.exist?(dest_path)
+
+      FileUtils.mkdir_p(File.dirname(dest_path))
+      FileUtils.rm(dest_path) if File.exist?(dest_path)
+
+      File.open(dest_path, 'w') do |output_file|
+        output_file << file_contents
+      end
+
+      true
+    end
+  end
+end

data/lib/hyde_decap/hyde_decap.rb

@@ -0,0 +1,179 @@
+require 'jekyll'
+require 'yaml'
+require 'open3'
+require_relative 'generated_file.rb'
+
+module Jekyll
+  class HydeDecapGenerator < Generator
+    def generate(site)
+      Hyde::Decap.new(site).generate()
+    end
+  end
+
+  module Commands
+    class Decap < Command
+      class << self
+        # command options should mirror from `jekyll serve`
+        COMMAND_OPTIONS = {
+          "ssl_cert"             => ["--ssl-cert [CERT]", "X.509 (SSL) certificate."],
+          "host"                 => ["host", "-H", "--host [HOST]", "Host to bind to"],
+          "open_url"             => ["-o", "--open-url", "Launch your site in a browser"],
+          "detach"               => ["-B", "--detach",
+                                     "Run the server in the background",],
+          "ssl_key"              => ["--ssl-key [KEY]", "X.509 (SSL) Private Key."],
+          "port"                 => ["-P", "--port [PORT]", "Port to listen on"],
+          "show_dir_listing"     => ["--show-dir-listing",
+                                     "Show a directory listing instead of loading " \
+                                     "your index file.",],
+          "skip_initial_build"   => ["skip_initial_build", "--skip-initial-build",
+                                     "Skips the initial site build which occurs before " \
+                                     "the server is started.",],
+          "livereload"           => ["-l", "--livereload",
+                                     "Use LiveReload to automatically refresh browsers",],
+          "livereload_ignore"    => ["--livereload-ignore ignore GLOB1[,GLOB2[,...]]",
+                                     Array,
+                                     "Files for LiveReload to ignore. " \
+                                     "Remember to quote the values so your shell " \
+                                     "won't expand them",],
+          "livereload_min_delay" => ["--livereload-min-delay [SECONDS]",
+                                     "Minimum reload delay",],
+          "livereload_max_delay" => ["--livereload-max-delay [SECONDS]",
+                                     "Maximum reload delay",],
+          "livereload_port"      => ["--livereload-port [PORT]", Integer,
+                                     "Port for LiveReload to listen on",],
+        }.freeze
+
+        LIVERELOAD_PORT = 35_729
+        LIVERELOAD_DIR = File.join(__dir__, "serve", "livereload_assets")
+
+        def init_with_program(prog)
+          prog.command(:decap) do |c|
+            c.description "Serve your site locally while running Decap CMS"
+            c.syntax "decap [options]"
+            c.alias :decap
+            c.alias :d
+
+            COMMAND_OPTIONS.each do |key, val|
+              c.option key, *val
+            end
+
+            c.action do |args, options|
+              # need to convert options to flags
+              flags = options.map do |key, value|
+                if value == true
+                  "--#{key}"
+                else
+                  "--#{key} #{value}"
+                end
+              end
+
+              # TODO replace netlify-cms-proxy-server with decap version when released
+              cmd = "trap 'kill %1; kill %2; exit;' SIGINT SIGTERM;"
+              cmd += " jekyll serve #{flags.join(' ')} & npx netlify-cms-proxy-server"
+
+              begin
+                Hyde::Utils::Subprocess.new cmd do |stdout, stderr, thread|
+                  unless stdout.nil?
+                    stdout_filtered = stdout.inspect.gsub('"\e[32m', '').gsub('\e[39m', '').gsub('\n"', '').chomp
+
+                    if stdout_filtered.start_with?("info")
+                      Jekyll.logger.info "Decap CMS:", stdout_filtered
+                    else
+                      puts stdout
+                    end
+                  end
+                  puts stderr unless stderr.nil?
+                end
+              rescue => e
+                puts e
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+module Hyde
+  class Decap
+    @@config = {
+      "file_output_path" => 'admin',
+      "enable" => true,
+      "keep_files" => true
+    }
+
+    def initialize(site)
+      @site = site
+      @config = site.config.dig('hyde_decap')
+
+      @config = @@config.merge(@site.config.dig('hyde_decap') || {})
+
+      if config('keep_files') == true
+        @site.config['keep_files'].push(config('file_output_path'))
+      end
+
+      if site.config.dig('hyde_decap').nil?
+        @site.config['hyde_decap'] = @config
+      end
+    end
+
+    def generate
+      return unless config('enable') == true
+
+      # create new index.html file
+      html_file = Hyde::GeneratedFile.new(@site, config('file_output_path'), 'index.html')
+      html_file.file_contents = File.read(File.join(File.dirname(__FILE__), 'index.html'))
+      @site.static_files << html_file
+
+      # create new config.yml file
+      config_file = Hyde::GeneratedFile.new(@site, config('file_output_path'), 'config.yml')
+      config_file.file_contents = @config.to_yaml
+      @site.static_files << config_file
+    end
+
+    private
+
+    def config(*keys)
+      @config.dig(*keys)
+    end
+  end
+
+  # copied from http://stackoverflow.com/a/1162850/83386
+  # credit to [ehsanul](https://stackoverflow.com/users/127219/ehsanul)
+  # and [funroll](https://stackoverflow.com/users/878969/funroll)
+  module Utils
+    class Subprocess
+      def initialize(cmd, &block)
+        Open3.popen3(cmd) do |stdin, stdout, stderr, thread|
+          trap("INT") {
+            Jekyll.logger.info "Decap:", "shutting down server and Decap CMS Proxy"
+            thread.exit
+          }
+
+          # read each stream from a new thread
+          { :out => stdout, :err => stderr }.each do |key, stream|
+            Thread.new do
+              begin
+                until (line = stream.gets).nil? do
+                  # yield the block depending on the stream
+                  if key == :out
+                    yield line, nil, thread if block_given?
+                  else
+                    yield nil, line, thread if block_given?
+                  end
+                end
+              rescue IOError => e
+                if e.message != 'stream closed in another thread'
+                  raise e
+                end
+              end
+            end
+          end
+
+          thread.join # don't exit until the external process is done
+        end
+      end
+    end
+  end
+end

data/lib/hyde_decap/index.html

@@ -0,0 +1,16 @@
+<!DOCTYPE html>
+<html>
+
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+  <meta name="robots" content="noindex" />
+  <title>Content Manager</title>
+	<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/hithismani/responsive-decap@main/dist/responsive.min.css">
+</head>
+
+<body>
+  <!-- Include the script that builds the page and powers Decap CMS -->
+	<script src="https://unpkg.com/decap-cms@^3.0.0/dist/decap-cms.js"></script>
+</body>
+</html>

data/lib/hyde_decap.rb

@@ -0,0 +1,8 @@
+module Hyde
+  class Decap
+    VERSION = "0.1.0"
+  end
+end
+
+require_relative './hyde_decap/hyde_decap.rb'
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: hyde-decap
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gregory Daynes
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Hyde Decap is a plugin for Jekyll to add Decap CMS.
+email: email@gregdaynes.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/hyde_decap.rb
+- lib/hyde_decap/generated_file.rb
+- lib/hyde_decap/hyde_decap.rb
+- lib/hyde_decap/index.html
+homepage: https://github.com/gregdaynes/hyde-decap
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Plugin for jekyll to add Decap CMS
+test_files: []