flayyer_liquid 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 82818a255a2b36fa7fc664a360ae24b34cf18d91ee8757265f46c433d4366cea
+  data.tar.gz: c21f496baa89ee9d7f35601b7fa15c2a32a136844ab56b26df42a1652a122532
+SHA512:
+  metadata.gz: 215c4b850f1d2cfb620a05f270c26eb5fb934b23c6b29efa48b7a79dff898420a99bffdabe15bcfc0a8fda1783e0f79e7eef79d6854ac187c55210d240bfe083
+  data.tar.gz: 43bc5a6436c19622acb2fc81b23b9a838006fb4ff868b8fe140b04d6de4009cdcfb46f62911d296a0f4eaf8c922d461544fe851341ca4d1a64673828051bc11d

data/.gitignore

@@ -0,0 +1,147 @@
+# Custom
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Created by https://www.toptal.com/developers/gitignore/api/ruby,osx,windows,linux
+# Edit at https://www.toptal.com/developers/gitignore?templates=ruby,osx,windows,linux
+
+### Linux ###
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+
+### OSX ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Ruby Patch ###
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+# End of https://www.toptal.com/developers/gitignore/api/ruby,osx,windows,linux

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flayyer.gemspec
+gemspec
+
+gem 'liquid' # peer dependency
+gem 'flayyer', '~> 1.0.0'
+
+gem 'rake', '~> 12.0'
+group :test do
+  gem 'rspec', '~> 3.0'
+end

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    flayyer_liquid (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    flayyer (1.0.0)
+    liquid (4.0.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  flayyer (~> 1.0.0)
+  flayyer_liquid!
+  liquid
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Patricio López Juri
+
+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,215 @@
+# flayyer-ruby-liquid (flayyer_liquid)
+
+This gem is agnostic to any Ruby framework and is meant to be used alongside [shopify/liquid](https://github.com/Shopify/liquid).
+
+To create a FLAYYER template please refer to: [flayyer.com](https://flayyer.com?ref=flayyer-ruby-liquid)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flayyer'
+gem 'flayyer_liquid'
+```
+
+And then execute:
+
+```sh
+bundle install
+```
+
+Or install it yourself as:
+
+```sh
+gem install flayyer flayyer_liquid
+```
+
+## Usage
+
+After installing the gem you need to register our custom tag to render Flayyer urls. You can do this on any file you are setting up liquid or any config files that executes when starting up the application.
+
+```ruby
+require 'flayyer_liquid'
+
+Liquid::Template.register_tag('flayyer', FlayyerLiquid::FlayyerTag)
+```
+
+Just for reference, the programmatic usage is:
+
+```ruby
+# Register tag
+Liquid::Template.register_tag('flayyer', FlayyerLiquid::FlayyerTag)
+
+# Set defaults
+template = Liquid::Template.parse("{% flayyer tenant: 'tenant', deck: 'my-deck', template: 'post' %}")
+
+# Set variables and also you can override defaults by prefixing liquid variables with `flayyer_`
+url = template.render('flayyer_variables' => { title: 'Hello world!' })
+url = template.render({ 'flayyer_variables' => { title: 'Hello world!' }, 'flayyer_template' => 'gallery', 'flayyer_extension' => 'png' })
+```
+
+For convenience, adicional variables passed to `{% flayyer ... %}` tag will be treated as Flayyer variables. This is useful if your Flayyer template has a title variable, here is an example:
+
+```ruby
+template = Liquid::Template.parse(
+  "{% flayyer tenant: 't', deck: 'd', template: 'post', title: 'My Post' %}"
+)
+```
+
+This works with Liquid variables:
+
+```ruby
+template = Liquid::Template.parse(
+  "{% flayyer tenant: 't', deck: 'd', template: 'post', title: '{{ post.title }}' %}"
+)
+url = template.render('post' => { title: 'My Post' })
+```
+
+### Use quotes around Liquid variables
+
+Prevent this common mistake:
+
+```ruby
+# This is wrong ❌
+{% flayyer title: {{ post.title }} %}
+```
+
+```ruby
+# This is correct ✅
+{% flayyer title: '{{ post.title }}' %}
+```
+
+**IMPORTANT: variables must be serializable.**
+
+## Liquid templates
+
+Here is an example:
+
+```html
+<head>
+  <meta
+    property="og:image"
+    content="{% flayyer tenant: 't', deck: 'd', template: 'product', title: '{{ product.title }}', description: '{{ product.description }}' %}"
+  >
+</head>
+```
+
+## Shopify Integration
+
+> Based on https://shopify.github.io/liquid-code-examples/example/open-graph-tags
+
+Feel free to change images sizes from the filter [`img_url`](https://shopify.dev/docs/themes/liquid/reference/filters/url-filters) depending of how your Flayyer templates renders each type of preview.
+
+```html
+{%- assign og_title = page_title -%}
+{%- assign og_url = canonical_url -%}
+{%- assign og_type = 'website' -%}
+{%- assign og_description = page_description | default: shop.description | default: shop.name -%}
+
+{%- if settings.share_image -%}
+  {%- capture og_image_tags -%}
+    <--! FLAYYER integration starts -->
+    {%- assign original_image = settings.share_image | img_url: '1200x630' -%}
+    <meta
+      property="og:image"
+      content="{% flayyer tenant: 'tenant', deck: 'deck', template: 'main', title: '{{ og_title }}', image: '{{ original_image }}' %}"
+    >
+    <--! FLAYYER integration ends -->
+  {%- endcapture -%}
+{%- endif -%}
+
+{%- case template.name -%}
+  {%- when 'product' -%}
+    {%- assign og_title = product.title | strip_html -%}
+    {%- assign og_type = 'product' -%}
+
+    {%- if product.images.size > 0 -%}
+      {%- capture og_image_tags -%}
+        {%- for image in product.images limit:3 -%}
+          <--! FLAYYER integration starts -->
+          {%- assign original_image = image.src | product_img_url: '800x800' -%}
+          <meta
+            property="og:image"
+            content="{% flayyer tenant: 'tenant', deck: 'deck', template: 'main', title: '{{ og_title }}', image: '{{ original_image }}' %}"
+          >
+          <--! FLAYYER integration ends -->
+        {%- endfor -%}
+      {%- endcapture -%}
+    {%- endif -%}
+
+  {%- when 'article' -%}
+    {%- assign og_title = article.title | strip_html -%}
+    {%- assign og_type = 'article' -%}
+    {%- assign og_description = article.excerpt_or_content | strip_html -%}
+
+    {%- if article.image -%}
+      {%- capture og_image_tags -%}
+        <--! FLAYYER integration starts -->
+        {%- assign original_image = article.src | product_img_url: '800x800' -%}
+        <meta
+          property="og:image"
+          content="{% flayyer tenant: 'tenant', deck: 'deck', template: 'main', title: '{{ og_title }}', description: '{{ og_description }}', image: '{{ original_image }}' %}"
+        >
+        <--! FLAYYER integration ends -->
+      {%- endcapture -%}
+    {%- endif -%}
+
+  {%- when 'collection' -%}
+    {%- assign og_title = collection.title | strip_html -%}
+    {%- assign og_type = 'product.group' -%}
+
+    {%- if collection.image -%}
+      {%- capture og_image_tags -%}
+        <--! FLAYYER integration starts -->
+        {%- assign original_image = collection.src | product_img_url: '800x800' -%}
+        <meta
+          property="og:image"
+          content="{% flayyer tenant: 'tenant', deck: 'deck', template: 'main', title: '{{ og_title }}', image: '{{ original_image }}' %}"
+        >
+        <--! FLAYYER integration ends -->
+      {%- endcapture -%}
+    {%- endif -%}
+
+  {%- when 'password' -%}
+    {%- assign og_title = shop.name -%}
+    {%- assign og_url = shop.url -%}
+    {%- assign og_description = shop.description | default: shop.name -%}
+
+{%- endcase -%}
+
+<meta property="og:site_name" content="{{ shop.name }}">
+<meta property="og:url" content="{{ og_url }}">
+<meta property="og:title" content="{{ og_title }}">
+<meta property="og:type" content="{{ og_type }}">
+<meta property="og:description" content="{{ og_description }}">
+
+{%- if template.name == 'product' -%}
+  <meta property="og:price:amount" content="{{ product.price | money_without_currency | strip_html }}">
+  <meta property="og:price:currency" content="{{ shop.currency }}">
+{%- endif -%}
+
+{{ og_image_tags }}
+
+{%- unless settings.social_twitter_link == blank -%}
+  <meta name="twitter:site" content="{{ settings.social_twitter_link | split: 'twitter.com/' | last | prepend: '@' }}">
+{%- endunless -%}
+
+<meta name="twitter:card" content="summary_large_image">
+<meta name="twitter:title" content="{{ og_title }}">
+<meta name="twitter:description" content="{{ og_description }}">
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/flayyer/flayyer-ruby-liquid.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flayyer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flayyer_liquid.gemspec

@@ -0,0 +1,31 @@
+require_relative 'lib/flayyer_liquid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flayyer_liquid'
+  spec.version       = FlayyerLiquid::VERSION
+  spec.authors       = ['Patricio López Juri']
+  spec.email         = ['patricio@flayyer.com']
+
+  spec.summary       = 'FLAYYER.com helper classes and methods'
+  # spec.summary       = %q{TODO: Write a short summary, because RubyGems requires one.}
+  spec.description   = 'FLAYYER.com helper classes and methods'
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/flayyer/flayyer-ruby-liquid'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # spec.metadata['allowed_push_host'] = 'TODO: Set to 'http://mygemserver.com''
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/flayyer/flayyer-ruby-liquid'
+  spec.metadata['changelog_uri'] = 'https://github.com/flayyer/flayyer-ruby-liquid'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

data/lib/flayyer_liquid.rb

@@ -0,0 +1,60 @@
+require 'flayyer_liquid/version'
+require 'flayyer'
+require 'liquid'
+
+module FlayyerLiquid
+  class Error < StandardError; end
+
+  class FlayyerTag < Liquid::Tag
+    attr_accessor :params
+    attr_accessor :version, :tenant, :deck, :template, :extension, :variables
+
+    def initialize(tag_name, params, tokens)
+      super
+      @params = params
+    end
+
+    def render(context)
+      @variables = {}
+      @version = '_' # latest
+      @extension = 'jpeg'
+
+      # Pre-render values enclosed in {{ }}
+      params = Liquid::Template.parse(@params).render(context)
+
+      # TODO: Since 2015 there is no official way of passing multiple args
+      params.scan(Liquid::TagAttributes) do |key, value|
+        value = value.gsub(/^'|"/, '').gsub(/'|"$/, '')
+        case key
+        when 'tenant'
+          @tenant = value
+        when 'deck'
+          @deck = value
+        when 'template'
+          @template = value
+        when 'version'
+          @version = value
+        when 'extension'
+          @extension = value
+        else
+          @variables[key] = value
+        end
+      end
+
+      flayyer = Flayyer::FlayyerURL.create do |f|
+        f.tenant = context['flayyer_tenant'].nil? || context['flayyer_tenant'].empty? ? @tenant : context['flayyer_tenant']
+        f.deck = context['flayyer_deck'].nil? || context['flayyer_deck'].empty? ? @deck : context['flayyer_deck']
+        f.template = context['flayyer_template'].nil? || context['flayyer_template'].empty? ? @template : context['flayyer_template']
+        f.variables = context['flayyer_variables'].nil? || context['flayyer_variables'].empty? ? @variables : context['flayyer_variables']
+        f.version = context['flayyer_version'].nil? || context['flayyer_version'].empty? ? @version : context['flayyer_version']
+        f.extension = context['flayyer_extension'].nil? || context['flayyer_extension'].empty? ? @extension : context['flayyer_extension']
+      end
+
+      begin
+        return flayyer.href
+      rescue Flayyer::Error # missing tenant, deck or template
+        return ''
+      end
+    end
+  end
+end

data/lib/flayyer_liquid/version.rb

@@ -0,0 +1,3 @@
+module FlayyerLiquid
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: flayyer_liquid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Patricio López Juri
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-08-23 00:00:00.000000000 Z
+dependencies: []
+description: FLAYYER.com helper classes and methods
+email:
+- patricio@flayyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- flayyer_liquid.gemspec
+- lib/flayyer_liquid.rb
+- lib/flayyer_liquid/version.rb
+homepage: https://github.com/flayyer/flayyer-ruby-liquid
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/flayyer/flayyer-ruby-liquid
+  source_code_uri: https://github.com/flayyer/flayyer-ruby-liquid
+  changelog_uri: https://github.com/flayyer/flayyer-ruby-liquid
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.6.2
+signing_key:
+specification_version: 4
+summary: FLAYYER.com helper classes and methods
+test_files: []