middleman-fragment-caching 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffc78947b5a87f058bb631153f83be941d833700
+  data.tar.gz: bc7f80cc5cc2a445bb04377a2f30a433fbeebdb5
+SHA512:
+  metadata.gz: e9a8320c179ef2b207ca3eaf8859f0a6f9dc9ff46738a802d7441b4a67a7590716ef1dd8a55651a9e95f12a80fd2c02935df2eafa43de03e59bceb499f564f8c
+  data.tar.gz: 1aa55aeb9339e0388166fb8d99f4618b9527dc44d26678fc8521fe90df2c5062c2fb897dcf4ebbb29dd7a745fb3ac2aa908ea6b84b6a7627eb9d1f88c5e18a46

data/.gitignore

@@ -0,0 +1,11 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+# Ignore tmp folder
+/tmp
+
+# Ignore gems
+*.gem

data/.rspec

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

data/Gemfile

@@ -0,0 +1,18 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-fragmnent-cache.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+he MIT License (MIT)
+
+Copyright (c) 2015 Orgânica Digital
+
+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,51 @@
+
+# Middleman Fragment Caching
+
+A Middleman fragment caching extension like Rails.
+
+## Purpose
+
+When we need build many pages, fragment caching can decrease the build time.
+
+## Instalation
+
+Add this line on Gemfile:
+
+```ruby
+gem 'middleman-fragment-caching', '~> 1.0'
+```
+
+Run bundler:
+
+```
+$ bundle
+```
+
+## Usage
+
+Activate the extension, adding the folling code on `config.rb`
+
+```ruby
+activate :middleman_fragment_caching
+```
+
+On your app views:
+
+```ruby
+<%= fragment_cache('my_key') do %>
+  ... some expensive content
+<% end %>
+
+<% fragment_cache('my_key', 'some_version', 123) do %>
+  ... other expensive content
+<% end %>
+```
+
+Clear all cache:
+
+```
+$ rm -r tmp/cache
+```
+
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rake/clean'
+
+task test: ['spec']
+
+task default: :test

data/lib/middleman-fragment-caching.rb

@@ -0,0 +1,8 @@
+require 'middleman-core'
+require 'middleman/fragment_caching/moneta'
+require 'middleman/fragment_caching/cache'
+
+::Middleman::Extensions.register(:middleman_fragment_caching) do
+  require 'middleman/fragment_caching/extension'
+  ::Middleman::FragmentCaching::Extension
+end

data/lib/middleman/fragment_caching/cache.rb

@@ -0,0 +1,65 @@
+require 'singleton'
+require 'set'
+require 'moneta'
+
+module Middleman
+  module FragmentCaching
+    # Cache management
+    class Cache
+      class << self
+        def dir
+          @dir ||= File.expand_path('tmp/cache').tap do |path|
+            FileUtils.mkdir_p(path)
+          end
+        end
+
+        def store
+          @store ||= create_store(:File, dir: dir)
+        end
+
+        # Creates a store
+        # @return [Moneta] store instance
+        def create_store(kind, options = {})
+          Moneta.new(kind, options)
+        end
+      end
+
+      include Singleton
+
+      def store
+        self.class.store
+      end
+
+      def stored_keys
+        @stored_keys ||= Set.new
+      end
+
+      def find_or_set(key, &block)
+        key = key.to_s
+
+        if !key.empty? && store.key?(key)
+          content = store[key]
+        else
+          content = block.call
+          store[key] = content unless key.empty?
+        end
+
+        stored_keys << key unless key.empty?
+
+        content
+      end
+
+      def expires_keys
+        store.keys - stored_keys.to_a
+      end
+
+      def clear!
+        expires_keys.each do |key|
+          store.delete key
+        end
+
+        stored_keys.clear
+      end
+    end
+  end
+end

data/lib/middleman/fragment_caching/extension.rb

@@ -0,0 +1,19 @@
+module Middleman
+  module FragmentCaching
+    class Extension < ::Middleman::Extension
+      def after_build(_)
+        Cache.instance.clear!
+      end
+
+      helpers do
+        def fragment_cache(*keys, &block)
+          content = Cache.instance.find_or_set(keys.join('_')) do
+            capture_html(&block)
+          end
+
+          concat_content content
+        end
+      end
+    end
+  end
+end

data/lib/middleman/fragment_caching/moneta.rb

@@ -0,0 +1,20 @@
+require 'moneta'
+
+module Moneta
+  # Add Moneta keys list support
+  class Proxy
+    def keys
+      adapter.keys
+    end
+  end
+
+  module Adapters
+    class File
+      def keys
+        Dir.entries(@dir).reject do |e|
+          %w(. .. .DS_Store).include?(e)
+        end
+      end
+    end
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-fragment-caching'

data/middleman-fragment-caching.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-fragment-caching'
+  s.version     = '0.0.1'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Orgânica Digital']
+  s.email       = %w(alessandro@organicadigital.com)
+  s.homepage    = 'http://organicadigital.com'
+  s.summary     = 'A Middleman fragment caching extension like Rails'
+  s.description = s.summary
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+
+  s.add_runtime_dependency 'middleman-core', '>= 3.3.0'
+  s.add_runtime_dependency 'moneta', '~> 0.7.20'
+
+  s.add_development_dependency 'rspec', '>= 3.3.0'
+  s.add_development_dependency 'rubocop'
+  s.add_development_dependency 'pry-meta'
+end

data/spec/cache_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe Middleman::FragmentCaching::Cache do
+  before(:each) { described_class.instance.clear! }
+
+  describe '.store' do
+    it 'is a Moneta file adapter instance' do
+      expect(described_class.store.adapter).to be_a(Moneta::Adapters::File)
+    end
+
+    it 'stores a value' do
+      described_class.store['foo'] = 'bar'
+      expect(described_class.store['foo']).to be_eql('bar')
+    end
+
+    it 'removes a value' do
+      described_class.store['foo'] = 'bar'
+      expect(described_class.store['foo']).to be_eql('bar')
+
+      described_class.store.delete :foo
+      expect(described_class.store[:foo]).to be_nil
+    end
+
+    it 'return ordered stored keys' do
+      described_class.store.clear
+
+      described_class.store['foo'] = 'bar'
+      described_class.store['baz'] = 'foo'
+
+      expect(described_class.store.keys).to be_eql(%w(baz foo))
+    end
+  end
+
+  describe '#find_or_set' do
+    subject { described_class.instance }
+
+    it 'caches the key / value' do
+      result = subject.find_or_set(:foo) { 'bar' }
+      expect(result).to be_eql('bar')
+
+      result = subject.find_or_set(:foo) { 'other bar' }
+      expect(result).to be_eql('bar')
+    end
+
+    it 'don\'t caches when the key is blank' do
+      result = subject.find_or_set('') { 'bar' }
+      expect(result).to be_eql('bar')
+
+      result = subject.find_or_set(:foo) { 'other bar' }
+      expect(result).to be_eql('bar')
+    end
+  end
+
+  describe '#stored_keys' do
+    subject { described_class.instance }
+
+    it 'keeps accessed keys' do
+      expect(subject.stored_keys).to be_empty
+
+      subject.find_or_set(:foo) {}
+      subject.find_or_set(:bar) {}
+      subject.find_or_set(:bar) {}
+      expect(subject.stored_keys.to_a).to be_eql(%w(foo bar))
+    end
+  end
+
+  describe '#clear' do
+    subject { described_class.instance }
+
+    it 'remove only unusable keys' do
+      subject.store.clear
+      subject.stored_keys.clear
+
+      subject.store['foo'] = 'bar'
+      subject.find_or_set(:baz) { 'foo' }
+
+      expect(subject.expires_keys).to be_eql(['foo'])
+
+      subject.clear!
+
+      expect(subject.store['foo']).to be_nil
+      expect(subject.store['baz']).to be_eql('foo')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'middleman-fragment-caching'

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: middleman-fragment-caching
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Orgânica Digital
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.20
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.20
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Middleman fragment caching extension like Rails
+email:
+- alessandro@organicadigital.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubcop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/middleman-fragment-caching.rb
+- lib/middleman/fragment_caching/cache.rb
+- lib/middleman/fragment_caching/extension.rb
+- lib/middleman/fragment_caching/moneta.rb
+- lib/middleman_extension.rb
+- middleman-fragment-caching.gemspec
+- spec/cache_spec.rb
+- spec/spec_helper.rb
+homepage: http://organicadigital.com
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A Middleman fragment caching extension like Rails
+test_files: []
+has_rdoc: