RubyGems - ottogen - Versions diffs - 0.1.0 → 1.0.0 - Mend

ottogen 0.1.0 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

checksums.yaml +4 -4
data/README.md +59 -43
data/bin/otto +1 -0
data/lib/ottogen/collection.rb +35 -0
data/lib/ottogen/collection_item.rb +61 -0
data/lib/ottogen/config.rb +126 -0
data/lib/ottogen/front_matter.rb +30 -0
data/lib/ottogen/layout.rb +65 -0
data/lib/ottogen/otto.rb +36 -15
data/lib/ottogen/ottogen.rb +168 -28
data/lib/ottogen/page.rb +58 -0
data/lib/ottogen/permalink.rb +35 -0
data/lib/ottogen/post.rb +108 -0
data/lib/ottogen/scaffold.rb +50 -0
data/spec/ottogen/collection_spec.rb +61 -0
data/spec/ottogen/config_spec.rb +249 -0
data/spec/ottogen/layout_spec.rb +150 -0
data/spec/ottogen/ottogen_spec.rb +430 -5
data/spec/ottogen/page_spec.rb +101 -0
data/spec/ottogen/permalink_spec.rb +49 -0
data/spec/ottogen/post_spec.rb +172 -0
data/spec/spec_helper.rb +51 -0
metadata +176 -57

data/spec/ottogen/ottogen_spec.rb CHANGED Viewed

@@ -1,9 +1,434 @@
-require 'ottogen/ottogen'
+# frozen_string_literal: true
-module Ottogen
-  describe Ottogen do
-    it 'works' do
-      expect(1).to eq(1)
+RSpec.describe Ottogen::Ottogen do
+  it 'is loaded' do
+    expect(defined?(Ottogen::Ottogen)).to eq('constant')
+  end
+  describe '.build' do
+    it 'passes site_title as an Asciidoctor attribute, resolvable in pages' do
+      in_otto_project(config: "title: My Otto Site\n") do
+        File.write('pages/index.adoc', "= Index\n\nMy site is {site_title}.\n")
+        capture_stdout { described_class.build }
+        expect(File.read('_build/index.html')).to include('My site is My Otto Site.')
+      end
+    end
+    it 'passes custom config keys as site_<key> attributes' do
+      in_otto_project(config: "title: T\nauthor: Ada Lovelace\n") do
+        File.write('pages/index.adoc', "= Index\n\nWritten by {site_author}.\n")
+        capture_stdout { described_class.build }
+        expect(File.read('_build/index.html')).to include('Written by Ada Lovelace.')
+      end
+    end
+    it 'still succeeds when config.yml has only a title' do
+      in_otto_project(config: "title: Minimal\n") do
+        File.write('pages/index.adoc', "= Index\n\nHello.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/index.html')).to be true
+      end
+    end
+    it 'resolves {page_title} from front matter in rendered HTML' do
+      in_otto_project do
+        File.write('pages/index.adoc', <<~ADOC)
+          ---
+          title: My Page
+          ---
+          = Index
+          Welcome to {page_title}.
+        ADOC
+        capture_stdout { described_class.build }
+        expect(File.read('_build/index.html')).to include('Welcome to My Page.')
+      end
+    end
+    it 'resolves arbitrary front matter keys in rendered HTML' do
+      in_otto_project do
+        File.write('pages/index.adoc', <<~ADOC)
+          ---
+          author: Ada Lovelace
+          ---
+          = Index
+          Written by {page_author}.
+        ADOC
+        capture_stdout { described_class.build }
+        expect(File.read('_build/index.html')).to include('Written by Ada Lovelace.')
+      end
+    end
+    it 'does not include front matter delimiters in rendered HTML' do
+      in_otto_project do
+        File.write('pages/index.adoc', <<~ADOC)
+          ---
+          title: My Page
+          ---
+          = Index
+          Body.
+        ADOC
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).not_to include('---')
+        expect(html).not_to include('title: My Page')
+      end
+    end
+    it 'still builds pages without front matter' do
+      in_otto_project do
+        File.write('pages/index.adoc', "= Plain\n\nNo front matter here.\n")
+        capture_stdout { described_class.build }
+        expect(File.read('_build/index.html')).to include('No front matter here.')
+      end
+    end
+    it 'wraps a page in its declared layout' do
+      in_otto_project do
+        FileUtils.mkdir_p('_layouts')
+        File.write('_layouts/default.html.erb', '<html><body><%= content %></body></html>')
+        File.write('pages/index.adoc', "---\nlayout: default\n---\n= Hi\n\nHello.\n")
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).to start_with('<html><body>')
+        expect(html).to include('Hello.')
+        expect(html).to end_with('</body></html>')
+      end
+    end
+    it 'renders collection items when output: true' do
+      in_otto_project(config: <<~YAML) do
+        title: T
+        collections:
+          recipes:
+            output: true
+      YAML
+        FileUtils.mkdir_p('_recipes')
+        File.write('_recipes/pizza.adoc', "= Pizza\n\nDough.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/recipes/pizza.html')).to be true
+        expect(File.read('_build/recipes/pizza.html')).to include('Dough.')
+      end
+    end
+    it 'does not render collection items when output: false' do
+      in_otto_project(config: <<~YAML) do
+        title: T
+        collections:
+          books:
+            output: false
+      YAML
+        FileUtils.mkdir_p('_books')
+        File.write('_books/midnight.adoc', "= Midnight\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/books/midnight.html')).to be false
+      end
+    end
+    it 'excludes drafts by default' do
+      in_otto_project do
+        FileUtils.mkdir_p('_drafts')
+        File.write('_drafts/wip.adoc', "= WIP\n\nDraft body.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/wip.html')).to be false
+      end
+    end
+    it 'renders drafts when build is called with drafts: true' do
+      in_otto_project do
+        FileUtils.mkdir_p('_drafts')
+        File.write('_drafts/wip.adoc', "= WIP\n\nDraft body.\n")
+        capture_stdout { described_class.build(drafts: true) }
+        expect(File.exist?('_build/wip.html')).to be true
+        expect(File.read('_build/wip.html')).to include('Draft body.')
+      end
+    end
+    it 'honors a per-document permalink: in front matter' do
+      in_otto_project do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hello.adoc', "---\npermalink: /custom/path.html\n---\nBody.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/custom/path.html')).to be true
+        expect(File.exist?('_build/hello.html')).to be false
+      end
+    end
+    it 'applies a global permalink: from config.yml to posts with date tokens' do
+      in_otto_project(config: "title: T\npermalink: /:year/:month/:day/:slug/\n") do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hello.adoc', "= Hello\n\nBody.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/2026/01/15/hello/index.html')).to be true
+        expect(File.read('_build/2026/01/15/hello/index.html')).to include('Body.')
+      end
+    end
+    it 'does not apply the global permalink to pages' do
+      in_otto_project(config: "title: T\npermalink: /:year/:month/:day/:slug/\n") do
+        File.write('pages/about.adoc', "= About\n\nAbout body.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/about.html')).to be true
+      end
+    end
+    it 'renders posts to _build/<slug>.html' do
+      in_otto_project do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hello-world.adoc', "= Hello\n\nBody.\n")
+        capture_stdout { described_class.build }
+        expect(File.exist?('_build/hello-world.html')).to be true
+        expect(File.read('_build/hello-world.html')).to include('Body.')
+      end
+    end
+    it 'exposes site.posts to layouts' do
+      in_otto_project do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-only-post.adoc', "= Hi\n\nBody.\n")
+        File.write('_layouts/default.html.erb', '<nav><%= site.posts.first.title %></nav><%= content %>')
+        File.write('pages/index.adoc', "---\nlayout: default\n---\nIndex.\n")
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).to include('<nav>Only Post</nav>')
+      end
+    end
+    it 'exposes site.data.<file> in layouts' do
+      in_otto_project do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_data')
+        File.write('_data/nav.yml', "- title: Home\n  url: /\n")
+        File.write('_layouts/default.html.erb', "<%= site.data.nav.first['title'] %>|<%= content %>")
+        File.write('pages/index.adoc', "---\nlayout: default\n---\nBody.\n")
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).to include('Home|')
+        expect(html).to include('Body.')
+      end
+    end
+    it 'embeds an include declared in the page layout' do
+      in_otto_project do
+        FileUtils.mkdir_p('_layouts')
+        FileUtils.mkdir_p('_includes')
+        File.write('_includes/header.html', '<header>Site Header</header>')
+        File.write('_layouts/default.html.erb', "<html><%= partial 'header.html' %><body><%= content %></body></html>")
+        File.write('pages/index.adoc', "---\nlayout: default\n---\n= Hi\n\nHello.\n")
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).to include('<header>Site Header</header>')
+        expect(html).to include('Hello.')
+      end
+    end
+    it 'chains layouts (post -> default)' do
+      in_otto_project 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>")
+        File.write('pages/index.adoc', "---\nlayout: post\n---\n= Hi\n\nHello.\n")
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).to include('<html><body><article>')
+        expect(html).to include('Hello.')
+        expect(html).to include('</article></body></html>')
+      end
+    end
+    it 'still emits standalone HTML for pages without a layout' do
+      in_otto_project do
+        File.write('pages/index.adoc', "= Hi\n\nNo layout here.\n")
+        capture_stdout { described_class.build }
+        html = File.read('_build/index.html')
+        expect(html).to include('<!DOCTYPE html>')
+        expect(html).to include('No layout here.')
+      end
+    end
+    it 'exits with a friendly error when a page references a missing layout' do
+      in_otto_project do
+        File.write('pages/index.adoc', "---\nlayout: missing\n---\n= Hi\n\nHello.\n")
+        buffer = StringIO.new
+        original = $stdout
+        $stdout = buffer
+        begin
+          expect { described_class.build }.to raise_error(SystemExit)
+        ensure
+          $stdout = original
+        end
+        expect(buffer.string).to include('❌')
+        expect(buffer.string).to include('missing')
+      end
+    end
+    it 'exits with a friendly error when a page has malformed front matter' do
+      in_otto_project do
+        File.write('pages/index.adoc', "---\ntitle: 'unclosed\n---\nBody\n")
+        buffer = StringIO.new
+        original = $stdout
+        $stdout = buffer
+        begin
+          expect { described_class.build }.to raise_error(SystemExit)
+        ensure
+          $stdout = original
+        end
+        expect(buffer.string).to include('❌')
+        expect(buffer.string).to include('pages/index.adoc')
+      end
+    end
+  end
+  describe '.init' do
+    it 'writes a config.yml with title, description, url, and baseurl keys' do
+      in_tmp_dir do
+        capture_stdout { described_class.init('site') }
+        config = YAML.safe_load_file('site/config.yml')
+        expect(config.keys).to include('title', 'description', 'url', 'baseurl')
+      end
+    end
+    it 'scaffolds _layouts/default.html.erb with a starter template' do
+      in_tmp_dir do
+        capture_stdout { described_class.init('site') }
+        path = 'site/_layouts/default.html.erb'
+        expect(File.exist?(path)).to be true
+        expect(File.read(path)).to include('<%= content %>')
+      end
+    end
+    it 'scaffolds an _includes/ directory' do
+      in_tmp_dir do
+        capture_stdout { described_class.init('site') }
+        expect(Dir.exist?('site/_includes')).to be true
+      end
+    end
+    it 'scaffolds a _data/ directory' do
+      in_tmp_dir do
+        capture_stdout { described_class.init('site') }
+        expect(Dir.exist?('site/_data')).to be true
+      end
+    end
+    it 'scaffolds a _posts/ directory' do
+      in_tmp_dir do
+        capture_stdout { described_class.init('site') }
+        expect(Dir.exist?('site/_posts')).to be true
+      end
+    end
+    it 'scaffolds a _drafts/ directory' do
+      in_tmp_dir do
+        capture_stdout { described_class.init('site') }
+        expect(Dir.exist?('site/_drafts')).to be true
+      end
+    end
+  end
+  describe '.new_post' do
+    it 'creates _posts/<date>-<slug>.adoc with title and date front matter' do
+      in_otto_project do
+        capture_stdout { described_class.new_post('Hello World') }
+        expected = "_posts/#{Date.today.iso8601}-hello-world.adoc"
+        expect(File.exist?(expected)).to be true
+        body = File.read(expected)
+        expect(body).to include('title: Hello World')
+        expect(body).to include("date: #{Date.today.iso8601}")
+      end
+    end
+    it 'slugifies the title (lowercase, dashed)' do
+      in_otto_project do
+        capture_stdout { described_class.new_post('My Cool, Fancy Post!') }
+        expected = "_posts/#{Date.today.iso8601}-my-cool-fancy-post.adoc"
+        expect(File.exist?(expected)).to be true
+      end
+    end
+  end
+  describe '.doctor' do
+    it 'reports OK in a healthy project' do
+      in_otto_project do
+        output = capture_stdout { described_class.doctor }
+        expect(output).to include('✅')
+      end
+    end
+    it 'exits non-zero and reports problems when required files are missing' do
+      in_tmp_dir do
+        FileUtils.touch('.otto')
+        # config.yml and pages/ deliberately missing
+        buffer = StringIO.new
+        original = $stdout
+        $stdout = buffer
+        begin
+          expect { described_class.doctor }.to raise_error(SystemExit)
+        ensure
+          $stdout = original
+        end
+        expect(buffer.string).to include('config.yml')
+      end
     end
   end
 end

data/spec/ottogen/page_spec.rb ADDED Viewed

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+RSpec.describe Ottogen::Page do
+  describe '.read' do
+    it 'parses YAML front matter delimited by ---' do
+      in_tmp_dir do
+        File.write('post.adoc', <<~ADOC)
+          ---
+          title: Hello
+          author: Ada
+          ---
+          = Hello
+          Body.
+        ADOC
+        page = described_class.read('post.adoc')
+        expect(page.front_matter).to eq('title' => 'Hello', 'author' => 'Ada')
+      end
+    end
+    it 'strips the front matter block from the body' do
+      in_tmp_dir do
+        File.write('post.adoc', <<~ADOC)
+          ---
+          title: Hello
+          ---
+          = Hello
+          Body.
+        ADOC
+        page = described_class.read('post.adoc')
+        expect(page.body).to eq("= Hello\n\nBody.\n")
+      end
+    end
+    it 'returns empty front matter when the file has no --- block' do
+      in_tmp_dir do
+        File.write('post.adoc', "= Plain\n\nBody.\n")
+        page = described_class.read('post.adoc')
+        expect(page.front_matter).to eq({})
+      end
+    end
+    it 'returns the full file as body when there is no front matter' do
+      in_tmp_dir do
+        File.write('post.adoc', "= Plain\n\nBody.\n")
+        page = described_class.read('post.adoc')
+        expect(page.body).to eq("= Plain\n\nBody.\n")
+      end
+    end
+    it 'raises Page::Error for unclosed front matter' do
+      in_tmp_dir do
+        File.write('post.adoc', "---\ntitle: Hello\n\n= Body without close\n")
+        expect { described_class.read('post.adoc') }
+          .to raise_error(Ottogen::Page::Error)
+      end
+    end
+    it 'raises Page::Error for malformed YAML in front matter' do
+      in_tmp_dir do
+        File.write('post.adoc', "---\ntitle: 'unclosed\n---\nBody\n")
+        expect { described_class.read('post.adoc') }
+          .to raise_error(Ottogen::Page::Error)
+      end
+    end
+  end
+  describe '#asciidoctor_attributes' do
+    it 'prefixes every front matter key with page_' do
+      in_tmp_dir do
+        File.write('post.adoc', "---\ntitle: Hi\nauthor: Ada\n---\nBody.\n")
+        attrs = described_class.read('post.adoc').asciidoctor_attributes
+        expect(attrs).to include('page_title' => 'Hi', 'page_author' => 'Ada')
+      end
+    end
+    it 'includes page_url derived from the source path' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('pages')
+        File.write('pages/about.adoc', "---\ntitle: About\n---\nBody.\n")
+        attrs = described_class.read('pages/about.adoc').asciidoctor_attributes
+        expect(attrs['page_url']).to eq('/about.html')
+      end
+    end
+  end
+end

data/spec/ottogen/permalink_spec.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require 'date'
+RSpec.describe Ottogen::Permalink do
+  let(:post) do
+    Ottogen::Post.new(
+      path: '_posts/2026-01-15-hello-world.adoc',
+      date: Date.new(2026, 1, 15),
+      slug: 'hello-world',
+      front_matter: { 'title' => 'Hello World!' },
+      body: ''
+    )
+  end
+  describe '.expand' do
+    it 'replaces :year, :month, :day from the date' do
+      expanded = described_class.expand('/:year/:month/:day/', post)
+      expect(expanded.path).to eq('/2026/01/15/')
+    end
+    it 'replaces :slug' do
+      expanded = described_class.expand('/:slug.html', post)
+      expect(expanded.path).to eq('/hello-world.html')
+    end
+    it 'replaces :title with a slugified version' do
+      expanded = described_class.expand('/:title/', post)
+      expect(expanded.path).to eq('/hello-world/')
+    end
+  end
+  describe '#output_path' do
+    it 'appends index.html when the path ends with /' do
+      permalink = described_class.new('/2026/01/15/hello/')
+      expect(permalink.output_path('_build')).to eq('_build/2026/01/15/hello/index.html')
+    end
+    it 'uses the path as-is otherwise' do
+      permalink = described_class.new('/2026/01/15/hello.html')
+      expect(permalink.output_path('_build')).to eq('_build/2026/01/15/hello.html')
+    end
+  end
+end