sinatralli 0.0.2

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Daryl Ginn
+
+MIT License
+
+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,124 @@
+# Sinatralli
+
+A Sinatra Dalli Gem for page, fragment and key value caching.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatralli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatralli
+
+## Dependencies
+
+This gem uses [Dalli](https://github.com/mperham/dalli), a high performance memcached client for Ruby.
+
+## Getting started
+
+If you're using a modern structure, you'll have to register Sinatralli.
+
+~~~ruby
+class CatsAreAwesome < Sinatra::Base
+  register Sinatra::Sinatralli
+
+  get '/' do
+    erb :index
+  end
+end
+~~~
+
+If you're using the classic structure, you'll just have to require it.
+
+~~~ruby
+require "sinatralli"
+
+get '/' do
+  erb :index
+end
+~~~
+
+## Default settings
+
+There are a few settings
+
+~~~ruby
+# Default cache server
+set :cache_server, 'localhost:11211'
+# Enable cache
+set :cache_enabled, true
+# Default environment
+set :cache_environment, :production
+# Default expires
+set :cache_expires, 600
+# Minify the page output
+set :cache_minify_pages, true
+# Cache pages
+set :cache_pages, true
+# Cache logging
+set :cache_logging, true
+~~~
+
+## Page caching
+
+Page caching is enabled by default, you can turn off all page caching by setting `:cache_pages` to `false`.
+
+Cache key: `_sd_page_sitename.com/path_bar`
+
+You can also overide default settings for a specific page.
+
+~~~ruby
+get '/foo' do
+  erb :bar, cache: false, expires: 10, minify: false
+end
+~~~
+
+## Fragment caching
+
+Fragment caching is fairly straight forward, you can also set a custom expiry.
+
+Cache key: `_sd_frag_sitename.com/path_bar`
+
+~~~erb
+<% cache 'bar', expires: 300 do %>
+  ...
+<% end %>
+~~~
+
+## Key value caching
+
+Store an item simple, there are 3 parameters: __key__, __value__ & __expires__
+
+~~~ruby
+cache_set('key', 'your value', 300)
+~~~
+
+To retretive an item, you just specify the key:
+
+~~~ruby
+cache_get('key')
+~~~
+
+## Delete cache
+
+Delete an item by key:
+
+~~~ruby
+cache_delete('key')
+~~~
+
+Flush all cache:
+
+~~~ruby
+cache_flush
+~~~
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sinatra/templates.rb

@@ -0,0 +1,81 @@
+module Sinatra
+  module Templates
+    def render(engine, data, options={}, locals={}, &block)
+      # DRY
+      def get_setting(key, default)
+        settings.respond_to?(key) ? settings.send(key) : default
+      end
+
+      # Minification
+      def minify_output(content)
+        content.gsub(/^\s*\/\/.+$|<!--(.*?)-->|\t|\n|\r/, '')
+      end
+
+      # Cache output
+      def cache_output(key, content, opts)
+        content = minify_output(content) if settings.cache_minify_pages && opts[:minify]
+        expires = opts[:expires] ? opts[:expires] : settings.cache_expires
+        puts key
+        output  = cache_set(key, content, expires)
+      end
+
+      # merge app-level options
+      engine_options  = get_setting(engine, {})
+      options         = engine_options.merge(options)
+
+      # extract generic options
+      locals          = options.delete(:locals) || locals         || {}
+      views           = options.delete(:views)  || settings.views || "./views"
+      layout          = options.delete(:layout)
+      eat_errors      = layout.nil?
+      layout          = engine_options[:layout] if layout.nil? or layout == true
+      layout          = @default_layout         if layout.nil? or layout == true
+      content_type    = options.delete(:content_type)  || options.delete(:default_content_type)
+      layout_engine   = options.delete(:layout_engine) || engine
+      scope           = options.delete(:scope)         || self
+
+      # set some defaults
+      options[:outvar]           ||= '@_out_buf'
+      options[:default_encoding] ||= settings.default_encoding
+
+      # Cache defaults
+      options =
+      {
+        cache: true,
+        minify: true,
+        expires: false
+      }.merge!(options)
+
+      sd_do_cache = settings.cache_enabled && (settings.environment == settings.cache_environment)
+      sd_do_cache = sd_do_cache && settings.cache_pages && options[:cache]
+      sd_page_key = "_sinatralli_page_#{request.host + request.path_info.gsub(/^\//, '')}_#{data.to_s}"
+
+      # compile and render template
+      begin
+        layout_was      = @default_layout
+        @default_layout = false
+        template        = compile_template(engine, data, options, views)
+        output          = template.render(scope, locals, &block)
+      ensure
+        @default_layout = layout_was
+      end
+
+      # render layout
+      if layout
+        # Fetch the copy
+        if sd_do_cache
+          cached = cache_get(sd_page_key)
+          return cached unless cached.nil?
+        end
+        options = options.merge(:views => views, :layout => false, :eat_errors => eat_errors, :scope => scope)
+        catch(:layout_missing) {
+          output = render(layout_engine, layout, options, locals) { output }
+          return sd_do_cache ? cache_output(sd_page_key, output, options) : output
+        }
+      end
+
+      output.extend(ContentTyped).content_type = content_type if content_type
+      sd_do_cache ? cache_output(sd_page_key, output, options) : output
+    end
+  end
+end

data/lib/sinatralli.rb

@@ -0,0 +1,79 @@
+require 'sinatra/templates'
+require 'dalli'
+
+module Sinatra
+  module Sinatralli
+    module Helpers
+      def cache(key, opts={}, &block)
+        return call_fragment(block) unless cache_enabled
+        key = "_sinatralli_frag_#{request.host + request.path_info.gsub(/^\//, '')}_#{key.to_s}"
+        if cache = cache_get(key)
+          @_out_buf << cache
+        else
+          cache_set(key, call_fragment(block), opts[:expires])
+        end
+      end
+
+      def cache_set(key, value, expires=nil)
+        return value unless cache_enabled
+        expires ||= settings.cache_expires
+        dalli.set(key, Marshal.dump(value), expires)
+        puts "SET: #{key}" if settings.cache_logging
+        value
+      end
+
+      def cache_get(key)
+        return nil unless cache_enabled
+        cache = dalli.get(key)
+        if cache
+          puts "GET: #{key}" if settings.cache_logging
+          return Marshal.load(cache)
+        end
+      end
+
+      def cache_delete(key)
+        dalli.delete(key) if cache_enabled
+      end
+
+      def cache_flush
+        dalli.flush if cache_enabled
+      end
+
+      private
+
+      def dalli
+        @_sd_dalli ||= Dalli::Client.new(settings.cache_server)
+      end
+
+      def cache_enabled
+        @_sd_cache_enabled ||= settings.cache_enabled && (settings.environment == settings.cache_environment)
+      end
+
+      def call_fragment(block)
+        obl = @_out_buf.length
+        tmp = block.call
+        tmp[obl..-1]
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Sinatralli::Helpers
+
+      # Default server
+      app.set :cache_server, 'localhost:11211'
+      # Enable cache
+      app.set :cache_enabled, true
+      # Default environment
+      app.set :cache_environment, :production
+      # Default expires
+      app.set :cache_expires, 600
+      # Minify the page output
+      app.set :cache_minify_pages, true
+      # Cache pages
+      app.set :cache_pages, true
+      # Cache logging
+      app.set :cache_logging, true
+    end
+  end
+  register Sinatralli
+end

data/sinatralli.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.name          = "sinatralli"
+  gem.version       = "0.0.2"
+  gem.authors       = ["Daryl Ginn"]
+  gem.email         = ["me@daryl.im"]
+  gem.description   = %q{A Sinatra Dalli Gem for page, fragment and key value caching.}
+  gem.summary       = %q{A Sinatra Dalli Gem for page, fragment and key value caching.}
+  gem.homepage      = "https://github.com/daryl/Sinatralli"
+
+  gem.add_dependency 'dalli'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = %w{lib}
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: sinatralli
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Daryl Ginn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Sinatra Dalli Gem for page, fragment and key value caching.
+email:
+- me@daryl.im
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/sinatra/.DS_Store
+- lib/sinatra/templates.rb
+- lib/sinatralli.rb
+- sinatralli.gemspec
+homepage: https://github.com/daryl/Sinatralli
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Sinatra Dalli Gem for page, fragment and key value caching.
+test_files: []