dugway 1.0.14 → 1.2.0

data/lib/dugway/liquid/drops/features_drop.rb

@@ -0,0 +1,144 @@
+require 'set'
+
+module Dugway
+  module Drops
+    # Provides access to specific account feature flags within Liquid templates,
+    # mirroring the behavior of the storefront's FeaturesDrop but reading
+    # configuration from the Dugway store configuration (e.g., dugway.json).
+    #
+    # Feature flags can have a default status (enabled or disabled). This status,
+    # along with the list of exposed features, opt-ins, and opt-outs, should be
+    # defined under a top-level "features" key in the store configuration file,
+    # making it a peer to "store" and "customization".
+    #
+    # Example structure expected within the store configuration (e.g., dugway.json):
+    # {
+    #   "store": { ... },
+    #   "customization": { ... },
+    #   "features": {
+    #     "definitions": {
+    #       "theme_bnpl_messaging": "enabled_by_default",
+    #       "theme_category_collages": "disabled_by_default"
+    #     },
+    #     "opt_ins": ["some_opted_in_feature"],
+    #     "opt_outs": ["some_opted_out_feature"]
+    #   }
+    # }
+    # The `FeaturesDrop` receives the top-level `features` hash as its `source`
+    # via the ThemeDrop.
+    #
+    # Usage in Liquid:
+    #   {% if features.has_theme_bnpl_messaging %} ... {% endif %}
+    #   Note: Liquid might require the trailing '?' depending on context,
+    #         but this implementation handles calls without it.
+    #
+    class FeaturesDrop < BaseDrop
+      # Memoized hash of feature definitions (name => default_status_string)
+      # read from the source (store configuration data).
+      # @return [Hash<String, String>]
+      def feature_definitions
+        @feature_definitions ||= source&.fetch('definitions', {}) || {}
+      end
+
+      # Returns a memoized list of features this account has explicitly opted *into*,
+      # filtered to only include features defined in the definitions.
+      # @return [Array<String>] List of opted-in feature names.
+      def opt_ins
+        return @opt_ins if defined?(@opt_ins)
+
+        source_opt_ins = source&.fetch('opt_ins', []) || []
+        # Ensure source data is treated as a Set for efficient intersection
+        source_set = source_opt_ins.respond_to?(:to_set) ? source_opt_ins.to_set : Set.new(Array(source_opt_ins))
+
+        # Only keep opt-ins that correspond to defined features
+        @opt_ins = (Set.new(feature_definitions.keys) & source_set).to_a
+      end
+
+      # Returns a memoized list of features this account has explicitly opted *out of*,
+      # filtered to only include features defined in the definitions.
+      # @return [Array<String>] List of opted-out feature names.
+      def opt_outs
+        return @opt_outs if defined?(@opt_outs)
+
+        source_opt_outs = source&.fetch('opt_outs', []) || []
+        # Ensure source data is treated as a Set for efficient intersection
+        source_set = source_opt_outs.respond_to?(:to_set) ? source_opt_outs.to_set : Set.new(Array(source_opt_outs))
+
+        # Only keep opt-outs that correspond to defined features
+        @opt_outs = (Set.new(feature_definitions.keys) & source_set).to_a
+      end
+
+      # Override BaseDrop's `before_method` to intercept `has_...` calls directly.
+      # This is called by BaseDrop's `method_missing` and allows us to intercept
+      # `has_...` calls before BaseDrop tries to resolve them against the source hash.
+      def before_method(method_or_key)
+        method_str = method_or_key.to_s
+
+        if method_str.start_with?('has_')
+          # Extract feature name, removing 'has_' prefix and optional trailing '?'
+          # to handle calls like `features.has_feature_name` or `features.has_feature_name?`
+          feature_name = method_str.sub(/^has_/, '').chomp('?')
+
+          # Check if this feature is defined
+          # If the extracted name doesn't match a defined feature, it's not available.
+          unless feature_definitions.key?(feature_name)
+            return false
+          end
+
+          # If defined, calculate availability based on defaults and overrides.
+          is_feature_available?(feature_name)
+        else
+          # If it's not a 'has_' method, delegate to BaseDrop's original logic.
+          super(method_or_key)
+        end
+      end
+
+      # Keep liquid_method_missing for compatibility or explicit Liquid contexts,
+      # We keep liquid_method_missing defined as it's the official Liquid hook,
+      # although our `before_method` override likely handles most cases in Liquid 3.
+      # This provides potential compatibility if Liquid internals change or call this directly.
+      def liquid_method_missing(method_name)
+        method_str = method_name.to_s
+
+        if method_str.start_with?('has_')
+          feature_name = method_str.sub(/^has_/, '').chomp('?')
+          # Check definition and calculate availability, returning false if undefined.
+          feature_definitions.key?(feature_name) ? is_feature_available?(feature_name) : false
+        else
+          # Fallback for non-'has_' methods.
+          super
+        end
+      end
+
+      private
+      # Determines if a specific feature is available for the account based on its
+      # default status (from store customization) and the account's explicit opt-ins/outs
+      # (also from store customization).
+      #
+      # @param feature_name [String] The name of the feature to check.
+      # @return [Boolean] True if the feature is available, false otherwise.
+      def is_feature_available?(feature_name)
+        default_behavior_str = feature_definitions[feature_name]
+        # Should not happen if called via before_method/liquid_method_missing,
+        # but return false if the definition was somehow missing.
+        return false unless default_behavior_str
+
+        is_opted_in = opt_ins.include?(feature_name)
+        is_opted_out = opt_outs.include?(feature_name)
+
+        # Determine final availability:
+        # - If explicitly opted in, it's available.
+        # - If explicitly opted out, it's unavailable.
+        # - Otherwise, availability depends on the defined default behavior string.
+        # Precedence: Opt-out > Opt-in > Default
+        if is_opted_out
+          false
+        elsif is_opted_in
+          true
+        else
+          default_behavior_str == 'enabled_by_default'
+        end
+      end
+    end
+  end
+end

data/lib/dugway/liquid/drops/product_drop.rb

@@ -104,6 +104,14 @@ module Dugway
         end
       end
 
+      def related_products
+        @related_products ||= begin
+          drop = RelatedProductsDrop.new(source)
+          drop.context = @context if @context
+          drop.products
+        end
+      end
+
       private
 
       def price_min_max

data/lib/dugway/liquid/drops/products_drop.rb

@@ -33,7 +33,7 @@ module Dugway
           when 'newest', 'date'
             'date'
           # We don't pass these in the API, so fake it
-          when 'sales', 'sells', 'views'
+          when 'sales', 'sells', 'top-selling', 'views'
             'shuffle'
           else
             'position'

data/lib/dugway/liquid/drops/related_products_drop.rb

@@ -0,0 +1,88 @@
+module Dugway
+  module Drops
+    class RelatedProductsDrop < BaseDrop
+      def initialize(product)
+        super()
+        @product = product
+      end
+
+      def products
+        fetch_related_products
+      end
+
+      private
+
+      def settings
+        @settings ||= theme.customization
+      end
+
+      def limit
+        @limit ||= begin
+          if settings
+            limit = settings['similar_products'] ||
+                    settings['related_items'] ||
+                    settings['related_products'] ||
+                    settings['number_related_products'] ||
+                    4
+            limit
+          else
+            4
+          end
+        end
+      end
+
+      def sort_order
+        @sort_order ||= begin
+          if settings
+            order = settings['related_products_order'] ||
+                    settings['similar_products_order'] ||
+                    "position"
+            order
+          else
+            "position"
+          end
+        end
+      end
+
+      def fetch_related_products
+        return [] unless @product
+
+        category_products = sort_products(fetch_category_products).take(limit)
+        return category_products if category_products.size >= limit
+
+        remaining_limit = limit - category_products.size
+        fallback_products = sort_products(fetch_fallback_products(category_products, remaining_limit)).take(remaining_limit)
+
+        category_products + fallback_products
+      end
+
+      def fetch_category_products
+        # Filter Dugway's product data to match the categories of the current product
+        Dugway.store.products.select do |product|
+          product_cats = product['category_ids'] || []
+          current_cats = @product['category_ids'] || []
+          (product_cats & current_cats).any? && product['id'] != @product['id']
+        end.map { |p| ProductDrop.new(p) }
+      end
+
+      def fetch_fallback_products(category_products, limit)
+        # Get additional products excluding already included ones
+        excluded_ids = category_products.map { |p| p['id'] } + [@product['id']]
+        Dugway.store.products
+          .reject { |product| excluded_ids.include?(product['id']) }
+          .map { |p| ProductDrop.new(p) }
+      end
+
+      def sort_products(products)
+        case sort_order
+        when 'date', 'newest'
+          products.sort { |a,b| b.source['id'] <=> a.source['id'] }
+        when 'sales', 'sells', 'top-selling', 'views'
+          products.shuffle
+        else
+          products.sort_by { |p| p.source['position'] }
+        end
+      end
+    end
+  end
+end

data/lib/dugway/liquid/drops/theme_drop.rb

@@ -1,6 +1,13 @@
 module Dugway
   module Drops
     class ThemeDrop < BaseDrop
+      # @param customization [Hash] Theme customization values.
+      # @param definitions [Hash] Theme setting definitions (from settings.json).
+      def initialize(customization, definitions = {})
+        super(customization)
+        @definitions = definitions || {}
+      end
+
       def before_method(method_or_key)
         # We should try to get away from this api and use the newer one below
         if source.respond_to?('has_key?') && source.has_key?(method_or_key) && settings_images.find { |image| image['variable'] == method_or_key.to_s }
@@ -20,6 +27,22 @@ module Dugway
         Drops::ThemeImageSetsDrop.new(source)
       end
 
+      def features
+        # Fetch features config from the top-level Dugway options hash,
+        # which should contain the parsed store configuration (e.g., dugway.json).
+        # This allows 'features' to be a peer to 'store' and 'customization'.
+        feature_data = Dugway.options&.fetch('features', {}) || {}
+        Drops::FeaturesDrop.new(feature_data)
+      end
+
+      # Provides access to theme translations via theme.translations
+      def translations
+        # Instantiate and return the TranslationsDrop, passing settings.
+        # Memoize the instance for efficiency within a single render cycle.
+        # Pass both customization (source) and definitions to TranslationsDrop.
+        @translations_drop ||= Drops::TranslationsDrop.new(source, @definitions)
+      end
+
       private
       def settings_images
         @settings_images ||= settings.has_key?('images') ? settings['images'] : []

data/lib/dugway/liquid/drops/translations_drop.rb

@@ -0,0 +1,122 @@
+require 'i18n'
+
+module Dugway
+  module Drops
+    class TranslationsDrop < BaseDrop
+      class MissingTranslationError < StandardError; end
+
+      # @param settings [Hash] Theme customization values (resolved settings).
+      # @param definitions [Hash] Raw theme setting definitions (from settings.json).
+      def initialize(settings, definitions = {})
+        @settings = settings || {}
+        @definitions = definitions || {} # Store definitions
+        # Read settings using both symbol and string keys for flexibility.
+        @translation_mode = (@settings[:translation_mode] || @settings['translation_mode'])&.to_s
+        # Use explicit theme setting for locale if present, otherwise default to current I18n.locale
+        @translation_locale = (@settings[:translation_locale] || @settings['translation_locale'])&.to_s.presence || I18n.locale.to_s
+        super()
+      end
+
+      # Liquid access: `{{ translations['key.name'] }}`
+      # Returns the translation string (which could be an empty string),
+      # or a "[MISSING TRANSLATION: ...]" string if the key is not found or its value is nil.
+      #
+      # @param key [String, Symbol] The translation key.
+      # @return [String, nil] The translation or missing translation indicator.
+      def [](key)
+        key_str = key.to_s
+        translation = find_translation(key_str)
+
+        if translation.nil?
+          # Key is missing, or explicitly nil in manual mode - treat both as missing.
+          log_missing_translation(key_str)
+          return missing_translation_message(key_str)
+        end
+
+        # Key found, return its value.
+        translation
+      end
+
+      private
+
+      def manual_mode?
+        @translation_mode == 'manual'
+      end
+
+      # Looks up translation using I18n.
+      # Returns nil if the key is not found or the locale is invalid.
+      def lookup_automatic_translation(key)
+        locale_to_use = @translation_locale
+        # `default: nil` prevents I18n from raising an error on missing keys.
+        I18n.t("storefront.#{key}", locale: locale_to_use, default: nil)
+      rescue I18n::InvalidLocale
+        nil # Treat invalid locale as a missing translation.
+      end
+
+      # Converts a canonical key ('a.b.c') to the theme setting key format (:a_b_c_tr_text).
+      def derive_manual_setting_key(key)
+        "#{key.tr('.', '_')}_tr_text".to_sym
+      end
+
+      # Finds the translation based on the current mode.
+      # In manual mode, respects the 'allow_blank' setting definition.
+      # Returns the translation string, or nil if not found or disallowed blank.
+      def find_translation(key_str)
+        if manual_mode?
+          manual_setting_key_sym = derive_manual_setting_key(key_str)
+          manual_setting_key_str = manual_setting_key_sym.to_s
+          custom_value = nil
+          setting_exists = false
+
+          # Check both symbol and string keys for manual overrides.
+          if @settings.key?(manual_setting_key_sym)
+            custom_value = @settings[manual_setting_key_sym]
+            setting_exists = true
+          elsif @settings.key?(manual_setting_key_str)
+            custom_value = @settings[manual_setting_key_str]
+            setting_exists = true
+          end
+
+          if setting_exists
+            # Find the corresponding definition to check allow_blank
+            # Assuming manual translations are defined similarly to 'options'
+            definition = find_setting_definition(manual_setting_key_str) || {}
+            allow_blank = definition['allow_blank'].to_s == 'true'
+
+            # Return custom value if it's present, or if it's blank but allowed
+            return custom_value if custom_value.present? || (allow_blank && custom_value == '')
+
+            # If we reach here, the value is blank but blank is not allowed.
+            # Fall through to automatic lookup.
+          end
+
+          # If setting key didn't exist, fall through to automatic lookup.
+
+        end # End manual_mode? check
+
+        # Automatic mode or fallback from manual mode
+        lookup_automatic_translation(key_str)
+      end
+
+      # Helper to find a setting definition by its variable name across common sections.
+      def find_setting_definition(variable_name)
+        # Look primarily in 'options' as manual translations often mimic them.
+        # Add other potential sections if needed in the future.
+        (@definitions['options'] || []).find { |d| d['variable'] == variable_name }
+      end
+
+      # Logs a warning message for a missing translation.
+      def log_missing_translation(key_str)
+        mode = manual_mode? ? 'manual' : 'automatic'
+        locale_info = manual_mode? ? '' : " locale='#{@translation_locale}'"
+        message = "Missing translation: key='#{key_str}'#{locale_info} mode='#{mode}'"
+        Dugway.logger.warn(message)
+      end
+
+      # Returns the standard string indicating a missing translation.
+      def missing_translation_message(key_str)
+        "[MISSING TRANSLATION: #{key_str}]"
+      end
+    end
+  end
+end

data/lib/dugway/liquifier.rb

@@ -16,6 +16,7 @@ module Dugway
   class Liquifier
     def initialize(request)
       @request = request
+      load_theme_locales
     end
 
     def render(content, variables={})
@@ -41,7 +42,7 @@ module Dugway
 
     def self.render_styles(css)
       Liquid::Template.parse(css).render!(
-        { 'theme' => Drops::ThemeDrop.new(Dugway.theme.customization) },
+        { 'theme' => Drops::ThemeDrop.new(Dugway.theme.customization, Dugway.theme.settings) },
         :registers => { :settings => Dugway.theme.settings }
       )
     end
@@ -68,7 +69,8 @@ module Dugway
       {
         'store' => Drops::AccountDrop.new(store.account),
         'cart' => Drops::CartDrop.new(cart),
-        'theme' => Drops::ThemeDrop.new(theme.customization),
+        # Pass both customization and definitions to ThemeDrop
+        'theme' => Drops::ThemeDrop.new(theme.customization, theme.settings),
         'pages' => Drops::PagesDrop.new(store.pages.map { |p| Drops::PageDrop.new(p) }),
         'categories' => Drops::CategoriesDrop.new(store.categories.map { |c| Drops::CategoryDrop.new(c) }),
         'artists' => Drops::ArtistsDrop.new(store.artists.map { |a| Drops::ArtistDrop.new(a) }),
@@ -77,6 +79,10 @@ module Dugway
         'head_content' => [window_bigcartel_script, head_content].join,
         'bigcartel_credit' => bigcartel_credit,
         'powered_by_big_cartel' => powered_by_big_cartel,
+        'big_cartel_credit_logo' => big_cartel_credit_logo,
+        # Pass both customization and definitions to TranslationsDrop
+        'translations' => Drops::TranslationsDrop.new(theme.customization, theme.settings),
+        't' => Drops::TranslationsDrop.new(theme.customization, theme.settings),
       }
     end
 
@@ -109,17 +115,47 @@ module Dugway
       "<script>#{script}</script>"
     end
 
+    def read_svg_asset(filename)
+      File.read(File.join(File.dirname(__FILE__), 'assets', filename))
+    end
+
     def bigcartel_credit
       '<a href="http://bigcartel.com/" title="Start your own store at Big Cartel now">Online Store by Big Cartel</a>'
     end
 
     def powered_by_big_cartel
-      %(<a class="bigcartel-credit" href="https://www.bigcartel.com/?utm_source=bigcartel&utm_medium=storefront&utm_campaign=123" title="Powered by Big Cartel">
-        <span class="bigcartel-credit__text" aria-hidden="true">Powered by</span>
-        <svg aria-hidden="true" class="bigcartel-credit__lockup" xmlns="http://www.w3.org/2000/svg" viewBox="1.99 2.05 124.96 24.95">
-          <path d="M46.18 4A1.91 1.91 0 1 1 50 4a1.91 1.91 0 1 1-3.81 0Zm78.76 14.35a.81.81 0 0 1-.25-.69V2.23h-4.52v2.68h1.58V18c0 2.14 1.11 3.28 3.2 3.28a6.56 6.56 0 0 0 2-.42v-2.78c-1.28.51-1.8.38-2.01.23Zm-75.27.05h1.43V21h-5.79v-2.64h1.43v-8h-1.61V7.7h4.54Zm-11.09-11a5.81 5.81 0 0 0-4.36 1.87V2.23H29.7v2.68h1.62v12.71a.81.81 0 0 1-.25.69c-.43.33-1.5 0-2.06-.23v2.76a6.59 6.59 0 0 0 2.05.42 2.92 2.92 0 0 0 2.74-1.32 6.86 6.86 0 0 0 4.27 1.34 6.66 6.66 0 0 0 6.86-7c-.01-4.06-2.68-6.97-6.35-6.97ZM38 18.57c-2.15 0-3.72-1.75-3.72-4.17s1.55-4.32 3.78-4.32a3.75 3.75 0 0 1 3.75 4.1c.02 2.55-1.58 4.39-3.81 4.39Zm68.86-.49v2.76a7.52 7.52 0 0 1-2 .42c-2.09 0-3.2-1.14-3.2-3.28V5.36l2.93-1.92V7.7h3.81l-1.91 2.68h-1.9v7.24a.77.77 0 0 0 .26.69c.53.4 2.03-.23 2.03-.23ZM58 7.31c-3.88 0-6.69 3-6.69 7.11s2.66 6.87 6.33 6.87A6.14 6.14 0 0 0 62 19.45v1.42c0 2.72-2.4 3.45-3.83 3.45a5.22 5.22 0 0 1-3.12-1.06l-2.36 1.83A7.78 7.78 0 0 0 58 27c3.21 0 6.95-1.63 6.95-6.21v-6.38A6.84 6.84 0 0 0 58 7.31Zm.12 11.29c-2.19 0-3.72-1.74-3.72-4.23s1.6-4.21 3.8-4.21a3.94 3.94 0 0 1 3.8 4.21 4 4 0 0 1-3.85 4.23ZM120.6 15c0-5.05-3.45-7.69-6.85-7.69a6.76 6.76 0 0 0-6.58 7.06 7.13 7.13 0 0 0 12.69 4.39l-2.22-1.71a4.24 4.24 0 0 1-3.44 1.69 3.86 3.86 0 0 1-3.94-3.11h10.28a3.09 3.09 0 0 0 .06-.63Zm-10.35-2.08a3.65 3.65 0 0 1 3.56-3.11 3.77 3.77 0 0 1 3.77 3.11ZM94.92 10V7.7h-4v2.68h1.62v8h-2.35a.83.83 0 0 1-.61-.19.91.91 0 0 1-.19-.64v-5.77c0-1.31-.65-4.47-5.52-4.47a7.85 7.85 0 0 0-4.14 1.18l1.17 2.23a5 5 0 0 1 3-.78 3.26 3.26 0 0 1 1.76.49 2.08 2.08 0 0 1 .81 1.78v1.25a6.58 6.58 0 0 0-3.21-.92c-2.58 0-3.91 1.62-5.19 3.2s-2.51 3-5 2.92c-2.27-.11-3.63-1.86-3.63-4.43 0-2.39 1.45-4 3.54-4a3.75 3.75 0 0 1 3.7 3.18l2.45-1.9a6.3 6.3 0 0 0-6.3-4.18 6.72 6.72 0 0 0-6.48 7c0 3.43 2.1 7.16 6.62 7.16a7.45 7.45 0 0 0 5.87-2.73 4.38 4.38 0 0 0 4.08 2.57 5.91 5.91 0 0 0 3.93-1.66 2.87 2.87 0 0 0 2.8 1.33h7.42v-2.64h-1.61v-3.21c0-3.3 1.09-4.77 3.56-4.77a3.68 3.68 0 0 1 1.45.31V8a4.81 4.81 0 0 0-1.74-.25A4.21 4.21 0 0 0 94.92 10Zm-8.47 7.48a4.93 4.93 0 0 1-3.16 1.41 1.9 1.9 0 0 1-2.05-1.91 2 2 0 0 1 2.18-2 5 5 0 0 1 3 1.18ZM11 14.52v-.89a1.78 1.78 0 0 1 .83-1.51l7.35-4.7A1.79 1.79 0 0 0 20 5.91V2.05L11 7.8 2 2.05V14.2a8.69 8.69 0 0 0 3.88 7.58L11 25.05l5.12-3.27A8.69 8.69 0 0 0 20 14.2V8.77Z" class="a"></path>
-        </svg>
-      </a>)
+      build_powered_by_link(include_text: true)
+    end
+
+    def big_cartel_credit_logo
+      build_powered_by_link(include_text: false)
+    end
+
+    def build_powered_by_link(include_text: true)
+      svg_content = read_svg_asset('big_cartel_logo.svg')
+      
+      text_span = include_text ? '      <span class="bigcartel-credit__text" aria-hidden="true">Powered by</span>' : ''
+      <<~HTML
+        <a class="bigcartel-credit" href="https://www.bigcartel.com/?utm_source=bigcartel&utm_medium=storefront&utm_campaign=123}" title="Powered by Big Cartel" data-bc-hook="attribution">
+        #{text_span}
+          #{svg_content}
+        </a>
+      HTML
+    end
+
+    # Load theme-specific override locales
+    def load_theme_locales
+      return unless Dugway.source_dir && Dir.exist?(File.dirname(Dugway.source_dir))
+      
+      parent_dir = File.dirname(Dugway.source_dir)
+      theme_locales_dir = File.join(parent_dir, 'locales')
+      
+      if Dir.exist?(theme_locales_dir)
+        theme_locales_path = File.expand_path(theme_locales_dir)
+        # Ensure theme locales are loaded *after* defaults to allow overrides
+        I18n.load_path |= Dir[File.join(theme_locales_path, 'storefront.*.yml')]
+        I18n.backend.reload!
+      end
     end
   end
 end

data/lib/dugway/store.rb

@@ -8,8 +8,9 @@ module Dugway
     default_timeout 5
     headers 'User-Agent' => "Dugway #{ Dugway::VERSION }"
 
-    def initialize(subdomain)
+    def initialize(subdomain, store_options = {})
       self.class.base_uri "https://api.bigcartel.com/#{ subdomain }"
+      @store_options = store_options || {}
     end
 
     def account
@@ -124,7 +125,11 @@ module Dugway
     end
 
     def locale
-      currency['locale']
+      @store_options[:locale] || currency['locale']
+    end
+
+    def website
+      @store_options[:website] || account['website']
     end
 
     def instant_checkout?