mascot 0.1.12 → 0.1.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d705fe26af1339418f2018ebeed0af942e6b49e
-  data.tar.gz: d0fbb9055d2b7214078eb1de963065e8f1949c9b
+  metadata.gz: 6be4b1751690e6c59370910168e633fa512d4179
+  data.tar.gz: 953289c76d1245c7e037a5a32ededad0321ca8cc
 SHA512:
-  metadata.gz: 95f73264703dccec615c082cf1f071237160b94e967903842c7f889da8dae7617c3a5931539ea0be5fbb2fbd070959cfc17bfc800c67eca0c758976249e88f01
-  data.tar.gz: ab29c4b7f17646864334e14007b1bf27feab5960c9e5fa88a805785dab23421b62727b8b12d813519105a50555c5f116c6a74a82d34e35bbc46786747b9ba457
+  metadata.gz: 61471911d2ef4efb0c017e371d4fa563af64116e40360a0eff0062d14f2397343755c9de4930ea01a8470f66408ef29a136994a1d07236e715ec42b136612df9
+  data.tar.gz: 2a24c41a5618965f225570b912346fa0d2b9863076c2e1e1d876efe6ea78dc79ee65847297dfcd64dc45f86a26f2868e288bfcb91c5d6e6c6f9658c205eb57d9

data/lib/mascot.rb

@@ -1,20 +1,18 @@
 require "mascot/version"
 
 module Mascot
-  # 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.
   InvalidRequestPathError = Class.new(RuntimeError)
 
   # Raised by Resources if a path is already in its index
   ExistingRequestPathError = Class.new(InvalidRequestPathError)
 
-  autoload :Asset,        "mascot/asset"
-  autoload :Frontmatter,  "mascot/frontmatter"
-  autoload :ResourcesPipeline,     "mascot/resources_pipeline"
-  autoload :Resource,     "mascot/resource"
-  autoload :ResourcesNode, "mascot/resources_node"
-  autoload :SafeRoot,     "mascot/safe_root"
-  autoload :Site,         "mascot/site"
+  autoload :Asset,                "mascot/asset"
+  autoload :DirectoryCollection,  "mascot/directory_collection"
+  autoload :Formats,              "mascot/formats"
+  autoload :Frontmatter,          "mascot/frontmatter"
+  autoload :Resource,             "mascot/resource"
+  autoload :ResourcesPipeline,    "mascot/resources_pipeline"
+  autoload :ResourcesNode,        "mascot/resources_node"
+  autoload :Site,                 "mascot/site"
 end

data/lib/mascot/directory_collection.rb

@@ -0,0 +1,24 @@
+module Mascot
+  # Maps a directory of assets into a set of routes that correspond with
+  # the `path` root.
+  class DirectoryCollection
+    attr_reader :assets, :path
+
+    def initialize(path: , assets:)
+      @path = path
+      @assets = assets
+    end
+
+    def mount(node)
+      assets.each { |a| node.add path: asset_path_to_request_path(a), asset: a }
+    end
+
+    private
+    # Given a @file_path of `/hi`, this method changes `/hi/there/friend.html.erb`
+    # to an absolute `/there/friend` format by removing the file extensions
+    def asset_path_to_request_path(asset)
+      # Relative path of resource to the file_path of this project.
+      asset.path.dirname.join(asset.format_basename).relative_path_from(path).to_s
+    end
+  end
+end

data/lib/mascot/extensions/layouts.rb

@@ -13,8 +13,8 @@ module Mascot
         @rules << Rule.new(layout, block)
       end
 
-      def process_resources(resources)
-        resources.each do |resource|
+      def process_resources(node)
+        node.resources.each do |resource|
           @rules.each do |rule|
             if rule.processor.call(resource)
               resource.data["layout"] ||= rule.layout

data/lib/mascot/extensions/proc_manipulator.rb

@@ -5,12 +5,12 @@ module Mascot
         @block = block
       end
 
-      def process_resources(resources)
-        resources.each do |resource|
+      def process_resources(node)
+        node.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
+            @block.call resource, node
           end
         end
       end

data/lib/mascot/formats.rb

@@ -0,0 +1,45 @@
+module Mascot
+  # Manages collections of resources that share the same ResourceNode. Given the files `/a.html` and `/a.gif`,
+  # both of these assets would be stored in the `ResourceNode#name = "a"` under `ResourceNode#formats` with
+  # the extensions `.gif`, and `.html`.
+  class Formats
+    include Enumerable
+
+    extend Forwardable
+    def_delegators :@formats, :size, :clear
+
+    def initialize(node: )
+      @node = node
+      @formats = Hash.new
+    end
+
+    def each(&block)
+      @formats.values.each(&block)
+    end
+
+    def remove(ext)
+      @formats.delete(ext)
+    end
+
+    def ext(ext)
+      @formats[ext]
+    end
+
+    def mime_type(mime_type)
+      find { |f| f.mime_type == mime_type }
+    end
+
+    def add(asset: , ext: )
+      resource = Resource.new(asset: asset, node: @node, ext: ext)
+      if @formats.has_key? ext
+        raise Mascot::ExistingRequestPathError, "Resource at #{resource.request_path} already set"
+      else
+        @formats[ext] = resource
+      end
+    end
+
+    def inspect
+      "<#{self.class}: resources=#{map(&:request_path)}>"
+    end
+  end
+end

data/lib/mascot/resource.rb

@@ -1,5 +1,4 @@
 require "forwardable"
-require "observer"
 
 module Mascot
   # Represents the request path of an asset. There may be multiple
@@ -70,17 +69,17 @@ module Mascot
     # below and select, we could call a single map and pull out a resources
     def filter_resources(type: DEFAULT_FILTER_SCOPE, &block)
       return [] unless node
-      resources = block.call.map(&:resources)
+      nodes = block.call
 
       case type
       when :all
-        resources
+        nodes.map(&:formats)
       when :same
-        resources.flatten.select { |r| r.ext == ext }
+        nodes.map{ |n| n.formats.ext(ext) }.flatten.compact
       when String
-        resources.flatten.select { |r| r.ext == type }
+        nodes.map{ |n| n.formats.ext(type) }.flatten.compact
       when MIME::Type
-        resources.flatten.select { |r| r.mime_type == type }
+        nodes.map{ |n| n.formats.mime_type(type) }.flatten.compact
       else
         raise ArgumentError, "Invalid type argument #{type}. Must be either :same, :all, an extension string, or a Mime::Type"
       end

data/lib/mascot/resources_node.rb

@@ -5,9 +5,7 @@ module Mascot
   # a leaf node. The actual `buz.html` asset is then stored on the leaf node as a resource. This tree structure
   # makes it possible to reason through path relationships from code to build out elements in a website like tree navigation.
   class ResourcesNode
-    # TODO: Should it be called "formats" or "extensions"? Probably the latter, but that could conflict with Resource Manipulators.
-    attr_reader :parent, :name, :formats
-    include Enumerable
+    attr_reader :parent, :name
 
     DELIMITER = "/".freeze
 
@@ -15,13 +13,15 @@ module Mascot
       @parent = parent
       @name = name.freeze
       @delimiter = delimiter.freeze
-      @children = Hash.new { |hash, key| hash[key] = ResourcesNode.new(parent: self, delimiter: delimiter, name: key) }
-      @resources = Hash.new
+    end
+
+    def formats
+      @formats ||= Formats.new(node: self)
     end
 
     # Returns the immediate children nodes.
     def children
-      @children.values
+      child_nodes.values
     end
 
     # Returns sibling nodes.
@@ -40,28 +40,34 @@ module Mascot
       parents
     end
 
-    # Iterates through resources in the current node and all child resources.
-    # TODO: Should this include all children? Perhaps I should move this method
-    # into an eumerator that more clearly states it returns an entire sub-tree.
-    def each(&block)
-      @resources.values.each { |resource| block.call(resource) }
-      children.each{ |c| c.each(&block) }
-    end
-
     def root?
       parent.nil?
     end
 
     def leaf?
-      @children.empty?
+      child_nodes.empty?
     end
 
-    def resources
-      @resources.values
+    class Resources
+      include Enumerable
+
+      def initialize(node: )
+        @node = node
+      end
+
+      def each(&block)
+        @node.formats.each(&block)
+        @node.children.each { |child| child.resources.each(&block) }
+      end
+
+      def glob(pattern)
+        paths = Dir.glob(pattern)
+        select { |r| paths.include? r.asset.path.to_s }
+      end
     end
 
-    def remove_resource(resource)
-      @resources.delete resource.ext #if @resources[resource.ext] == resource
+    def resources
+      Resources.new(node: self)
     end
 
     def remove
@@ -70,7 +76,7 @@ module Mascot
         # this call orphans the tree up to a resource.
         parent.remove_child(name)
       else
-        @resources.clear
+        formats.clear
       end
     end
 
@@ -78,9 +84,9 @@ module Mascot
       head, *path = tokenize(path)
       if path.empty?
         # When there's no more paths, we're left with the format (e.g. ".html")
-        add_format(asset: asset, ext: head)
+        formats.add(asset: asset, ext: head)
       else
-        @children[head].add(path: path, asset: asset)
+        child_nodes[head].add(path: path, asset: asset)
       end
     end
     alias :[]= :add
@@ -88,37 +94,18 @@ module Mascot
     def get_resource(path)
       *path, ext = tokenize(path)
       if node = dig(*path)
-        node.get_format(ext: ext)
+        node.formats.ext(ext)
       end
     end
 
-    def inspect
-      "<#{self.class}: resources=#{resources.map(&:request_path)} children=#{children.map(&:name).inspect}>"
-    end
-
     def get(path)
       *path, ext = tokenize(path)
       dig(*path)
     end
     alias :[] :get
 
-    protected
-    def get_format(ext: "")
-      @resources[ext]
-    end
-
-    def remove_child(path)
-      *_, segment, _ = tokenize(path)
-      @children.delete(segment)
-    end
-
-    def add_format(asset: , ext: )
-      resource = Resource.new(asset: asset, node: self, ext: ext)
-      if @resources.has_key? ext
-        raise Mascot::ExistingRequestPathError, "Resource at #{resource.request_path} already set"
-      else
-        @resources[ext] = resource
-      end
+    def inspect
+      "<#{self.class}: formats=#{formats.map(&:request_path)} children=#{children.map(&:name).inspect}>"
     end
 
     # TODO: I don't really like how the path is broken up with the "ext" at the end.
@@ -128,14 +115,28 @@ module Mascot
       head, *tail = args
       if head.nil? and tail.empty?
         self
-      elsif @children.has_key?(head)
-        @children[head].dig(*tail)
+      elsif child_nodes.has_key?(head)
+        child_nodes[head].dig(*tail)
       else
         nil
       end
     end
 
+    protected
+    def remove_child(path)
+      *_, segment, _ = tokenize(path)
+      child_nodes.delete(segment)
+    end
+
     private
+    def add_child_node(name)
+      ResourcesNode.new(parent: self, delimiter: @delimiter, name: name)
+    end
+
+    def child_nodes
+      @child_nodes ||= Hash.new { |hash, key| hash[key] = add_child_node(key) }
+    end
+
     # Returns all of the names for the path along with the format, if set.
     def tokenize(path)
       return path if path.respond_to? :to_a

data/lib/mascot/site.rb

@@ -6,31 +6,24 @@ module Mascot
   class Site
     # Default file pattern to pick up in site
     DEFAULT_GLOB = "**/**".freeze
-    # Default root path for site.
-    DEFAULT_ROOT_PATH = Pathname.new(".").freeze
 
-    attr_reader :root, :resources_pipeline
+    # Default root_path for site.
+    DEFAULT_ROOT_PATH = Pathname.new(".").freeze
 
-    def initialize(root: DEFAULT_ROOT_PATH)
-      self.root = root
-    end
+    attr_reader :root_path, :resources_pipeline
 
-    # Lazy stream of files that will be rendered by resources.
-    def assets(glob = DEFAULT_GLOB)
-      safe_root.glob(root.join(glob)).select(&File.method(:file?)).lazy.map do |path|
-        Asset.new(path: path)
-      end
+    def initialize(root_path: DEFAULT_ROOT_PATH)
+      self.root_path = root_path
     end
 
     def glob(glob)
-      paths = safe_root.glob(root.join(glob))
-      resources.select{ |r| paths.include? r.asset.path.to_s }
+      root.resources.glob(root_path.join(glob))
     end
 
     # Returns a list of resources.
-    def resources
+    def root
       ResourcesNode.new.tap do |root_node|
-        assets.each { |a| root_node.add path: asset_path_to_request_path(a), asset: a }
+        DirectoryCollection.new(assets: assets, path: root_path).mount(root_node)
         resources_pipeline.process root_node
       end
     end
@@ -43,11 +36,11 @@ module Mascot
 
     # Find the page with a path.
     def get(request_path)
-      resources.get_resource(request_path)
+      root.get_resource(request_path)
     end
 
-    def root=(path)
-      @root = Pathname.new(path)
+    def root_path=(path)
+      @root_path = Pathname.new(path)
     end
 
     def resources_pipeline
@@ -55,15 +48,11 @@ module Mascot
     end
 
     private
-    # Given a @file_path of `/hi`, this method changes `/hi/there/friend.html.erb`
-    # to an absolute `/there/friend` format by removing the file extensions
-    def asset_path_to_request_path(asset)
-      # Relative path of resource to the file_path of this project.
-      asset.path.dirname.join(asset.format_basename).relative_path_from(root).to_s
-    end
-
-    def safe_root
-      SafeRoot.new(path: root)
+    # Lazy stream of files that will be rendered by resources.
+    def assets(glob = DEFAULT_GLOB)
+      Dir.glob(root_path.join(glob)).select(&File.method(:file?)).lazy.map do |path|
+        Asset.new(path: path)
+      end
     end
   end
 end

data/lib/mascot/version.rb

@@ -1,3 +1,3 @@
 module Mascot
-  VERSION = "0.1.12"
+  VERSION = "0.1.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mascot
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.14
 platform: ruby
 authors:
 - Brad Gessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-18 00:00:00.000000000 Z
+date: 2016-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,13 +75,14 @@ extra_rdoc_files: []
 files:
 - lib/mascot.rb
 - lib/mascot/asset.rb
+- lib/mascot/directory_collection.rb
 - lib/mascot/extensions/layouts.rb
 - lib/mascot/extensions/proc_manipulator.rb
+- lib/mascot/formats.rb
 - lib/mascot/frontmatter.rb
 - lib/mascot/resource.rb
 - lib/mascot/resources_node.rb
 - lib/mascot/resources_pipeline.rb
-- lib/mascot/safe_root.rb
 - lib/mascot/site.rb
 - lib/mascot/version.rb
 - mascot.gemspec

data/lib/mascot/safe_root.rb

@@ -1,42 +0,0 @@
-require "pathname"
-
-module Mascot
-  # Validates if a path is within another path. This prevents
-  # users from accidentally selecting a file outside of their site,
-  # which could be insured.
-  class SafeRoot
-    def initialize(path: )
-      @path = Pathname.new(path)
-    end
-
-    # Validates if a path is safe by checking if its within a folder.
-    def safe?(path)
-      root_path = File.expand_path(@path)
-      resource_path = File.expand_path(path)
-
-      if resource_path.start_with? root_path
-        path
-      else
-      end
-    end
-
-    def glob(pattern)
-      Dir[validate(pattern)]
-    end
-
-    def unsafe?(path)
-      not safe? path
-    end
-
-    def path
-    end
-
-    def validate(path)
-      if unsafe? path
-        raise Mascot::UnsafePathAccessError, "Unsafe attempt to access #{path} outside of #{@path}"
-      else
-        path
-      end
-    end
-  end
-end