mvz-ruby-handlebars 0.0.8 → 0.0.9

data/spec/ruby-handlebars/helpers/each_helper_spec.rb

@@ -0,0 +1,331 @@
+require_relative '../../spec_helper'
+require_relative './shared'
+
+require_relative '../../../lib/ruby-handlebars'
+require_relative '../../../lib/ruby-handlebars/tree'
+require_relative '../../../lib/ruby-handlebars/helpers/each_helper'
+
+
+describe Handlebars::Helpers::EachHelper do
+  let(:subject) { Handlebars::Helpers::EachHelper }
+  let(:hbs) {Handlebars::Handlebars.new}
+  let(:ctx) {Handlebars::Context.new(hbs, {})}
+
+  it_behaves_like "a registerable helper", "each"
+
+  context '.apply' do
+    include_context "shared apply helper"
+
+    let(:values) { [Handlebars::Tree::String.new('a'), Handlebars::Tree::String.new('b'), Handlebars::Tree::String.new('c') ]}
+
+    it 'applies the block on all values' do
+      subject.apply(ctx, values, block, else_block)
+
+      expect(block).to have_received(:fn).exactly(3).times
+      expect(else_block).not_to have_received(:fn)
+    end
+
+    context 'when values is nil' do
+      let(:values) { nil }
+
+      it 'uses the else_block if provided' do
+        subject.apply(ctx, values, block, else_block)
+
+        expect(block).not_to have_received(:fn)
+        expect(else_block).to have_received(:fn).once
+      end
+
+      it 'returns nil if no else_block is provided' do
+        expect(subject.apply(ctx, values, block, nil)).to be nil
+      end
+    end
+
+    context 'when values is empty' do
+      let(:values) { [] }
+
+      it 'uses the else_block if provided' do
+        subject.apply(ctx, values, block, else_block)
+
+        expect(block).not_to have_received(:fn)
+        expect(else_block).to have_received(:fn).once
+      end
+
+      it 'returns nil if no else_block is provided' do
+        expect(subject.apply(ctx, values, block, nil)).to be nil
+      end
+    end
+  end
+
+  context 'integration' do
+    include_context "shared helpers integration tests"
+
+    let(:ducks) {[{name: 'Huey'}, {name: 'Dewey'}, {name: 'Louis'}]}
+
+    it 'simple case' do
+      template = [
+        "<ul>",
+        "{{#each items}}  <li>{{this.name}}</li>",
+        "{{/each}}</ul>"
+      ].join("\n")
+
+      data = {items: ducks}
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "  <li>Huey</li>",
+        "  <li>Dewey</li>",
+        "  <li>Louis</li>",
+        "</ul>"
+      ].join("\n"))
+
+      data = {items: []}
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    it 'considers not found items as an empty list and does not raise an error' do
+      template = [
+        "<ul>",
+        "{{#each stuff}}  <li>{{this.name}}</li>",
+        "{{/each}}</ul>"
+      ].join("\n")
+
+      expect(evaluate(template, {})).to eq([
+        "<ul>",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    it 'considers not found items as an empty list and uses else block if provided' do
+      template = [
+        "<ul>",
+        "{{#each stuff}}  <li>{{this.name}}</li>",
+        "{{else}}  <li>No stuff found....</li>",
+        "{{/each}}</ul>"
+      ].join("\n")
+
+      expect(evaluate(template, {})).to eq([
+        "<ul>",
+        "  <li>No stuff found....</li>",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    it 'works with non-hash data' do
+      template = [
+        "<ul>",
+        "{{#each items}}  <li>{{this.name}}</li>",
+        "{{/each}}</ul>"
+      ].join("\n")
+
+      data = double(items: ducks)
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "  <li>Huey</li>",
+        "  <li>Dewey</li>",
+        "  <li>Louis</li>",
+        "</ul>"
+      ].join("\n"))
+
+      data = {items: []}
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    it 'using an else statement' do
+      template = [
+        "<ul>",
+        "{{#each items}}  <li>{{this.name}}</li>",
+        "{{else}}  <li>No ducks to display</li>",
+        "{{/each}}</ul>"
+      ].join("\n")
+
+      data = {items: ducks}
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "  <li>Huey</li>",
+        "  <li>Dewey</li>",
+        "  <li>Louis</li>",
+        "</ul>"
+      ].join("\n"))
+
+      data = {items: []}
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "  <li>No ducks to display</li>",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    it 'imbricated' do
+      data = {people: [
+        {
+          name: 'Huey',
+          email: 'huey@junior-woodchucks.example.com',
+          phones: ['1234', '5678'],
+        },
+        {
+          name: 'Dewey',
+          email: 'dewey@junior-woodchucks.example.com',
+          phones: ['4321'],
+        }
+      ]}
+
+      template = [
+        "People:",
+        "<ul>",
+        "  {{#each people}}",
+        "  <li>",
+        "    <ul>",
+        "      <li>Name: {{this.name}}</li>",
+        "      <li>Phones: {{#each this.phones}} {{this}} {{/each}}</li>",
+        "      <li>email: {{this.email}}</li>",
+        "    </ul>",
+        "  </li>",
+        "  {{else}}",
+        "  <li>No one to display</li>",
+        "  {{/each}}",
+        "</ul>"
+      ].join("\n")
+
+      expect(evaluate(template, data)).to eq([
+        "People:",
+        "<ul>",
+        "  ",
+        "  <li>",
+        "    <ul>",
+        "      <li>Name: Huey</li>",
+        "      <li>Phones:  1234  5678 </li>",
+        "      <li>email: huey@junior-woodchucks.example.com</li>",
+        "    </ul>",
+        "  </li>",
+        "  ",
+        "  <li>",
+        "    <ul>",
+        "      <li>Name: Dewey</li>",
+        "      <li>Phones:  4321 </li>",
+        "      <li>email: dewey@junior-woodchucks.example.com</li>",
+        "    </ul>",
+        "  </li>",
+        "  ",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    context 'special variables' do
+      it '@first' do
+        template = [
+          "{{#each items}}",
+          "{{this}}",
+          "{{#if @first}}",
+          " first",
+          "{{/if}}\n",
+          "{{/each}}"
+        ].join
+        expect(evaluate(template, {items: %w(a b c)})).to eq("a first\nb\nc\n")
+      end
+
+      it '@last' do
+        template = [
+          "{{#each items}}",
+          "{{this}}",
+          "{{#if @last}}",
+          " last",
+          "{{/if}}\n",
+          "{{/each}}"
+        ].join
+        expect(evaluate(template, {items: %w(a b c)})).to eq("a\nb\nc last\n")
+      end
+
+      it '@index' do
+        template = [
+          "{{#each items}}",
+          "{{this}} {{@index}}\n",
+          "{{/each}}"
+        ].join
+        expect(evaluate(template, {items: %w(a b c)})).to eq("a 0\nb 1\nc 2\n")
+      end
+    end
+  end
+
+  context 'integration with "as |value|" notation' do
+    include_context "shared helpers integration tests"
+
+    let(:ducks) {[{name: 'Huey'}, {name: 'Dewey'}, {name: 'Louis'}]}
+
+    it 'simple case' do
+      template = [
+        "<ul>",
+        "{{#each items as |item|}}  <li>{{item.name}}</li>",
+        "{{/each}}</ul>"
+      ].join("\n")
+
+      data = {items: ducks}
+      expect(evaluate(template, data)).to eq([
+        "<ul>",
+        "  <li>Huey</li>",
+        "  <li>Dewey</li>",
+        "  <li>Louis</li>",
+        "</ul>"
+      ].join("\n"))
+    end
+
+    it 'imbricated' do
+      data = {people: [
+        {
+          name: 'Huey',
+          email: 'huey@junior-woodchucks.example.com',
+          phones: ['1234', '5678'],
+        },
+        {
+          name: 'Dewey',
+          email: 'dewey@junior-woodchucks.example.com',
+          phones: ['4321'],
+        }
+      ]}
+
+      template = [
+        "People:",
+        "<ul>",
+        "  {{#each people as |person| }}",
+        "  <li>",
+        "    <ul>",
+        "      <li>Name: {{person.name}}</li>",
+        "      <li>Phones: {{#each person.phones as |phone|}} {{phone}} {{/each}}</li>",
+        "      <li>email: {{person.email}}</li>",
+        "    </ul>",
+        "  </li>",
+        "  {{else}}",
+        "  <li>No one to display</li>",
+        "  {{/each}}",
+        "</ul>"
+      ].join("\n")
+
+      expect(evaluate(template, data)).to eq([
+        "People:",
+        "<ul>",
+        "  ",
+        "  <li>",
+        "    <ul>",
+        "      <li>Name: Huey</li>",
+        "      <li>Phones:  1234  5678 </li>",
+        "      <li>email: huey@junior-woodchucks.example.com</li>",
+        "    </ul>",
+        "  </li>",
+        "  ",
+        "  <li>",
+        "    <ul>",
+        "      <li>Name: Dewey</li>",
+        "      <li>Phones:  4321 </li>",
+        "      <li>email: dewey@junior-woodchucks.example.com</li>",
+        "    </ul>",
+        "  </li>",
+        "  ",
+        "</ul>"
+      ].join("\n"))
+    end
+  end
+end

data/spec/ruby-handlebars/helpers/helper_missing_helper_spec.rb

@@ -0,0 +1,45 @@
+require_relative '../../spec_helper'
+require_relative './shared'
+
+require_relative '../../../lib/ruby-handlebars'
+require_relative '../../../lib/ruby-handlebars/tree'
+require_relative '../../../lib/ruby-handlebars/helpers/helper_missing_helper'
+
+
+describe Handlebars::Helpers::HelperMissingHelper do
+  let(:subject) { Handlebars::Helpers::HelperMissingHelper }
+  let(:hbs) { Handlebars::Handlebars.new }
+  let(:ctx) {Handlebars::Context.new(hbs, {})}
+
+  it_behaves_like "a registerable helper", "helperMissing"
+
+  context '.apply' do
+    let(:name) { "missing_helper" }
+
+    it 'raises a Handlebars::UnknownHelper exception with the name given as a parameter' do
+      expect { subject.apply(ctx, name, nil, nil) }.to raise_exception(Handlebars::UnknownHelper, "Helper \"#{name}\" does not exist")
+    end
+  end
+
+  context 'integration' do
+    include_context "shared helpers integration tests"
+
+    context 'is called when an unknown helper is called in a template' do
+      it 'should provide a useful error message with inline helpers' do
+        expect { evaluate('{{unknown "This will hardly work" }}') }.to raise_exception(Handlebars::UnknownHelper, 'Helper "unknown" does not exist')
+      end
+
+      it 'should provide a useful error message with block helpers' do
+        expect { evaluate('{{#unknown}}This will hardly work{{/unknown}}') }.to raise_exception(Handlebars::UnknownHelper, 'Helper "unknown" does not exist')
+      end
+    end
+
+    it 'can be overriden easily' do
+      hbs.register_helper('helperMissing') do |context, name|
+        # Do nothing
+      end
+
+      expect { evaluate('{{unknown "This will hardly work" }}') }.not_to raise_exception
+    end
+  end
+end

data/spec/ruby-handlebars/helpers/if_helper_spec.rb

@@ -0,0 +1,90 @@
+require_relative '../../spec_helper'
+require_relative './shared'
+
+require_relative '../../../lib/ruby-handlebars'
+require_relative '../../../lib/ruby-handlebars/helpers/if_helper'
+
+
+describe Handlebars::Helpers::IfHelper do
+  let(:subject) { Handlebars::Helpers::IfHelper }
+  let(:hbs) {Handlebars::Handlebars.new}
+  let(:ctx) {Handlebars::Context.new(hbs, {})}
+
+  it_behaves_like "a registerable helper", "if"
+
+  context '.apply' do
+    it_behaves_like "a helper running the main block", 'true', true
+    it_behaves_like "a helper running the main block", 'a non-empty string', 'something'
+    it_behaves_like "a helper running the main block", 'a non-empty list', ['a']
+    it_behaves_like "a helper running the main block", 'a non-empty hash', {a: 'b'}
+
+    it_behaves_like "a helper running the else block", "false", false
+    it_behaves_like "a helper running the else block", "an empty string", ""
+    it_behaves_like "a helper running the else block", "an empty list", []
+    it_behaves_like "a helper running the else block", "an empty hash", {}
+
+    context 'when else_block is not present' do
+      include_context "shared apply helper"
+      let(:params) { false }
+      let(:else_block) { nil }
+
+      it 'returns an empty-string' do
+        expect(subject.apply(ctx, params, block, else_block)).to eq("")
+
+        expect(block).not_to have_received(:fn)
+        expect(else_block).not_to have_received(:fn)
+      end
+    end
+  end
+
+  context 'integration' do
+    include_context "shared helpers integration tests"
+
+    context 'if' do
+      it 'without else' do
+        template = [
+          "{{#if condition}}",
+          "  Show something",
+          "{{/if}}"
+        ].join("\n")
+        expect(evaluate(template, {condition: true})).to eq("\n  Show something\n")
+        expect(evaluate(template, {condition: false})).to eq("")
+      end
+
+      it 'with an else' do
+        template = [
+          "{{#if condition}}",
+          "  Show something",
+          "{{ else }}",
+          "  Do not show something",
+          "{{/if}}"
+        ].join("\n")
+        expect(evaluate(template, {condition: true})).to eq("\n  Show something\n")
+        expect(evaluate(template, {condition: false})).to eq("\n  Do not show something\n")
+      end
+
+      it 'imbricated ifs' do
+        template = [
+          "{{#if first_condition}}",
+          "  {{#if second_condition}}",
+          "    Case 1",
+          "  {{else}}",
+          "    Case 2",
+          "  {{/if}}",
+          "{{else}}",
+          "  {{#if second_condition}}",
+          "    Case 3",
+          "  {{else}}",
+          "    Case 4",
+          "  {{/if}}",
+          "{{/if}}"
+        ].join("\n")
+
+        expect(evaluate(template, {first_condition: true, second_condition: true}).strip).to eq("Case 1")
+        expect(evaluate(template, {first_condition: true, second_condition: false}).strip).to eq("Case 2")
+        expect(evaluate(template, {first_condition: false, second_condition: true}).strip).to eq("Case 3")
+        expect(evaluate(template, {first_condition: false, second_condition: false}).strip).to eq("Case 4")
+      end
+    end
+  end
+end