minitest_shopify_themes 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c93992986e47e83e7d81af19832e5fbdd05281444dc20992a7bf5fcce9e0886b
+  data.tar.gz: 646dcc863bc5ceebae020eaac691d2eebca236aedb120665fb0bd41c6127a695
+SHA512:
+  metadata.gz: a501321c5e52ed4d1efa4e8aa5635069a24d8a8694ebcb86a11eb688d58704bbe701c282e6fa65dd0b14a43606a167dbaf417c2743fc0fc6340614e7ada43a88
+  data.tar.gz: e32d14b57184b516fa70340d42f142903a79b5cbcac6343ff438878a314d330ead7b7a2a88662b7c65ba4e5eb21fe12336d6d3e3c3f18040b995e0c8de84e1bb

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/README.md

@@ -0,0 +1,72 @@
+# Minitest Shopify
+
+Prototype of a minitest test class with capybara assertions capable of rendering sections and snippets of a liquid based Shopify theme.
+
+## Example
+```ruby
+MinitestShopifyThemes.configure do |config|
+  config.theme_root = File.join(__dir__, "theme")
+  config.selenium_driver = :selenium_chrome_headless
+  config.layout_file = "layout/theme"
+end
+```
+
+```ruby
+require "minitest/autorun"
+require "minitest_shopify_themes"
+
+class TestCard < MinitestShopifyThemes::LiquidTest
+  def test_renders_a_card
+    render template: "snippets/card", variables: { comment: default_comment }
+    assert_text "Hello world!"
+    assert_text "John Doe"
+  end
+
+  private
+
+  def default_comment
+    {
+      id: 1,
+      created_at: "2023-07-20T19:31:35Z",
+      content: "Hello world!",
+      author: {
+        id: 1,
+        name: "John Doe"
+      }
+    }
+  end
+end
+```
+
+You can also use selenium to run tests that involve JavaScript or assets:
+
+```ruby
+require "minitest/autorun"
+require "minitest_shopify_themes"
+
+class TestCardView < MinitestShopifyThemes::ViewTest
+  def test_javascript_enabled_card
+    render template: "snippets/js-card", variables: { comment: default_comment }
+    within "#comment-1" do
+      assert_text "Javascript is enabled"
+      assert_no_text "Hello World"
+    end
+  end
+
+  private
+
+  def default_comment
+    {
+      id: 1,
+      content: "Hello world!",
+    }
+  end
+end
+```
+
+## Installation
+This is an experiment for the time being, if you want to try it out for yourself you can add the following definition to your gemfile:
+
+```ruby
+gem "minitest_shopify_themes", git: "https://github.com/nebulab/minitest_shopify_themes.git", branch: "main"
+```

data/Rakefile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test)
+task default: :test

data/lib/minitest_shopify_themes/configuration.rb

@@ -0,0 +1,28 @@
+require "pathname"
+require "liquid"
+
+class MinitestShopifyThemes::Configuration
+  attr_reader :theme_root
+  attr_accessor :selenium_driver, :layout_file
+
+  def initialize
+    self.theme_root = "./theme"
+    @selenium_driver = :selenium_chrome_headless
+    @layout_file = nil
+  end
+
+  def theme_root=(value)
+    @theme_root = Pathname(value).expand_path
+
+    # We set up a file system to be able to render snippets from within
+    # the templates we provide to the render method.  The render method is
+    # only used to render a snippet or app block, however, we cannot
+    # emulate the render of an app block, so its okay to default to
+    # snippets.
+    Liquid::Environment.default.file_system = MinitestShopifyThemes::LocalFileSystem.new(@theme_root.to_s, "snippets/%s.liquid")
+  end
+
+  def assets_dir
+    @theme_root&.join("assets")
+  end
+end

data/lib/minitest_shopify_themes/filters/assets_filter.rb

@@ -0,0 +1,15 @@
+module MinitestShopifyThemes::Filters::AssetsFilter
+  def asset_url(input)
+    File.join("/assets", input)
+  end
+
+  def script_tag(input)
+    "<script src=\"#{input}\" type=\"text/javascript\"></script>"
+  end
+
+  def stylesheet_tag(input)
+    "<link href=\"#{input}\" rel=\"stylesheet\" type=\"text/css\" media=\"all\" />"
+  end
+
+  Liquid::Environment.default.register_filter(self)
+end

data/lib/minitest_shopify_themes/filters/image_filter.rb

@@ -0,0 +1,12 @@
+module MinitestShopifyThemes::Filters::ImageFilter
+  def image_url(input, width = nil, height = nil)
+    input
+  end
+
+  def image_tag(input, args = [])
+    attributes = args.map { |k, v| "#{k}=\"#{v}\"" }.join(" ")
+    "<img src=\"#{input}\" #{attributes} />"
+  end
+
+  Liquid::Environment.default.register_filter(self)
+end

data/lib/minitest_shopify_themes/filters/money_filter.rb

@@ -0,0 +1,29 @@
+require 'money'
+
+module MinitestShopifyThemes::Filters::MoneyFilter
+  module TestHelper
+    def setup
+      super
+      Money.locale_backend = :i18n
+    end
+  end
+
+  class ShopifyMoney < Money
+    self.rounding_mode = BigDecimal::ROUND_HALF_UP
+    self.locale_backend = :i18n
+
+    def to_liquid
+      to_json
+    end
+
+    def to_liquid_value
+      to_html
+    end
+  end
+
+  def money(input, currency: "USD")
+    ShopifyMoney.new(input, currency)
+  end
+
+  Liquid::Environment.default.register_filter(self)
+end

data/lib/minitest_shopify_themes/filters/translations_filter.rb

@@ -0,0 +1,46 @@
+require 'i18n'
+
+module MinitestShopifyThemes::Filters::TranslationsFilter
+  module TestHelper
+    def setup
+      super
+
+      Dir["#{MinitestShopifyThemes.configuration.theme_root}/locales/*.json"].each do |file|
+        next if file.end_with?('.schema.json')
+
+        command = %{node -pe "JSON.stringify(eval('data='+require('fs').readFileSync(0, 'utf8')))"}
+        # Use Node.js to parse JSON, as it handles comments in JSON files
+        # and is more lenient than Ruby's JSON parser.
+        r, w = IO.pipe
+        pid = Process.spawn(command, in: file, out: w, err: :close, close_others: true)
+        w.close
+        Process.wait(pid)
+        raise "Failed to parse JSON from #{file}" unless $?.success?
+        contents = r.read
+        r.close
+        require 'json'
+        data = JSON.parse!(contents) rescue binding.irb
+        locale = File.basename(file, '.json').chomp(".default")
+        I18n.backend.store_translations(locale.to_sym, data)
+        if file.end_with?('.default.json')
+          @default_locale = locale.to_sym
+        end
+      end
+
+      I18n.locale = @default_locale || I18n.default_locale
+    end
+  end
+
+  def t(key, variables = {})
+    I18n.t(key).gsub(/{{\s*([a-zA-Z0-9_]+)\s*}}/) do |match|
+      var_name = $1
+      if variables.key?(var_name)
+        variables[var_name].to_s
+      else
+        match # Return the original match if variable not found
+      end
+    end
+  end
+
+  Liquid::Environment.default.register_filter(self)
+end

data/lib/minitest_shopify_themes/liquid_test.rb

@@ -0,0 +1,51 @@
+require "minitest/autorun"
+require "capybara/minitest"
+require "liquid"
+require "loofah"
+
+MinitestShopifyThemes.loader.eager_load_namespace(MinitestShopifyThemes::Tags)
+MinitestShopifyThemes.loader.eager_load_namespace(MinitestShopifyThemes::Filters)
+
+class MinitestShopifyThemes::LiquidTest < Minitest::Test
+  include Capybara::Minitest::Assertions
+  include MinitestShopifyThemes::Filters::TranslationsFilter::TestHelper
+  include MinitestShopifyThemes::Filters::MoneyFilter::TestHelper
+
+  def render(template:, variables: {})
+    @page = render_liquid(template:, variables:)
+
+    if MinitestShopifyThemes.configuration.layout_file
+      @page = render_liquid(
+        template: MinitestShopifyThemes.configuration.layout_file,
+        variables: variables.merge({ content_for_layout: @page })
+      )
+    end
+  end
+
+  # Helper to enable Capybara assertions on the rendered template.
+  def page
+    Capybara.string(@page)
+  end
+
+  def render_liquid(template:, variables:)
+    file = File.read(File.join(MinitestShopifyThemes.configuration.theme_root, template) + ".liquid")
+    template = Liquid::Template.parse(file, error_mode: :strict)
+    @output = template.render!(deep_stringify_keys(variables), {strict_variables: true, strict_filters: true})
+  end
+
+  def text
+    html&.to_text(encode_special_chars: false).gsub(/\s+/, ' ').strip
+  end
+
+  def html
+    Loofah.html5_fragment(@output)
+  end
+
+  def deep_stringify_keys(hash)
+    # Liquid expects string keys for variables, but Rails convention is to use symbols.
+    # This method recursively converts all keys to strings so either convention can be used.
+    hash.each_with_object({}) do |(key, value), acc|
+      acc[key.to_s] = value.is_a?(Hash) ? deep_stringify_keys(value) : value
+    end
+  end
+end

data/lib/minitest_shopify_themes/local_file_system.rb

@@ -0,0 +1,24 @@
+require "liquid"
+
+module MinitestShopifyThemes
+  # This is an override for the LocalFileSystem that is part of Liquid
+  # gem.  However, out of the box it does not support snippets with a
+  # '-' in the name.  This override exists to allow for that and achieve
+  # parity with Shopify.  We might want to push this upstream to the
+  # Liquid gem.
+  class LocalFileSystem < Liquid::LocalFileSystem
+    def full_path(template_path)
+      raise ::Liquid::FileSystemError, "Illegal template name '#{template_path}'" unless %r{\A[^./][a-zA-Z0-9_\-/]+\z}.match?(template_path)
+
+      full_path = if template_path.include?('/')
+        File.join(root, File.dirname(template_path), @pattern % File.basename(template_path))
+      else
+        File.join(root, @pattern % template_path)
+      end
+
+      raise ::Liquid::FileSystemError, "Illegal template path '#{File.expand_path(full_path)}'" unless File.expand_path(full_path).start_with?(File.expand_path(root))
+
+      full_path
+    end
+  end
+end

data/lib/minitest_shopify_themes/tags/schema_tag.rb

@@ -0,0 +1,8 @@
+class MinitestShopifyThemes::Tags::SchemaTag < Liquid::Block
+  def render(context)
+    # The schema tag renders nothing.
+    nil
+  end
+
+  Liquid::Environment.default.register_tag('schema', self)
+end

data/lib/minitest_shopify_themes/tags/section_tag.rb

@@ -0,0 +1,13 @@
+class MinitestShopifyThemes::Tags::SectionTag < Liquid::Tag
+  def initialize(tag_name, section_name, options)
+    @section_name = section_name.strip.gsub("'", "")
+  end
+
+  def render(context)
+    file = MinitestShopifyThemes.configuration.theme_root.join("sections", @section_name + ".liquid").read
+    template = Liquid::Template.parse(file, error_mode: :strict)
+    template.render!
+  end
+
+  Liquid::Environment.default.register_tag('section', self)
+end

data/lib/minitest_shopify_themes/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MinitestShopifyThemes
+  VERSION = "0.2.0"
+end

data/lib/minitest_shopify_themes/view_test.rb

@@ -0,0 +1,37 @@
+class MinitestShopifyThemes::ViewTest < MinitestShopifyThemes::LiquidTest
+  include Capybara::DSL
+
+  VIEWS_DIR = Dir.mktmpdir
+  Minitest.after_run { FileUtils.remove_entry VIEWS_DIR }
+  Capybara.server = :puma, { Silent: true }
+
+  def setup
+    Capybara.current_driver = MinitestShopifyThemes.configuration.selenium_driver
+    Capybara.app ||= Rack::Lint.new Rack::Cascade.new [
+      Rack::Files.new(VIEWS_DIR),
+      Rack::URLMap.new("/assets" => Rack::Files.new(MinitestShopifyThemes.configuration.assets_dir)),
+    ]
+  end
+
+  def teardown
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+
+  def render(**)
+    super
+    host_page do |path|
+      visit path
+    end
+  end
+
+  private
+
+  def host_page
+    Tempfile.create(['', '.html'], VIEWS_DIR) do |f|
+      f.write(@page)
+      f.flush
+      yield Pathname.new(f.path).basename
+    end
+  end
+end

data/lib/minitest_shopify_themes.rb

@@ -0,0 +1,19 @@
+require_relative "minitest_shopify_themes/version"
+require "zeitwerk"
+
+module MinitestShopifyThemes
+  def self.loader
+    @loader ||= Zeitwerk::Loader.for_gem
+  end
+
+  loader.setup
+  # loader.eager_load # optionally
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: minitest_shopify_themes
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nick Belzer
+bindir: exe
+cert_chain: []
+date: 2025-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: money
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: loofah
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+email: nickbelzer@nebulab.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- README.md
+- Rakefile
+- lib/minitest_shopify_themes.rb
+- lib/minitest_shopify_themes/configuration.rb
+- lib/minitest_shopify_themes/filters/assets_filter.rb
+- lib/minitest_shopify_themes/filters/image_filter.rb
+- lib/minitest_shopify_themes/filters/money_filter.rb
+- lib/minitest_shopify_themes/filters/translations_filter.rb
+- lib/minitest_shopify_themes/liquid_test.rb
+- lib/minitest_shopify_themes/local_file_system.rb
+- lib/minitest_shopify_themes/tags/schema_tag.rb
+- lib/minitest_shopify_themes/tags/section_tag.rb
+- lib/minitest_shopify_themes/version.rb
+- lib/minitest_shopify_themes/view_test.rb
+homepage: https://github.com/nebulab/minitest-shopify?tab=readme-ov-file#readme
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/nebulab/minitest-shopify/issues
+  homepage_uri: https://github.com/nebulab/minitest-shopify?tab=readme-ov-file#readme
+  source_code_uri: https://github.com/nebulab/minitest-shopify
+  changelog_uri: https://github.com/nebulab/minitest-shopify/releases
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A minitest plugin for testing Shopify Liquid themes
+test_files: []