brandish 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86feab5398244c93d5f1611dd767c8729ae38496
+  data.tar.gz: d7052a18a14e35af428f52d7813bb477486ebbfb
+SHA512:
+  metadata.gz: c966e40a9ee589b88dce82aae60599a84d8329554c2e1d51a4a5c1f1c79ef27473263c07856456d0ab4538933b86f2383d36c168ce4a84be29ede33861d2d31b
+  data.tar.gz: 1baea0c61653b3469b1dac38f360c39c9c80133a5fd748673057874893821d1d3c90ef9a99aef8b7498f04502a66882895d4759a7ab88b26f8923a3da36149b0

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/site/

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--require pry

data/.rubocop.yml

@@ -0,0 +1,41 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Max: 15
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/*.rb'
+    - 'spec/**/*.rb'
+    - 'brandish.gemspec'
+Metrics/AbcSize:
+  Max: 25
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+Style/SignalException:
+  EnforcedStyle: only_fail
+Style/AccessModifierIndentation:
+  EnforcedStyle: outdent
+Style/Documentation:
+  Enabled: false
+Style/Encoding:
+  Enabled: true
+  EnforcedStyle: always
+  AutoCorrectEncodingComment: "# encoding: utf-8\n"
+Style/RegexpLiteral:
+  EnforcedStyle: mixed
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+Style/AlignArray:
+  Enabled: false
+Style/IndentArray:
+  Enabled: false
+Style/Alias:
+  EnforcedStyle: prefer_alias_method
+Style/ParallelAssignment:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.2
+before_install: gem install bundler -v 1.13.6

data/.yardopts

@@ -0,0 +1 @@
+-m markdown

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 me@medcat.me. 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,10 @@
+# encoding: utf-8
+
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gem "pry"
+gem "pry-rescue"
+gem "pry-stack_explorer"
+# Specify your gem's dependencies in brandish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeremy Rodi
+
+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,41 @@
+# Brandish
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/brandish`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'brandish'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install brandish
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/medcat/brandish. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/brandish

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: true
+
+load_path = File.expand_path(File.join(__FILE__, "../../lib"))
+$LOAD_PATH.unshift(load_path) unless $LOAD_PATH.include?(load_path)
+require "brandish"
+require "brandish/application"
+
+class Object
+  def taint
+    fail
+  end
+end
+
+Brandish::Application.call

data/brandish.gemspec

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "brandish/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "brandish"
+  spec.version       = Brandish::VERSION
+  spec.authors       = ["Jeremy Rodi"]
+  spec.email         = ["me@medcat.me"]
+
+  spec.summary       = "A markup language for compiling to different formats."
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/medcat/brandish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency "hanami-helpers", "~> 0.5"
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "commander", "~> 4.4"
+  spec.add_dependency "listen", "~> 3.0"
+  spec.add_dependency "sass", "~> 3.4"
+  spec.add_dependency "yoga", "~> 0.4"
+  spec.add_dependency "liquid", "~> 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.13"
+  spec.add_development_dependency "rubocop", "~> 0.47"
+end

data/defaults/templates/html.liquid

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+
+    <title>{{ title | escape }}</title>
+    <meta name="description" content="{{ description | escape }}">
+    <meta name="author" content="{{ author | escape }}">
+
+    {% for style in styles %}
+      {% if style.inline? %}
+        {% comment %}
+          Style and Script tags, in HTML5, are CDATA.  No escaping needed.
+        {% endcomment %}
+        <style>{{ style.content }}</style>
+      {% else %}
+        <link rel="stylesheet" href="{{ style.content | escape }}">
+      {% endif %}
+    {% endfor %}
+  </head>
+
+  <body>
+    <div id="container">
+      {{ content }}
+    </div>
+
+    {% for script in scripts %}
+      {% if script.inline? %}
+        {% comment %}
+          Style and Script tags, in HTML5, are CDATA.  No escaping needed.
+        {% endcomment %}
+        <script>{{ script.content }}</script>
+      {% else %}
+        <script src="{{ script.content | escape }}"></script>
+      {% endif %}
+    {% endfor %}
+  </body>
+</html>

data/lib/brandish.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "brandish/version"
+require "brandish/errors"
+require "brandish/path_set"
+require "brandish/configure"
+require "brandish/scanner"
+require "brandish/parser"
+require "brandish/markup"
+require "brandish/processor"
+require "brandish/processors"
+
+# A library to format text.
+module Brandish
+  # @overload self.configuration(&block)
+  #   Sets the configuration object to a new {Configure} object, and builds it
+  #   using {Configure::DSL.call}.  The configuration object is then returned.
+  #
+  #   @yield
+  #   @return [Configure]
+  # @overload self.configuration
+  #   Returns the current configuration object.
+  #
+  #   @return [Configure]
+  def self.configuration(root = ::Dir.pwd)
+    if block_given?
+      @configuration ||= Configure.new(::File.expand_path(root))
+      Configure::DSL.call(@configuration, &::Proc.new)
+    else
+      @configuration
+    end
+  end
+
+  # Sets the configuration object to a new {Configure} object, and builds it
+  # using {Configure::DSL.call}.  The configuration object is then returned.
+  #
+  # @yield
+  # @return [Configure]
+  def self.configure(&b)
+    configuration(&b)
+  end
+
+  # Resets the configuration object, so that it can be redefined.  This is
+  # used to clear out the previous configuration.
+  #
+  # @return [void]
+  def self.reset_configuration
+    @configuration = nil
+  end
+end

data/lib/brandish/application.rb

@@ -0,0 +1,163 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "webrick"
+require "pathname"
+require "commander"
+require "listen"
+require "brandish/application/bench_command"
+require "brandish/application/build_command"
+require "brandish/application/initialize_command"
+require "brandish/application/serve_command"
+
+module Brandish
+  # The command line interface for Brandish.
+  #
+  # @api private
+  class Application
+    include Commander::Methods
+
+    # The name of the configure file.  This should be `"brandish.config.rb"`,
+    # but may change in the future (maybe `Brandishfile`?).
+    #
+    # @return [::String]
+    attr_reader :config_file
+
+    # The executing directory for the application.  This is provided with the
+    # global option `-d`.  Using this should be the same as using `cd` and
+    # executing the command.
+    #
+    # @return [::String]
+    attr_reader :directory
+
+    # Defines and runs the command line interface.
+    #
+    # @see #call
+    # @return [void]
+    def self.call
+      new.call
+    end
+
+    # Defines and runs the command line interface.
+    #
+    # @see #program_information
+    # @see #configure_global_option
+    # @see #directory_global_option
+    # @see InitializeCommand.define
+    # @see BenchCommand.define
+    # @see BuildCommand.define
+    # @see ServeCommand.define
+    # @return [void]
+    def call
+      program_information
+      configure_global_option
+      directory_global_option
+      command(:initialize) { |c| InitializeCommand.define(self, c) }
+      command(:bench) { |c| BenchCommand.define(self, c) }
+      command(:build) { |c| BuildCommand.define(self, c) }
+      command(:serve) { |c| ServeCommand.define(self, c) }
+      alias_command(:init, :initialize)
+      default_command(:build)
+      run!
+    end
+
+    # The program information.  This is for use with Commander.
+    #
+    # @return [void]
+    def program_information
+      program :name, "Brandish"
+      program :version, Brandish::VERSION
+      program :help_formatter, :compact
+      program :help_paging, false
+      program :description, "A multi-format document generator."
+      program :help, "Author", "Jeremy Rodi <jeremy.rodi@medcat.me>"
+      program :help, "License", "MIT License Copyright (c) 2017 Jeremy Rodi"
+    end
+
+    # Defines the config global option.  This sets {#config_file} to its
+    # default file, and defines an option that can set it.
+    #
+    # @return [void]
+    def configure_global_option
+      @config_file = "brandish.config.rb"
+      global_option("--config FILE") { |f| @config_file = f }
+    end
+
+    # Defines the directory global option.  This sets {#directory} to its
+    # default value, and defines an option that can set it.
+    #
+    # @return [void]
+    def directory_global_option
+      @directory = Pathname.new(Dir.pwd)
+      global_option("--directory PATH") do |path|
+        @directory = Pathname.new(path).expand_path(Dir.pwd)
+      end
+    end
+
+    # Options that are passed to the `progress` method provided by Commander.
+    # This makes it look "nice."
+    #
+    # @return [{::Symbol => ::String}]
+    PROGRESS_OPTIONS = {
+      title: "   Building...", progress_str: "#", incomplete_str: " ",
+      format: ":title <:progress_bar> :percent_complete%",
+      complete_message: "   Build complete!"
+    }.freeze
+
+    # The width of all of the set text items in the progress bar.  This is
+    # used to dynamically determine the with of the progress bar later on.
+    #
+    # @return [::Numeric]
+    PROGRESS_WIDTH = "   Building... <  > 000%  ".length
+
+    # Creates a progress bar on the terminal based off of the given array.
+    # This mostly passes everything on to the `progress` method provided by
+    # Commander, but with a few options added.
+    #
+    # @param array [::Array] The array of items that are being processed.
+    # @yield [item] Once for every item in the array.  Once the block ends,
+    #   the progress bar increments.
+    # @yieldparam item [::Object] One of the items in the array.
+    # @return [void]
+    def progress(array, &block)
+      # rubocop:disable Style/GlobalVars
+      width = $terminal.terminal_size[0] - PROGRESS_WIDTH
+      # rubocop:enable Style/GlobalVars
+      options = PROGRESS_OPTIONS.merge(width: width)
+      super(array, options, &block)
+    end
+
+    # The path to the configuration file.  This is used for
+    # {#load_configuration_file!}.
+    #
+    # @return [::Pathname]
+    def config_file_path
+      @directory / @config_file
+    end
+
+    # If the configuration isn't already loaded, load it; otherwise, just
+    # return the already loaded version of the configuration file.
+    #
+    # @return [Configure]
+    def load_configuration_file
+      Brandish.configuration || load_configuration_file!
+    end
+
+    # Forces the configuration file to be loaded, even if it already was;
+    # this first resets the configuration using {Brandish.reset_configuration},
+    # then it loads the {#config_file_path}.  If no configuration was provided,
+    # it fails;  if it didn't load properly, it fails.
+    #
+    # @raise [RuntimeError] If no configuration was provided, or if it didn't
+    #   load properly.
+    # @return [Configure]
+    def load_configuration_file!
+      Brandish.reset_configuration
+      load config_file_path.to_s
+      fail "No configuration provided" unless Brandish.configuration
+      Brandish.configuration
+    rescue LoadError
+      fail "No configuration provided"
+    end
+  end
+end