workarea-core 3.4.44 → 3.5.0.beta.1

data/lib/workarea/elasticsearch/document.rb

@@ -44,27 +44,22 @@ module Workarea
 
         def save(document, options = {})
           options = options.merge(type: type)
-          current_index.save(document, options)
+          I18n.for_each_locale { current_index.save(document, options) }
         end
 
-        def bulk(documents = [], options = {})
+        def bulk(documents, options = {})
           options = options.merge(type: type)
-
-          if block_given?
-            I18n.for_each_locale { current_index.bulk(Array.wrap(yield), options) }
-          else
-            current_index.bulk(documents, options)
-          end
+          I18n.for_each_locale { current_index.bulk(documents, options) }
         end
 
         def update(document, options = {})
           options = options.merge(type: type)
-          current_index.update(document, options)
+          I18n.for_each_locale { current_index.update(document, options) }
         end
 
         def delete(id, options = {})
           options = options.merge(type: type)
-          current_index.delete(id, options)
+          I18n.for_each_locale { current_index.delete(id, options) }
         end
 
         def count(query = nil, options = {})
@@ -102,14 +97,12 @@ module Workarea
       end
 
       def save(options = {})
-        I18n.for_each_locale do
-          document = as_document.merge(Serializer.serialize(model))
-          self.class.save(document, options)
-        end
+        document = as_document.merge(Serializer.serialize(model))
+        self.class.save(document, options)
       end
 
       def destroy(options = {})
-        I18n.for_each_locale { self.class.delete(id, options) }
+        self.class.delete(id, options)
       end
     end
   end

data/lib/workarea/ext/freedom_patches/action_view_cache_helper.rb

@@ -11,13 +11,11 @@ module ActionView
       end
 
       def cache_fragment_name(*)
-        result = super
-
-        if request.env['workarea.cache_varies'].present?
-          result << request.env['workarea.cache_varies']
-        end
+        super.tap { |result| result << cache_varies if cache_varies.present? }
+      end
 
-        result
+      def cache_varies
+        request.env['workarea.cache_varies']
       end
     end
   end

data/lib/workarea/ext/freedom_patches/active_support_duration.rb

@@ -0,0 +1,14 @@
+module ActiveSupport
+  class Duration
+    class << self
+      def mongoize(object)
+        object.parts.to_a.first.reverse
+      end
+      alias_method :evolve, :mongoize
+
+      def demongoize(object)
+        object.first.to_i.send(object.last.to_sym)
+      end
+    end
+  end
+end

data/lib/workarea/ext/freedom_patches/money.rb

@@ -1,4 +1,15 @@
 class Money
+  module BlankMongoizing
+    def mongoize(value)
+      return nil if value.blank?
+      super(value)
+    end
+  end
+
+  class << self
+    prepend BlankMongoizing
+  end
+
   alias_method :to_m, :to_money
 
   def as_json(*)

data/lib/workarea/ext/freedom_patches/premailer.rb

@@ -0,0 +1,6 @@
+class Premailer
+  def convert_to_text(html, line_length = 65, from_charset = 'UTF-8')
+    html.gsub!(/<script.*script>/m, '')
+    super(html, line_length, from_charset)
+  end
+end

data/lib/workarea/ext/freedom_patches/string.rb

@@ -1,13 +1,28 @@
+# frozen_string_literal: true
+
 class String
+  #
+  # These two methods are to cut down on object allocation
+  #
+
+  def self.optionize_unwanted_chars_regex
+    @optionize_unwanted_chars_regex ||= /[^a-z0-9\-_]+/
+  end
+
+  def self.optionize_seperator_regexes
+    @optionize_seperator_regexes ||= {}
+  end
+
   def optionize(sep = '-')
-    result = downcase.strip
+    result = downcase
+    result.strip!
 
     # Turn unwanted chars into the separator
-    result.gsub!(/[^a-z0-9\-_]+/, sep)
-    re_sep = Regexp.escape(sep)
+    result.gsub!(String.optionize_unwanted_chars_regex, sep)
 
     # No more than one of the separator in a row.
-    result.gsub!(/#{re_sep}{2,}/, sep)
+    String.optionize_seperator_regexes[sep] ||= /#{Regexp.escape(sep)}{2,}/
+    result.gsub!(String.optionize_seperator_regexes[sep], sep)
 
     result.underscore
   end

data/lib/workarea/ext/mongoid/find_ordered.rb

@@ -4,8 +4,8 @@ module Mongoid
       ids = Array(ids).flatten
       return [] if ids.blank?
 
-      unsorted = any_in(id: ids).to_a
-      ids.map { |id| unsorted.detect { |p| p.id.to_s == id.to_s } }.compact
+      lookup = scoped.any_in(id: ids).to_lookup_hash
+      ids.map { |id| lookup[id] }.compact
     end
   end
 end

data/lib/workarea/ext/mongoid/lookup_hash.rb

@@ -0,0 +1,30 @@
+module Mongoid
+  class LookupHash
+    delegate_missing_to :@table
+
+    def initialize(klass)
+      @klass = klass
+      @table = {}
+    end
+
+    def [](value)
+      @table[value] || @table[@klass.fields['_id'].type.mongoize(value)]
+    end
+  end
+
+  class Criteria
+    def to_lookup_hash
+      scoped.each_with_object(LookupHash.new(klass)) do |model, result|
+        result[model.id] = model
+      end
+    end
+
+    alias_method :to_lookup_h, :to_lookup_hash
+  end
+
+  module Document
+    class_methods do
+      delegate :to_lookup_h, :to_lookup_hash, to: :criteria
+    end
+  end
+end

data/lib/workarea/geolocation.rb

@@ -8,7 +8,7 @@ module Workarea
     end
 
     def country
-      Country[
+      @country ||= Country[
         @env['HTTP_GEOIP2_DATA_COUNTRY_CODE'].presence ||
           @env['HTTP_GEOIP_CITY_COUNTRY_CODE'].presence ||
             request.try(:country_code)
@@ -16,29 +16,35 @@ module Workarea
     end
 
     def region
-      region_from_geoip2.presence ||
+      @region ||= region_from_geoip2.presence ||
         @env['HTTP_GEOIP_REGION'].presence ||
         request_data['region_code']
     end
 
+    def subdivision
+      return @subdivision if defined?(@subdivision)
+      @subdivision = country&.subdivisions&.fetch(region) rescue nil
+    end
+
     def city
-      @env['HTTP_GEOIP2_DATA_CITY_NAME'].presence ||
+      @city ||= @env['HTTP_GEOIP2_DATA_CITY_NAME'].presence ||
         @env['HTTP_GEOIP_CITY'].presence ||
         request.try(:city)
     end
 
     def postal_code
-      @env['HTTP_GEOIP_POSTAL_CODE'].presence || request.try(:postal_code)
+      @postal_code ||= @env['HTTP_GEOIP_POSTAL_CODE'].presence ||
+        request.try(:postal_code)
     end
 
     def latitude
-      @env['HTTP_GEOIP2_DATA_LATITUDE'].presence ||
+      @latitude ||= @env['HTTP_GEOIP2_DATA_LATITUDE'].presence ||
         @env['HTTP_GEOIP_LATITUDE'].presence ||
         request.try(:latitude)
     end
 
     def longitude
-      @env['HTTP_GEOIP2_DATA_LONGITUDE'].presence ||
+      @longitude ||= @env['HTTP_GEOIP2_DATA_LONGITUDE'].presence ||
         @env['HTTP_GEOIP_LONGITUDE'].presence ||
         request.try(:longitude)
     end
@@ -50,6 +56,18 @@ module Workarea
       [latitude, longitude]
     end
 
+    def names
+      @names ||= [
+        postal_code,
+        city,
+        region,
+        subdivision&.name,
+        country&.alpha2,
+        country&.alpha3,
+        country&.name
+      ].reject(&:blank?)
+    end
+
     private
 
     def request

data/lib/workarea/routes_constraints/super_admin.rb

@@ -2,7 +2,7 @@ module Workarea
   module RoutesConstraints
     class SuperAdmin
       def matches?(request)
-        user_id = request.cookie_jar.signed[:user_id]
+        user_id = request.session[:user_id]
         return false if user_id.blank?
         User.find(user_id).super_admin?
       end

data/lib/workarea/version.rb

@@ -1,10 +1,9 @@
 module Workarea
   module VERSION
     MAJOR = 3
-    MINOR = 4
-    PATCH = 44
-    PRE   = nil
-
+    MINOR = 5
+    PATCH = 0
+    PRE   = 'beta.1'
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join('.')
 
     module MONGODB

data/lib/workarea/visit.rb

@@ -0,0 +1,92 @@
+module Workarea
+  class Visit
+    class UnsupportedSessionAccess < RuntimeError; end
+
+    attr_reader :env
+    attr_writer :override_segments
+
+    delegate :postal_code, :city, :subdivision, :region, :country, to: :geolocation
+    delegate :admin?, to: :metrics
+
+    def initialize(env)
+      @env = env
+    end
+
+    def cookies
+      request.cookie_jar
+    end
+
+    def session
+      raise UnsupportedSessionAccess unless Configuration::Session.cookie_store?
+      @session ||= (cookies.signed_or_encrypted[Configuration::Session.key] || {}).with_indifferent_access
+    end
+
+    def logged_in?
+      session[:user_id].present?
+    end
+
+    def request
+      @request ||= ActionDispatch::Request.new(env)
+    end
+
+    def geolocation
+      @geolocation ||= Workarea::Geolocation.new(env, request.remote_ip)
+    end
+
+    def location_names
+      geolocation.names
+    end
+
+    def current_email
+      cookies.signed[:email]
+    end
+
+    def metrics
+      return blank_metrics if current_metrics_id.blank?
+      @metrics ||= Metrics::User.find_or_initialize_by(id: current_metrics_id)
+    end
+
+    # A value of 0 here means it's the first request we've seen
+    def sessions
+      @sessions ||= cookies[:sessions].to_i
+    end
+
+    def segments
+      @segments ||= Segment.find_qualifying(self)
+    end
+
+    def override_segments
+      @override_segments ||= Segment.in(id: session[:segment_ids]).to_a
+    end
+
+    def applied_segments
+      admin? ? override_segments : segments
+    end
+
+    def referrer
+      return @referrer if defined?(@referrer)
+      @referrer = Workarea.referrer_parser.parse(request.referrer) rescue {}
+    end
+
+    def browser
+      @browser ||= Browser.new(env['HTTP_USER_AGENT'], accept_language: env['HTTP_ACCEPT_LANGUAGE'])
+    end
+
+    def current_metrics_id
+      return @current_metrics_id if defined?(@current_metrics_id)
+      @current_metrics_id = current_email.presence || session['session_id']
+    end
+
+    def current_metrics_id=(id)
+      @current_metrics_id = id
+      @metrics = nil
+    end
+
+    private
+
+    # Memoizing this saves a lot of allocated objects
+    def blank_metrics
+      @blank_metrics ||= Metrics::User.new
+    end
+  end
+end

data/lib/workarea/warnings.rb

@@ -0,0 +1,95 @@
+module Workarea
+  module Warnings
+    extend self
+
+    def check
+      check_timezone
+      check_mongo_notable_scan
+      check_dragonfly_config
+      check_auto_capture
+    end
+
+    def check_timezone
+      if Rails.application.config.time_zone == 'UTC'
+        warn <<~eos
+**************************************************
+⛔️ WARNING: Rails.application.config.time_zone is set to UTC, which you \
+probably don't want.
+As of Workarea 3.2, we use that value as the standard \
+timezone for the admin side of the application.
+We recommend setting this to the timezone of the retailer. Contact them to \
+find their preference.
+**************************************************
+        eos
+      end
+    end
+
+    def check_mongo_notable_scan
+      if (Rails.env.development? &&
+          !Workarea.config.skip_service_connections &&
+          Configuration::Mongoid.indexes_enforced?)
+        warn <<~eos
+**************************************************
+⛔️ WARNING: MongoDB is configured with notablescan.
+
+This means that MongoDB won't run queries that require a collection scan and will return an error.
+Workarea turns this on for running tests to assert that queries have indexes, and turns it off at the end of the test run.
+Since you're not running in the test environment and this is turned on, it might mean the test process was killed, preventing Workarea from turning it off.
+
+To turn this off, start the mongo shell and run this command:
+db.getSiblingDB("admin").runCommand( { setParameter: 1, notablescan: 0 } )
+**************************************************
+        eos
+      end
+    end
+
+    def check_dragonfly_config
+      if !Rails.env.test? && !Rails.env.development? &&
+           Dragonfly.app(:workarea).datastore.is_a?(Dragonfly::FileDataStore)
+
+        warn <<~eos
+**************************************************
+⛔️ WARNING: Dragonfly is configured to use the filesystem.
+
+This means all dragonfly assets (assets, product images, etc.) will be stored
+locally and not accessible to all servers within your environment.
+
+We recommend using S3 when running in a live environment by setting
+WORKAREA_S3_REGION and WORKAREA_S3_BUCKET_NAME in your environment variables.
+Workarea will automatically configure Dragonfly to use S3 if those values
+are present.
+**************************************************
+        eos
+      end
+    end
+
+    def check_auto_capture
+      if Workarea.config.auto_capture
+        warn <<~eos
+**************************************************
+⛔️ WARNING: Workarea is configured with Workarea.config.auto_capture.
+
+In v3.5, this is being deprecated to allow more flexibility based on the types
+of items in the order.
+
+You should set Workarea.config.checkout_payment_action instead. You can set it
+for each type of order, here are the defaults:
+  {
+    shipped: 'authorize!',
+    not_shipped: 'purchase!',
+    mixed: 'authorize!'
+  }
+
+To achieve the same functionality as Workarea.config.auto_capture, you'd set:
+  {
+    shipped: 'purchase!',
+    not_shipped: 'purchase!',
+    mixed: 'purchase!'
+  }
+
+**************************************************
+        eos
+      end
+    end
+  end
+end