middleman-cache-do 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e859598b349c4104c8353743745ee6d914299264
+  data.tar.gz: bacf12b225c7f44616d7b70fe106aa2da019915d
+SHA512:
+  metadata.gz: 51b0ce6bdeade859bd9fd174a2147e4a32c9a7781374d582f2c52dd5c21b7cef511998812ad8178a936371bc0428726ba095251cdbcf56bd12de26ebf6c7c525
+  data.tar.gz: 694237f8a6dc3ac79f01a418f48122107bcea36a23da7dcc324a0da28e77703b8f2edb52cf835bc9755db6b60f2b74948cfa4339616826c83ce1b1814c65855b

data/.gitignore

@@ -0,0 +1,5 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg

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-cache-do.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/README.md

@@ -0,0 +1,52 @@
+# Middleman Cache Do
+
+Cache blocks of stuff into a memcache store. Handy for when you're making API calls between lots of builds.
+
+## Example Usage
+
+### Gemfile
+
+    gem 'dalli' # Your memcache client.
+    gem 'middleman-cache-do'
+
+
+### Install memcache locally
+
+    brew install memcache
+
+
+### .env
+
+    MEMCACHEDCLOUD_SERVERS="127.0.0.1:11211"
+    MEMCACHEDCLOUD_USERNAME=""
+    MEMCACHEDCLOUD_PASSWORD=""
+
+
+### config.rb
+
+    activate :middleman_cache_do do |config|
+      config.client = Dalli::Client.new(ENV['MEMCACHEDCLOUD_SERVERS'].split(','), {
+        username: ENV['MEMCACHEDCLOUD_USERNAME'],
+        password: ENV['MEMCACHEDCLOUD_PASSWORD'],
+        namespace: 'middleman_cache_do',
+        compress: true
+      }) if ENV['MEMCACHEDCLOUD_SERVERS']
+    end
+
+
+### In your Helpers
+
+    helpers do
+      def some_cached_method
+        app.cache 'some_method' do
+          { json: :blob } # Call your external API here.
+        end
+      end
+    end
+
+
+### In your views
+
+    <%= cache 'Some-Key' do %>
+      <!-- Some external call to an API -->
+    <% end %>

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-cache-do')

data/lib/middleman-cache-do.rb

@@ -0,0 +1,6 @@
+require "middleman-core"
+
+Middleman::Extensions.register :middleman_cache_do do
+  require 'middleman-cache-do/extension'
+  MiddlemanCacheDo::Extension
+end

data/lib/middleman-cache-do/extension.rb

@@ -0,0 +1,33 @@
+# Require core library
+require 'middleman-core'
+
+# Extension namespace
+module MiddlemanCacheDo
+  class Extension < ::Middleman::Extension
+    option :client, nil, 'Caching client for stopping to many external requests'
+    option :expiration, 10_800, 'Cache will expire after x. Defualt: 3 hours'
+
+    def initialize(app, options_hash={}, &block)
+      # Call super to build options from the options_hash
+      super
+    end
+
+    expose_to_application :cache
+    def cache(key, expiration: nil, &block)
+      expiration ||= options.expiration
+      return block if options.client.nil?
+
+      options.client.fetch(key, expiration, &block)
+    end
+
+    helpers do
+      def cache(key, expiration: nil, &block)
+        content = app.cache(key, expiration: expiration) do
+          capture_html(&block)
+        end
+
+        concat_content content
+      end
+    end
+  end
+end

data/middleman-cache-do.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-cache-do'
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Mike Rogers']
+  s.email       = ['me@mikerogers.io']
+  s.homepage    = 'https://github.com/MikeRogers0/Middleman-Cache-Do'
+  s.summary     = %q{Cache fragments of code to memcache}
+  s.description = %q{Adds a cache method to helpers and templates which helps cache blocks of expensive code}
+  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.require_paths = ['lib']
+  
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency 'middleman-core', '~> 4.2', '>= 4.2.1'
+  
+  # Additional dependencies
+  s.add_runtime_dependency 'dalli', '~> 2.7', '>= 2.7.6'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: middleman-cache-do
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Rogers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.6
+description: Adds a cache method to helpers and templates which helps cache blocks
+  of expensive code
+email:
+- me@mikerogers.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-cache-do.rb
+- lib/middleman-cache-do/extension.rb
+- middleman-cache-do.gemspec
+homepage: https://github.com/MikeRogers0/Middleman-Cache-Do
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Cache fragments of code to memcache
+test_files:
+- features/support/env.rb