dato 0.1.31 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e6ffeb74c86a321901eeaf73084308fa26e0181
-  data.tar.gz: 6fd4ca5ad2a9f8fdb846970ac065603740c19436
+  metadata.gz: b54b098b276ed1157ddb3a025a7ed159f4de08ce
+  data.tar.gz: 51dabe629a57a274820cf257173b06cf0e3f48fe
 SHA512:
-  metadata.gz: 1870915a900d2e7877acba29fbb74cf4a578bda4a21b2566959f1d5189431514b43dd61e2d5d601d5e42f95cc0caf76410660a908120cb23fcda6a9815a4f88b
-  data.tar.gz: ff7093aeeb4cbadb4bec71fae0066bedbeb6e5fa37fe11e1e867eefaff58d06354063c2a69e33d468c77e7a22e7cccc3132753e840f5e0b9dcfab0903e16f025
+  metadata.gz: c175e119234ebb14bdbd534b68a76300cffd7fa893255d95afe2f785020c925b8afce747c94141da9984fafddfbc0cd054fc221fc4f3568847709fc32c65b237
+  data.tar.gz: 63acf4d92d062a34301091d45402a254b08eadd1eee5ed4b6b91aaa852ec72dcab93edabdd28f3528a67736a1e90219f8616e3aeb76ae15fb3691002724657da

data/.rubocop.yml

@@ -13,8 +13,14 @@ Metrics/ClassLength:
 Metrics/ModuleLength:
   Enabled: false
 
+Metrics/CyclomaticComplexity:
+  Max: 7
+
 Metrics/AbcSize:
-  Max: 20
+  Max: 30
+
+Metrics/PerceivedComplexity:
+  Max: 8
 
 Metrics/LineLength:
   Exclude:

data/.ruby-version

@@ -1 +1 @@
-2.1.0
+2.2.2

data/docs/dato-cli.md

@@ -103,12 +103,14 @@ Our job is to generate the Markdown files in the `content` directory from the da
 Using the DatoCMS web interface, we first create the following Item types:
 
 * post
-  - title (string, required, title)
+  - title (string, required)
+  - slug (slug, required)
   - publication_date (date, required)
   - body (text, required)
 
 * author
   - name (string, required, title)
+  - slug (slug, required)
   - bio (text, required)
 
 * quote
@@ -217,7 +219,7 @@ end
 
 directory "data/authors" do
   dato.authors.each do |item|
-    create_data_file "#{item.name.slug}.toml", :toml, {
+    create_data_file "#{item.slug}.toml", :toml, {
       name: item.name,
       bio: item.bio
     }
@@ -233,11 +235,6 @@ If a Item Type is marked as "single instance" (ie. `about_page`) you don't need
 
 You can query an item's field value with a method called like the field API identifier.
 
-An item also features a `.slug` method:
-
-* if an item type has a field of type `string` with a "Title" Presentation mode, than the method returns the slugified version of the title itself;
-* otherwise, it just returns the unique identifier of the item;
-
 Complex field types (ie. `image`, `file`, `video`, `seo`) implement specific methods you can use as well within the config file:
 
 ```

data/exe/dato

@@ -4,4 +4,4 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'dato'
-Dato::Dump::Cli.start(ARGV)
+Dato::Cli.start(ARGV)

data/lib/dato.rb

@@ -4,7 +4,7 @@ require 'dato/version'
 require 'dato/site/client'
 require 'dato/account/client'
 require 'dato/local/site'
-require 'dato/dump/cli'
+require 'dato/cli'
 
 module Dato
 end

data/lib/dato/api_error.rb

@@ -12,8 +12,12 @@ module Dato
         'DatoCMS API Error',
         "Status: #{faraday_error.response[:status]}",
         'Response:',
-        JSON.pretty_generate(JSON.load(faraday_error.response[:body]))
+        JSON.pretty_generate(body)
       ].join("\n")
     end
+
+    def body
+      JSON.parse(faraday_error.response[:body])
+    end
   end
 end

data/lib/dato/cli.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+require 'thor'
+require 'dato/dump/runner'
+require 'dato/dump/ssg_detector'
+require 'dato/migrate_slugs/runner'
+
+module Dato
+  class Cli < Thor
+    package_name 'DatoCMS'
+
+    desc 'dump', 'dumps DatoCMS contents into local files'
+    option :config, default: 'dato.config.rb'
+    option :token, default: ENV['DATO_API_TOKEN'], required: true
+    def dump
+      config_file = File.expand_path(options[:config])
+
+      client = Dato::Site::Client.new(
+        options[:token],
+        extra_headers: {
+          'X-Reason' => 'dump',
+          'X-SSG' => Dump::SsgDetector.new(Dir.pwd).detect
+        }
+      )
+
+      Dump::Runner.new(config_file, client).run
+    end
+
+    desc 'migrate-slugs', 'migrates a Site so that it uses slug fields'
+    option :token, default: ENV['DATO_API_TOKEN'], required: true
+    option :skip_id_prefix, type: :boolean
+    def migrate_slugs
+      client = Dato::Site::Client.new(
+        options[:token],
+        extra_headers: {
+          'X-Reason' => 'migrate-slugs'
+        }
+      )
+
+      MigrateSlugs::Runner.new(client, options[:skip_id_prefix]).run
+    end
+  end
+end

data/lib/dato/dump/format/toml.rb

@@ -3,14 +3,14 @@ require 'active_support/core_ext/hash/keys'
 require 'toml'
 
 class Time
-  def to_toml(path = "")
-    utc.strftime("%Y-%m-%dT%H:%M:%SZ")
+  def to_toml(_path = '')
+    utc.strftime('%Y-%m-%dT%H:%M:%SZ')
   end
 end
 
 class Date
-  def to_toml(path = "")
-    strftime("%Y-%m-%d")
+  def to_toml(_path = '')
+    strftime('%Y-%m-%d')
   end
 end
 

data/lib/dato/dump/runner.rb

@@ -16,7 +16,7 @@ module Dato
       end
 
       def run
-        print "Fetching content from DatoCMS... "
+        print 'Fetching content from DatoCMS... '
 
         loader.load
 

data/lib/dato/dump/ssg_detector.rb

@@ -26,7 +26,7 @@ module Dato
         },
         {
           file: 'config.json',
-          loader: ->(content) { JSON.load(content) }
+          loader: ->(content) { JSON.parse(content) }
         }
       ].freeze
 
@@ -59,7 +59,7 @@ module Dato
         package_path = File.join(path, 'package.json')
         return unless File.exist?(package_path)
 
-        package = JSON.load(File.read(package_path))
+        package = JSON.parse(File.read(package_path))
 
         deps = package.fetch('dependencies', {})
         dev_deps = package.fetch('devDependencies', {})

data/lib/dato/local/field_type/file.rb

@@ -39,13 +39,12 @@ module Dato
             url: url
           }
         end
-        
-      private
-      
+
+        private
+
         def default_host
           'dato-images.imgix.net'
         end
-        
       end
     end
   end

data/lib/dato/local/field_type/slug.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Dato
+  module Local
+    module FieldType
+      class Slug
+        def self.parse(value, _repo)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/dato/local/item.rb

@@ -24,14 +24,25 @@ module Dato
         other.is_a?(Item) && other.id == id
       end
 
-      def slug(prefix_with_id: true)
-        slug_field = fields.find { |f| f.api_key.to_sym == :slug }
+      def autogenerated_slug(options = {})
+        warning = [
+          'Warning: the method `Item#autogenerated_slug` is deprecated:',
+          'please add an explicit field of type `slug`',
+          "to the `#{item_type.api_key}` item type."
+        ]
+        puts warning.join(' ')
+
+        prefix_with_id = options.fetch(:prefix_with_id, true)
+
+        title_field = fields.find do |field|
+          field.field_type == 'string' &&
+            field.appeareance[:type] == 'title'
+        end
 
-        return read_attribute(:slug, slug_field) if slug_field
         return item_type.api_key.humanize.parameterize if singleton?
-        return id.to_s unless title_field_api_key
+        return id.to_s unless title_field
 
-        title = send(title_field_api_key)
+        title = send(title_field.api_key)
         if title && prefix_with_id
           "#{id}-#{title.parameterize[0..50]}"
         elsif title
@@ -41,14 +52,6 @@ module Dato
         end
       end
 
-      def title_field_api_key
-        title_field = fields.find do |field|
-          field.field_type == 'string' &&
-            field.appeareance[:type] == 'title'
-        end
-        title_field && title_field.api_key
-      end
-
       def singleton?
         item_type.singleton
       end
@@ -88,8 +91,6 @@ module Dato
         base = {
           id: id,
           item_type: item_type.api_key,
-          slug: slug(prefix_with_id: false),
-          slug_with_prefix: slug,
           updated_at: updated_at
         }
 
@@ -112,17 +113,24 @@ module Dato
         field_type = field.field_type
         type_klass_name = "::Dato::Local::FieldType::#{field_type.camelize}"
         type_klass = type_klass_name.safe_constantize
+        value = if field.localized
+                  (entity.send(method) || {})[I18n.locale]
+                else
+                  entity.send(method)
+                end
 
         if type_klass
-          value = if field.localized
-                    (entity.send(method) || {})[I18n.locale]
-                  else
-                    entity.send(method)
-                  end
-
           value && type_klass.parse(value, @items_repo)
         else
-          raise "Cannot convert field `#{method}` of type `#{field_type}`"
+          warning = [
+            "Warning: unrecognized field of type `#{field_type}`",
+            "for item `#{item_type.api_key}` and",
+            "field `#{method}`: returning a simple Hash instead.",
+            'Please upgrade to the latest version of the `dato` gem!'
+          ]
+          puts warning.join(' ')
+
+          value
         end
       end
 
@@ -136,7 +144,7 @@ module Dato
       rescue NoMethodError
         message = []
         message << "Undefined method `#{method}`"
-        message << 'Available fields for this DatoCMS item:'
+        message << "Available fields for a `#{item_type.api_key}` item:"
         message += fields.map do |f|
           "* .#{f.api_key}"
         end

data/lib/dato/local/loader.rb

@@ -34,7 +34,9 @@ module Dato
         items_per_page = 500
         base_response = client.request(:get, '/items', 'page[limit]' => 500)
 
-        extra_pages = (base_response[:meta][:total_count] / items_per_page.to_f).ceil - 1
+        extra_pages = (
+          base_response[:meta][:total_count] / items_per_page.to_f
+        ).ceil - 1
 
         extra_pages.times do |page|
           base_response[:data] += client.request(

data/lib/dato/migrate_slugs/runner.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+require 'dato/json_api_deserializer'
+require 'active_support/inflector/transliterate'
+
+module Dato
+  module MigrateSlugs
+    class Runner
+      attr_reader :client, :skip_id_prefix
+
+      def initialize(client, skip_id_prefix)
+        @client = client
+        @skip_id_prefix = skip_id_prefix
+      end
+
+      def run
+        print 'Fetching site informations... '
+        title_fields
+        puts "\e[32m✓\e[0m"
+
+        title_fields.each do |title_field|
+          item_type = item_types.find do |i|
+            i['id'] == title_field['item_type']
+          end
+
+          print "Adding slug field to Item type `#{item_type['name']}`... "
+          add_slug_field(title_field)
+          puts "\e[32m✓\e[0m"
+
+          items = items_for(title_field['item_type'])
+          print "Generating slugs for #{items.count} items"
+
+          items.each do |item|
+            update_item(title_field, item)
+            print '.'
+          end
+          puts "\e[32m✓\e[0m"
+
+          puts
+        end
+      end
+
+      def simple_slugify(item, title, suffix)
+        if title
+          slug = title.parameterize[0..50].gsub(/(^\-|\-$)/, '')
+          skip_id_prefix ? "#{slug}#{suffix}" : "#{item['id']}-#{slug}#{suffix}"
+        end
+      end
+
+      def slugify(item, title, suffix)
+        if title.is_a?(Hash)
+          Hash[
+            title.map do |locale, value|
+              [locale, simple_slugify(item, value, suffix)]
+            end
+          ]
+        else
+          simple_slugify(item, title, suffix)
+        end
+      end
+
+      def update_item(title_field, item)
+        title = item[title_field['api_key']]
+        counter = 0
+
+        loop do
+          begin
+            slug = slugify(item, title, counter.zero? ? '' : "-#{counter}")
+            return client.items.update(item['id'], item.merge(slug: slug))
+          rescue ApiError => e
+            error = e.body['data'][0]
+
+            if error['id'] == 'INVALID_FIELD' &&
+               error['attributes']['details']['field'] == 'slug' &&
+               error['attributes']['details']['code'] == 'VALIDATION_UNIQUE'
+
+              counter += 1
+            else
+              raise e
+            end
+          end
+        end
+      end
+
+      def items_for(item_type_id)
+        items_per_page = 500
+        base_response = client.request(
+          :get,
+          '/items',
+          'page[limit]' => 500,
+          'filter[type]' => item_type_id
+        )
+
+        extra_pages = (
+          base_response[:meta][:total_count] / items_per_page.to_f
+        ).ceil - 1
+
+        extra_pages.times do |page|
+          base_response[:data] += client.request(
+            :get,
+            '/items',
+            'page[offset]' => items_per_page * (page + 1),
+            'page[limit]' => items_per_page
+          )[:data]
+        end
+
+        JsonApiDeserializer.new.deserialize(base_response)
+      end
+
+      def add_slug_field(field)
+        validators = {
+          unique: {}
+        }
+
+        validators[:required] = {} if field['validators']['required']
+
+        slug_field = client.fields.create(
+          field['item_type'],
+          field_type: 'slug',
+          appeareance: { title_field_id: field['id'] },
+          validators: validators,
+          position: 99,
+          api_key: 'slug',
+          label: 'Slug',
+          hint: '',
+          localized: field['localized']
+        )
+
+        client.fields.update(
+          slug_field['id'],
+          position: field['position'] + 1
+        )
+      end
+
+      def title_fields
+        @title_fields ||= item_types.map do |item_type|
+          fields = client.fields.all(item_type['id'])
+
+          any_slug_present = fields.any? do |f|
+            f['field_type'] == 'slug' || f['api_key'] == 'slug'
+          end
+
+          next if any_slug_present
+          fields.find do |field|
+            field['field_type'] == 'string' &&
+              field['appeareance']['type'] == 'title'
+          end
+        end.compact
+      end
+
+      def item_types
+        @item_types ||= client.item_types.all
+      end
+    end
+  end
+end

data/lib/dato/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Dato
-  VERSION = '0.1.31'
+  VERSION = '0.2.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.1.31
+  version: 0.2.4
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -338,7 +338,6 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- dato.config.rb
 - dato.gemspec
 - docs/account-api-client.md
 - docs/dato-cli.md
@@ -350,7 +349,7 @@ files:
 - lib/dato/account/repo/base.rb
 - lib/dato/account/repo/site.rb
 - lib/dato/api_error.rb
-- lib/dato/dump/cli.rb
+- lib/dato/cli.rb
 - lib/dato/dump/dsl/add_to_data_file.rb
 - lib/dato/dump/dsl/create_data_file.rb
 - lib/dato/dump/dsl/create_post.rb
@@ -381,6 +380,7 @@ files:
 - lib/dato/local/field_type/link.rb
 - lib/dato/local/field_type/links.rb
 - lib/dato/local/field_type/seo.rb
+- lib/dato/local/field_type/slug.rb
 - lib/dato/local/field_type/string.rb
 - lib/dato/local/field_type/text.rb
 - lib/dato/local/field_type/video.rb
@@ -389,6 +389,7 @@ files:
 - lib/dato/local/json_api_entity.rb
 - lib/dato/local/loader.rb
 - lib/dato/local/site.rb
+- lib/dato/migrate_slugs/runner.rb
 - lib/dato/site/client.rb
 - lib/dato/site/repo/base.rb
 - lib/dato/site/repo/field.rb
@@ -421,7 +422,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Ruby client for DatoCMS API

data/dato.config.rb

@@ -1 +0,0 @@
-puts dato.blog_posts.first.title

data/lib/dato/dump/cli.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-require 'thor'
-require 'dato/dump/runner'
-
-module Dato
-  module Dump
-    class Cli < Thor
-      package_name 'DatoCMS'
-
-      desc 'dump', 'dumps DatoCMS contents into local files'
-      option :config, default: 'dato.config.rb'
-      option :token, default: ENV['DATO_API_TOKEN'], required: true
-      def dump
-        config_file = File.expand_path(options[:config])
-
-        client = Dato::Site::Client.new(
-          options[:token],
-          extra_headers: {
-            'X-Reason' => 'dump',
-            'X-SSG' => SsgDetector.new(Dir.pwd).detect
-          }
-        )
-
-        Runner.new(config_file, client).run
-      end
-    end
-  end
-end