brandish 0.1.1

data/lib/brandish/processors/latex.rb

@@ -0,0 +1,15 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "brandish/processors/latex/markup"
+
+module Brandish
+  module Processors
+    # Processors for generating LaTeX output.  This implements the {Common}
+    # processors.
+    #
+    # @note This does not currently implement the Common processors.
+    module Latex
+    end
+  end
+end

data/lib/brandish/processors/latex/markup.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module Latex
+      # Markup support for the Latex format.  For more information, and
+      # available options, see the {Processors::Common::Markup} processor.
+      #
+      # This markup processor provides the following engines:
+      #
+      # - `:kramdown` - A Markdown formatter.  More information on this
+      #   markup format can be found at <https://github.com/gettalong/kramdown>.
+      #   Available options are: `:template`, `:auto_ids` (not recommended),
+      #   `:auto_id_stripping` (not recommended), `:auto_id_prefix` (not
+      #   recommended), `:parse_block_html`, `:parse_span_html`,
+      #   `:html_to_native`, `:link_defs`, `:footnote_nr`, `:enable_coderay`,
+      #   `:coderay_wrap`, `:coderay_line_numbers`,
+      #   `:coderay_line_number_start`, `:coderay_tab_width`,
+      #   `:coderay_bold_every`, `:coderay_css`, `:coderay_default_lang`,
+      #   `:entity_output`, `:toc_levels` (not recommended), `:line_width`,
+      #   `:latex_headers` (does nothing), `:smart_quotes`,
+      #   `:remove_block_html_tags`, `:remove_span_html_tags`,
+      #   `:header_offset`, `:hard_wrap`, `:syntax_highlighter`,
+      #   `:syntax_highlighter_opts`, `:math_engine`, `:math_engine_opts`,
+      #   `:footnote_backlink`, and `:gfm_quirks`.  Requires the kramdown
+      #   gem.
+      # - `:redcloth` - A Textile formatter.  More information on this
+      #   markup format can be found at <https://github.com/jgarber/redcloth>.
+      #   Available options are: `:filter_html`, `:sanitize_html`,
+      #   `:filter_styles`, `:filter_classes`, `:filter_ids`,
+      #   `:hard_breaks` (deprecated, default), `:lite_mode`,
+      #   and `:no_span_caps`.
+      # - `:escape` - Escapes the content to prevent conflict with the
+      #   resulting format.
+      # @note
+      #   This class provides the `latex:markup` processor.
+      class Markup < Processors::Common::Markup
+        register %i(latex markup) => self
+
+        engine(:kramdown, {}, :initialize_kramdown, :markup_kramdown)
+        engine(:redcloth, [], :initialize_redcloth, :markup_redcloth)
+        engine(:escape, nil, nil, :markup_escape)
+      end
+    end
+  end
+end

data/lib/brandish/scanner.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "strscan"
+require "yoga"
+
+module Brandish
+  # Scans the file for tokens.  This is by default done incrementally, as it's
+  # requested by the parser or whatever consumer wants to use it.  This is done
+  # to make sure that work that doesn't need to be done isn't.
+  class Scanner
+    include Yoga::Scanner
+
+    # The default options for the scanner.
+    #
+    # @return [{::Symbol => ::Object}]
+    DEFAULT_OPTIONS = { tags: %i(< >).freeze }.freeze
+
+    # Initialize the scanner with the given source and file.  If no file
+    # is given, it defaults to `<anon>`.
+    def initialize(*args, **options)
+      super(*args)
+      @options = DEFAULT_OPTIONS.merge(options)
+    end
+
+  private
+
+    def scan
+      scan_escape ||
+        scan_operators ||
+        scan_numerics ||
+        scan_whitespace ||
+        scan_normal ||
+        fail(ScanError) # unreachable
+    end
+
+    def scan_escape
+      match(/\\./, :ESCAPE)
+    end
+
+    def scan_operators
+      operators.find { |(o, n)| (t = match(o, n)) && (return t) }
+    end
+
+    def scan_numerics
+      match(/0[xX][0-9a-fA-F]/, :NUMERIC) || match(/[-+]?\d+(\.\d+)?/, :NUMERIC)
+    end
+
+    def scan_whitespace
+      match_line(:LINE) || match(/[ \v\t\f]+/, :SPACE)
+    end
+
+    def scan_normal
+      match(/[^\d\s\\#{Regexp.escape(operators.keys.join)}]+/, :TEXT)
+    end
+
+    OPERATORS = { "=" => :"=", '"' => :'"', "/" => :"/" }.freeze
+
+    def operators
+      @_operators ||=
+        OPERATORS.merge(@options.fetch(:tags).map(&:to_s).zip([:<, :>]).to_h)
+    end
+  end
+end

data/lib/brandish/version.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  # The running version of Brandish.
+  #
+  # @return [::String]
+  VERSION = "0.1.1"
+end

data/templates/initialize/Gemfile.tt

@@ -0,0 +1,14 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# For edge:
+# gem "brandish", github: "medcat/brandish", branch: "master"
+# For the latest version:
+# gem "brandish"
+# For the running version:
+gem "brandish", "<%= approx %>"
+
+# Markdown support.
+gem "redcarpet"

data/templates/initialize/brandish.config.rb.tt

@@ -0,0 +1,49 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+Brandish.configure do |config|
+  # Sets the root of the brandish documents and output.  This is a path to
+  # where the documents are located.  This is its default value.
+  config.root = "."
+
+  # Sets the brackets to be used for Brandish documents.  By default, they are
+  # the less than and greater than signs, but could be anything, as long as
+  # they are two distinct symbols.
+  # config[:tags] = %i([ ])
+
+  # A "form".  This is a form of output.  Multiple forms are allowed, with
+  # the same formats for each also allowed.
+  config.form :html, <%= :"#{options[:name]}_html".inspect %> do |form|
+    # `.use` adds a processor to the compilation chain for the document.
+    # Each processor updates the AST, changing something about it.  The
+    # `all:literal` processor provides the `<literal>` block tag for Brandish.
+    # All processors are scoped by a format; if no format is provided, the
+    # format for the form is assumed by default.
+    form.use :literal
+    # The `all:if` processor provides the `<if>` and `<unless>` block tags for
+    # Brandish.  It can conditionally include a portion of the text if a
+    # set of conditions are met.
+    # form.use :if, embed: true # if it should use embeded conditions.
+                                # You should only use this if you trust the
+                                # source.
+    form.use :if
+    # `markup` allows the raw text in a document to be parsed as a given
+    # markup.
+    form.use :markup, engine: :redcarpet
+    # This performs error checking of the document, to make sure that no tags
+    # in the documents are left over.
+    form.use "all:verify"
+    # `output` outputs the document in the given format.  This should always
+    # be last.
+    form.use :output
+  end
+
+  # The latex output of the brandish document.
+  # config.form :latex, <%= :"#{options[:name]}_latex".inspect %> do |form|
+  #  form.use "all:literal"
+  #  form.use :markup, engine: :kramdown
+  #  form.use :header
+  #  form.use "all:verify"
+  #  form.use :output
+  # end
+end

metadata

@@ -0,0 +1,296 @@
+--- !ruby/object:Gem::Specification
+name: brandish
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jeremy Rodi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hanami-helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: yoga
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: liquid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+description: A markup language for compiling to different formats.
+email:
+- me@medcat.me
+executables:
+- brandish
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/brandish
+- brandish.gemspec
+- defaults/templates/html.liquid
+- lib/brandish.rb
+- lib/brandish/application.rb
+- lib/brandish/application/bench_command.rb
+- lib/brandish/application/build_command.rb
+- lib/brandish/application/initialize_command.rb
+- lib/brandish/application/serve_command.rb
+- lib/brandish/configure.rb
+- lib/brandish/configure/dsl.rb
+- lib/brandish/configure/dsl/form.rb
+- lib/brandish/configure/form.rb
+- lib/brandish/errors.rb
+- lib/brandish/execute.rb
+- lib/brandish/markup.rb
+- lib/brandish/markup/redcarpet.rb
+- lib/brandish/markup/redcarpet/format.rb
+- lib/brandish/markup/redcarpet/html.rb
+- lib/brandish/parser.rb
+- lib/brandish/parser/main.rb
+- lib/brandish/parser/node.rb
+- lib/brandish/parser/node/block.rb
+- lib/brandish/parser/node/command.rb
+- lib/brandish/parser/node/pair.rb
+- lib/brandish/parser/node/root.rb
+- lib/brandish/parser/node/string.rb
+- lib/brandish/parser/node/text.rb
+- lib/brandish/path_set.rb
+- lib/brandish/processor.rb
+- lib/brandish/processor/base.rb
+- lib/brandish/processor/block.rb
+- lib/brandish/processor/command.rb
+- lib/brandish/processor/context.rb
+- lib/brandish/processor/descend.rb
+- lib/brandish/processor/inline.rb
+- lib/brandish/processor/name_filter.rb
+- lib/brandish/processor/pair_filter.rb
+- lib/brandish/processors.rb
+- lib/brandish/processors/all.rb
+- lib/brandish/processors/all/comment.rb
+- lib/brandish/processors/all/embed.rb
+- lib/brandish/processors/all/if.rb
+- lib/brandish/processors/all/import.rb
+- lib/brandish/processors/all/literal.rb
+- lib/brandish/processors/all/verify.rb
+- lib/brandish/processors/common.rb
+- lib/brandish/processors/common/asset.rb
+- lib/brandish/processors/common/asset/paths.rb
+- lib/brandish/processors/common/group.rb
+- lib/brandish/processors/common/header.rb
+- lib/brandish/processors/common/markup.rb
+- lib/brandish/processors/common/output.rb
+- lib/brandish/processors/html.rb
+- lib/brandish/processors/html/group.rb
+- lib/brandish/processors/html/header.rb
+- lib/brandish/processors/html/markup.rb
+- lib/brandish/processors/html/output.rb
+- lib/brandish/processors/html/output/document.rb
+- lib/brandish/processors/html/script.rb
+- lib/brandish/processors/html/script/babel.rb
+- lib/brandish/processors/html/script/coffee.rb
+- lib/brandish/processors/html/script/vanilla.rb
+- lib/brandish/processors/html/style.rb
+- lib/brandish/processors/html/style/highlight.rb
+- lib/brandish/processors/html/style/sass.rb
+- lib/brandish/processors/html/style/vanilla.rb
+- lib/brandish/processors/latex.rb
+- lib/brandish/processors/latex/markup.rb
+- lib/brandish/scanner.rb
+- lib/brandish/version.rb
+- templates/initialize/Gemfile.tt
+- templates/initialize/brandish.config.rb.tt
+homepage: https://github.com/medcat/brandish
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A markup language for compiling to different formats.
+test_files: []