mascot 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f77239bcb7a2bd96b15d86b979653a82c4b28a64
-  data.tar.gz: d9cde5bb1ec8a33d691f54834a70ea41a5770a93
+  metadata.gz: d49c4a14896b46d0fdcd7aedd1250a104e9b5048
+  data.tar.gz: 101a6a075f65556c4dc0a86ca69e7a5c39459a4d
 SHA512:
-  metadata.gz: 3b96e6d7fd9588b2fbdb2e8a52c6126b5645851e063bfe797a3a49e21edc684f57fbdf1a0b02774e933d889788092e536a0a2fe969fc5200b366b379f69dae2b
-  data.tar.gz: 295c73a424297c6d7f0688e576eb1fdf41dfa06b1826ea1993ed580a7abcbefef61af6c031b750e7136882d085b36df8777d80a24b4c243d35fda85ac7a68cd2
+  metadata.gz: 65db308403d25699fd58e498e09a7c390b885894709ebb60be396eeca3f1faed0d65c574dfc75164325272462bd7672e230f505694c6e1b15a7e2f5ba1b6addc
+  data.tar.gz: eec51f4ec3bd95bf28831e097a646acd3faeba341529f75eb3bb93a844ffdff87c44d3aa9d9d78d29d703897bde3fb7b1960d0bda74abf8f96d73e3dfe127f61

data/lib/mascot.rb

@@ -1,7 +1,7 @@
 require "mascot/version"
 
 module Mascot
-  # Raised if a user attempts to access a resource outside of the sitemap path.
+  # Raised if a user attempts to access a resource outside of the site path.
   UnsafePathAccessError = Class.new(SecurityError)
 
   # Raised by Resources if a path is added that's not a valid path.
@@ -12,8 +12,9 @@ module Mascot
 
   autoload :Asset,        "mascot/asset"
   autoload :Frontmatter,  "mascot/frontmatter"
-  autoload :SafeRoot,     "mascot/safe_root"
+  autoload :ResourcesPipeline,     "mascot/resources_pipeline"
   autoload :Resources,    "mascot/resources"
   autoload :Resource,     "mascot/resource"
-  autoload :Sitemap,      "mascot/sitemap"
+  autoload :SafeRoot,     "mascot/safe_root"
+  autoload :Site,      "mascot/site"
 end

data/lib/mascot/asset.rb

@@ -50,7 +50,7 @@ module Mascot
     end
 
     def mime_type
-      @mime_type ||= Array(inferred_mime_type).first || DEFAULT_MIME_TYPE
+      @mime_type ||= inferred_mime_type || DEFAULT_MIME_TYPE
     end
 
     def exists?
@@ -75,7 +75,7 @@ module Mascot
     # Returns the mime type of the file extension. If a type can't
     # be resolved then we'll just grab the first type.
     def inferred_mime_type
-      MIME::Types.type_for(format_extension) if format_extension
+      MIME::Types.type_for(format_extension).first if format_extension
     end
   end
 end

data/lib/mascot/extensions/layouts.rb

@@ -0,0 +1,27 @@
+module Mascot
+  module Extensions
+    # Register layouts with resources that match certain patterns.
+    class Layouts
+      Rule = Struct.new(:layout, :processor)
+
+      def initialize
+        @rules = Array.new
+      end
+
+      # Register a layout for a set of resources.
+      def layout(layout, &block)
+        @rules << Rule.new(layout, block)
+      end
+
+      def process_resources(resources)
+        resources.each do |resource|
+          @rules.each do |rule|
+            if rule.processor.call(resource)
+              resource.data["layout"] ||= rule.layout
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mascot/extensions/proc_manipulator.rb

@@ -0,0 +1,19 @@
+module Mascot
+  module Extensions
+    class ProcManipulator
+      def initialize(block)
+        @block = block
+      end
+
+      def process_resources(resources)
+        resources.each do |resource|
+          if @block.arity == 1
+            @block.call resource
+          else # This will blow up if 0 or greater than 2.
+            @block.call resource, resources
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mascot/frontmatter.rb

@@ -2,9 +2,12 @@ require "yaml"
 
 module Mascot
   # Parses metadata from the header of the page.
+
+  # TODO: Redo this to use File readline and pos to
+  # perform faster
   class Frontmatter
     DELIMITER = "---".freeze
-    PATTERN = /\A(#{DELIMITER}\n(.+)\n#{DELIMITER}\n)?(.+)\Z/m
+    PATTERN = /\A(#{DELIMITER}\n(.+?)\n#{DELIMITER}\n*)?(.+)\Z/m
 
     attr_reader :body
 

data/lib/mascot/resources_pipeline.rb

@@ -0,0 +1,10 @@
+require "forwardable"
+
+module Mascot
+  # Processes a collection of resources
+  class ResourcesPipeline < Array
+    def process(resources)
+      each{ |processor| processor.process_resources resources }
+    end
+  end
+end

data/lib/mascot/safe_root.rb

@@ -2,7 +2,7 @@ require "pathname"
 
 module Mascot
   # Validates if a path is within another path. This prevents
-  # users from accidentally selecting a file outside of their sitemap,
+  # users from accidentally selecting a file outside of their site,
   # which could be insured.
   class SafeRoot
     def initialize(path: )

data/lib/mascot/{sitemap.rb → site.rb}

@@ -1,21 +1,18 @@
 require "pathname"
+require "mascot/extensions/proc_manipulator"
 
 module Mascot
   # A collection of pages from a directory.
-  class Sitemap
-    # Default file pattern to pick up in sitemap
+  class Site
+    # Default file pattern to pick up in site
     DEFAULT_GLOB = "**/**".freeze
-    # Default root path for sitemap.
+    # Default root path for site.
     DEFAULT_ROOT_PATH = Pathname.new(".").freeze
-    # Default root request path
-    DEFAULT_ROOT_REQUEST_PATH = Pathname.new("/").freeze
 
-    attr_reader :root, :request_path, :extensions
+    attr_reader :root, :resources_pipeline
 
-    def initialize(root: DEFAULT_ROOT_PATH, request_path: DEFAULT_ROOT_REQUEST_PATH)
+    def initialize(root: DEFAULT_ROOT_PATH)
       self.root = root
-      self.request_path = request_path
-      @extensions = []
     end
 
     # Lazy stream of files that will be rendered by resources.
@@ -29,10 +26,16 @@ module Mascot
     def resources
       Resources.new(root_file_path: root).tap do |resources|
         assets.each { |a| resources.add_asset a }
-        process_resources resources
+        resources_pipeline.process resources
       end
     end
 
+    # Quick and dirty way to manipulate resources in the site without
+    # creating classes that implement the #process_resources method
+    def manipulate(&block)
+      resources_pipeline << Extensions::ProcManipulator.new(block)
+    end
+
     # Find the page with a path.
     def get(request_path)
       resources.get(request_path)
@@ -42,15 +45,11 @@ module Mascot
       @root = Pathname.new(path)
     end
 
-    def request_path=(path)
-      @request_path = Pathname.new(path)
+    def resources_pipeline
+      @resources_pipeline ||= ResourcesPipeline.new
     end
 
     private
-    def process_resources(resources)
-      @extensions.each { |exstension| exstension.process_resources(resources) }
-    end
-
     def safe_root
       SafeRoot.new(path: root)
     end

data/lib/mascot/version.rb

@@ -1,3 +1,3 @@
 module Mascot
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mascot
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Brad Gessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-03 00:00:00.000000000 Z
+date: 2016-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,11 +75,14 @@ extra_rdoc_files: []
 files:
 - lib/mascot.rb
 - lib/mascot/asset.rb
+- lib/mascot/extensions/layouts.rb
+- lib/mascot/extensions/proc_manipulator.rb
 - lib/mascot/frontmatter.rb
 - lib/mascot/resource.rb
 - lib/mascot/resources.rb
+- lib/mascot/resources_pipeline.rb
 - lib/mascot/safe_root.rb
-- lib/mascot/sitemap.rb
+- lib/mascot/site.rb
 - lib/mascot/version.rb
 - mascot.gemspec
 homepage: https://github.com/bradgessler/mascot