harpiya_core 4.3.0.alpha

data/lib/harpiya/core/importer/product.rb

@@ -0,0 +1,63 @@
+module Harpiya
+  module Core
+    module Importer
+      class Product
+        attr_reader :product, :product_attrs, :variants_attrs, :options_attrs
+
+        def initialize(product, product_params, options = {})
+          @product = product || Harpiya::Product.new(product_params)
+
+          @product_attrs = product_params.to_h
+          @variants_attrs = (options[:variants_attrs] || []).map(&:to_h)
+          @options_attrs = options[:options_attrs] || []
+        end
+
+        def create
+          if product.save
+            variants_attrs.each do |variant_attribute|
+              # make sure the product is assigned before the options=
+              product.variants.create({ product: product }.merge(variant_attribute))
+            end
+
+            set_up_options
+          end
+
+          product
+        end
+
+        def update
+          if product.update(product_attrs)
+            variants_attrs.each do |variant_attribute|
+              # update the variant if the id is present in the payload
+              if variant_attribute['id'].present?
+                product.variants.find(variant_attribute['id'].to_i).update(variant_attribute)
+              else
+                # make sure the product is assigned before the options=
+                product.variants.create({ product: product }.merge(variant_attribute))
+              end
+            end
+
+            set_up_options
+          end
+
+          product
+        end
+
+        private
+
+        def set_up_options
+          options_attrs.each do |name|
+            option_type = Harpiya::OptionType.where(name: name).first_or_initialize do |option_type|
+              option_type.presentation = name
+              option_type.save!
+            end
+
+            unless product.option_types.include?(option_type)
+              product.option_types << option_type
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/harpiya/core/number_generator.rb

@@ -0,0 +1,51 @@
+module Harpiya
+  module Core
+    class NumberGenerator < Module
+      BASE           = 10
+      DEFAULT_LENGTH = 9
+
+      attr_accessor :prefix, :length
+
+      def initialize(options)
+        @prefix     = options.fetch(:prefix)
+        @length     = options.fetch(:length, DEFAULT_LENGTH)
+        @letters    = options[:letters]
+      end
+
+      def included(host)
+        generator_instance = self
+
+        host.class_eval do
+          validates(:number, presence: true, uniqueness: { allow_blank: true })
+
+          before_validation do |instance|
+            instance.number ||= generate_permalink(host)
+          end
+
+          define_singleton_method(:number_generator) { generator_instance }
+
+          def generate_permalink(host)
+            host.number_generator.generate_permalink(host)
+          end
+        end
+      end
+
+      def generate_permalink(host)
+        length = @length
+
+        loop do
+          candidate = new_candidate(length)
+          return candidate unless host.exists?(number: candidate)
+
+          # If over half of all possible options are taken add another digit.
+          length += 1 if host.count > Rational(BASE**length, 2)
+        end
+      end
+
+      def new_candidate(length)
+        characters = @letters ? 36 : 10
+        @prefix + SecureRandom.random_number(characters**length).to_s(characters).rjust(length, '0').upcase
+      end
+    end # Permalink
+  end # Core
+end # Harpiya

data/lib/harpiya/core/product_duplicator.rb

@@ -0,0 +1,79 @@
+module Harpiya
+  class ProductDuplicator
+    attr_accessor :product
+
+    @@clone_images_default = true
+    mattr_accessor :clone_images_default
+
+    def initialize(product, include_images = @@clone_images_default)
+      @product = product
+      @include_images = include_images
+    end
+
+    def duplicate
+      new_product = duplicate_product
+
+      # don't dup the actual variants, just the characterising types
+      new_product.option_types = product.option_types if product.has_variants?
+
+      # allow site to do some customization
+      new_product.send(:duplicate_extra, product) if new_product.respond_to?(:duplicate_extra)
+      new_product.save!
+      new_product
+    end
+
+    protected
+
+    def duplicate_product
+      product.dup.tap do |new_product|
+        new_product.name = "COPY OF #{product.name}"
+        new_product.taxons = product.taxons
+        new_product.created_at = nil
+        new_product.deleted_at = nil
+        new_product.updated_at = nil
+        new_product.product_properties = reset_properties
+        new_product.master = duplicate_master
+        new_product.variants = product.variants.map { |variant| duplicate_variant variant }
+      end
+    end
+
+    def duplicate_master
+      master = product.master
+      master.dup.tap do |new_master|
+        new_master.sku = sku_generator(master.sku)
+        new_master.deleted_at = nil
+        new_master.images = master.images.map { |image| duplicate_image image } if @include_images
+        new_master.price = master.price
+        new_master.currency = master.currency
+      end
+    end
+
+    def duplicate_variant(variant)
+      new_variant = variant.dup
+      new_variant.sku = sku_generator(new_variant.sku)
+      new_variant.deleted_at = nil
+      new_variant.option_values = variant.option_values.map { |option_value| option_value }
+      new_variant
+    end
+
+    def duplicate_image(image)
+      new_image = image.dup
+      new_image.attachment.attach(image.attachment.blob)
+      new_image.save!
+      new_image
+    end
+
+    def reset_properties
+      product.product_properties.map do |prop|
+        prop.dup.tap do |new_prop|
+          new_prop.created_at = nil
+          new_prop.updated_at = nil
+        end
+      end
+    end
+
+    def sku_generator(sku)
+      "COPY OF #{Variant.unscoped.where('sku like ?', "%#{sku}").order(:created_at).last.sku}"
+    end
+  end
+end

data/lib/harpiya/core/product_filters.rb

@@ -0,0 +1,194 @@
+module Harpiya
+  module Core
+    # THIS FILE SHOULD BE OVER-RIDDEN IN YOUR SITE EXTENSION!
+    #   the exact code probably won't be useful, though you're welcome to modify and reuse
+    #   the current contents are mainly for testing and documentation
+
+    # To override this file...
+    #   1) Make a copy of it in your sites local /lib/harpiya folder
+    #   2) Add it to the config load path, or require it in an initializer, e.g...
+    #
+    #      # config/initializers/harpiya.rb
+    #      require 'harpiya/core/product_filters'
+    #
+
+    # set up some basic filters for use with products
+    #
+    # Each filter has two parts
+    #  * a parametrized named scope which expects a list of labels
+    #  * an object which describes/defines the filter
+    #
+    # The filter description has three components
+    #  * a name, for displaying on pages
+    #  * a named scope which will 'execute' the filter
+    #  * a mapping of presentation labels to the relevant condition (in the context of the named scope)
+    #  * an optional list of labels and values (for use with object selection - see taxons examples below)
+    #
+    # The named scopes here have a suffix '_any', following Ransack's convention for a
+    # scope which returns results which match any of the inputs. This is purely a convention,
+    # but might be a useful reminder.
+    #
+    # When creating a form, the name of the checkbox group for a filter F should be
+    # the name of F's scope with [] appended, eg "price_range_any[]", and for
+    # each label you should have a checkbox with the label as its value. On submission,
+    # Rails will send the action a hash containing (among other things) an array named
+    # after the scope whose values are the active labels.
+    #
+    # Ransack will then convert this array to a call to the named scope with the array
+    # contents, and the named scope will build a query with the disjunction of the conditions
+    # relating to the labels, all relative to the scope's context.
+    #
+    # The details of how/when filters are used is a detail for specific models (eg products
+    # or taxons), eg see the taxon model/controller.
+
+    # See specific filters below for concrete examples.
+    module ProductFilters
+      # Example: filtering by price
+      #   The named scope just maps incoming labels onto their conditions, and builds the conjunction
+      #   'price' is in the base scope's context (ie, "select foo from products where ...") so
+      #     we can access the field right away
+      #   The filter identifies which scope to use, then sets the conditions for each price range
+      #
+      # If user checks off three different price ranges then the argument passed to
+      # below scope would be something like ["$10 - $15", "$15 - $18", "$18 - $20"]
+      #
+      Harpiya::Product.add_search_scope :price_range_any do |*opts|
+        conds = opts.map { |o| Harpiya::Core::ProductFilters.price_filter[:conds][o] }.reject(&:nil?)
+        scope = conds.shift
+        conds.each do |new_scope|
+          scope = scope.or(new_scope)
+        end
+        Harpiya::Product.joins(master: :default_price).where(scope)
+      end
+
+      def self.format_price(amount)
+        Harpiya::Money.new(amount)
+      end
+
+      def self.price_filter
+        v = Harpiya::Price.arel_table
+        conds = [[Harpiya.t(:under_price, price: format_price(10)), v[:amount].lteq(10)],
+                 ["#{format_price(10)} - #{format_price(15)}", v[:amount].between(10..15)],
+                 ["#{format_price(15)} - #{format_price(18)}", v[:amount].between(15..18)],
+                 ["#{format_price(18)} - #{format_price(20)}", v[:amount].between(18..20)],
+                 [Harpiya.t(:or_over_price, price: format_price(20)), v[:amount].gteq(20)]]
+        {
+          name: Harpiya.t(:price_range),
+          scope: :price_range_any,
+          conds: Hash[*conds.flatten],
+          labels: conds.map { |k, _v| [k, k] }
+        }
+      end
+
+      # Example: filtering by possible brands
+      #
+      # First, we define the scope. Two interesting points here: (a) we run our conditions
+      #   in the scope where the info for the 'brand' property has been loaded; and (b)
+      #   because we may want to filter by other properties too, we give this part of the
+      #   query a unique name (which must be used in the associated conditions too).
+      #
+      # Secondly, the filter. Instead of a static list of values, we pull out all existing
+      #   brands from the db, and then build conditions which test for string equality on
+      #   the (uniquely named) field "p_brand.value". There's also a test for brand info
+      #   being blank: note that this relies on with_property doing a left outer join
+      #   rather than an inner join.
+      Harpiya::Product.add_search_scope :brand_any do |*opts|
+        conds = opts.map { |o| ProductFilters.brand_filter[:conds][o] }.reject(&:nil?)
+        scope = conds.shift
+        conds.each do |new_scope|
+          scope = scope.or(new_scope)
+        end
+        Harpiya::Product.with_property('brand').where(scope)
+      end
+
+      def self.brand_filter
+        brand_property = Harpiya::Property.find_by(name: 'brand')
+        brands = brand_property ? Harpiya::ProductProperty.where(property_id: brand_property.id).pluck(:value).uniq.map(&:to_s) : []
+        pp = Harpiya::ProductProperty.arel_table
+        conds = Hash[*brands.map { |b| [b, pp[:value].eq(b)] }.flatten]
+        {
+          name: I18n.t('harpiya.taxonomy_brands_name'),
+          scope: :brand_any,
+          conds: conds,
+          labels: brands.sort.map { |k| [k, k] }
+        }
+      end
+
+      # Example: a parameterized filter
+      #   The filter above may show brands which aren't applicable to the current taxon,
+      #   so this one only shows the brands that are relevant to a particular taxon and
+      #   its descendants.
+      #
+      #   We don't have to give a new scope since the conditions here are a subset of the
+      #   more general filter, so decoding will still work - as long as the filters on a
+      #   page all have unique names (ie, you can't use the two brand filters together
+      #   if they use the same scope). To be safe, the code uses a copy of the scope.
+      #
+      #   HOWEVER: what happens if we want a more precise scope?  we can't pass
+      #   parametrized scope names to Ransack, only atomic names, so couldn't ask
+      #   for taxon T's customized filter to be used. BUT: we can arrange for the form
+      #   to pass back a hash instead of an array, where the key acts as the (taxon)
+      #   parameter and value is its label array, and then get a modified named scope
+      #   to get its conditions from a particular filter.
+      #
+      #   The brand-finding code can be simplified if a few more named scopes were added to
+      #   the product properties model.
+      Harpiya::Product.add_search_scope :selective_brand_any do |*opts|
+        Harpiya::Product.brand_any(*opts)
+      end
+
+      def self.selective_brand_filter(taxon = nil)
+        taxon ||= Harpiya::Taxonomy.first.root
+        brand_property = Harpiya::Property.find_by(name: 'brand')
+        scope = Harpiya::ProductProperty.where(property: brand_property).
+                joins(product: :taxons).
+                where("#{Harpiya::Taxon.table_name}.id" => [taxon] + taxon.descendants)
+        brands = scope.pluck(:value).uniq
+        {
+          name: 'Applicable Brands',
+          scope: :selective_brand_any,
+          labels: brands.sort.map { |k| [k, k] }
+        }
+      end
+
+      # Provide filtering on the immediate children of a taxon
+      #
+      # This doesn't fit the pattern of the examples above, so there's a few changes.
+      # Firstly, it uses an existing scope which was not built for filtering - and so
+      # has no need of a conditions mapping, and secondly, it has a mapping of name
+      # to the argument type expected by the other scope.
+      #
+      # This technique is useful for filtering on objects (by passing ids) or with a
+      # scope that can be used directly (eg. testing only ever on a single property).
+      #
+      # This scope selects products in any of the active taxons or their children.
+      #
+      def self.taxons_below(taxon)
+        return Harpiya::Core::ProductFilters.all_taxons if taxon.nil?
+
+        {
+          name: 'Taxons under ' + taxon.name,
+          scope: :taxons_id_in_tree_any,
+          labels: taxon.children.sort_by(&:position).map { |t| [t.name, t.id] },
+          conds: nil
+        }
+      end
+
+      # Filtering by the list of all taxons
+      #
+      # Similar idea as above, but we don't want the descendants' products, hence
+      # it uses one of the auto-generated scopes from Ransack.
+      #
+      # idea: expand the format to allow nesting of labels?
+      def self.all_taxons
+        taxons = Harpiya::Taxonomy.all.map { |t| [t.root] + t.root.descendants }.flatten
+        {
+          name: 'All taxons',
+          scope: :taxons_id_equals_any,
+          labels: taxons.sort_by(&:name).map { |t| [t.name, t.id] },
+          conds: nil # not needed
+        }
+      end
+    end
+  end
+end

data/lib/harpiya/core/query_filters.rb

@@ -0,0 +1,11 @@
+module Harpiya
+  module Core
+    module QueryFilters
+    end
+  end
+end
+
+require 'harpiya/core/query_filters/comparable'
+require 'harpiya/core/query_filters/number'
+require 'harpiya/core/query_filters/date'
+require 'harpiya/core/query_filters/text'

data/lib/harpiya/core/query_filters/comparable.rb

@@ -0,0 +1,46 @@
+module Harpiya
+  module Core
+    module QueryFilters
+      class Comparable
+        def initialize(attribute:)
+          @attribute = attribute
+        end
+
+        def call(scope:, filter:)
+          scope = gt(scope, filter[:gt])
+          scope = gteq(scope, filter[:gteq])
+          scope = lt(scope, filter[:lt])
+          lteq(scope, filter[:lteq])
+        end
+
+        private
+
+        attr_reader :attribute
+
+        def gt(scope, value)
+          return scope unless value
+
+          scope.where(attribute.gt(value))
+        end
+
+        def gteq(scope, value)
+          return scope unless value
+
+          scope.where(attribute.gteq(value))
+        end
+
+        def lt(scope, value)
+          return scope unless value
+
+          scope.where(attribute.lt(value))
+        end
+
+        def lteq(scope, value)
+          return scope unless value
+
+          scope.where(attribute.lteq(value))
+        end
+      end
+    end
+  end
+end