dato 0.1.21 → 0.1.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6df40edef1f8ec088780bf5465eed032d37f853
-  data.tar.gz: b9a2c1fecc384e608aa7fd483fa8af4ad3a7058b
+  metadata.gz: 144ffa9b811678f73e5aaafceb4142e8b55aa1b1
+  data.tar.gz: 743a63ec3d45593af332b52198d8e642ccbb89e9
 SHA512:
-  metadata.gz: 96981103eb1441d212ad4932a3b595a1dca7f1b01fc47bfe4a78a385c96e612dcd685efab2603d8b82501f003f0389766f65b7aeba8081561c5114272392b8a8
-  data.tar.gz: 1b782b8acade363c81060cc31c29ca34fc93a7730f2d4b8df2363308986d6ff160d3d8e5d6e5f2cf84d5590eb505125f3ddc25fa00afcb032518c68df2039e5d
+  metadata.gz: 87c5ac87dfb9c5930b9093161ae9e6b01e827c2b11358feb26acb1aef69366ebeda418bfeb02678643df2ab2f6e30dddd67dc4672faa1bdcc74c75209a0b80b3
+  data.tar.gz: e6149a6e77bfe83400eb8a8badf9439d2cbf96fef79bf7c9e300a9cbaea0658e6a42847c71768ab4c740175ddd04bbea3a62acb072644553b541638f839a8fce

data/README.md

@@ -15,7 +15,7 @@ Ruby client for the DatoCMS API.
 
 This gem can be used in different ways, so the documentation is split up in different files:
 
-* [I want to use the content of a DatoCMS site in my static website (Hugo, Jeckyll, etc.)](https://github.com/datocms/ruby-datocms-client/blob/master/docs/dato-cli.md);
+* [I want to use the content of a DatoCMS site in my static website (Hugo, Jekyll, etc.)](https://github.com/datocms/ruby-datocms-client/blob/master/docs/dato-cli.md);
 * [I want to edit the contents of an existing DatoCMS site  programmatically](https://github.com/datocms/ruby-datocms-client/blob/master/docs/site-api-client.md);
 * [I want to create new DatoCMS sites programmatically](https://github.com/datocms/ruby-datocms-client/blob/master/docs/account-api-client.md).
 

data/docs/dato-cli.md

@@ -45,11 +45,36 @@ DatoCMS commands:
   dato help [COMMAND]      # Describe available commands or one specific command
 ```
 
-Hurray!!
+Great! Now the easiest way to dump all the remote data into local files is to create a `dato.config.rb` file into your project root directory with the following content:
 
-## Step-by-step integration guide
+```ruby
+# dato.config.rb
+dato.available_locales.each do |locale|
+  directory "content/#{locale}" do
+    I18n.with_locale(locale) do
+      create_data_file "site.yml", :yaml, dato.site.to_hash
+      dato.item_types.each do |item_type|
+        create_data_file "#{item_type.api_key}.yml", :yaml, 
+          dato.items_of_type(item_type).map(&:to_hash)
+      end
+    end
+  end
+end
+```
+
+And run the following command:
+
+```
+$ bundle exec dato dump --token=SITE_READONLY_TOKEN 
+```
+
+Hurray! A new `content` directory should have been generated with a Yaml file for each item type and the site itself!
 
-Now, just to make things more down-to-heart, suppose we're working with a Hugo website with the following structure:
+## Hugo step-by-step integration guide
+
+That's just the beginning: it probably makes more sense if you generate local files following the precise guidelines of the static site generator you're using. You can easily configure the `dato.config.rb` file to achieve that.
+
+Just to make things more down-to-heart, suppose we're working with a Hugo website with the following structure:
 
 ```
 .
@@ -71,7 +96,7 @@ Now, just to make things more down-to-heart, suppose we're working with a Hugo w
     └── ...
 ```
 
-Our job is to generate the Markdown files in the `content` directory from the data contained in our DatoCMS site. Also the Toml files contained in the in the `data` directory need the same treatment.
+Our job is to generate the Markdown files in the `content` directory from the data contained in our DatoCMS site. The Toml files contained in the in the `data` directory need to be generated as well.
 
 ### Set up the site
 
@@ -92,9 +117,7 @@ Using the DatoCMS web interface, we first create the following Item types:
 
 ### Writing the config file
 
-We then define how content stored in DatoCMS needs to be translated into local files using a config file placed in your project root folder called `dato.config.rb`.
-
-Let's start with posts:
+We then define how content stored in DatoCMS needs to be translated into local files inside the `dato.config.rb` config file. Let's start with posts:
 
 ```ruby
 directory "content/post" do

data/lib/dato/local/item.rb

@@ -26,9 +26,9 @@ module Dato
 
       def slug(prefix_with_id: true)
         return item_type.api_key.humanize.parameterize if singleton?
-        return id.to_s unless title_attribute
+        return id.to_s unless title_field_api_key
 
-        title = send(title_attribute)
+        title = send(title_field_api_key)
         if title && prefix_with_id
           "#{id}-#{title.parameterize[0..50]}"
         elsif title
@@ -38,6 +38,14 @@ 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
@@ -140,14 +148,6 @@ module Dato
           super
         end
       end
-
-      def title_attribute
-        title_field = fields.find do |field|
-          field.field_type == 'string' &&
-            field.appeareance[:type] == 'title'
-        end
-        title_field && title_field.api_key
-      end
     end
   end
 end

data/lib/dato/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dato
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.22
 platform: ruby
 authors:
 - Stefano Verna
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-08 00:00:00.000000000 Z
+date: 2016-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler