mixpal 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8c9c74b1185daabd7b04ce5ac8865084eeaa8ca222c342c12ace6e4d1c444cd
-  data.tar.gz: 82a07a359fe377bd2dbf60e95f9eb20d79afb764a4c50219846e529c981e271a
+  metadata.gz: c6f66eee2ba6982bd46527e9bb5e39dea9f45f71486f0ab8e5cc83237e4cf017
+  data.tar.gz: c11d9ee0b87ae7b4c8ef6230bcd98aab358e34ffb9bbb9ef482cf15f8a7301d2
 SHA512:
-  metadata.gz: 9dcceef2cf2269fc79e6c45675702ecc7e568c7340dedc62d45d358d15ff52c87a2c15d257d986bae53004d7c78a305706912f590448877d29622fc0a0f1df36
-  data.tar.gz: a989eb95e2e2ac576379e4bcc63d161f1d8815774f8ee1a079e735a42da24ed3e7e6dbc42547a285263c4bc5c5642a660de2f5dac8881249d5b5d33bae93baa5
+  metadata.gz: b968446550407fe603d29bd7ec1bb42adcaec1505232a4826a62184a0bb705f1c04ccb0ba1af5a7998ed20b83ecf57e4d0c2fffd373ec461f5195d981af24bc6
+  data.tar.gz: ff250e09fe05911ca0432d28bcef0f6bfb13b8c2246218ced5515f1c43c443b248f9cf3bafb523ff5af45c7a16f19b74117a42032d6d7d4ea2a951d11b9f5e92

data/README.md

@@ -162,5 +162,5 @@ prefer local development, inspect the Dockerfile to get your local env built.
 docker-compose build \
   --build-arg USER_ID=$(id -u) \
   --build-arg GROUP_ID=$(id -g)
-docker-compose run rake release
+docker-compose run gem rake release
 ```

data/lib/mixpal/snippet.rb

@@ -0,0 +1,23 @@
+module Mixpal
+  class Snippet
+    attr_reader :snippet
+
+    def initialize(snippet)
+      @snippet = snippet
+    end
+
+    def render
+      snippet.html_safe
+    end
+
+    def to_store
+      {
+        'snippet' => snippet
+      }
+    end
+
+    def self.from_store(data)
+      new(data['snippet'])
+    end
+  end
+end

data/lib/mixpal/tracker.rb

@@ -1,6 +1,6 @@
 module Mixpal
   class Tracker
-    attr_reader :events, :user_updates, :revenue_updates, :identity, :alias_user
+    attr_reader :events, :user_updates, :revenue_updates, :identity, :alias_user, :js_snippets
 
     STORAGE_KEY = 'mixpal'
 
@@ -10,6 +10,7 @@ module Mixpal
       @events = []
       @user_updates = []
       @revenue_updates = []
+      @js_snippets = []
 
       @identity = args[:identity]
     end
@@ -31,6 +32,10 @@ module Mixpal
       revenue_updates << Mixpal::Revenue.new(amount, properties)
     end
 
+    def add_js_snippet(snippet)
+      js_snippets << Mixpal::Snippet.new(snippet)
+    end
+
     def render
       ''.tap do |html|
         html << '<script type="text/javascript">'
@@ -39,6 +44,7 @@ module Mixpal
         html << events.map(&:render).join('')
         html << user_updates.map(&:render).join('')
         html << revenue_updates.map(&:render).join('')
+        html << js_snippets.map(&:render).join('')
         html << '</script>'
       end.html_safe
     end
@@ -58,13 +64,15 @@ module Mixpal
       end
 
       if data['user_updates']
-        @user_updates =
-          data['user_updates'].map { |u| Mixpal::User.from_store(u) }
+        @user_updates = data['user_updates'].map { |u| Mixpal::User.from_store(u) }
       end
 
       if data['revenue_updates']
-        @revenue_updates =
-          data['revenue_updates'].map { |u| Mixpal::Revenue.from_store(u) }
+        @revenue_updates = data['revenue_updates'].map { |u| Mixpal::Revenue.from_store(u) }
+      end
+
+      if data['js_snippets']
+        @js_snippets = data['js_snippets'].map { |u| Mixpal::Snippet.from_store(u) }
       end
 
       session.delete(STORAGE_KEY)
@@ -78,7 +86,8 @@ module Mixpal
         'identity' => identity,
         'events' => events.map(&:to_store),
         'user_updates' => user_updates.map(&:to_store),
-        'revenue_updates' => revenue_updates.map(&:to_store)
+        'revenue_updates' => revenue_updates.map(&:to_store),
+        'js_snippets' => js_snippets.map(&:to_store)
       }
     end
   end

data/lib/mixpal/util.rb

@@ -5,12 +5,22 @@ module Mixpal
         hash.reject! { |_, v| v.nil? }
 
         contents = hash.map do |k, v|
-          js_value = v.is_a?(String) || v.is_a?(Time) ? "\"#{v}\"" : v
-          "\"#{k}\": #{js_value}"
+          "\"#{k}\": #{escape_js_object_value(v)}"
         end.join(',').html_safe
 
         "{#{contents}}"
       end
+
+      def escape_js_object_value(value)
+        case value
+        when String
+          value.dump
+        when Time
+          "\"#{value}\""
+        else
+          value
+        end
+      end
     end
   end
 end

data/lib/mixpal/version.rb

@@ -1,3 +1,3 @@
 module Mixpal
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/mixpal.rb

@@ -9,6 +9,7 @@ module Mixpal
   autoload :User, 'mixpal/user'
   autoload :Revenue, 'mixpal/revenue'
   autoload :Integration, 'mixpal/integration'
+  autoload :Snippet, 'mixpal/snippet'
 
   class << self
     def configuration

data/mixpanel_assistant.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rubocop", "~> 0.91.0"
-  spec.add_development_dependency "rspec", "~> 3.9.0"
+  spec.add_development_dependency "rspec", "~> 3.13.0"
   spec.add_development_dependency "guard-rspec", "~> 4.7.3"
   spec.add_development_dependency "rb-fsevent", "~> 0.10.4"
   spec.add_development_dependency "awesome_print", "~> 1.8.0"

data/spec/lib/mixpal/snippet_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe Mixpal::Snippet do
+  let(:snippet) { 'alert("hello world");' }
+  subject { described_class.new(snippet) }
+
+  describe '#render' do
+    it 'outputs the snippet string' do
+      expect(subject.render).to eq 'alert("hello world");'
+    end
+
+    it 'outputs an html safe string' do
+      expect(subject.render).to be_html_safe
+    end
+  end
+
+  describe '#to_store' do
+    it 'returns a hash with its data' do
+      expect(subject.to_store).to eq('snippet' => snippet)
+    end
+  end
+
+  describe '.from_store' do
+    let(:result) do
+      described_class.from_store('snippet' => snippet)
+    end
+
+    it 'instantiates a new instance' do
+      expect(result).to be_an_instance_of(described_class)
+    end
+
+    it 'sets its snippet string from the data' do
+      expect(result.snippet).to eq snippet
+    end
+  end
+end

data/spec/lib/mixpal/tracker_spec.rb

@@ -30,6 +30,10 @@ describe Mixpal::Tracker do
       expect(subject.revenue_updates).to eq []
     end
 
+    it 'creates an empty set of arbitrary javascript snippets' do
+      expect(subject.js_snippets).to eq []
+    end
+
     context 'with an :identity arg' do
       subject { subject_with_identity }
 
@@ -102,6 +106,22 @@ describe Mixpal::Tracker do
     end
   end
 
+  describe '#add_js_snippet' do
+    it 'instantiates a new Snippet object with properties' do
+      snippet = "alert('hello world');"
+
+      expect(Mixpal::Snippet).to receive(:new).with(snippet)
+      subject.add_js_snippet(snippet)
+    end
+
+    it 'adds the Snippet to js_snippets for rendering later' do
+      expect { subject.add_js_snippet("alert('hello world');") }
+        .to change(subject.js_snippets, :size).by(1)
+
+      expect(subject.js_snippets.first).to be_an_instance_of(Mixpal::Snippet)
+    end
+  end
+
   describe '#render' do
     it 'outputs script tag' do
       expect(subject.render).to have_tag('script')
@@ -190,6 +210,23 @@ describe Mixpal::Tracker do
         expect(subject.render).to include joined
       end
     end
+
+    context 'with js snippets' do
+      before do
+        subject.add_js_snippet('alert("hello world");')
+        subject.add_js_snippet('arbitraryFunctionCall();')
+      end
+
+      it 'delegates render to the events' do
+        subject.js_snippets.each { |snippet| expect(snippet).to receive :render }
+        subject.render
+      end
+
+      it 'joins each rendered snippet' do
+        joined = subject.js_snippets[0].render + subject.js_snippets[1].render
+        expect(subject.render).to include joined
+      end
+    end
   end
 
   describe '#store!' do
@@ -251,6 +288,25 @@ describe Mixpal::Tracker do
         )
       end
     end
+
+    context 'when js_snippets have been added' do
+      before do
+        subject.add_js_snippet('alert("hello world");')
+        subject.add_js_snippet('arbitraryFunctionCall();')
+      end
+
+      it 'delegates composition to the snippets' do
+        subject.js_snippets.each { |snippet| expect(snippet).to receive :to_store }
+        subject.store!(session)
+      end
+
+      it 'stores the snippets in an array' do
+        subject.store!(session)
+        expect_storage_to_include(
+          'js_snippets' => [subject.js_snippets[0].to_store, subject.js_snippets[1].to_store]
+        )
+      end
+    end
   end
 
   describe '#restore!' do
@@ -260,6 +316,7 @@ describe Mixpal::Tracker do
     before do
       old_tracker.track 'Event 1'
       old_tracker.register_user name: 'Nick Giancola'
+      old_tracker.add_js_snippet("alert('hello world');")
       old_tracker.store!(session)
     end
 
@@ -280,9 +337,16 @@ describe Mixpal::Tracker do
       subject.restore!(session)
     end
 
-    it 'restores the events' do
+    it 'restores the snippets' do
+      subject.restore!(session)
+      expect(subject.js_snippets.size).to eq 1
+    end
+
+    it 'delegates snippet restoration to the Snippet class' do
+      expect(Mixpal::Snippet).to receive(:from_store)
+        .with(old_tracker.js_snippets.first.to_store)
+
       subject.restore!(session)
-      expect(subject.events.size).to eq 1
     end
 
     context 'with a different identity (e.g. after login)' do

data/spec/lib/mixpal/util_spec.rb

@@ -24,5 +24,10 @@ describe Mixpal::Util do
       expect(subject.hash_to_js_object_string(age: 21, gender: nil))
         .to eq '{"age": 21}'
     end
+
+    it 'escapes double quotes in values' do
+      expect(subject.hash_to_js_object_string(key: 'value "with" quotes'))
+        .to eq '{"key": "value \"with\" quotes"}'
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mixpal
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - patbenatar
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-03 00:00:00.000000000 Z
+date: 2024-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.9.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +187,7 @@ files:
 - lib/mixpal/event.rb
 - lib/mixpal/integration.rb
 - lib/mixpal/revenue.rb
+- lib/mixpal/snippet.rb
 - lib/mixpal/tracker.rb
 - lib/mixpal/user.rb
 - lib/mixpal/util.rb
@@ -194,6 +195,7 @@ files:
 - mixpanel_assistant.gemspec
 - spec/lib/mixpal/event_spec.rb
 - spec/lib/mixpal/revenue_spec.rb
+- spec/lib/mixpal/snippet_spec.rb
 - spec/lib/mixpal/tracker_spec.rb
 - spec/lib/mixpal/user_spec.rb
 - spec/lib/mixpal/util_spec.rb
@@ -279,6 +281,7 @@ summary: As the JavaScript library is Mixpanel's preferred method of usage, Mixp
 test_files:
 - spec/lib/mixpal/event_spec.rb
 - spec/lib/mixpal/revenue_spec.rb
+- spec/lib/mixpal/snippet_spec.rb
 - spec/lib/mixpal/tracker_spec.rb
 - spec/lib/mixpal/user_spec.rb
 - spec/lib/mixpal/util_spec.rb