pagemaster 2.0.2 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6cdf1de48e215acc4bc5333aaa696a5f780f60fee31215692c0a1f056086db5
-  data.tar.gz: 77311ef8a70474d8d9fdf0af0a6a03a2c78c8e4102bc77e3af4c58c6bf8954c3
+  metadata.gz: 15e3d4691cda14a252ecc20253c4ce5a9cb99092208503df0b9f2c412b7ec4c5
+  data.tar.gz: 26ae449fe19081b43d10af962ca275734bcdb9fa2ad8d232ee9a6be14f409fef
 SHA512:
-  metadata.gz: 68c63dc08c8246dea2a055e0c97e4be920d7547e3fbee31cae6fe25cf2086f5f50264eef2d76375b660e0a60625e64755dbcc7b7ceb27df31d7b05650b29f9ac
-  data.tar.gz: 3506b331595c280a8f3a3fafedf14c7c6b9d98b0c13e611b7b7cf2ee22e653bfc41264fa5420e1826a72c7df9c6c1c15eb94e1eeafb5f2993c6d781f4034297d
+  metadata.gz: 02cc23dae3ef3d00cf0498f68040f9953207af6134bc880ccd71be63adca6181a7e01359b6a13a722e085cc63125c5c087f76d6046cb624ae5b9eabeeccfbe29
+  data.tar.gz: 2815b7482d9901f5eb105285190d20c46faa5f1f5ca3a8c795ea1821c3a1f657421c2321f9b69f98fb47d67534f1db59677fd808650b483526968ea463cd8a35

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+gemspec
+
+gem 'jekyll', require: false
+gem 'simplecov', require: false

data/lib/pagemaster.rb

@@ -1,90 +1,22 @@
+# frozen_string_literal: true
+
+# stdlib
 require 'csv'
-require 'yaml'
+require 'fileutils'
 require 'json'
-
-include FileUtils
-
-# 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 |c|
-        c.syntax 'pagemaster [options] [args]'
-        c.description 'Generate md pages from collection data.'
-        c.option :no_perma, '--no-permalink', 'Skips adding hard-coded permalink.'
-        c.option :force, '--force', 'Erases pre-existing collection before regenerating.'
-        c.action { |args, options| execute(args, options) }
-      end
-    end
-
-    def execute(args, opts = {})
-      config = YAML.load_file('_config.yml')
-      abort 'Cannot find collections in config' unless config.key?('collections')
-      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'),
-          ext:    config.fetch('permalink', '') == 'pretty' ? '/' : '.html'
-        }
-        data = ingest(meta)
-        generate_pages(name, meta, data, opts)
-      end
-    end
-
-    def ingest(meta)
-      src = "_data/#{meta[:source]}"
-      puts "Processing #{src}...."
-      data = case File.extname(src)
-             when '.csv'
-               CSV.read(src, headers: true).map(&:to_hash)
-             when '.json'
-               JSON.parse(File.read(src).encode('UTF-8'))
-             when '.yml'
-               YAML.load_file(src)
-             else
-               raise 'Collection source must have a valid extension (.csv, .yml, or .json)'
-             end
-      detect_duplicates(meta, data)
-      data
-    rescue StandardError
-      raise "Cannot load #{src}. check for typos and rebuild."
-    end
-
-    def detect_duplicates(meta, data)
-      ids = data.map { |d| d[meta[:data]] }
-      duplicates = ids.detect { |i| ids.count(i) > 1 } || []
-      raise "Your collection duplicate ids: \n#{duplicates}" unless duplicates.empty?
-    end
-
-    def generate_pages(name, meta, data, opts)
-      dir       = "_#{name}"
-      perma     = opts.fetch(:no_perma, meta[:ext])
-
-      if opts.fetch(:force, false)
-        FileUtils.rm_rf(dir)
-        puts "Overwriting #{dir} directory with --force."
-      end
-
-      mkdir_p(dir)
-      data.each do |item|
-        pagename = slug(item.fetch(meta[:id_key]))
-        pagepath = "#{dir}/#{pagename}.md"
-        item['permalink'] = "/#{name}/#{pagename}#{perma}" if perma
-        item['layout']    = meta[:layout]
-        if File.exist?(pagepath)
-          puts "#{pagename}.md already exits. Skipping."
-        else
-          File.open(pagepath, 'w') { |f| f.write("#{item.to_yaml}---") }
-        end
-      end
-    rescue StandardError
-      raise 'Pagemaster exited for some reason, most likely a missing or invalid id_key.'
-    end
-
-    def slug(str)
-      str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
-    end
-  end
-end
+require 'jekyll'
+
+# 3rd party
+require 'rainbow'
+require 'safe_yaml'
+
+# relative
+require 'pagemaster/collection'
+require 'pagemaster/command'
+require 'pagemaster/error'
+require 'pagemaster/site'
+require 'pagemaster/version'
+
+#
+#
+module Pagemaster; end

data/lib/pagemaster/collection.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Pagemaster
+  #
+  #
+  class Collection
+    attr_reader :source, :id_key, :layout, :data, :dir
+
+    #
+    #
+    def initialize(name, config)
+      @name   = name
+      @config = config
+      @source = fetch 'source'
+      @id_key = fetch 'id_key'
+    end
+
+    #
+    #
+    def fetch(key)
+      raise Error::InvalidCollection unless @config.key? key
+
+      @config.dig key
+    end
+
+    #
+    #
+    def ingest_source
+      file = "_data/#{@source}"
+      raise Error::InvalidSource, "Cannot find source file #{file}" unless File.exist? file
+
+      case File.extname file
+      when '.csv'
+        CSV.read(file, headers: true).map(&:to_hash)
+      when '.json'
+        JSON.parse(File.read(file).encode('UTF-8'))
+      when /\.ya?ml/
+        YAML.load_file file
+      else
+        raise Error::InvalidSource, "Collection source #{file} must have a valid extension (.csv, .yml, or .json)"
+      end
+    rescue StandardError
+      raise Error::InvalidSource, "Cannot load #{file}. check for typos and rebuild."
+    end
+
+    #
+    #
+    def validate_data
+      ids = @data.map { |d| d.dig @id_key }
+      raise Error::InvalidCollection, "One or more items in collection '#{@name}' is missing required id for the id_key '#{@id_key}'" unless ids.all?
+
+      duplicates = ids.detect { |i| ids.count(i) > 1 } || []
+      raise Error::InvalidCollection, "The collection '#{@name}' has the follwing duplicate ids for id_key #{@id_key}: \n#{duplicates}" unless duplicates.empty?
+    end
+
+    #
+    #
+    def overwrite_pages
+      return unless @dir
+
+      FileUtils.rm_rf @dir
+      puts Rainbow("Overwriting #{@dir} directory with --force.").cyan
+    end
+
+    #
+    #
+    def generate_pages(opts, collections_dir, source_dir)
+      @opts   = opts
+      @dir    = File.join [source_dir, collections_dir, "_#{@name}"].compact
+
+      overwrite_pages if @opts.fetch :force, false
+      FileUtils.mkdir_p @dir
+      @data = ingest_source
+      validate_data
+
+      @data.map do |d|
+        path = "#{@dir}/#{slug d[@id_key]}.md"
+        d['layout'] = @config['layout'] if @config.key? 'layout'
+        if File.exist? path
+          puts Rainbow("#{path} already exits. Skipping.").cyan
+        else
+          File.open(path, 'w') { |f| f.write("#{d.to_yaml}---") }
+        end
+        path
+      end
+    end
+
+    #
+    #
+    def slug(str)
+      str.downcase.tr(' ', '_').gsub(/[^:\w-]/, '')
+    end
+  end
+end

data/lib/pagemaster/command.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Pagemaster
+  #
+  #
+  class Command < Jekyll::Command
+    def self.init_with_program(prog)
+      prog.command(:pagemaster) do |c|
+        c.syntax 'pagemaster [options] [args]'
+        c.description 'Generate md pages from collection data.'
+        c.option :force, '--force', 'Erases pre-existing collection before regenerating.'
+        c.action do |args, options|
+          site = Pagemaster::Site.new args, options
+          site.generate_pages
+        end
+      end
+    end
+  end
+end

data/lib/pagemaster/error.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Pagemaster
+  module Error
+    #
+    #
+    class RainbowError < StandardError
+      def initialize(msg = '')
+        super(Rainbow(msg).magenta)
+      end
+    end
+
+    #
+    #
+    class InvalidConfig < RainbowError; end
+
+    #
+    #
+    class MissingArgs < RainbowError; end
+
+    #
+    #
+    class InvalidCollection < RainbowError; end
+
+    #
+    #
+    class InvalidArgument < RainbowError; end
+
+    #
+    #
+    class InvalidSource < RainbowError; end
+  end
+end

data/lib/pagemaster/site.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Pagemaster
+  #
+  #
+  class Site
+    attr_reader :config, :args, :opts, :collections
+
+    #
+    #
+    def initialize(args, opts, config = nil)
+      @args             = args
+      @opts             = opts
+      @config           = config || config_from_file
+      @collections      = parse_collections
+      @collections_dir  = @config.dig 'collections_dir'
+      @source_dir       = @config.dig 'source_dir'
+
+      raise Error::MissingArgs, 'You must specify one or more collections after `jekyll pagemaster`' if @args.empty?
+      raise Error::InvalidCollection, "Cannot find collection(s) #{@args} in config" if @collections.empty?
+    end
+
+    #
+    #
+    def config_from_file
+      YAML.load_file "#{`pwd`.strip}/_config.yml"
+    end
+
+    #
+    #
+    def parse_collections
+      collections_config = @config.dig 'collections'
+
+      raise Error::InvalidConfig, "Cannot find 'collections' key in _config.yml" if collections_config.nil?
+
+      args.map do |a|
+        raise Error::InvalidArgument, "Cannot find requested collection #{a} in _config.yml" unless collections_config.key? a
+
+        Collection.new(a, collections_config.fetch(a))
+      end
+    end
+
+    #
+    #
+    def generate_pages
+      paths = @collections.map do |c|
+        c.generate_pages @opts, @collections_dir, @source_dir
+      end.flatten
+      puts Rainbow('Done ✔').green
+
+      paths
+    end
+  end
+end

data/lib/pagemaster/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Pagemaster
+  VERSION = '2.1.2'
+end

data/spec/collection_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+describe Pagemaster::Collection do
+  include_context 'shared'
+  before(:all) { Pagemaster::Test.reset }
+
+  let(:csv_collection)  { site.collections.first }
+  let(:json_collection) { site.collections[1] }
+  let(:yaml_collection) { site.collections.last }
+
+  describe '.new' do
+    context 'with valid config' do
+      it 'gets the source' do
+        expect(csv_collection.source).to be_a String
+      end
+
+      it 'gets the id_key' do
+        expect(csv_collection.id_key).to be_a String
+      end
+    end
+  end
+
+  describe '.ingest_source' do
+    context 'with valid csv collection' do
+      it 'ingests the source file' do
+        result = csv_collection.ingest_source
+
+        expect(result).to be_an Array
+        expect(result.first).to be_a Hash
+      end
+    end
+
+    context 'with valid json collection' do
+      it 'ingests the source file' do
+        result = json_collection.ingest_source
+
+        expect(result).to be_an Array
+        expect(result.first).to be_a Hash
+      end
+    end
+
+    context 'with valid yaml collection' do
+      it 'ingests the source file' do
+        result = yaml_collection.ingest_source
+
+        expect(result).to be_an Array
+        expect(result.first).to be_a Hash
+      end
+    end
+  end
+
+  describe '.overwrite_pages' do
+    context 'if page directory does not exists' do
+      it 'does nothing' do
+        expect { csv_collection.overwrite_pages }.not_to raise_error
+      end
+    end
+
+    it 'removes the page directory' do
+      csv_collection.overwrite_pages
+    end
+  end
+end

data/spec/setup.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+# constants
+ROOT    = `pwd`.strip
+SAMPLE  = "#{ROOT}/spec/sample_site"
+BUILD   = "#{ROOT}/test_build"
+
+# helper methods
+def quiet_stdout
+  if QUIET
+    begin
+      orig_stderr = $stderr.clone
+      orig_stdout = $stdout.clone
+      $stderr.reopen File.new('/dev/null', 'w')
+      $stdout.reopen File.new('/dev/null', 'w')
+      retval = yield
+    rescue StandardError => e
+      $stdout.reopen orig_stdout
+      $stderr.reopen orig_stderr
+      raise e
+    ensure
+      $stdout.reopen orig_stdout
+      $stderr.reopen orig_stderr
+    end
+    retval
+  else
+    yield
+  end
+end
+
+module Pagemaster
+  module Test
+    def self.reset
+      Dir.chdir(ROOT)
+      FileUtils.rm_r(BUILD) if File.directory?(BUILD)
+      FileUtils.copy_entry(SAMPLE, BUILD)
+      Dir.chdir(BUILD)
+    end
+  end
+end

data/spec/site_spec.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+describe Pagemaster::Site do
+  include_context 'shared'
+  before(:all) { Pagemaster::Test.reset }
+
+  describe '.new' do
+    it 'runs without errors' do
+      expect(site).to be_a Pagemaster::Site
+    end
+
+    it 'parses the config' do
+      expect(site.config).to be_a Hash
+      expect(site.config).to eq config
+    end
+
+    it 'parses the args' do
+      expect(site.args).to be_an Array
+      expect(site.args).to eq args
+    end
+
+    it 'parses the opts' do
+      expect(site.opts).to be_a Hash
+      expect(site.opts). to eq opts
+    end
+
+    it 'parses the collections' do
+      expect(site.collections).to be_an Array
+      expect(site.collections.first).to be_a Pagemaster::Collection
+    end
+
+    context 'when given invalid args' do
+      it 'throws an error' do
+        expect { Pagemaster::Site.new(['bad_arg'], opts) }.to raise_error Pagemaster::Error::InvalidArgument
+      end
+    end
+  end
+
+  describe '.generate_pages' do
+    it 'generates expected pages' do
+      expect(site.generate_pages).to eq page_paths
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter 'spec'
+end
+
+require File.expand_path('../lib/pagemaster.rb', __dir__)
+require 'pagemaster'
+require 'setup'
+
+shared_context 'shared', shared_context: :metadata do
+  let(:args)    { %w[csv_collection json_collection yaml_collection] }
+  let(:config)  { YAML.load_file "#{BUILD}/_config.yml" }
+  let(:opts)    { {} }
+  let(:site)    { Pagemaster::Site.new args, opts }
+  let(:page_paths) do
+    ['_csv_collection/img_item_1.md',
+     '_csv_collection/img_item_2.md',
+     '_csv_collection/dir_imgs_item.md',
+     '_csv_collection/pdf_imgs_item.md',
+     '_json_collection/img_item_1.md',
+     '_json_collection/img_item_2.md',
+     '_json_collection/dir_imgs_item.md',
+     '_json_collection/pdf_imgs_item.md',
+     '_yaml_collection/img_item_1.md',
+     '_yaml_collection/img_item_2.md',
+     '_yaml_collection/dir_imgs_item.md',
+     '_yaml_collection/pdf_imgs_item.md']
+  end
+end
+
+require 'collection_spec'
+require 'site_spec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagemaster
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.2
 platform: ruby
 authors:
 - Marii Nyrop
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rainbow
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: safe_yaml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -86,7 +86,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
 - lib/pagemaster.rb
+- lib/pagemaster/collection.rb
+- lib/pagemaster/command.rb
+- lib/pagemaster/error.rb
+- lib/pagemaster/site.rb
+- lib/pagemaster/version.rb
+- spec/collection_spec.rb
+- spec/setup.rb
+- spec/site_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/mnyrop/pagemaster
 licenses:
 - MIT
@@ -99,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -107,8 +117,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.6.2
 signing_key: 
 specification_version: 4
 summary: jekyll pagemaster plugin
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/collection_spec.rb
+- spec/site_spec.rb
+- spec/setup.rb