middleman-caching-proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cefacd267c25aa55daa8c3aab6adba286294d201
+  data.tar.gz: b02aa54ec0e117b924dedf78d0647d994f1d3d4e
+SHA512:
+  metadata.gz: dc4feea092dfe37bf0067a8faf6bd5d5f9289c305c6f10570d4f5e421083a8b0326c448b3bd38c9df79e39a5347de28350670b14e2717515a296d3c4e3414999
+  data.tar.gz: 24be5f3a39fa8d3d8e10b5f3b27a1d27c83f747bd16996a818a123509fa61951479ad5eeceaf83b2377d2daf9767eb8acf1151e9906bdb256fc31b3c4d6ede0f

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at joe.g.yates@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Joe Yates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# Middleman::Caching::Proxy
+
+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
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-caching-proxy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-caching-proxy
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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.
+
+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.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "middleman/caching/proxy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/middleman-caching-proxy.rb

@@ -0,0 +1 @@
+require "middleman/caching_proxy"

data/lib/middleman/caching_proxy.rb

@@ -0,0 +1,179 @@
+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
+
+  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)

data/lib/middleman/caching_proxy/version.rb

@@ -0,0 +1,7 @@
+module Middleman; end
+
+module Middleman
+  module CachingProxy
+    VERSION = "0.1.0"
+  end
+end

data/middleman-caching-proxy.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman/caching_proxy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "middleman-caching-proxy"
+  spec.version       = Middleman::CachingProxy::VERSION
+  spec.authors       = ["Joe Yates"]
+  spec.email         = ["joe.g.yates@gmail.com"]
+
+  spec.summary       = %q{Speed up Middleman builds via a cache}
+  spec.description   = %q{Keeps a cache of proxy pages and uses the cached copy if the proxied object hasn't changed}
+  spec.homepage      = "https://github.com/joeyates/middleman-caching-proxy"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "middleman", ">= 3.0.0", "< 4.0.0"
+  spec.add_runtime_dependency "semantic"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/spec/middleman/caching/proxy_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Middleman::Caching::Proxy 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

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

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: middleman-caching-proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joe Yates
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: semantic
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Keeps a cache of proxy pages and uses the cached copy if the proxied
+  object hasn't changed
+email:
+- joe.g.yates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/middleman-caching-proxy.rb
+- lib/middleman/caching_proxy.rb
+- lib/middleman/caching_proxy/version.rb
+- middleman-caching-proxy.gemspec
+- spec/middleman/caching/proxy_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/joeyates/middleman-caching-proxy
+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: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Speed up Middleman builds via a cache
+test_files: []