dugway 1.1.0 → 1.3.0

data/lib/dugway/theme.rb

@@ -13,10 +13,12 @@ module Dugway
       File.join(__dir__, 'config', 'theme_color_attribute_mappings.yml')
     ).freeze
 
-    attr_reader :errors
+    attr_reader :errors, :warnings
 
     def initialize(overridden_customization={})
       @overridden_customization = overridden_customization.stringify_keys
+      @errors = []
+      @warnings = []
     end
 
     def layout
@@ -39,9 +41,13 @@ module Dugway
       customization_for_type('image_sets')
     end
 
+    def features
+      customization_for_type('features')
+    end
+
     def customization
       Hash.new.tap do |customization|
-        %w( fonts colors options images image_sets ).each do |type|
+        %w( fonts colors options images image_sets features).each do |type|
           customization.update(customization_for_type(type))
         end
 
@@ -95,6 +101,7 @@ module Dugway
 
     def valid?(validate_colors: true, validate_layout_attributes: true, validate_options: true)
       @errors = []
+      @warnings = []
 
       REQUIRED_FILES.each do |file|
         @errors << "Missing source/#{ file }" if read_source_file(file).nil?
@@ -117,7 +124,14 @@ module Dugway
 
       validate_required_color_settings if validate_colors
       validate_required_layout_attributes if validate_layout_attributes
-      validate_options_settings if validate_options
+
+      if validate_options
+        validate_options_settings # Validate descriptions, requires, defaults
+        # Validate sections for options, images, and image_sets
+        validate_setting_sections(settings['options'], 'options') if settings['options']
+        validate_setting_sections(settings['images'], 'images') if settings['images']
+        validate_setting_sections(settings['image_sets'], 'image_sets') if settings['image_sets']
+      end
 
       @errors.empty?
     end
@@ -164,15 +178,41 @@ module Dugway
       @errors << "layout.html must have exactly one `data-bc-hook=\"footer\"`" if footer_hooks != 1
     end
 
+    VALID_SECTIONS = %w(global_navigation homepage product_page general messaging social translations).freeze
+
     def validate_options_settings
       return unless settings['options']
 
       validate_options_descriptions
       validate_options_requires
+      validate_option_defaults
     end
 
     private
 
+    # Generic method to validate the 'section' property for any array of settings
+    def validate_setting_sections(settings_array, setting_type_name)
+      return unless settings_array.is_a?(Array)
+
+      settings_array.each do |setting|
+        variable = setting['variable'] || 'unknown'
+
+        unless setting.key?('section')
+          warning_msg = "Warning: Theme setting '#{variable}' is missing the 'section' property."
+          @warnings << warning_msg
+          Kernel.warn(warning_msg)
+          next # Skip further checks if section is missing
+        end
+
+        section_value = setting['section']
+        unless VALID_SECTIONS.include?(section_value)
+          warning_msg = "Warning: Theme setting '#{variable}' has an invalid 'section' value: '#{section_value}'. Allowed values are: #{VALID_SECTIONS.join(', ')}."
+          @warnings << warning_msg
+          Kernel.warn(warning_msg)
+        end
+      end
+    end
+
     def validate_preview
       preview = settings['preset_styles']['preview']
       if preview
@@ -254,6 +294,10 @@ module Dugway
     def validate_options_requires
       return unless settings['options']
       all_variables = settings['options'].map { |o| o['variable'] }
+      
+      # Include variables from images and image_sets settings
+      all_variables.concat(settings['images'].map { |i| i['variable'] }) if settings['images']
+      all_variables.concat(settings['image_sets'].map { |i| i['variable'] }) if settings['image_sets']
 
       settings['options'].each do |option|
         next unless option['requires']
@@ -275,24 +319,116 @@ module Dugway
 
         # Process each rule in the array
         option['requires'].each do |rule|
-          next if rule == 'inventory'
+          validate_requires_rule(rule, option['variable'], all_variables)
+        end
+      end
+    end
 
-          # Extract setting name from rule
-          # Handle both simple cases ("show_search") and complex cases ("show_search eq true")
-          setting_name = if rule.include?(' ')
-            rule.split(/\s+/).first
-          else
-            rule
-          end
+    # Validates individual requires rule - handles both string rules and object rules (like 'any')
+    def validate_requires_rule(rule, option_variable, all_variables)
+      # Handle object-based rules (like {"any": [...]})
+      if rule.is_a?(Hash)
+        if rule.has_key?('any')
+          validate_any_condition(rule['any'], option_variable, all_variables)
+        else
+          @errors << "Option '#{option_variable}' has unsupported requires object. Only 'any' is currently supported."
+        end
+        return
+      end
 
-          # Verify the referenced setting exists
-          unless all_variables.include?(setting_name)
-            @errors << "Option '#{option['variable']}' requires unknown setting '#{setting_name}'"
-          end
+      # Handle string-based rules (existing logic)
+      return if rule == 'inventory'
+
+      valid_operators = %w(eq neq gt lt gte lte present)
+
+      # Extract setting name and optional operator/value
+      parts = rule.split(/\s+/)
+      setting_name = parts[0]
+      operator = parts[1]
+      value = parts[2]
+
+      if setting_name.start_with?('feature:')
+        # Validate feature flag format
+        unless setting_name =~ /^feature:[a-z_]+$/
+          @errors << "Option '#{option_variable}' has invalid feature flag format"
+          return
         end
+
+        # Only validate operator/value if they exist
+        if operator
+          is_valid_operator = ['eq', 'neq'].include?(operator)
+
+          @errors << "Option '#{option_variable}' has invalid operator '#{operator}'. Feature flags can only use `eq` or `neq`." unless is_valid_operator
+
+          is_valid_value = ['visible'].include?(value)
+
+          @errors << "Option '#{option_variable}' has invalid comparison value '#{value}'. Feature flags can only check for `visible`." unless is_valid_value
+        end
+        return
+      end
+
+      # --- Non-feature rule validation ---
+      unless all_variables.include?(setting_name)
+        @errors << "Option '#{option_variable}' requires unknown setting '#{setting_name}'"
+        return # Skip further checks for this rule if setting is unknown
+      end
+
+      # Validate operator if present
+      if operator && !valid_operators.include?(operator)
+        @errors << "Option '#{option_variable}' has invalid operator '#{operator}'. Allowed operators are: #{valid_operators.join(', ')}."
+      end
+    end
+
+    # Validates 'any' condition - ensures it's an array and validates each nested rule
+    def validate_any_condition(any_rules, option_variable, all_variables)
+      unless any_rules.is_a?(Array)
+        @errors << "Option '#{option_variable}' has invalid 'any' condition - must be an array of rules"
+        return
+      end
+
+      if any_rules.empty?
+        @errors << "Option '#{option_variable}' has empty 'any' condition - must contain at least one rule"
+        return
+      end
+
+      # Validate each rule within the 'any' condition
+      any_rules.each do |nested_rule|
+        validate_requires_rule(nested_rule, option_variable, all_variables)
+      end
+    end
+
+    def validate_option_value(option, value_type)
+      value = option[value_type]
+      return unless value
+
+      case option['type']
+      when 'select'
+        validate_select_option(option, value, value_type)
+      when 'boolean'
+        @errors << "#{value_type.capitalize} '#{value}' is not a boolean for #{option['variable']}" unless [true, false].include?(value)
       end
     end
 
+    def validate_option_defaults
+      return unless settings['options']
+      settings['options'].each do |option|
+        validate_option_value(option, 'default')
+        validate_option_value(option, 'upgrade_default')
+      end
+    end
+
+    def validate_select_option(option, value, value_type)
+      if option['options'] == "product_orders"
+        valid_values = %w[position top-selling newest views updated_new_to_old]
+        @errors << "#{value_type.capitalize} '#{value}' is not a valid option for #{option['variable']}" unless valid_values.include?(value)
+      elsif option['options'].is_a?(String) && option['options'] =~ /^\d+\.\.\d+$/
+        range = eval(option['options'])
+        @errors << "#{value_type.capitalize} '#{value}' is out of range for #{option['variable']}" unless range.include?(value.to_i)
+      elsif option['options'].is_a?(Array)
+        valid_values = option['options'].map { |o| o.is_a?(Array) ? o[1] : o }
+        @errors << "#{value_type.capitalize} '#{value}' is not a valid option for #{option['variable']}" unless valid_values.include?(value)
+      end
+    end
 
     def source_dir
       Dugway.source_dir

data/lib/dugway/version.rb

@@ -1,3 +1,3 @@
 module Dugway
-  VERSION = "1.1.0"
+  VERSION = "1.3.0"
 end

data/lib/dugway.rb

@@ -11,9 +11,45 @@ end
 
 require 'active_support/all'
 require 'i18n'
+require 'i18n/backend/fallbacks'
 require 'bigcartel-currency-locales'
 require 'bigcartel/theme/fonts'
 
+# Configure I18n to load locale files from the gem's locales directory.
+# This allows for easy addition and management of translations.
+gem_locales_pattern = File.expand_path('../locales/storefront.*.yml', File.dirname(__FILE__))
+gem_locale_files = Dir.glob(gem_locales_pattern)
+
+# Add these locale files to the I18n load path, ensuring no duplicates and preserving existing paths.
+I18n.load_path = (I18n.load_path + gem_locale_files).uniq
+
+# Determine available locales from the filenames (e.g., 'storefront.en-US.yml' -> :'en-US').
+available_locales = gem_locale_files.map do |file|
+  # Extracts 'en-US' from 'storefront.en-US.yml' or 'de' from 'storefront.de.yml'
+  locale_string = File.basename(file, '.yml').split('storefront.').last
+  locale_string.to_sym if locale_string
+end.compact.uniq
+
+# Ensure :en is an available locale if any 'en-XX' variant exists (e.g., :en-US, :en-GB),
+# as I18n can use :en as a fallback.
+if available_locales.any? { |loc| loc.to_s.start_with?('en-') } && !available_locales.include?(:en)
+  available_locales << :en
+end
+
+# Set available locales. Provide a default if no locale files are found (e.g., during initial setup or in case of an error).
+I18n.config.available_locales = available_locales.empty? ? [:'en-US', :en] : available_locales
+
+# Enable fallbacks for I18n
+# This allows sv-SE to fallback to sv, en-GB to en, etc.
+I18n::Backend::Simple.include(I18n::Backend::Fallbacks)
+
+# Disable enforce_available_locales to allow invalid locales like 'eu'
+# We'll handle them gracefully with fallbacks
+I18n.enforce_available_locales = false
+
+# Reload I18n to apply changes and load the translations from the files.
+I18n.backend.reload!
+
 require 'rack/builder'
 require 'rack/commonlogger'
 require 'better_errors'
@@ -36,7 +72,21 @@ module Dugway
 
       BigCartel::CurrencyLocales.insert
       I18n.default_locale = 'en-US'
-      I18n.locale = Dugway.store.locale
+      
+      # Set locale with fallback handling for invalid or missing locales
+      begin
+        requested_locale = Dugway.store.locale
+        if requested_locale
+          # Try to set the locale - if it's completely invalid (like 'eu'), 
+          # this will fall back to default_locale due to enforce_available_locales = false
+          I18n.locale = requested_locale
+        else
+          I18n.locale = I18n.default_locale
+        end
+      rescue I18n::InvalidLocale
+        # If somehow we still get an invalid locale error, fall back to default
+        I18n.locale = I18n.default_locale
+      end
 
       Rack::Builder.app do
         use Rack::Session::Cookie, :secret => 'stopwarningmeaboutnothavingasecret'
@@ -52,7 +102,9 @@ module Dugway
     end
 
     def store
-      @store ||= Store.new(options && options[:store] && options[:store][:subdomain] || 'dugway')
+      store_options = options && options[:store] ? options[:store] : {}
+      subdomain = store_options[:subdomain] || 'dugway'
+      @store ||= Store.new(subdomain, store_options)
     end
 
     def theme
@@ -74,5 +126,6 @@ module Dugway
     def options
       @options
     end
+
   end
 end

data/locales/storefront.de.yml

@@ -0,0 +1,81 @@
+de:
+  storefront:
+    navigation:
+      all: "Alle"
+      all_products: "Alle Produkte"
+      back_to_site: "Zurück zur Seite"
+      cart: "Warenkorb"
+      categories: "Kategorien"
+      contact: "Kontakt"
+      home: "Startseite"
+      item: "Artikel" # capitalized as it is proper grammar in German
+      items: "Artikel" # capitalized as it is proper grammar in German
+      more: "Mehr"
+      next: "Weiter"
+      newest: "Neueste"
+      pages: "Seiten"
+      previous: "Zurück"
+      products: "Produkte"
+      quick_view: "Schnellansicht"
+      search: "Suche"
+      shop: "Shop"
+      social: "Folge uns"
+      subscribe: "Abonnieren"
+      top_selling: "Meistverkauft"
+      view: "Ansehen"
+      view_all: "Alle anzeigen"
+      # "Sort By" translations are used in very few themes, and are not exposed in theme settings for sellers to configure
+      sort_by: Sortieren nach
+      sort_by_featured: Empfohlen
+      sort_by_on_sale: Im Angebot
+      sort_by_top_selling: Bestseller
+      sort_by_alphabetically_a_to_z: Alphabetisch (A bis Z)
+      sort_by_alphabetically_z_to_a: Alphabetisch (Z bis A)
+      sort_by_date_new_to_old: Datum (neu zu alt)
+      sort_by_date_old_to_new: Datum (alt zu neu)
+      sort_by_price_low_to_high: Preis (niedrig zu hoch)
+      sort_by_price_high_to_low: Preis (hoch zu niedrig)
+    home:
+      all_products: "Alle Produkte"
+      featured: "Empfohlen"
+      featured_categories: "Empfohlene Kategorien"
+      featured_products: "Empfohlene Produkte"
+      featured_video: ""
+    products:
+      add_to_cart: "Hinzufügen"
+      added: "Hinzugefügt!" # Used in few themes, intentionally not exposed in theme settings
+      adding: "Hinzufügen..." # Used in few themes, intentionally not exposed in theme settings
+      almost_sold_out: "Nur noch wenige!"
+      coming_soon: "Demnächst verfügbar"
+      in_stock: "auf Lager"
+      description: "Beschreibung"
+      inventory: "Lagerbestand"
+      low_inventory: "Begrenzte Menge"
+      no_products: "Keine Produkte gefunden"
+      on_sale: "Im Angebot"
+      related_products: "Das gefällt dir vielleicht"
+      reset: "Zurücksetzen"
+      search_results: "Suchergebnisse"
+      select: "Wählen"
+      select_variant: "Option wählen"
+      sold_out: "Ausverkauft"
+      variant: "Option"
+      variants: "Optionen"
+    cart:
+      checkout: "Zur Kasse"
+      continue_shopping: "Weiter einkaufen"
+      empty_cart: "Dein Warenkorb ist leer"
+      quantity_abbreviated: "Anz."
+      quantity: "Anzahl"
+      remove: "Entfernen"
+      share_this_cart: "Diesen Warenkorb teilen"
+      share_this_cart_link_copy_success: "Link kopiert!"
+      subtotal: "Zwischensumme"
+      view_cart: "Warenkorb ansehen"
+    contact:
+      email: "E-Mail"
+      form_success: "Danke! Deine Nachricht wurde gesendet und wir werden uns bald bei dir melden."
+      message: "Nachricht"
+      name: "Name"
+      send_button: "Nachricht senden"
+      subject: "Betreff"

data/locales/storefront.en-CA.yml

@@ -0,0 +1,81 @@
+en-CA:
+  storefront:
+    navigation:
+      all: "All"
+      all_products: "All products"
+      back_to_site: "Back to site"
+      cart: "Cart"
+      categories: "Categories"
+      contact: "Contact"
+      home: "Home"
+      item: "item"
+      items: "items"
+      more: "More"
+      next: "Next"
+      newest: "Newest"
+      pages: "Pages"
+      previous: "Previous"
+      products: "Products"
+      quick_view: "Quick view"
+      search: "Search"
+      shop: "Shop"
+      social: "Follow us"
+      subscribe: "Subscribe"
+      top_selling: "Best-selling"
+      view: "View"
+      view_all: "View all"
+      # "Sort By" translations are used in very few themes, and are not exposed in theme settings for sellers to configure
+      sort_by: Sort by
+      sort_by_featured: Featured
+      sort_by_on_sale: On Sale
+      sort_by_top_selling: Top Selling
+      sort_by_alphabetically_a_to_z: Alphabetically (A to Z)
+      sort_by_alphabetically_z_to_a: Alphabetically (Z to A)
+      sort_by_date_new_to_old: Date (New to Old)
+      sort_by_date_old_to_new: Date (Old to New)
+      sort_by_price_low_to_high: Price (Low to High)
+      sort_by_price_high_to_low: Price (High to Low)
+    home:
+      all_products: "All products"
+      featured: "Featured"
+      featured_categories: "Featured categories"
+      featured_products: "Featured products"
+      featured_video: ""
+    products:
+      add_to_cart: "Add to cart"
+      adding: "Adding..." # Used in few themes, intentionally not exposed in theme settings
+      added: "Added!" # Used in few themes, intentionally not exposed in theme settings
+      almost_sold_out: "Only a few left!"
+      coming_soon: "Coming soon"
+      description: "Description"
+      in_stock: "in stock"
+      inventory: "Inventory"
+      low_inventory: "Limited quantities available"
+      no_products: "No products found"
+      on_sale: "On sale"
+      related_products: "You might also like"
+      reset: "Reset"
+      search_results: "Search results"
+      select: "Select"
+      select_variant: "Select option"
+      sold_out: "Sold out"
+      variant: "Option"
+      variants: "Options"
+    cart:
+      checkout: "Checkout"
+      continue_shopping: "Continue shopping"
+      empty_cart: "Your cart is empty"
+      quantity_abbreviated: "Qty"
+      quantity: "Quantity"
+      remove: "Remove"
+      share_this_cart: "Share this cart"
+      share_this_cart_link_copy_success: "Link copied!"
+      subtotal: "Subtotal"
+      view_cart: "View cart"
+    contact:
+      email: "Email"
+      form_success: "Thanks! Your message has been sent and we'll get back to you soon."
+      message: "Message"
+      name: "Name"
+      send_button: "Send message"
+      subject: "Subject"

data/locales/storefront.en-GB.yml

@@ -0,0 +1,81 @@
+en-GB:
+  storefront:
+    navigation:
+      all: "All"
+      all_products: "All products"
+      back_to_site: "Back to site"
+      cart: "Basket"
+      categories: "Categories"
+      contact: "Contact"
+      home: "Home"
+      item: "item"
+      items: "items"
+      more: "More"
+      next: "Next"
+      newest: "Newest"
+      pages: "Pages"
+      previous: "Previous"
+      products: "Products"
+      quick_view: "Quick view"
+      search: "Search"
+      shop: "Shop"
+      social: "Follow us"
+      subscribe: "Subscribe"
+      top_selling: "Top-selling"
+      view: "View"
+      view_all: "View all"
+      # "Sort By" translations are used in very few themes, and are not exposed in theme settings for sellers to configure
+      sort_by: Sort by
+      sort_by_featured: Featured
+      sort_by_on_sale: On Sale
+      sort_by_top_selling: Top Selling
+      sort_by_alphabetically_a_to_z: Alphabetically (A to Z)
+      sort_by_alphabetically_z_to_a: Alphabetically (Z to A)
+      sort_by_date_new_to_old: Date (New to Old)
+      sort_by_date_old_to_new: Date (Old to New)
+      sort_by_price_low_to_high: Price (Low to High)
+      sort_by_price_high_to_low: Price (High to Low)
+    home:
+      all_products: "All products"
+      featured: "Featured"
+      featured_categories: "Featured categories"
+      featured_products: "Featured products"
+      featured_video: ""
+    products:
+      add_to_cart: "Add to basket"
+      adding: "Adding..." # Used in few themes, intentionally not exposed in theme settings
+      added: "Added!" # Used in few themes, intentionally not exposed in theme settings
+      almost_sold_out: "Only a few left!"
+      coming_soon: "Coming soon"
+      description: "Description"
+      in_stock: "in stock"
+      inventory: "Stock"
+      low_inventory: "Limited quantities available"
+      no_products: "No products found"
+      on_sale: "On offer"
+      related_products: "You might also like"
+      reset: "Reset"
+      search_results: "Search results"
+      select: "Select"
+      select_variant: "Select option"
+      sold_out: "Sold out"
+      variant: "Option"
+      variants: "Options"
+    cart:
+      checkout: "Checkout"
+      continue_shopping: "Continue shopping"
+      empty_cart: "Your basket is empty"
+      quantity_abbreviated: "Qty"
+      quantity: "Quantity"
+      remove: "Remove"
+      share_this_cart: "Share this basket"
+      share_this_cart_link_copy_success: "Link copied!"
+      subtotal: "Subtotal"
+      view_cart: "View basket"
+    contact:
+      email: "Email"
+      form_success: "Thanks! Your message has been sent and we'll get back to you soon."
+      message: "Message"
+      name: "Name"
+      send_button: "Send message"
+      subject: "Subject"

data/locales/storefront.en-US.yml

@@ -0,0 +1,81 @@
+en-US:
+  storefront:
+    navigation:
+      all: "All"
+      all_products: "All products"
+      back_to_site: "Back to site"
+      cart: "Cart"
+      categories: "Categories"
+      contact: "Contact"
+      home: "Home"
+      item: "item"
+      items: "items"
+      more: "More"
+      next: "Next"
+      newest: "Newest"
+      pages: "Pages"
+      previous: "Previous"
+      products: "Products"
+      quick_view: "Quick view"
+      search: "Search"
+      shop: "Shop"
+      social: "Follow us"
+      subscribe: "Subscribe"
+      top_selling: "Top-selling"
+      view: "View"
+      view_all: "View all"
+      # "Sort By" translations are used in very few themes, and are not exposed in theme settings for sellers to configure
+      sort_by: Sort by
+      sort_by_featured: Featured
+      sort_by_on_sale: On Sale
+      sort_by_top_selling: Top Selling
+      sort_by_alphabetically_a_to_z: Alphabetically (A to Z)
+      sort_by_alphabetically_z_to_a: Alphabetically (Z to A)
+      sort_by_date_new_to_old: Date (New to Old)
+      sort_by_date_old_to_new: Date (Old to New)
+      sort_by_price_low_to_high: Price (Low to High)
+      sort_by_price_high_to_low: Price (High to Low)
+    home:
+      all_products: "All products"
+      featured: "Featured"
+      featured_categories: "Featured categories"
+      featured_products: "Featured products"
+      featured_video: ""
+    products:
+      add_to_cart: "Add to cart"
+      adding: "Adding..." # Used in few themes, intentionally not exposed in theme settings
+      added: "Added!" # Used in few themes, intentionally not exposed in theme settings
+      almost_sold_out: "Only a few left!"
+      coming_soon: "Coming soon"
+      description: "Description"
+      in_stock: "in stock"
+      inventory: "Inventory"
+      low_inventory: "Limited quantities available"
+      no_products: "No products found"
+      on_sale: "On sale"
+      related_products: "You might also like"
+      reset: "Reset"
+      search_results: "Search results"
+      select: "Select"
+      select_variant: "Select option"
+      sold_out: "Sold out"
+      variant: "Option"
+      variants: "Options"
+    cart:
+      checkout: "Checkout"
+      continue_shopping: "Continue shopping"
+      empty_cart: "Your cart is empty"
+      quantity_abbreviated: "Qty"
+      quantity: "Quantity"
+      remove: "Remove"
+      share_this_cart: "Share this cart"
+      share_this_cart_link_copy_success: "Link copied!"
+      subtotal: "Subtotal"
+      view_cart: "View cart"
+    contact:
+      email: "Email"
+      form_success: "Thanks! Your message has been sent and we'll get back to you soon."
+      message: "Message"
+      name: "Name"
+      send_button: "Send message"
+      subject: "Subject"