middleman-metaman 0.1.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a2a8ce9708336d9c838361407fdbde3a054d0e86e30fef8ffebfd11e91f0d73
+  data.tar.gz: d0d52a5e5b7cb944dbbe27d55ffd9f11bc8a6638af33db012ec599ec6477fcec
+SHA512:
+  metadata.gz: ea892ec190985247ba925cf9142b7ed06790d4b0a3a649825fdcb6cb237b7c89df82185181baa1da31f9d6ca066c2f1d7a6aeabd339fa43ac3e2797b05b31cba
+  data.tar.gz: 84254ab7e70d46a0ca33a0fd240f36c0ddb40322888952bb16e0c1b8874832a5849c2dbbefee5f03c1ef0c58ea4888e2127ed9da6a86e059a81605c5cdf267be

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+*.gem

data/.ruby-gemset

@@ -0,0 +1 @@
+middleman-metaman

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,6 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-metaman.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Cache Ventures. https://cacheventures.com
+
+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,73 @@
+# Middleman Metaman
+![Metman Logo](metaman.jpg)
+By [Cache Ventures](https://cacheventures.com).
+
+Metaman makes it easy to manage your meta tags on a Middleman site.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'middleman-metaman'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install middleman-metaman
+
+## Configuration
+
+Within the config.rb of the middleman project, include the line
+
+```ruby
+activate :metaman, host: 'https://domain.com'
+```
+
+## Usage
+
+Put this in the head of your site
+
+```erb
+  <%= display_meta_tags %>
+```
+
+You can set meta tags using multiple methods. The order of priority from lowest
+to highest is defaults (data/meta_tags.yml), translations, front matter,
+page specific variables set via `set_meta_tags` in
+a template.
+
+### Setting Defaults
+
+The defaults file lives in `data/meta_tags.yml`. You can set any meta tag you
+would like. It will be converted to a hash and merged during page generation.
+Nested parameters like `{ og: { title: 'My Title' } }` will become `og:title`.
+
+### Setting via Templates
+
+```erb
+<% set_page_meta(title: 'My Title', og: { image: 'meta-image.png' } )
+```
+
+### Setting via Front Matter
+
+Only the `title` and `description` can be set via Front Matter at this time.
+
+### Setting via Translations
+
+The gem will look for translations like so. If your page is called
+`thank_you.html.erb` your translations should go under en > thank_you > meta > `...`
+
+## Image Handling
+
+Any key that includes `image` in it will automatically have the host prepended
+and will use the `image_path` helper.
+
+## Property / Name Attribute
+
+This gem currently supports  generating meta tags using the
+property attribute for any meta tags that start with `og:`, `music:`, `music:`, `video:`, `article:`, `book:`, `profile:`.

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/lib/middleman-metaman.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+::Middleman::Extensions.register(:metaman) do
+  require 'middleman-metaman/extension'
+  ::Middleman::MetamanExtension
+end

data/lib/middleman-metaman/extension.rb

@@ -0,0 +1,20 @@
+require 'middleman-metaman/helpers'
+
+module Middleman
+  class MetamanExtension < Extension
+    option :host, nil, 'Set host that the site will running at.'
+
+    def initialize(app, options_hash={}, &block)
+      super
+
+      # place in class variable so helpers can access
+      @@options = options
+    end
+
+    def self.options
+      @@options
+    end
+
+    self.defined_helpers = [Middleman::Metaman::Helpers]
+  end
+end

data/lib/middleman-metaman/helpers.rb

@@ -0,0 +1,142 @@
+module Middleman
+  module Metaman
+    module Helpers
+
+      def set_meta_tags(tags)
+        @set_meta_tags ||= ActiveSupport::HashWithIndifferentAccess.new
+        @set_meta_tags.merge!(tags)
+      end
+
+      def display_meta_tags
+        @meta_tags ||= ActiveSupport::HashWithIndifferentAccess.new
+        @meta_tags[:og] ||= ActiveSupport::HashWithIndifferentAccess.new
+        @meta_tags[:twitter] ||= ActiveSupport::HashWithIndifferentAccess.new
+        if data['meta_tags']
+          site_meta_tags = data['meta_tags'].with_indifferent_access
+          @meta_tags.merge!(site_meta_tags)
+        end
+
+        # get meta from translation
+        t_page = current_page.url.gsub('-', '_').gsub('/', '.')
+        t_key = "#{t_page}.meta"
+        @meta_tags.merge!(I18n.t(t_key)) if I18n.exists?(t_key)
+
+        # get meta from frontmatter
+        @meta_tags.merge!(
+          {
+            title: current_page.data.title,
+            description: current_page.data.description
+          }.compact
+        )
+
+        @meta_tags.merge!(@set_meta_tags) if @set_meta_tags
+
+        html = []
+        @meta_tags[:title] = full_title(@meta_tags[:title])
+        html.push content_tag(:title, @meta_tags[:title])
+
+        excluded_keys = %w(site_name separator title image)
+        meta_hash = @meta_tags.reject { |k| excluded_keys.include?(k) }.merge(
+          og: meta_open_graph,
+          twitter: meta_twitter
+        )
+
+        meta_hash.each do |key, value|
+          next unless value
+
+          html.push generate_meta_html(key, value)
+        end
+        html.flatten.join
+      end
+
+      private
+
+      def full_title(title)
+        if title.is_a?(Hash) && title[:site_name].nil?
+          title[:title]
+        elsif title && @meta_tags[:site_name]
+          title + " #{@meta_tags[:separator] || '|'} " + @meta_tags[:site_name]
+        else
+          title
+        end
+      end
+
+      def generate_meta_html(key, value)
+        return unless key && value
+        return generate_meta_hash(key, value) if value.is_a?(Hash)
+        return generate_meta_array(key, value) if value.is_a?(Array)
+
+        value += current_page.url if key == 'og:url'
+        value = meta_image_url(value) if key.to_s.include?('image')
+
+        [tag(:meta, "#{meta_key(key)}" => key, content: value)]
+      end
+
+      def generate_meta_hash(key, value)
+        html = []
+        value.each do |hk, hv|
+          html.push generate_meta_html("#{key}:#{hk}", hv)
+        end
+        html
+      end
+
+      def generate_meta_array(key, value)
+        html = []
+        value.each do |av|
+          html.push generate_meta_html(key, av)
+        end
+        html
+      end
+
+      # determine key for meta tag based on name
+      def meta_key(key)
+        key.match?(/^(og|music|video|article|book|profile):/i) ? 'propery' : 'name'
+      end
+
+      # generate open graph meta
+      def meta_open_graph
+        og = ActiveSupport::HashWithIndifferentAccess.new
+        og[:url] = default_value(:og, :url) || host
+        og[:type] = default_value(:og, :type, 'website')
+        og[:site_name] = default_value(:og, :site_name)
+        og[:title] = default_value(:og, :title)
+        og[:description] = default_value(:og, :description)
+        og[:image] = default_value(:og, :image)
+
+        @meta_tags[:og].reject { |k| og.keys.include?(k) }.each do |k, v|
+          og[k] = v
+        end
+
+        og
+      end
+
+      # generate twitter meta
+      def meta_twitter
+        twitter = ActiveSupport::HashWithIndifferentAccess.new
+        twitter[:title] = default_value(:twitter, :title)
+        twitter[:description] = default_value(:twitter, :description)
+        twitter[:image] = default_value(:twitter, :image)
+
+        @meta_tags[:twitter].reject { |k| twitter.keys.include?(k) }.each do |k, v|
+          twitter[k] = v
+        end
+
+        twitter
+      end
+
+      # get the meta image url
+      def meta_image_url(image)
+        "#{host}#{image_path(image)}" if image
+      end
+
+      def default_value(scope, key, default = nil)
+        @meta_tags[scope][key] || @meta_tags[key] || default
+      end
+
+      def host
+        Middleman::MetamanExtension.options.host
+      end
+
+    end
+  end
+end

data/lib/middleman-metaman/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Metaman
+    VERSION = '0.1.6'.freeze
+  end
+end

data/middleman-metaman.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-metaman/version'
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-metaman"
+  s.version     = Middleman::Metaman::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Jarrett Lusso']
+  s.email       = ['jarrett@cacheventures.com']
+  s.homepage    = 'https://github.com/cacheventures/middleman-metaman'
+  s.summary     = 'Manage your middleman meta tags.'
+  s.description = 'Manage your middleman meta tags.'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # The version of middleman-core your extension depends on
+  s.add_runtime_dependency("middleman-core", [">= 4.2.1"])
+
+  # Additional dependencies
+  # s.add_runtime_dependency("gem-name", "gem-version")
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: middleman-metaman
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+platform: ruby
+authors:
+- Jarrett Lusso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.1
+description: Manage your middleman meta tags.
+email:
+- jarrett@cacheventures.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/middleman-metaman.rb
+- lib/middleman-metaman/extension.rb
+- lib/middleman-metaman/helpers.rb
+- lib/middleman-metaman/version.rb
+- metaman.jpg
+- middleman-metaman.gemspec
+homepage: https://github.com/cacheventures/middleman-metaman
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Manage your middleman meta tags.
+test_files: []