shoperb_liquid 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8541bd02f53f35ef50ce7447e69d16aa77d320261acd78d4f28d105b23f56c94
+  data.tar.gz: b3443c0b6e0b69861d33588ed40e3ee2319873efb1241d26da0b478705cc35e4
+SHA512:
+  metadata.gz: 63793d3bcc3c6516f956d9807814149684d453df92242a882fec7bcec903cf75df70162097cdbfafefc2e716e7cbf764c68ab56d57ae33f93d199467c24ed6f0
+  data.tar.gz: 208e27a4d4d8768076026677f00016e669f00c239ccece2d12259d131bc351bf91efaa170e0dae7b80dda62d7ff0e87ee202fb4fc47feb9ca3c5b2d9aa79874e

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea/*

data/.rubocop.yml

@@ -0,0 +1,131 @@
+Rails:
+  Enabled: true
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
+  Exclude:
+    - 'tmp/**/*'
+    - 'spec/**/*'
+    - 'db/**/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+    - 'lib/tasks/**/*'
+    - '**/*.rake'
+    - 'config.ru'
+    - 'Gemfile'
+    - 'Rakefile'
+Style/Documentation:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/RescueModifier:
+  Enabled: false
+Style/DotPosition:
+  EnforcedStyle: trailing
+Style/ModuleFunction:
+  EnforcedStyle: extend_self
+Style/UnneededInterpolation:
+  Enabled: false
+Style/TernaryParentheses:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Lint/IneffectiveAccessModifier:
+  Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+Lint/RescueException:
+  Enabled: false
+Lint/UnusedBlockArgument:
+  Enabled: false
+Lint/UnusedMethodArgument:
+  Enabled: false
+Lint/UselessAssignment:
+  Enabled: true
+Metrics/LineLength:
+  Max: 192
+Style/MultilineTernaryOperator:
+  Enabled: false
+Style/AlignHash:
+  EnforcedHashRocketStyle: key
+  EnforcedColonStyle: key
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/BracesAroundHashParameters:
+  Enabled: false
+Style/ClosingParenthesisIndentation:
+  Enabled: false
+Style/MultilineMethodDefinitionBraceLayout:
+  EnforcedStyle: new_line
+Style/IfUnlessModifierOfIfUnless:
+  Enabled: true
+Style/ClassVars:
+  Enabled: false
+Style/Documentation:
+  Enabled: true
+Style/DoubleNegation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+Style/CaseIndentation:
+  IndentOneStep: true
+  EnforcedStyle: end
+Style/ParallelAssignment:
+  Enabled: false
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: comma
+Style/FormatString:
+  Enabled: false
+Style/GuardClause:
+  Enabled: false
+Style/PredicateName:
+  Enabled: false
+Style/NestedTernaryOperator:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: true
+  EnforcedStyle: always
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+Style/WordArray:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Metrics/BlockNesting:
+  Enabled: false
+Performance/TimesMap:
+  Enabled: false
+Performance/CaseWhenSplat:
+  Enabled: false
+Rails/Delegate:
+  Enabled: false
+Style/MultilineBlockChain:
+  Enabled: false
+Style/Lambda:
+  Enabled: false
+Style/CaseEquality:
+  Enabled: false
+Style/SpaceInLambdaLiteral:
+  EnforcedStyle: require_space
+Style/MultilineAssignmentLayout:
+  EnforcedStyle: same_line
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+Style/LambdaCall:
+  EnforcedStyle: braces
+Style/FormatString:
+  EnforcedStyle: percent
+Style/Encoding:
+  EnforcedStyle: always
+Style/CommandLiteral:
+  AllowInnerBackticks: true
+Style/ClassCheck:
+  Enabled: false
+Style/IndentArray:
+  EnforcedStyle: consistent
+Style/IndentHash:
+  EnforcedStyle: consistent

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shoperb_liquid.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c)
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,143 @@
+# ShoperbLiquid
+
+ShoperbLiquid gem provides all the necessary filters, tags and drops for Liquid part of Shoperb and RTE.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shoperb_liquid'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shoperb_liquid
+
+## Usage
+
+You can configure the gem the following way:
+
+```
+ShoperbLiquid.configure do |config|
+  config.cache = MyCacheClass.new
+  config.translator = I18n
+  config.assets_remote_host = "https://cdn.my-assets.com"
+  config.routes = Rails.application.routes.url_helpers
+  config.environment = :development
+  config.models_namespace = nil
+  conifg.file_system = MyFileSystem.new
+  config.error_mode = :strict
+  config.error_notify = lambda { |error, template, line| }
+end
+```
+
+### cache
+
+Accepts an instance of class, respondible to caching, which implements methods "fetch", "read", "write". Cache is used for Cache liquid tag.
+
+Example: ActiveSupport::Cache::MemoryStore.new, ActiveSupport::Cache::FileStore.new, ActiveSupport::Cache::MemCacheStore.new, etc.
+
+### translator
+
+Translator is expecting to recieve an instance of class, which is responsible for translating strings inside the theme. It should implement methods "translate" and "locale". It can be I18n or it can be any other custom class, which reads translation strings from some other places (database).
+
+### assets_remote_host
+
+This configuration defines the remote host for assets (if any) and is used in such liquid filters, like theme_filters#customize.
+
+### routes
+
+This config is expecting a class, which is responsible for building urls. It should work a lot like rails routes helper and implement following methods:
+
+* store_root_path
+* store_cart_path
+* store_signup_path
+* store_login_path
+* store_logout_path
+* store_account_path
+* add_store_account_billing_payment_methods_path
+* store_account_billing_payment_method_path
+* delete_store_account_billing_payment_method_path
+* store_address_path
+* store_addresses_path
+* store_blog_post_path
+* store_blog_posts_path
+* store_brand_path
+* store_brands_path
+* store_category_path
+* store_categories_path
+* store_checkout_order_url
+* store_collection_path
+* store_collections_path
+* store_order_path
+* store_orders_path
+* store_page_path
+* store_pages_path
+* store_product_path
+* store_products_path
+* store_variants_path
+* store_subscribers_add_path
+* store_search_path
+* store_recover_password_path
+* store_reset_password_path
+* new_store_address_path
+* add_store_cart_path
+* checkout_store_cart_path
+* update_store_cart_path
+* store_new_login_path
+* store_upd_reset_password_path
+* store_account_subscriptions_path
+* store_account_subscription_plans_path
+* store_account_create_subscription_path
+* store_order_returns_path
+* new_store_order_return_path
+* store_order_return_path
+* store_order_return_generate_parcel_path
+
+### environment
+
+Accepts values: products, development, test, (any other) + theme_development, which would rather by used by RTE.
+
+### models_namespace
+
+In case if your models are namespaced, you can provide the namespace name in this config.
+
+### file_system
+
+File System is a class, responsible for fetching theme files (for example from the file system or database). It should implement following methods:
+
+* __read_template_file__: (should fetch template or fragment)
+* __read_section_file__: (should fetch section)
+* __absolute_asset_path__: (should return absolute path of an asset by its relative (or basename) path). For instance Shoperb side needs to print correct pathname with a digest, taken from database.
+
+### error_mode
+
+Liquid error mode. Values: strict, :warn, lax (default).
+
+## Liquid template options
+
+Options, provided to the template, are passed by __shoperb_liquid__ gem. However, options should be built in the appropriate context. In order for them to be built correctly, context should have following variables:
+
+* __params__: hash
+* __options__: hash
+* __flash__: hash
+* __shop__: object
+* __request__: object
+* __template__: string
+* __current_cart__: object
+* __current_carts__: array
+* __current_customer__: object
+* __current_settings__: hash
+* __ResourceHints__: object (optional)
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/shoperb_liquid/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+

data/lib/shoperb_liquid/configuration.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module ShoperbLiquid
+  class Configuration
+    attr_accessor :cache, :file_system, :translator,
+      :assets_remote_host, :environment, :routes,
+      :models_namespace, :error_mode, :error_notify
+
+    def initialize
+      @cache        = default_cache
+      @file_system  = default_file_system
+      @translator   = default_translator
+      @routes       = default_routes
+      @error_mode   = Liquid::Environment.default.error_mode = :lax
+      @error_notify = default_error_notify
+      @models_namespace = nil
+    end
+
+    def file_system=(value)
+      @file_system = Liquid::Environment.default.file_system = value
+    end
+
+    def environment=(value)
+      @environment = value.to_s.inquiry
+    end
+
+    def error_mode=(value)
+      @error_mode = Liquid::Environment.default.error_mode = value
+    end
+
+    def models_namespace=(namespace)
+      if namespace != @models_namespace
+        @models_namespace = namespace
+        ShoperbLiquid::Models.shadow
+      end
+    end
+
+    def error_notify(*args)
+      @error_notify.call(*args)
+    end
+
+    private
+
+    def default_cache
+      ActiveSupport::Cache::MemoryStore.new
+    end
+
+    def default_translator
+      AbstractTranslator.new
+    end
+
+    def default_file_system
+      AbstractFileReader.new
+    end
+
+    def default_routes
+      AbstractRoutesHelper.new
+    end
+
+    def default_error_notify
+      lambda { |error, template, line| }
+    end
+
+    #
+    # File reader class should implement following methods
+    # so liquid knew where to fetch files from
+    #
+    class AbstractFileReader
+      def read_template_file(*args)
+        raise ShoperbLiquid::Error, "No file system given to read template file"
+      end
+
+      def read_section_file(*args)
+        raise ShoperbLiquid::Error, "No file system given to read section file"
+      end
+
+      def absolute_asset_path(*args)
+        raise ShoperbLiquid::Error, "No file system given to detect absolute asset path"
+      end
+    end
+
+    #
+    # Class, which is reponsible for fetching transltions
+    # should implement following methods
+    #
+    class AbstractTranslator
+      def translate(string, **args)
+        string
+      end
+
+      def locale
+        :en
+      end
+    end
+
+    #
+    # Class, which is reponsible for building urls
+    # should implement following methods
+    #
+    class AbstractRoutesHelper
+      PATHS = [
+        :store_root_path,
+        :store_cart_path,
+        :store_carts_path,
+        :store_signup_path,
+        :store_login_path,
+        :store_logout_path,
+        :store_account_path,
+        :add_store_account_billing_payment_methods_path,
+        :store_account_billing_payment_method_path,
+        :delete_store_account_billing_payment_method_path,
+        :store_address_path,
+        :store_addresses_path,
+        :store_blog_post_path,
+        :store_blog_posts_path,
+        :store_brand_path,
+        :store_brands_path,
+        :store_category_path,
+        :store_categories_path,
+        :store_checkout_order_url,
+        :store_collection_path,
+        :store_collections_path,
+        :store_order_path,
+        :store_orders_path,
+        :store_page_path,
+        :store_pages_path,
+        :store_product_path,
+        :store_products_path,
+        :store_variants_path,
+        :store_subscribers_add_path,
+        :store_search_path,
+        :store_recover_password_path,
+        :store_reset_password_path,
+        :new_store_address_path,
+        :add_store_cart_path,
+        :checkout_store_cart_path,
+        :update_store_cart_path,
+        :add_store_multi_cart_path,
+        :checkout_store_multi_cart_path,
+        :update_store_multi_cart_path,
+        :store_new_login_path,
+        :store_upd_reset_password_path,
+        :store_account_subscriptions_path,
+        :store_account_subscription_plans_path,
+        :store_account_create_subscription_path,
+        :store_order_returns_path,
+        :store_order_return_path,
+        :new_store_order_return_path,
+        :store_order_return_generate_parcel_path,
+      ].freeze
+
+      PATHS.each do |path|
+        define_method path do |*_|
+          raise_not_implemented(path)
+        end
+      end
+
+      def url_for(*_)
+        raise_not_implemented(:url_for)
+      end
+
+      private
+
+      def raise_not_implemented(path)
+        raise ShoperbLiquid::Error, "Cannot build url #{path} with given routes helper"
+      end
+    end
+  end
+end

data/lib/shoperb_liquid/drops/account_drop.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ShoperbLiquid
+  class AccountDrop < Base
+    def shops
+      CollectionDrop.new(@record.shops.by_name)
+    end
+  end
+end

data/lib/shoperb_liquid/drops/address_drop.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module ShoperbLiquid
+  class AddressDrop < Base
+    def id
+      record.id
+    end
+
+    def name
+      record.name
+    end
+
+    def first_name
+      record.first_name
+    end
+
+    def last_name
+      record.last_name
+    end
+
+    def full_name
+      record.full_name
+    end
+
+    def company
+      record.company
+    end
+
+    def company?
+      record.account_type == "company"
+    end
+
+    # def email
+    #   record.email
+    # end
+
+    def phone
+      record.phone
+    end
+
+    def full_address
+      record.full_address
+    end
+
+    def company_with_phone
+      record.company_with_phone
+    end
+
+    def city_state_with_zip
+      record.city_state_with_zip
+    end
+
+    def state_with_country
+      record.state_with_country
+    end
+
+    def zip_with_city
+      record.zip_with_city
+    end
+
+    def street
+      record.full_address
+    end
+
+    def address1
+      record.address1
+    end
+
+    def address2
+      record.address2
+    end
+
+    def city
+      record.city
+    end
+
+    def state
+      record.state_name
+    end
+
+    def country
+      record.country_name
+    end
+
+    def state_code
+      record.state&.code
+    end
+
+    def country_code
+      record.country&.code
+    end
+
+    def zip
+      record.zip
+    end
+
+    def vat_number
+      record.vat_number
+    end
+
+    # return only for address customer
+    # if have id then showing edit/update path
+    # if id not present, then create path.
+    # This is for simplicity of theme creators
+    def url
+      if record&.type == "AddressCustomer"
+        if record.id
+          controller.store_address_path(record)
+        else
+          controller.store_addresses_path
+        end
+      end
+    end
+
+    def delete_url
+      if record&.type == "AddressCustomer" && id
+        controller.delete_store_address_path(id)
+      end
+    end
+  end
+end

data/lib/shoperb_liquid/drops/array_drop.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module ShoperbLiquid
+  class ArrayDrop < CollectionDrop
+    def [](attr)
+      return super unless attr.is_a?(Integer)
+      collection[attr]
+    end
+
+    def include?(other)
+      collection.include?(other)
+    end
+
+    def inspect
+      collection.inspect
+    end
+  end
+end

data/lib/shoperb_liquid/drops/attribute_drop.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ShoperbLiquid
+  class AttributeDrop < Base
+    def id
+      record.id
+    end
+
+    def handle
+      record.handle
+    end
+
+    def name
+      record.name
+    end
+
+    def value
+      record.value
+    end
+  end
+end