liquidum 1.0.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c706ca4c829ea154f07046f2d670039b0f7c0a83f317d04461c630c37e2228a5
+  data.tar.gz: 7b791bd8ca4f80aaebb89bf7bced6905625c2054d766acafc248f68148631591
+SHA512:
+  metadata.gz: f5592e44012744611615e275e54cc5023d043b2d8e37babf792f03d3179bab71c368cc24462d2bf9e3344a07044cb44346791c00a071237258aa97e320b31de7
+  data.tar.gz: 1cd597b5d26227b7e950e197bc0de59b93d792b58778d5e7f179e3faa0f6bf40c42d3308a2fcb8eb90fa69b3124ae75c9e6af4ee649e496a6c86b3fe6f29d66e

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Tom de Grunt
+
+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,39 @@
+# Liquidum
+
+Simplified use of Shopify's liquid, including some handy filters, tags and drops.
+
+## Usage
+
+Basically it's as easy as:
+
+```ruby
+Liquidum.render("{{payload.test}}", assigns: { 'payload' => { 'test' => 'blah' } })
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'liquidum'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install liquidum
+```
+
+## Contributing
+
+Contribution directions go here.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Liquidum'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+  t.warning = false
+end
+
+task default: :test
+
+# Adds the Auxilium semver task
+spec = Gem::Specification.find_by_name 'auxilium'
+load "#{spec.gem_dir}/lib/tasks/semver.rake"

data/app/controllers/liquidum/application_controller.rb

@@ -0,0 +1,5 @@
+module Liquidum
+  class ApplicationController < ::ApplicationController
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/liquidum/completions_controller.rb

@@ -0,0 +1,15 @@
+require_dependency "liquidum/application_controller"
+
+module Liquidum
+  class CompletionsController < ApplicationController
+    def index
+      q          = params[:q]
+      klass      = q.classify.safe_constantize
+      drop       = q.classify.concat('Drop').safe_constantize
+      invokables = drop&.invokable_methods || []
+      # drop_relations = klass.reflect_on_all_associations.map(&:name).select {|n| invokables.include?(n.to_s) }
+
+      render json: { q: q, completions: invokables }
+    end
+  end
+end

data/app/controllers/liquidum/sandbox_controller.rb

@@ -0,0 +1,28 @@
+require_dependency 'liquidum/application_controller'
+
+module Liquidum
+  class SandboxController < ApplicationController
+    before_action :set_objects
+    class Sandbox
+      include ActiveModel::Model
+
+      attr_accessor :template, :context, :result
+    end
+
+    def index; end
+
+    def create
+      @sandbox.result = Liquidum.render(@sandbox.template, assigns: JSON.parse(@sandbox.context))
+      render :index
+    end
+
+    private
+
+    def set_objects
+      @sandbox = Sandbox.new(template: params.dig(:sandbox_controller_sandbox, :template) || '{{test}}',
+                             context: params.dig(:sandbox_controller_sandbox,
+                                                 :context) || '{"test": "context"}',
+                             result: '')
+    end
+  end
+end

data/app/helpers/liquidum/application_helper.rb

@@ -0,0 +1,4 @@
+module Liquidum
+  module ApplicationHelper
+  end
+end

data/app/jobs/liquidum/application_job.rb

@@ -0,0 +1,4 @@
+module Liquidum
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/models/concerns/liquidum/to_liquid.rb

@@ -0,0 +1,17 @@
+# frozen_literal_strings: true
+
+module Liquidum
+  module ToLiquid
+    extend ActiveSupport::Concern
+
+    included do
+      def to_liquid
+        klass = "#{self.class.name}Drop".safe_constantize
+        klass ||= "#{self.class.base_class.name}Drop".safe_constantize if self.class.respond_to?(:base_class)
+        raise "No Drop defined for #{self.class.name}" unless klass
+
+        klass.new(self)
+      end
+    end
+  end
+end

data/app/views/liquidum/sandbox/index.html.slim

@@ -0,0 +1,13 @@
+= sts.form_for(@sandbox, url: sandbox_index_path, data: { turbo: false }) do |f|
+  = sts.card(title: 'Liquid Sandbox') do |card|
+    - card.action
+      = f.submit t('.render')
+    = sts.tabs do |t|
+      - t.tab :main
+        .grid.grid-cols-12.gap-4
+          .col-span-12
+            = f.editor :context, mode: "application/json"
+          .col-span-12
+            = f.editor :template, mode: "text/plain"
+          .col-span-12
+            = f.editor :result, mode: "text/plain", read_only: true

data/config/routes.rb

@@ -0,0 +1,4 @@
+Liquidum::Engine.routes.draw do
+  resources :completions
+  resources :sandbox
+end

data/lib/liquidum/configuration.rb

@@ -0,0 +1,23 @@
+module Liquidum
+  class Configuration
+    attr_writer :logger
+    attr_accessor :liquidum_file_system
+    attr_writer :i18n_store
+
+    def initialize
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::INFO
+      @liquidum_file_system = 'Liquidum::LiquidumFileSystem'
+      @i18n_store = ->(context, block) { nil }
+    end
+
+    # logger [Object].
+    def logger
+      @logger.is_a?(Proc) ? instance_exec(&@logger) : @logger
+    end
+
+    def i18n_store(context, &block)
+      @i18n_store.is_a?(Proc) ? instance_exec(context, block, &@i18n_store) : @i18n_store
+    end
+  end
+end

data/lib/liquidum/drop.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Liquidum
+  class Drop < Liquid::Drop
+    delegate :id, :errors, to: :@object
+
+    def initialize(object)
+      @object = object
+    end
+
+    def is_for_a?(klass)
+      @object.is_a?(klass)
+    end
+
+    def to_gid
+      @object.to_gid
+    end
+
+    def to_sgid
+      @object.to_sgid
+    end
+
+    def to_h(max_level = 3, current_level: 0)
+      return if current_level > max_level
+
+      h = {}
+
+      public_methods(false).each do |pm|
+        result = send(pm)
+
+        h[pm] = if result.is_a? ApplicationDrop
+                  result.to_h(max_level, current_level: current_level + 1)
+                elsif result.is_a? Enumerator::Lazy
+                  result.map { |r| r.to_h(max_level, current_level: current_level + 1) }.force
+                else
+                  result
+                end
+      end
+      h
+    end
+
+    class << self
+      def association(*associations)
+        associations.each do |name|
+          define_method(name) do
+            if @object.class.respond_to?(:reflect_on_all_associations)
+              relation = @object.class.reflect_on_all_associations.find do |a|
+                a.name == name
+              end
+            end
+            return unless relation
+
+            klass = "#{relation.class_name}Drop".classify.safe_constantize
+
+            Rails.logger.warn "No #{klass}" and return unless klass
+
+            if relation.collection?
+              # FIXME: The LazyDrop has unexpected side effects for exisiting templates, this needs to be discussed further
+              # Enumerator::LazyDrop.new(@object.send(name).lazy.map { |o| klass.new(o) })
+              @object.send(name).map { |o| klass.new(o) }
+            else
+              klass.new(@object.send(name)) unless @object.send(name).nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/liquidum/engine.rb

@@ -0,0 +1,15 @@
+
+module Liquidum
+  class Engine < ::Rails::Engine
+    isolate_namespace Liquidum
+
+    config.autoload_paths << File.expand_path(File.join(File.dirname(__FILE__), '.', 'liquid'))
+
+    initializer 'liquidum.config' do |_app|
+      path = File.expand_path(File.join(File.dirname(__FILE__), '.', 'liquid', '{tags,filters,drops}', '*.rb'))
+      Dir.glob(path).each do |c|
+        require_dependency(c)
+      end
+    end
+  end
+end

data/lib/liquidum/liquid/drops/active_storage_attached_many_drop.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class ActiveStorageAttachedManyDrop < Liquidum::Drop
+  include Enumerable
+
+  def initialize(object)
+    super
+    @object = @object.map { |a| ActiveStorage::AttachmentDrop.new(a) }
+  end
+
+  def each(&block)
+    @object.each(&block)
+  end
+end

data/lib/liquidum/liquid/drops/active_storage_attached_one_drop.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class ActiveStorageAttachedOneDrop < Liquidum::Drop
+  def download
+    @object.download
+  end
+
+  def filename
+    @object.filename.to_s
+  end
+
+  def content_type
+    @object.content_type
+  end
+
+  def to_io
+    return unless @object.attached?
+
+    StringIO.new(@object.download)
+  end
+end

data/lib/liquidum/liquid/drops/active_storage_attachment_drop.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class ActiveStorage::AttachmentDrop < Liquidum::Drop
+  def download
+    @object.download
+  end
+
+  def filename
+    @object.filename.to_s
+  end
+
+  def content_type
+    @object.content_type
+  end
+
+  def [](something)
+    @object.send(something).to_s
+  end
+end

data/lib/liquidum/liquid/drops/enumerator_lazy_drop.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Enumerator::LazyDrop < Liquidum::Drop
+  def liquid_method_missing(method)
+    @object.send(method)
+  end
+end

data/lib/liquidum/liquid/filters/array_wrap_filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ArrayWrapFilter
+  # Wraps an object into an array if it is not already an array.
+  #
+  # Example:
+  #   <div class="summary">{%assign res = payload.test['MESSAGE']['ITEM'] | array_wrap %}{%for item in res %}{{item['PN']['$']}}{%endfor%}</div>
+  ##
+  def array_wrap(input)
+    Array.wrap(input)
+  end
+end
+
+Liquid::Template.register_filter(ArrayWrapFilter)

data/lib/liquidum/liquid/filters/encode_filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module EncodeFilter
+  # Encode text
+  #
+  # Example:
+  #   <div class="summary">{{title | encode: 'utf-8'}}</div>
+  ##
+  def encode(input, encoding, options = {})
+    input.encode(encoding)
+  end
+end
+
+Liquid::Template.register_filter(EncodeFilter)

data/lib/liquidum/liquid/filters/format_filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module FormatFilter
+  # Applies format to input
+  #
+  # Example:
+  #   <div class="summary">{{title | format: '%20s'}}</div>
+  ##
+  def format(input, format_string)
+    Kernel.format(format_string, input)
+  end
+end
+
+Liquid::Template.register_filter(FormatFilter)

data/lib/liquidum/liquid/filters/localize_filter.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LocalizeFilter
+  # Localize date/time
+  # See: http://guides.rubyonrails.org/i18n.html
+  #
+  # Examples:
+  #
+  # {{ date_time | localize: 'nl', '%d %b %R' }}
+  def localize(input, locale = 'en', format = nil)
+    I18n.l(input, format: format, locale: locale)
+  end
+end
+
+Liquid::Template.register_filter(LocalizeFilter)

data/lib/liquidum/liquid/filters/strptime_filter.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module StrptimeFilter
+  # Converts string to date time using format
+  #
+  # Example:
+  #   <div class="date">{{'08012020 09:01:00'| strptime: '%D%M%Y %H:%S:%M'}}</div>
+  ##
+  def strptime(input, format_string)
+    DateTime.strptime(input, format_string)
+  end
+end
+
+Liquid::Template.register_filter(StrptimeFilter)

data/lib/liquidum/liquid/filters/sum_filter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module SumFilter
+  # Sums the items in the array
+  #
+  # input - the object array
+  #
+  # Returns the sum
+  def sum(input)
+    return input unless input.respond_to?(:sum)
+
+    input = input.values if input.is_a?(Hash) # FIXME
+    input.sum
+  end
+end
+Liquid::Template.register_filter(SumFilter)

data/lib/liquidum/liquid/filters/timezone_filter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module TimezoneFilter
+  # Convert between timezones
+  # Inspired by: http://customer.io/docs/dates-timezones.html
+  # See: http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html
+  #
+  # Examples:
+  #
+  # {{ date_time | timezone: 'Europe/Amsterdam' }}
+  #
+  # Changes like +3 or -4 or not (yet) possible
+  def timezone(input, to_zone = 'UTC')
+    input.utc.in_time_zone(to_zone)
+  end
+end
+
+Liquid::Template.register_filter(TimezoneFilter)

data/lib/liquidum/liquid/filters/to_filter.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ToFilter
+  # Turn object in something else
+  #
+  # Example:
+  #   {{message.payload | to: 'json'}}
+  #   {{message.payload | to: 'yaml'}}
+  #
+  # Advanced example:
+  #   {{payload | to: 'json', pretty: true}}
+  #   {%assign today = 'now'|to: 'date'%}
+  #
+  def to(input, format, options = {})
+    case format
+    when 'yaml'
+      to_dump = input
+      to_dump = to_dump.to_h if input.is_a?(HashWithIndifferentAccess)
+      result  = YAML.dump(to_dump)
+      result  = result.gsub(/^---\n/, '') if options['inline']
+      result
+    when 'json'
+      if options['pretty']
+        JSON.pretty_generate(input)
+      else
+        input.to_json
+      end
+    when 'date'
+      date = Liquid::Utils.to_date(input)
+
+      return input if date.to_s.empty?
+      return date if options[:format].to_s.empty?
+
+      date.strftime(options[:format].to_s)
+    when 'sgid'
+      return '' if input.nil? || !input.respond_to?(:to_sgid)
+
+      # Should accept for and expires_on options but vorto/nuntius does not allow that
+      input.to_sgid.to_s
+    else
+      raise 'No to format given'
+    end
+  end
+end
+
+Liquid::Template.register_filter(ToFilter)

data/lib/liquidum/liquid/filters/translate_filter.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module TranslateFilter
+  # Translate text
+  #
+  # Example:
+  #   <div class="summary">{{'.title' | t}}</div>
+  #
+  # provide optional locale to translate the text in, if you don't pass it it will use I18n.locale
+  #
+  #   <div class="summary">{{'.title' | t: locale: 'nl'}}</div>
+  #
+  # you can provide additional arguments to be used for interpolation:
+  #
+  #   <div class="summary">{{'.title' | t: gender: 'm', locale: 'nl'}}</div>
+  #
+
+  def translate(input, options = {})
+    result = nil
+
+    Liquidum.config.i18n_store(@context) do |obj|
+      locale = options.delete('locale')
+
+      key = input
+      scope = nil
+
+      if key.start_with?('.')
+        key = input[1..-1]
+        scope = obj.translation_scope
+      end
+
+      result = I18n.t(key, locale: locale, scope: scope, cascade: { skip_root: false },
+                           **options.symbolize_keys)
+      if result
+        result = I18n::Backend::Simple.new.send(:interpolate, I18n.locale, result,
+                                                options.symbolize_keys)
+      end
+    end
+
+    result
+  end
+  alias t translate
+end
+
+Liquid::Template.register_filter(TranslateFilter)

data/lib/liquidum/liquid/filters/where_exp_filter.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhereExpFilter
+  # Filters an array of objects against an expression
+  #
+  # input - the object array
+  # variable - the variable to assign each item to in the expression
+  # expression - a Liquid comparison expression passed in as a string
+  #
+  # Returns the filtered array of objects
+  def where_exp(input, variable, expression)
+    return input unless input.respond_to?(:select)
+
+    input = input.values if input.is_a?(Hash) # FIXME
+
+    condition = parse_condition(expression)
+    @context.stack do
+      input.select do |object|
+        @context[variable] = object
+        condition.evaluate(@context)
+      end
+    end || []
+  end
+
+  private
+
+  # Parse a string to a Liquid Condition
+  def parse_condition(exp)
+    parser    = Liquid::Parser.new(exp)
+    condition = parse_binary_comparison(parser)
+
+    parser.consume(:end_of_string)
+    condition
+  end
+
+  # Generate a Liquid::Condition object from a Liquid::Parser object additionally processing
+    # the parsed expression based on whether the expression consists of binary operations with
+    # Liquid operators `and` or `or`
+    #
+    #  - parser: an instance of Liquid::Parser
+    #
+    # Returns an instance of Liquid::Condition
+    def parse_binary_comparison(parser)
+      parse_comparison(parser).tap do |condition|
+        binary_operator = parser.id?("and") || parser.id?("or")
+        condition.send(binary_operator, parse_comparison(parser)) if binary_operator
+      end
+    end
+
+    # Generates a Liquid::Condition object from a Liquid::Parser object based on whether the parsed
+    # expression involves a "comparison" operator (e.g. <, ==, >, !=, etc)
+    #
+    #  - parser: an instance of Liquid::Parser
+    #
+    # Returns an instance of Liquid::Condition
+    def parse_comparison(parser)
+      left_operand = Liquid::Expression.parse(parser.expression)
+      operator     = parser.consume?(:comparison)
+
+      # No comparison-operator detected. Initialize a Liquid::Condition using only left operand
+      return Liquid::Condition.new(left_operand) unless operator
+
+      # Parse what remained after extracting the left operand and the `:comparison` operator
+      # and initialize a Liquid::Condition object using the operands and the comparison-operator
+      Liquid::Condition.new(left_operand, operator, Liquid::Expression.parse(parser.expression))
+    end
+
+end
+
+Liquid::Template.register_filter(WhereExpFilter)