squib 0.8.0 → 0.9.0

data/lib/squib/layout_parser.rb

@@ -1,91 +1,91 @@
-require 'yaml'
-
-module Squib
-  # Internal class for handling layouts
-  #@api private
-  class LayoutParser
-
-    # Load the layout file(s), if exists
-    # @api private
-    def self.load_layout(files)
-      layout = {}
-      Squib::logger.info { "  using layout(s): #{files}" }
-      Array(files).each do |file|
-        thefile = file
-        thefile = builtin(file) unless File.exists?(file)
-        if File.exists? thefile
-          yml = layout.merge(YAML.load_file(thefile) || {}) #load_file returns false on empty file
-          yml.each do |key, value|
-            layout[key] = recurse_extends(yml, key, {})
-          end
-        else
-          Squib::logger.error { "Layout file not found: #{file}. Skipping..." }
-        end
-      end
-      return layout
-    end
-
-    # Determine the file path of the built-in layout file
-    def self.builtin(file)
-      "#{File.dirname(__FILE__)}/layouts/#{file}"
-    end
-
-    # Process the extends recursively
-    # :nodoc:
-    # @api private
-    def self.recurse_extends(yml, key, visited )
-      assert_not_visited(key, visited)
-      return yml[key] unless has_extends?(yml, key)
-      return yml[key] unless parents_exist?(yml, key)
-      visited[key] = key
-      parent_keys = [yml[key]['extends']].flatten
-      h = {}
-      parent_keys.each do |parent_key|
-        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
-          if child_val.to_s.strip.start_with?('+=')
-            parent_val + child_val.sub('+=','').strip.to_f
-          elsif child_val.to_s.strip.start_with?('-=')
-            parent_val - child_val.sub('-=','').strip.to_f
-          else
-            child_val #child overrides parent when merging, no +=
-          end
-        end
-        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
-          younger_sibling #when two siblings have the same entry, the "younger" (lower one) overrides
-        end
-      end
-      return h
-    end
-
-    # Does this layout entry have an extends field?
-    # i.e. is it a base-case or will it need recursion?
-    # :nodoc:
-    # @api private
-    def self.has_extends?(yml, key)
-      !!yml[key] && yml[key].key?('extends')
-    end
-
-    # Checks if we have any absentee parents
-    # @api private
-    def self.parents_exist?(yml, key)
-      exists = true
-      Array(yml[key]['extends']).each do |parent|
-        unless yml.key?(parent)
-          exists = false unless
-          Squib.logger.error "Processing layout: '#{key}' attempts to extend a missing '#{yml[key]['extends']}'"
-        end
-      end
-      return exists
-    end
-
-    # Safeguard against malformed circular extends
-    # :nodoc:
-    # @api private
-    def self.assert_not_visited(key, visited)
-      if visited.key? key
-        raise "Invalid layout: circular extends with '#{key}'"
-      end
-    end
-
-  end
-end
+require 'yaml'
+
+module Squib
+  # Internal class for handling layouts
+  #@api private
+  class LayoutParser
+
+    # Load the layout file(s), if exists
+    # @api private
+    def self.load_layout(files)
+      layout = {}
+      Squib::logger.info { "  using layout(s): #{files}" }
+      Array(files).each do |file|
+        thefile = file
+        thefile = builtin(file) unless File.exists?(file)
+        if File.exists? thefile
+          yml = layout.merge(YAML.load_file(thefile) || {}) #load_file returns false on empty file
+          yml.each do |key, value|
+            layout[key] = recurse_extends(yml, key, {})
+          end
+        else
+          Squib::logger.error { "Layout file not found: #{file}. Skipping..." }
+        end
+      end
+      return layout
+    end
+
+    # Determine the file path of the built-in layout file
+    def self.builtin(file)
+      "#{File.dirname(__FILE__)}/layouts/#{file}"
+    end
+
+    # Process the extends recursively
+    # :nodoc:
+    # @api private
+    def self.recurse_extends(yml, key, visited )
+      assert_not_visited(key, visited)
+      return yml[key] unless has_extends?(yml, key)
+      return yml[key] unless parents_exist?(yml, key)
+      visited[key] = key
+      parent_keys = [yml[key]['extends']].flatten
+      h = {}
+      parent_keys.each do |parent_key|
+        from_extends = yml[key].merge(recurse_extends(yml, parent_key, visited)) do |key, child_val, parent_val|
+          if child_val.to_s.strip.start_with?('+=')
+            parent_val + child_val.sub('+=','').strip.to_f
+          elsif child_val.to_s.strip.start_with?('-=')
+            parent_val - child_val.sub('-=','').strip.to_f
+          else
+            child_val #child overrides parent when merging, no +=
+          end
+        end
+        h = h.merge(from_extends) do |key, older_sibling, younger_sibling|
+          younger_sibling #when two siblings have the same entry, the "younger" (lower one) overrides
+        end
+      end
+      return h
+    end
+
+    # Does this layout entry have an extends field?
+    # i.e. is it a base-case or will it need recursion?
+    # :nodoc:
+    # @api private
+    def self.has_extends?(yml, key)
+      !!yml[key] && yml[key].key?('extends')
+    end
+
+    # Checks if we have any absentee parents
+    # @api private
+    def self.parents_exist?(yml, key)
+      exists = true
+      Array(yml[key]['extends']).each do |parent|
+        unless yml.key?(parent)
+          exists = false unless
+          Squib.logger.error "Processing layout: '#{key}' attempts to extend a missing '#{yml[key]['extends']}'"
+        end
+      end
+      return exists
+    end
+
+    # Safeguard against malformed circular extends
+    # :nodoc:
+    # @api private
+    def self.assert_not_visited(key, visited)
+      if visited.key? key
+        raise "Invalid layout: circular extends with '#{key}'"
+      end
+    end
+
+  end
+end

data/lib/squib/layouts/economy.yml

@@ -1,85 +1,85 @@
-#This layout inspired by popular fantasy games
-title:
-  x: 90
-  y: 90
-  width: 635
-  height: 50
-  align: center
-
-art:
-  x: 75
-  y: 150
-  width: 675
-  height: 520
-
-description:
-  x: 100
-  y: 675
-  width: 625
-  height: 275
-  valign: middle
-  align: center
-  font_size: 18
-desc: # alias
-  extends: description
-
-type:
-  x: 90
-  y: 955
-  width: 645
-  height: 50
-  align: center
-
-lower_right:
-  x: 675
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: right
-lr: #alias
-  extends: lower_right
-
-lower_left:
-  x: 75
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: left
-ll: # alias
-  extends: lower_left
-
-copyright:
-  x: 75
-  y: 1025
-  width: 675
-  height: 25
-  font_size: 16
-  align: center
-  valign: bottom
-#aliases for copyright
-copy:
-  extends: copyright
-credit:
-  extends: copyright
-credits:
-  extends: copyright
-
-# The "cut line", without rounded corners
-cut:
-  x: 37.5
-  y: 37.5
-  width: 750
-  height: 1050
-
-# The "safe zone" as defined by TheGameCrafter poker cards
-safe:
-  x: 75
-  y: 75
-  width: 675
-  height: 975
-  radius: 16
-  dash: 3 3
+#This layout inspired by popular fantasy games
+title:
+  x: 90
+  y: 90
+  width: 635
+  height: 50
+  align: center
+
+art:
+  x: 75
+  y: 150
+  width: 675
+  height: 520
+
+description:
+  x: 100
+  y: 675
+  width: 625
+  height: 275
+  valign: middle
+  align: center
+  font_size: 18
+desc: # alias
+  extends: description
+
+type:
+  x: 90
+  y: 955
+  width: 645
+  height: 50
+  align: center
+
+lower_right:
+  x: 675
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: right
+lr: #alias
+  extends: lower_right
+
+lower_left:
+  x: 75
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: left
+ll: # alias
+  extends: lower_left
+
+copyright:
+  x: 75
+  y: 1025
+  width: 675
+  height: 25
+  font_size: 16
+  align: center
+  valign: bottom
+#aliases for copyright
+copy:
+  extends: copyright
+credit:
+  extends: copyright
+credits:
+  extends: copyright
+
+# The "cut line", without rounded corners
+cut:
+  x: 37.5
+  y: 37.5
+  width: 750
+  height: 1050
+
+# The "safe zone" as defined by TheGameCrafter poker cards
+safe:
+  x: 75
+  y: 75
+  width: 675
+  height: 975
+  radius: 16
+  dash: 3 3

data/lib/squib/layouts/fantasy.yml

@@ -1,101 +1,101 @@
-#This layout inspired by popular fantasy games
-title:
-  x: 90
-  y: 90
-  width: 500
-  height: 50
-
-upper_right:
-  x: 595
-  y: 90
-  width: 135
-  height: 50
-  align: right
-ur: # alias
-  extends: upper_right
-
-art:
-  x: 75
-  y: 150
-  width: 675
-  height: 520
-
-type:
-  x: 90
-  y: 675
-  width: 500
-  height: 50
-
-type_right:
-  x: 595
-  y: 675
-  width: 135
-  height: 50
-  align: right
-tr: #alias
-  extends: type_right
-
-description:
-  x: 100
-  y: 730
-  width: 625
-  height: 275
-  valign: middle
-  align: center
-  font_size: 18
-desc: # alias
-  extends: description
-
-lower_right:
-  x: 675
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: right
-lr: #alias
-  extends: lower_right
-
-lower_left:
-  x: 75
-  y: 975
-  width: 75
-  height: 75
-  font_size: 18
-  valign: bottom
-  align: left
-ll: # alias
-  extends: lower_left
-
-copyright:
-  x: 75
-  y: 1025
-  width: 675
-  height: 25
-  font_size: 16
-  align: center
-  valign: bottom
-#aliases for copyright
-copy:
-  extends: copyright
-credit:
-  extends: copyright
-credits:
-  extends: copyright
-
-# The "cut line", without rounded corners
-cut:
-  x: 37.5
-  y: 37.5
-  width: 750
-  height: 1050
-
-# The "safe zone" as defined by TheGameCrafter poker cards
-safe:
-  x: 75
-  y: 75
-  width: 675
-  height: 975
-  radius: 16
-  dash: 3 3
+#This layout inspired by popular fantasy games
+title:
+  x: 90
+  y: 90
+  width: 500
+  height: 50
+
+upper_right:
+  x: 595
+  y: 90
+  width: 135
+  height: 50
+  align: right
+ur: # alias
+  extends: upper_right
+
+art:
+  x: 75
+  y: 150
+  width: 675
+  height: 520
+
+type:
+  x: 90
+  y: 675
+  width: 500
+  height: 50
+
+type_right:
+  x: 595
+  y: 675
+  width: 135
+  height: 50
+  align: right
+tr: #alias
+  extends: type_right
+
+description:
+  x: 100
+  y: 730
+  width: 625
+  height: 275
+  valign: middle
+  align: center
+  font_size: 18
+desc: # alias
+  extends: description
+
+lower_right:
+  x: 675
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: right
+lr: #alias
+  extends: lower_right
+
+lower_left:
+  x: 75
+  y: 975
+  width: 75
+  height: 75
+  font_size: 18
+  valign: bottom
+  align: left
+ll: # alias
+  extends: lower_left
+
+copyright:
+  x: 75
+  y: 1025
+  width: 675
+  height: 25
+  font_size: 16
+  align: center
+  valign: bottom
+#aliases for copyright
+copy:
+  extends: copyright
+credit:
+  extends: copyright
+credits:
+  extends: copyright
+
+# The "cut line", without rounded corners
+cut:
+  x: 37.5
+  y: 37.5
+  width: 750
+  height: 1050
+
+# The "safe zone" as defined by TheGameCrafter poker cards
+safe:
+  x: 75
+  y: 75
+  width: 675
+  height: 975
+  radius: 16
+  dash: 3 3