redis_snippets 0.0.4 → 0.0.5

data/README.md

@@ -0,0 +1,50 @@
+# Redis Snippets
+
+## Background
+
+Easily store snippets of content in Redis.
+
+## How
+
+It's a Rails 3 engine so add redis-snippets to your Gemfile and put this in an initializer:
+
+``` ruby
+App::Application.config.redis_snippets = {
+  :connection => ::Redis::Namespace.new("my_namespace", :redis => ::Redis.new),
+  :keys => [:key1, :key2]
+}
+```
+
+You should then be able to access /admin/snippets/.
+
+In your views use helper snippet().
+
+``` ruby
+<%= snippet(:key1) %>
+```
+
+## Multi Site
+
+If you're using one app to serve multiple sites a little more configuration is necessary.
+
+``` ruby
+App::Application.config.redis_snippets = {
+  :connection => ::Redis::Namespace.new("my_namespace", :redis => ::Redis.new),
+  :multi_site => true,
+  :keys => [:key1, :key2]
+}
+```
+
+And add this method to your ApplicationController:
+
+``` ruby
+helper_method :redis_snippet_site_key
+def redis_snippet_site_key
+  request.host
+end
+```
+
+## Requirements
+
+* redis
+* redis-namespace

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/app/controllers/admin/snippets_controller.rb

@@ -1,10 +1,13 @@
 class Admin::SnippetsController < AdminController
+  include RedisSnippets::Help
+  
   def index
   end
 
   def update
     params[:snippets].each do |key, content|
-      RedisSnippets::Snippets.update(key.to_sym, params[:snippets][key])
+      raise "#{key} not in the specified keys." unless RedisSnippetsEngine.config.redis_snippets[:keys].include?(key.to_sym)
+      RedisSnippets::Snippets.update(snippet_key(key), params[:snippets][key])
     end
     
     flash[:notice] = 'Snippets updated.'

data/app/helpers/redis_snippets/snippets_helper.rb

@@ -1,12 +1,14 @@
 module RedisSnippets
   module SnippetsHelper
+    include RedisSnippets::Help
+
     def snippet_content(snippet_name)
-      RedisSnippets::Snippets.send(snippet_name)
+      RedisSnippets::Snippets.send(snippet_key(snippet_name))
     end
     
     # Return true if snippet has content.
     def snippet_has_content?(snippet_name)
-      !RedisSnippets::Snippets.send(snippet_name).blank?
+      !snippet_content(snippet_name).blank?
     end
     
     def snippet(snippet_name, classes=nil)

data/app/models/redis_snippets/snippets.rb

@@ -1,7 +1,6 @@
 class RedisSnippets::Snippets
   class << self
     def update(key, content)
-      raise "#{key} not in the specified keys." unless RedisSnippetsEngine.config.redis_snippets[:keys].include?(key)
       RedisSnippets::Redis.set("snippets:#{key}", content)
     end
 
@@ -11,7 +10,6 @@ class RedisSnippets::Snippets
 
     # Retrieve snippet.
     def method_missing(method, *args)
-      raise "#{method} not in the specified keys." unless RedisSnippetsEngine.config.redis_snippets[:keys].include?(method.to_sym)
       RedisSnippets::Redis.get("snippets:#{method}")
     end
   end

data/app/views/admin/snippets/show.html.erb

@@ -6,7 +6,7 @@
     <% RedisSnippetsEngine.config.redis_snippets[:keys].each do |key| %>
       <li>
         <%= label_tag key.to_s, key.to_s %>
-        <%= text_area_tag "snippets[#{key}]", RedisSnippets::Snippets.send(key), :cols => 120, :rows => 10 %>
+        <%= text_area_tag "snippets[#{key}]", RedisSnippets::Snippets.send(snippet_key(key)), :cols => 120, :rows => 10 %>
       </li>
     <% end -%>
     </ol>

data/lib/redis_snippets/help.rb

@@ -0,0 +1,13 @@
+module RedisSnippets
+  module Help
+    # If multi_site => true the symbol returned will have the key returned with a prefix.
+    # This prefix is defined in your application using the redis_snippet_site_key method.
+    # redis_snippet_site_key should simply return a unique string per site. For instance
+    # it could be the domain of the site.
+    def snippet_key(key)
+      s = RedisSnippetsEngine.config.redis_snippets[:multi_site] ? redis_snippet_site_key + ':' : ''
+      s << key.to_s
+      s.to_sym
+    end
+  end
+end

data/lib/redis_snippets.rb

@@ -7,3 +7,4 @@ end
 
 require 'redis_snippets/railtie'
 require 'redis_snippets/redis'
+require 'redis_snippets/help'

data/redis_snippets.gemspec

@@ -4,19 +4,19 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{redis_snippets}
-  s.version = "0.0.4"
+  s.name = "redis_snippets"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Martin Moen Wulffeld}]
-  s.date = %q{2011-07-21}
-  s.description = %q{}
-  s.email = %q{martin@wulffeld.org}
+  s.authors = ["Martin Moen Wulffeld"]
+  s.date = "2012-01-17"
+  s.description = ""
+  s.email = "martin@wulffeld.org"
   s.extra_rdoc_files = [
-    "README"
+    "README.md"
   ]
   s.files = [
-    "README",
+    "README.md",
     "Rakefile",
     "VERSION",
     "app/controllers/admin/snippets_controller.rb",
@@ -25,13 +25,14 @@ Gem::Specification.new do |s|
     "app/views/admin/snippets/show.html.erb",
     "config/routes.rb",
     "lib/redis_snippets.rb",
+    "lib/redis_snippets/help.rb",
     "lib/redis_snippets/railtie.rb",
     "lib/redis_snippets/redis.rb",
     "redis_snippets.gemspec"
   ]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{View snippets held in Redis storage.}
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.13"
+  s.summary = "View snippets held in Redis storage."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

metadata

@@ -1,60 +1,46 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: redis_snippets
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.0.5
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 4
-  version: 0.0.4
 platform: ruby
-authors: 
+authors:
 - Martin Moen Wulffeld
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-21 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: redis
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2160253380 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: redis-namespace
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2160253380
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: &2160252900 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: ""
+  prerelease: false
+  version_requirements: *2160252900
+description: ''
 email: martin@wulffeld.org
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README
-files: 
-- README
+extra_rdoc_files:
+- README.md
+files:
+- README.md
 - Rakefile
 - VERSION
 - app/controllers/admin/snippets_controller.rb
@@ -63,41 +49,32 @@ files:
 - app/views/admin/snippets/show.html.erb
 - config/routes.rb
 - lib/redis_snippets.rb
+- lib/redis_snippets/help.rb
 - lib/redis_snippets/railtie.rb
 - lib/redis_snippets/redis.rb
 - redis_snippets.gemspec
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: View snippets held in Redis storage.
 test_files: []
-

data/README

@@ -1,12 +0,0 @@
-Shove this in an initializer and smoke it:
-
- App::Application.config.redis_snippets = {
-   :connection => ::Redis::Namespace.new("my_namespace", :redis => ::Redis.new),
-   :keys => [:key1, :key2]
- }
-
-Access /admin/snippets/.
-
-Then use helper snippet().
-
- <%= snippet(:key1) %>