middleman-caching-proxy 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cefacd267c25aa55daa8c3aab6adba286294d201
-  data.tar.gz: b02aa54ec0e117b924dedf78d0647d994f1d3d4e
+  metadata.gz: 81c6ce51f0c02f5c109266f1a158568dcd3dfc62
+  data.tar.gz: 968b0211af2b5c69a92d92fbc47da19c0903ce89
 SHA512:
-  metadata.gz: dc4feea092dfe37bf0067a8faf6bd5d5f9289c305c6f10570d4f5e421083a8b0326c448b3bd38c9df79e39a5347de28350670b14e2717515a296d3c4e3414999
-  data.tar.gz: 24be5f3a39fa8d3d8e10b5f3b27a1d27c83f747bd16996a818a123509fa61951479ad5eeceaf83b2377d2daf9767eb8acf1151e9906bdb256fc31b3c4d6ede0f
+  metadata.gz: d612e58dc98456e7a15ac4cbe0200925bba21575ce6df8b2c237d7bbc8b543f4f668975efae5bc5bd3bdfa30cfc54a44dfb3e9a5672c894684c04777043b086b
+  data.tar.gz: 23204aae5624bc0d4a3f86248ea084fc03739de55092239782620c2267c9cc297eb0139679e1f0980e1f932b91af8ada5e1ef10a6527c98a6e6fc1b4b04acd93

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in middleman-caching-proxy.gemspec
 gemspec
+

data/README.md

@@ -1,8 +1,7 @@
-# Middleman::Caching::Proxy
+# Middleman::CachingProxy
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/middleman/caching/proxy`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Caches the result of `proxy` calls allong with the fingerprint of their inputs.
+If the inputs remain the same, uses the cached version.
 
 ## Installation
 
@@ -22,20 +21,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In `config.rb`:
+
+```ruby
+activate :caching_proxy
+
+things.each do |thing|
+  proxy_with_cache(
+    path: "/things/#{thing.slug}",
+    template: "/templates/thing_template.html",
+    proxy_options: {locals: {thing: thing}},
+    fingerprint: thing.updated_at.to_i
+  )
+end
+```
+
+There are 4 required parameters:
+
+* `path`: the page path,
+* `template`: the page template,
+* `proxy_options`: options to pass to the `proxy` invocation,
+* `fingerprint`: a value that indicates the 'version' of the item. If this
+  value changes, the cached version will be skipped and updated.
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
+You can also run `bin/console` for an interactive prompt that will allow you
+to experiment.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+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 tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/middleman-caching-proxy. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/joeyates/middleman-caching-proxy. This project is intended
+to be a safe, welcoming space for collaboration, and contributors are expected
+to adhere to the [Contributor Covenant](http://contributor-covenant.org) code
+of conduct.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).

data/lib/middleman/caching_proxy.rb

@@ -1,179 +1,7 @@
 require "middleman-core"
-require "middleman-core/sitemap/resource"
-require "semantic"
 
-class CacheItem
-  attr_reader :path
-  attr_reader :template
-  attr_reader :proxy_options
-  attr_reader :fingerprint
+require "middleman/caching_proxy/extension"
 
-  def initialize(path:, template:, proxy_options:, fingerprint:)
-    @path = path
-    @template = template
-    @proxy_options = proxy_options
-    @fingerprint = fingerprint
-  end
-end
-
-class CachedResource
-  attr_reader :path
-  attr_reader :cached_path
-  attr_reader :build_path
-
-  def initialize(path:, cached_path:, build_path:)
-    @path = path
-    @cached_path = cached_path
-    @build_path = build_path
-  end
-
-  def destination_path
-    path[1..-1]
-  end
-
-  def ext
-    ""
-  end
-
-  def ignored?
-    false # Seems to mean "actualyy include in build?"
-  end
-
-  def binary?
-    true # Seems to mean "do a binary copy or make a rack request?"
-  end
-
-  def source_file
-    cached_path
-  end
-
-  def content_type
-    "text/html"
-  end
-end
-
-class MiddlemanExtension < ::Middleman::Extension
-  option :cache_directory,
-    "tmp/proxy_cache",
-    "The directory where cache files will be stored"
-
-  if Semantic::Version.new(Middleman::VERSION).major >= 4
-    expose_to_config :proxy_with_cache
-  end
-
-  attr_reader :copy_from_cache
-  attr_reader :copy_to_cache
-
-  def initialize(app, options_hash = {}, &block)
-    super
-
-    require "fileutils"
-
-    if Semantic::Version.new(Middleman::VERSION).major <= 3
-      app.send :include, InstanceMethods
-    end
-
-    @cache_manifest = nil
-    @copy_from_cache = []
-    @copy_to_cache = []
-  end
-
-  def after_configuration
-    ensure_cache_directory
-  end
-
-  def after_build(builder)
-    copy_proxied_files_to_cache
-    File.open(cache_manifest_path, "w") do |f|
-      f.write cache.to_json
-    end
-  end
-
-  def add(item)
-    if matches_cached?(item)
-      copy_from_cache << item
-      true
-    else
-      cache[item.path] = item.fingerprint
-      copy_to_cache << item
-      false
-    end
-  end
-
-  def manipulate_resource_list(resources)
-    resources + cached_resources
-  end
-
-  module InstanceMethods
-    def proxy_with_cache(path:, template:, proxy_options:, fingerprint:)
-      item = CacheItem.new(
-        path: path,
-        template: template,
-        proxy_options: proxy_options,
-        fingerprint: fingerprint
-      )
-      will_use_cache = extensions[:caching_proxy].add(item)
-      if !will_use_cache
-        proxy item.path, item.template, item.proxy_options
-      end
-    end
-  end
-
-  private
-
-  def matches_cached?(item)
-    cached_path = cache_path(item.path)
-    exists = File.exist?(cached_path)
-    return false if !exists
-    return false if cache[item.path].nil?
-    return false if cache[item.path] != item.fingerprint
-    true
-  end
-
-  def copy_proxied_files_to_cache
-    copy_to_cache.each do |item|
-      cached_path = cache_path(item.path)
-      build = build_path(item.path)
-      cache_subdirectory = File.dirname(cached_path)
-      FileUtils.mkdir_p cache_subdirectory
-      FileUtils.cp build, cached_path
-    end
-  end
-
-  def cached_resources
-    copy_from_cache.map do |item|
-      cached_path = cache_path(item.path)
-      build = build_path(item.path)
-      CachedResource.new(
-        path: item.path, cached_path: cached_path, build_path: build
-      )
-    end
-  end
-    
-  def cache
-    return @cache_manifest if @cache_manifest
-    if File.exist?(cache_manifest_path)
-      @cache_manifest = JSON.load(File.read(cache_manifest_path))
-    else
-      @cache_manifest = {}
-    end
-  end
-
-  def cache_manifest_path
-    cache_path(".cache.json")
-  end
-
-  def cache_path(path)
-    ::File.join(options.cache_directory, path)
-  end
-
-  def build_path(path)
-    File.join("build", path)
-  end
-
-  def ensure_cache_directory
-    FileUtils.mkdir_p options.cache_directory
-  end
-end
-
-::Middleman::Extensions.register(:caching_proxy, MiddlemanExtension)
+::Middleman::Extensions.register(
+  :caching_proxy, Middleman::CachingProxy::Extension
+)

data/lib/middleman/caching_proxy/cache.rb

@@ -0,0 +1,44 @@
+require "autostruct/wrap"
+require "fileutils"
+
+require "middleman/caching_proxy/cache_manifest"
+
+class Cache
+  def initialize(path:, key:)
+    @manifest = nil
+  end
+  include Autostruct::Wrap
+
+  def has?(item)
+    cached_path = full_path(item: item)
+    return false if !::File.exist?(cached_path)
+    manifest.has?(item)
+  end
+
+  def add(item:, source:)
+    manifest.add item
+    cached_path = full_path(item: item)
+    copy_in source, cached_path
+  end
+
+  def full_path(item:)
+    ::File.join(path, "items", item.path)
+  end
+
+  def save
+    manifest.save
+  end
+
+  private
+
+  def manifest
+    @manifest ||= CacheManifest.new(path: path, key: key)
+  end
+
+  def copy_in(source, cached_path)
+    cache_subdirectory = ::File.dirname(cached_path)
+    FileUtils.mkdir_p cache_subdirectory
+
+    FileUtils.cp source, cached_path
+  end
+end

data/lib/middleman/caching_proxy/cache_item.rb

@@ -0,0 +1,6 @@
+require "autostruct/wrap"
+
+class CacheItem
+  def initialize(path:, template:, proxy_options:, fingerprint:); end
+  include Autostruct::Wrap
+end

data/lib/middleman/caching_proxy/cache_manifest.rb

@@ -0,0 +1,79 @@
+require "autostruct/wrap"
+require "fileutils"
+
+require "middleman/caching_proxy/version"
+
+class CacheManifest
+  FILENAME = ".manifest.json"
+  KEY = "key"
+  ITEMS = "items"
+  VERSION = "version"
+
+  def initialize(path:, key:)
+    @manifest = nil
+    @items = nil
+  end
+  include Autostruct::Wrap
+
+  def has?(item)
+    items[item.path] == item.fingerprint
+  end
+
+  def add(item)
+    items[item.path] = item.fingerprint
+  end
+
+  def save
+    ensure_cache_directory
+    File.open(manifest_path, "w") do |f|
+      f.write build(items: items).to_json
+    end
+  end
+
+  private 
+
+  def items
+    @items ||= manifest[ITEMS]
+  end
+
+  def manifest_path
+    ::File.join(path, FILENAME)
+  end
+
+  def manifest
+    return @manifest if @manifest
+    @manifest = build
+    if File.exist?(manifest_path)
+      from_disk = JSON.load(File.read(manifest_path))
+      if is_ok?(from_disk)
+        @manifest = from_disk
+      end
+    end
+    @manifest
+  end
+
+  def is_ok?(manifest)
+    return false if manifest.nil?
+    return false if manifest[VERSION] != version
+    # Clear cache if key changes
+    return false if manifest[KEY] != key
+    return false if !manifest[ITEMS].is_a?(Hash)
+    true
+  end
+
+  def build(items: [])
+    {
+      KEY => key,
+      ITEMS => items,
+      VERSION => version
+    }
+  end
+
+  def version
+    Middleman::CachingProxy::VERSION
+  end
+
+  def ensure_cache_directory
+    FileUtils.mkdir_p path
+  end
+end

data/lib/middleman/caching_proxy/cached_resource.rb

@@ -0,0 +1,30 @@
+require "autostruct/wrap"
+
+class CachedResource
+  def initialize(path:, cached_path:, build_path:); end
+  include Autostruct::Wrap
+
+  def destination_path
+    path[1..-1]
+  end
+
+  def ext
+    ""
+  end
+
+  def ignored?
+    false # Seems to mean "actually include in build?"
+  end
+
+  def binary?
+    true # Seems to mean "do a binary copy or make a rack request?"
+  end
+
+  def source_file
+    cached_path
+  end
+
+  def content_type
+    "text/html"
+  end
+end

data/lib/middleman/caching_proxy/extension.rb

@@ -0,0 +1,102 @@
+require "middleman-core"
+require "semantic"
+
+require "middleman/caching_proxy/cache"
+require "middleman/caching_proxy/cache_item"
+require "middleman/caching_proxy/cached_resource"
+
+class Middleman::CachingProxy::Extension < ::Middleman::Extension
+  option :cache_directory,
+    "tmp/proxy_cache",
+    "The directory where cache files will be stored"
+  option :cache_key,
+    nil,
+    "A global cache key"
+
+  if Semantic::Version.new(Middleman::VERSION).major >= 4
+    expose_to_config :proxy_with_cache
+  end
+
+  module InstanceMethods
+    def proxy_with_cache(path:, template:, proxy_options:, fingerprint:)
+      item = CacheItem.new(
+        path: path,
+        template: template,
+        proxy_options: proxy_options,
+        fingerprint: fingerprint
+      )
+      will_use_cache = extensions[:caching_proxy].add(item)
+      if !will_use_cache
+        proxy item.path, item.template, item.proxy_options
+      end
+    end
+  end
+
+  attr_reader :copy_from_cache
+  attr_reader :add_to_cache
+
+  def initialize(app, options_hash = {}, &block)
+    super
+
+    if Semantic::Version.new(Middleman::VERSION).major <= 3
+      app.send :include, InstanceMethods
+    end
+
+    if !options.cache_key
+      raise "Please supply a cache_key value"
+    end
+
+    @copy_from_cache = []
+    @add_to_cache = []
+    @cache = nil
+  end
+
+  def manipulate_resource_list(resources)
+    resources + cached_resources
+  end
+
+  def after_build(_builder)
+    copy_new_files_to_cache
+    cache.save
+  end
+
+  def add(item)
+    if cache.has?(item)
+      copy_from_cache << item
+      true
+    else
+      add_to_cache << item
+      false
+    end
+  end
+
+  private
+
+  def cache
+    @cache ||= Cache.new(path: options.cache_directory, key: options.cache_key)
+  end
+
+  def copy_new_files_to_cache
+    add_to_cache.each do |item|
+      # Handle directory_indexes extension
+      resource = app.sitemap.find_resource_by_path(item.path)
+      build_path = relative_build_path(resource.destination_path)
+      cache.add item: item, source: build_path
+    end
+  end
+
+  def cached_resources
+    copy_from_cache.map do |item|
+      cached_path = cache.full_path(item: item)
+      # TODO: Handle directory_indexes extension
+      build_path = relative_build_path(item.path)
+      CachedResource.new(
+        path: item.path, cached_path: cached_path, build_path: build_path
+      )
+    end
+  end
+
+  def relative_build_path(path)
+    File.join("build", path)
+  end
+end

data/lib/middleman/caching_proxy/version.rb

@@ -2,6 +2,6 @@ module Middleman; end
 
 module Middleman
   module CachingProxy
-    VERSION = "0.1.0"
+    VERSION = "0.1.2"
   end
 end

data/middleman-caching-proxy.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'middleman/caching_proxy/version'
+require "middleman/caching_proxy/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "middleman-caching-proxy"
@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "middleman", ">= 3.0.0", "< 4.0.0"
   spec.add_runtime_dependency "semantic"
+  spec.add_runtime_dependency "autostruct"
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/middleman/{caching/proxy_spec.rb → caching_proxy_spec.rb}

@@ -1,11 +1,7 @@
 require "spec_helper"
 
-describe Middleman::Caching::Proxy do
+describe Middleman::CachingProxy do
   it "has a version number" do
     expect(Middleman::Caching::Proxy::VERSION).not_to be nil
   end
-
-  it "does something useful" do
-    expect(false).to eq(true)
-  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,2 @@
 $LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
-require "middleman/caching/proxy"
+require "middleman/caching_proxy"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-caching-proxy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Joe Yates
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-16 00:00:00.000000000 Z
+date: 2016-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: autostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -106,9 +120,14 @@ files:
 - bin/setup
 - lib/middleman-caching-proxy.rb
 - lib/middleman/caching_proxy.rb
+- lib/middleman/caching_proxy/cache.rb
+- lib/middleman/caching_proxy/cache_item.rb
+- lib/middleman/caching_proxy/cache_manifest.rb
+- lib/middleman/caching_proxy/cached_resource.rb
+- lib/middleman/caching_proxy/extension.rb
 - lib/middleman/caching_proxy/version.rb
 - middleman-caching-proxy.gemspec
-- spec/middleman/caching/proxy_spec.rb
+- spec/middleman/caching_proxy_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/joeyates/middleman-caching-proxy
 licenses: