middleman-dato 0.0.1.rc2 → 0.0.1.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2662bb3c2b38f4f37124b6ea9eb18de9db52b121
-  data.tar.gz: f798ff90cad69d1eb951dc3d95d345d9bc9b30a7
+  metadata.gz: 9e9b62c5c0b856590c2086fc8eb5f7c881fdee83
+  data.tar.gz: ada1e157192adfb35b34f62ddbfa89828c5afad0
 SHA512:
-  metadata.gz: 935e93b6a99c6c7a244b7f48184f3af845f8252d04cf696d8a94c00971fbd8e1a5c906ead27407ca39e0fedc2a4ed91a6888e22d1f046e734d02de9bdbf41895
-  data.tar.gz: 88393186cced3a657979a04fefafb21a482791dbfb4a5f060935f8c10d7286b9d43d7af4f45006729e79bb9617a2d511436da953e8cac65f00587d945cd5dedb
+  metadata.gz: a6929b598351b0a444326ccba3e879215f4594378559e17674f5ae691348f1d4db32d29b7a49ffa7d9595b8db20b1f781831c61be389066686b2398bfa132904
+  data.tar.gz: 25b452a1e01c2034d6d8c046f906baf42605ae598d41d26f806b011b2c8705433a55b2d607cf550bb595b51176cd809a76b90b4915173932e67ca300efbbbd61

data/Gemfile

@@ -12,8 +12,5 @@ group :development do
 end
 
 group :test do
-  gem 'cucumber'
-  gem 'fivemat'
-  gem 'aruba'
   gem 'rspec'
 end

data/lib/dato/meta_tags/article_modified_time.rb

@@ -0,0 +1,20 @@
+require 'dato/meta_tags/og_meta_tag'
+require 'time'
+
+module Dato
+  module MetaTags
+    class ArticleModifiedTime < OgMetaTag
+      def buildable?
+        record && !record.singleton?
+      end
+
+      def name
+        "article:modified_time"
+      end
+
+      def value
+        record.updated_at.iso8601
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/article_publisher.rb

@@ -0,0 +1,21 @@
+require 'dato/meta_tags/og_meta_tag'
+require 'time'
+
+module Dato
+  module MetaTags
+    class ArticlePublisher < OgMetaTag
+      def buildable?
+        record && !record.singleton? &&
+        global_seo_field(:facebook_page_url).present?
+      end
+
+      def name
+        "article:publisher"
+      end
+
+      def value
+        global_seo_field(:facebook_page_url)
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/base.rb

@@ -0,0 +1,80 @@
+require 'forwardable'
+require 'dato/seo'
+
+module Dato
+  module MetaTags
+    class Base
+      attr_reader :builder, :base_url, :space, :content_type, :record
+
+      def initialize(builder, base_url, space, record)
+        @space = space
+        @base_url = base_url
+        @record = record
+        @builder = builder
+      end
+
+      def seo_field_with_fallback(attribute, alternative = nil, &block)
+        seo = first_record_field_of_type(:seo)
+
+        alternatives = []
+
+        alternatives << seo.send(attribute) if seo
+        alternatives << alternative if alternative
+        alternatives << fallback_seo.send(attribute) if fallback_seo
+
+        alternatives = alternatives.select(&:present?)
+        alternatives = alternatives.select(&block) if block
+
+        alternatives.first
+      end
+
+      def title_suffix
+        global_seo_field(:title_suffix)
+      end
+
+      def no_index?
+        space && space[:attributes][:no_index]
+      end
+
+      def global_seo_field(attribute)
+        if global_seo
+          global_seo[attribute]
+        end
+      end
+
+      def first_record_field_of_type(type)
+        return nil unless record
+
+        field = record.fields.find do |name, field|
+          field[:field_type] == type.to_s
+        end
+
+        if field
+          field_name = field.first
+          record.send(field_name)
+        end
+      end
+
+      def fallback_seo
+        @fallback_seo ||= begin
+          if global_seo
+            Seo.new(global_seo[:fallback_seo])
+          end
+        end
+      end
+
+      def global_seo
+        @global_seo ||= begin
+          if space && space[:attributes][:global_seo]
+            global_seo = space[:attributes][:global_seo]
+            if space[:attributes][:locales].size > 1
+              global_seo[I18n.locale]
+            else
+              global_seo
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/description.rb

@@ -0,0 +1,24 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class Description < Base
+
+      def build
+        if description.present?
+          [
+            builder.tag(:meta, name: "description", content: description),
+            builder.tag(:meta, property: "og:description", content: description),
+            builder.tag(:meta, name: "twitter:description", content: description)
+          ]
+        end
+      end
+
+      def description
+        @description ||= seo_field_with_fallback(:description)
+      end
+    end
+  end
+end
+
+

data/lib/dato/meta_tags/image.rb

@@ -0,0 +1,33 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class Image < Base
+
+      def build
+        if image.present?
+          [
+            builder.tag(:meta, property: "og:image", content: image),
+            builder.tag(:meta, name: "twitter:image", content: image)
+          ]
+        end
+      end
+
+      def image
+        image = seo_field_with_fallback(
+          :image,
+          first_record_field_of_type(:image)
+        ) do |image|
+          image.attributes[:width] >= 200 &&
+          image.attributes[:height] >= 200
+        end
+
+        if image
+          image.file.format("jpg").to_url
+        end
+      end
+    end
+  end
+end
+
+

data/lib/dato/meta_tags/og_locale.rb

@@ -0,0 +1,20 @@
+require 'dato/meta_tags/og_meta_tag'
+
+module Dato
+  module MetaTags
+    class OgLocale < OgMetaTag
+      def buildable?
+        true
+      end
+
+      def name
+        "og:locale"
+      end
+
+      def value
+        locale = I18n.locale
+        "#{locale}_#{locale.upcase}"
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/og_meta_tag.rb

@@ -0,0 +1,25 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class OgMetaTag < Base
+      def buildable?
+        false
+      end
+
+      def build
+        if buildable?
+          builder.tag(:meta, property: name, content: value)
+        end
+      end
+
+      def name
+        raise NotImplementedError
+      end
+
+      def value
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/og_site_name.rb

@@ -0,0 +1,19 @@
+require 'dato/meta_tags/og_meta_tag'
+
+module Dato
+  module MetaTags
+    class OgSiteName < OgMetaTag
+      def buildable?
+        global_seo_field(:site_name).present?
+      end
+
+      def name
+        "og:site_name"
+      end
+
+      def value
+        global_seo_field(:site_name)
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/og_type.rb

@@ -0,0 +1,25 @@
+require 'dato/meta_tags/og_meta_tag'
+
+module Dato
+  module MetaTags
+    class OgType < OgMetaTag
+      def buildable?
+        true
+      end
+
+      def name
+        "og:type"
+      end
+
+      def value
+        if !record
+          "website"
+        elsif record.singleton?
+          "website"
+        else
+          "article"
+        end
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/robots.rb

@@ -0,0 +1,16 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class Robots < Base
+      def build
+        if no_index?
+          builder.tag(:meta, name: "robots", content: "noindex")
+        end
+      end
+    end
+  end
+end
+
+
+

data/lib/dato/meta_tags/title.rb

@@ -0,0 +1,37 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class Title < Base
+
+      def build
+        if title.present?
+          [
+            builder.content_tag(:title, title_with_suffix),
+            builder.tag(:meta, property: "og:title", content: title),
+            builder.tag(:meta, name: "twitter:title", content: title)
+          ]
+        end
+      end
+
+      def title
+        @title ||= seo_field_with_fallback(
+          :title,
+          first_record_field_of_type(:title)
+        )
+      end
+
+      def title_with_suffix
+        title_plus_suffix = title + title_suffix
+
+        if title_plus_suffix.size <= 60
+          title_plus_suffix
+        else
+          title
+        end
+      end
+    end
+  end
+end
+
+

data/lib/dato/meta_tags/twitter_card.rb

@@ -0,0 +1,19 @@
+require 'dato/meta_tags/twitter_meta_tag'
+
+module Dato
+  module MetaTags
+    class TwitterCard < TwitterMetaTag
+      def buildable?
+        true
+      end
+
+      def name
+        "twitter:card"
+      end
+
+      def value
+        "summary"
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/twitter_meta_tag.rb

@@ -0,0 +1,26 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class TwitterMetaTag < Base
+      def buildable?
+        false
+      end
+
+      def build
+        if buildable?
+          builder.tag(:meta, name: name, content: value)
+        end
+      end
+
+      def name
+        raise NotImplementedError
+      end
+
+      def value
+        raise NotImplementedError
+      end
+    end
+  end
+end
+

data/lib/dato/meta_tags/twitter_site.rb

@@ -0,0 +1,19 @@
+require 'dato/meta_tags/twitter_meta_tag'
+
+module Dato
+  module MetaTags
+    class TwitterSite < TwitterMetaTag
+      def buildable?
+        global_seo_field(:twitter_account).present?
+      end
+
+      def name
+        "twitter:site"
+      end
+
+      def value
+        global_seo_field(:twitter_account)
+      end
+    end
+  end
+end

data/lib/dato/meta_tags/url.rb

@@ -0,0 +1,24 @@
+require 'dato/meta_tags/base'
+
+module Dato
+  module MetaTags
+    class Url < Base
+
+      def build
+        if url.present?
+          [
+            builder.tag(:link, rel: "canonical", href: url),
+            builder.tag(:meta, property: "og:url", content: url),
+            builder.tag(:meta, name: "twitter:url", content: url)
+          ]
+        end
+      end
+
+      def url
+        base_url + builder.current_page.url
+      end
+    end
+  end
+end
+
+

data/lib/dato/meta_tags_builder.rb

@@ -0,0 +1,41 @@
+require 'dato/meta_tags/title'
+require 'dato/meta_tags/description'
+require 'dato/meta_tags/image'
+require 'dato/meta_tags/url'
+require 'dato/meta_tags/robots'
+require 'dato/meta_tags/og_locale'
+require 'dato/meta_tags/og_type'
+require 'dato/meta_tags/og_site_name'
+require 'dato/meta_tags/article_modified_time'
+require 'dato/meta_tags/article_publisher'
+require 'dato/meta_tags/twitter_card'
+require 'dato/meta_tags/twitter_site'
+
+module Dato
+  class MetaTagsBuilder
+    META_TAGS = [
+      MetaTags::Title,
+      MetaTags::Description,
+      MetaTags::Image,
+      MetaTags::Url,
+      MetaTags::Robots,
+      MetaTags::OgLocale,
+      MetaTags::OgType,
+      MetaTags::OgSiteName,
+      MetaTags::ArticleModifiedTime,
+      MetaTags::ArticlePublisher,
+      MetaTags::TwitterCard,
+      MetaTags::TwitterSite
+    ]
+
+    def initialize(*args)
+      @args = args
+    end
+
+    def meta_tags
+      META_TAGS.map do |klass|
+        klass.new(*@args).build
+      end.flatten.compact.join("\n")
+    end
+  end
+end

data/lib/dato/middleman_extension.rb

@@ -1,5 +1,6 @@
 require 'middleman-core'
 require 'dato/repo'
+require 'dato/meta_tags_builder'
 require 'ostruct'
 
 module Dato
@@ -7,6 +8,7 @@ module Dato
     option :domain, nil, 'Space domain'
     option :token, nil, 'Space API token'
     option :api_host, 'http://dato-api.herokuapp.com', 'Space API token'
+    option :base_url, nil, 'Website base URL'
 
     attr_reader :records
 
@@ -38,6 +40,21 @@ module Dato
       def dato
         OpenStruct.new(Repo.instance.records_per_content_type)
       end
+
+      def dato_meta_tags(record)
+        begin
+          builder = MetaTagsBuilder.new(
+            self,
+            Repo.instance.connection_options[:base_url],
+            Repo.instance.space,
+            record
+          )
+          builder.meta_tags
+        rescue Exception => e
+          puts e.message
+          puts e.backtrace.join("\n")
+        end
+      end
     end
   end
 end

data/lib/dato/record.rb

@@ -1,15 +1,21 @@
 require "dato/file"
+require "dato/seo"
+require "time"
 
 module Dato
   class Record
-    attr_reader :attributes, :fields, :singleton
+    attr_reader :attributes, :fields, :content_type
 
     def initialize(attributes, content_type)
       @attributes = attributes.with_indifferent_access
-      @singleton = content_type[:singleton]
+      @content_type = content_type
       @fields = content_type[:fields].with_indifferent_access
     end
 
+    def singleton?
+      @singleton = content_type[:singleton]
+    end
+
     def respond_to?(method, include_private = false)
       if @attributes.has_key?(method)
         true
@@ -27,10 +33,14 @@ module Dato
         attribute
       end
 
+      return nil if !attribute
+
       if %w(image file).include? fields[name][:field_type]
         Dato::File.new(attribute)
       elsif fields[name][:field_type] == "date"
         Date.parse(attribute)
+      elsif fields[name][:field_type] == "seo"
+        Dato::Seo.new(attribute)
       else
         attribute
       end
@@ -40,6 +50,10 @@ module Dato
       @attributes[:id]
     end
 
+    def updated_at
+      Time.parse(@attributes[:updated_at])
+    end
+
     def method_missing(method, *arguments, &block)
       if @attributes.has_key?(method) && arguments.size == 0
         read_attribute(method.to_sym)

data/lib/dato/repo.rb

@@ -7,9 +7,11 @@ module Dato
   class Repo
     include Singleton
 
-    attr_reader :client, :content_types, :records_per_content_type
+    attr_reader :client, :space, :content_types, :records_per_content_type,
+      :connection_options
 
     def connection_options=(options)
+      @connection_options = options
       @client = Client.new(
         options[:api_host],
         options[:domain],
@@ -18,7 +20,9 @@ module Dato
     end
 
     def sync!
-      @content_types = prepare_content_types(client.space)
+      space_response = client.space.with_indifferent_access
+      @space = space_response[:data]
+      @content_types = prepare_content_types(space_response)
       @records_per_content_type = group_by_content_type(client.records)
     end
 

data/lib/dato/seo.rb

@@ -0,0 +1,31 @@
+require "imgix"
+
+module Dato
+  class Seo
+    attr_reader :attributes
+
+    def initialize(data)
+      @attributes = data.with_indifferent_access
+    end
+
+    def image
+      @attributes[:image] && File.new(@attributes[:image])
+    end
+
+    def respond_to?(method, include_private = false)
+      if @attributes.has_key?(method)
+        true
+      else
+        super
+      end
+    end
+
+    def method_missing(method, *arguments, &block)
+      if @attributes.has_key?(method) && arguments.size == 0
+        @attributes[method.to_sym]
+      else
+        super
+      end
+    end
+  end
+end

data/middleman-dato.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "middleman-dato"
-  s.version     = "0.0.1.rc2"
+  s.version     = "0.0.1.rc3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Stefano Verna"]
   s.email       = ["s.verna@cantierecreativo.net"]

data/spec/dato/meta_tags/article_modified_time_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+module Dato::MetaTags
+  RSpec.describe ArticleModifiedTime do
+    subject(:meta_tag) { described_class.new(builder, space, record) }
+    let(:builder) { MockBuilder.new }
+    let(:space) { nil }
+    let(:record) do
+      double("Record", updated_at: Time.now, singleton?: false)
+    end
+
+    describe '.value' do
+      context 'if record is not singleton' do
+        it 'returns an ISO 8601 time representation' do
+          expect(meta_tag.value).not_to be_nil
+        end
+      end
+    end
+  end
+end
+

data/spec/dato/meta_tags/og_locale_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+module Dato::MetaTags
+  RSpec.describe OgLocale do
+    subject(:meta_tag) { described_class.new(builder, space, record) }
+    let(:builder) { MockBuilder.new }
+    let(:space) { nil }
+    let(:record) { nil }
+
+    describe '.value' do
+      it "returns the current locale" do
+        I18n.with_locale(:it) do
+          expect(meta_tag.value).to eq "it_IT"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'active_support/dependencies'
+
+require 'i18n'
+
+I18n.available_locales = [:it, :en]
+
+ActiveSupport::Dependencies.autoload_paths.unshift(
+  File.join(__dir__, "../lib")
+)
+
+Dir["spec/support/**/*.rb"].each do |f|
+  require_relative "../" + f
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

data/spec/support/mock_builder.rb

@@ -0,0 +1,5 @@
+class MockBuilder
+  def tag(*args)
+    args
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-dato
 version: !ruby/object:Gem::Version
-  version: 0.0.1.rc2
+  version: 0.0.1.rc3
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -78,12 +78,33 @@ files:
 - Rakefile
 - lib/dato/client.rb
 - lib/dato/file.rb
+- lib/dato/meta_tags/article_modified_time.rb
+- lib/dato/meta_tags/article_publisher.rb
+- lib/dato/meta_tags/base.rb
+- lib/dato/meta_tags/description.rb
+- lib/dato/meta_tags/image.rb
+- lib/dato/meta_tags/og_locale.rb
+- lib/dato/meta_tags/og_meta_tag.rb
+- lib/dato/meta_tags/og_site_name.rb
+- lib/dato/meta_tags/og_type.rb
+- lib/dato/meta_tags/robots.rb
+- lib/dato/meta_tags/title.rb
+- lib/dato/meta_tags/twitter_card.rb
+- lib/dato/meta_tags/twitter_meta_tag.rb
+- lib/dato/meta_tags/twitter_site.rb
+- lib/dato/meta_tags/url.rb
+- lib/dato/meta_tags_builder.rb
 - lib/dato/middleman_extension.rb
 - lib/dato/record.rb
 - lib/dato/repo.rb
+- lib/dato/seo.rb
 - lib/middleman-dato.rb
 - lib/middleman_extension.rb
 - middleman-dato.gemspec
+- spec/dato/meta_tags/article_modified_time_spec.rb
+- spec/dato/meta_tags/og_locale_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_builder.rb
 homepage: http://cantierecreativo.net
 licenses: []
 metadata: {}
@@ -107,5 +128,9 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Fetches data from a Dato space
-test_files: []
+test_files:
+- spec/dato/meta_tags/article_modified_time_spec.rb
+- spec/dato/meta_tags/og_locale_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock_builder.rb
 has_rdoc: