drawght 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 776b1ea99f39fc1716543bd837504d10ca2648babb6e283c0bbf0dcc6db10b5f
+  data.tar.gz: 0aa2b64aaa564b8194266ac18d37627ae384ba3cf4e39d7ad84a3a5c342ef36c
+SHA512:
+  metadata.gz: 73a0b217f9ba7ecca5aaad07a182bc9756714245bd12af06a75b288b781f62bbbb6cce10013dcbcce66cc4e7a3631f62c07ed7ea9a0a50edf4525eb29dd3fd45
+  data.tar.gz: 96895069175bf3326d10e4a40f6276120043b650d77211ed00dca259c00f4ddedeaa2d28622c35a70c12e15c02a42db5e4dd1dbda936ae1d2398b3b8c092cf0b

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright © 2021, Hallison Batista
+
+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,211 @@
+# Drawght
+
+Drawght is a data handler for texts without logical statements. The goal is
+to use a dataset (such as the subject of a text) to draft a document
+template. It can be considered a mini template processor.
+
+Data is accessed through `{}` braces, replaced by their respective values.
+
+Considering the following data:
+
+```yaml
+title: Drawght is a very useful sketch
+author:
+  name: Hallison Batista
+  email: email@hallison.dev.br
+  networks:
+  - name: Github
+    url: //github.com/hallison
+  - name: Twitter
+    url: //twitter.com/hallison
+creation-date: 2021-06-28
+publishing date: 2021-07-01
+references:
+- name: Mustache
+  url: //mustache.github.io
+- name: Handlebars
+  url: //handlebarsjs.com
+tags:
+- Template
+- Draft
+```
+
+Note that the `creation-date` and `publishing date` fields are normally
+identified by the parser.
+
+In a template written in Markdown: 
+
+```markdown
+# {title}
+
+Drawght is a good tool for writing draft documents using datasets without
+logical statements.
+
+Written by {author.name} <{author.email}>, created in {creation-date},
+published in {publishing date} and tagged by {tags#1}.
+
+- [{author.networks:name}]({author.networks:url})
+
+Follow the news on [{author.networks#1.name}]({author.networks#1.url}).
+
+The syntax was inspired by: 
+
+- [{references:name}]({references:url})
+
+Tags:
+
+- {tags} (tagged by {author.name}).
+```
+
+The Drawght processing returns the following result:
+
+```markdown
+# Drawght is a very useful sketch
+
+Drawght is a good tool for writing draft documents using datasets without
+logical statements.
+
+Written by Hallison Batista <email@hallison.dev.br>, created in 2021-06-28,
+published in 2021-07-01 and tagged by Template.
+
+- [Dev.to](//dev.to/hallison)
+- [Github](//github.com/hallison)
+- [Twitter](//twitter.com/hallison)
+
+Follow the news on [Dev.to](//dev.to/hallison).
+
+The syntax was inspired by:
+
+- [Mustache](//mustache.github.io)
+- [Handlebars](//handlebarsjs.com)
+
+Tags:
+
+- Template (tagged by Hallison Batista).
+- Draf (tagged by Hallison Batista).
+```
+
+In a template written in HTML: 
+
+```html
+<h1>{title}</h1>
+
+<p>
+Drawght is a good tool for writing draft documents using datasets without
+logical statements.
+</p>
+
+<p>
+Written by <a href="mailto:{author.email}">{author.name}</a>, created
+published in {publishing date} and tagged by {tags#1}.
+</p>
+
+<ul>
+  <li><a href="{author.networks:url}">{author.networks:name}</a></li>
+</ul>
+
+<p>
+Follow the news on <a href="{author.networks#1.url}">author.networks#1.name</a>.
+</p>
+
+<p>
+The syntax was inspired by: 
+</p>
+
+<ul>
+  <a href="{references:url}">{references:name}</a>
+</ul>
+
+<p>
+Tags:
+</p>
+
+<ul>
+  <li>{tags} (tagged by {author.name}).</li>
+</ul>
+```
+
+The Drawght processing returns the following result:
+
+```html
+<h1>Drawght is a very useful sketch</h1>
+
+<p>
+Drawght is a good tool for writing draft documents using datasets without
+logical statements.
+</p>
+
+<p>
+Written by <a href="mailto:email@hallison.dev.br">Hallison Batista</a>,
+created published in 2021-07-01 and tagged by Template.
+</p>
+
+<ul>
+  <li><a href="//dev.to/hallison">Dev.to</a></li>
+  <li><a href="//github.com/hallison">Github</a></li>
+  <li><a href="//twitter.com/hallison">Twitter</a></li>
+</ul>
+
+<p>
+Follow the news on <a href="//dev.to/hallison">Dev.to</a>.
+</p>
+
+<p>
+The syntax was inspired by:
+</p>
+
+<ul>
+  <a href="//mustache.github.io">Mustache</a>
+  <a href="//handlebarsjs.com">Handlebars</a>
+</ul>
+
+<p>
+Tags:
+</p>
+
+<ul>
+  <li>Template (tagged by Hallison Batista).</li>
+  <li>Draf (tagged by Hallison Batista).</li>
+</ul>
+```
+
+## Syntax
+
+Drawght has a simple syntax:
+
+- `{key}`: converts `key` to its respective value. If the value is a list, then
+  the row will be replicated and converted with the respective values. 
+
+- `{object.key}`: converts `key` to its respective value inside `object`,
+  assuming the same behavior as `{key}`. 
+
+- `{list:key}`: selects `list`, replicates the line for each item in the list,
+  and converts `key` to its respective value contained in an object within
+  `list`. The `list` key can also be accessed by `object.list`, just as `key`
+  can also be accessed by `object.key` which will be converted following the
+  same process in case it is a list. 
+
+- `{list#n.key}`: selects item object `n` (from 1) from `list` and converts
+  `key` to its respective value. The whole process is similar to `object.key`. 
+
+## License (MIT)
+
+### Copyright (c) 2021, Hallison Batista
+
+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/drawght.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |spec|
+  spec.name      = "drawght"
+  spec.summary   = "Drawght parser implementation in Ruby."
+  spec.authors   = ["Hallison Batista"]
+  spec.email     = "email@hallison.dev.br"
+  spec.homepage  = "https://github.com/drawght/drawght-ruby"
+  spec.version   = %x(git describe --tags --abbrev=0)
+  spec.date      = %x(git log --format='%as' --max-count=1)
+  spec.licenses  = ["MIT"]
+  spec.platform  = Gem::Platform::RUBY
+
+  spec.files = %x(git ls-files).split.reject do |out|
+    ignore = out =~ /([MR]ake|Gem)file/ || out =~ /^\./
+    ignore = ignore || out =~ /example\..*/
+    ignore = ignore || out =~ %r{^doc/api} || out =~ %r{^test/.*}
+    ignore
+  end
+
+  spec.test_files = spec.files.select do |path|
+    path =~ %r{^test/.*}
+  end
+
+  spec.description = <<-end.gsub /^[ ]{4}/m, ""
+    Drawght is a data handler for texts without logical statements. The goal is
+    to use a dataset (such as the subject of a text) to draft a document
+    template. It can be considered a mini template processor.
+  end
+
+  spec.require_paths = ["lib"]
+end

data/lib/drawght.rb

@@ -0,0 +1,7 @@
+module Drawght
+  require_relative "drawght/parser"
+
+  def self.new(template)
+    Drawght::Parser.new template
+  end
+end

data/lib/drawght/parser.rb

@@ -0,0 +1,68 @@
+class Drawght::Parser
+  PREFIX, ATTRIBUTE, QUERY, ITEM, SUFFIX,  = "{", ".", ":", "#", "}"
+  KEY, LIST, INDEX = "(?<key>.*?)", "(?<list>.*?)", "(?<index>.*?)"
+  EOL = /\r?\n/
+
+  KEY_PATTERN = Regexp.new "#{PREFIX}#{KEY}#{SUFFIX}"
+  LIST_PATTERN = Regexp.new "#{PREFIX}#{LIST}#{QUERY}#{KEY}#{SUFFIX}"
+  ITEM_PATTERN = Regexp.new "#{LIST}#{ITEM}#{INDEX}([#{ATTRIBUTE}]#{KEY})?$"
+
+  def initialize(template)
+    @template = template
+  end
+
+  def parse(data)
+    self.parse_keys(self.parse_queries(@template, data), data)
+  end
+
+  def parse_queries(template, data)
+    template.split(EOL).map do |line|
+      result = line
+      line.scan LIST_PATTERN do |(list, key)|
+        value = value_from_key(list, data)
+        if value && (value.kind_of? Array) && key
+          partial = line.gsub("#{list}#{QUERY}", "")
+          parsed_lines = value.map { |item| parse_template(partial, item) }
+          result = result.gsub(line, parsed_lines.join("\n"))
+        end
+      end
+      result
+    end.join("\n")
+  end
+
+  def parse_keys(template, data)
+    template.split(EOL).map do |line|
+      parse_template(line, data)
+    end.join("\n"); 
+  end
+
+  def parse_template(template, data)
+    result = template
+    template.scan KEY_PATTERN do |(key)|
+      template_key = "#{PREFIX}#{key}#{SUFFIX}"
+      value = value_from_key(key, data) || template_key
+      if value.kind_of? Array
+        result = value.map { |item| template.gsub(template_key, item) }.join("\n")
+      else
+        result = result.gsub(template_key, value.to_s)
+      end
+    end
+    result
+  end
+
+  private
+
+  def value_from_key(nested_key, data)
+    item = nested_key.match ITEM_PATTERN
+    if item
+      list, index, key = item.captures
+      index = index && (index.to_i)
+      value = data.dig *list.split(ATTRIBUTE)
+      if value && (value.kind_of? Array) && index
+        key ? value[index - 1][key] : value[index - 1]
+      end
+    else
+      data.dig *nested_key.split(ATTRIBUTE)
+    end
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: drawght
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Hallison Batista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-07-11 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Drawght is a data handler for texts without logical statements. The goal is
+  to use a dataset (such as the subject of a text) to draft a document
+  template. It can be considered a mini template processor.
+email: email@hallison.dev.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- drawght.gemspec
+- lib/drawght.rb
+- lib/drawght/parser.rb
+homepage: https://github.com/drawght/drawght-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Drawght parser implementation in Ruby.
+test_files: []