archival 0.0.8 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d3848687ae065595e19f5b75bb50927318e81df6d6b878541b2ef44138f9d31
-  data.tar.gz: 7a48ab3c689dcbb886f2441216750729ec892e40d6dc0a39197fba17eb9c4ab2
+  metadata.gz: c44af9438c108896c1e5c3f6577708a150525305045a5e0bd183700b49f20234
+  data.tar.gz: 4033a7f2b80d88eab1d4071552398716f1592b6c07ec34acc00d36613d30f49b
 SHA512:
-  metadata.gz: '039d5ae09373d249e90fd850e7bd68970ae5ad3c394ed452016e4acaca4df5063d1aab818a09f9a365af9e3277b777257c27d2c4cc365b7d8daafcb33842e8a3'
-  data.tar.gz: 6246274ed1209a20819616480c7a1ffde1422b1a68bf5e728a3b637e61ac8675e2bc8fafa8a003cedac455e11ca21e5f22ef9039de96d95f1fc5dcab0f93111b
+  metadata.gz: ddad0158c303b58e247f6e974dc22ef0967936c113afa7f090a9302cd4cd890512f58b2136b0aabecec6ddfc8ae29c242a0f8ee7a2842734241c783942820792
+  data.tar.gz: ef1663df39febc76cf51af9eedfcf106db95712bf8f96d51e76e94e8daa4bd0a5d9133e0e2971e696a74add29bb4f3214da3a13d400b0711e64861678c753571

data/.rubocop.yml

@@ -30,7 +30,7 @@ Metrics/BlockLength:
   Max: 150
 
 Metrics/ClassLength:
-  Max: 200
+  Max: 250
 
 Metrics/CyclomaticComplexity:
   Max: 10

data/README.md

@@ -53,6 +53,18 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+To point a local archival site at a local version, run inside the website dir:
+
+```
+bundle config local.archival /path/to/local/git/repository
+```
+
+Then comment out the archival dependency in Gemfile and add:
+
+```
+gem 'archival', github: 'jesseditson/archival', branch: 'main'
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jesseditson/archival.

data/archival.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = 'archival'
-  s.version     = '0.0.8'
+  s.version     = '0.0.11'
   s.summary     = 'An incredibly simple CMS for durable websites'
   s.description = 'https://jesseditson.com/the-simplest-cms-part-1'
   s.authors     = ['Jesse Ditson']

data/bin/bundle

@@ -73,7 +73,7 @@ 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.rubygems_version < Gem::Version.new("2.7.0")
 
     requirement += ".a" if bundler_gem_version.prerelease?
 

data/lib/archival/builder.rb

@@ -3,17 +3,23 @@
 require 'liquid'
 require 'tomlrb'
 require 'redcarpet'
+require 'fileutils'
+require 'tags/asset'
 
 module Archival
   class DuplicateKeyError < StandardError
   end
 
+  class DuplicateStaticFileError < StandardError
+  end
+
   class Builder
     attr_reader :page_templates
 
     def initialize(config, *_args)
       @config = config
       refresh_config
+      Asset.helper_port = @config.helper_port
     end
 
     def pages_dir
@@ -221,14 +227,40 @@ module Archival
       # in dev, they will be copied as they change.
       @config.assets_dirs.each do |asset_dir|
         asset_path = File.join(@config.build_dir, asset_dir)
-        next if @config.dev_mode || !File.exist?(asset_path)
+        next if @config.dev_mode && File.exist?(asset_path)
+
+        source_path = File.join(@config.root, asset_dir)
+        next unless File.exist?(source_path)
 
-        FileUtils.copy_entry File.join(@config.root, asset_dir), asset_path
+        FileUtils.copy_entry source_path, asset_path
       end
+
+      copy_static
     end
 
     private
 
+    def copy_static
+      static_dir = File.join(@config.root, @config.static_dir)
+
+      # same for the static dir, but just the content.
+      return unless File.exist?(static_dir)
+
+      copied_static_files = Set[Dir.children(@config.build_dir)]
+      Dir.children(static_dir).each do |child|
+        raise DuplicateStaticFileError if copied_static_files.include?(child)
+
+        copied_static_files << child
+        asset_path = File.join(@config.build_dir, child)
+        next if @config.dev_mode && File.exist?(asset_path)
+
+        source_path = File.join(static_dir, child)
+        next unless File.exist?(source_path)
+
+        FileUtils.copy_entry source_path, asset_path
+      end
+    end
+
     def dev_mode_content
       "<script src=\"http://localhost:#{@config.helper_port}/js/archival-helper.js\" type=\"application/javascript\"></script>" # rubocop:disable Layout/LineLength
     end

data/lib/archival/config.rb

@@ -4,8 +4,8 @@ require 'tomlrb'
 
 module Archival
   class Config
-    attr_reader :pages_dir, :objects_dir, :assets_dirs, :root, :build_dir,
-                :helper_port, :dev_mode
+    attr_reader :pages_dir, :objects_dir, :static_dir, :assets_dirs, :root,
+                :build_dir, :helper_port, :dev_mode
 
     def initialize(config = {})
       @root = config['root'] || Dir.pwd
@@ -17,6 +17,7 @@ module Archival
       )
       @helper_port = config['helper_port'] || manifest['helper_port'] || 2701
       @assets_dirs = config['assets_dirs'] || manifest['assets'] || []
+      @static_dir = config['static_dir'] || manifest['static'] || 'static'
       @dev_mode = config[:dev_mode] || false
     end
 

data/lib/archival/helper_server.rb

@@ -44,16 +44,23 @@ module Archival
     MAGIC_GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
 
     def handle_request(client, req, method, path)
-      if method == 'GET' && path.start_with?('/js/')
-        # For static paths, just serve the files they refer to.
+      if method == 'GET' && path.start_with?('/js/archival-helper.js')
+        # For this special file, serve it from the helper dir
         http_response(client, type: 'application/javascript') do
-          serve_static(client, path)
+          serve_static(client, path, @helper_dir)
         end
         client.close
       elsif (matches = req.match(/^Sec-WebSocket-Key: (\S+)/))
         websocket_key = matches[1]
         # puts "Websocket handshake detected with key: #{websocket_key}"
         connect_socket(client, websocket_key)
+      elsif method == 'GET'
+        # For static paths, just serve the files they refer to.
+        # TODO: mime type should be inferred from file type
+        http_response(client, type: 'application/javascript') do
+          serve_static(client, path)
+        end
+        client.close
       else
         client.close
       end
@@ -99,8 +106,9 @@ module Archival
 
       # Our server only supports single-frame, text messages.
       # Raise an exception if the client tries to send anything else.
-      raise "We don't support continuations" unless fin
-      raise 'We only support opcode 1' unless opcode == 1
+      raise 'Archival dev server does not support continuations' unless fin
+      # Some browsers send this regardless, so ignore it to keep the noise down.
+      return unless opcode == 1
 
       second_byte = @socket.getbyte
       is_masked = second_byte & 0b10000000
@@ -119,15 +127,17 @@ module Archival
       #   warn "Payload size: #{payload_size} bytes"
 
       mask = 4.times.map { @socket.getbyte }
-      #   warn "Got mask: #{mask.inspect}"
+      # warn "Got mask: #{mask.inspect}"
 
       data = payload_size.times.map { @socket.getbyte }
-      #   warn "Got masked data: #{data.inspect}"
+      # warn "Got masked data: #{data.inspect}"
+
+      return unless data[0]
 
       unmasked_data = data.each_with_index.map do |byte, i|
         byte ^ mask[i % 4]
       end
-      #   warn "Unmasked the data: #{unmasked_data.inspect}"
+      # warn "Unmasked the data: #{unmasked_data.inspect}"
 
       unmasked_data.pack('C*').force_encoding('utf-8')
     end
@@ -139,8 +149,8 @@ module Archival
       @socket.write output.pack("CCA#{message.size}")
     end
 
-    def serve_static(client, path)
-      buffer = File.open(File.join(@helper_dir, path)).read
+    def serve_static(client, path, base = @build_dir)
+      buffer = File.open(File.join(base, path)).read
       buffer.sub! '$PORT', @port.to_s
       client.print buffer
     end
@@ -150,6 +160,7 @@ module Archival
       type = config[:type] ||= 'text/html'
       client.print "HTTP/1.1 #{status}\r\n"
       client.print "Content-Type: #{type}\r\n"
+      client.print "Access-Control-Allow-Origin: *\r\n"
       client.print "\r\n"
       yield
     end

data/lib/archival/listen.rb

@@ -72,6 +72,11 @@ module Archival
       @config.assets_dirs.each do |dir|
         return :assets if child?(File.join(@config.root, dir), file)
       end
+
+      # a static file was changed - copy or delete those too.
+      return :assets if child?(File.join(@config.root, @config.static_dir),
+                               file)
+
       # other special files
       return :layout if child?(File.join(@config.root, 'layout'), file)
       return :config if ['manifest.toml',
@@ -89,6 +94,8 @@ module Archival
         end
         builder.update_assets(changes[:assets]) if changes[:assets].length
         if changes[:assets].length || changes[:layouts] || changes[:config]
+          # TODO: optimization: this could operate on the known subset of
+          # changes instead...
           builder.full_rebuild
         end
         builder.write_all

data/lib/archival/markdown_renderer.rb

@@ -4,7 +4,7 @@ require 'redcarpet'
 
 module Archival
   class MarkdownRenderer < Redcarpet::Render::HTML
-    def autolink(link, _link_type, _opts)
+    def autolink(link, _opts)
       # TODO: handle link_type?
       "<a href=\"#{rewrite_link(link)}\">#{rewrite_link(link)}</a>"
     end

data/lib/archival/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Archival
-  VERSION = '0.0.8'
+  VERSION = '0.0.11'
 end

data/lib/tags/asset.rb

@@ -14,7 +14,7 @@ class Asset < Liquid::Tag
 
   prepend Liquid::Tag::Disableable
 
-  SYNTAX = /(#{Liquid::QuotedFragment}+)/o.freeze
+  SYNTAX = /(#{Liquid::QuotedFragment}+|\w+)/o.freeze
 
   def initialize(tag_name, markup, tokens)
     super
@@ -24,13 +24,25 @@ class Asset < Liquid::Tag
     # This is defaulted to the pages dir, because it represents the structure
     # of our website. Asset directories are copied as siblings at runtime.
     @@root_dir ||= File.join(Dir.pwd, 'pages')
+
+    @attributes = {}
+
+    markup.scan(Liquid::TagAttributes) do |key, value|
+      @attributes[key] = parse_expression(value)
+    end
   end
 
   def self.root_dir=(dir)
     @@root_dir = dir
   end
 
+  def self.helper_port=(port)
+    @@helper_port = port
+  end
+
   def render_to_output_buffer(context, output)
+    path = @path
+    path = path.evaluate(context) if path.is_a? Liquid::VariableLookup
     unless @@root_dir
       raise AssetError,
             'root_dir must be set on Archival::Asset'
@@ -41,8 +53,13 @@ class Asset < Liquid::Tag
             'template_path must be provided to parse when using assets'
     end
     template_path = File.dirname(context['template_path'])
-    abs_asset_path = Pathname.new(File.join(@@root_dir, @path))
-    output << abs_asset_path.relative_path_from(template_path).to_s
+    abs_asset_path = Pathname.new(File.join(@@root_dir, path))
+    asset_path = abs_asset_path.relative_path_from(template_path).cleanpath.to_s
+    output << if @attributes['serve'] == true
+                "http://localhost:#{@@helper_port}/#{asset_path}"
+              else
+                asset_path
+              end
     output
   end
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "archival",
-  "version": "0.0.8",
+  "version": "0.0.11",
   "description": "An incredibly simple CMS for durable websites",
   "bin": "build.rb",
   "directories": {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: archival
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.11
 platform: ruby
 authors:
 - Jesse Ditson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-22 00:00:00.000000000 Z
+date: 2022-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: An incredibly simple CMS for durable websites