mascot 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd189be94137f4449cf5cd3adfe17cc3c73696d
-  data.tar.gz: f7bd464af3cbcad19c4556a481d35fe6b09a4980
+  metadata.gz: 121fe032defb71fbc2265ccf6a0f850a91e2f47d
+  data.tar.gz: 3afef4d165793f1727c3dc8c43390419e6b2ceb3
 SHA512:
-  metadata.gz: 3e3dd576d4168e4ac6b5bc1e54fe8bb0279fb1fbfc657831db743580608523fe481df1dd105a48069a02605a681aaafbb2466e3b5fb007456373530d0242b2cd
-  data.tar.gz: ab69681818613b98b7f0cd4766bbdd86c55e6624812fbdf9783afb27491c42299088c0b61437d3099bf128efd39175fa0178c7fabb1f80314cd2f17a99aecaeb
+  metadata.gz: a674481e7d739c26f2517579808cc60494c64872865e45a496a7b8e144e2ecd053a11f4048c39d2d735bf413ebd5a118c4feda6c7d4ad4f57e640759c7cf17f9
+  data.tar.gz: 8a77fb0441652d75b55524207bbcbff4f11ebd780d646444318b1b7ba2c974a8a6c68207221aaa77d587e032327a5053f319d1449f2d733389b8f216cb1c0fde

data/lib/mascot/asset.rb

@@ -0,0 +1,67 @@
+require "mime/types"
+require "forwardable"
+require "pathname"
+
+module Mascot
+  # Represents a file on a web server that may be parsed to extract
+  # frontmatter or be renderable via a template. Multiple resources
+  # may point to the same asset. Properties of an asset should be mutable.
+  # The Resource object is immutable and may be modified by the Resources proxy.
+  class Asset
+    # If we can't resolve a mime type for the resource, we'll fall
+    # back to this binary octet-stream type so the client can download
+    # the resource and figure out what to do with it.
+    DEFAULT_MIME_TYPE = MIME::Types["application/octet-stream"].first
+
+    attr_reader :path
+
+    extend Forwardable
+    def_delegators :frontmatter, :data, :body
+
+    def initialize(path: , mime_type: nil)
+      # The MIME::Types gem returns an array when types are looked up.
+      # This grabs the first one, which is likely the intent on these lookups.
+      @mime_type = Array(mime_type).first
+      @path = Pathname.new path
+    end
+
+    # List of all file extensions.
+    def extensions
+      path.basename.to_s.split(".").drop(1)
+    end
+
+    # Returns the format extension.
+    def format_extension
+      extensions.first
+    end
+
+    # Returns a list of the rendering extensions.
+    def template_extensions
+      extensions.drop(1)
+    end
+
+    # Treat resources with the same request path as equal.
+    def ==(asset)
+      path == asset.path
+    end
+
+    def mime_type
+      @mime_type ||= Array(inferred_mime_type).first || DEFAULT_MIME_TYPE
+    end
+
+    def exists?
+      File.exists? path
+    end
+
+    private
+    def frontmatter
+      Frontmatter.new File.read @path
+    end
+
+    # 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
+    end
+  end
+end

data/lib/mascot/frontmatter.rb

@@ -0,0 +1,19 @@
+require "yaml"
+
+module Mascot
+  # Parses metadata from the header of the page.
+  class Frontmatter
+    DELIMITER = "---".freeze
+    PATTERN = /\A(#{DELIMITER}\n(.+)\n#{DELIMITER}\n)?(.+)\Z/m
+
+    attr_reader :body
+
+    def initialize(content)
+      _, @data, @body = content.match(PATTERN).captures
+    end
+
+    def data
+      @data ? YAML.load(@data) : {}
+    end
+  end
+end

data/lib/mascot/resource.rb

@@ -0,0 +1,56 @@
+require "forwardable"
+require "observer"
+
+module Mascot
+  # Represents the request path of an asset. There may be multiple
+  # resources that point to the same asset. Resources are immutable
+  # and may be altered by the resource proxy.
+  class Resource
+    include Observable
+
+    extend Forwardable
+    def_delegators :asset, :mime_type
+
+    attr_accessor :request_path, :asset
+    attr_writer :body, :data
+
+    def initialize(request_path: , asset: )
+      self.request_path = request_path
+      @asset = asset
+    end
+
+    # When #dup or #clone is copied, the Resource
+    # collection observer must be removed so there's
+    # not duplicate resources.
+    def initialize_copy(instance)
+      instance.delete_observers
+      super instance
+    end
+
+    def request_path=(request_path)
+      old_request_path = @request_path
+      # We freeze the value to ensure users can't modify
+      # the request_path string in place (e.g. Resource#request_path.capitalize!)
+      # and throw the resource out of sync with the Resources collection.
+      @request_path = request_path.dup.freeze
+      changed
+      notify_observers self, old_request_path
+    end
+
+    def inspect
+      "#<#{self.class}:0x#{(object_id << 1).to_s(16)} @request_path=#{@request_path.inspect} @asset=#{@asset.inspect}>"
+    end
+
+    def data
+      @data ||= asset.data
+    end
+
+    def body
+      @body ||= asset.body
+    end
+
+    def ==(asset)
+      request_path == asset.request_path
+    end
+  end
+end

data/lib/mascot/resources.rb

@@ -0,0 +1,97 @@
+module Mascot
+  class Resources
+    include Enumerable
+
+    extend Forwardable
+    def_delegators :@routes, :size, :empty?, :any?, :clear
+
+    def initialize(root_file_path: )
+      @routes = Hash.new
+      @root_file_path = Pathname.new(root_file_path)
+    end
+
+    def each(&block)
+      @routes.values.each(&block)
+    end
+
+    def last
+      @routes.values.last
+    end
+
+    def glob(pattern = "**/**")
+      paths = safe_root.glob @root_file_path.join(pattern)
+      select { |r| paths.include? r.asset.path.to_s}
+    end
+
+    def get(request_path)
+      return if request_path.nil?
+      @routes[key(request_path)]
+    end
+
+    def add(resource)
+      validate_request_path resource
+      validate_uniqueness resource
+
+      resource.add_observer self
+      @routes[key(resource)] = resource
+    end
+
+    def update(resource, old_request_path)
+      validate_request_path old_request_path
+      validate_request_path resource
+      validate_uniqueness resource
+
+      @routes.delete key(old_request_path)
+      @routes[key(resource)] = resource
+    end
+
+    def remove(resource)
+      validate_request_path resource
+      resource.delete_observer self
+      @routes.delete key(resource)
+      resource
+    end
+
+    def add_asset(asset, request_path: nil)
+      add Resource.new asset: asset, request_path: asset_path_to_request_path(request_path || asset.path)
+    end
+
+    private
+    def key(path)
+      File.join "/", validate_request_path(coerce_request_path(path))
+    end
+
+    def coerce_request_path(resource)
+      resource.respond_to?(:request_path) ? resource.request_path : resource
+    end
+
+    def validate_request_path(path)
+      path = coerce_request_path(path)
+      raise InvalidRequestPathError, "path can't be nil" if path.nil?
+      path
+    end
+
+    # Raise an exception if the user tries to add a Resource with an existing request path.
+    def validate_uniqueness(resource)
+      path = coerce_request_path(resource)
+      if existing_resource = get(path)
+        raise ExistingRequestPathError, "Resource #{existing_resource} already exists at #{path}"
+      else
+        resource
+      end
+    end
+
+    # 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(path)
+      # Relative path of resource to the file_path of this project.
+      relative_path = Pathname.new(path).relative_path_from(@root_file_path)
+      # Removes the .fooz.baz
+      File.join("/", relative_path).to_s.sub(/\..*/, '')
+    end
+
+    def safe_root
+      @safe_root ||= SafeRoot.new(path: @root_file_path)
+    end
+  end
+end

data/lib/mascot/safe_root.rb

@@ -0,0 +1,42 @@
+require "pathname"
+
+module Mascot
+  # Validates if a path is within another path. This prevents
+  # users from accidentally selecting a file outside of their sitemap,
+  # 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

data/lib/mascot/sitemap.rb

@@ -0,0 +1,52 @@
+require "pathname"
+
+module Mascot
+  # A collection of pages from a directory.
+  class Sitemap
+    # Default file pattern to pick up in sitemap
+    DEFAULT_GLOB = "**/**".freeze
+    # Default root path for sitemap.
+    DEFAULT_ROOT_PATH = Pathname.new(".").freeze
+    # Default root request path
+    DEFAULT_ROOT_REQUEST_PATH = Pathname.new("/").freeze
+
+    attr_reader :root, :request_path
+
+    def initialize(root: DEFAULT_ROOT_PATH, request_path: DEFAULT_ROOT_REQUEST_PATH)
+      self.root = root
+      self.request_path = request_path
+    end
+
+    # 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
+    end
+
+    # Returns a list of resources.
+    def resources
+      Resources.new(root_file_path: root).tap do |resources|
+        assets.each { |a| resources.add_asset a }
+      end
+    end
+
+    # Find the page with a path.
+    def get(request_path)
+      resources.get(request_path)
+    end
+
+    def root=(path)
+      @root = Pathname.new(path)
+    end
+
+    def request_path=(path)
+      @request_path = Pathname.new(path)
+    end
+
+    private
+    def safe_root
+      @safe_root ||= SafeRoot.new(path: root)
+    end
+  end
+end

data/lib/mascot/version.rb

@@ -1,3 +1,3 @@
 module Mascot
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

data/lib/mascot.rb

@@ -1,145 +1,19 @@
 require "mascot/version"
 
-require "forwardable"
-require "pathname"
-require "yaml"
-require "mime/types"
-
 module Mascot
   # Raised if a user attempts to access a resource outside of the sitemap path.
-  InsecurePathAccessError = Class.new(SecurityError)
-
-  # Parses metadata from the header of the page.
-  class Frontmatter
-    DELIMITER = "---".freeze
-    PATTERN = /\A(#{DELIMITER}\n(.+)\n#{DELIMITER}\n)?(.+)\Z/m
-
-    attr_reader :body
-
-    def initialize(content)
-      _, @data, @body = content.match(PATTERN).captures
-    end
-
-    def data
-      @data ? YAML.load(@data) : {}
-    end
-
-    private
-    def parse
-      @content
-    end
-  end
-
-  # Represents a page in a web server context.
-  class Resource
-    # If we can't resolve a mime type for the resource, we'll fall
-    # back to this binary octet-stream type so the client can download
-    # the resource and figure out what to do with it.
-    DEFAULT_MIME_TYPE = MIME::Types["application/octet-stream"].first
-
-    attr_reader :request_path, :file_path
-
-    extend Forwardable
-    def_delegators :@frontmatter, :data, :body
-
-    def initialize(request_path: , file_path: , mime_type: nil)
-      @request_path = request_path
-      @file_path = Pathname.new file_path
-      @frontmatter = Frontmatter.new File.read @file_path
-      @mime_types = Array(mime_type) if mime_type
-    end
-
-    # List of all file extensions.
-    def extensions
-      @file_path.basename.to_s.split(".").drop(1)
-    end
-
-    # Returns the format extension.
-    def format_extension
-      extensions.first
-    end
-
-    # Returns a list of the rendering extensions.
-    def template_extensions
-      extensions.drop(1)
-    end
-
-    def mime_type
-      (@mime_types ||= Array(resolve_mime_type)).push(DEFAULT_MIME_TYPE).first
-    end
-
-    # Treat resources with the same request path as equal.
-    def ==(resource)
-      request_path == resource.request_path
-    end
-
-    private
-    # Returns the mime type of the file extension. If a type can't
-    # be resolved then we'll just grab the first type.
-    def resolve_mime_type
-      MIME::Types.type_for(format_extension) if format_extension
-    end
-  end
-
-  # A collection of pages from a directory.
-  class Sitemap
-    # Default file pattern to pick up in sitemap
-    DEFAULT_GLOB = "**/**".freeze
-    # Default root path for sitemap.
-    DEFAULT_ROOT_DIR = Pathname.new(".").freeze
-    # Default root request path
-    DEFAULT_ROOT_REQUEST_PATH = Pathname.new("/").freeze
-
-    attr_reader :file_path, :request_path
-
-    def initialize(file_path: DEFAULT_ROOT_DIR, request_path: DEFAULT_ROOT_REQUEST_PATH)
-      self.file_path = file_path
-      self.request_path = request_path
-    end
-
-    # Lazy stream of resources.
-    def resources(glob = DEFAULT_GLOB)
-      Dir[validate_path(@file_path.join(glob))].select(&File.method(:file?)).lazy.map do |path|
-        Resource.new request_path: request_path(path), file_path: path
-      end
-    end
-
-    # Find the page with a path.
-    def find_by_request_path(request_path)
-      return if request_path.nil?
-      resources.find { |r| r.request_path == File.join("/", request_path) }
-    end
-
-    def file_path=(path)
-      @file_path = Pathname.new(path)
-    end
-
-    def request_path=(path)
-      @request_path = Pathname.new(path)
-    end
-
-    private
+  UnsafePathAccessError = Class.new(SecurityError)
 
-    # Make sure the user is accessing a file within the root path of the
-    # sitemap.
-    def validate_path(path)
-      root_path = @file_path.expand_path.to_s
-      resource_path = path.expand_path.to_s
+  # Raised by Resources if a path is added that's not a valid path.
+  InvalidRequestPathError = Class.new(RuntimeError)
 
-      if resource_path.start_with? root_path
-        path
-      else
-        raise Mascot::InsecurePathAccessError, "#{resource_path} outside sitemap #{root_path} directory"
-      end
-    end
+  # Raised by Resources if a path is already in its index
+  ExistingRequestPathError = Class.new(InvalidRequestPathError)
 
-    # 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 request_path(path)
-      # Relative path of resource to the file_path of this project.
-      relative_path = Pathname.new(path).relative_path_from(@file_path)
-      # Removes the .fooz.baz
-      @request_path.join(relative_path).to_s.sub(/\..*/, '')
-    end
-  end
+  autoload :Asset,        "mascot/asset"
+  autoload :Frontmatter,  "mascot/frontmatter"
+  autoload :SafeRoot,     "mascot/safe_root"
+  autoload :Resources,    "mascot/resources"
+  autoload :Resource,     "mascot/resource"
+  autoload :Sitemap,      "mascot/sitemap"
 end

data/mascot.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "pry"
 
   spec.add_runtime_dependency "mime-types", ">= 2.99"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mascot
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Brad Gessler
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-24 00:00:00.000000000 Z
+date: 2016-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -88,6 +74,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/mascot.rb
+- lib/mascot/asset.rb
+- lib/mascot/frontmatter.rb
+- lib/mascot/resource.rb
+- lib/mascot/resources.rb
+- lib/mascot/safe_root.rb
+- lib/mascot/sitemap.rb
 - lib/mascot/version.rb
 - mascot.gemspec
 homepage: https://github.com/bradgessler/mascot