bridgetown_writebook 0.1.0 → 0.1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c25aa1ad6696109457b735df53aed475b1c7c2b3797c26d13c35b106ae900b6
-  data.tar.gz: 3f7d2626aa3e8b136d3e08ceac6da90953165840a0a5a4e14bf809a817a6eb74
+  metadata.gz: 1ecde4cf7c2246af31a117f402935e342064314ab25f9ce3c38c50520682a769
+  data.tar.gz: 78fcd4f3b88571eb92f8953c627b01bb19a17145d0b94251955dfd46462213c2
 SHA512:
-  metadata.gz: 9bad682e488ee4de5377045ab507bf59d0e636ab707bc4321550a32140e7feaeecf68ccbc5fa248acbd0cfec6800f0dbe3a5f1c3cfe302c54b3474049febfefd
-  data.tar.gz: bcb3a49ad89e9c122d1aa6d681df9c18b3c4687c70489d931f2b52e2308d6bd4b8bc93fcada0b148161a0eb0b1ac5a7aa24cad81047b28b4fdf798a23ca3f655
+  metadata.gz: dcd86b0250d74ca12824716bac756083d46e1990b4fd86e698c35928a1250f32d955048d07bf074b2dac8176a7f91621e3797f5b60a66e86c49d7535fa9f1f58
+  data.tar.gz: 391edeb2c0e1dc1b5502da043b23df3ea71f7db0570b3b1dddeb71cb71041b37d2493a6324768a7200a06e5556805fcdec0e48d569816c878e8e761c6461b4e4

data/bridgetown.automation.rb

@@ -52,6 +52,6 @@
 
 append_to_file "config/boot.rb" do
   <<~RUBY
-
+require 'bridgetown_writebook/commands'
   RUBY
 end

data/lib/bridgetown_writebook/builder.rb

@@ -6,6 +6,10 @@ module BridgetownWritebook
       liquid_tag "bridgetown_writebook" do
         "This plugin works!"
       end
+
+      liquid_tag "what" do
+        "is going on"
+      end
     end
   end
 end

data/lib/bridgetown_writebook/commands/book.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_all "bridgetown-core/commands/concerns"
+require_relative "chapter"
+
+module BridgetownWritebook
+  module Commands
+    class Book < Thor
+      desc "setup", "Setup folders and files for books"
+      def setup
+        create_books_folder
+        add_books_collection_to_config
+      end
+
+      desc "new", "Create a new book"
+      option :title, type: :string, required: true, desc: "Title of the book"
+      def new
+        title = options[:title]
+        folder_path = File.join("src", "_books", title.parameterize)
+
+        if Dir.exist?(folder_path)
+          Bridgetown.logger.info "Folder already exists: #{folder_path}"
+        else
+          FileUtils.mkdir_p(folder_path)
+          Bridgetown.logger.info "Folder created: #{folder_path}"
+        end
+
+        file_path = File.join(folder_path, "00-meta.md")
+        content = <<~MARKDOWN
+          ---
+          title: #{text title}
+          subtitle:
+          authors: [  ]
+          ---
+        MARKDOWN
+
+        File.write(file_path, content)
+        Bridgetown.logger.info "Creating a new book with title: #{title}"
+      end
+
+      # Register Chapters as a nested subcommand
+      desc "chapters <command>", "Manage chapters of a book"
+      subcommand "chapters", Chapter
+
+      private
+
+      def create_books_folder
+        folder_path = File.join("src", "_books")
+
+        if Dir.exist?(folder_path)
+          Bridgetown.logger.info "Folder already exists: #{folder_path}"
+        else
+          FileUtils.mkdir_p(folder_path)
+          Bridgetown.logger.info "Folder created: #{folder_path}"
+        end
+      end
+
+      def add_books_collection_to_config
+        config_file = "bridgetown.config.yml"
+        unless File.exist?(config_file)
+          Bridgetown.logger.info "Config file not found: #{config_file}"
+          return
+        end
+
+        content = File.read(config_file)
+        if content.include?("books:")
+          Bridgetown.logger.info "'books' collection already exists, skipping..."
+          return
+        end
+
+        config = YAML.load_file(config_file) || {}
+        config["collections"] ||= {}
+        config["collections"]["books"] = {
+          "output"    => true,
+          "permalink" => "/books/:path/",
+        }
+
+        File.write(config_file, config.to_yaml)
+        Bridgetown.logger.info "'books' collection added/updated in #{config_file}"
+      end
+    end
+  end
+end

data/lib/bridgetown_writebook/commands/chapter.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module BridgetownWritebook
+  module Commands
+    class Chapter < Thor
+      desc "add", "Add a new chapter to a book"
+      option :book, type: :string, required: true, desc: "Title of the book"
+      option :title, type: :string, required: true, desc: "Title of the chapter"
+      def add
+        book_title = options[:book]
+        chapter_title = options[:title]
+        @folder_path = File.join("src", "_books", book_title.parameterize)
+
+        unless Dir.exist?(@folder_path)
+          Bridgetown.logger.info "Book not found: #{book_title}"
+          return
+        end
+
+        chapter_file = File.join(@folder_path, "#{new_chapter_number}-#{chapter_title.parameterize}.md")
+
+        content = <<~MARKDOWN
+          ---
+          title: #{text chapter_title}
+          ---
+        MARKDOWN
+
+        File.write(chapter_file, content)
+        Bridgetown.logger.info "Chapter created: #{chapter_file}"
+      end
+
+      private
+
+      def new_chapter_number
+        existing_chapters = Dir.children(@folder_path)
+          .grep(%r{^\d{2}-.*\.md$})
+          .sort
+        last_number = if existing_chapters.empty?
+                        0
+                      else
+                        existing_chapters.last.split("-").first.to_i
+                      end
+
+        format("%02d", last_number + 1)
+      end
+    end
+  end
+end

data/lib/bridgetown_writebook/commands.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_all "bridgetown-core/commands/concerns"
+require "commands/book"
+
+module BridgetownWritebook
+  class Commands
+    include Bridgetown::Commands::ConfigurationOverridable
+
+    Bridgetown::Commands::Registrations.register do
+      desc "book <command>", "Take me to the book"
+      subcommand "book", Book
+    end
+  end
+end

data/lib/bridgetown_writebook/models/book.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module BridgetownWritebook
+  module Models
+    class Book
+      attr_accessor :name, :subtitle, :resource, :meta, :chapters
+
+      delegate :id, to: :resource
+      alias_method :title, :name
+
+      def initialize(book, chapters:, meta:)
+        @resource = book
+        @meta = meta
+        @chapters = []
+
+        chapters.each do |chapter|
+          @chapters << Chapter.new(chapter, booxk: self)
+        end
+
+        extract_metadata
+      end
+
+      #TODO: support other formats as well.
+      def cover
+        "/#{resource.path.split(".").first}/cover.png"
+      end
+
+      def authors?
+        @authors.present?
+      end
+
+      def authors
+        "by #{@authors.join(", ")}" if authors?
+      end
+
+      def extract_metadata
+        @name = @meta&.data&.title || slug.titleize
+        @subtitle = @meta&.data&.subtitle
+        @authors = @meta&.data&.authors
+      end
+
+      def slug
+        id.split("/").last.split(".md").first
+      end
+
+      def link
+        resource.relative_url
+      end
+
+      def chapter_ids
+        chapters.map(&:id)
+      end
+
+      def generate
+        resource.data.layout = :book
+        resource.data.title = title
+        resource.data.cover = cover
+        resource.data.subtitle = subtitle
+        resource.data.authors = authors
+        resource.content = content
+
+        chapters.each(&:generate)
+      end
+
+      def content
+        <<~HTML
+          <ul class="pl-0" data-controller="bookmark" data-bookmark-chapter-outlet='.chapter' data-bookmark-book-value="#{text id}">
+           #{html chapters.map do |chapter|
+             li chapter
+           end.join }
+          </ul>
+        HTML
+      end
+
+      # TODO: may be convert these into compenents or partials.
+      # TODO: Move them to the template, add it to the metadata and move it to the template.
+      def li(chapter)
+        <<~HTML
+          <li class='chapter flex justify-between items-end gap-4'
+              data-controller='chapter'
+              data-chapter-id-value='#{text chapter.id}'
+              data-chapter-ellipsis-class="text-orange-500"
+          >
+            <a href='#{text chapter.link}' class="text-nowrap">#{text chapter.title}</a>
+            <span class="grow overflow-hidden border-b border-dotted border-black mb-1.5" data-chapter-target="ellipsis"></span>
+            <span class="text-nowrap">#{text chapter.word_count}</span>
+          </li>
+        HTML
+      end
+    end
+  end
+end

data/lib/bridgetown_writebook/models/chapter.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module BridgetownWritebook
+  module Models
+    class Chapter
+      attr_accessor :name, :slug, :resource, :book
+
+      delegate :id, :data, to: :resource
+
+      def initialize(chapter, book:)
+        @resource = chapter
+        @book = book
+
+        # Populate the word count before adding the stimulus controller
+        calculate_word_count
+      end
+
+      def calculate_word_count
+        words_array = resource.content.split - %w[#]
+        @word_count = words_array.size
+      end
+
+      def delimited_word_count
+        @word_count.to_fs(:delimited)
+      end
+
+      def word_count
+        return "#{delimited_word_count} words" if @word_count > 1
+
+        "#{delimited_word_count} word"
+      end
+
+      def link
+        resource.relative_url
+      end
+
+      def title
+        data.title
+      end
+
+      def next_chapter
+        book.chapters[book.chapters.index(self) + 1]
+      end
+
+      def generate
+        resource.data.layout = "chapter"
+        resource.data.book_title = book.name
+        resource.data.book_link = book.link
+        resource.data.next_chapter_title = next_chapter&.title
+        resource.data.next_chapter_link = next_chapter&.link
+        resource.data.word_count = word_count
+        resource.content = <<~HTML
+          #{html resource.content}
+          <div data-controller="reading"
+               data-reading-id-value="#{text id}"
+               data-reading-book-value="#{text book.id}">
+          </div>
+        HTML
+      end
+    end
+  end
+end

data/lib/bridgetown_writebook/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BridgetownWritebook
-  VERSION = "0.1.0"
+  VERSION = "0.1.0.1"
 end

data/lib/bridgetown_writebook.rb

@@ -2,6 +2,7 @@
 
 require "bridgetown"
 require "bridgetown_writebook/builder"
+require_relative "bridgetown_writebook/commands"
 
 # @param config [Bridgetown::Configuration::ConfigurationDSL]
 Bridgetown.initializer :bridgetown_writebook do |config|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bridgetown_writebook
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.0.1
 platform: ruby
 authors:
 - Bridgetown Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-26 00:00:00.000000000 Z
+date: 2025-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bridgetown
@@ -95,6 +95,11 @@ files:
 - layouts/bridgetown_writebook/layout.html
 - lib/bridgetown_writebook.rb
 - lib/bridgetown_writebook/builder.rb
+- lib/bridgetown_writebook/commands.rb
+- lib/bridgetown_writebook/commands/book.rb
+- lib/bridgetown_writebook/commands/chapter.rb
+- lib/bridgetown_writebook/models/book.rb
+- lib/bridgetown_writebook/models/chapter.rb
 - lib/bridgetown_writebook/version.rb
 - package.json
 homepage: https://github.com/username/bridgetown_writebook