archival 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c657b6a9eef44687dc75a8c85349309433c224fc7a0871890c4c50aa955745f
-  data.tar.gz: a857f9490e10cf5aa9e49e9df1d5adbb40908dd1731d00a81b41361fb4bbcc4c
+  metadata.gz: 7403410bc5164f3be23c22494a716fe7af6d6e805fc38ddb12c920bed918dba7
+  data.tar.gz: ebb064928f3295b914609a9751c11cf663ae54af6671b655def56f5d03dab93e
 SHA512:
-  metadata.gz: 5bcf4e0b7678dc60aa1769a1afa586cbd3569a36b7d863c5fb83a7fe45e4249f6a176a411e17815c4ce41d0dc95d233f0fdaf7af640dfff81eba4851f54af387
-  data.tar.gz: 9738d2bc0bfbad7612c9ff5e225e5787691ef736824ff4a546e25bab3855c70af7cffeae2610eb486551dc8fb1f44f885223664a48e41d9bd4f0260eb45615dd
+  metadata.gz: 866d33fea5f99757f5a5a01254769ba4a1527341f0f68df03c0daeda38fc642a5177c011d18a902937b72027c2061f92efb0eddea765eae295b520c562188f74
+  data.tar.gz: 802638fe184d75b2596bfbb378e02fe8de985bfdda46463dcba009937493faef442c65280307a7d3d25fd3ecbc762584846d305f3e7ceb2cf4bf4949cfe5d057

data/.rubocop.yml

@@ -1,14 +1,17 @@
+inherit_mode:
+    merge:
+      - Exclude
+
 AllCops:
   NewCops: enable
   SuggestExtensions: false
   Exclude:
-    - bin/bundle
+    - bin/*
 
 Layout/LineLength:
   Max: 80
   Exclude:
     - archival.gemspec
-    - bin/*
     - spec/spec_helper.rb
 
 Layout/TrailingWhitespace:
@@ -29,6 +32,18 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 150
 
+Metrics/CyclomaticComplexity:
+  Max: 10
+  Exclude:
+    # This file does a lot of defaulting. It's easy to read.
+    - lib/archival/config.rb
+
+Metrics/PerceivedComplexity:
+  Max: 10
+  Exclude:
+    # This file does a lot of defaulting. It's easy to read.
+    - lib/archival/config.rb
+
 Lint/ImplicitStringConcatenation:
   Exclude:
     - spec/tags/layout_spec.rb

data/Rakefile

@@ -10,3 +10,4 @@ RuboCop::RakeTask.new
 
 task default: :spec
 task lint: :rubocop
+task 'lint:fix': 'rubocop:auto_correct'

data/archival.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'archival'
-  s.version     = '0.0.2'
+  s.version     = '0.0.7'
   s.summary     = 'An incredibly simple CMS for durable websites'
   s.description = 'https://jesseditson.com/the-simplest-cms-part-1'
   s.authors     = ['Jesse Ditson']
@@ -24,5 +24,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'liquid', '~> 5.1.0'
   s.add_dependency 'listen', '~> 3.7.0'
+  s.add_dependency 'redcarpet', '~> 3.5.1'
   s.add_dependency 'tomlrb', '~> 2.0.1'
 end

data/bin/archival

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('archival', 'archival')
+load Gem.bin_path("archival", "archival")

data/bin/bundle

@@ -8,46 +8,46 @@
 # this file is here to facilitate running it.
 #
 
-require 'rubygems'
+require "rubygems"
 
 m = Module.new do
   module_function
 
   def invoked_as_script?
-    File.expand_path($PROGRAM_NAME) == File.expand_path(__FILE__)
+    File.expand_path($0) == File.expand_path(__FILE__)
   end
 
   def env_var_version
-    ENV['BUNDLER_VERSION']
+    ENV["BUNDLER_VERSION"]
   end
 
   def cli_arg_version
     return unless invoked_as_script? # don't want to hijack other binstubs
-    return unless 'update'.start_with?(ARGV.first || ' ') # must be running `bundle update`
-
+    return unless "update".start_with?(ARGV.first || " ") # must be running `bundle update`
     bundler_version = nil
     update_index = nil
     ARGV.each_with_index do |a, i|
-      bundler_version = a if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+      if update_index && update_index.succ == i && a =~ Gem::Version::ANCHORED_VERSION_PATTERN
+        bundler_version = a
+      end
       next unless a =~ /\A--bundler(?:[= ](#{Gem::Version::VERSION_PATTERN}))?\z/
-
-      bundler_version = Regexp.last_match(1)
+      bundler_version = $1
       update_index = i
     end
     bundler_version
   end
 
   def gemfile
-    gemfile = ENV['BUNDLE_GEMFILE']
+    gemfile = ENV["BUNDLE_GEMFILE"]
     return gemfile if gemfile && !gemfile.empty?
 
-    File.expand_path('../Gemfile', __dir__)
+    File.expand_path("../../Gemfile", __FILE__)
   end
 
   def lockfile
     lockfile =
       case File.basename(gemfile)
-      when 'gems.rb' then gemfile.sub(/\.rb$/, gemfile)
+      when "gems.rb" then gemfile.sub(/\.rb$/, gemfile)
       else "#{gemfile}.lock"
       end
     File.expand_path(lockfile)
@@ -55,17 +55,15 @@ m = Module.new do
 
   def lockfile_version
     return unless File.file?(lockfile)
-
     lockfile_contents = File.read(lockfile)
     return unless lockfile_contents =~ /\n\nBUNDLED WITH\n\s{2,}(#{Gem::Version::VERSION_PATTERN})\n/
-
     Regexp.last_match(1)
   end
 
   def bundler_requirement
     @bundler_requirement ||=
       env_var_version || cli_arg_version ||
-      bundler_requirement_for(lockfile_version)
+        bundler_requirement_for(lockfile_version)
   end
 
   def bundler_requirement_for(version)
@@ -75,32 +73,28 @@ m = Module.new do
 
     requirement = bundler_gem_version.approximate_recommendation
 
-    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new('2.7.0')
+    return requirement unless Gem::Version.new(Gem::VERSION) < Gem::Version.new("2.7.0")
 
-    requirement += '.a' if bundler_gem_version.prerelease?
+    requirement += ".a" if bundler_gem_version.prerelease?
 
     requirement
   end
 
   def load_bundler!
-    ENV['BUNDLE_GEMFILE'] ||= gemfile
+    ENV["BUNDLE_GEMFILE"] ||= gemfile
 
     activate_bundler
   end
 
   def activate_bundler
     gem_error = activation_error_handling do
-      gem 'bundler', bundler_requirement
+      gem "bundler", bundler_requirement
     end
     return if gem_error.nil?
-
     require_error = activation_error_handling do
-      require 'bundler/version'
-    end
-    if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
-      return
+      require "bundler/version"
     end
-
+    return if require_error.nil? && Gem::Requirement.new(bundler_requirement).satisfied_by?(Gem::Version.new(Bundler::VERSION))
     warn "Activating bundler (#{bundler_requirement}) failed:\n#{gem_error.message}\n\nTo install the version of bundler this project requires, run `gem install bundler -v '#{bundler_requirement}'`"
     exit 42
   end
@@ -115,4 +109,6 @@ end
 
 m.load_bundler!
 
-load Gem.bin_path('bundler', 'bundle') if m.invoked_as_script?
+if m.invoked_as_script?
+  load Gem.bin_path("bundler", "bundle")
+end

data/bin/htmldiff

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('diff-lcs', 'htmldiff')
+load Gem.bin_path("diff-lcs", "htmldiff")

data/bin/ldiff

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('diff-lcs', 'ldiff')
+load Gem.bin_path("diff-lcs", "ldiff")

data/bin/listen

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('listen', 'listen')
+load Gem.bin_path("listen", "listen")

data/bin/rake

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('rake', 'rake')
+load Gem.bin_path("rake", "rake")

data/bin/redcarpet

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'redcarpet' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("redcarpet", "redcarpet")

data/bin/rspec

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('rspec-core', 'rspec')
+load Gem.bin_path("rspec-core", "rspec")

data/bin/rubocop

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('rubocop', 'rubocop')
+load Gem.bin_path("rubocop", "rubocop")

data/bin/ruby-parse

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('parser', 'ruby-parse')
+load Gem.bin_path("parser", "ruby-parse")

data/bin/ruby-rewrite

@@ -8,16 +8,14 @@
 # this file is here to facilitate running it.
 #
 
-require 'pathname'
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
-                                           Pathname.new(__FILE__).realpath)
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
 
-bundle_binstub = File.expand_path('bundle',
-                                  __dir__)
+bundle_binstub = File.expand_path("../bundle", __FILE__)
 
 if File.file?(bundle_binstub)
-  if File.read(bundle_binstub,
-               300) =~ /This file was generated by Bundler/
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
     load(bundle_binstub)
   else
     abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
@@ -25,7 +23,7 @@ Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this
   end
 end
 
-require 'rubygems'
-require 'bundler/setup'
+require "rubygems"
+require "bundler/setup"
 
-load Gem.bin_path('parser', 'ruby-rewrite')
+load Gem.bin_path("parser", "ruby-rewrite")

data/exe/archival

@@ -19,17 +19,13 @@ build_dir = Dir.pwd
 
 case command
 when 'build'
-  builder = Archival::Builder.new('root' => build_dir)
-  builder.write_all
-when 'run'
-  Archival.listen(build_dir)
-  begin
-    sleep
-  rescue Interrupt
-    # Don't print a stack when a user interrupts, as this is the right way to
-    # stop the development server.
-    puts ''
+  Archival::Logger.benchmark('built') do
+    config = Archival::Config.new('root' => build_dir)
+    builder = Archival::Builder.new(config)
+    builder.write_all
   end
+when 'run'
+  Archival.listen('root' => build_dir)
 else
   # print help
   puts 'archival [command]'

data/helper/js/archival-helper.js

@@ -0,0 +1,91 @@
+/**
+ * When running archival in development mode (archival run), this file is
+ * injected into all pages, and is responsible for reloading the page when the
+ * source has changed.
+ */
+
+(function () {
+  const remotePort = $PORT;
+  const CONNECTING_COLOR = "#bd270d";
+  const CONNECTED_COLOR = "#19bd0d";
+  const CHECK_INTERVAL = 500;
+  const DISCONNECTED_INTERVAL = 1000;
+  const connectionDot = document.createElement("div");
+  connectionDot.style = `position: absolute; z-index: 9999; bottom: 10px; right: 10px; background-color: ${CONNECTING_COLOR}; width: 15px; height: 15px; border-radius: 50%; opacity: 0.8;`;
+  connectionDot.setAttribute("title", "Archival Dev Server: Connecting");
+  connectionDot.addEventListener(
+    "mouseenter",
+    () => (connectionDot.style.opacity = 0.2)
+  );
+  connectionDot.addEventListener(
+    "mouseleave",
+    () => (connectionDot.style.opacity = 0.8)
+  );
+
+  let lastContact = -1;
+  let isConnecting = false;
+  let connection;
+
+  function connectionLoop() {
+    connection.send(`page:${window.location.pathname}`);
+    if (Date.now() - lastContact > DISCONNECTED_INTERVAL) {
+      setConnected(false);
+      connectSocket();
+    }
+    setTimeout(connectionLoop, CHECK_INTERVAL);
+  }
+
+  function setConnected(connected) {
+    connectionDot.style.backgroundColor = connected
+      ? CONNECTED_COLOR
+      : CONNECTING_COLOR;
+    connectionDot.setAttribute(
+      "title",
+      `Archival Dev Server: ${connected ? "Connected" : "Disconnected"}`
+    );
+  }
+
+  window.onload = () => {
+    connectSocket(true);
+  };
+
+  function connectSocket(init) {
+    if (isConnecting) {
+      return;
+    }
+    isConnecting = true;
+    console.log(
+      `${init ? "connecting" : "reconnecting"} to archival dev server...`
+    );
+    document.body.appendChild(connectionDot);
+    connection = new WebSocket(`ws://localhost:${remotePort}`);
+    connection.onerror = () => {
+      isConnecting = false;
+    };
+
+    connection.onopen = () => {
+      isConnecting = false;
+      connection.send("connected");
+      if (init) {
+        connectionLoop();
+      }
+    };
+    connection.onmessage = (event) => {
+      lastContact = Date.now();
+      switch (event.data) {
+        case "ready":
+          console.log("connected to archival dev server.");
+          break;
+        case "ok":
+          setConnected(true);
+          break;
+        case "refresh":
+          window.location.reload();
+          break;
+        default:
+          console.log(`receieved unexpected message ${event.data}`);
+          break;
+      }
+    };
+  }
+})();