page_structured_data 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ae9b454e36210166cdf451555fe65a2ea3bb2f25b64e5cb37fd06c70c067981
-  data.tar.gz: 84e43ef5f28b1a1d006b0eb1154de023fce87e6c861feba45f4fd765206d668f
+  metadata.gz: 58a0137257224be05f4cd4812b8a95e02a52ef8024f9a32a7a35bfdf7d918175
+  data.tar.gz: fb4e545f1641f039264ee60e528ed358ca76ed54315580d5880fc9f3facca519
 SHA512:
-  metadata.gz: 67cc94556edb321670382bf6216634fc57651d230582ef6f7d5b8d5aa33e1a1940444d4667d25c69e444813a6c13e57ac1232a6f441db49defff84b7fa6d6751
-  data.tar.gz: a41d5847de2b57430b87772c1e386ac16e20a8feecb7fb06180cc72de13e134d158856257984ae4f32201320c2f657bc5b05c2a1d0b60f4112ac563c7a62569e
+  metadata.gz: 72d650e297af061d95bba42ef0760f03c1665897fe33f545cbbf3e29ff2b827d2c900216a4819217504ceb6b2e3b871be2ac670890cfb5f7fb4434e6d33c72ad
+  data.tar.gz: ae13d9256f20f5cc6b92e41633a404b226303215be1a459c360289f903f33d59ff22a4d20c4f4e73d52b4f52d79a4b1c9d875d0980216608a20cf8b774c031ca

data/README.md

@@ -1,8 +1,10 @@
 # PageStructuredData
-Short description and motivation.
-
-## Usage
-How to use my plugin.
+Use this gem to churn out meta tags for your rails webpages. This also renders meta tags for the following:
+1. Page `<title>` tag with proper hyphenation when used with breadcrumbs
+2. Basic `<meta>` tags
+2. Twitter meta tags
+3. Open graph meta tags
+4. Google Schema JSON-LD `<script>` tags
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -21,8 +23,81 @@ Or install it yourself as:
 $ gem install page_structured_data
 ```
 
+## Usage
+
+### Layouts
+
+Add the following in your layout to include the basic meta tags by default
+
+```erbruby
+<%= render 'page_structured_data/meta_tags', page: @page_meta, 
+    default_image_url: image_url('<path_to_default_image>') %>
+```
+
+Note: This doesn't include csrf or any other security or viewport related meta tags.
+
+### Views
+
+In your views, please define the `@page_meta` as follows
+
+```ruby
+<% @page_meta = PageStructuredData::Page.new(title: 'Home', extra_title: "Official Page",
+        description: 'Welcome to my Page') %>
+```
+
+The instance variable will be used in the layout to create proper meta tags. Most attributes are self explanatory. `extra_title` is used to append to the title. 
+
+### Config
+
+Configure the application wide settings as follows:
+
+```erbruby
+# config/initializers/page_structured_data.rb
+Rails.application.config.after_initialize do
+  PageStructuredData.config do |config|
+    config.base_app_name = 'AwesomestApp' # or use any application constant as this is called after_initialize
+  end
+end
+```
+
+### Breadcrumbs
+
+Create a list of breadcrumbs like this:
+
+```erbruby
+<% breadcrumb = PageStructuredData::Breadcrumbs.new(hierarchy: [{ title: 'Resources', href: resources_url }, { title: 'Articles', href: resources_articles_url }]) %>
+```
+
+And include it in the `Page.new` as:
+
+```erbruby
+<% @page_meta = PageStructuredData::Page.new(title: 'Home', extra_title: "Official Page",
+        description: 'Welcome to my Page', breadcrumb: breadcrumb) %>
+```
+
+This will create a JSON+LD breadcrumbs similar to [Breadcrumbs](https://developers.google.com/search/docs/appearance/structured-data/breadcrumb)
+
+### PageTypes
+
+Currently this gem supports the following page types:
+
+* [BlogPosting](https://schema.org/BlogPosting)
+* [NewsArticle](https://schema.org/NewsArticle)
+
+To use these, it is similar to breadcrumbs: include them in `Page.new` and it the json+ld will be automatically included.
+
+```erbruby
+<% article_page_type = PageStructuredData::PageTypes::BlogPosting.new(headline: @article.title, published_at: @article.published_at,
+        updated_at: @article.updated_at, authors: [name: @article.authors.first.name, url: @article.authors.first.website],
+        images: [main_app.url_for(@article.cover_image.variant(:standard))]) %>
+<% @page_meta = PageStructuredData::Page.new(title: 'Home', extra_title: "Official Page",
+                                             description: 'Welcome to my Page', page_type: article_page_type) %>
+```
+
+Just replace BlogPosting class with the other type for other page types.
+
 ## Contributing
-Contribution directions go here.
+Please raise a PR to be validated and merged.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/src/page_structured_data/page.rb

@@ -38,10 +38,6 @@ module PageStructuredData
       output.join
     end
 
-    def default_image_url
-      PageStructuredData.default_image_url
-    end
-
     private
 
     def base_app_name

data/app/views/page_structured_data/_meta_tags.html.slim

@@ -1,10 +1,8 @@
+- default_image_url = local_assigns[:default_image_url]
+
 - title = page&.page_title
 - description = page&.description
-- image = page&.image
-- if page&.image.present?
-  - image = page.image
-- else
-  - image = page.default_image_url
+- image = page&.image || default_image_url || nil
 
 title = title
 

data/lib/page_structured_data/version.rb

@@ -1,3 +1,3 @@
 module PageStructuredData
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/page_structured_data.rb

@@ -3,7 +3,7 @@ require "page_structured_data/engine"
 
 module PageStructuredData
   class << self
-    attr_accessor :default_image_url, :base_app_name
+    attr_accessor :base_app_name
 
     def config
       yield self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: page_structured_data
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Jey Geethan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2023-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails