pagemaster 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 85693645a299d6fdaf96300cac4bb14965a30ec8
+  data.tar.gz: 5ded4953bc2f0f3fb9a44766c0074dbf8b9e58e3
+SHA512:
+  metadata.gz: d684b86103dc4dbb49e5d019c6a69ae1d4b1b121fa5813ce216fb1b9d3831baa7108f2eeca0e5590967208e1a4574cf5f8583078aba54d035c8bc42ea5d2923d
+  data.tar.gz: 077cc16aa4c5a9b51540b88d979ab517aeff689f70720d9da1c72495d70bc29b2f185e72294241154300180d48506cdf222eb5b8834100d298d35f2770efb89a

data/lib/pagemaster.rb

@@ -0,0 +1,103 @@
+require 'yaml'
+require 'csv'
+
+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'."
+      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
+
+			# ingest data source, sort it and generate unique titles
+			data = uniqify(ingest(@src), @name_key)
+
+			# keep track of (valid) pages generated vs. (untitled, nonunique) pages skipped.
+			untitled, nonunique, valid = 0, 0, 0
+
+			# 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
+
+			# 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
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: pagemaster
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marii Nyröp
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: jekyll .md page generator plugin from csv or yaml files
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pagemaster.rb
+homepage: https://github.com/mnyrop/pagemaster
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: jekyll pagemaster plugin
+test_files: []