txbr 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd81fe81e5e0d795e842a3cf75c4277d0ba5e7211214596d2755835994d27435
-  data.tar.gz: 6a40e039b54a45ba5271525dbc27fea9294eadc7d0580e38f87c3f1d8579f6aa
+  metadata.gz: 159bfa45f2d0f53ef30fe11e2bd6dfbf1b07b0ea0e19530ca3ac3d171308c4ac
+  data.tar.gz: 15621955923af3e6aa17933faf75eb344e5be7a8bd34fe52ea526d1f88a01be3
 SHA512:
-  metadata.gz: 6d314adee43b7c9450db5a230e6e8b3a35205ed764f102f875c9967e01205e8d19bef938715d64aa1c065f91b7cf9a7a014733e14eff6c0b711a004f58e4a363
-  data.tar.gz: bbf37aa158dd6c518c472f7f10214648c1c6496437ba9373e14e52fe987c196d42738dc9d639c637d68c796cd6eb67e2cced94f3b5b3c755757e95accedd477d
+  metadata.gz: 7247f257169835737f3d834d8afc0cba5930314e439a3629acfa526b4f3d7197eece08194c3f85a848a17932a3aea22540a9386a79699d286f860c140cd8f9c7
+  data.tar.gz: 9416bc14041f5b8b261ecad1de0e8aa7ccaf61d3ddc11297cc6d3aa907cf14c029ae9c3e37b45d53325ed8c2bc6e87af44b580189fae59aa5f2cfb3dbddb70fc

data/README.md

@@ -135,7 +135,7 @@ Txbr requires an Internet connection to access the Transifex and Braze APIs.
 Compatibility
 ---
 
-Txdb requires Ruby 2.5.
+Txbr requires Ruby 2.5.
 
 Authors
 ---

data/lib/txbr/campaign.rb

@@ -27,6 +27,12 @@ module Txbr
       {}
     end
 
+    def prerender_variables
+      @prerender_variables ||= {
+        'campaign.${api_id}' => campaign_id
+      }
+    end
+
     private
 
     def template_group
@@ -38,7 +44,9 @@ module Txbr
         TEMPLATE_KEYS.each_with_object([]) do |key, ret|
           begin
             if message = props[key]
-              ret << Txbr::Template.new(message_id, ::Liquid::Template.parse(message))
+              ret << Txbr::Template.new(
+                message_id, message, prerender_variables
+              )
             end
           rescue => e
             Txgh.events.publish_error!(e, metadata.merge(template_key: key))

data/lib/txbr/content_tag.rb

@@ -1,9 +1,13 @@
+require 'liquid'
+require 'cgi'
+require 'uri'
+
 module Txbr
   class ContentTag
-    attr_reader :liquid_template, :liquid_tag
+    attr_reader :template, :liquid_tag
 
-    def initialize(liquid_template, liquid_tag)
-      @liquid_template = liquid_template
+    def initialize(template, liquid_tag)
+      @template = template
       @liquid_tag = liquid_tag
     end
 
@@ -14,14 +18,14 @@ module Txbr
         # set local variables for the project and resource slugs. It's less
         # error-prone to let Liquid do the template evaluation instead of
         # grepping through the nodelist looking for assignment statements.
-        liquid_template.render
+        template.render
         liquid_tag.metadata
       end
     end
 
     def strings_manifest
       @strings_manifest ||= StringsManifest.new.tap do |manifest|
-        extract_strings_from(liquid_template.root, manifest)
+        extract_strings_from(template.root, manifest)
       end
     end
 

data/lib/txbr/email_template.rb

@@ -37,8 +37,7 @@ module Txbr
     def templates
       TEMPLATE_KEYS.each_with_object([]) do |name, ret|
         begin
-          liquid_tmpl = ::Liquid::Template.parse(details[name])
-          ret << Txbr::Template.new(email_template_id, liquid_tmpl)
+          ret << Txbr::Template.new(email_template_id, details[name])
         rescue => e
           Txgh.events.publish_error!(e, metadata.merge(template_key: name))
         end

data/lib/txbr/liquid/connected_content_tag.rb

@@ -23,51 +23,36 @@ module Txbr
       # template might contain {{strings.bar}}, which would print
       # out "baz".
       PARSE_RE = /(:#{IDENTIFIER})\s+(#{IDENTIFIER})/
-      ASSIGNS_RE = /\{\{(?:(?!\}\}).)*\}\}/
 
       attr_reader :tag_name, :url, :arguments
 
-      def initialize(tag_name, arg, _context = nil)
+      def initialize(tag_name, arg, _parse_context = nil)
         @tag_name = tag_name
         @url, @arguments = parse_arg(arg)
       end
 
-      # this method is called inside Txbr::ContentTag#metadata
-      def render(context)
-        @metadata_hash =
-          Metadata::ASSIGNMENTS.each_with_object({}) do |assignment, ret|
-            ret[assignment] = context[assignment]
-          end
-      end
-
       def prefix
         # we want to blow up if "save" isn't present
         arguments.fetch('save').first
       end
 
-      def metadata
-        @metadata ||= begin
-          query_hash = CGI.parse(uri.query)
-
-          Metadata.new(
-            query_hash
-              .each_with_object({}) { |(k, v), ret| ret[k] = v.first }
-              .merge('prefix' => prefix)
-          )
-        end
+      def render(context)
+        @url = ::Liquid::Template.parse(url).render(context)
+        ''
       end
 
-      private
+      def metadata
+        uri = URI.parse(url)
 
-      def uri
-        @uri ||= URI.parse(
-          url.gsub(ASSIGNS_RE) do |assign|
-            # remove curlies from beginning and end, look up in assigns hash
-            @metadata_hash[assign.gsub(/\A\{\{|\}\}\z/, '')]
-          end
+        Metadata.new(
+          CGI.parse(uri.query)
+            .each_with_object({}) { |(k, v), ret| ret[k] = v.first }
+            .merge('prefix' => prefix)
         )
       end
 
+      private
+
       def parse_arg(arg)
         url, *components = arg.split(PARSE_RE)
 

data/lib/txbr/template.rb

@@ -2,9 +2,12 @@ module Txbr
   class Template
     attr_reader :id, :liquid_template
 
-    def initialize(id, liquid_template)
+    def initialize(id, source, prerender_variables = {})
       @id = id
-      @liquid_template = liquid_template
+
+      @liquid_template = ::Liquid::Template.parse(
+        prerender(source, prerender_variables)
+      )
     end
 
     def each_content_tag
@@ -16,6 +19,14 @@ module Txbr
       end
     end
 
+    def render
+      liquid_template.render
+    end
+
+    def root
+      liquid_template.root
+    end
+
     private
 
     def translation_enabled?
@@ -39,7 +50,7 @@ module Txbr
 
     def content_tags
       @content_tags ||= connected_content_tags.each_with_object([]) do |tag, ret|
-        tag = ContentTag.new(liquid_template, tag)
+        tag = ContentTag.new(self, tag)
         ret << tag if tag.contains_translations?
       end
     end
@@ -51,5 +62,21 @@ module Txbr
         node.is_a?(Txbr::Liquid::ConnectedContentTag)
       end
     end
+
+    # Designed to replace special Braze variables like {{campaign.${api_id}}},
+    # which Liquid can't natively handle. If the variable exists in the given
+    # variables hash, replace it with the value directly. Otherwise, transform
+    # the var into something Liquid-friendly so it doesn't jam up the parser.
+    def prerender(source, variables)
+      source.gsub(/\{\{[\w\-\.\[\]]+\.\$\{[\w\-\.\[\]]+\}\}\}/) do |orig|
+        orig = orig[2..-3]  # remove curlies
+        next variables[orig] if variables.include?(orig)
+        "{{#{normalize_braze_var(orig)}}}"
+      end
+    end
+
+    def normalize_braze_var(var)
+      "__braze__#{var.gsub(/[^\w\-\.\[\]]/, '')}"
+    end
   end
 end

data/lib/txbr/version.rb

@@ -1,3 +1,3 @@
 module Txbr
-  VERSION = '2.4.1'
+  VERSION = '2.5.0'
 end

data/spec/campaign_spec.rb

@@ -10,28 +10,26 @@ describe Txbr::Campaign do
 
   let(:first_message) do
     <<~MESSAGE
-        {% assign project_slug = "my_project" %}
-        {% assign resource_slug = "my_resource" %}
-        {% assign translation_enabled = true %}
-        {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{resource_slug}} :save strings %}
-        {% connected_content http://my_strings_api.com?project_slug=my_project&resource_slug=my_footer_resource :save footer %}
-
-        {{strings.header | default: 'Buy our stuff!'}}
-        {% if user.gets_discount? %}
-          {{strings.discount | default: 'You get a discount'}}
-        {% else %}
-          {{strings.no_discount | default: 'You get no discount'}}
-        {% endif %}
-        {{footer.company | default: 'Megamarketing Corp'}}
+      {% assign project_slug = "my_project" %}
+      {% assign translation_enabled = true %}
+      {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{campaign.${api_id}}} :save strings %}
+      {% connected_content http://my_strings_api.com?project_slug=my_project&resource_slug=my_footer_resource :save footer %}
+
+      {{strings.header | default: 'Buy our stuff!'}}
+      {% if user.gets_discount? %}
+        {{strings.discount | default: 'You get a discount'}}
+      {% else %}
+        {{strings.no_discount | default: 'You get no discount'}}
+      {% endif %}
+      {{footer.company | default: 'Megamarketing Corp'}}
     MESSAGE
   end
 
   let(:second_message) do
     <<~HTML
       {% assign project_slug = "my_project" %}
-      {% assign resource_slug = "my_resource" %}
       {% assign translation_enabled = true %}
-      {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{resource_slug}} :save strings %}
+      {% connected_content http://my_strings_api.com?project_slug={{project_slug}}&resource_slug={{campaign.${api_id}}} :save strings %}
       {{strings.meta.subject_line | default: 'You lucky duck maybe'}}
     HTML
   end
@@ -60,7 +58,7 @@ describe Txbr::Campaign do
     it 'extracts and groups all strings with the same project, resource, and prefix' do
       resource = campaign.each_resource.to_a.first
       expect(resource.tx_resource.project_slug).to eq('my_project')
-      expect(resource.tx_resource.resource_slug).to eq('my_resource')
+      expect(resource.tx_resource.resource_slug).to eq(campaign_id)
 
       # notice how it combined strings from both messages,
       expect(resource.phrases).to eq([
@@ -76,7 +74,7 @@ describe Txbr::Campaign do
       tx_resource = resource.tx_resource
 
       expect(tx_resource.project_slug).to eq('my_project')
-      expect(tx_resource.resource_slug).to eq('my_resource')
+      expect(tx_resource.resource_slug).to eq(campaign_id)
       expect(tx_resource.source_file).to eq('World Domination')
       expect(tx_resource.source_lang).to eq(project.source_lang)
       expect(tx_resource.type).to eq(project.strings_format)
@@ -107,29 +105,26 @@ describe Txbr::Campaign do
     end
 
     context 'when the message comes from a separate resource' do
-      let(:first_message) do
-        super().tap do |subj|
-          subj.sub!(
-            'resource_slug = "my_resource"',
-            'resource_slug = "my_other_resource"'
-          )
-        end
-      end
-
       it 'includes the additional resource' do
         resources = campaign.each_resource.to_a
-        expect(resources.size).to eq(3)
+        expect(resources.size).to eq(2)
 
         expect(resources.first.phrases).to_not(
-          include({ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' })
+          include({ 'key' => 'company', 'string' => 'Megamarketing Corp' })
         )
 
-        expect(resources.last.phrases).to eq(
-          [{ 'key' => 'meta.subject_line', 'string' => 'You lucky duck maybe' }]
+        expect(resources.last.phrases).to(
+          include({ 'key' => 'company', 'string' => 'Megamarketing Corp' })
         )
 
-        expect(resources.first.tx_resource.project_slug).to eq('my_project')
-        expect(resources.first.tx_resource.resource_slug).to eq('my_other_resource')
+        first = resources.first.tx_resource
+        second = resources.last.tx_resource
+
+        expect(first.project_slug).to eq('my_project')
+        expect(first.resource_slug).to eq(campaign_id)
+
+        expect(second.project_slug).to eq('my_project')
+        expect(second.resource_slug).to eq('my_footer_resource')
       end
     end
 

data/spec/template_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe Txbr::Template do
+  subject { described_class.new(id, source, prerender_variables) }
+
+  let(:prerender_variables) { {} }
+  let(:id) { 'foobar' }
+  let(:source) do
+    <<~SRC
+      <h1>Braze campaign is {{campaign.${api_id}}}</h1>
+    SRC
+  end
+
+  context 'with a direct variable replacement' do
+    let(:prerender_variables) { { 'campaign.${api_id}' => 'abc123' } }
+
+    it 'prerenders correctly' do
+      expect(subject.render.strip).to eq("<h1>Braze campaign is abc123</h1>")
+    end
+  end
+
+  context 'with no variable replacements' do
+    it 'renders without erroring' do
+      expect { subject.render }.to_not raise_error
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: txbr
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Cameron Dutro
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-16 00:00:00.000000000 Z
+date: 2019-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: abroad
@@ -155,6 +155,7 @@ files:
 - spec/support/fake_connection.rb
 - spec/support/standard_setup.rb
 - spec/support/test_config.rb
+- spec/template_spec.rb
 - spec/uploader_spec.rb
 - spec/utils_spec.rb
 - txbr.gemspec