redis_snippets 0.0.11 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 201aaa3560f2c964fdb9751db79dc562d3417877
-  data.tar.gz: cd61885b8d6eae29bec8e06a1a9330c61dd394d5
+SHA256:
+  metadata.gz: a32461d6ee5259748fc6537e758b48225976155e8cdc44ebf9ec17f3d93b804f
+  data.tar.gz: 590fc3a6e3b3e0bdc3ffad2af93365acac6c52df011073f41df3f3fdb14ecc17
 SHA512:
-  metadata.gz: cf1e09f3d02b341a8a66d7f2503c9592e0eea39e6ff0c3f343abfd3a669a8d53783965cfce198183a5c62fd25322007ad92aa749b05ffd36b7fcc3b73b0e7751
-  data.tar.gz: d23eb03147736e87eccda9881354950e95e70f343cf682965a9ed4df55eb0e49467f5a5c9e09fa529cffb281867c66b238e1fb780b894418eeae533ded2bd46b
+  metadata.gz: b4819ebdecad814ba7af40a2ede613e6a7b828b967a59a8fada4e0ac372291822a4e7c3ec3b5d82ebbf4d2e2bbafc4f6e1b4495b834eb5848eb1644e3457d6d7
+  data.tar.gz: ad2259a91847730a1344ed181269543eb348fbd67fad5d19154f93274e0c8b20718991676f6127b64c20064c006ea68ed23cdccda21729165b093768d8e1bcd8

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.
 
-## How
+## Requirements
 
-It's a Rails engine so add redis-snippets to your Gemfile and put this in an initializer:
+Gems:
+
+* rails 5.x or higher
+* redis
+* redis-namespace
+
+## Installation
+
+Add to your Rails projects Gemfile and bundle install:
+
+```
+gem "redis_snippets"
+```
+
+## Usage
+
+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().
@@ -31,17 +59,18 @@ One snippet area can include multiple snippets if you separate them with a
 [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.
 
 ``` 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]
 }
 ```
 
@@ -53,9 +82,3 @@ def redis_snippet_site_key
   request.host
 end
 ```
-
-## Requirements
-
-* rails 5.x or higher
-* 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,5 +1,9 @@
 class RedisSnippets::SnippetsController < ApplicationController
-  include RedisSnippets::Help
+  include RedisSnippets::Util
+
+  # Temporary fix for Rails 6.0 support. Rendering views doesn't have access
+  # to the apps routes unless we include them.
+  include Rails.application.routes.url_helpers
 
   before_action :redis_snippets_authenticate_admin_user!
 
@@ -10,8 +14,7 @@ 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.'

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,54 @@
+
+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 = ""
+
+    if content = SnippetStoreService.send(snippet_key(@key))
+      snippets = content.split("#{SECTION_DELIMITER}")
+      @snippet = random_snippet(content)
+    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
+
+  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/lib/redis_snippets/engine.rb

@@ -1,5 +1,9 @@
 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.

data/lib/redis_snippets/version.rb

@@ -1,3 +1,3 @@
 module RedisSnippets
-  VERSION = '0.0.11'
+  VERSION = '1.0.0'
 end

data/lib/redis_snippets.rb

@@ -1,7 +1,9 @@
+require 'rails'
 require 'redis'
 require 'redis/namespace'
 
 require 'redis_snippets/engine'
-
 require 'redis_snippets/redis'
-require 'redis_snippets/help'
+require 'redis_snippets/util'
+
+class UndefinedSnippetsKey < Exception; end

data/redis_snippets.gemspec

@@ -7,9 +7,9 @@ Gem::Specification.new do |spec|
   spec.version       = RedisSnippets::VERSION
   spec.authors       = ["Martin Moen Wulffeld"]
   spec.email         = ["martin@wulffeld.org"]
-  spec.description   = %q{Storing snippets of whatever in Redis.}
-  spec.summary       = %q{Storing snippets of whatever in Redis.}
-  spec.homepage      = "http://www.wulffeld.org/"
+  spec.summary       = %q{Storing snippets of HTML, text, etc. in Redis for use in views.}
+  spec.description   = %q{A Ruby on Rails gem that facilitates fast retrieval of snippets of code or information for views.}
+  spec.homepage      = "https://github.com/wulffeld/redis_snippets"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/spec/app/helpers/redis_snippets/snippets_helper_spec.rb

@@ -0,0 +1,38 @@
+require 'rails_helper'
+
+describe RedisSnippets::SnippetsHelper, type: :helper do
+  let(:code) { "<p>Buy this from Amazon.</p>" }
+  let(:view) { ActionController::Base.new.view_context }
+
+  describe "#snippet_has_content?" do
+    before do
+      SnippetStoreService.update(snippet_key(:advert_header), code)
+    end
+
+    it "returns true if there's content in the snippet" do
+      expect(snippet_has_content?(:advert_header)).to be true
+    end
+
+    it "returns false if there's no content in the snippet" do
+      expect(snippet_has_content?(:advert_footer)).to be false
+    end
+  end
+
+  describe "#snippet" do
+    before do
+      SnippetStoreService.update(snippet_key(:advert_header), code)
+    end
+
+    it "adds the snippet key as the class" do
+      expect(snippet(:advert_header)).to eq("<div class=\"snippet advert_header\"><p>Buy this from Amazon.</p></div>")
+    end
+
+    it "adds more classes from a string" do
+      expect(snippet(:advert_header, "advert-responsive")).to eq("<div class=\"snippet advert_header advert-responsive\"><p>Buy this from Amazon.</p></div>")
+    end
+
+    it "adds more classes from an array" do
+      expect(snippet(:advert_header, ["advert-responsive", "p-4"])).to eq("<div class=\"snippet advert_header advert-responsive p-4\"><p>Buy this from Amazon.</p></div>")
+    end
+  end
+end

data/spec/app/presenters/snippet_presenter_spec.rb

@@ -0,0 +1,53 @@
+require 'rails_helper'
+
+describe SnippetPresenter do
+  let(:code) { "<p>Buy this from Amazon.</p>" }
+  let(:multiple_adverts) { <<-HEREDOC
+<p>Buy this from Amazon.</p>
+[section]
+<p>Buy this from Apple.</p>
+HEREDOC
+  }
+  let(:view) { ActionController::Base.new.view_context }
+
+  subject(:presenter) { described_class.new(view: view, key: :advert_header) }
+  subject(:presenter_with_string_class) { described_class.new(view: view, key: :advert_header, classes: "advert-responsive") }
+  subject(:presenter_with_array_classes) { described_class.new(view: view, key: :advert_header, classes: ["advert-responsive", "p-4"]) }
+
+  describe "#call" do
+    before do
+      SnippetStoreService.update(snippet_key(:advert_header), code)
+    end
+
+    it "renders the content" do
+      expect(presenter.call).to eq("<div class=\"snippet advert_header\">#{code}</div>")
+    end
+
+    describe "classes argument" do
+      it "adds the snippet key as the class" do
+        expect(presenter.call).to eq("<div class=\"snippet advert_header\"><p>Buy this from Amazon.</p></div>")
+      end
+
+      it "adds more classes from a string" do
+        expect(presenter_with_string_class.call).to eq("<div class=\"snippet advert_header advert-responsive\"><p>Buy this from Amazon.</p></div>")
+      end
+
+      it "adds more classes from an array" do
+        expect(presenter_with_array_classes.call).to eq("<div class=\"snippet advert_header advert-responsive p-4\"><p>Buy this from Amazon.</p></div>")
+      end
+    end
+  end
+
+  describe ".random_snippet" do
+    before do
+      SnippetStoreService.update(snippet_key(:advert_header), multiple_adverts)
+    end
+
+    it "returns one of the sections" do
+      allow(SnippetPresenter).to receive(:rand).and_return(0)
+      expect(described_class.random_snippet(multiple_adverts)).to eq("<p>Buy this from Amazon.</p>\n")
+      allow(SnippetPresenter).to receive(:rand).and_return(1)
+      expect(described_class.random_snippet(multiple_adverts)).to eq("<p>Buy this from Apple.</p>\n")
+    end
+  end
+end

data/spec/app/services/snippet_store_service_spec.rb

@@ -0,0 +1,44 @@
+require 'rails_helper'
+
+describe SnippetStoreService do
+  let(:defined_key) { SnippetStoreService.advert_header }
+
+  let(:code) { "<p>Hello world.</p>" }
+
+  describe "#update" do
+    it "updates the content of a snippet" do
+      SnippetStoreService.update(snippet_key(:advert_header), code)
+
+      expect(SnippetStoreService.advert_header).to eq(code)
+    end
+
+    it "doesn't allowed undefined keys" do
+      expect { SnippetStoreService.update(:advert_sidebar, code) }.to raise_error(UndefinedSnippetsKey)
+    end
+  end
+
+  describe "#del" do
+    it "removes the content of a snippet" do
+      SnippetStoreService.update(snippet_key(:advert_header), code)
+      SnippetStoreService.del(snippet_key(:advert_header))
+
+      expect(SnippetStoreService.advert_header).to eq(nil)
+    end
+  end
+
+  describe "#method_missing" do
+    it "delegates missing methods to the store" do
+      SnippetStoreService.update(snippet_key(:advert_header), code)
+
+      expect(SnippetStoreService.advert_header).to eq(code)
+    end
+
+    it "returns nil for defined keys that has not been set" do
+      expect(defined_key).to eq(nil)
+    end
+
+    it "returns nil for undefined keys" do
+      expect(SnippetStoreService.advert_sidebar).to eq(nil)
+    end
+  end
+end

data/spec/dummy/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/spec/dummy/app/assets/config/manifest.js

@@ -0,0 +1,3 @@
+//= link_tree ../images
+//= link_directory ../stylesheets .css
+//= link manifest.js

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Dummy</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    'application', media: 'all' %>
+  </head>
+
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/bin/setup

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+# path to your application root.
+APP_ROOT = File.expand_path('..', __dir__)
+
+def system!(*args)
+  system(*args) || abort("\n== Command #{args} failed ==")
+end
+
+FileUtils.chdir APP_ROOT do
+  # This script is a way to setup or update your development environment automatically.
+  # This script is idempotent, so that you can run it at anytime and get an expectable outcome.
+  # Add necessary setup steps to this file.
+
+  puts '== Installing dependencies =='
+  system! 'gem install bundler --conservative'
+  system('bundle check') || system!('bundle install')
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?('config/database.yml')
+  #   FileUtils.cp 'config/database.yml.sample', 'config/database.yml'
+  # end
+
+  puts "\n== Preparing database =="
+  system! 'bin/rails db:prepare'
+
+  puts "\n== Removing old logs and tempfiles =="
+  system! 'bin/rails log:clear tmp:clear'
+
+  puts "\n== Restarting application server =="
+  system! 'bin/rails restart'
+end

data/spec/dummy/config/application.rb

@@ -0,0 +1,29 @@
+require_relative 'boot'
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+# require "active_job/railtie"
+# require "active_record/railtie"
+# require "active_storage/engine"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+require "action_view/railtie"
+require "action_cable/engine"
+require "sprockets/railtie"
+# require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "redis_snippets"
+
+module Dummy
+  class Application < Rails::Application
+    # Initialize configuration defaults for originally generated Rails version.
+    config.load_defaults 6.0
+
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration can go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded after loading
+    # the framework and any gems in your application.
+  end
+end

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../Gemfile', __dir__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../lib', __dir__)

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require_relative 'application'
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,62 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports.
+  config.consider_all_requests_local = true
+
+  # Enable/disable caching. By default caching is disabled.
+  # Run rails dev:cache to toggle caching.
+  if Rails.root.join('tmp', 'caching-dev.txt').exist?
+    config.action_controller.perform_caching = true
+    config.action_controller.enable_fragment_cache_logging = true
+
+    config.cache_store = :memory_store
+    config.public_file_server.headers = {
+      'Cache-Control' => "public, max-age=#{2.days.to_i}"
+    }
+  else
+    config.action_controller.perform_caching = false
+
+    config.cache_store = :null_store
+  end
+
+  # Store uploaded files on the local file system (see config/storage.yml for options).
+  config.active_storage.service = :local
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  config.action_mailer.perform_caching = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations.
+  config.active_record.migration_error = :page_load
+
+  # Highlight code that triggered database queries in logs.
+  config.active_record.verbose_query_logs = true
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+
+  # Suppress logger output for asset requests.
+  config.assets.quiet = true
+
+  # Raises error for missing translations.
+  # config.action_view.raise_on_missing_translations = true
+
+  # Use an evented file watcher to asynchronously detect changes in source code,
+  # routes, locales, etc. This feature depends on the listen gem.
+  # config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,48 @@
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  config.cache_classes = false
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure public file server for tests with Cache-Control for performance.
+  config.public_file_server.enabled = true
+  config.public_file_server.headers = {
+    'Cache-Control' => "public, max-age=#{1.hour.to_i}"
+  }
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+  config.cache_store = :null_store
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Store uploaded files on the local file system in a temporary directory.
+  # config.active_storage.service = :test
+
+  # config.action_mailer.perform_caching = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations.
+  # config.action_view.raise_on_missing_translations = true
+end

data/spec/dummy/config/initializers/application_controller_renderer.rb

@@ -0,0 +1,8 @@
+# Be sure to restart your server when you modify this file.
+
+# ActiveSupport::Reloader.to_prepare do
+#   ApplicationController.renderer.defaults.merge!(
+#     http_host: 'example.org',
+#     https: false
+#   )
+# end

data/spec/dummy/config/initializers/assets.rb

@@ -0,0 +1,12 @@
+# Be sure to restart your server when you modify this file.
+
+# Version of your assets, change this if you want to expire all your assets.
+Rails.application.config.assets.version = '1.0'
+
+# Add additional assets to the asset load path.
+# Rails.application.config.assets.paths << Emoji.images_path
+
+# Precompile additional assets.
+# application.js, application.css, and all non-JS/CSS in the app/assets
+# folder are already added.
+# Rails.application.config.assets.precompile += %w( admin.js admin.css )

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/content_security_policy.rb

@@ -0,0 +1,28 @@
+# Be sure to restart your server when you modify this file.
+
+# Define an application-wide content security policy
+# For further information see the following documentation
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
+
+# Rails.application.config.content_security_policy do |policy|
+#   policy.default_src :self, :https
+#   policy.font_src    :self, :https, :data
+#   policy.img_src     :self, :https, :data
+#   policy.object_src  :none
+#   policy.script_src  :self, :https
+#   policy.style_src   :self, :https
+
+#   # Specify URI for violation reports
+#   # policy.report_uri "/csp-violation-report-endpoint"
+# end
+
+# If you are using UJS then enable automatic nonce generation
+# Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
+
+# Set the nonce only to specific directives
+# Rails.application.config.content_security_policy_nonce_directives = %w(script-src)
+
+# Report CSP violations to a specified URI
+# For further information see the following documentation:
+# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
+# Rails.application.config.content_security_policy_report_only = true

data/spec/dummy/config/initializers/cookies_serializer.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Specify a serializer for the signed and encrypted cookie jars.
+# Valid options are :json, :marshal, and :hybrid.
+Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf

data/spec/dummy/config/initializers/wrap_parameters.rb

@@ -0,0 +1,14 @@
+# Be sure to restart your server when you modify this file.
+
+# This file contains settings for ActionController::ParamsWrapper which
+# is enabled by default.
+
+# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
+ActiveSupport.on_load(:action_controller) do
+  wrap_parameters format: [:json]
+end
+
+# To enable root element in JSON for ActiveRecord objects.
+# ActiveSupport.on_load(:active_record) do
+#   self.include_root_in_json = true
+# end

data/spec/dummy/config/puma.rb

@@ -0,0 +1,38 @@
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+#
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+#
+port        ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+#
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Specifies the number of `workers` to boot in clustered mode.
+# Workers are forked web server processes. If using threads and workers together
+# the concurrency of the application would be max `threads` * `workers`.
+# Workers do not work on JRuby or Windows (both of which do not support
+# processes).
+#
+# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
+
+# Use the `preload_app!` method when specifying a `workers` number.
+# This directive tells Puma to first boot the application and load code
+# before forking the application. This takes advantage of Copy On Write
+# process behavior so workers use less memory.
+#
+# preload_app!
+
+# Allow puma to be restarted by `rails restart` command.
+plugin :tmp_restart

data/spec/dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  mount RedisSnippets::Engine, at: "admin", as: "redis_snippets"
+end

data/spec/dummy/config.ru

@@ -0,0 +1,5 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative 'config/environment'
+
+run Rails.application

data/spec/dummy/tmp/development_secret.txt

@@ -0,0 +1 @@
+25c7ba3ff5498aead660dbc8bf38be3833df9479ffc2fc76fd8306308d7d365a455654be62905c9594caa61d0c85e7349056c1cd49d027995ac34dae86cd3dd7

data/spec/rails_helper.rb

@@ -0,0 +1,53 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'support/simplecov_setup'
+
+require File.expand_path('dummy/config/environment', __dir__)
+require 'rspec/rails'
+require 'redis_snippets'
+
+include RedisSnippets::SnippetsHelper
+
+Rails.application.config.redis_snippets = {
+  connection: MockRedis.new,
+  keys: [
+    :advert_header,
+    :advert_footer
+  ]
+}
+
+RSpec.configure do |config|
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+
+  def clean_keys!
+    RedisSnippets::Engine.config.redis_snippets[:keys].each do |key|
+      SnippetStoreService.del(key)
+    end
+  end
+
+  config.before(:each) do
+    clean_keys!
+  end
+
+  config.after(:each) do
+    clean_keys!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+ENV['RAILS_ENV'] ||= 'test'
+
+require 'support/simplecov_setup'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end

data/spec/support/simplecov_setup.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter %r{^/spec/}
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_snippets
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 1.0.0
 platform: ruby
 authors:
 - Martin Moen Wulffeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-02 00:00:00.000000000 Z
+date: 2019-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.1
-description: Storing snippets of whatever in Redis.
+description: A Ruby on Rails gem that facilitates fast retrieval of snippets of code
+  or information for views.
 email:
 - martin@wulffeld.org
 executables: []
@@ -88,20 +89,61 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
 - README.md
 - Rakefile
 - app/controllers/redis_snippets/snippets_controller.rb
 - app/helpers/redis_snippets/snippets_helper.rb
-- app/models/redis_snippets/snippets.rb
+- app/presenters/snippet_presenter.rb
+- app/services/snippet_store_service.rb
 - app/views/redis_snippets/snippets/show.html.erb
 - config/routes.rb
 - lib/redis_snippets.rb
 - lib/redis_snippets/engine.rb
-- lib/redis_snippets/help.rb
 - lib/redis_snippets/redis.rb
+- lib/redis_snippets/util.rb
 - lib/redis_snippets/version.rb
 - redis_snippets.gemspec
-homepage: http://www.wulffeld.org/
+- spec/app/helpers/redis_snippets/snippets_helper_spec.rb
+- spec/app/presenters/snippet_presenter_spec.rb
+- spec/app/services/snippet_store_service_spec.rb
+- spec/dummy/.ruby-version
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/tmp/.keep
+- spec/dummy/tmp/development_secret.txt
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/simplecov_setup.rb
+homepage: https://github.com/wulffeld/redis_snippets
 licenses:
 - MIT
 metadata: {}
@@ -120,9 +162,45 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
-summary: Storing snippets of whatever in Redis.
-test_files: []
+summary: Storing snippets of HTML, text, etc. in Redis for use in views.
+test_files:
+- spec/app/helpers/redis_snippets/snippets_helper_spec.rb
+- spec/app/presenters/snippet_presenter_spec.rb
+- spec/app/services/snippet_store_service_spec.rb
+- spec/dummy/.ruby-version
+- spec/dummy/Rakefile
+- spec/dummy/app/assets/config/manifest.js
+- spec/dummy/app/assets/images/.keep
+- spec/dummy/app/assets/stylesheets/application.css
+- spec/dummy/app/controllers/application_controller.rb
+- spec/dummy/app/views/layouts/application.html.erb
+- spec/dummy/bin/rails
+- spec/dummy/bin/rake
+- spec/dummy/bin/setup
+- spec/dummy/config.ru
+- spec/dummy/config/application.rb
+- spec/dummy/config/boot.rb
+- spec/dummy/config/environment.rb
+- spec/dummy/config/environments/development.rb
+- spec/dummy/config/environments/test.rb
+- spec/dummy/config/initializers/application_controller_renderer.rb
+- spec/dummy/config/initializers/assets.rb
+- spec/dummy/config/initializers/backtrace_silencers.rb
+- spec/dummy/config/initializers/content_security_policy.rb
+- spec/dummy/config/initializers/cookies_serializer.rb
+- spec/dummy/config/initializers/filter_parameter_logging.rb
+- spec/dummy/config/initializers/inflections.rb
+- spec/dummy/config/initializers/mime_types.rb
+- spec/dummy/config/initializers/wrap_parameters.rb
+- spec/dummy/config/puma.rb
+- spec/dummy/config/routes.rb
+- spec/dummy/lib/assets/.keep
+- spec/dummy/log/.keep
+- spec/dummy/tmp/.keep
+- spec/dummy/tmp/development_secret.txt
+- spec/rails_helper.rb
+- spec/spec_helper.rb
+- spec/support/simplecov_setup.rb