schizm 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f84ad79aced293697aa2a4377ef3e2e441c437e
-  data.tar.gz: 28a1c9d028c5de7ca4e1c73894d5c04ab860810d
+  metadata.gz: ec626d76f2d425ade64be899c1784234153fd8ee
+  data.tar.gz: 21b0ae3b7389198d70b078cd6ac9fd757546b1bb
 SHA512:
-  metadata.gz: c305dee798979981a5eba2ffc1c2609d945afa2b5aea5da14fc134935c8494ea27e29eeb67ed01c114ee474b831cca81683b1c5268591d3ca232f775769eeb9a
-  data.tar.gz: 4a10c89712aa6365cf1e4e31053a12f42231f6aac038b9ee74d403c314734d6511a28d30424cf1acc6d169c22e3e6d91dd1fc2ea1abbd999b7a989121bf0081c
+  metadata.gz: 0fd538deab37751a92026371b5244af68c57489937ff676d1e62f1d97c3c75650850c8f67b4d53262877af923c7996c32f9cab291b4d80e2681dae51627ce9f7
+  data.tar.gz: 6e4e26bbbd82d52a09391856b17e2efc745e10ae6c3afa80a3d92d3dea0db14c59cd4d4345832c1688c5bbb056950073c6a8369ac71ce288d107a2fc3ef1a807

data/lib/schizm/chunk.rb

@@ -1,130 +1,158 @@
+# Copyright (c) 2017 M. Grady Saunders
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+# 
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require_relative 'env'
 require_relative 'string'
 require_relative 'match'
 
 module Schizm
 
-  class Chunk
+# Structure to resolve chunks of source code.
+class Chunk
 
-    def initialize where, label
-      @where = String.new where
-      @label = String.new label
-      @share = Env.var[:share] if Env.var? :share
-      @target = nil
-      @blocks = Array.new
-      @labels = Array.new
-      @params = Hash.new
-    end
+  def initialize where, label
+    @where = String.new where
+    @label = String.new label
+    @share = Env.var[:share] if Env.var? :share
+    @target = nil
+    @blocks = Array.new
+    @labels = Array.new
+    @params = Hash.new
+  end
 
-    attr_reader :where
-    attr_reader :label
-    attr_accessor :share
-    attr_accessor :target
-    attr_accessor :blocks
-
-    # Boolean reader for +@share+.
-    def share?
-      case
-      when (@share == true) then return true
-      when (@share != true) then return false
-      end
-    end
+  attr_reader :where
+  attr_reader :label
+  attr_accessor :share
+  attr_accessor :target
+  attr_accessor :blocks
 
-    # Boolean reader for +@target+.
-    def target?
-      return false unless @target.is_a? ::String
-      return false unless @target != ""
-      return true
+  # Boolean reader for +@share+.
+  def share?
+    case
+    when (@share == true) then return true
+    when (@share != true) then return false
     end
+  end
 
-    # Hash organizing active chunks by +@where+ and +@label+.
-    @@hash =
-      Hash.new do |hash, where|
-      hash[where] =
-        Hash.new do |hash, label|
-        hash[label] = Chunk.new where, label
-        end
-      end
+  # Boolean reader for +@target+.
+  def target?
+    return false unless @target.is_a? ::String
+    return false unless @target != ""
+    return true
+  end
 
-    # Hash reader.
-    def self.hash
-      @@hash
+  # Hash organizing active chunks by +@where+ and +@label+.
+  @@hash =
+    Hash.new do |hash, where|
+    hash[where] =
+      Hash.new do |hash, label|
+      hash[label] = Chunk.new where, label
+      end
     end
 
-    # Hash iteration interface.
-    def self.each
-      @@hash.each do |where, hash|
-        hash.each do |label, chunk|
-          yield chunk
-        end
+  # Hash reader.
+  def self.hash
+    @@hash
+  end
+
+  # Hash iteration interface.
+  def self.each
+    @@hash.each do |where, hash|
+      hash.each do |label, chunk|
+        yield chunk
       end
     end
+  end
 
-    # Push a code block.
-    def push block, label = nil
-      block = String.new block
-      label = String.new label if label
-      @blocks.push block
-      @labels.push label
-    end
+  # Push a code block.
+  def push block, label = nil
+    block = String.new block
+    label = String.new label if label
+    @blocks.push block
+    @labels.push label
+  end
 
-    # Find a chunk relative to +self+. That is, consider only
-    # chunks defined in the same file, plus chunks shared with the
-    # entire project.
-    def find label
-      Chunk.each do |chunk|
-        if chunk.label == label and
-          (chunk.where == @where or chunk.share?)
-          return chunk
-        end
+  # Find a chunk relative to +self+. That is, consider only
+  # chunks defined in the same file, plus chunks shared with the
+  # entire project.
+  def find label
+    Chunk.each do |chunk|
+      if chunk.label == label and
+        (chunk.where == @where or chunk.share?)
+        return chunk
       end
-      nil
     end
+    nil
+  end
 
-    # Resolve chunk references to generate the final source string.
-    def to_s *trace
-      if trace.include? @label
-        raise "Infinite recursion!"
+  # Resolve chunk references to generate the final source string.
+  def to_s *trace
+    if trace.include? @label
+      raise "Infinite recursion!"
+    end
+    total = String.new(@blocks.join "\n")
+    total.trim!
+    while true
+      unless (total.sub! CHUNK_LABEL do
+          if (chunk = find $1)
+            replace = chunk.to_s *trace, @label
+            replace.gsub /(?<=\n)/, " " * String.new($`).find_indent
+          else
+            "/* " + $1 + " ... */"
+          end
+          end)
+        break
       end
-      total = String.new(@blocks.join "\n\n")
-      total.trim!
-      while true
-        unless (total.sub! CHUNK_LABEL do
-            if (chunk = find $1)
-              replace = chunk.to_s *trace, @label
-              replace.gsub /(?<=\n)/, " " * String.new($`).find_indent
-            else
-              "/* " + $1 + " ... */"
-            end
-            end)
-          break
+    end
+    if target?
+      if Env.var? :guard and @target =~ HEADER_PATH
+        guardify = String.new(@target).guardify
+        if Env.var? :title
+          guardify.prepend "_"
+          guardify.prepend String.new(Env.var[:title]).guardify
         end
+        total.prepend "\#define #{guardify}\n\n"
+        total.prepend "\#ifndef #{guardify}\n"
+        total.concat "\n\n"
+        total.concat "\#endif /* \#ifndef #{guardify} */"
       end
-      if target?
-        if Env.var? :guard and @target =~ HEADER_PATH
-          guardify = String.new(@target).guardify
-          if Env.var? :title
-            guardify.prepend "_"
-            guardify.prepend String.new(Env.var[:title]).guardify
-          end
-          total.prepend "\#define #{guardify}\n\n"
-          total.prepend "\#ifndef #{guardify}\n"
-          total.concat "\n\n"
-          total.concat "\#endif /* \#ifndef #{guardify} */"
-        end
-        if File.file? "LICENSE"
-          total.prepend "\n"
-          total.prepend String.new(File.read("LICENSE")).comment
-        end
+      if File.file? "LICENSE"
+        total.prepend "\n"
+        total.prepend String.new(File.read("LICENSE")).comment
       end
-      total
-    end
-
-    # Identifier for a particular block.
-    def id block = @blocks.size
-      "#{@label.slugify}-#{block}"
     end
+    total
+  end
 
+  # Identifier for +block+.
+  def id block = @blocks.size
+    String.new "#{@label.slugify}-#{block}"
   end
 
-end
+end # class Chunk
+
+end # module Schizm

data/lib/schizm/env.rb

@@ -1,3 +1,30 @@
+# Copyright (c) 2017 M. Grady Saunders
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+# 
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 require 'etc'
 require 'optparse'
 require 'pathname'
@@ -9,19 +36,22 @@ module Schizm
 
 module Env
 
+  # Global variable hash.
   @@var = {}
 
+  # Global variable hash getter.
   def self.var
     return @@var
   end
 
+  # +true+ if +@@var[key]+ is neither +nil+ nor +false+.
   def self.var? key
     return true if @@var.has_key?(key) and 
       @@var[key] != nil and @@var[key] != false
     return false
   end
 
-  # Prompt yes/no question.
+  # Prompt the user with a yes/no question.
   def self.yes? string, backup
     backup = backup.downcase[0]
     print "#{string} [Y/n] " if backup == "y"
@@ -31,6 +61,8 @@ module Env
     return backup == "y"
   end
 
+  # Write +string+ to +target+. If +target+ is an existing file and
+  # +var[:rewrite]+ is not set, prompts the user for permission to rewrite.
   def self.write target, string
     if (not File.file? target or 
         var? :rewrite or 
@@ -179,19 +211,22 @@ YAMLCONFIG
     assets = {
       "schizm.liquid" => "docs/_layouts",
       "schizm.js" => "docs/assets/js",
-      "fonts/fira-code.css" => "docs/assets/fonts",
-      "fonts/fira-code-light.otf" => "docs/assets/fonts",
-      "fonts/fira-code-regular.otf" => "docs/assets/fonts",
-      "fonts/fira-code-medium.otf" => "docs/assets/fonts",
-      "fonts/fira-code-bold.otf" => "docs/assets/fonts",
-      "fonts/genericons-neue.css" => "docs/assets/fonts",
-      "fonts/genericons-neue.eot" => "docs/assets/fonts",
-      "fonts/genericons-neue.ttf" => "docs/assets/fonts",
-      "fonts/genericons-neue.woff2" => "docs/assets/fonts",
-      "fonts/social-logos.css" => "docs/assets/fonts",
-      "fonts/social-logos.eot" => "docs/assets/fonts",
-      "fonts/social-logos.ttf" => "docs/assets/fonts",
-      "fonts/social-logos.woff2" => "docs/assets/fonts"
+      "fonts/Fira-Code.css" => "docs/assets/fonts",
+      "fonts/Fira-Code-Light.otf" => "docs/assets/fonts",
+      "fonts/Fira-Code-Regular.otf" => "docs/assets/fonts",
+      "fonts/Fira-Code-Medium.otf" => "docs/assets/fonts",
+      "fonts/Fira-Code-Bold.otf" => "docs/assets/fonts",
+      "fonts/Fira-Code-LICENSE" => "docs/assets/fonts",
+      "fonts/Genericons-Neue.css" => "docs/assets/fonts",
+      "fonts/Genericons-Neue.eot" => "docs/assets/fonts",
+      "fonts/Genericons-Neue.ttf" => "docs/assets/fonts",
+      "fonts/Genericons-Neue.woff2" => "docs/assets/fonts",
+      "fonts/Genericons-Neue-LICENSE" => "docs/assets/fonts",
+      "fonts/Social-Logos.css" => "docs/assets/fonts",
+      "fonts/Social-Logos.eot" => "docs/assets/fonts",
+      "fonts/Social-Logos.ttf" => "docs/assets/fonts",
+      "fonts/Social-Logos.woff2" => "docs/assets/fonts",
+      "fonts/Social-Logos-LICENSE" => "docs/assets/fonts"
     }
     assets.each do |from, to|
       write File.join(to, File.basename(from)), resource(from)

data/lib/schizm/env_colors.rb

@@ -1,7 +1,35 @@
+# Copyright (c) 2017 M. Grady Saunders
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# 
+#   1. Redistributions of source code must retain the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer.
+# 
+#   2. Redistributions in binary form must reproduce the above
+#      copyright notice, this list of conditions and the following
+#      disclaimer in the documentation and/or other materials
+#      provided with the distribution.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+# TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+# NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 module Schizm
 
 module Env
 
+  # https://material.io/guidelines/style/color.html
   COLORS = {
     'red' => {
         '50' => ['#FFEBEE', '#222222'],