fountainrb 1.0.0

data/lib/fountainrb.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "fountainrb/version"
+require_relative "fountainrb/errors"
+require_relative "fountainrb/inline"
+require_relative "fountainrb/elements"
+require_relative "fountainrb/title_page"
+require_relative "fountainrb/tokenizer"
+require_relative "fountainrb/parser"
+require_relative "fountainrb/screenplay"
+require_relative "fountainrb/validator"
+require_relative "fountainrb/html_renderer"
+require_relative "fountainrb/plain_text_renderer"
+
+# A pure-Ruby parser for the Fountain screenplay markup language.
+#
+#   require "fountainrb"
+#
+#   screenplay = FountainRB.parse(File.read("script.fountain"))
+#   screenplay.scenes.first.text      #=> "INT. HOUSE - DAY"
+#   screenplay.character_names        #=> ["STEEL", "BRICK"]
+#   puts screenplay.to_html
+#
+# See https://fountain.io/syntax/ for the language reference.
+module FountainRB
+  class << self
+    # Parse Fountain source.
+    #
+    # @param source [String]
+    # @return [Screenplay]
+    def parse(source)
+      Parser.new(source).parse
+    end
+
+    # Read and parse a Fountain file.
+    #
+    # @param path [String, Pathname]
+    # @param encoding [String]
+    # @return [Screenplay]
+    def parse_file(path, encoding: "UTF-8")
+      parse(File.read(path, encoding: encoding))
+    end
+
+    # Check Fountain source for likely mistakes.
+    #
+    # Fountain parsing is intentionally forgiving, so this reports problems
+    # that would otherwise be silently recovered from: unclosed notes or
+    # boneyards, stray closing brackets, malformed scene numbers, and orphan
+    # dual-dialogue carets.
+    #
+    # @param source [String, nil]
+    # @return [Array<Issue>]
+    def validate(source)
+      Validator.new(source).validate
+    end
+
+    # True when {validate} finds no issues in +source+.
+    #
+    # @param source [String, nil]
+    # @return [Boolean]
+    def valid?(source)
+      validate(source).empty?
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: fountainrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Distark
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2026-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+description: |
+  fountainrb is a dependency-free Ruby implementation of the Fountain
+  screenplay markup language (https://fountain.io/syntax/). It tokenizes
+  title pages, scene headings, action, characters, dialogue, parentheticals,
+  dual dialogue, lyrics, transitions, centered text, page breaks, sections,
+  synopses, notes and boneyards, parses inline emphasis, and can render a
+  parsed screenplay to HTML, plain text or JSON.
+email:
+- dev@distark.com
+executables:
+- fountainrb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/fountainrb
+- lib/fountainrb.rb
+- lib/fountainrb/elements.rb
+- lib/fountainrb/errors.rb
+- lib/fountainrb/html_renderer.rb
+- lib/fountainrb/inline.rb
+- lib/fountainrb/parser.rb
+- lib/fountainrb/plain_text_renderer.rb
+- lib/fountainrb/screenplay.rb
+- lib/fountainrb/title_page.rb
+- lib/fountainrb/tokenizer.rb
+- lib/fountainrb/validator.rb
+- lib/fountainrb/version.rb
+homepage: https://github.com/jtoy/fountainrb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jtoy/fountainrb
+  source_code_uri: https://github.com/jtoy/fountainrb/tree/main
+  changelog_uri: https://github.com/jtoy/fountainrb/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: A pure-Ruby parser for Fountain screenplays
+test_files: []