vignette 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee8ea3546f25377842740f40f7151c87acf9ade
-  data.tar.gz: 5d27a9f351421792d79a782faa420f4f9b82e098
+  metadata.gz: e2899584cc71727faccd169acd629f4823a1dcd8
+  data.tar.gz: f86dfe90395dbd08d08d426d83854034efb2986c
 SHA512:
-  metadata.gz: 96b339372591c6138ee84b52001e4b6f777b9a5c75f194a499742a85a68208187ee8dddd159886388d27ad25fdc162093bb2d2886f089423bc67bf8cba735b04
-  data.tar.gz: d5d633fce6996d3c6a5e194807a610d660604e6bfeee655da18ab54741d757abb2555e2429d9abc2616862006b6af2bcb5b4e801c65ecfa6362aa02f004852eb
+  metadata.gz: e3edfbbff798f29ef81d164fc8871643f1b74c2b2e649fe7abf939cb28a8348cf022594b5570f8c387fdc8408969eaaa4e85fdf0215612fb3947cd445d966520
+  data.tar.gz: f364423a9963b72b70ae0ba27b166d74623f216e289b48f69155332625c1483bf536d80984ca101f5fd45269aa201db8012cb206100a673460bd35ca4db8c2c6

data/README.md

@@ -72,6 +72,8 @@ Note, you must use arrays that will not change between runs.  Thus, `[Date.today
 
 If you choose to store your `tests` in `cookies`, then the chosen result will be stored in a cookie sent to the user's browser.  Thus, be careful not to store any secret information in a test.
 
+For unnamed tests, the system will try to determine the name from the line in the file (e.g. `(app/models/user.rb:50)`).  When it does this, it will keep the name the same so long as the underlying array has the same crc32 code.  That is, even if that vignette moves off of line 50, the test will keep the same "name" until the choices of the test change.  This is a trade-off to allow un-named vignettes to be easily understood in an analytics system without having to name each one unless you would like to.
+
 ## Naming Tests
 
 Vignette tests can also be specifically named, e.g:
@@ -82,12 +84,11 @@ Vignette tests can also be specifically named, e.g:
 or from HAML:
 
     %div
-      :vignette
-        [dog_names]
+      :vignette_dog_names
         Wooferson
         T-Bone
 
-This will lead to `Vignette.tests` to include: `{ "cat_names" => "Chairman Meow" }`
+This will lead to `Vignette.tests` to include: `{ "cat_names" => "Chairman Meow" }` and `{ "dog_names" => "Wooferson" }`, respectively.  Note, due to limitations in HAML, you must use a filter that starts with `vignette_` and uses only letters, numbers and underscores (`\w+`).
 
 Without a name, Vignettes will try to name themselves based on the name of the falling calling them, e.g. `(app/models/user.rb:25)` or `(app/views/users/new.html.haml:22)`
 

data/lib/vignette/filter.rb

@@ -10,8 +10,8 @@ if defined?(Haml)
       lines = text.split splitter
 
       # Allow first line to be name of test, if desired
-      if lines.first.strip =~ /^\[(\w+)\]$/
-        lines[1..-1].vignette($1)
+      if options[:name] && options[:name] =~ /vignette_(\w+)/i
+        lines.vignette($1)
 
       # Otherwise, try to use filename and line
       elsif options[:filename] && options[:line]
@@ -33,8 +33,11 @@ if defined?(Haml)
     # I removed that check from below.
     def compile(compiler, text)
       filter = self
+      node = compiler.instance_variable_get('@node')
+
       filename = compiler.options[:filename]
-      line = compiler.instance_variable_get('@node').line
+      line = node.line
+      name = node.value[:name]
 
       compiler.instance_eval do
         return if options[:suppress_eval]
@@ -52,7 +55,7 @@ if defined?(Haml)
         # too many.
         text = %[\n#{text.sub(/\n"\Z/, "\\n\"")}]
         push_script <<RUBY.rstrip, :escape_html => false
-find_and_preserve(#{filter.inspect}.render_with_options(#{text}, _hamlout.options.merge(filename: "#{filename}", line: #{line})))
+find_and_preserve(#{filter.inspect}.render_with_options(#{text}, _hamlout.options.merge(filename: "#{filename}", line: #{line}, name: "#{name}")))
 RUBY
         return
       end
@@ -64,4 +67,18 @@ RUBY
     end
   end
 
+  # This is hack to allow us to pull names from filters
+  module HamlCompilerHack
+
+    def compile_filter
+      if @node.value[:name] =~ /vignette_(\w+)/i
+        Haml::Filters::Vignette.internal_compile(self, @node.value[:text])
+      else
+        super
+      end
+
+    end
+  end
+
+  Haml::Compiler.prepend(HamlCompilerHack)
 end

data/lib/vignette/version.rb

@@ -1,3 +1,3 @@
 module Vignette
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/spec/lib/vignette/filter_spec.rb

@@ -4,9 +4,10 @@ describe Haml::Filters::Vignette do
 
   context "when parsing a haml template" do
     let!(:session) { Hash.new }
-    before(:each) { expect(Kernel).to receive(:rand).and_return(2) }
 
     context "with a rendered template and no file name" do
+      before(:each) { expect(Kernel).to receive(:rand).and_return(2) }
+
       let(:template) { "
 %p
   :vignette
@@ -26,10 +27,11 @@ describe Haml::Filters::Vignette do
     end
 
     context "with a rendered template" do
+      before(:each) { expect(Kernel).to receive(:rand).and_return(2) }
+
       let(:template) { "
 %p
-  :vignette
-    [numbers]
+  :vignette_numbers
     one
     two
     three
@@ -39,7 +41,7 @@ describe Haml::Filters::Vignette do
         Vignette.with_settings(nil, session, nil) do
           html = Haml::Engine.new(template).render
 
-          expect(html).to match(/\<p\>\s+three\s+\<\/p\>\n/)
+          expect(html).to eq("<p>\n  three\n</p>\n")
           expect(Vignette.tests).to eq({:"numbers" => "three"})
         end
       end
@@ -48,14 +50,35 @@ describe Haml::Filters::Vignette do
     context "with a template file" do
       let(:template_file) { File.join(File.dirname(__FILE__), '../../fixtures/ex.html.haml') }
 
+      before(:each) { expect(Kernel).to receive(:rand).and_return(2, 1) }
+
       it "should correctly call vignette from render" do
         Vignette.with_settings(nil, session, nil) do
           template = File.read(template_file)
 
           html = Haml::Engine.new(template, filename: template_file).render
 
-          expect(html).to match(/\<div\>\s+I like\s+scorpians\s+\<\/div\>/)
+          expect(html).to eq("<div>\n  I like\n  scorpians\n</div>\n")
+          expect(Vignette.tests).to eq({:"(ex.html.haml:3)" => "scorpians"})
+
+          # With a line number change
+          template2 = "%p Hi mom\n" + template
+
+          html2 = Haml::Engine.new(template2, filename: template_file).render
+
+          expect(html2).to eq("<p>Hi mom</p>\n<div>\n  I like\n  scorpians\n</div>\n")
           expect(Vignette.tests).to eq({:"(ex.html.haml:3)" => "scorpians"})
+
+          # With a vignette change
+          template3 = template2.gsub('cats', 'rats')
+
+          html3 = Haml::Engine.new(template3, filename: template_file).render
+
+          expect(html3).to eq("<p>Hi mom</p>\n<div>\n  I like\n  rats\n</div>\n")
+          expect(Vignette.tests).to eq({
+            :"(ex.html.haml:3)" => "scorpians",
+            :"(ex.html.haml:4)" => "rats"
+          })
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vignette
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Geoff Hayes