ottogen 0.1.0 → 1.0.0

data/spec/ottogen/post_spec.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require 'date'
+
+RSpec.describe Ottogen::Post do
+  describe '.read' do
+    it 'parses YYYY-MM-DD-slug from the filename' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hello-world.adoc', "= Hello\n\nBody.\n")
+
+        post = described_class.read('_posts/2026-01-15-hello-world.adoc')
+
+        expect(post.date).to eq(Date.new(2026, 1, 15))
+        expect(post.slug).to eq('hello-world')
+      end
+    end
+
+    it 'parses front matter via the shared FrontMatter parser' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hi.adoc', "---\ntitle: Greetings\n---\n= Hi\n\nBody.\n")
+
+        post = described_class.read('_posts/2026-01-15-hi.adoc')
+
+        expect(post.front_matter).to eq('title' => 'Greetings')
+        expect(post.body).to eq("= Hi\n\nBody.\n")
+      end
+    end
+
+    it 'raises Post::Error when the filename does not match YYYY-MM-DD-slug.adoc' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/not-a-post.adoc', "= Hi\n")
+
+        expect { described_class.read('_posts/not-a-post.adoc') }
+          .to raise_error(Ottogen::Post::Error)
+      end
+    end
+  end
+
+  describe '#title' do
+    it 'falls back to a titleized slug when not in front matter' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hello-world.adoc', "= Hi\n")
+
+        post = described_class.read('_posts/2026-01-15-hello-world.adoc')
+
+        expect(post.title).to eq('Hello World')
+      end
+    end
+
+    it 'uses the front matter title when present' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hi.adoc', "---\ntitle: Greetings\n---\nBody.\n")
+
+        post = described_class.read('_posts/2026-01-15-hi.adoc')
+
+        expect(post.title).to eq('Greetings')
+      end
+    end
+  end
+
+  describe '#url' do
+    it 'is /<slug>.html' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hello-world.adoc', "= Hi\n")
+
+        post = described_class.read('_posts/2026-01-15-hello-world.adoc')
+
+        expect(post.url).to eq('/hello-world.html')
+      end
+    end
+  end
+
+  describe '.discover' do
+    it 'returns all posts from _posts/' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-a.adoc', "= A\n")
+        File.write('_posts/2026-02-15-b.adoc', "= B\n")
+
+        slugs = described_class.discover.map(&:slug)
+
+        expect(slugs).to contain_exactly('a', 'b')
+      end
+    end
+
+    it 'returns an empty array when _posts/ is missing' do
+      in_tmp_dir do
+        expect(described_class.discover).to eq([])
+      end
+    end
+  end
+
+  describe '.read_draft' do
+    it 'parses a draft filename and uses today as the date' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_drafts')
+        File.write('_drafts/in-progress.adoc', "= WIP\n\nBody.\n")
+
+        draft = described_class.read_draft('_drafts/in-progress.adoc')
+
+        expect(draft.slug).to eq('in-progress')
+        expect(draft.date).to eq(Date.today)
+      end
+    end
+  end
+
+  describe '#tags' do
+    it 'returns front matter tags as an array (list form)' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hi.adoc', "---\ntags:\n  - ruby\n  - cli\n---\nBody.\n")
+
+        expect(described_class.read('_posts/2026-01-15-hi.adoc').tags).to eq(%w[ruby cli])
+      end
+    end
+
+    it 'returns empty array when not present' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hi.adoc', "= Hi\n")
+
+        expect(described_class.read('_posts/2026-01-15-hi.adoc').tags).to eq([])
+      end
+    end
+
+    it 'wraps a single-string tag value into a one-element array' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hi.adoc', "---\ntags: ruby\n---\nBody.\n")
+
+        expect(described_class.read('_posts/2026-01-15-hi.adoc').tags).to eq(%w[ruby])
+      end
+    end
+  end
+
+  describe '#categories' do
+    it 'returns front matter categories as an array' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_posts')
+        File.write('_posts/2026-01-15-hi.adoc', "---\ncategories:\n  - dev\n  - ruby\n---\nBody.\n")
+
+        expect(described_class.read('_posts/2026-01-15-hi.adoc').categories).to eq(%w[dev ruby])
+      end
+    end
+  end
+
+  describe '.discover_drafts' do
+    it 'returns drafts from _drafts/' do
+      in_tmp_dir do
+        FileUtils.mkdir_p('_drafts')
+        File.write('_drafts/a.adoc', "= A\n")
+        File.write('_drafts/b.adoc', "= B\n")
+
+        slugs = described_class.discover_drafts.map(&:slug)
+
+        expect(slugs).to contain_exactly('a', 'b')
+      end
+    end
+
+    it 'returns an empty array when _drafts/ is missing' do
+      in_tmp_dir do
+        expect(described_class.discover_drafts).to eq([])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'stringio'
+require 'tmpdir'
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'ottogen/ottogen'
+require 'ottogen/otto'
+
+module Ottogen
+  module SpecHelpers
+    def in_tmp_dir
+      Dir.mktmpdir('ottogen-spec') do |dir|
+        Dir.chdir(dir) do
+          yield dir
+        end
+      end
+    end
+
+    def capture_stdout
+      original = $stdout
+      $stdout = StringIO.new
+      yield
+      $stdout.string
+    ensure
+      $stdout = original
+    end
+
+    def in_otto_project(config: "title: Test site\n", &block)
+      in_tmp_dir do |dir|
+        FileUtils.touch('.otto')
+        File.write('config.yml', config)
+        FileUtils.mkdir_p('pages')
+        FileUtils.mkdir_p('assets')
+        block.call(dir)
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Ottogen::SpecHelpers
+  config.disable_monkey_patching!
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -1,104 +1,209 @@
 --- !ruby/object:Gem::Specification
 name: ottogen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ian Johnson
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 2.0.20
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.20
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.60'
 description: |
   # Otto
 
-  AsciiDoc static site generator.
+  AsciiDoc-powered static site generator with Jekyll-style conventions: layouts, includes, data files, posts, drafts, permalinks, and custom collections.
 
-  # Quickstart
+  ## Install
 
-  **Install Otto**
-
-  ``` sh
+  ```sh
   gem install ottogen
   ```
 
-  **Initialize a new site**
+  Requires Ruby 3.0 or newer.
+
+  ## Quickstart
 
-  ``` sh
+  ```sh
   mkdir mysite && cd mysite
   otto init
-  ```
-
-  **Build the site**
-
-  ``` sh
   otto build
-  ```
-
-  **Serve the site**
-
-  ``` sh
   otto serve
-  ```
-
-  **View the site**
-
-  ``` sh
   open http://127.0.0.1:8778/
   ```
 
-  # AsciiDoc Crash Course
-
-  TODO
+  For a longer walkthrough including AsciiDoc syntax, see [GUIDE.md](GUIDE.md).
 
-  **Paragraphs**
+  ## Commands
 
-  **Text formatting**
+  | Command | Description |
+  |---|---|
+  | `otto init [DIR]` | Scaffold a new site (current dir if omitted) |
+  | `otto build` | Render the site to `_build/` |
+  | `otto build --drafts` | Include posts from `_drafts/` |
+  | `otto watch` | Rebuild on file change |
+  | `otto serve` | Serve `_build/` on port 8778 |
+  | `otto generate PAGE` | Create a new page in `pages/` |
+  | `otto post "Title"` | Create a new dated post in `_posts/` |
+  | `otto clean` | Delete `_build/` |
+  | `otto doctor` | Sanity-check project layout |
 
-  **Links**
+  ## Project layout
 
-  **Document header**
-
-  **Section titles**
+  ```
+  my-site/
+  ├── .otto                 # marker
+  ├── config.yml            # site config
+  ├── assets/               # copied verbatim into _build/
+  ├── pages/                # AsciiDoc pages, output mirrors path
+  ├── _layouts/             # ERB layouts (.html.erb)
+  ├── _includes/            # ERB partials
+  ├── _data/                # YAML/JSON files exposed as site.data.*
+  ├── _posts/               # YYYY-MM-DD-slug.adoc
+  └── _drafts/              # undated drafts (excluded by default)
+  ```
 
-  **Automatic TOC**
+  ## Configuration (`config.yml`)
 
-  **Includes**
+  ```yaml
+  title: My Otto Site
+  description: Things I write
+  url: https://example.com
+  baseurl: ""
 
-  **Lists**
+  permalink: /:year/:month/:day/:slug/
 
-  **Images**
+  collections:
+    recipes:
+      output: true
+  ```
 
-  **Audio**
+  `permalink` accepts these tokens: `:year`, `:month`, `:day`, `:slug`, `:title`. Templates ending in `/` produce pretty URLs (`<path>/index.html`).
 
-  **Videos**
+  ## Pages and posts
 
-  **Keyboard, button, and menu macros**
+  Both support YAML front matter:
 
-  **Literals and source code**
+  ```adoc
+  ---
+  layout: default
+  title: Hello
+  tags: [ruby, cli]
+  ---
+  = Hello
 
-  **Admonitions**
+  Welcome to {site_title}. This page is at {page_url}.
+  ```
 
-  **More delimited blocks**
+  Pages live under `pages/`; posts under `_posts/` with `YYYY-MM-DD-slug.adoc` names. Layouts wrap rendered AsciiDoc; partials in `_includes/` are pulled in via `<%= partial 'header.html' %>`.
 
-  **Tables**
+  ## License
 
-  **IDs, roles, and options**
+  MIT
 email: tacoda@hey.com
 executables:
 - otto
@@ -108,14 +213,30 @@ files:
 - LICENSE
 - README.md
 - bin/otto
+- lib/ottogen/collection.rb
+- lib/ottogen/collection_item.rb
+- lib/ottogen/config.rb
+- lib/ottogen/front_matter.rb
+- lib/ottogen/layout.rb
 - lib/ottogen/otto.rb
 - lib/ottogen/ottogen.rb
+- lib/ottogen/page.rb
+- lib/ottogen/permalink.rb
+- lib/ottogen/post.rb
+- lib/ottogen/scaffold.rb
+- spec/ottogen/collection_spec.rb
+- spec/ottogen/config_spec.rb
+- spec/ottogen/layout_spec.rb
 - spec/ottogen/ottogen_spec.rb
+- spec/ottogen/page_spec.rb
+- spec/ottogen/permalink_spec.rb
+- spec/ottogen/post_spec.rb
+- spec/spec_helper.rb
 homepage: https://www.tacoda.dev/otto/
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -123,16 +244,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: AsciiDoc static site generator
-test_files:
-- spec/ottogen/ottogen_spec.rb
+test_files: []