markie 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a779cd45039bccbf2dffd04137a2908e609331484552e4269dd985da9d288532
+  data.tar.gz: 773b69639460a9d19aeb486a71fad6fd69814216c6c4f65222af643ce0301e37
+SHA512:
+  metadata.gz: 28f22a19ba9fcb37196fb591c72e4a2bb3314b1616972d2857bcc21fb26514b39cc1562b1d718410c08f7354549f921aaaa551010488dd5990638e1388a2d4fa
+  data.tar.gz: afeed9b58bcf5d372afc5511a583835d4ebcd02b5f2a5608e1de5c8719e9188a0bccc32dc244fb18004401c3233d367d705d853159d197399053adcc38c567f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

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 thomascountz@gmail.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in markie.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    markie (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  markie!
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 thomascountz
+
+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,125 @@
+# Markie <img src="https://i.postimg.cc/wxXhdwZr/markie-2.jpg" alt="markie_logo" width="100" align="right"/>
+
+Proof-of-concept Markdown to HTML compiler in Ruby
+
+
+## Grammar v.`6c20d2a`
+
+
+```
+Body           := Paragraph*
+Paragraph      := Sentence+ <NEWLINE> <NEWLINE>
+                | Sentence+ <EOF>
+Sentence       := Text
+                | Emphasis
+                | Link
+Text           := <TEXT>
+Emphasis       := <UNDERSCORE> <TEXT> <UNDERSCORE>
+                | <ASTERISK> <TEXT> <ASTERISK>
+Link           := <OPEN_SQUARE_BRACKET> <TEXT> <CLOSED_SQUARE_BRACKET> <OPEN_PARENTHESIS> <TEXT> <CLOSED_PARENTHESIS>
+```
+
+## Quick Start
+
+Setup Markie for local development
+```
+$ bin/setup
+```
+
+Experiment with Markie
+
+```
+$ bin/console
+```
+
+Run tests
+```
+$ rake
+```
+
+## Example v.`6c20d2a`
+
+```ruby
+markdown = "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"
+=> "[Markie](https://github.com/Thomascountz/markie) isn't _the_ best, but it's fun!"
+
+tokens = Markie::Tokenizer.tokenize(markdown)
+=> [#<Markie::Token:0x00007f942c095c00 @type=:open_square_bracket, @value="[">,
+ #<Markie::Token:0x00007f942c115cc0 @type=:text, @value="Markie">,
+ #<Markie::Token:0x00007f942c11c2f0 @type=:close_square_bracket, @value="]">,
+ #<Markie::Token:0x00007f942c124400 @type=:open_parenthesis, @value="(">,
+ #<Markie::Token:0x00007f942d0e7928 @type=:text, @value="https://github.com/Thomascountz/markie">,
+ #<Markie::Token:0x00007f942d0e5f10 @type=:close_parenthesis, @value=")">,
+ #<Markie::Token:0x00007f942d10d100 @type=:text, @value=" isn't ">,
+ #<Markie::Token:0x00007f942d1171a0 @type=:underscore, @value="_">,
+ #<Markie::Token:0x00007f942d12dc98 @type=:text, @value="the">,
+ #<Markie::Token:0x00007f942d13f5b0 @type=:underscore, @value="_">,
+ #<Markie::Token:0x00007f942d19f7f8 @type=:text, @value=" best, but it's fun!">,
+ #<Markie::Token:0x00007f942d19f690 @type=:eof, @value="">]
+
+ast = Markie::Parser.parse(tokens)
+=> #<Markie::Node:0x00007f942d23a640
+ @children=
+  [#<Markie::Node:0x00007f942d23a708
+    @children=
+     [#<Markie::Node:0x00007f942d23aaf0 @children=[#<Markie::Node:0x00007f942d23abb8 @children=[], @token_count=1, @type=:text, @value="Markie">], @token_count=6, @type=:link, @value="https://github.com/Thomascountz/markie">,
+      #<Markie::Node:0x00007f942d23aa00 @children=[], @token_count=1, @type=:text, @value=" isn't ">,
+      #<Markie::Node:0x00007f942d23a910 @children=[], @token_count=3, @type=:emphasis, @value="the">,
+      #<Markie::Node:0x00007f942d23a820 @children=[], @token_count=1, @type=:text, @value=" best, but it's fun!">],
+    @token_count=11,
+    @type=:paragraph,
+    @value=nil>],
+ @token_count=11,
+ @type=:body,
+ @value=nil>
+```
+
+### Abstract Syntax Tree as JSON
+
+```json
+{
+  "type": "body",
+  "token_count": "11",
+  "value": "",
+  "children": [
+    {
+      "type": "paragraph",
+      "token_count": "11",
+      "value": "",
+      "children": [
+        {
+          "type": "link",
+          "token_count": "6",
+          "value": "https://github.com/Thomascountz/markie",
+          "children": [
+            {
+              "type": "text",
+              "token_count": "1",
+              "value": "Markie",
+              "children": []
+            }
+          ]
+        },
+        {
+          "type": "text",
+          "token_count": "1",
+          "value": " isn't ",
+          "children": []
+        },
+        {
+          "type": "emphasis",
+          "token_count": "3",
+          "value": "the",
+          "children": []
+        },
+        {
+          "type": "text",
+          "token_count": "1",
+          "value": " best, but it's fun!",
+          "children": []
+        }
+      ]
+    }
+  ]
+}
+```

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "markie"
+require "pry"
+
+Pry.start
+

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/markie.rb

@@ -0,0 +1,6 @@
+require "markie/node"
+require "markie/parser"
+require "markie/rule"
+require "markie/token"
+require "markie/tokenizer"
+require "markie/version"

data/lib/markie/node.rb

@@ -0,0 +1,15 @@
+module Markie
+  class Node
+    attr_reader :type, :token_count, :children, :value
+    def initialize(type:, token_count:, children: [], value: nil)
+      @type = type
+      @token_count = token_count
+      @children = children
+      @value = value
+    end
+
+    def to_json
+      "{ \"type\": \"#{type}\", \"token_count\": \"#{token_count}\", \"value\": \"#{value}\", \"children\": [#{children.map(&:to_json).join(", ") if children.any?}] }"
+    end
+  end
+end

data/lib/markie/parser.rb

@@ -0,0 +1,44 @@
+require_relative "token"
+require_relative "node"
+
+module Markie
+  class Parser
+    class << self
+      def parse(tokens)
+        parse_body(tokens)
+      end
+
+      def parse_body(tokens)
+        children = [parse_paragraph(tokens)]
+        Node.new(type: :body, token_count: children.map(&:token_count).sum, children: children)
+      end
+
+      def parse_paragraph(tokens, children = [])
+        if tokens[0].type == :eof
+          return Node.new(type: :paragraph, token_count: children.map(&:token_count).sum, children: children)
+        end
+
+        if tokens[0].type == :text
+          next_child = Node.new(type: :text, token_count: 1, value: tokens[0].value)
+
+        elsif tokens[0].type == :underscore && tokens[1].type == :text && tokens[2].type == :underscore
+          next_child = Node.new(type: :emphasis, token_count: 3, value: tokens[1].value)
+
+        elsif tokens[0].type == :asterisk && tokens[1].type == :text && tokens[2].type == :asterisk
+          next_child = Node.new(type: :emphasis, token_count: 3, value: tokens[1].value)
+
+        elsif tokens[0].type == :open_square_bracket && tokens[1].type == :text && tokens[2].type == :close_square_bracket && tokens[3].type == :open_parenthesis && tokens[4].type == :text && tokens[5].type == :close_parenthesis
+          next_child = Node.new(type: :link, token_count: 6, value: tokens[4].value, children: [
+            Node.new(type: :text, token_count: 1, value: tokens[1].value),
+          ])
+
+        end
+
+        children.append(next_child)
+        next_tokens = tokens[next_child.token_count..-1]
+
+        parse_paragraph(next_tokens, children)
+      end
+    end
+  end
+end

data/lib/markie/rule.rb

@@ -0,0 +1,22 @@
+module Markie
+  class Rule
+    attr_reader :regex
+
+    def initialize(regex:, tokenize_rule:)
+      @regex = regex
+      @tokenize_rule = tokenize_rule
+    end
+
+    def applies_to?(markdown)
+      regex.match?(markdown[0])
+    end
+
+    def tokenize(markdown)
+      tokenize_rule.call(markdown, regex)
+    end
+
+    private
+
+    attr_reader :tokenize_rule
+  end
+end

data/lib/markie/token.rb

@@ -0,0 +1,18 @@
+module Markie
+  class Token
+    attr_reader :type, :value
+
+    def initialize(type:, value: "")
+      @type = type
+      @value = value
+    end
+
+    def length
+      value.length
+    end
+
+    def to_s
+      "{ type: #{type}, value: \"#{value}\" }"
+    end
+  end
+end

data/lib/markie/tokenizer.rb

@@ -0,0 +1,94 @@
+require_relative "token"
+require_relative "./rule"
+
+module Markie
+  class Tokenizer
+    class << self
+      def tokenize(markdown)
+        scan(markdown, [])
+      end
+
+      private
+
+      def scan(markdown, tokens)
+        if markdown.length == 0
+          return tokens.append(eof_token)
+        end
+
+        next_token = nil
+
+        rules.each do |rule|
+          if rule.applies_to?(markdown)
+            next_token = rule.tokenize(markdown)
+            break
+          end
+        end
+
+        if next_token.nil?
+          next_token = text_token(markdown)
+        end
+
+        scan(markdown[next_token.length..-1], tokens.append(next_token))
+      end
+
+      def eof_token
+        Token.new(type: :eof)
+      end
+
+      def text_token(markdown)
+        text = markdown.each_char.take_while { |char|
+          !char.match?(Regexp.union(rules.map(&:regex)))
+        }.join("")
+
+        Token.new(type: :text, value: text)
+      end
+
+      def rules
+        [
+          Rule.new(
+            regex: Regexp.new("\_"),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :underscore, value: "_")
+            }
+          ),
+          Rule.new(
+            regex: Regexp.new("\\*"),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :asterisk, value: "*")
+            }
+          ),
+          Rule.new(
+            regex: Regexp.new("\\["),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :open_square_bracket, value: "[")
+            }
+          ),
+          Rule.new(
+            regex: Regexp.new("\\]"),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :close_square_bracket, value: "]")
+            }
+          ),
+          Rule.new(
+            regex: Regexp.new("\\("),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :open_parenthesis, value: "(")
+            }
+          ),
+          Rule.new(
+            regex: Regexp.new("\\)"),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :close_parenthesis, value: ")")
+            }
+          ),
+          Rule.new(
+            regex: Regexp.new("\n"),
+            tokenize_rule: ->(markdown, regex) {
+              Token.new(type: :newline, value: "\n")
+            }
+          ),
+        ]
+      end
+    end
+  end
+end

data/lib/markie/version.rb

@@ -0,0 +1,3 @@
+module Markie
+  VERSION = "0.0.1"
+end

data/markie.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "markie/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "markie"
+  spec.version = Markie::VERSION
+  spec.authors = ["thomascountz"]
+  spec.email = ["thomascountz@gmail.com"]
+
+  spec.summary = "Markdown to HTML compiler"
+  spec.homepage = "https://github.com/Thomascountz/markie"
+  spec.license = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  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 = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: markie
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thomascountz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: 
+email:
+- thomascountz@gmail.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/markie.rb
+- lib/markie/node.rb
+- lib/markie/parser.rb
+- lib/markie/rule.rb
+- lib/markie/token.rb
+- lib/markie/tokenizer.rb
+- lib/markie/version.rb
+- markie.gemspec
+homepage: https://github.com/Thomascountz/markie
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.0.6
+signing_key: 
+specification_version: 4
+summary: Markdown to HTML compiler
+test_files: []