redis_snippets 0.0.10 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d57ab380b6653a5a2bbadfd96bcb3f5c2b1033b0
-  data.tar.gz: c6ef4474551730d558e675fa49fde37e5f20219a
+SHA256:
+  metadata.gz: 1157b175b0ce0c3c72be376383f9da2d522999f69304c093cd3ddbc22eb0d25d
+  data.tar.gz: 7673c2ffe8fd7b0134847e1de912dd94aadf900a267c937625e3ace993f106ee
 SHA512:
-  metadata.gz: c81fa957b20f7e9d1b7cdf0164bae965e85cea2a51f6ad1c65d3ba6f17d24a4e0119cd8f5bd9889dbc9e54c12df67735cd43eac6ab2f84897837925bf90a000a
-  data.tar.gz: f5ed406436c21e5969129f901fcdea444f89f68b1dd10a17576a60798c7bab9790f542692e7b47823ff4487c49e272bd3614acb02ef5dae6da82a84832b385c0
+  metadata.gz: fc847d478f9c40aef9fe2ecb067eee24c700d23b1053bcb09280db46c5025b09a94e6363ecdb2f0d70e567a606b75cb53d0771e16844b3a934b6eb815c4bb44f
+  data.tar.gz: fbfc1e84fc0c9794221880574abde61e7d3e2c11720c0c92062be5592c0f15d599f428b556abe777156fc2662790b4386c60cd553720d9567a3664337761602d

data/.gitignore

@@ -1,3 +1,5 @@
-*.tmproj
-pkg
 .bundle
+pkg
+spec/dummy/log
+Gemfile.lock
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+cache: bundler
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=aa59e066b7cd7b5477aecc5c17004d78d35012420e791d23b17c0ea705ef9cd7
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+before_install:
+  - gem update --system
+  - gem install bundler --version 2.0.2
+rvm:
+  - 2.6.5
+script:
+  - bundle exec rake
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+gemspec
+
+group :test, :development do
+  gem "rails", ">= 6.0"
+  gem "rspec-rails", ">= 3.9.0"
+end
+
+group :test do
+  gem "mock_redis"
+  gem "simplecov"
+end

data/README.md

@@ -1,20 +1,48 @@
 # Redis Snippets
 
+[![Version](https://img.shields.io/gem/v/redis_snippets.svg?style=flat-square)](https://rubygems.org/gems/redis_snippets)
+[![Build](https://img.shields.io/travis/wulffeld/redis_snippets.svg?style=flat-square)](https://travis-ci.org/wulffeld/redis_snippets)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/wulffeld/redis_snippets?style=flat-square)](https://codeclimate.com/github/wulffeld/redis_snippets)
+[![Coverage](https://img.shields.io/codeclimate/coverage/wulffeld/redis_snippets?style=flat-square)](https://codeclimate.com/github/wulffeld/redis_snippets)
+
 ## Background
 
-Easily store snippets of content in Redis.
+Easily store snippets of content in Redis. Inspired by plugin for Wordpress
+named Snippets.
+
+With redis_snippets you could for instance store AdSense code snippets or
+other HTML/JS content.
+
+## Requirements
+
+Gems:
+
+* rails 5.x or higher
+* redis
+* redis-namespace
+
+## Installation
+
+Add to your Rails projects Gemfile and bundle install:
+
+```
+gem "redis_snippets"
+```
 
-## How
+## Usage
 
-It's a Rails engine so add redis-snippets to your Gemfile and put this in an initializer:
+It's a Rails 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]
+Rails.application.config.redis_snippets = {
+  connection: ::Redis::Namespace.new("my_namespace", redis: ::Redis.new),
+  keys: [:key1, :key2]
 }
 ```
 
+The names of the keys are entirely up to you.
+
 You should then be able to access /admin/snippets/.
 
 In your views use helper snippet().
@@ -28,20 +56,63 @@ In your views use helper snippet().
 One snippet area can include multiple snippets if you separate them with a
 
 ```
-[snippet]
+[section]
 ```
 
-The snippet helper will randomly select the snippet. This is convenient for ad delivery for example.
+The snippet helper will randomly select the snippet. This is convenient for ad
+delivery or perhaps A/B testing 🤷‍♂.
 
 ## Multi Site
 
-If you're using one app to serve multiple sites a little more configuration is necessary.
+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]
+Rails.application.config.redis_snippets = {
+  connection: ::Redis::Namespace.new("my_namespace", redis: ::Redis.new),
+  multi_site: true,
+  keys: [:key1, :key2],
+  transform: "MySnippetTransform"
+}
+```
+
+## Transforming Snippets
+
+Sometimes you might want to transform snippets. This happens after
+randomization so you get the actual snippet content to be rendered passed to
+your transform class.
+
+The transform class must respond to .transforms? and #transform. Example:
+
+``` ruby
+class MySnippetTransform
+  def initialize(content:, key:)
+    @content = content
+    @key = key
+  end
+
+  # Must return content.
+  def transform
+    @content.gsub("Amazon", "Etsy")
+  end
+
+  class << self
+    def transforms?(key:)
+      key == :advert_header
+    end
+  end
+end
+```
+
+I personally use this to insert special CSS code for AdSense. This saves me
+from having to do this manually whenever I update it or add it.
+
+``` ruby
+Rails.application.config.redis_snippets = {
+  connection: ::Redis::Namespace.new("my_namespace", redis: ::Redis.new),
+  multi_site: true,
+  keys: [:key1, :key2],
+  transform: "MySnippetTransform"
 }
 ```
 
@@ -53,8 +124,3 @@ def redis_snippet_site_key
   request.host
 end
 ```
-
-## Requirements
-
-* redis
-* redis-namespace

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/app/controllers/redis_snippets/snippets_controller.rb

@@ -1,7 +1,7 @@
 class RedisSnippets::SnippetsController < ApplicationController
-  include RedisSnippets::Help
-  
-  before_filter :redis_snippets_authenticate_admin_user!
+  include RedisSnippets::Util
+
+  before_action :redis_snippets_authenticate_admin_user!
 
   layout 'admin'
 
@@ -10,10 +10,9 @@ class RedisSnippets::SnippetsController < ApplicationController
 
   def update
     params[:snippets].each do |key, content|
-      raise "#{key} not in the specified keys." unless RedisSnippets::Engine.config.redis_snippets[:keys].include?(key.to_sym)
-      RedisSnippets::Snippets.update(snippet_key(key), params[:snippets][key])
+      SnippetStoreService.update(snippet_key(key), params[:snippets][key])
     end
-  
+
     flash[:notice] = 'Snippets updated.'
     redirect_to redis_snippets.snippets_path
   end

data/app/helpers/redis_snippets/snippets_helper.rb

@@ -1,32 +1,14 @@
 module RedisSnippets
   module SnippetsHelper
-    include RedisSnippets::Help
-
-    def snippet_content(snippet_name)
-      RedisSnippets::Snippets.send(snippet_key(snippet_name))
-    end
+    include RedisSnippets::Util
 
     # Return true if snippet has content.
-    def snippet_has_content?(snippet_name)
-      !snippet_content(snippet_name).blank?
-    end
-
-    def snippet(snippet_name, classes=nil)
-      return '' if controller.status == 404
-      snippet = snippet_content(snippet_name)
-      return '' if snippet.blank?
-      snippets = snippet.split("[section]")
-      build_snippet(snippets[rand(snippets.length)], snippet_class_list(snippet_name, classes))
-    end
-
-    def snippet_class_list(snippet_name, classes)
-      ['snippet', classes || snippet_name.to_s].compact.join(' ').html_safe
+    def snippet_has_content?(key)
+      !SnippetStoreService.send(snippet_key(key)).blank?
     end
 
-    def build_snippet(content, classes)
-      content_tag(:div,
-        content.html_safe,
-        :class => classes)
+    def snippet(key, classes = nil)
+      SnippetPresenter.new(view: self, key: key, classes: classes).call
     end
   end
 end

data/app/presenters/snippet_presenter.rb

@@ -0,0 +1,67 @@
+
+class SnippetPresenter
+  include RedisSnippets::Util
+
+  SECTION_DELIMITER = "[section]"
+
+  delegate :random_snippet, to: "self.class"
+
+  def initialize(view:, key:, classes: nil)
+    @view = view
+    @key = key
+    @classes = classes
+  end
+
+  def call
+    prepare_snippet
+    render
+  end
+
+  protected
+
+  def prepare_snippet
+    @snippet = ""
+
+    return unless content = SnippetStoreService.send(snippet_key(@key))
+
+    snippets = content.split("#{SECTION_DELIMITER}")
+    @snippet = random_snippet(content)
+
+    if transform_class && transform_class.transforms?(key: @key)
+      @snippet = transform_class.new(content: @snippet, key: @key).transform
+    end
+  end
+
+  def snippet_class_list
+    [
+      "snippet",
+      @key.to_s,
+      *@classes
+    ].reject(&:blank?).join(" ").html_safe
+  end
+
+  def render
+    # If snippet is empty we avoid wrapping it in the div.
+    if @snippet.blank?
+      ""
+    else
+      @view.content_tag(:div, @snippet.html_safe, class: snippet_class_list)
+    end
+  end
+
+  def transform_class
+    @klass ||=
+      if RedisSnippets::Engine.config.redis_snippets[:transform].is_a?(Proc)
+        klass = RedisSnippets::Engine.config.redis_snippets[:transform].call and klass.constantize
+      else
+        RedisSnippets::Engine.config.redis_snippets[:transform] and RedisSnippets::Engine.config.redis_snippets[:transform].constantize
+      end
+  end
+
+  class << self
+    def random_snippet(content)
+      snippets = content.split("#{SECTION_DELIMITER}").map { |section| section.gsub(/^\n/, "") }
+      snippets[rand(snippets.length)]
+    end
+  end
+end

data/app/{models/redis_snippets/snippets.rb → services/snippet_store_service.rb}

@@ -1,10 +1,12 @@
-class RedisSnippets::Snippets
+class SnippetStoreService
   class << self
     def update(key, content)
+      ensure_key_is_defined!(key)
       RedisSnippets::Redis.set("snippets:#{key}", content)
     end
 
     def del(key)
+      ensure_key_is_defined!(key)
       RedisSnippets::Redis.del("snippets:#{key}")
     end
 
@@ -12,5 +14,11 @@ class RedisSnippets::Snippets
     def method_missing(method, *args)
       RedisSnippets::Redis.get("snippets:#{method}")
     end
+
+    protected
+
+    def ensure_key_is_defined!(key)
+      raise UndefinedSnippetsKey.new("#{key} not in the specified keys.") unless RedisSnippets::Engine.config.redis_snippets[:keys].include?(key.to_sym)
+    end
   end
 end

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

@@ -1,23 +1,19 @@
-<div class="redis_snippets">
-  <h1>Snippets</h1>
+<div class="redis-snippets">
+  <h1 class="h1">Snippets</h1>
 
-  <%= form_tag '', method: :put, class: "form-redis_snippets" do |f| %>
-    <fieldset class="form-redis_snippets-inputs">
-      <ol>
+  <%= form_tag "", method: :put, class: "redis-snippets__form" do |f| %>
+    <fieldset class="redis-snippets__fieldset">
+      <ol class="redis-snippets__list">
         <% RedisSnippets::Engine.config.redis_snippets[:keys].each do |key| %>
-          <li class="form-redis_snippets-inputs-text form-redis_snippets-inputs-input form-redis_snippets-inputs-optional">
-            <%= label_tag key.to_s, key.to_s, class: "form-redis_snippets-label" %>
-            <%= text_area_tag "snippets[#{key}]", RedisSnippets::Snippets.send(snippet_key(key)), cols: 120, rows: 10 %>
+          <li class="redis-snippets__snippet">
+            <%= label_tag key.to_s, key.to_s, class: "redis-snippets__snippet-label" %>
+            <%= text_area_tag "snippets[#{key}]", SnippetStoreService.send(snippet_key(key)), cols: 120, rows: 10 %>
           </li>
         <% end -%>
       </ol>
     </fieldset>
-    <fieldset class="form-redis_snippets-inputs-actions">
-      <ol>
-        <li class="form-redis_snippets-inputs-action form-redis_snippets-inputs-button_action">
-          <%= button_tag 'Submit' %>
-        </li>
-      </ol>
-    </field>
+    <fieldset class="redis-snippets__actions">
+      <%= button_tag "Submit", class: "redis-snippets__submit" %>
+    </fieldset>
   <% end -%>
 </div>

data/config/routes.rb

@@ -1,3 +1,3 @@
 RedisSnippets::Engine.routes.draw do
-  resource :snippets, controller: 'snippets', only: [:show, :update]
+  resource :snippets, controller: 'redis_snippets/snippets', only: [:show, :update]
 end

data/lib/redis_snippets/engine.rb

@@ -1,5 +1,7 @@
 module RedisSnippets
   class Engine < ::Rails::Engine
-    isolate_namespace RedisSnippets
+    config.generators do |g|
+      g.test_framework :rspec
+    end
   end
 end

data/lib/redis_snippets/redis.rb

@@ -1,17 +1,22 @@
 module RedisSnippets
   class Redis
     class << self
-      # Can't do method_missing on get/set as they're defined somewhere by Ruby.
       def get(key)
-        RedisSnippets::Engine.config.redis_snippets[:connection].get(key)
+        connection.get(key)
       end
 
       def set(key, value)
-        RedisSnippets::Engine.config.redis_snippets[:connection].set(key, value)
+        connection.set(key, value)
       end
 
-      def method_missing(method, *args)
-        RedisSnippets::Engine.config.redis_snippets[:connection].send(method, *args)
+      def del(key)
+        connection.del(key)
+      end
+
+      protected
+
+      def connection
+        RedisSnippets::Engine.config.redis_snippets[:connection]
       end
     end
   end

data/lib/redis_snippets/{help.rb → util.rb}

@@ -1,6 +1,6 @@
 module RedisSnippets
-  module Help
-    # If multi_site => true the symbol returned will have the key returned with a prefix.
+  module Util
+    # If multi_site is 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.