card-mod-social 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3312df5902b40340dc9e170e7d5d48e5b34997bce87231921af24fba4a8748e7
+  data.tar.gz: 9400b86935eea5b5f162422dc053aeca9710116bc618a66db0c5b6faffed0fa8
+SHA512:
+  metadata.gz: 5a0f309b75cb71ef75227df2dacb3bdb7e2c8eaa1d6fdf78509e6780ca9b75bbae853d541b4538b291b497c0f8b6a0bab106c6bd99c19f0b703afb1ef16d26b6
+  data.tar.gz: 3e5731468e345276b37faa7b847b6b29778949c3cb397ecc4ec2018e5eb2252e456b96127da48a82150fc24e0925423d8f40238ba2413ed97dadafa3238e1e43

data/README.md

@@ -0,0 +1,35 @@
+<!--
+# @title README - mod: social
+-->
+
+# Social mod
+
+This mod adds Twitter and OpenGraph meta tags to decko cards.
+
+## Tags shared by both
+
+Both OpenGraph and Twitter support `description` and `image` fields.
+
+- The __description__ is handled by the `#social_description` method, which can be
+  overwritten in any set. By default it renders the `:text_without_nests` view (in the
+  Text format) of the `+:description` card (which itself can be overwrtten using
+  the `#social_description_card` method.
+- The __image__ is handled by the `#social_image` method, which can be overwritten in any
+  set. By default it renders the `:source` view of the `+:image` card (which itself can be
+  overwrtten using the `#social_image_card` method.
+
+If you want different content for the two, you can override `#og_description`, 
+`#og_image`, `#twitter_description`, and/or `#twitter_image`.
+
+## Open Graph tags
+
+The following additional OpenGraph meta tags are also generated (and overridable):
+
+- __#og_url__: by default the card's url with no extension
+- __#og_site_name__: by default the content of the `:title` card
+- __#og_type__: defaults to "article"
+- __#og_title__: defaults to the card name
+
+## Twitter tags
+
+This mod also adds an overridable __#twitter_card__ meta tag that defaults to "summary".

data/set/all/social_meta.rb

@@ -0,0 +1,92 @@
+format :text do
+  def text_description
+    truncate render_text_without_nests.strip, length: 200, separator: " "
+  end
+end
+
+format :html do
+  def views_in_head
+    super << :social_meta_tags
+  end
+
+  view :social_meta_tags do
+    return unless card.known?
+
+    shared = %w[title description image]
+    meta_tags_for(:og, shared + %w[url site_name type]) +
+      meta_tags_for(:twitter, shared + %w[card site creator])
+  end
+
+  # OPEN GRAPH
+
+  def og_url
+    card_url card.name.url_key
+  end
+
+  def og_site_name
+    Card[:title]&.content
+  end
+
+  def og_type
+    "article"
+  end
+
+  def og_title
+    card.name
+  end
+
+  def og_description
+    social_description
+  end
+
+  def og_image
+    social_image
+  end
+
+  # TWITTER CARDS
+
+  def twitter_card
+    "summary"
+  end
+
+  def twitter_description
+    social_description
+  end
+
+  def twitter_image
+    social_image
+  end
+
+  # SHARED
+
+  # NOTE: not cache safe
+  def social_description
+    @social_description ||= social_description_card&.format(:text)&.text_description
+  end
+
+  # NOTE: not cache safe
+  def social_image
+    @social_image ||= social_image_card&.format(:text)&.render_source
+  end
+
+  def social_image_card
+    try(:image_card) || card.fetch(:image) || Card[:logo]
+  end
+
+  def social_description_card
+    card.fetch(:description) || card
+  end
+
+  private
+
+  def meta_tags_for prefix, properties
+    properties.map do |property|
+      next unless (content = try "#{prefix}_#{property}")
+      meta_tag "#{prefix}:#{property}", content
+    end.compact
+  end
+
+  def meta_tag property, content
+    %{<meta name="#{property}" content="#{content}">}
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: card-mod-social
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Philipp Kühl
+- Ethan McCutchen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: card
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- info@decko.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- set/all/social_meta.rb
+homepage: http://decko.org
+licenses:
+- GPL-3.0
+metadata:
+  card-mod: social
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.28
+signing_key:
+specification_version: 4
+summary: Social media markup for decko
+test_files: []