jekyll-airtable 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b5d3193ed1ef6eb2ff3a561eac88eda5304ee6de
-  data.tar.gz: aa1721c7f178f12ff151ced96e49a0bb29397161
+  metadata.gz: 8823b75bac320ee91a3c9e2047d939f454dbe5ee
+  data.tar.gz: d05f45a5710a493dca9bafcfe944a29ca5065ad8
 SHA512:
-  metadata.gz: 2b0e29168c98a7b926b400f0e2ddf7cd7b21f9041961bfc8744aa037690292246bf75101d2f134da8570e2590d999275abcecf00f031620e9e47ecb4a7c9760e
-  data.tar.gz: 42f9c568fef5fafc2dfeff8ddbeb3a25754dce5473a985a4df509a04220156800ff2d2a7742be6d028511306137698b6e4655786643eee357d9e4b38d89b4aa1
+  metadata.gz: de5626a0609472cf9214c3fd87050eed7af1dae916ae7a3f0265911e6cba54763c2d0ed5009aeadf41e85fe593b3f1a609eaea1d1fe06b75f389760567cfb914
+  data.tar.gz: '09e5a93c147c5bb9aa19fd92f77896206dbcaeaede8563b1cde77796c844958b9e0cc98467e5a32cf4a67d482f921deac7c76157597f47b0974e577b611fb04d'

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    jekyll-airtable (0.3.0)
+    jekyll-airtable (0.4.1)
       faraday (~> 0.11.0)
       faraday_middleware (~> 0.10.1)
+      hashie
       jekyll (~> 3.3)
 
 GEM
@@ -26,10 +27,11 @@ GEM
       faraday (>= 0.7.4, < 1.0)
     ffi (1.9.25)
     forwardable-extended (2.6.0)
+    hashie (3.6.0)
     http_parser.rb (0.6.0)
     i18n (0.9.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.8.3)
+    jekyll (3.8.4)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -77,7 +79,7 @@ GEM
     rspec-support (3.8.0)
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
-    sass (3.5.7)
+    sass (3.6.0)
       sass-listen (~> 4.0.0)
     sass-listen (4.0.0)
       rb-fsevent (~> 0.9, >= 0.9.4)

data/README.md

@@ -27,11 +27,11 @@ run bundle install again
 .env
 ```
 
-3. Copy the .env.example in this repo to the root of your project, rename it to .env then fill it for your needs.
-4. Set the SYNC_WITH_AIRTABLE key in the .env to 'true'
+3. Copy the .env.example in this repo to the root of your project, rename it to .env.
+4. Set your Airtable API Key in the .env
 
 ```
-SYNC_WITH_AIRTABLE='true'
+AIRTABLE_API_KEY='your_airtable_api_key'
 ```
 
 5. You need to add a custom plugin to get the dotenv to work, you do this by creating a folder ```_plugins``` (if does not exist already) inside your Jekyll repo
@@ -49,10 +49,7 @@ module Jekyll
       Dotenv.overload
       site.config['env'] = Dotenv.overload
 
-      site.config['SYNC_WITH_AIRTABLE'] = ENV['SYNC_WITH_AIRTABLE']
       site.config['AIRTABLE_API_KEY']   = ENV['AIRTABLE_API_KEY']
-      site.config['AIRTABLE_BASE_UID']  = ENV['AIRTABLE_BASE_UID']
-      site.config['AIRTABLE_TABLE_NAMES'] = ENV['AIRTABLE_TABLE_NAMES'].split(',').map(&:strip)
     end
   end
 end
@@ -60,11 +57,21 @@ end
 
 Now the secret keys can be accessed by Jekyll without being visible to the public.
 
-7. Now, you need to declare the plugins in the config.yml
+7. Now, you need to declare and hook the plugins in the config.yml
 ```yml
 plugins:
   - jekyll-airtable
   - environment_variables_generator
+
+airtable:
+  enable_sync: true
+  base_uid: 'appp7C1MblPCnMePn'
+  tables:
+    - name: 'Use Cases' 
+    - name: 'Whitepapers'    
+    - name: 'Quotes'
+      long_text_columns:
+        - 'column name'
 ```
 
 8. Finally, you can execute the plugin using ```sh bundle exec jekyll serve ``` or ```sh bundle exec jekyll build ```
@@ -80,8 +87,6 @@ collections:
     output: true
   whitepapers:
     output: true
-  tutorials:
-    output: true
 
 defaults:
   - scope:
@@ -90,6 +95,18 @@ defaults:
       layout: "page" # any jekyll layout file you already have in the _layouts that you want to use for this collection type.
 ```
 
+
+## Conventions
+
+There are a number of "enforced" conventions you have to know and can take advantage of. 
+
+1. By default, the slug of the record (which is the file name) come from this sources, in order of priority: 1) The column labelled 'Slug' / 'slug' in your Airtable table, 2) The primary key of each row (the first column on each table), 3) or the Airtable UID of the record. So if you want to set each record's slug manually, you can do so by creating slug column in your Airtable table.**GOTCHA:** Should slugs that are derived from priority 1 and 2 are both longer than 100 char, then it will automatically use the Airtable UID.
+
+2. Attachments are not copied into your Jekyll repo but their informations, such as url and so on, will be stored in "_data/airtable/attachments.yml_" folder, if none exist before, this plugin will automatically create it for you.
+
+
+3. Long text with paragraphs are now supported.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/jekyll-airtable.gemspec

@@ -30,5 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "dotenv"
   spec.add_dependency 'faraday', '~> 0.11.0'
   spec.add_dependency 'faraday_middleware', '~>  0.10.1'
-  spec.add_dependency "jekyll", "~> 3.3"  
+  spec.add_dependency "jekyll", "~> 3.3"
+  spec.add_dependency "hashie"
 end

data/lib/jekyll-airtable/version.rb

@@ -1,5 +1,5 @@
 module Jekyll
   module Airtable
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/lib/jekyll/airtable_fetcher.rb

@@ -1,6 +1,8 @@
 require "json"
 require 'fileutils'
 require 'yaml'
+require 'hashie'
+require 'uri'
 
 module Jekyll
   class AirtableFetcher < Jekyll::Generator
@@ -8,44 +10,42 @@ module Jekyll
     priority :lowest      
 
     def generate(site)
-      return false if site.config['AIRTABLE_API_KEY'].nil? || site.config['AIRTABLE_API_KEY'] == ''
-      return false if site.config['SYNC_WITH_AIRTABLE'] == 'false'
-
-      setup_directories
+      jekyll_config = Hashie::Mash.new(site.config) 
+      return false if should_generate_be_prevented?(jekyll_config)
       # For storing hashes of attachments that will be saved to the data file
       @attachments_hash = {}
+      setup_directories
 
-      Airtable.configure do |config|
-        config.api_key = site.config['AIRTABLE_API_KEY']
-      end
-
-      client = Airtable.client(base_uid: site.config['AIRTABLE_BASE_UID'])      
+      client = setting_up_airtable_client
 
-      site.config['AIRTABLE_TABLE_NAMES'].each do |table_name|
+      @table_names.each do |table_name|
         records = client.list_records(table_name: table_name)
         next if records.size == 0
+        
+        if records.class.name == 'Hash'
+          error = records["error"]
+          if error.present?
+            puts error['message']
+            next
+          end
+        end
 
         directory_name = "collections/_" + to_snake(table_name)
         Dir.mkdir(directory_name) unless File.exists?(directory_name)
 
         records.each do |record|
           fields    = record['fields']
-          # We use the first field as the primary key
-          # Then find the value of the primary key to be stored as the slug, which
-          # will be used as file name and the path to the record in the url.
-          # However, if the record has field called 'slug', it will be used instead
-          pkey      = fields.keys.first
-          slug      = fields['slug'].nil? ? fields[pkey] : fields['slug']
-          filename  = to_snake(slug) + '.md'
           uid       = record['id']
-
-          out_file  = File.new("#{directory_name}/#{filename}", "w")
-          out_file.puts(front_matter_mark)
-          out_file.puts("uid: #{uid}")
+          out_file  = create_page_for_the_record(directory_name, uid, fields)
 
           fields.each do |key, value|
             snake_key = to_snake(key)
 
+            if is_a_long_text?(jekyll_config, table_name, key)
+              write_long_text_to_file(snake_key, value, out_file)
+              next
+            end
+
             if value.class.name == 'Array'
               out_file.puts("#{snake_key}:")
               write_array_values(out_file, value)
@@ -62,11 +62,29 @@ module Jekyll
         end
       end
 
-      write_attachments_data_file
+      write_attachments_data_file if @attachments_hash.keys.size > 0
     end
 
     private
 
+    def should_generate_be_prevented?(config)
+      is_enabled    = config.airtable.enable_sync
+      return true if !is_enabled
+
+      @api_key      = config.to_hash['AIRTABLE_API_KEY']
+      @base_uid     = config.airtable.base_uid
+      @table_names  = config.airtable.tables.map{ |t| t.name }
+
+      return true if @api_key.nil? || @api_key == '' || @base_uid.nil? || @base_uid == ''
+      false
+    end
+
+    def setting_up_airtable_client
+      Airtable.configure { |config| config.api_key = @api_key }
+
+      Airtable.client(base_uid: @base_uid)
+    end
+
     def front_matter_mark
       '---'
     end
@@ -75,6 +93,10 @@ module Jekyll
       string.split(' ').map(&:downcase).join('_')
     end
 
+    def to_dash(string)
+      string.split(' ').map(&:downcase).join('-')
+    end    
+
     def write_array_values(file, array)
       array.each do |element|
         if is_this_is_an_attachment?(element)
@@ -113,7 +135,7 @@ module Jekyll
       Dir.mkdir('_data') unless File.exists?('_data')
       Dir.mkdir('_data/airtable') unless File.exists?('_data/airtable')      
 
-      Dir.mkdir('collections') unless File.exists?('collections')      
+      Dir.mkdir('collections') unless File.exists?('collections')
     end
 
     def write_attachments_data_file
@@ -121,5 +143,58 @@ module Jekyll
         f.write(@attachments_hash.to_yaml)
       end
     end
+
+    def create_page_for_the_record(directory_name, uid, fields)
+      # We use the first field as the primary key
+      # Then find the value of the primary key to be stored as the slug, which
+      # will be used as file name and the path to the record in the url.
+      # However, if the record has field called 'slug', it will be used instead
+      pkey      = fields.keys.first
+      slug      = fields['slug'].nil? ? fields[pkey] : fields['slug']
+      slug      = slug.length > 100 ? uid : slug
+      
+      if is_an_uri?(slug)
+        filename  = to_dash(slug) + '.md'
+      else
+        filename  = to_dash(uid) + '.md'
+      end
+
+      out_file  = File.new("#{directory_name}/#{filename}", "w")
+      out_file.puts(front_matter_mark)
+      out_file.puts("uid: #{uid}")
+
+      out_file
+    end
+
+    def is_a_long_text?(config, table_name, key)
+      table = config.airtable.tables.select{ |a| a.name == table_name }.first
+      return false if table.nil?
+
+      list  = table.long_text_columns || []
+      list.include?(key)
+    end
+
+    def write_long_text_to_file(snake_key, text, out_file)
+      out_file.puts("#{snake_key}: |")
+
+      lines = text.split("\n")
+
+      lines.each do |line|
+        out_file.puts("  " + line)
+      end
+    end
+
+    def is_an_uri?(string)
+      return true if  string.include?('http') || 
+                      string.include?('://') || 
+                      string.include?('www.')
+
+      uri = URI.parse(string)
+      %w( http https ).include?(uri.scheme)
+    rescue URI::BadURIError
+      false
+    rescue URI::InvalidURIError
+      false
+    end    
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-airtable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Galih Muhammad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-16 00:00:00.000000000 Z
+date: 2018-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Airtable support in Jekyll site to easily fetch and store data
 email:
 - galih0muhammad@gmail.com