middleman-dato 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 350ddc7ef70748046571194c17e29f843297c9c8
-  data.tar.gz: fe3eb4419b27d91804beeb795a64a9280d310bb4
+  metadata.gz: 58d96f4274983ff4f7dbb53ce87535f60d0a85a7
+  data.tar.gz: 44ca86cac8e9b7b0761f7a226f8f3799bb004cfe
 SHA512:
-  metadata.gz: f7688e47beeb4197b91c178751044dcaeae92c19670d5d2a412d0d6c05e7186b1cc9590934ee88f3191196d0281de532eeaeb3de45e623d949e7f9ea9131c549
-  data.tar.gz: 40003527ad0b4db7f05de87323cdd389a242bdf6a7010c789be0039792c44b7b83c330ebcfaa470a04057760a7a308490c60bada78eac22c6751680608da7acd
+  metadata.gz: e3aa277cd4ef6b1371236da52cf3ef6b8391aad1562d4a646ae0925e23d2d44f62cb069f2750d0970459e24fbfe56abf8cddcf9711fe0537f441042d4070fe15
+  data.tar.gz: 3d9951128381105479635c09f8ee535da7d57b83ae7513edaa9d7924241306daa0fa1401f19699578c9ea5468c552a2bf5852889cb5d90ff34d7455a74f9c5d1

data/lib/middleman_dato/middleman_extension.rb

@@ -3,63 +3,21 @@ require 'middleman-core'
 require 'middleman-core/version'
 require 'dato/site/client'
 require 'dato/local/loader'
-require 'middleman_dato/meta_tags_builder'
-require 'middleman_dato/meta_tags/favicon'
-require 'pusher-client'
-require 'singleton'
+require 'dato/watch/site_change_watcher'
+require 'middleman_dato/watcher'
+require 'dato/utils/seo_tags_builder'
+require 'dato/utils/favicon_tags_builder'
 
 module MiddlemanDato
-  class Watcher
-    include Singleton
-    attr_reader :event_queue
-
-    def initialize
-      PusherClient.logger.level = Logger::WARN
-      @site_id = nil
-      @apps = []
-    end
-
-    def watch(app, loader, site_id)
-      @app = app
-      @loader = loader
-
-      if site_id != @site_id
-        if @socket && @socket.connected
-          @apps = []
-          @socket.disconnect
-        end
-
-        @apps = [ app.object_id ]
-        @site_id = site_id
-        @socket = PusherClient::Socket.new('75e6ef0fe5d39f481626', secure: true)
-        @socket.subscribe("site-#{site_id}")
-        @socket.bind('site:change') do
-          print "DatoCMS content changed, refreshing data..."
-          @loader.load
-          puts " done!"
-          @app.sitemap.rebuild_resource_list!(:touched_dato_content)
-        end
-        @socket.connect(true)
-      else
-        @apps[@apps.size - 1] = app.object_id
-      end
-    end
-
-    def shutdown(app)
-      if @socket && @socket.connected && @apps == [ app.object_id ]
-        @socket.disconnect
-      end
-      @apps.delete(app.object_id)
-    end
-  end
-
   class MiddlemanExtension < ::Middleman::Extension
     attr_reader :loader
 
-    option :domain, nil, 'Site domain (legacy)'
-    option :token, nil, 'Site API token'
+    option :token, ENV['DATO_API_TOKEN'], 'Site API token'
     option :api_base_url, 'https://site-api.datocms.com', 'Site API host'
-    option :base_url, nil, 'Website base URL'
+    option :live_reload, true, 'Live reload of content coming from DatoCMS'
+
+    option :base_url, nil, 'Website base URL (deprecated)'
+    option :domain, nil, 'Site domain (deprecated)'
 
     expose_to_config dato: :dato_collector
     expose_to_application dato_items_repo: :items_repo
@@ -71,13 +29,13 @@ module MiddlemanDato
       @loader.load
 
       app.after_configuration do
-        if !app.build?
+        if options_hash[:live_reload] && !app.build?
           Watcher.instance.watch(app, loader, loader.items_repo.site.id)
         end
       end
 
       app.before_shutdown do
-        if !app.build?
+        if options_hash[:live_reload] && !app.build?
           Watcher.instance.shutdown(app)
         end
       end
@@ -106,45 +64,40 @@ module MiddlemanDato
 
     module InstanceMethods
       def dato
-        extensions[:dato].loader.items_repo
+        extensions[:dato].items_repo
       end
     end
 
     helpers do
       def dato
-        extensions[:dato].loader.items_repo
+        extensions[:dato].items_repo
       end
 
       def dato_meta_tags(item)
-        site_entity = extensions[:dato].loader
-          .entities_repo
-          .find_entities_of_type('site')
-          .first
-
-        builder = MetaTagsBuilder.new(
-          self,
-          extensions[:dato].options[:base_url],
-          site_entity,
-          item
-        )
-        builder.meta_tags
+        meta_tags = Dato::Utils::SeoTagsBuilder.new(item, dato.site).meta_tags
+
+        meta_tags.map do |data|
+          if data[:content]
+            content_tag(data[:tag_name], data[:content], data[:attributes])
+          else
+            tag(data[:tag_name], data[:attributes])
+          end
+        end.join
       end
 
       def dato_favicon_meta_tags(options = {})
-        site_entity = extensions[:dato].loader
-          .entities_repo
-          .find_entities_of_type('site')
-          .first
-
-        options[:theme_color] ||= '#ffffff'
-        options[:app_name] ||= ''
-
-        favicon_builder = MetaTags::Favicon.new(
-          self,
-          site_entity,
+        meta_tags = Dato::Utils::FaviconTagsBuilder.new(
+          dato.site,
           options[:theme_color]
-        )
-        favicon_builder.build
+        ).meta_tags
+
+        meta_tags.map do |data|
+          if data[:content]
+            content_tag(data[:tag_name], data[:content], data[:attributes])
+          else
+            tag(data[:tag_name], data[:attributes])
+          end
+        end.join
       end
     end
   end

data/lib/middleman_dato/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MiddlemanDato
-  VERSION = '0.6.1'
+  VERSION = '0.7.0'
 end

data/lib/middleman_dato/watcher.rb

@@ -0,0 +1,44 @@
+require 'singleton'
+
+module MiddlemanDato
+  class Watcher
+    include Singleton
+
+    def initialize
+      @site_id = nil
+      @apps = []
+      @watcher = nil
+    end
+
+    def watch(app, loader, site_id)
+      @app = app
+      @loader = loader
+
+      if site_id != @site_id
+        if @watcher && @watcher.connected?
+          @apps = []
+          @watcher.disconnect!
+        end
+
+        @apps = [ app.object_id ]
+        @site_id = site_id
+        @watcher = Dato::Watch::SiteChangeWatcher.new(site_id).connect do
+          print "DatoCMS content changed, refreshing data..."
+          @loader.load
+          puts " done!"
+          @app.sitemap.rebuild_resource_list!(:touched_dato_content)
+        end
+      else
+        @apps[@apps.size - 1] = app.object_id
+      end
+    end
+
+    def shutdown(app)
+      if @watcher && @watcher.connected? && @apps == [ app.object_id ]
+        @watcher.disconnect!
+      end
+
+      @apps.delete(app.object_id)
+    end
+  end
+end

data/middleman-dato.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('coveralls')
 
   s.add_runtime_dependency('middleman-core', ['>= 4.1.10'])
-  s.add_runtime_dependency('dato', ['>= 0.2.4'])
+  s.add_runtime_dependency('dato', ['>= 0.3.0'])
   s.add_runtime_dependency('activesupport')
   s.add_runtime_dependency('pusher-client')
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: middleman-dato
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -96,25 +96,9 @@ files:
 - README.md
 - Rakefile
 - lib/middleman-dato.rb
-- lib/middleman_dato/meta_tags/article_modified_time.rb
-- lib/middleman_dato/meta_tags/article_publisher.rb
-- lib/middleman_dato/meta_tags/base.rb
-- lib/middleman_dato/meta_tags/description.rb
-- lib/middleman_dato/meta_tags/favicon.rb
-- lib/middleman_dato/meta_tags/image.rb
-- lib/middleman_dato/meta_tags/og_locale.rb
-- lib/middleman_dato/meta_tags/og_meta_tag.rb
-- lib/middleman_dato/meta_tags/og_site_name.rb
-- lib/middleman_dato/meta_tags/og_type.rb
-- lib/middleman_dato/meta_tags/robots.rb
-- lib/middleman_dato/meta_tags/title.rb
-- lib/middleman_dato/meta_tags/twitter_card.rb
-- lib/middleman_dato/meta_tags/twitter_meta_tag.rb
-- lib/middleman_dato/meta_tags/twitter_site.rb
-- lib/middleman_dato/meta_tags/url.rb
-- lib/middleman_dato/meta_tags_builder.rb
 - lib/middleman_dato/middleman_extension.rb
 - lib/middleman_dato/version.rb
+- lib/middleman_dato/watcher.rb
 - middleman-dato.gemspec
 - spec/middleman_dato/meta_tags/article_modified_time_spec.rb
 - spec/middleman_dato/meta_tags/favicon_spec.rb
@@ -152,4 +136,3 @@ test_files:
 - spec/middleman_dato/meta_tags/og_locale_spec.rb
 - spec/spec_helper.rb
 - spec/support/mock_builder.rb
-has_rdoc: 

data/lib/middleman_dato/meta_tags/article_modified_time.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/og_meta_tag'
-require 'time'
-
-module MiddlemanDato
-  module MetaTags
-    class ArticleModifiedTime < OgMetaTag
-      def buildable?
-        item && !item.singleton?
-      end
-
-      def name
-        'article:modified_time'
-      end
-
-      def value
-        item.updated_at.iso8601
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/article_publisher.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/og_meta_tag'
-require 'time'
-
-module MiddlemanDato
-  module MetaTags
-    class ArticlePublisher < OgMetaTag
-      def buildable?
-        item && !item.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/middleman_dato/meta_tags/base.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-require 'forwardable'
-require 'dato/local/field_type/seo'
-require 'active_support/core_ext/object/blank'
-
-module MiddlemanDato
-  module MetaTags
-    class Base
-      attr_reader :builder, :base_url, :site, :item_type, :item
-
-      def initialize(builder, base_url, site, item)
-        @site = site
-        @base_url = base_url
-        @item = item
-        @builder = builder
-      end
-
-      def seo_field_with_fallback(attribute, alternative = nil, &block)
-        seo = first_item_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?
-        site && site.no_index
-      end
-
-      def global_seo_field(attribute)
-        global_seo[attribute] if global_seo
-      end
-
-      def first_item_field_of_type(type)
-        return nil unless item
-
-        field = item.fields.detect do |f|
-          f.field_type == type.to_s
-        end
-
-        item.send(field.api_key) if field
-      end
-
-      def fallback_seo
-        @fallback_seo ||= begin
-          Dato::Local::FieldType::Seo.parse(global_seo[:fallback_seo], nil) if global_seo
-        end
-      end
-
-      def global_seo
-        @global_seo ||= begin
-          if site && site.global_seo
-            global_seo = site.global_seo
-            if site.locales.size > 1
-              global_seo[I18n.locale]
-            else
-              global_seo
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/description.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/base'
-
-module MiddlemanDato
-  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/middleman_dato/meta_tags/favicon.rb

@@ -1,82 +0,0 @@
-# frozen_string_literal: true
-require 'dato/local/field_type/image'
-
-module MiddlemanDato
-  module MetaTags
-    class Favicon
-      attr_reader :builder, :theme_color, :favicon, :app_name
-      APPLE_TOUCH_ICON_SIZES = [57, 60, 72, 76, 114, 120, 144, 152, 180].freeze
-      ICON_SIZES = [16, 32, 96, 192].freeze
-      APPLICATION_SIZES = [70, 150, 310].freeze
-
-      def initialize(builder, entity, theme_color)
-        @favicon = entity.favicon
-        @builder = builder
-        @theme_color = theme_color
-        @app_name = entity.global_seo['site_name'] || ''
-      end
-
-      def image
-        Dato::Local::FieldType::Image.parse(favicon, nil) if favicon.present?
-      end
-
-      def url(width, height = nil)
-        height ||= width
-        image.file.width(width).height(height).to_url
-      end
-
-      def build_apple_icon_tags
-        APPLE_TOUCH_ICON_SIZES.map do |size|
-          builder.tag(:link,
-                      rel: 'apple-touch-icon',
-                      sizes: "#{size}x#{size}",
-                      href: url(size))
-        end
-      end
-
-      def build_icon_tags
-        ICON_SIZES.map do |size|
-          builder.tag(:link,
-                      rel: 'icon',
-                      type: "image/#{image.format}",
-                      href: url(size),
-                      sizes: "#{size}x#{size}")
-        end
-      end
-
-      def build_application_tags
-        APPLICATION_SIZES.map do |size|
-          builder.tag(:meta,
-                      name: "msapplication-square#{size}x#{size}logo",
-                      content: url(size))
-        end + [builder.tag(:meta,
-                           name: 'msapplication-wide310x150logo',
-                           content: url(310, 150))]
-      end
-
-      def main_tags
-        [
-          builder.tag(:meta, name: 'application-name', content: app_name),
-          builder.tag(:meta, name: 'theme-color', content: theme_color),
-          builder.tag(:meta,
-                      name: 'msapplication-TileColor',
-                      content: theme_color)
-        ]
-      end
-
-      def build_tags
-        tags = main_tags
-        unless image.nil?
-          tags += build_apple_icon_tags
-          tags += build_icon_tags
-          tags += build_application_tags
-        end
-        tags
-      end
-
-      def build
-        build_tags.join("\n")
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/image.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/base'
-
-module MiddlemanDato
-  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_item_field_of_type(:image)
-        ) do |i|
-          i.width >= 200 && i.height >= 200
-        end
-
-        image.file.format('jpg').to_url if image
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/og_locale.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/og_meta_tag'
-
-module MiddlemanDato
-  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/middleman_dato/meta_tags/og_meta_tag.rb

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

data/lib/middleman_dato/meta_tags/og_site_name.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/og_meta_tag'
-
-module MiddlemanDato
-  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/middleman_dato/meta_tags/og_type.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/og_meta_tag'
-
-module MiddlemanDato
-  module MetaTags
-    class OgType < OgMetaTag
-      def buildable?
-        true
-      end
-
-      def name
-        'og:type'
-      end
-
-      def value
-        if !item
-          'website'
-        elsif item.singleton?
-          'website'
-        else
-          'article'
-        end
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/robots.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/base'
-
-module MiddlemanDato
-  module MetaTags
-    class Robots < Base
-      def build
-        builder.tag(:meta, name: 'robots', content: 'noindex') if no_index?
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/title.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/base'
-
-module MiddlemanDato
-  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 ||= begin
-                     title_field = item.fields.find do |field|
-                       field.field_type == 'string' &&
-                         field.appeareance[:type] == 'title'
-                     end
-
-                     seo_field_with_fallback(
-                       :title,
-                       item && title_field && item.send(title_field.api_key)
-                     )
-                   end
-      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/middleman_dato/meta_tags/twitter_card.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/twitter_meta_tag'
-
-module MiddlemanDato
-  module MetaTags
-    class TwitterCard < TwitterMetaTag
-      def buildable?
-        true
-      end
-
-      def name
-        'twitter:card'
-      end
-
-      def value
-        'summary'
-      end
-    end
-  end
-end

data/lib/middleman_dato/meta_tags/twitter_meta_tag.rb

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

data/lib/middleman_dato/meta_tags/twitter_site.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/twitter_meta_tag'
-
-module MiddlemanDato
-  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/middleman_dato/meta_tags/url.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/base'
-
-module MiddlemanDato
-  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/middleman_dato/meta_tags_builder.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-require 'middleman_dato/meta_tags/title'
-require 'middleman_dato/meta_tags/description'
-require 'middleman_dato/meta_tags/image'
-require 'middleman_dato/meta_tags/url'
-require 'middleman_dato/meta_tags/robots'
-require 'middleman_dato/meta_tags/og_locale'
-require 'middleman_dato/meta_tags/og_type'
-require 'middleman_dato/meta_tags/og_site_name'
-require 'middleman_dato/meta_tags/article_modified_time'
-require 'middleman_dato/meta_tags/article_publisher'
-require 'middleman_dato/meta_tags/twitter_card'
-require 'middleman_dato/meta_tags/twitter_site'
-
-module MiddlemanDato
-  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
-    ].freeze
-
-    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