redis_snippets 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a32461d6ee5259748fc6537e758b48225976155e8cdc44ebf9ec17f3d93b804f
-  data.tar.gz: 590fc3a6e3b3e0bdc3ffad2af93365acac6c52df011073f41df3f3fdb14ecc17
+  metadata.gz: 717ab9484b932c8a8e7fa6aa05e58ef380f3ddd9468068903ea297b4590397eb
+  data.tar.gz: badd68f7355ebe589110d770e45117f03784f5d65ef2d678eac615db7ce3586d
 SHA512:
-  metadata.gz: b4819ebdecad814ba7af40a2ede613e6a7b828b967a59a8fada4e0ac372291822a4e7c3ec3b5d82ebbf4d2e2bbafc4f6e1b4495b834eb5848eb1644e3457d6d7
-  data.tar.gz: ad2259a91847730a1344ed181269543eb348fbd67fad5d19154f93274e0c8b20718991676f6127b64c20064c006ea68ed23cdccda21729165b093768d8e1bcd8
+  metadata.gz: 01266e1500a427aa626d5d3bfc0d9d5ec30d21f0454add4dec24c1a3cc1d0ac660cf7864a20fc91591f795b1b946244689aa757cccde50d49f464dddee14c354
+  data.tar.gz: 72df68e6b25ad50e25b26679086d5fe0b2802168a167046b2eec92ed99b878e265b09ffb29f0bb5a05eb55fa6298a0d5eed862ab6e7b09f58a9246be77dec550

data/README.md

@@ -64,13 +64,55 @@ 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
 Rails.application.config.redis_snippets = {
   connection: ::Redis::Namespace.new("my_namespace", redis: ::Redis.new),
   multi_site: true,
-  keys: [:key1, :key2]
+  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"
 }
 ```
 

data/app/presenters/snippet_presenter.rb

@@ -22,9 +22,13 @@ class SnippetPresenter
   def prepare_snippet
     @snippet = ""
 
-    if content = SnippetStoreService.send(snippet_key(@key))
-      snippets = content.split("#{SECTION_DELIMITER}")
-      @snippet = random_snippet(content)
+    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
 
@@ -45,6 +49,15 @@ class SnippetPresenter
     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/, "") }

data/lib/redis_snippets/version.rb

@@ -1,3 +1,3 @@
 module RedisSnippets
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 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/rails_helper.rb

@@ -13,7 +13,8 @@ Rails.application.config.redis_snippets = {
   keys: [
     :advert_header,
     :advert_footer
-  ]
+  ],
+  transform: -> { ENV['TRANSFORM'] ? "Transformer" : nil }
 }
 
 RSpec.configure do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis_snippets
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Martin Moen Wulffeld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2019-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,6 +108,7 @@ files:
 - redis_snippets.gemspec
 - spec/app/helpers/redis_snippets/snippets_helper_spec.rb
 - spec/app/presenters/snippet_presenter_spec.rb
+- spec/app/presenters/snippet_presenter_transform_spec.rb
 - spec/app/services/snippet_store_service_spec.rb
 - spec/dummy/.ruby-version
 - spec/dummy/Rakefile
@@ -162,13 +163,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 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/presenters/snippet_presenter_transform_spec.rb
 - spec/app/services/snippet_store_service_spec.rb
 - spec/dummy/.ruby-version
 - spec/dummy/Rakefile