brandish 0.1.1

data/lib/brandish/processors/html/script/babel.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module HTML
+      class Script < Common::Asset
+        # A set of scripting engines that use the Babel transpiler.
+        #
+        # Engines:
+        #
+        # - `"babel"`, `"babel-file"` - A command.  This takes the contents
+        #   of the resolved file, transpiles it, and outputs it into
+        #   the output path, given by `#load_file_paths`.
+        # - `"babel-inline"` - A block.  Similar to `"babel"`; however, it
+        #   takes the block, uses {Parser::Node::Root#flatten} on it,
+        #   transpiles the result, and adds that as an inline script.
+        #
+        # @note
+        #   The libraries that these engines depend on are not required in
+        #   by default; if any of these engines are used, the requisite
+        #   libraries would have to be required by the `brandish.config.rb`
+        #   file.
+        module Babel
+          Script.engine "babel", :command, :script_babel_file
+          Script.engine "babel-file", :command, :script_babel_file
+          Script.engine "babel-inline", :block, :script_babel_inline
+
+        private
+
+          def script_babel_inline
+            parsed = ::Babel::Transpiler.transform(@body.flatten)
+            @context[:document].add_inline_script(parsed["code"])
+          end
+
+          def script_babel_file
+            paths = load_file_paths
+            paths[:out].dirname.mkpath
+            parsed = ::Babel::Transpiler.transform(paths[:file].read)
+            paths[:out].write(parsed["code"])
+
+            @context[:document].add_linked_script(paths[:src])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brandish/processors/html/script/coffee.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module HTML
+      class Script < Common::Asset
+        # A set of scripting engines that use the Coffee transpiler.
+        #
+        # Engines:
+        #
+        # - `"coffee"`, `"coffee-file"` - A command.  This takes the contents
+        #   of the resolved file, transpiles it, and outputs it into
+        #   the output path, given by `#load_file_paths`.
+        # - `"coffee-inline"` - A block.  Similar to `"coffee"`; however, it
+        #   takes the block, uses {Parser::Node::Root#flatten} on it,
+        #   transpiles the result, and adds that as an inline script.
+        #
+        # @note
+        #   The libraries that these engines depend on are not required in
+        #   by default; if any of these engines are used, the requisite 
+        #   libraries would have to be required by the `brandish.config.rb`
+        #   file.
+        module Coffee
+          Script.engine "coffee", :command, :script_coffee_file
+          Script.engine "coffee-file", :command, :script_coffee_file
+          Script.engine "coffee-inline", :block, :script_coffee_inline
+
+        private
+
+          def script_coffee_inline
+            parsed = ::CoffeeScript.compile(@body.flatten)
+            @context[:document].add_inline_script(parsed)
+          end
+
+          def script_coffee_file
+            paths = load_file_paths
+            paths[:out].dirname.mkpath
+            paths[:out].write(::CoffeeScript.compile(paths[:file].read))
+
+            @context[:document].add_linked_script(paths[:src])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brandish/processors/html/script/vanilla.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module HTML
+      class Script < Common::Asset
+        # "Vanilla" scripting engines.  This just performs copying, and
+        # does not modify the contents of the styles at all.
+        #
+        # Engines:
+        #
+        # - `"file"` - A command.  Takes a file, and copies it over to the
+        #   destination, based on the values given in `#load_file_paths`.
+        # - `"remote"`, `"remote-file"` - A command.  Takes a URI (supports 
+        #   `http`, `https`, and `ftp`), and outputs the directory into the
+        #   `"output"` pair (or a uri path assumed from the URI).
+        # - `"inline"` - A block.  This performs {Parser::Node::Root#flatten}
+        #   on the body, and pushes the result as an inline style.
+        # - `"remote-inline"` - A command.  Similar to `"remote"`; however,
+        #   this takes the remote styles as an inline style.
+        module Vanilla
+          Script.engine "inline", :block, :script_inline
+          Script.engine "file", :command, :script_file
+
+        private
+
+          def script_inline
+            @context[:document].add_inline_script(@body.flatten)
+          end
+
+          def script_file
+            paths = load_file_paths
+            paths[:out].dirname.mkpath
+            src, dest = paths[:file].open("rb"), paths[:out].open("wb")
+            ::IO.copy_stream(src, dest)
+            [src, dest].each(&:close)
+
+            @context[:document].add_linked_script(paths[:src])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brandish/processors/html/style.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+require "brandish/processors/html/style/highlight"
+require "brandish/processors/html/style/sass"
+require "brandish/processors/html/style/vanilla"
+
+module Brandish
+  module Processors
+    module HTML
+      # A Style asset.  This is a CSS asset.
+      #
+      # Engines:
+      #
+      # - `"highlight-rouge"`, `"highlight-rouge-file"` - A command.
+      #   Retrieves the given theme from the Rouge library, and outputs it
+      #   to the `"output"` pair (or `"highlight/rouge/<theme>.css"` by
+      #   default).
+      # - `"highlight-pygments", `"highlight-pygments-file"` - A command.
+      #   Retrieves the given theme from the Pygments library, and outputs
+      #   it to the `"output"` pair (or `"highlight/pygments/<theme>.css"`
+      #   by default).
+      # - `"highlight-rouge-inline"` - A command.  Retrieves the given theme
+      #   from the Rouge library, and uses it like an inline style.
+      # - `"highlight-pygments-inline"` - A command.  Retrieves the given
+      #   theme from the pygments library, and uses it like an inline
+      #   style.
+      # - `"sass"`, `"sass-file"`, `"scss"`, `"scss-file"` - A command.
+      #   These take a file and processes it, and outputs it to the output
+      #   path given by `#load_file_paths`.  There is no difference
+      #   between any of these engine types - the engine assumes the actual
+      #   syntax of the file from the file extension.
+      # - `"sass-inline"` - A block.  This takes the block's contents,
+      #   performs {Parser::Node::Root#flatten} on it, and processes the
+      #   content as Sass.  This is then included as an inline stylesheet.
+      # - `"scss-inline" - A block.  Similar to `"sass-inline"`, except it
+      #   processes the content as SCSS.
+      # - `"file"` - A command.  Takes a file, and copies it over to the
+      #   destination, based on the values given in `#load_file_paths`.
+      # - `"remote"`, `"remote-file"` - A command.  Takes a URI (supports
+      #   `http`, `https`, and `ftp`), and outputs the directory into the
+      #   `"output"` pair (or a uri path assumed from the URI).
+      # - `"inline"` - A block.  This performs {Parser::Node::Root#flatten}
+      #   on the body, and pushes the result as an inline style.
+      # - `"remote-inline"` - A command.  Similar to `"remote"`; however,
+      #   this takes the remote styles as an inline style.
+      #
+      # Pairs:
+      #
+      # - `"src"`, `"file"`, `"name"`, or `"link"` - Required.  At least one
+      #   of these options are required.  They all perform the same function.
+      #   This defines the name or path of the asset to add or process.
+      # - `"type"` - Required.  The type of the asset to process.  This defines
+      #   how the asset is handled.
+      # - `"theme"` - Required (for `highlight-*` engines only).  The theme
+      #   to find for styling.
+      # - `"scope"` - Required (for `highlight-*` engines only).  The CSS
+      #   scope for styling.
+      # - `"output"` - Optional (for `highlight-*` engines or for
+      #   `"remote"`/`"remote-file"` that output to a file only).  The output
+      #   path for the CSS file.
+      class Style < Common::Asset
+        register %i(html style) => self
+        self.names = %i(style styling)
+
+        include Style::Highlight
+        include Style::Sass
+        include Style::Vanilla
+
+        # (see Common::Asset::Paths#asset_kind_path)
+        def asset_kind_path
+          "assets/styles"
+        end
+
+        # (see Common::Asset::Paths#asset_kind_extension)
+        def asset_kind_extension
+          ".css"
+        end
+      end
+    end
+  end
+end

data/lib/brandish/processors/html/style/highlight.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module HTML
+      class Style < Common::Asset
+        # A Style engine for highlighting libraries.  This supports
+        # Rouge and Pygments.
+        #
+        # Engines:
+        #
+        # - `"highlight-rouge"`, `"highlight-rouge-file"` - A command.
+        #   Retrieves the given theme from the Rouge library, and outputs it
+        #   to the `"output"` pair (or `"highlight/rouge/<theme>.css"` by
+        #   default).
+        # - `"highlight-pygments", `"highlight-pygments-file"` - A command.
+        #   Retrieves the given theme from the Pygments library, and outputs
+        #   it to the `"output"` pair (or `"highlight/pygments/<theme>.css"`
+        #   by default).
+        # - `"highlight-rouge-inline"` - A command.  Retrieves the given theme
+        #   from the Rouge library, and uses it like an inline style.
+        # - `"highlight-pygments-inline"` - A command.  Retrieves the given
+        #   theme from the pygments library, and uses it like an inline
+        #   style.
+        #
+        # @note
+        #   The libraries that these engines depend on are not required in
+        #   by default; if any of these engines are used, the requisite 
+        #   libraries would have to be required by the `brandish.config.rb`
+        #   file.
+        module Highlight
+          Style.engine "highlight-rouge", :command, :style_highlight_rouge
+          Style.engine "highlight-pygments", :command, :style_highlight_pygments
+          Style.engine "highlight-rouge-file", :command, :style_highlight_rouge
+          Style.engine "highlight-pygments-file", :command, :style_highlight_pygments
+          Style.engine "highlight-rouge-inline", :command, :style_highlight_rouge_inline
+          Style.engine "highlight-pygments-inline", :command, :style_highlight_pygments_inline
+          Style.pair :theme, :scope, :output
+
+        private
+
+          def highlight_theme
+            @pairs.fetch("theme")
+          end
+
+          def highlight_rouge_value
+            scope = @pairs.fetch("scope", ".highlight")
+            options = { scope: scope }
+            ::Rouge::Theme.find(highlight_theme).render(options)
+          end
+
+          def highlight_pygments_value
+            scope = @pairs.fetch("scope", ".highlight")
+            ::Pygments.css(scope, style: highlight_theme)
+          end
+
+          def style_highlight_rouge
+            file = @pairs.fetch("output", "highlight/rouge/#{highlight_theme}.css")
+            output_path = output_styles_path / file
+            output_path.dirname.mkpath
+            link_path = output_path.relative_path_from(@context.configure.output)
+            output_path.write(highlight_rouge_value)
+
+            @context[:document].add_linked_style(link_path)
+          end
+
+          def style_highlight_pygments
+            file = @pairs.fetch("output", "highlight/pygments/#{highlight_theme}.css")
+            output_path = output_styles_path / file
+            output_path.dirname.mkpath
+            link_path = output_path.relative_path_from(@context.configure.output)
+            output_path.write(highlight_pygments_value)
+
+            @context[:document].add_linked_style(link_path)
+          end
+
+          def style_highlight_rouge_inline
+            @context[:document].add_inline_style(highlight_rouge_value)
+          end
+
+          def style_highlight_pygments_inline
+            @context[:document].add_inline_style(highlight_pygments_value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brandish/processors/html/style/sass.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module HTML
+      class Style < Common::Asset
+        # A set of styling engines that provide access to Sass/SCSS.
+        #
+        # Engines:
+        #
+        # - `"sass"`, `"sass-file"`, `"scss"`, `"scss-file"` - A command.
+        #   These take a file and processes it, and outputs it to the output 
+        #   path given by `#load_file_paths`.  There is no difference 
+        #   between any of these engine types - the engine assumes the actual 
+        #   syntax of the file from the file extension.
+        # - `"sass-inline"` - A block.  This takes the block's contents,
+        #   performs {Parser::Node::Root#flatten} on it, and processes the
+        #   content as Sass.  This is then included as an inline stylesheet.
+        # - `"scss-inline" - A block.  Similar to `"sass-inline"`, except it
+        #   processes the content as SCSS.
+        #
+        # @note
+        #   The libraries that these engines depend on are not required in
+        #   by default; if any of these engines are used, the requisite 
+        #   libraries would have to be required by the `brandish.config.rb`
+        #   file.
+        module Sass
+          Style.engine "sass", :command, :style_file_sass
+          Style.engine "scss", :command, :style_file_sass
+          Style.engine "sass-file", :command, :style_file_sass
+          Style.engine "scss-file", :command, :style_file_sass
+          Style.engine "sass-inline", :block, :style_inline_sass
+          Style.engine "scss-inline", :block, :style_inline_scss
+
+        private
+
+          def style_file_sass
+            paths = load_file_paths
+            paths[:out].dirname.mkpath
+            dest = paths[:out].open("wb")
+            sass_options = { load_paths: style_load_paths.to_a }
+            engine = ::Sass::Engine.for_file(paths[:file].to_s, sass_options)
+            output = engine.render
+            dest.write(output)
+            dest.close
+
+            @context[:document].add_linked_style(paths[:src])
+          end
+
+          def style_inline_scss
+            style_inline_sass(:scss)
+          end
+
+          def style_inline_sass(syntax = :sass)
+            sass_options = { syntax: syntax, load_paths: style_load_paths.to_a }
+            engine = ::Sass::Engine.new(@body.flatten, sass_options)
+            @context[:document].add_inline_style(engine.render)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/brandish/processors/html/style/vanilla.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Brandish
+  module Processors
+    module HTML
+      class Style < Common::Asset
+        # "Vanilla" stylesheet engines.  This just performs copying, and
+        # does not modify the contents of the styles at all.
+        #
+        # Engines:
+        #
+        # - `"file"` - A command.  Takes a file, and copies it over to the
+        #   destination, based on the values given in `#load_file_paths`.
+        # - `"remote"`, `"remote-file"` - A command.  Takes a URI (supports
+        #   `http`, `https`, and `ftp`), and outputs the directory into the
+        #   `"output"` pair (or a uri path assumed from the URI).
+        # - `"inline"` - A block.  This performs {Parser::Node::Root#flatten}
+        #   on the body, and pushes the result as an inline style.
+        # - `"remote-inline"` - A command.  Similar to `"remote"`; however,
+        #   this takes the remote styles as an inline style.
+        module Vanilla
+          Style.engine "file", :command, :style_file
+          Style.engine "remote", :command, :style_file_remote
+          Style.engine "inline", :block, :style_inline
+          Style.engine "remote-file", :command, :style_file_remote
+          Style.engine "remote-inline", :command, :style_inline_remote
+
+        private
+
+          def style_inline_remote
+            uri = URI(load_style_file)
+            file = open(uri)
+            content = file.read
+            file.close
+
+            @context[:document].add_inline_style(content)
+          end
+
+          def style_file_remote
+            uri = URI(load_style_file)
+            file = open(uri)
+            asset_path = @pairs.fetch("output") { uri_path(uri) }
+            output_path = output_styles_path / asset_path
+            output_path.dirname.mkpath
+            link_path = output_path.relative_path_from(@context.configure.output)
+            output = output_path.open("wb")
+            ::IO.copy_stream(file, output)
+            [file, output].each(&:close)
+
+            @context[:document].add_linked_style(link_path)
+          end
+
+          def style_inline
+            @context[:document].add_inline_style(@body.flatten)
+          end
+
+          def style_file
+            paths = load_file_paths
+            paths[:out].dirname.mkpath
+            src, dest = paths[:file].open("rb"), paths[:out].open("wb")
+            ::IO.copy_stream(src, dest)
+            [src, dest].each(&:close)
+
+            @context[:document].add_linked_style(paths[:src])
+          end
+        end
+      end
+    end
+  end
+end