gemtext 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1392d564c448b924956632750348b03f7804d62ab1e3b925c212b25d44f613bb
+  data.tar.gz: 16d8245dda4b5356bf5adbd0d2070dbd6b28239c096de688c47126990656a0cc
+SHA512:
+  metadata.gz: 98a51c3e848abcd5cc1d1d7840d56ed0e7cc916ce2546db688e06faf4b4920b35568f2d23c13404add1e2751cc9440fe1e266ddc2dd996fd71344a154b2925fd
+  data.tar.gz: a39c9d52790e8cbf6481edd59d893a73e210742e8513eb7a823b511d81dbb2dd32b6caf26e1a465dca784fae353bd640e2437e53b5b3a75a485d5d30aaf07eb9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.2
+before_install: gem install bundler -v 2.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## v1.0.0
+
+* Parse a Gemtext::Document from a Ruby IO

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at git@exastencil.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gemtext.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Exa Stencil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Gemtext
+
+This gem provides data structures and parsing capabilities for
+[gemtext](https://gemini.circumlunar.space/docs/specification.html)
+(text/gemini). Gemtext is pretty simple, so this is just meant to save
+you some work.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gemtext'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gemtext
+
+## Usage
+
+```ruby
+Gemtext.parse(io)
+#=> <#Gemtext::Document>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/exastencil/gemtext. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/exastencil/gemtext/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Gemtext project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/exastencil/gemtext/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gemtext"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemtext.gemspec

@@ -0,0 +1,25 @@
+require_relative 'lib/gemtext/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gemtext"
+  spec.version       = Gemtext::VERSION
+  spec.authors       = ["Exa Stencil"]
+  spec.email         = ["git@exastencil.com"]
+
+  spec.summary       = %q{Gemtext parser for Ruby}
+  spec.description   = %q{Produces a Gemtext::Document of Gemtext::Nodes from a Ruby IO}
+  spec.homepage      = "https://github.com/exastencil/gemtext"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/exastencil/gemtext"
+  spec.metadata["changelog_uri"] = "https://github.com/exastencil/gemtext/blob/main/CHANGELOG.md"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/gemtext.rb

@@ -0,0 +1,6 @@
+require 'gemtext/version'
+require 'gemtext/parser'
+
+module Gemtext
+  class Error < StandardError; end
+end

data/lib/gemtext/document.rb

@@ -0,0 +1,27 @@
+require 'gemtext/node'
+require 'gemtext/heading'
+require 'gemtext/sub_heading'
+require 'gemtext/sub_sub_heading'
+require 'gemtext/whitespace'
+require 'gemtext/text'
+require 'gemtext/list_item'
+require 'gemtext/link'
+require 'gemtext/preformatted'
+require 'gemtext/quote'
+
+module Gemtext
+  # `Gemtext::Document` represents a gemtext document or "page". It
+  # consists of a sequence of `Gemtext::Node`s
+  class Document
+    # Nodes
+    attr_reader :nodes
+
+    def initialize
+      @nodes = []
+    end
+
+    def push(node)
+      @nodes << node if node.is_a? Gemtext::Node
+    end
+  end
+end

data/lib/gemtext/heading.rb

@@ -0,0 +1,7 @@
+module Gemtext
+  class Heading < Node
+    def self.[](content)
+      new content
+    end
+  end
+end

data/lib/gemtext/link.rb

@@ -0,0 +1,20 @@
+module Gemtext
+  class Link < Node
+    attr_reader :description
+    attr_reader :target
+
+    def initialize(content)
+      super content
+      @target = @content.split(/\s+/).first
+      @description = content.delete_prefix(@target).strip
+    end
+
+    def self.[](target, description = nil)
+      new "#{target} #{description}"
+    end
+
+    def ==(other)
+      other.class == self.class && other.target == @target && other.description == @description
+    end
+  end
+end

data/lib/gemtext/list_item.rb

@@ -0,0 +1,7 @@
+module Gemtext
+  class ListItem < Node
+    def self.[](content)
+      new content
+    end
+  end
+end

data/lib/gemtext/node.rb

@@ -0,0 +1,21 @@
+module Gemtext
+  # `Gemtext::Node` represents a piece of a document. There are
+  # a limited number of node types. They store their content with any
+  # formatting needed to identify that content removed.
+  class Node
+    # The content of the node
+    attr_reader :content
+
+    def initialize(content = nil)
+      @content = content
+    end
+
+    def inspect
+      "#{self.class}{#{content}}"
+    end
+
+    def ==(other)
+      other.class == self.class && other.content == @content
+    end
+  end
+end

data/lib/gemtext/parser.rb

@@ -0,0 +1,69 @@
+require 'gemtext/document'
+
+module Gemtext
+  class Parser
+    def initialize(io)
+      @io = io
+      @document = Document.new
+      @preformatted = false
+    end
+
+    def parse
+      @io.each do |line|
+        # Always strip lines to handle "\r\n"
+        stripped = line.strip
+
+        # First check if we're toggling preformatted mode
+        if stripped =~ /^```/
+          if @preformatted
+            # Closing out the preformatted text
+            @preformatted.content.delete_suffix!("\n") # Remove the extra newline from the last line
+            @document.push @preformatted
+            @preformatted = false
+          elsif stripped == '```'
+            # Starting preformatted text without caption
+            @preformatted = Preformatted[""]
+          else
+            # Starting preformatted text with caption
+            @preformatted = Preformatted["", stripped.delete_prefix('```').strip]
+          end
+          next
+        end
+
+        # Once we're in a preformatted block add to the block until we
+        # break out of it
+        if @preformatted
+          @preformatted.content << line
+          next
+        end
+
+        @document.push(
+          case stripped
+          when /^#\s+/
+            Heading[stripped.delete_prefix('#').strip]
+          when /^##\s+/
+            SubHeading[stripped.delete_prefix('##').strip]
+          when /^###\s+/
+            SubSubHeading[stripped.delete_prefix('###').strip]
+          when ""
+            Whitespace[nil]
+          when /^=>/
+            without_arrow = stripped.delete_prefix('=>').strip
+            pieces = without_arrow.split /\s+/
+            url = pieces.first
+            description = pieces.drop(1).join ' ' # TODO: Preserve whitespace in description
+
+            Link[url, description]
+          when /^\*\s/
+            ListItem[stripped.delete_prefix('*').strip]
+          when /^>/
+            Quote[stripped.delete_prefix('>').strip]
+          else
+            Text[line.strip]
+          end
+        )
+      end
+    @document.dup
+    end
+  end
+end

data/lib/gemtext/preformatted.rb

@@ -0,0 +1,16 @@
+module Gemtext
+  class Preformatted < Node
+    def initialize(content, caption = nil)
+      super content
+      @caption = caption
+    end
+
+    def self.[](content, caption = nil)
+      new content, caption
+    end
+
+    def inspect
+      "#{self.class}{#{content}|{#{@caption}}"
+    end
+  end
+end

data/lib/gemtext/quote.rb

@@ -0,0 +1,7 @@
+module Gemtext
+  class Quote < Node
+    def self.[](content)
+      new content
+    end
+  end
+end

data/lib/gemtext/sub_heading.rb

@@ -0,0 +1,11 @@
+module Gemtext
+  class SubHeading < Node
+    def self.[](content)
+      new content
+    end
+
+    def inspect
+      "#{self.class}{#{content}}"
+    end
+  end
+end

data/lib/gemtext/sub_sub_heading.rb

@@ -0,0 +1,7 @@
+module Gemtext
+  class SubSubHeading < Node
+    def self.[](content)
+      new content
+    end
+  end
+end

data/lib/gemtext/text.rb

@@ -0,0 +1,11 @@
+module Gemtext
+  class Text < Node
+    def self.[](content)
+      new content
+    end
+
+    def ==(other)
+      other.class == self.class && other.content == @content
+    end
+  end
+end

data/lib/gemtext/version.rb

@@ -0,0 +1,3 @@
+module Gemtext
+  VERSION = "1.0.0"
+end

data/lib/gemtext/whitespace.rb

@@ -0,0 +1,7 @@
+module Gemtext
+  class Whitespace < Node
+    def self.[](content)
+      new content
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: gemtext
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Exa Stencil
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-20 00:00:00.000000000 Z
+dependencies: []
+description: Produces a Gemtext::Document of Gemtext::Nodes from a Ruby IO
+email:
+- git@exastencil.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemtext.gemspec
+- lib/gemtext.rb
+- lib/gemtext/document.rb
+- lib/gemtext/heading.rb
+- lib/gemtext/link.rb
+- lib/gemtext/list_item.rb
+- lib/gemtext/node.rb
+- lib/gemtext/parser.rb
+- lib/gemtext/preformatted.rb
+- lib/gemtext/quote.rb
+- lib/gemtext/sub_heading.rb
+- lib/gemtext/sub_sub_heading.rb
+- lib/gemtext/text.rb
+- lib/gemtext/version.rb
+- lib/gemtext/whitespace.rb
+homepage: https://github.com/exastencil/gemtext
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/exastencil/gemtext
+  source_code_uri: https://github.com/exastencil/gemtext
+  changelog_uri: https://github.com/exastencil/gemtext/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Gemtext parser for Ruby
+test_files: []