phlex-markdown 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9decdb08e89ad1d8deb79e6782b7961102150af4e6e20e0dff67a4ea7ff6c6d7
-  data.tar.gz: 50e51626d52911b3ddb2f31404ede909bdea835b230dff35ed9d4592d6ea1cc9
+  metadata.gz: 3e4546655748fea3f6ab3004ff7d67d12b95e461d7a29ad6f876fd7998ee0444
+  data.tar.gz: a3bbde5d84b3d9642df40079b7f3f2bc36489e6dbda19205e2fe674adce6335a
 SHA512:
-  metadata.gz: a09c726ac8e02922efd62342038ebe87abdb107c1729881d0998665d5a6b7147f41294140c6e26b5342a6c56c1b4cca4c9aaf1f399480a0d95caf947d12036da
-  data.tar.gz: 1736bc45133d4336846c8accb29128e27ae9499550ebad59287624a99c2cd09d33b268c95999d670f22300f518e46788c4a8da6cd7a583066c14ccb7d6dcc84f
+  metadata.gz: 390f03b1b399c1c62bb4d844dbb253539661fda7b39f6b2c08c514905d7fc18184292a1e09b0dbb89e80a2acfba8d141506076f2fa978ec05cc5e8967a530594
+  data.tar.gz: f8ca5719060e644e31e9be6ef9d37dbf5904f55d5a834d2dd3beaa30721adc5cb075557e28f40eef30ebb87d0def4bcda9b8f8bdd2e5aa27ce9cedc91f4f6d3b

data/.editorconfig

@@ -11,3 +11,7 @@ indent_size = 2
 [*.erb]
 indent_style = space
 indent_size = 2
+
+[*.md]
+indent_style = space
+indent_size = 2

data/Gemfile

@@ -5,6 +5,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec
 
+gem "phlex", github: "joeldrapper/phlex"
 gem "capybara"
 gem "rubocop"
 gem "solargraph"

data/README.md

@@ -1,5 +1,52 @@
 # `phlex-markdown`
 
+`Phlex::Markdown` is a [Phlex](https://phlex.fun) view that renders Markdown into HTML using Phlex. You could use it directly — it takes a String of markdown and renders it to safe HTML.
+
+Alternatively, you can define a sub-class and override various methods to customise the output.
+
+For example, here we override `h1` and `ul`, adding some Tailwind classes to them.
+
+```ruby
+class MyMarkdown < Phlex::Markdown
+  def h1 = super(class: "font-bold text-xl")
+  def ul = super(class: "ml-4 pt-2")
+end
+```
+
+When we render the view.
+
+```ruby
+content = <<~MD
+  # Hello World
+
+  - A
+  - B
+  - C
+MD
+
+output = MyMarkdown.new(content).call
+```
+
+The `output` will use the attributes from our methods.
+
+```html
+<h1 class="font-bold text-xl">Hello World</h1>
+<ul class="ml-4 pt-2">
+  <li>A</li>
+  <li>B</li>
+  <li>C</li>
+</ul>
+```
+
+You could also wrap the whole document in an `<article>` element by overriding `template`.
+
+```ruby
+class MyMarkdownArticle < Phlex::Markdown
+  def template
+    article(class: "prose") { super }
+  end
+end
+```
 
 ### Community 🙌
 

data/lib/phlex/markdown.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "phlex"
 require "markly"
 
 module Phlex
@@ -44,7 +45,13 @@ module Phlex
 					p { visit_children(node) }
 				end
 			in :link
-				a(href: node.url) { visit_children(node) }
+				a(href: node.url, title: node.title) { visit_children(node) }
+			in :image
+				img(
+					src: node.url,
+					alt: node.each.first.string_content,
+					title: node.title
+				)
 			in :emph
 				em { visit_children(node) }
 			in :strong
@@ -57,10 +64,16 @@ module Phlex
 			in :list_item
 				li { visit_children(node) }
 			in :code
-				whitespace { code { text(node.string_content) } }
+				inline_code do |**attributes|
+					code(**attributes) { text(node.string_content) }
+				end
 			in :code_block
-				code_block(node.string_content, language: node.fence_info) do |**attributes|
-					pre(**attributes) { text(node.string_content) }
+				code_block(node.string_content, node.fence_info) do |**attributes|
+					pre(**attributes) do
+						code(class: "language-#{node.fence_info}") do
+							text(node.string_content)
+						end
+					end
 				end
 			in :hrule
 				hr
@@ -69,8 +82,12 @@ module Phlex
 			end
 		end
 
-		def code_block(code, language:)
-			yield
+		def inline_code(**attributes)
+			yield(**attributes)
+		end
+
+		def code_block(code, language, **attributes)
+			yield(**attributes)
 		end
 
 		def visit_children(node)

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: phlex-markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Drapper
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-11-17 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: markly
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: phlex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.5'
 description: A Markdown view for Phlex
 email:
 - joel@drapper.me
@@ -53,8 +53,6 @@ files:
 - README.md
 - SECURITY.md
 - lib/phlex/markdown.rb
-- lib/phlex/markdown/version.rb
-- sig/phlex.rbs
 homepage: https://github.com/joeldrapper/phlex-markdown
 licenses:
 - MIT

data/lib/phlex/markdown/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Phlex
-	class Markdown
-		VERSION = "0.1.0"
-	end
-end

data/sig/phlex.rbs

@@ -1,4 +0,0 @@
-module Phlex
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end