salli 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 daryl
+
+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,104 @@
+# Salli
+
+A Sinatra Dalli Gem for page, fragment and key value caching.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'salli'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salli
+
+## 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 Salli.
+
+~~~ruby
+class CatsAreAwesome < Sinatra::Base
+  register Sinatra::Salli
+
+  get '/' do
+    erb :index
+  end
+end
+~~~
+
+If you're using the classic structure, you'll just have to require it.
+
+~~~ruby
+require "salli"
+
+get '/' do
+  erb :index
+end
+~~~
+
+## Default settings
+
+There are a few settings
+
+~~~ruby
+# Default server
+app.set :cache_server, 'localhost:11211'
+# Cache on/off
+app.set :cache, true
+# Expiration (seconds)
+app.set :cache_expires, 600
+# Cache logging (development)
+app.set :cache_logging, true
+# Default cache environment
+app.set :cache_environment, :development
+~~~
+
+## Fragment caching
+
+Fragment caching is fairly straight forward, you can also set a custom expiry.
+
+~~~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/salli.rb

@@ -0,0 +1,30 @@
+require "salli/version"
+require "salli/helpers"
+# Salvador
+require 'dalli'
+
+module Sinatra
+  module Salli
+    def self.registered(app)
+      app.helpers Salli::Helpers
+      # Default server
+      app.set :cache_server, 'localhost:11211'
+      # Cache on/off
+      app.set :cache, true
+      # Expiration (seconds)
+      app.set :cache_expires, 600
+      # Cache logging (development)
+      app.set :cache_logging, true
+      # Default cache environment
+      app.set :cache_environment, :development
+    end
+
+    # Development logging
+    def self.log(meth, key)
+      puts (meth =~ /g/ ? 'Served: ' : 'Stored: ') << key
+    end
+  end
+
+  # Classic
+  register Salli
+end

data/lib/salli/helpers.rb

@@ -0,0 +1,102 @@
+module Sinatra
+  module Salli
+    module Helpers
+      ##
+      # Fragment cache
+      # @api public
+      def cache(nade, expires=nil, &maybe)
+        raise ArgumentError, 'No block was used' unless block_given?
+        return call_me(maybe) unless all_systems_go?
+        # Push to output buffer
+        if value = cache_get(nade)
+          buff? ? @_out_buf << value : value
+        else
+          cache_set(nade, call_me(maybe), expires)
+        end
+      end
+
+      ##
+      # Key / value
+      # @api public
+      def cache_set(key, value, expires=nil)
+        return value unless all_systems_go?
+        key = keygen(key.to_s)
+        expires ||= settings.cache_expires
+        client.set(key, Marshal.dump(value), expires)
+        Salli.log('set', key) if settings.cache_logging
+        value
+      end
+
+      ##
+      # Fetch
+      # @api public
+      def cache_get(key)
+        return nil unless all_systems_go?
+        key = keygen(key.to_s)
+        if value = client.get(key)
+          Salli.log('get', key) if settings.cache_logging
+          Marshal.load(value)
+        end
+      end
+
+      ##
+      # Delete by key
+      # @api public
+      def cache_delete(key)
+        client.delete(keygen(key.to_s)) if all_systems_go?
+      end
+
+      ##
+      # Wipe out
+      # @api public
+      def cache_flush
+        client.flush if all_systems_go?
+      end
+
+      private
+
+      ##
+      # Can we cache?
+      # @api private
+      def all_systems_go?
+        @all_systems_go ||= settings.cache && correct_nature? && client
+      end
+
+      ##
+      # Environment check
+      # @api private
+      def correct_nature?
+        @correct_nature ||= (settings.environment == settings.cache_environment)
+      end
+
+      ##
+      # Dalli client
+      # @api private
+      def client
+        @client ||= Dalli::Client.new(settings.cache_server)
+      end
+
+      ##
+      # Keygen
+      # @api private
+      def keygen(key)
+        'salli:' << request.host << ':' << key
+      end
+
+      ##
+      # Buffer?
+      # @api private
+      def buff?
+        @_out_buf
+      end
+
+      ##
+      # Call block
+      # @api private
+      def call_me(maybe)
+        tmp = maybe.call
+        buff? ? tmp[@_out_buf.length..-1] : tmp
+      end
+    end
+  end
+end

data/lib/salli/version.rb

@@ -0,0 +1,3 @@
+module Salli
+  VERSION = "0.0.1"
+end

data/salli.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salli/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "salli"
+  gem.version       = Salli::VERSION
+  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/Salli"
+
+  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 = ["lib"]
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: salli
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Daryl Ginn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-05 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/salli.rb
+- lib/salli/helpers.rb
+- lib/salli/version.rb
+- salli.gemspec
+homepage: https://github.com/daryl/Salli
+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: []