shopify_liquid_test_helper 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84284c898f11a3cdb722b02acd0ec877884b31a05fa0898ab5e7a928e6f20cae
-  data.tar.gz: c998c86408b453d132537b191f94faa96b5cd7f98459e948ccb8a41871fa4a5c
+  metadata.gz: 0ddfc04095edd38e1d15ea3077d4023f1e45c1527c8d8296180f6fe31ecd69f2
+  data.tar.gz: 8394cc4880370163215a194c95cc256acc7bc20f19dedf5ed4623af839f53bc1
 SHA512:
-  metadata.gz: 125d273dc6e140eadd9cc06d0cf788948d3ec1cc66089cfc7c3b27da865b0d4d3a83c388a0db69b3634067aeab525cc0e3e21a6cbb181d16bea0c01999935769
-  data.tar.gz: 6716beb9dfa4bfb3c6dc44ecf7bec268642bab035adfb595478e12eea4611bbbf4c2afcbd536976907d78849b7e743175d3c70a9af785dda59285b37919c4a38
+  metadata.gz: 63bab7c6a918c254bacbfa8343a1383b3f2ce73c495016f26ab82ce31533766a02e1cd54a33ec9d9d83658c022e5809f5cb68c4786599fec7f3a3812c78c2240
+  data.tar.gz: 49711d147d87237160f6fef93b64297ec8a18a9632ae3441944e6cbd553bb539eb03118cd14e51cea122b00ea8c078ada47fa2d64fca4b67138f26333b92ecd3

data/README.md

@@ -7,7 +7,6 @@ ShopifyLiquidTestHelper is a Ruby gem designed to assist in testing Shopify Liqu
 | Tag | Status |
 | --- | ------ |
 | `render` | ✅ |
-| `capture` | ✅ |
 
 
 ## Installation
@@ -138,6 +137,61 @@ end
 
 ShopifyLiquidTestHelper will automatically load the `product_card` snippet from the `snippets` directory when you use the `render` tag in your Liquid template.
 
+
+### Mocking render with `allow` in RSpec
+
+ShopifyLiquidTestHelper provides functionality to mock Liquid snippets using RSpec's `allow` method. This is particularly useful when testing templates that depend on other snippets.
+
+Here's a simple example of how to use `allow` for mocking:
+
+```liquid
+<!-- snippets/product.liquid -->
+<div class="product">
+  <h1>{{ product.title }}</h1>
+  <div class="price">
+    {% render 'product_price' %}
+  </div>
+  <div class="description">
+    {{ product.description }}
+  </div>
+  {% if product.available %}
+    <button type="button" class="add-to-cart">Add to Cart</button>
+  {% else %}
+    <p>Sold Out</p>
+  {% endif %}
+</div>
+```
+
+
+```ruby
+RSpec.describe 'ProductTemplate' do
+  let(:template) { ShopifyLiquidTestHelper.parse_template('snippets/product.liquid') }
+  let(:product) { { 'title' => 'Test Product', 'price' => 1000 } }
+
+  before do
+    # Mock the 'product_price' snippet to return a formatted price
+    allow(ShopifyLiquidTestHelper).to receive(:get_snippet).with('product_price').and_return('{{ product.price | money }}')
+  end
+
+  it 'renders the product title and price' do
+    rendered = template.render('product' => product)
+    expect(rendered).to include('Test Product')
+    expect(rendered).to include('$10.00')
+  end
+
+  context 'when the product is on sale' do
+    before do
+      # Override the mock for a specific test
+      allow(ShopifyLiquidTestHelper).to receive(:get_snippet).with('product_price').and_return('On Sale: {{ product.price | money }}')
+    end
+
+    it 'shows the sale price' do
+      rendered = template.render('product' => product)
+      expect(rendered).to include('On Sale: $10.00')
+    end
+  end
+end
+
 ### Customizing the Snippets Directory
 
 If your snippets are located in a different directory, you can specify the path when initializing ShopifyLiquidTestHelper:
@@ -216,7 +270,7 @@ This gem allows you to test your Shopify Liquid templates thoroughly, ensuring t
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/yourusername/shopify_liquid_test_helper.
+Bug reports and pull requests are welcome on GitHub at https://github.com/giwa/shopify_liquid_test_helper.
 
 ## License
 

data/lib/shopify_liquid_test_helper/integration.rb

@@ -0,0 +1 @@
+require 'shopify_liquid_test_helper/rspec_configuration'

data/lib/shopify_liquid_test_helper/matchers.rb

@@ -0,0 +1,40 @@
+module ShopifyLiquidTestHelper
+  module Matchers
+    extend RSpec::Matchers::DSL
+
+    matcher :render_liquid_template do |expected|
+      match do |template|
+        @rendered = if template.is_a?(String)
+                      Liquid::Template.parse(template).render(@assigns)
+                    elsif template.is_a?(Liquid::Template)
+                      template.render(@assigns)
+                    else
+                      raise ArgumentError, "Template must be a String or Liquid::Template object"
+                    end
+        @rendered == expected
+      end
+
+      chain :with do |assigns|
+        @assigns = assigns
+      end
+
+      failure_message do |template|
+        "expected that Liquid template \"#{template}\" " \
+        "would render as \"#{expected}\", but got \"#{@rendered}\""
+      end
+
+      failure_message_when_negated do |template|
+        "expected that Liquid template \"#{template}\" " \
+        "would not render as \"#{expected}\", but it did"
+      end
+
+      description do
+        "render Liquid template to \"#{expected}\""
+      end
+    end
+
+    def expect_liquid_template_result(template, expected, assigns = {})
+      expect(template).to render_liquid_template(expected).with(assigns)
+    end
+  end
+end

data/lib/shopify_liquid_test_helper/rspec_configuration.rb

@@ -0,0 +1,13 @@
+require 'rspec'
+require 'shopify_liquid_test_helper/test_helpers'
+require 'shopify_liquid_test_helper/matchers'
+
+RSpec.configure do |config|
+  config.include ShopifyLiquidTestHelper::Matchers
+  config.include ShopifyLiquidTestHelper::TestHelpers
+
+  config.before(:all) do
+    ShopifyLiquidTestHelper.register_custom_tags
+    ShopifyLiquidTestHelper.reset_snippets
+  end
+end

data/lib/shopify_liquid_test_helper/test_helpers.rb

@@ -0,0 +1,26 @@
+module ShopifyLiquidTestHelper
+  module TestHelpers
+    def parse_liquid(template)
+      Liquid::Template.parse(template)
+    end
+
+    def parse_liquid_file(template_name)
+      Liquid::Template.parse(File.read(template_name))
+    end
+
+    def render_liquid(template, assigns = {})
+      case template
+      when String
+        parse_liquid(template).render(assigns)
+      when Liquid::Template
+        template.render(assigns)
+      else
+        raise ArgumentError, "Template must be a String or Liquid::Template object"
+      end
+    end
+
+    def register_snippet(name, content)
+      ShopifyLiquidTestHelper.register_snippet(name, content)
+    end
+  end
+end

data/lib/shopify_liquid_test_helper.rb

@@ -1,19 +1,18 @@
+require 'shopify_liquid_simulator'
 require 'liquid'
-require 'shopify_liquid_test_helper/render_tag'
-require 'shopify_liquid_test_helper/capture_tag'
 
 module ShopifyLiquidTestHelper
   class << self
     attr_accessor :snippets_dir
+    attr_writer :snippet_provider
 
-    def parse_template(template_name)
+    def parse_liquid_file(template_name)
       Liquid::Template.parse(File.read(template_name))
     end
 
     def register_custom_tags
-      # TODO: separate tag implementations
-      Liquid::Template.register_tag('render', RenderTag)
-      Liquid::Template.register_tag('capture', CaptureTag)
+      ShopifyLiquidSimulator.register_tags
+      ShopifyLiquidSimulator::Render.snippet_provider = method(:get_snippet)
     end
 
     def register_snippet(name, content)
@@ -21,13 +20,25 @@ module ShopifyLiquidTestHelper
     end
 
     def get_snippet(name)
-      snippets[name] || load_snippet(name)
+      snippet_provider.call(name)
+    end
+
+    def reset_snippets
+      Thread.current[:snippets] = {}
+    end
+
+    def snippet_provider
+      @snippet_provider ||= method(:default_snippet_provider)
     end
 
     private
 
     def snippets
-      @snippets ||= {}
+      Thread.current[:snippets] ||= {}
+    end
+
+    def default_snippet_provider(name)
+      snippets[name] || load_snippet(name)
     end
 
     def load_snippet(name)
@@ -42,6 +53,7 @@ module ShopifyLiquidTestHelper
     end
   end
 
-  # デフォルトのsnippetsディレクトリを設定
   @snippets_dir = 'snippets'
-end
+end
+
+require 'shopify_liquid_test_helper/integration' if defined?(RSpec)

data/spec/{render_tag_spec.rb → shopify_liquid_test_helper_spec.rb}

@@ -1,8 +1,7 @@
 require 'spec_helper'
 
-RSpec.describe ShopifyLiquidTestHelper::RenderTag do
+RSpec.describe ShopifyLiquidTestHelper do
   before(:all) do
-    ShopifyLiquidTestHelper.register_custom_tags
     ShopifyLiquidTestHelper.register_snippet('simple', 'Hello, {{ name }}!')
     ShopifyLiquidTestHelper.register_snippet('for_loop', 'Item: {{ item }}')
     ShopifyLiquidTestHelper.register_snippet('with_object', 'Name: {{ object.name }}')
@@ -15,25 +14,25 @@ RSpec.describe ShopifyLiquidTestHelper::RenderTag do
   describe 'render tag' do
     it 'renders a simple snippet' do
       template = "{% render 'simple', name: 'World' %}"
-      expect(render(template)).to eq 'Hello, World!'
+      expect(template).to render_liquid_template('Hello, World!')
     end
 
     it 'renders a snippet with a for loop' do
       template = "{% render 'for_loop' for items as item %}"
       assigns = { 'items' => %w[A B C] }
-      expect(render(template, assigns)).to eq 'Item: AItem: BItem: C'
+      expect(template).to render_liquid_template('Item: AItem: BItem: C').with(assigns)
     end
 
     it 'renders a snippet with an object' do
       template = "{% render 'with_object' with user as object %}"
       assigns = { 'user' => { 'name' => 'John' } }
-      expect(render(template, assigns)).to eq 'Name: John'
+      expect(template).to render_liquid_template('Name: John').with(assigns)  
     end
 
     it 'does not allow access to variables outside the snippet' do
       ShopifyLiquidTestHelper.register_snippet('isolated', '{{ outside_var }}')
       template = "{% assign outside_var = 'Outside' %}{% render 'isolated' %}"
-      expect(render(template)).to eq ''
+      expect(template).to render_liquid_template('').with('outside_var' => 'Outside') 
     end
 
     it 'provides all forloop variables in for loop rendering' do
@@ -41,35 +40,18 @@ RSpec.describe ShopifyLiquidTestHelper::RenderTag do
                                         '{{ forloop.index }},{{ forloop.index0 }},{{ forloop.first }},{{ forloop.last }},{{ forloop.length }},{{ forloop.rindex }},{{ forloop.rindex0 }}|')
       template = "{% render 'forloop_vars' for items as item %}"
       assigns = { 'items' => %w[A B C] }
-      expect(render(template, assigns)).to eq '1,0,true,false,3,3,2|2,1,false,false,3,2,1|3,2,false,true,3,1,0|'
+      expect(template).to render_liquid_template('1,0,true,false,3,3,2|2,1,false,false,3,2,1|3,2,false,true,3,1,0|').with(assigns) 
     end
 
     it 'allows using an alias for the rendered variable' do
       template = "{% render 'simple' with 'Alias' as name %}"
-      expect(render(template)).to eq 'Hello, Alias!'
+      expect(template).to render_liquid_template('Hello, Alias!')
     end
 
     it 'does not pollute the outer scope' do
       template = "{% render 'simple' with 'Inner' as name %}{{ name }}"
       assigns = { 'name' => 'Outer' }
-      expect(render(template, assigns)).to eq 'Hello, Inner!Outer'
-    end
-  end
-
-  describe 'capture tag' do
-    it 'captures content into a variable' do
-      template = "{% capture my_variable %}Hello, Capture!{% endcapture %}{{ my_variable }}"
-      expect(render(template)).to eq 'Hello, Capture!'
-    end
-
-    it 'captures complex content with Liquid logic' do
-      template = "{% capture complex %}{% for i in (1..3) %}{{ i }}{% endfor %}{% endcapture %}{{ complex }}"
-      expect(render(template)).to eq '123'
-    end
-
-    it 'overwrites previously captured variables' do
-      template = "{% capture var %}First{% endcapture %}{% capture var %}Second{% endcapture %}{{ var }}"
-      expect(render(template)).to eq 'Second'
+      expect(template).to render_liquid_template('Hello, Inner!Outer').with(assigns)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'shopify_liquid_test_helper'
 
-RSpec.configure do |config|
-  config.before(:all) do
-    ShopifyLiquidTestHelper.register_custom_tags
-  end
-end
+# RSpec.configure do |config|
+#   config.before(:all) do
+#     ShopifyLiquidTestHelper.register_custom_tags
+#   end
+# end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_liquid_test_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Ken Takagiwa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-24 00:00:00.000000000 Z
+date: 2024-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: shopify_liquid_simulator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -63,11 +77,13 @@ files:
 - README.md
 - Rakefile
 - lib/shopify_liquid_test_helper.rb
-- lib/shopify_liquid_test_helper/capture_tag.rb
-- lib/shopify_liquid_test_helper/render_tag.rb
-- spec/render_tag_spec.rb
+- lib/shopify_liquid_test_helper/integration.rb
+- lib/shopify_liquid_test_helper/matchers.rb
+- lib/shopify_liquid_test_helper/rspec_configuration.rb
+- lib/shopify_liquid_test_helper/test_helpers.rb
+- spec/shopify_liquid_test_helper_spec.rb
 - spec/spec_helper.rb
-homepage: https://github.com/yourusername/shopify_liquid_test_helper
+homepage: https://github.com/giwa/shopify_liquid_test_helper
 licenses:
 - MIT
 metadata: {}

data/lib/shopify_liquid_test_helper/capture_tag.rb

@@ -1,14 +0,0 @@
-module ShopifyLiquidTestHelper
-  class CaptureTag < Liquid::Block
-    def initialize(tag_name, markup, tokens)
-      super
-      @variable_name = markup.strip
-    end
-
-    def render(context)
-      result = super
-      context.scopes.last[@variable_name] = result
-      ''
-    end
-  end
-end

data/lib/shopify_liquid_test_helper/render_tag.rb

@@ -1,107 +0,0 @@
-module ShopifyLiquidTestHelper
-  class RenderTag < Liquid::Tag
-    SYNTAX = /(#{Liquid::QuotedFragment}+)(\s+(?:with|for)\s+(#{Liquid::QuotedFragment}+))?(\s+as\s+(#{Liquid::QuotedFragment}+))?/o
-
-    def initialize(tag_name, markup, tokens)
-      super
-      parse_markup(markup)
-      @params = extract_params(markup)
-    end
-
-    def render(context)
-      snippet_name = resolve_snippet_name(context)
-      snippet = fetch_snippet(snippet_name)
-
-      temp_context = create_isolated_context(context)
-      variable = resolve_variable(context)
-
-      if @for_loop
-        render_for_loop(snippet, variable, temp_context)
-      else
-        render_with_variable(snippet, variable, temp_context)
-      end
-    end
-
-    private
-
-    def parse_markup(markup)
-      unless markup =~ SYNTAX
-        raise Liquid::SyntaxError,
-              "Syntax Error in 'render' - Valid syntax: render 'snippet' [with object|for array] [as alias]"
-      end
-
-      @snippet_name = ::Regexp.last_match(1)
-      @variable_name = ::Regexp.last_match(3)
-      @alias = ::Regexp.last_match(5)
-      @for_loop = ::Regexp.last_match(2) =~ /\s+for\s+/
-    end
-
-    def extract_params(markup)
-      params = {}
-      markup.scan(Liquid::TagAttributes) { |key, value| params[key] = value }
-      params
-    end
-
-    def resolve_snippet_name(context)
-      snippet_name = context[@snippet_name] || @snippet_name
-      snippet_name.gsub(/['"]/, '')
-    end
-
-    def fetch_snippet(snippet_name)
-      snippet = ShopifyLiquidTestHelper.get_snippet(snippet_name)
-      raise Liquid::SyntaxError, "Unknown snippet '#{snippet_name}'" unless snippet
-
-      snippet
-    end
-
-    def resolve_variable(context)
-      @variable_name ? context[@variable_name] : nil
-    end
-
-    def render_for_loop(snippet, array, context)
-      return unless array.respond_to?(:each)
-
-      array.each_with_index.map do |item, index|
-        item_context = create_item_context(context, item, index, array.size)
-        Liquid::Template.parse(snippet).render(item_context)
-      end.join
-    end
-
-    def create_item_context(context, item, index, array_size)
-      item_context = context.new_isolated_subcontext
-      item_context[@alias || 'item'] = item
-
-      item_context['forloop'] = {
-        'first' => index.zero?,
-        'index' => index + 1,
-        'index0' => index,
-        'last' => index == array_size - 1,
-        'length' => array_size,
-        'rindex' => array_size - index,
-        'rindex0' => array_size - index - 1
-      }
-
-      @params.each do |key, value|
-        item_context[key] = context[value] || context.evaluate(value) || value
-      end
-
-      item_context
-    end
-
-    def render_with_variable(snippet, variable, context)
-      context[@alias || 'object'] = variable if @variable_name
-
-      @params.each do |key, value|
-        context[key] = context[value] || context.evaluate(value) || value
-      end
-
-      Liquid::Template.parse(snippet).render(context)
-    end
-
-    def create_isolated_context(context)
-      new_context = context.new_isolated_subcontext
-      @params.each { |key, value| new_context[key] = context[value] || context.evaluate(value) || value }
-      new_context
-    end
-  end
-end