RubyGems - pagemaster - Versions diffs - 1.0.0 → 2.0.0 - Mend

pagemaster 1.0.0 → 2.0.0

Files changed (3) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 85693645a299d6fdaf96300cac4bb14965a30ec8
-  data.tar.gz: 5ded4953bc2f0f3fb9a44766c0074dbf8b9e58e3
+SHA256:
+  metadata.gz: 1cc95d2a656139e4ac5f4487d2ee34259e953a949021a1b3885a2e4ee3124250
+  data.tar.gz: 3270dd906aae58e82ec50dab84b98a45dfee552583de3e2636e14d3ef362748e
 SHA512:
-  metadata.gz: d684b86103dc4dbb49e5d019c6a69ae1d4b1b121fa5813ce216fb1b9d3831baa7108f2eeca0e5590967208e1a4574cf5f8583078aba54d035c8bc42ea5d2923d
-  data.tar.gz: 077cc16aa4c5a9b51540b88d979ab517aeff689f70720d9da1c72495d70bc29b2f185e72294241154300180d48506cdf222eb5b8834100d298d35f2770efb89a
+  metadata.gz: 91177001b1b99318b88324b8cc20fffd16eb3fc6756cecb08bf405f45aac74122dcf845fd9e3737f5a86ef0c49acb6d20ae34c9db805ac07c13d0205831c45da
+  data.tar.gz: a44434fefa5681e38ba6405243d2930a3076a02724756d738289a1f94f19676b63e5fb29a8d0cd59f51881d6ad00f0ce89cbb314f74fd95baf8b2a719e6efd58

data/lib/pagemaster.rb CHANGED Viewed

@@ -1,103 +1,83 @@
-require 'yaml'
+include FileUtils
 require 'csv'
+require 'yaml'
+require 'json'
-Jekyll::Hooks.register :site, :after_reset do |site| # when site is re/built
-	for collection in site.collections
-		collection = collection[1]
-		if collection.metadata["output"] && collection.metadata["pm_generate"]
-			# grab collection variables from config
-			@input = collection.metadata["pm_input"].to_s
-			@dir = collection.metadata["pm_directory"].to_s
-			@name_key = collection.metadata["pm_key"].to_s
-			@src = collection.metadata["pm_source"].to_s
-			@layout = collection.metadata["pm_layout"].to_s
-			@layout ||= @src
-			@src = @src + "." + @input
-      # check if input is csv or yaml
-      unless @input == 'yaml' or @input == 'csv'
-        raise "pagemaster :: Input must be 'csv' or 'yaml'."
+# Jekyll comand to generate markdown collection pages from CSV/YML/JSON records
+class Pagemaster < Jekyll::Command
+  class << self
+    def init_with_program(prog)
+      prog.command(:pagemaster) do |command|
+        command.syntax 'pagemaster [options]'
+        command.description 'Generate md pages from collection data.'
+        command.action do |args|
+          execute(args)
+        end
       end
+    end
-			# check usability of dir name. gsub alphanumerics to (especially) avoid leading double underscores. then make directory.
-			if @dir.empty?
-				raise "pagemaster :: Target directory is undefined or unusable. Cannot generate pages. Specify dir in config and rebuild."
-			else
-				@targetdir = "_" + @dir.downcase.gsub(/[^\0-9a-z]/, '').to_s
-				FileUtils::mkdir_p @targetdir
-				puts ">> pagemaster :: Made directory " + @targetdir + " in root."
-			end
-			# check usability of name_key, to be used later when naming generated pages
-			if @name_key.empty?
-				raise "pagemaster ::  pm_key is undefined or unusable. Cannot generate pages. Specify pm_key in config and rebuild."
-			end
-			def ingest(src) # takes + opens src file
-				begin
-					puts ">> pagemaster :: Loaded " + src + "."
-          if @input == 'yaml'
-            return YAML.load_file('_data/' + src)
-          else
-            return CSV.read('_data/' + src, :headers => true).map(&:to_hash)
-          end
-				rescue
-					raise "pagemaster :: Cannot load " + src + ". Check for typos and rebuild."
-				end
-			end
-			def uniqify(hashes, key) # takes opened src file as hash array
-				occurences = {} # hash list of slug names and # of occurences
-				hashes.each do |item|
-					if item[key].nil?
-						raise "pagemaster :: Source file has at least one missing value for pm_key='" + key + "'. Cannot generate page."
-					end
-					new_name = item[key].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '').gsub(/-+/, '-') # gsub for slug
-					if occurences.has_key? new_name
-						occurences[new_name]+=1
-						safe_slug = new_name + "-" + occurences[new_name].to_s
-					else
-						occurences.store(new_name, 1)
-						safe_slug = new_name
-					end
-					item.store("slug", safe_slug)
-				end
-				return hashes # return changed yml array with unique, slugified names added
-			end
+    def execute(args)
+      config = YAML.load_file('_config.yml')
+      abort 'Cannot find collections in config' unless config.key?('collections')
+      perma = config['permalink'] == 'pretty' ? '/' : '.html'
+      args.each do |name|
+        abort "Cannot find #{name} in collection config" unless config['collections'].key? name
+        meta = {
+          'id_key'  => config['collections'][name].fetch('id_key'),
+          'layout'  => config['collections'][name].fetch('layout'),
+          'source'  => config['collections'][name].fetch('source')
+        }
+        data = ingest(meta)
+        generate_pages(name, meta, data, perma)
+      end
+    end
-			# ingest data source, sort it and generate unique titles
-			data = uniqify(ingest(@src), @name_key)
+    def ingest(meta)
+      src = '_data/' + meta['source']
+      puts "Processing #{src}...."
+      case File.extname(src)
+      when '.csv' then data = CSV.read(src, headers: true, encoding: 'utf-8').map(&:to_hash)
+      when '.json' then data = JSON.parse(File.read(src).encode('UTF-8'))
+      when '.yml' then data = YAML.load_file(src)
+      else abort 'Collection source must have a valid extension (.csv, .yml, or .json)'
+      end
+      detect_duplicates(meta, data)
+      data
+    rescue StandardError
+      abort "Cannot load #{src}. check for typos and rebuild."
+    end
-			# keep track of (valid) pages generated vs. (untitled, nonunique) pages skipped.
-			untitled, nonunique, valid = 0, 0, 0
+    def detect_duplicates(meta, data)
+      ids = []
+      data.each { |d| ids << d[meta['id_key']] }
+      duplicates = ids.detect { |i| ids.count(i) > 1 } || []
+      abort "Your collection duplicate ids: \n#{duplicates}" unless duplicates.empty?
+    end
-			# make pages
-			data.each do |item|
-				pagename = item["slug"]
-				pagepath = @targetdir + "/" + pagename + ".md"
-				layout_str = ""
-				unless @layout.empty?
-					layout_str = "layout: " + @layout
-				end
-				if pagename.empty?
-					puts ">> pagemaster :: Title for item is unspecified. Cannot generate page."
-					untitled+=1
-				elsif !File.exist?(pagepath)
-					File.open(pagepath, 'w') { |file| file.write( item.to_yaml.to_s + layout_str + "\n---" ) }
-					valid+=1
-				else
-					puts ">> pagemaster :: " + pagename + ".md already exits."
-					nonunique+=1
-				end
-			end
+    def generate_pages(name, meta, data, perma)
+      completed = 0
+      skipped = 0
+      dir = '_' + name
+      mkdir_p(dir)
+      data.each do |item|
+        pagename = slug(item.fetch(meta['id_key']))
+        pagepath = dir + '/' + pagename + '.md'
+        item['permalink'] = '/' + name + '/' + pagename + perma
+        item['layout'] = meta['layout']
+        if File.exist?(pagepath)
+          puts "#{pagename}.md already exits. Skipping."
+          skipped += 1
+        else
+          File.open(pagepath, 'w') { |file| file.write(item.to_yaml.to_s + '---') }
+          completed += 1
+        end
+      end
+    rescue StandardError
+      abort 'Pagemaster exited for some reason, most likely a missing or invalid id_key.'
+    end
-			# log outcomes
-			puts ">> pagemaster :: " + valid.to_s + " pages were generated from " + @src + " to " + @targetdir + " directory."
-			puts ">> pagemaster :: " + nonunique.to_s + " items were skipped because of non-unique names."
-			puts ">> pagemaster :: " + untitled.to_s + " items were skipped because of missing titles."
-		end
-	end
+    def slug(str)
+      str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
+    end
+  end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pagemaster
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Marii Nyröp
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-10-30 00:00:00.000000000 Z
+date: 2018-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -24,7 +24,63 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: jekyll .md page generator plugin from csv or yaml files
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: jekyll plugin for generating md pages from csv/json/yml
 email:
 executables: []
 extensions: []
@@ -51,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key:
 specification_version: 4
 summary: jekyll pagemaster plugin