ottogen 0.1.0 → 1.0.0

data/spec/ottogen/config_spec.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+RSpec.describe Ottogen::Config do
+  describe '.load' do
+    it 'reads top-level keys from config.yml' do
+      in_tmp_dir do
+        File.write('config.yml', <<~YAML)
+          title: My Site
+          description: An Otto site
+          url: https://example.com
+          baseurl: /blog
+        YAML
+
+        config = described_class.load
+
+        expect(config['title']).to eq('My Site')
+        expect(config['description']).to eq('An Otto site')
+        expect(config['url']).to eq('https://example.com')
+        expect(config['baseurl']).to eq('/blog')
+      end
+    end
+
+    it 'exposes arbitrary custom keys' do
+      in_tmp_dir do
+        File.write('config.yml', <<~YAML)
+          author: Ada Lovelace
+          twitter: ada
+        YAML
+
+        config = described_class.load
+
+        expect(config['author']).to eq('Ada Lovelace')
+        expect(config['twitter']).to eq('ada')
+      end
+    end
+
+    it 'raises Ottogen::Config::Error when config.yml is missing' do
+      in_tmp_dir do
+        expect { described_class.load }.to raise_error(Ottogen::Config::Error)
+      end
+    end
+
+    it 'raises Ottogen::Config::Error when config.yml is malformed YAML' do
+      in_tmp_dir do
+        File.write('config.yml', "title: 'unclosed\n")
+
+        expect { described_class.load }.to raise_error(Ottogen::Config::Error)
+      end
+    end
+
+    it 'treats an empty config.yml as an empty config' do
+      in_tmp_dir do
+        File.write('config.yml', '')
+
+        config = described_class.load
+
+        expect(config['title']).to be_nil
+        expect(config.asciidoctor_attributes).to eq({})
+      end
+    end
+  end
+
+  describe '#asciidoctor_attributes' do
+    it 'prefixes every key with site_' do
+      in_tmp_dir do
+        File.write('config.yml', <<~YAML)
+          title: Otto
+          author: Ada
+        YAML
+
+        attrs = described_class.load.asciidoctor_attributes
+
+        expect(attrs).to eq('site_title' => 'Otto', 'site_author' => 'Ada')
+      end
+    end
+  end
+
+  describe '#data' do
+    it 'reads .yml files from _data/ as data.<name>' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_data')
+        File.write('_data/nav.yml', "- title: Home\n  url: /\n- title: About\n  url: /about\n")
+
+        config = described_class.load
+
+        expect(config.data.nav).to eq([{ 'title' => 'Home', 'url' => '/' },
+                                       { 'title' => 'About', 'url' => '/about' }])
+      end
+    end
+
+    it 'reads .json files from _data/ as data.<name>' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_data')
+        File.write('_data/items.json', '[{"name":"one"},{"name":"two"}]')
+
+        config = described_class.load
+
+        expect(config.data.items).to eq([{ 'name' => 'one' }, { 'name' => 'two' }])
+      end
+    end
+
+    it 'supports both .yml and .yaml extensions' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_data')
+        File.write('_data/short.yml', "key: yml\n")
+        File.write('_data/long.yaml', "key: yaml\n")
+
+        config = described_class.load
+
+        expect(config.data.short).to eq('key' => 'yml')
+        expect(config.data.long).to eq('key' => 'yaml')
+      end
+    end
+
+    it 'returns empty data when _data/ is missing or empty' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+
+        config = described_class.load
+
+        expect(config.data['nav']).to be_nil
+      end
+    end
+
+    it 'raises Config::Error for a malformed data file (with file path in message)' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_data')
+        File.write('_data/bad.yml', "title: 'unclosed\n")
+
+        expect { described_class.load }
+          .to raise_error(Ottogen::Config::Error, %r{_data/bad\.yml})
+      end
+    end
+
+    it 'exposes entries via both [] and method_missing' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_data')
+        File.write('_data/nav.yml', "- title: Home\n")
+
+        data = described_class.load.data
+
+        expect(data['nav']).to eq([{ 'title' => 'Home' }])
+        expect(data.nav).to eq([{ 'title' => 'Home' }])
+      end
+    end
+  end
+
+  describe '#posts' do
+    it 'exposes site.posts sorted by date descending' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-old.adoc', "= Old\n")
+        File.write('_posts/2026-02-15-new.adoc', "= New\n")
+        File.write('_posts/2026-01-30-mid.adoc', "= Mid\n")
+
+        slugs = described_class.load.posts.map(&:slug)
+
+        expect(slugs).to eq(%w[new mid old])
+      end
+    end
+
+    it 'excludes drafts by default' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_posts')
+        FileUtils.mkdir_p('_drafts')
+        File.write('_posts/2026-01-15-real.adoc', "= R\n")
+        File.write('_drafts/wip.adoc', "= D\n")
+
+        slugs = described_class.load.posts.map(&:slug)
+
+        expect(slugs).to eq(%w[real])
+      end
+    end
+
+    it 'includes drafts when loaded with drafts: true' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_posts')
+        FileUtils.mkdir_p('_drafts')
+        File.write('_posts/2020-01-01-real.adoc', "= R\n")
+        File.write('_drafts/wip.adoc', "= D\n")
+
+        slugs = described_class.load(drafts: true).posts.map(&:slug)
+
+        expect(slugs).to contain_exactly('real', 'wip')
+      end
+    end
+  end
+
+  describe '#tags' do
+    it 'is a hash of tag string to posts that have that tag' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-a.adoc', "---\ntags: [ruby, cli]\n---\nA\n")
+        File.write('_posts/2026-02-15-b.adoc', "---\ntags: [ruby]\n---\nB\n")
+
+        tags = described_class.load.tags
+
+        expect(tags.keys).to contain_exactly('ruby', 'cli')
+        expect(tags['ruby'].map(&:slug)).to contain_exactly('a', 'b')
+        expect(tags['cli'].map(&:slug)).to eq(['a'])
+      end
+    end
+  end
+
+  describe '#categories' do
+    it 'is a hash of category string to posts in that category' do
+      in_tmp_dir do
+        File.write('config.yml', "title: T\n")
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-a.adoc', "---\ncategories: [dev]\n---\nA\n")
+        File.write('_posts/2026-02-15-b.adoc', "---\ncategories: [dev, ruby]\n---\nB\n")
+
+        cats = described_class.load.categories
+
+        expect(cats['dev'].map(&:slug)).to contain_exactly('a', 'b')
+        expect(cats['ruby'].map(&:slug)).to eq(['b'])
+      end
+    end
+  end
+
+  describe '#collections' do
+    it 'exposes site.<collection_name> as the items array' do
+      in_tmp_dir do
+        File.write('config.yml', <<~YAML)
+          title: T
+          collections:
+            recipes:
+              output: true
+        YAML
+        FileUtils.mkdir_p('_recipes')
+        File.write('_recipes/pizza.adoc', "= Pizza\n")
+        File.write('_recipes/bread.adoc', "= Bread\n")
+
+        config = described_class.load
+
+        expect(config.recipes.map(&:slug)).to contain_exactly('pizza', 'bread')
+      end
+    end
+  end
+end

data/spec/ottogen/layout_spec.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+RSpec.describe Ottogen::Layout do
+  describe '.find' do
+    it 'loads a layout from _layouts/<name>.html.erb' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', '<html><%= content %></html>')
+
+        layout = described_class.find('default')
+
+        expect(layout.name).to eq('default')
+      end
+    end
+
+    it 'raises Layout::Error when the layout file is missing' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+
+        expect { described_class.find('missing') }.to raise_error(Ottogen::Layout::Error)
+      end
+    end
+
+    it 'parses YAML front matter on layout files' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/post.html.erb', "---\nlayout: default\n---\n<article><%= content %></article>")
+
+        layout = described_class.find('post')
+
+        expect(layout.front_matter).to eq('layout' => 'default')
+      end
+    end
+  end
+
+  describe '#render' do
+    let(:site) { Ottogen::Config.new('title' => 'My Site') }
+    let(:page) { Ottogen::Page.new(front_matter: { 'title' => 'My Page' }, body: '') }
+
+    it 'substitutes <%= content %> with the given content' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', '<html><body><%= content %></body></html>')
+
+        layout = described_class.find('default')
+        result = layout.render(content: '<p>Hi</p>', site: site, page: page)
+
+        expect(result).to eq('<html><body><p>Hi</p></body></html>')
+      end
+    end
+
+    it 'exposes site.<key> from the config' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', '<title><%= site.title %></title>')
+
+        result = described_class.find('default').render(content: '', site: site, page: page)
+
+        expect(result).to eq('<title>My Site</title>')
+      end
+    end
+
+    it 'exposes page.<key> from page front matter' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', '<h1><%= page.title %></h1>')
+
+        result = described_class.find('default').render(content: '', site: site, page: page)
+
+        expect(result).to eq('<h1>My Page</h1>')
+      end
+    end
+
+    it 'chains parent layouts via front matter layout: key' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', '<html><body><%= content %></body></html>')
+        File.write('_layouts/post.html.erb', "---\nlayout: default\n---\n<article><%= content %></article>")
+
+        result = described_class.find('post').render(content: '<p>Hi</p>', site: site, page: page)
+
+        expect(result).to eq('<html><body><article><p>Hi</p></article></body></html>')
+      end
+    end
+
+    it 'embeds an _includes/<name> partial via partial(...)' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_includes')
+        File.write('_includes/header.html', '<header>Top</header>')
+        File.write('_layouts/default.html.erb', "<%= partial 'header.html' %><%= content %>")
+
+        result = described_class.find('default').render(content: '<p>Hi</p>', site: site, page: page)
+
+        expect(result).to eq('<header>Top</header><p>Hi</p>')
+      end
+    end
+
+    it 'allows partials to reference site.<key>' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_includes')
+        File.write('_includes/header.html', '<title><%= site.title %></title>')
+        File.write('_layouts/default.html.erb', "<%= partial 'header.html' %>")
+
+        result = described_class.find('default').render(content: '', site: site, page: page)
+
+        expect(result).to eq('<title>My Site</title>')
+      end
+    end
+
+    it 'allows partials to reference page.<key>' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_includes')
+        File.write('_includes/header.html', '<h1><%= page.title %></h1>')
+        File.write('_layouts/default.html.erb', "<%= partial 'header.html' %>")
+
+        result = described_class.find('default').render(content: '', site: site, page: page)
+
+        expect(result).to eq('<h1>My Page</h1>')
+      end
+    end
+
+    it 'allows partials to include other partials' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_includes')
+        File.write('_includes/inner.html', '<span>inner</span>')
+        File.write('_includes/outer.html', "<div><%= partial 'inner.html' %></div>")
+        File.write('_layouts/default.html.erb', "<%= partial 'outer.html' %>")
+
+        result = described_class.find('default').render(content: '', site: site, page: page)
+
+        expect(result).to eq('<div><span>inner</span></div>')
+      end
+    end
+
+    it 'raises Layout::Error when an include is missing' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', "<%= partial 'missing.html' %>")
+
+        expect do
+          described_class.find('default').render(content: '', site: site, page: page)
+        end.to raise_error(Ottogen::Layout::Error)
+      end
+    end
+  end
+end