redis_snippets 0.0.10 → 1.0.2

data/lib/redis_snippets/version.rb

@@ -1,3 +1,3 @@
 module RedisSnippets
-  VERSION = '0.0.10'
+  VERSION = '1.0.2'
 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

@@ -6,10 +6,10 @@ Gem::Specification.new do |spec|
   spec.name          = "redis_snippets"
   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.email         = ["wulffeld@gmail.com"]
+  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($/)
@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", ">= 1.3.2"
   spec.add_development_dependency "rake"
 
+  spec.add_dependency "rails",           ">= 5"
   spec.add_dependency "redis",           ">= 2.0.0"
   spec.add_dependency "redis-namespace", ">= 1.2.1"
 end

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/presenters/snippet_presenter_transform_spec.rb

@@ -0,0 +1,45 @@
+require 'rails_helper'
+
+class Transformer
+  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
+
+describe SnippetPresenter do
+  describe "with a transform class" do
+    let(:code) { "<p>Buy this from Amazon.</p>" }
+    let(:view) { ActionController::Base.new.view_context }
+
+    subject(:header_presenter) { described_class.new(view: view, key: :advert_header) }
+    subject(:footer_presenter) { described_class.new(view: view, key: :advert_footer) }
+
+    describe "#call" do
+      before do
+        ENV["TRANSFORM"] = "1"
+        SnippetStoreService.update(snippet_key(:advert_header), code)
+        SnippetStoreService.update(snippet_key(:advert_footer), code)
+      end
+
+      it "transforms the content" do
+        expect(header_presenter.call).to eq("<div class=\"snippet advert_header\"><p>Buy this from Etsy.</p></div>")
+      end
+
+      it "does not transform the content if key is not allowed" do
+        expect(footer_presenter.call).to eq("<div class=\"snippet advert_footer\"><p>Buy this from Amazon.</p></div>")
+      end
+    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