m3ta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4bbd235e15bc17fd75e90fb5dd6b91f9ec6ff3344d6e264d973cc17c8b6f67d0
+  data.tar.gz: 3b6b16f0a2ba3d099296b86b71ff893577c33523824e686f81bf4e6ae6a7821c
+SHA512:
+  metadata.gz: ddf382e94a722791cb16da70c8452d0446442fcf0de8fde9e296db6287e89257125edc13ad33c070c66b9d93b35591e3585fca57b561fef0e4e45d080801b9cd
+  data.tar.gz: bd0842ae695601fdaf5578a51b1c5c3976333e52990977ed773aeb52f34584242bb4f10831cea4271966f947740cb56e33c4a5ae042b201fb7436b8ebbe01e8d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 
+
+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,94 @@
+# M3ta
+
+Writing meta tags can be awkward. M3ta attempts to make light work of configuring defaults that are reused on every page and giving as much flexibility as possible to append and modify those defaults on each request whether it is in a controller or view.
+
+## Installation
+
+Add it to this line to your application's Gemfile:
+
+```ruby
+gem "m3ta"
+```
+
+And then execute:
+```bash
+bundle install
+```
+
+## Usage
+
+Meta tags can be configured in multiple different ways. You can set defaults in to ways
+
+
+Via an initializer
+
+```ruby
+M3ta.defaults do |b|
+  b.title = 'Some blog post'
+  b.image =  'https://robl.me/braindeaf.png'
+end
+```
+
+Via I18n locales
+
+```yaml
+en:
+  m3ta:
+    site_name: RobL Vs...
+    description: I write thems code
+```
+
+Each request has access to a *m3ta::Builder* object to append data to.
+
+* Controllers
+
+```ruby
+class ApplicationController < ActionController::Base
+  m3ta do |b|
+    b.title = 'A better title'
+    b.description = %(...and then it will be over and that'll be alright with me...)
+  end
+end
+```
+
+```ruby
+class ProjectsController < ApplicationController
+  m3ta do |b|
+    b.title = 'Sometimes dead is better'
+  end
+end
+```
+
+* Views
+
+```ruby
+:ruby
+  m3ta.tap do |b|
+    b.title = %(Thundercats are better than Gobots)
+    b.description = "#{b.description} - J.R. Hayes"
+
+```
+
+```ruby
+<%=
+  m3ta.tap do |b|
+    b.title = %(Thundercats are better than Gobots)
+    b.description = "#{b.description} - J.R. Hayes"
+  end
+%>
+```
+
+Finally you can render your Meta Tags with a single helper in the application layout
+
+```ruby
+!!!
+  %head
+    = m3ta_tags
+  %body
+```
+
+## Contributing
+If you wish to contribute please feel free to fork the repo and submit a PR.
+
+## 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,5 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'

data/lib/m3ta/builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'hashie'
+
+module M3ta
+  class Builder < Hashie::Dash
+    # Core
+    property :site_name
+    property :type
+    property :title
+    property :description
+    property :url
+    property :image
+    property :keywords
+    property :player
+    property :video
+
+    # Social
+    property :facebook_app_id
+    property :twitter_handle
+
+    def apply(attributes = {}, &block)
+      merge!(attributes)
+      block.call(self) if block_given?
+      self
+    end
+  end
+end

data/lib/m3ta/controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module M3ta
+  module Controller
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_m3ta, default: M3ta.defaults.clone
+
+      def self.m3ta(&block)
+        _m3ta.apply(&block)
+      end
+
+      def m3ta(&block)
+        @m3ta ||= self.class.m3ta.clone
+        @m3ta.apply(&block)
+      end
+      helper_method :m3ta
+    end
+  end
+end

data/lib/m3ta/helpers.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module M3ta
+  module Helpers
+    def meta_tags
+      [
+        meta_tag(property: 'fb:app_id', content: m3ta.fb_app_id || '1434650413476851'),
+        twitter_card,
+        meta_tag(name: 'twitter:site', content: m3ta.twitter),
+        meta_tag(name: 'twitter:creator', content: m3ta.twitter),
+        meta_tag(property: 'og:type', content: m3ta.type || 'website'),
+        meta_tag(property: 'og:site_name', content: site_name),
+        meta_tag(property: 'og:url', content: url),
+        tag(:link, rel: 'canonical', href: url),
+        title_tags,
+        description_tags,
+        player_tags,
+        image_tags,
+        video_tags,
+        keywords_tags
+      ].flatten.compact.join("\n").html_safe
+    end
+
+    def title_tags
+      [
+        content_tag(:title, m3ta.title),
+        meta_tag(name: 'title', content: m3ta.title),
+        meta_tag(property: 'og:title', content: m3ta.title),
+        meta_tag(name: 'twitter:title', content: m3ta.title)
+      ]
+    end
+
+    def twitter_card
+      card = m3ta.player.present? ? 'player' : 'summary_large_image'
+      meta_tag(name: 'twitter:card', content: card)
+    end
+
+    def player_tags
+      return unless m3ta.player.present?
+
+      [
+        meta_tag(name: 'twitter:player', content: m3ta.player),
+        meta_tag(name: 'twitter:player:width', content: '1280'),
+        meta_tag(name: 'twitter:player:height', content: '720')
+      ]
+    end
+
+    def keywords_tags
+      return unless keywords.present?
+
+      meta_tag(name: 'keywords', content: keywords)
+    end
+
+    def image_tags
+      return unless m3ta.image
+
+      [
+        meta_tag(property: 'og:image', content: m3ta.image),
+        meta_tag(name: 'twitter:image:src', content: m3ta.image)
+      ]
+    end
+
+    def video_tags
+      return unless m3ta.video
+
+      [
+        meta_tag(property: 'og:video:url', content: m3ta.video),
+        meta_tag(property: 'og:video:secure_url', content: m3ta.video),
+        meta_tag(property: 'og:video:width', content: m3ta.video_width),
+        meta_tag(property: 'og:video:height', content: m3ta.video_height),
+        meta_tag(property: 'og:video:type', content: m3ta.video_type)
+      ]
+    end
+
+    def description_tags
+      [
+        meta_tag(name: 'description', content: m3ta.description),
+        meta_tag(property: 'og:description', content: m3ta.description),
+        meta_tag(name: 'twitter:description', content: m3ta.description)
+      ]
+    end
+
+    def keywords
+      @keywords ||= Array[m3ta.keywords,
+                          I18n.t('meta.keywords', default: '')].flatten.select(&:present?).map do |section|
+        section.to_s.split(',')
+      end.flatten.select(&:present?).map(&:strip).uniq.join(', ')
+    end
+
+    def site_name
+      m3ta.site_name || t('site_name')
+    end
+
+    def url
+      (m3ta.url || request.url).split('?')[0]
+    end
+
+    def meta_tag(options = {})
+      tag(:meta, options)
+    end
+  end
+end

data/lib/m3ta/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module M3ta
+  class Railtie < ::Rails::Railtie
+    initializer 'm3ta.action_controller' do
+      ActiveSupport.on_load(:action_controller) do
+        include M3ta::Controller
+      end
+    end
+
+    initializer 'm3ta.action_view' do
+      ActiveSupport.on_load(:action_view) do
+        include M3ta::Helpers
+      end
+    end
+  end
+end

data/lib/m3ta/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module M3ta
+  VERSION = '0.1.0'
+end

data/lib/m3ta.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'm3ta/railtie'
+
+module M3ta
+  extend ActiveSupport::Autoload
+
+  autoload :Builder
+  autoload :Controller
+  autoload :Helpers
+  autoload :Version
+
+  class << self
+    def defaults(&block)
+      @defaults ||= Builder.new(I18n.translate(:m3ta, default: {}))
+      @defaults.tap { |b| b.apply(&block) if block_given? }
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: m3ta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RobL
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.4.1
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.2.1
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.17.4
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+description: Define meta tags in your Rails app in defaults, i18n locales, controllers
+  and views.
+email:
+- contact@robl.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/m3ta.rb
+- lib/m3ta/builder.rb
+- lib/m3ta/controller.rb
+- lib/m3ta/helpers.rb
+- lib/m3ta/railtie.rb
+- lib/m3ta/version.rb
+homepage: https://github.com/braindeaf/m3ta
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/braindeaf/m3ta
+  source_code_uri: https://github.com/braindeaf/m3ta
+  changelog_uri: https://github.com/braindeaf/m3ta/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.3
+signing_key:
+specification_version: 4
+summary: Define meta tags in your Rails app
+test_files: []