fluent_markdown_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5d82d0aecb2d8e3a806de7b768061c80674da1e6345dd4fca5b1241d34775ac
+  data.tar.gz: 20cd19c395244dc3e61b3123b83d1ac9dc6704471b5ded81c0d8c4c7ff7eca21
+SHA512:
+  metadata.gz: f1fec3cc3158b6de2795cb40ae59ab37de6fb320e3db723605303739c5de4ce2229dd3b7e648c73c0e62b272d7abfea0bc43cfe321832f5a11df1d3f9986fe9b
+  data.tar.gz: e5bff018b386944b3e55da75f82b7b0d993e5c74a1370b89da8b090d261d44824e065a408fa1a597e68c110b2ee919e4af1109c41231b637e0efcc9af3cd26c9

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Niklas Schultz
+
+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,78 @@
+# Fluent Markdown Builder
+
+The fluent markdown builder is a ruby gem which provides a fluent interface
+for creating markdown content.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent_markdown_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent_markdown_builder
+
+## Usage
+
+This gem only has one file intended to be used by the client: The Markdown.rb
+
+You can simply create an object from this class and start building your markdown
+content like the following example demonstrates:
+
+```ruby
+md = Markdown.new('The fluent markdown builder gem')
+             .text('This is a gem which allows you to generate markdown syntax')
+             .text(' via a fluent builder pattern.')
+             .new_line
+             .text('Let\'s show some more functionality')
+             .new_line
+             .header(2, 'Lists')
+             .text('There are two type of lists:')
+             .paragraph
+             .bold('Organized lists:')
+             .new_line
+             .ol(['Some item', 'Another item', 'And yet another item'])
+             .bold('Unorganized lists:')
+             .new_line
+             .ul(['More items!', 'And even more', '...'])
+             .header(2, 'Hyperlinks')
+             .cursive('You can also add hyperlinks:')
+             .new_line
+             .hyperlink('Link to google', 'https://www.google.com', 'Take me to google')
+             .paragraph
+             .header(2, 'Code')
+             .text('We can also add code snippets')
+             .new_line
+             .code('#define 1 0')
+             .paragraph
+             .horizontal_line
+             .cursive('I think that should be enough for a short demo')
+             .new_line
+             .quote('Have a nice day')
+             .to_s
+```
+
+Now you can write the (string) content into a file for example and display it in
+a markdown viewer.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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.
+
+## Contributing
+
+Bug reports and pull requests are very welcome and highly appreciated 
+on GitHub at https://github.com/SNException/fluent_markdown_builder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent_markdown_builder"
+
+# 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/fluent_markdown_builder.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "core/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent_markdown_builder"
+  spec.version       = FluentMarkdownBuilder::VERSION
+  spec.authors       = ["Niklas Schultz"]
+  spec.email         = ["thexsalkin@gmail.com"]
+
+  spec.summary       = 'A fluent markdown builder'
+  spec.description   = 'A fluent interface to generate markdown easily.'
+  spec.homepage      = 'https://github.com/SNException/fluent_markdown_builder'
+  spec.license       = "MIT"
+
+  # 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        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |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 "minitest", "~> 5.10"
+end

data/lib/core/markdown.rb

@@ -0,0 +1,166 @@
+# MIT License
+#
+# Copyright 2019 Niklas Schultz.
+#
+# 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.
+
+# The Markdown object.
+# All its methods (with the exception of to_s) return 'self'.
+# That way you can use this object as fluent builder to create your
+# Markdown content.
+#
+# author:: Niklas Schultz
+# version:: 0.1.0
+# license:: MII
+class Markdown
+  # Creates a new object.
+  #
+  # You can ignore the argument so no header will be added on construction of
+  # this object.
+  def initialize(h1 = '')
+    @md = ''
+    unless h1.empty? then header(1, h1) end
+   end
+
+  # Adds a string to the current content.
+  def text(txt)
+    @md += txt
+    self
+  end
+
+  # Adds a header to the markdown content.
+  #
+  # The first argument specifies the header level (h1, h2...h6).
+  def header(level, txt)
+    raise ArgumentError, 'header level must not be 0 or smaller' if level <= 0
+    raise ArgumentError, 'header level must not be greater than 6' if level > 6
+
+    hashes = ''
+    level.times do
+      hashes += '#'
+    end
+    text(hashes + ' ' + txt)
+    paragraph
+  end
+
+  # Adds a horizontal line.
+  def horizontal_line
+    text('---')
+    paragraph
+  end
+
+  # Adds text which is cursive.
+  def cursive(txt)
+    text('*' + txt.rstrip.lstrip + '*')
+  end
+  
+  # Adds text which is bold.
+  def bold(txt)
+    text('**' + txt.rstrip.lstrip + '**')
+  end
+
+  # Adds text which is both bold and cursive.
+  def bold_and_cursive(txt)
+    text('***' + txt.rstrip.lstrip + '***')
+  end
+  
+  # Adds a quote.
+  def quote(txt)
+    text('> ' + txt)
+  end
+
+  # Adds a line of code.
+  def code(txt)
+    text('`' + txt + '`')
+  end
+
+  # Adds an unorganized list out of the given array.
+  def ul(bullet_points)
+    unless bullet_points.respond_to?(:each)
+      raise ArgumentError, 'arg must respond to "each" call'
+    end
+
+    md_list = ''
+    bullet_points.each do |v|
+      md_list += '* ' + v + line_feed
+    end
+    text(md_list)
+    paragraph
+  end
+
+  # Adds an organized list out of the given array.
+  def ol(bullet_points)
+    unless bullet_points.respond_to?(:each_with_index)
+      raise ArgumentError, 'arg must respond to "each_width_index" call'
+    end
+
+    md_list = ''
+    bullet_points.each_with_index do |v, i|
+      md_list += (i + 1).to_s + '. ' + v + line_feed
+    end
+    text(md_list)
+    paragraph
+  end
+
+  # Adds a hyperlink.
+  #
+  # This method takes three arguments:
+  # 1. The description of the hyperlink (the actual text shown)
+  # 2. The target of the hyperlink (e.g. https://google.com)
+  # 3. The text which will be displayed if you hover over the link
+  def hyperlink(desc, target, hover)
+    text('[' + desc + ']' + '(' + target + ' ' + '"' + hover + '"' + ')')
+  end
+
+  # Adds an image.
+  #
+  # This method takes three arguments:
+  # 1. The alternative text displayed if no image could be loaded
+  # 2. The path/resource of the image (e.g on your file system)
+  # 3. The text which will be displayed if you hover over the image
+  def image(alternative, path, hover)
+    text('![' + alternative + ']' + '(' + path + ' ' + '"' + hover + '"' + ')')
+  end
+
+  # Adds a new (empty) line.
+  def new_line
+    two_spaces = '  '
+    text(two_spaces + line_feed)
+  end
+
+  # Adds a new paragraph.
+  def paragraph
+    text(line_feed + line_feed)
+  end
+
+  # Converts this object to a string.
+  #
+  # In other words this method should be the final call you should invoke when
+  # you done creating the markdown content. After this call you can use the
+  # produced string and show it in a markdown viewer for example.
+  def to_s
+    @md
+  end
+
+  private
+
+  def line_feed
+    "\n"
+  end
+end

data/lib/core/version.rb

@@ -0,0 +1,28 @@
+# MIT License
+#
+# Copyright 2019 Niklas Schultz.
+#
+# 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.
+
+# author:: Niklas Schultz
+# version:: 0.1.0
+# license:: MII
+module FluentMarkdownBuilder
+  VERSION = '0.1.0'
+end

data/lib/fluent_markdown_builder.rb

@@ -0,0 +1,28 @@
+# MIT License
+#
+# Copyright 2019 Niklas Schultz.
+#
+# 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.
+
+
+# author:: Niklas Schultz
+# version:: 0.1.0
+# license:: MII
+require 'core/version'
+require 'core/markdown.rb'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fluent_markdown_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Niklas Schultz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-26 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.10'
+description: A fluent interface to generate markdown easily.
+email:
+- thexsalkin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent_markdown_builder.gemspec
+- lib/core/markdown.rb
+- lib/core/version.rb
+- lib/fluent_markdown_builder.rb
+homepage: https://github.com/SNException/fluent_markdown_builder
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A fluent markdown builder
+test_files: []