belletrist 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d59cf0de5fc3b77ee612b1bec7fc8a41db26bf7475e1f4943967871f41f024d
+  data.tar.gz: 62755a4c1c86779d64f29857cfce47fecb3740562ce53105cb35b6666cfaabd5
+SHA512:
+  metadata.gz: a7a9d2b6c69834b2054f364271abff3362ccf37fbdcc789c482c6d2243225cf041cbc388b4bf9f7185501be7a12848152fdb15840dc8254faa1239c1833cc0a3
+  data.tar.gz: 2918a2a44daa4495d1955378e6d8962d312d635fb99ba600a7a81480525b1a9340b08f9ac59768c2a89df310477525562ed49d2c5f6de5a0a361473b5d3d618e

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Scribe Changelog
+This file contains general, high level explanations of the differences between versions. Please check the commmit
+history for further details.
+
+## 1.0.3
+* Actually added the LICENSE file to the gem.
+
+## 1.0.1 & 1.0.2
+* Dumb fixes to correct errors in me getting all of this laid out. No functional change.
+
+## 1.0.0
+* Created the initial DSL for HTML generation, includes sanitizing and array mapping capabilities.
+* HTML DSL also supports sub-elements by subclassing HTML::Element, and using the `with` method.

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023
+
+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,37 @@
+# Belletrist
+Belletrist is a collection of Ruby DSLs for generation of different data file types. Currently, HTML is supported, but
+that will grow as my needs do, or if other people want or contribute any other DSLs, which would be pretty cool I think.
+
+Important to note is that Belletrist has a focus on performance, not correctness. Belletrist ascribes to the rule of
+"what goes in, must come out". Belletrist DSLs must output well-formed documents so long as the developer provides
+Belletrist valid input, if that contract is broken the result is undefined.
+
+## Requirements of a Belletrist DSL
+ * All input must be sanitized, and sanitization is not optional.
+ * Correctness of input is not a concern of the DSL, but of the developer.
+
+## Using
+Below are some examples of how you can use the different DSLs provided by Belletrist.
+
+### HTML
+```ruby
+require 'belletrist'
+
+da_rulez = ['Be hip!', 'Be cool!', 'Don\'t be square!']
+
+document = Belletrist::HTML::Document.new
+document.head do
+  title 'Some Kind of Web Page'
+  meta name: 'description', content: 'Example'
+end
+document.body do
+  h1 'My Very Cool Website'
+  p 'Please follow the rules:'
+  ol.map da_rulez do |rule|
+    li rule
+  end
+end
+
+# String conversation is serialization of the input.
+print document.to_s
+```

data/belletrist.gemspec

@@ -0,0 +1,22 @@
+require_relative './lib/belletrist/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'belletrist'
+  s.version     = Belletrist::VERSION
+  s.licenses    = ['MIT']
+  s.summary     = 'A collection of Ruby DSLs for data file generation.'
+  s.description = <<-EOF
+Belletrist is a collection of Ruby DSLs for generation of different data file types. Currently, HTML is supported, but
+that will grow as my needs do, or if other people want or contribute any other DSLs, which would be pretty cool I think.
+
+Important to note is that Belletrist has a focus on performance, not correctness. Belletrist ascribes to the rule of
+"what goes in, must come out". Belletrist DSLs must output well-formed documents so long as the developer provides
+Belletrist valid input, if that contract is broken the result is undefined.
+  EOF
+  s.authors     = ['Juniper']
+  s.email       = 'me@junisoft.org'
+  s.files       = Dir['lib/**/*.rb'] + %w[README.md CHANGELOG.md belletrist.gemspec LICENSE]
+  s.homepage    = 'https://codeberg.org/juniper/Belletrist'
+  s.metadata    = { "source_code_uri" => "https://codeberg.org/juniper/Belletrist" }
+  s.required_ruby_version = '>= 2.7.0'
+end

data/lib/belletrist/abstract.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Belletrist
+  class BaseCollector
+    attr_reader :elements
+
+    def initialize
+      @elements = []
+    end
+
+    def to_s
+      @elements.map {|e| e.to_s}.join('')
+    end
+
+    private def method_missing(symbol, *args, &block)
+      with new_element(symbol.to_s, args), &block
+    end
+
+    private def new_element(ele, args)
+      raise NotImplementedError
+    end
+
+    def p(*args, &block)
+      method_missing(:p, *args, &block)
+    end
+
+    def with(ele, &block)
+      @elements.push ele
+      ele.children.instance_eval(&block) if block
+      ele
+    end
+
+    def map(arr, &block)
+      arr.each do |item|
+        instance_exec item, &block
+      end
+    end
+
+    def responds_to?(method)
+      true
+    end
+  end
+end

data/lib/belletrist/html.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require_relative './abstract'
+
+module Belletrist::HTML
+  class Base
+    attr_reader :children
+
+    def initialize
+      @children = Collector.new
+    end
+
+    def inspect
+      self.to_s
+    end
+  end
+
+  class Element < Base
+    ESCAPE_HTML = {
+      "&" => "&amp;",
+      "<" => "&lt;",
+      ">" => "&gt;",
+      "'" => "&#x27;",
+      '"' => "&quot;",
+      "/" => "&#x2F;"
+    }
+    ESCAPE_HTML_PATTERN = Regexp.union(ESCAPE_HTML.keys)
+
+    attr_accessor :text
+    attr_reader :name
+
+    def initialize(name, args)
+      super()
+      @name = name.to_s
+      @attr = []
+      @text = ""
+
+      args.each do |arg|
+        if arg.is_a?(Hash)
+          import_attribute(arg)
+        else
+          @text += arg.to_s
+        end
+      end
+
+      component(@children)
+    end
+
+    def component(c)
+    end
+
+    private def import_attribute(hash)
+      hash.each do |entry|
+        k, v = entry
+        @attr.push [s_key(k.to_s), "\"#{s_quoted(v)}\""].join('=')
+      end
+    end
+
+    private def s_key(key)
+      key.gsub(/\W/, '')
+    end
+
+    private def s_quoted(value)
+      value.gsub(/"/, '&quot;')
+    end
+
+    private def s_txt(text)
+      text.gsub(ESCAPE_HTML_PATTERN, ESCAPE_HTML)
+    end
+
+    def map(arr, &block)
+      arr.each do |item|
+        @children.instance_exec item, &block
+      end
+    end
+
+    def to_s
+      spacer = ''
+      spacer = ' ' if @attr.length > 0
+      "<#{s_key(@name)}#{spacer}#{@attr.join(' ')}>#{s_txt(@text)}#{@children}</#{s_key(@name)}>"
+    end
+  end
+
+  class Document < Base
+    def initialize(spec=V5)
+      super()
+      @head = Collector.new
+      @body = Collector.new
+      @spec = spec
+    end
+
+    def head(&block)
+      @head.instance_eval(&block) if block
+      @head
+    end
+
+    def body(&block)
+      @body.instance_eval(&block) if block
+      @body
+    end
+
+    def to_s
+      "#{@spec}<html><head>#{@head}</head><body>#{@body}</body></html>"
+    end
+  end
+
+  class Collector < Belletrist::BaseCollector
+    def new_element(name, args)
+      Element.new(name, args)
+    end
+  end
+
+  V5 = '<!DOCTYPE html>'
+  V4 = '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 strict//EN" "http://www.w3.org/TR/html4/strict.dtd">'
+end

data/lib/belletrist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Belletrist
+  VERSION = '1.0.3'
+end

data/lib/belletrist.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require_relative 'belletrist/version'
+require_relative 'belletrist/html'
+
+module Belletrist
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: belletrist
+version: !ruby/object:Gem::Version
+  version: 1.0.3
+platform: ruby
+authors:
+- Juniper
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-12-17 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Belletrist is a collection of Ruby DSLs for generation of different data file types. Currently, HTML is supported, but
+  that will grow as my needs do, or if other people want or contribute any other DSLs, which would be pretty cool I think.
+
+  Important to note is that Belletrist has a focus on performance, not correctness. Belletrist ascribes to the rule of
+  "what goes in, must come out". Belletrist DSLs must output well-formed documents so long as the developer provides
+  Belletrist valid input, if that contract is broken the result is undefined.
+email: me@junisoft.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- belletrist.gemspec
+- lib/belletrist.rb
+- lib/belletrist/abstract.rb
+- lib/belletrist/html.rb
+- lib/belletrist/version.rb
+homepage: https://codeberg.org/juniper/Belletrist
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://codeberg.org/juniper/Belletrist
+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.3.26
+signing_key:
+specification_version: 4
+summary: A collection of Ruby DSLs for data file generation.
+test_files: []