page_structured_data 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e3bee4a3a39d57eeef14f3ccbb3aef73c65466cc98cb46780e7189bf5c6a06cc
4
+ data.tar.gz: 444f2453d3220a8b11e2eba2abe911827f7f0ec700dd8abd1a316a3907e0634b
5
+ SHA512:
6
+ metadata.gz: f20d8e02bf392254eb1854502b472ede713eac0318728b3841f5ac162b92d692508c6b60e242601d8b3bc9c3db2874ec5ccdc55f59ea557eed2d2133d63d6f33
7
+ data.tar.gz: 7eea77d8bd1b9dc006e4d038f892706ddba2dc9d8e1dbfabab342bbff0bc70d61c00a2f212571599a26d40a10468b5823c894a49a0cb41e6c3b3b4f1ffa7f74a
data/.gitignore ADDED
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+
13
+ # IDE
14
+ .idea
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,10 @@
1
+ Style/StringLiterals:
2
+ Enabled: true
3
+ EnforcedStyle: double_quotes
4
+
5
+ Style/StringLiteralsInInterpolation:
6
+ Enabled: true
7
+ EnforcedStyle: double_quotes
8
+
9
+ Layout/LineLength:
10
+ Max: 120
@@ -0,0 +1,84 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6
+
7
+ We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8
+
9
+ ## Our Standards
10
+
11
+ Examples of behavior that contributes to a positive environment for our community include:
12
+
13
+ * Demonstrating empathy and kindness toward other people
14
+ * Being respectful of differing opinions, viewpoints, and experiences
15
+ * Giving and gracefully accepting constructive feedback
16
+ * Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17
+ * Focusing on what is best not just for us as individuals, but for the overall community
18
+
19
+ Examples of unacceptable behavior include:
20
+
21
+ * The use of sexualized language or imagery, and sexual attention or
22
+ advances of any kind
23
+ * Trolling, insulting or derogatory comments, and personal or political attacks
24
+ * Public or private harassment
25
+ * Publishing others' private information, such as a physical or email
26
+ address, without their explicit permission
27
+ * Other conduct which could reasonably be considered inappropriate in a
28
+ professional setting
29
+
30
+ ## Enforcement Responsibilities
31
+
32
+ Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
33
+
34
+ Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
35
+
36
+ ## Scope
37
+
38
+ This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
39
+
40
+ ## Enforcement
41
+
42
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at 485345+jeygeethan@users.noreply.github.com. All complaints will be reviewed and investigated promptly and fairly.
43
+
44
+ All community leaders are obligated to respect the privacy and security of the reporter of any incident.
45
+
46
+ ## Enforcement Guidelines
47
+
48
+ Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
49
+
50
+ ### 1. Correction
51
+
52
+ **Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
53
+
54
+ **Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
55
+
56
+ ### 2. Warning
57
+
58
+ **Community Impact**: A violation through a single incident or series of actions.
59
+
60
+ **Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
61
+
62
+ ### 3. Temporary Ban
63
+
64
+ **Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
65
+
66
+ **Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
67
+
68
+ ### 4. Permanent Ban
69
+
70
+ **Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
71
+
72
+ **Consequence**: A permanent ban from any sort of public interaction within the community.
73
+
74
+ ## Attribution
75
+
76
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77
+ available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
78
+
79
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
80
+
81
+ [homepage]: https://www.contributor-covenant.org
82
+
83
+ For answers to common questions about this code of conduct, see the FAQ at
84
+ https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
data/Gemfile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ source "https://rubygems.org"
4
+
5
+ # Specify your gem's dependencies in page_structured_data.gemspec
6
+ gemspec
7
+
8
+ gem "rake", "~> 13.0"
9
+
10
+ gem "rspec", "~> 3.0"
11
+
12
+ gem "rubocop", "~> 0.80"
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2023 Jey Geethan
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,43 @@
1
+ # PageStructuredData
2
+
3
+ Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/page_structured_data`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'page_structured_data'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle install
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install page_structured_data
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/page_structured_data. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/page_structured_data/blob/master/CODE_OF_CONDUCT.md).
36
+
37
+ ## License
38
+
39
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
40
+
41
+ ## Code of Conduct
42
+
43
+ Everyone interacting in the PageStructuredData project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/page_structured_data/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
data/bin/console ADDED
@@ -0,0 +1,15 @@
1
+ #!/usr/bin/env ruby
2
+ # frozen_string_literal: true
3
+
4
+ require "bundler/setup"
5
+ require "page_structured_data"
6
+
7
+ # You can add fixtures and/or initialization code here to make experimenting
8
+ # with your gem easier. You can also use a different console, if you like.
9
+
10
+ # (If you use this, don't forget to add pry to your Gemfile!)
11
+ # require "pry"
12
+ # Pry.start
13
+
14
+ require "irb"
15
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PageStructuredData
4
+ # Basic page metadata for any page
5
+ class Anchors
6
+ attr_reader :anchors
7
+
8
+ def initialize(anchors:)
9
+ @anchors = anchors
10
+ end
11
+
12
+ def titles
13
+ anchors.keys
14
+ end
15
+
16
+ def anchor_for(title)
17
+ "##{anchors[title]}"
18
+ end
19
+ end
20
+ end
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PageStructuredData
4
+ # Basic page metadata for any page
5
+ class Breadcrumbs
6
+ attr_reader :hierarchy
7
+
8
+ def initialize(hierarchy: [])
9
+ @hierarchy = hierarchy
10
+ end
11
+
12
+ def titles
13
+ hierarchy.pluck(:title)
14
+ end
15
+
16
+ def json_ld(current_page_title:) # rubocop:disable Metrics/MethodLength
17
+ node = {
18
+ '@context': 'https://schema.org',
19
+ '@type': 'BreadcrumbList',
20
+ itemListElement: [],
21
+ }
22
+
23
+ items = []
24
+ count = 0
25
+ @hierarchy.each do |page|
26
+ items << {
27
+ '@type': 'ListItem',
28
+ position: (count += 1),
29
+ name: page[:title],
30
+ item: page[:href],
31
+ }
32
+ end
33
+
34
+ items << {
35
+ '@type': 'ListItem',
36
+ position: (count += 1),
37
+ name: current_page_title,
38
+ }
39
+
40
+ node['itemListElement'] = items
41
+
42
+ %(
43
+ <script type="application/ld+json">
44
+ #{node.to_json}
45
+ </script>
46
+ )
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PageStructuredData
4
+ # Basic page metadata for any page
5
+ class Meta
6
+ DEFAULT_IMAGE = 'common/page_meta/meta_image.png'
7
+
8
+ attr_reader :title, :description, :image, :extra_title, :breadcrumb, :page_type
9
+
10
+ def initialize(title:, description: nil, image: nil, # rubocop:disable Metrics/ParameterLists
11
+ extra_title: '', breadcrumb: nil, page_type: nil)
12
+ @title = title
13
+ @description = description
14
+ @image = image
15
+ @extra_title = extra_title
16
+ @breadcrumb = breadcrumb
17
+ @page_type = page_type
18
+
19
+ @breadcrumb = PageBreadcrumbs.new if breadcrumb.blank?
20
+ end
21
+
22
+ def title_with_hierarchies
23
+ current_page = extra_title.present? ? [title, extra_title] : [title]
24
+ current_page += breadcrumb.titles.reverse if breadcrumb.present?
25
+ current_page
26
+ end
27
+
28
+ def page_title
29
+ title_with_hierarchies.join(separator) + separator + base_company_name
30
+ end
31
+
32
+ def json_lds
33
+ output = []
34
+ output << breadcrumb.json_ld(current_page_title: title) if breadcrumb.present?
35
+ output << page_type.json_ld if page_type.present?
36
+ output.join
37
+ end
38
+
39
+ private
40
+
41
+ def separator
42
+ ' - '
43
+ end
44
+
45
+ def base_company_name
46
+ ::Common::Constants::Constants::COMPANY_NAME
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,46 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PageStructuredData
4
+ module PageTypes
5
+ # Basic page metadata for any page
6
+ class NewsArticle
7
+ attr_reader :headline, :images, :published_at, :updated_at, :authors
8
+
9
+ def initialize(headline:, published_at:, updated_at:, images: [], authors: [])
10
+ @headline = headline
11
+ @images = images
12
+ @published_at = published_at
13
+ @updated_at = updated_at
14
+ @authors = authors
15
+ end
16
+
17
+ def json_ld # rubocop:disable Metrics/MethodLength
18
+ node = {
19
+ '@context': 'https://schema.org',
20
+ '@type': 'NewsArticle',
21
+ }
22
+
23
+ node[:headline] = headline
24
+ node[:image] = images
25
+ node[:datePublished] = published_at
26
+ node[:dateModified] = updated_at
27
+
28
+ author_hash = authors.map do |author|
29
+ {
30
+ '@type': 'Person',
31
+ name: author[:name],
32
+ url: author[:url],
33
+ }
34
+ end
35
+
36
+ node[:author] = author_hash
37
+
38
+ %(
39
+ <script type="application/ld+json">
40
+ #{node.to_json}
41
+ </script>
42
+ )
43
+ end
44
+ end
45
+ end
46
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module PageStructuredData
4
+ VERSION = "0.1.0"
5
+ end
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "page_structured_data/version"
4
+ require_relative 'page_structured_data/anchors'
5
+ require_relative 'page_structured_data/breadcrumbs'
6
+ require_relative 'page_structured_data/meta'
7
+ require_relative 'page_structured_data/page_types/news_article'
8
+
9
+ module PageStructuredData
10
+ class Error < StandardError; end
11
+ # Your code goes here...
12
+ end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative "lib/page_structured_data/version"
4
+
5
+ Gem::Specification.new do |spec|
6
+ spec.name = "page_structured_data"
7
+ spec.version = PageStructuredData::VERSION
8
+ spec.authors = ["Jey Geethan"]
9
+ spec.email = ["opensource@rocketapex.com"]
10
+
11
+ spec.summary = "Easily create meta tags with structured data for webpages"
12
+ spec.description = "Easily create meta tags with structured data for webpages"
13
+ spec.homepage = "https://github.com/RocketApex/page_structured_data"
14
+ spec.license = "MIT"
15
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
16
+
17
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
18
+
19
+ spec.metadata["homepage_uri"] = spec.homepage
20
+ spec.metadata["source_code_uri"] = "https://github.com/RocketApex/page_structured_data"
21
+ spec.metadata["changelog_uri"] = "https://github.com/RocketApex/page_structured_data"
22
+
23
+ # Specify which files should be added to the gem when it is released.
24
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
25
+ spec.files = Dir.chdir(File.expand_path(__dir__)) do
26
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
27
+ end
28
+ spec.bindir = "exe"
29
+ spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
30
+ spec.require_paths = ["lib"]
31
+
32
+ # Uncomment to register a new dependency of your gem
33
+ # spec.add_dependency "example-gem", "~> 1.0"
34
+
35
+ # For more information and examples about making a new gem, checkout our
36
+ # guide at: https://bundler.io/guides/creating_gem.html
37
+ end
metadata ADDED
@@ -0,0 +1,64 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: page_structured_data
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Jey Geethan
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2023-10-16 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: Easily create meta tags with structured data for webpages
14
+ email:
15
+ - opensource@rocketapex.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - ".gitignore"
21
+ - ".rspec"
22
+ - ".rubocop.yml"
23
+ - CODE_OF_CONDUCT.md
24
+ - Gemfile
25
+ - LICENSE.txt
26
+ - README.md
27
+ - Rakefile
28
+ - bin/console
29
+ - bin/setup
30
+ - lib/page_structured_data.rb
31
+ - lib/page_structured_data/anchors.rb
32
+ - lib/page_structured_data/breadcrumbs.rb
33
+ - lib/page_structured_data/meta.rb
34
+ - lib/page_structured_data/page_types/news_article.rb
35
+ - lib/page_structured_data/version.rb
36
+ - page_structured_data.gemspec
37
+ homepage: https://github.com/RocketApex/page_structured_data
38
+ licenses:
39
+ - MIT
40
+ metadata:
41
+ allowed_push_host: https://rubygems.org
42
+ homepage_uri: https://github.com/RocketApex/page_structured_data
43
+ source_code_uri: https://github.com/RocketApex/page_structured_data
44
+ changelog_uri: https://github.com/RocketApex/page_structured_data
45
+ post_install_message:
46
+ rdoc_options: []
47
+ require_paths:
48
+ - lib
49
+ required_ruby_version: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: 2.3.0
54
+ required_rubygems_version: !ruby/object:Gem::Requirement
55
+ requirements:
56
+ - - ">="
57
+ - !ruby/object:Gem::Version
58
+ version: '0'
59
+ requirements: []
60
+ rubygems_version: 3.2.3
61
+ signing_key:
62
+ specification_version: 4
63
+ summary: Easily create meta tags with structured data for webpages
64
+ test_files: []