munge 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a89ec9386b6243aad9b81eefacf82593e7ed7398
-  data.tar.gz: 207829f90d9401f2e67515ab50c8bbfb236d1bfb
+  metadata.gz: 25f673749fbc6937969b76dc5e6067a6b93d36db
+  data.tar.gz: 662c67d7e42c7a62ce0a2759c31de3c9f61911a0
 SHA512:
-  metadata.gz: 88bda267fc35cf2ff6b74e4e2500505aca408d306fabdc2201386721d82b801cb1bd70ee43f015caec48356d13b84f5f8c5d2922d2c2da34b03fa695996dceaa
-  data.tar.gz: acd79ec11a7b1fc356aaa3323e51c748bcbbf24add3d37ebc826dd510a8dacfb9cc9d73efdaa15c7fd0d11087987bec2a94fe880e74af332599d78aa14a7335c
+  metadata.gz: 96c0ad09cbe74495f54bb76a9c1f2db9449362cb2e521331b2408c20f2572d091d07077ee3f59522c4b0e430e8702f9845ee5cb2c9aac0bb5adc60e027de4ef2
+  data.tar.gz: 86d863d8c3cc7ceb8022097fbdee9dc87851376d842f77499627aa2aa54119c15a2f7e96bb95d456cbf27f82809f030fb3edd8b9d6ae1eb2017b280edb4a1032

data/lib/munge/bootloader.rb

@@ -3,26 +3,26 @@ module Munge
   class Bootloader
     # @param root_path [String] Absolute path to munge directory
     def initialize(root_path:)
-      @root_path   = root_path
-      @config_path = File.join(root_path, "config.yml")
-      @setup_path  = File.join(root_path, "setup.rb")
-      @rules_path  = File.join(root_path, "rules.rb")
-      @config      = Munge::Util::Config.read(@config_path)
+      @root_path = root_path
+      @setup_path = File.join(root_path, "setup.rb")
+      @rules_path = File.join(root_path, "rules.rb")
+
+      config_path = File.join(root_path, "config.rb")
+      @config = Munge::PreInit.new(config_path).config
     end
 
     # @return [Munge::Init]
     def init
       @init ||=
         Init.new(
-          root_path: @root_path,
-          config: @config,
-          setup_path: @setup_path,
-          rules_path: @rules_path
+          root_path: root_path,
+          config: config,
+          setup_path: setup_path,
+          rules_path: rules_path
         )
     end
 
     attr_reader :root_path
-    attr_reader :config_path
     attr_reader :setup_path
     attr_reader :rules_path
     attr_reader :config

data/lib/munge/cli/commands/build.rb

@@ -11,7 +11,7 @@ module Munge
           destination_root = bootloader.root_path
           config           = bootloader.config
           app              = application(bootloader)
-          destination      = File.expand_path(build_root || config[:output], destination_root)
+          destination      = File.expand_path(build_root || config[:output_path], destination_root)
 
           @runner =
             Munge::Runner.new(

data/lib/munge/cli/commands/server.rb

@@ -27,7 +27,7 @@ module Munge
           end
 
           ignore(listen, ENV["BUILD_ROOT"])
-          ignore(listen, @bootloader.config[:output])
+          ignore(listen, @bootloader.config[:output_path])
 
           listen
         end

data/lib/munge/cli/commands/view.rb

@@ -37,7 +37,7 @@ module Munge
           config = bootloader.config
           @host  = host
           @port  = port
-          root   = File.expand_path(build_root || config[:output], bootloader.root_path)
+          root   = File.expand_path(build_root || config[:output_path], bootloader.root_path)
 
           @app =
             Rack::Builder.new do

data/lib/munge/cli/dispatch.rb

@@ -55,7 +55,7 @@ module Munge
 
       def bootloader
         Munge::Bootloader.new(root_path: current_working_directory)
-      rescue Munge::Errors::ConfigYmlNotFound => e
+      rescue Munge::Errors::ConfigRbNotFound => e
         puts e.message
         exit
       end

data/lib/munge/config.rb

@@ -0,0 +1,53 @@
+module Munge
+  class Config
+    def initialize(**configs)
+      @configs = configs
+    end
+
+    def [](key)
+      sym_key = key.to_sym
+
+      if @configs.key?(sym_key)
+        @configs[sym_key]
+      else
+        raise Munge::Errors::ConfigKeyNotFound, sym_key
+      end
+    end
+
+    def []=(key, value)
+      @configs[key.to_sym] = value
+    end
+
+    def key?(key)
+      @configs.key?(key)
+    end
+
+    def method_missing(method_name, *arguments)
+      if setter_fn?(method_name)
+        self[key_from_setter(method_name)] = arguments.first
+      elsif key?(method_name)
+        self[method_name]
+      end
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      if setter_fn?(method_name)
+        true
+      elsif key?(method_name)
+        true
+      else
+        super
+      end
+    end
+
+    private
+
+    def setter_fn?(method_name)
+      method_name.to_s.end_with?("=")
+    end
+
+    def key_from_setter(method_name)
+      method_name.to_s.sub(/=$/, "").to_sym
+    end
+  end
+end

data/lib/munge/errors.rb

@@ -65,7 +65,7 @@ module Munge
       end
     end
 
-    class ConfigYmlNotFound < Base
+    class ConfigRbNotFound < Base
       include ErrorWithIdentifier
 
       def message
@@ -73,5 +73,13 @@ module Munge
         "Are you in the correct directory, or did you run `munge init`?"
       end
     end
+
+    class ConfigKeyNotFound < Base
+      include ErrorWithIdentifier
+
+      def message
+        "Couldn't find config for key: #{@identifier.inspect}"
+      end
+    end
   end
 end

data/lib/munge/go/sass.rb

@@ -18,13 +18,11 @@ module Munge
     #
     # @param system [Munge::System]
     # @return [void]
-    # rubocop:disable Style/AccessorMethodName
     def set_sass_system!(system)
       Sass::Script::Functions.send(:define_method, :system) do
         system
       end
     end
-    # rubocop:enable Style/AccessorMethodName
 
     # Includes methods into Sass functions scope
     #

data/lib/munge/init.rb

@@ -2,6 +2,8 @@ module Munge
   # This class loads the user rules, as well as provides some useful methods
   # for setup.
   class Init
+    include Munge::Util::Import
+
     # Initializing loads up the user's `setup.rb` and `rules.rb`.
     def initialize(root_path:,
                    config:,
@@ -34,8 +36,7 @@ module Munge
     # @return [void]
     def import(file_path)
       absolute_file_path = File.expand_path(file_path, root_path)
-      contents           = File.read(absolute_file_path)
-      @binding.eval(contents, absolute_file_path)
+      import_to_context(absolute_file_path, @binding)
     end
 
     attr_reader :app

data/lib/munge/pre_init.rb

@@ -0,0 +1,28 @@
+module Munge
+  class PreInit
+    include Munge::Util::Import
+
+    def initialize(config_path)
+      if !File.exist?(config_path)
+        raise Munge::Errors::ConfigRbNotFound, config_path
+      end
+
+      @config_path = config_path
+    end
+
+    def config
+      config = Munge::Config.new
+
+      import_to_context(@config_path, binding)
+
+      config
+    end
+
+    private
+
+    def __end__
+      contents = File.read(@config_path)
+      contents.split(/^__END__$/, 2).last
+    end
+  end
+end

data/lib/munge/routers/{add_index_html.rb → add_directory_index.rb}

@@ -1,9 +1,9 @@
 module Munge
   module Routers
-    class AddIndexHtml
-      def initialize(html_extensions:, index:)
-        @html_extensions = html_extensions
-        @index           = index
+    class AddDirectoryIndex
+      def initialize(extensions:, index:)
+        @extensions = extensions
+        @index = index
       end
 
       def type
@@ -21,7 +21,7 @@ module Munge
       private
 
       def item_is_html?(item)
-        intersection = item.extensions & @html_extensions
+        intersection = item.extensions & @extensions
 
         !intersection.empty?
       end

data/lib/munge/routers/fingerprint.rb

@@ -39,7 +39,7 @@ module Munge
       end
 
       def hash(content)
-        Digest::MD5.hexdigest(content)
+        Digest::SHA256.hexdigest(content)
       end
 
       def disassemble(path)

data/lib/munge/routers/remove_index_basename.rb

@@ -1,10 +1,10 @@
 module Munge
   module Routers
-    class RemoveIndexBasename
-      def initialize(html_extensions:, index:)
-        @html_extensions = html_extensions
-        @index           = index
-        @index_basename  = Munge::Util::Path.basename_no_extension(@index)
+    class RemoveBasename
+      def initialize(extensions:, basenames:, keep_explicit:)
+        @extensions = extensions
+        @basenames = basenames
+        @keep_if_explicit_extension = keep_explicit
       end
 
       def type
@@ -12,7 +12,7 @@ module Munge
       end
 
       def match?(initial_route, item)
-        item_is_html?(item) && basename_is_index?(initial_route)
+        item_has_extension?(item) && route_has_basename?(initial_route)
       end
 
       def call(initial_route, _item)
@@ -21,14 +21,24 @@ module Munge
 
       private
 
-      def item_is_html?(item)
-        intersection = item.extensions & @html_extensions
+      def item_has_extension?(item)
+        intersection = item.extensions & @extensions
 
         !intersection.empty?
       end
 
-      def basename_is_index?(route)
-        File.basename(route) == @index_basename
+      def route_has_basename?(route)
+        if @keep_if_explicit_extension
+          route_extensions = Munge::Util::Path.extnames(route)
+
+          if route_extensions.any?
+            return false
+          end
+        end
+
+        route_basename = Munge::Util::Path.basename_no_extension(route)
+
+        @basenames.include?(route_basename)
       end
     end
   end

data/lib/munge/system/item_factory.rb

@@ -5,7 +5,7 @@ module Munge
       # @param ignore_extensions [Array<String>] Strings are converted to regex
       def initialize(text_extensions:,
                      ignore_extensions:)
-        @text_extensions = Set.new(text_extensions)
+        @text_extensions = text_extensions
         @item_identifier = ItemIdentifier.new(remove_extensions: ignore_extensions)
       end
 
@@ -59,20 +59,20 @@ module Munge
 
       private
 
-      def file_extensions(filepath)
-        extensions = File.basename(filepath).split(".")[1..-1]
-        Set.new(extensions)
-      end
-
       def item_file_type(abspath)
-        exts = file_extensions(abspath)
-
-        if exts.intersect?(@text_extensions)
+        if has_text_extension?(abspath)
           :text
         else
           :binary
         end
       end
+
+      def has_text_extension?(filepath)
+        extensions = Munge::Util::Path.extnames(filepath)
+        intersection = extensions & @text_extensions
+
+        intersection.any?
+      end
     end
   end
 end

data/lib/munge/system/router/itemish.rb

@@ -13,9 +13,9 @@ module Munge
           @compiled_content ||= @processor.transform(@item)
         end
 
-        def_delegators :@item, *%i(type relpath id frontmatter stat layout)
-        def_delegators :@item, *%i(dirname filename basename extensions)
-        def_delegators :@item, *%i(relpath? route?)
+        def_delegators :@item, :type, :relpath, :id, :frontmatter, :stat, :layout
+        def_delegators :@item, :dirname, :filename, :basename, :extensions
+        def_delegators :@item, :relpath?, :route?
       end
     end
   end

data/lib/munge/system.rb

@@ -8,12 +8,12 @@ module Munge
     def items
       return @items if @items
 
-      source_path = File.expand_path(@config[:source], @root_path)
+      source_path = File.expand_path(@config[:source_path], @root_path)
 
       source_item_factory =
         ItemFactory.new(
-          text_extensions: @config[:text_extensions] + @config[:bintext_extensions],
-          ignore_extensions: @config[:dynamic_extensions]
+          text_extensions: @config[:items_text_extensions],
+          ignore_extensions: @config[:items_ignore_extensions]
         )
 
       @items =
@@ -26,11 +26,11 @@ module Munge
     def layouts
       return @layouts if @layouts
 
-      layouts_path = File.expand_path(@config[:layouts], @root_path)
+      layouts_path = File.expand_path(@config[:layouts_path], @root_path)
 
       layouts_item_factory =
         ItemFactory.new(
-          text_extensions: @config[:text_extensions] + @config[:bintext_extensions],
+          text_extensions: @config[:layouts_text_extensions],
           ignore_extensions: %w(.+)
         )
 
@@ -55,7 +55,7 @@ module Munge
     def global_data
       return @global_data if @global_data
 
-      data_path = File.expand_path(@config[:data], @root_path)
+      data_path = File.expand_path(@config[:data_path], @root_path)
       @global_data = YAML.load_file(data_path) || {}
     end
 

data/lib/munge/transformers/tilt_transformer.rb

@@ -11,7 +11,7 @@ module Munge
         :tilt
       end
 
-      def call(item, content = nil, renderer = nil)
+      def call(item, content, renderer = nil)
         scope = Scope.new(@system.clone, @demands)
         @registry.each { |helpers| scope.extend(helpers) }
 

data/lib/munge/util/import.rb

@@ -0,0 +1,15 @@
+module Munge
+  module Util
+    module Import
+      # Loads file into current scope. Similar to `load "filename.rb"`
+      #
+      # @param absolute_file_path [String]
+      # @param execution_context [Binding]
+      # @return [void]
+      def import_to_context(absolute_file_path, execution_context)
+        contents = File.read(absolute_file_path)
+        execution_context.eval(contents, absolute_file_path)
+      end
+    end
+  end
+end

data/lib/munge/version.rb

@@ -1,3 +1,3 @@
 module Munge
-  VERSION = "0.14.0".freeze
+  VERSION = "0.15.0".freeze
 end

data/lib/munge.rb

@@ -1,7 +1,6 @@
 require "fileutils"
 require "forwardable"
 require "pathname"
-require "set"
 require "yaml"
 require "cgi"
 
@@ -19,8 +18,8 @@ require "munge/item"
 require "munge/errors"
 require "munge/util/path"
 require "munge/util/symbol_hash"
-require "munge/util/config"
 require "munge/util/boolean_regex"
+require "munge/util/import"
 require "munge/system/router"
 require "munge/system/router/itemish"
 require "munge/system/item_factory"
@@ -34,8 +33,10 @@ require "munge/writers/filesystem"
 require "munge/writers/noop"
 require "munge/write_manager"
 require "munge/application"
+require "munge/config"
 require "munge/runner"
 require "munge/reporter"
+require "munge/pre_init"
 require "munge/init"
 require "munge/bootloader"
 
@@ -49,6 +50,6 @@ require "munge/helpers/rendering"
 require "munge/helpers/tag"
 require "munge/routers/auto_add_extension"
 require "munge/routers/fingerprint"
-require "munge/routers/add_index_html"
+require "munge/routers/add_directory_index"
 require "munge/routers/remove_index_basename"
 require "munge/transformers/tilt_transformer"

data/seeds/config.rb

@@ -0,0 +1,65 @@
+yml = YAML.load(__end__)
+
+# Path to content
+config.source_path = "src"
+# Path to layouts
+config.layouts_path = "layouts"
+# Path to output result directory
+config.output_path = "dest"
+# Path to global data file
+config.data_path = "data.yml"
+
+# Determines `item.type` for items and layouts
+# This can be useful avoid applying a transformation to an image
+config.items_text_extensions = yml["text_extensions"] + yml["bintext_extensions"]
+config.layouts_text_extensions = yml["text_extensions"] + yml["bintext_extensions"]
+
+# Specify which extensions shouldn't be included as a part of `item.id`
+config.items_ignore_extensions = yml["dynamic_extensions"]
+
+# Specify which files require an asset fingerprint
+config.router_fingerprint_extensions = yml["bin_extensions"] + yml["bintext_extensions"]
+
+# Separator between basename and fingerprint hash
+config.router_fingeprint_separator = "-"
+
+# Remove basename from compiled _route_ if the basename is passed and original file has extension
+config.router_remove_basename_original_extensions = %w(htm html)
+config.router_remove_basename_route_basenames = %w(index)
+config.router_remove_basename_keep_explicit = true
+
+# Append basename to the _filepath_ if missing and if original file has extension
+config.router_add_index_original_extensions = yml["text_extensions"]
+config.router_add_index_basename = "index.html"
+
+# Ensure that items with these extensions retains the extension, even if the route itself does not specify it
+config.router_keep_extensions = yml["bin_extensions"] + yml["bintext_extensions"]
+
+__END__
+---
+text_extensions:
+  - html
+  - htm
+  - txt
+  - md
+
+bintext_extensions:
+  - js
+  - css
+  - scss
+
+bin_extensions:
+  - gif
+  - ico
+  - jpg
+  - jpeg
+  - png
+  - otf
+  - ttf
+  - eot
+  - woff
+
+dynamic_extensions:
+  - erb
+  - scss
+  - md

data/seeds/lib/routing.rb

@@ -1,28 +1,29 @@
 if ENV["MUNGE_ENV"] == "production"
   system.router.register(
     Routers::Fingerprint.new(
-      extensions: config[:bin_extensions] + config[:bintext_extensions],
-      separator: config[:fingeprint_separator]
+      extensions: config[:router_fingerprint_extensions],
+      separator: config[:router_fingeprint_separator]
     )
   )
 end
 
 system.router.register(
-  Routers::RemoveIndexBasename.new(
-    html_extensions: config[:text_extensions],
-    index: config[:index]
+  Routers::RemoveBasename.new(
+    extensions: config[:router_remove_basename_original_extensions],
+    basenames: config[:router_remove_basename_route_basenames],
+    keep_explicit: config[:router_remove_basename_keep_explicit]
   )
 )
 
 system.router.register(
-  Routers::AddIndexHtml.new(
-    html_extensions: config[:text_extensions],
-    index: config[:index]
+  Routers::AddDirectoryIndex.new(
+    extensions: config[:router_add_index_original_extensions],
+    index: config[:router_add_index_basename]
   )
 )
 
 system.router.register(
   Routers::AutoAddExtension.new(
-    keep_extensions: config[:bin_extensions] + config[:bintext_extensions]
+    keep_extensions: config[:router_keep_extensions]
   )
 )

data/seeds/lib/sass.rb

@@ -1,6 +1,6 @@
 require "munge/go/sass"
 
-Munge::Go.add_sass_load_path!(root_path, config[:source], AssetRoots.stylesheets_root)
+Munge::Go.add_sass_load_path!(root_path, config[:source_path], AssetRoots.stylesheets_root)
 
 Munge::Go.set_sass_system!(system)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: munge
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Zach Ahn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-23 00:00:00.000000000 Z
+date: 2017-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -288,7 +288,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
-description: Documentation for this release is located in https://github.com/zachahn/munge/blob/v0.14.0/README.md
+description: Documentation for this release is located in https://github.com/zachahn/munge/blob/v0.15.0/README.md
 email:
 - zach.ahn@gmail.com
 executables:
@@ -310,6 +310,7 @@ files:
 - lib/munge/cli/commands/update.rb
 - lib/munge/cli/commands/view.rb
 - lib/munge/cli/dispatch.rb
+- lib/munge/config.rb
 - lib/munge/errors.rb
 - lib/munge/formatters/default.rb
 - lib/munge/formatters/dots.rb
@@ -324,8 +325,9 @@ files:
 - lib/munge/helpers/tag.rb
 - lib/munge/init.rb
 - lib/munge/item.rb
+- lib/munge/pre_init.rb
 - lib/munge/reporter.rb
-- lib/munge/routers/add_index_html.rb
+- lib/munge/routers/add_directory_index.rb
 - lib/munge/routers/auto_add_extension.rb
 - lib/munge/routers/fingerprint.rb
 - lib/munge/routers/remove_index_basename.rb
@@ -341,7 +343,7 @@ files:
 - lib/munge/system/router/itemish.rb
 - lib/munge/transformers/tilt_transformer.rb
 - lib/munge/util/boolean_regex.rb
-- lib/munge/util/config.rb
+- lib/munge/util/import.rb
 - lib/munge/util/path.rb
 - lib/munge/util/symbol_hash.rb
 - lib/munge/version.rb
@@ -351,7 +353,7 @@ files:
 - munge.gemspec
 - seeds/.gitignore
 - seeds/Gemfile.tt
-- seeds/config.yml
+- seeds/config.rb
 - seeds/data.yml
 - seeds/layouts/blog_archives.html.erb
 - seeds/layouts/blog_index.html.erb

data/lib/munge/util/config.rb

@@ -1,30 +0,0 @@
-module Munge
-  module Util
-    class Config
-      class << self
-        def read(path)
-          abspath = File.expand_path(path)
-
-          yaml = read_yaml(abspath)
-
-          config =
-            if yaml.is_a?(Hash)
-              yaml
-            else
-              {}
-            end
-
-          Munge::Util::SymbolHash.deep_convert(config)
-        end
-
-        private
-
-        def read_yaml(abspath)
-          YAML.load_file(abspath)
-        rescue
-          raise Munge::Errors::ConfigYmlNotFound, abspath
-        end
-      end
-    end
-  end
-end

data/seeds/config.yml

@@ -1,29 +0,0 @@
-source: src
-output: dest
-data: data.yml
-layouts: layouts
-index: index.html
-fingeprint_separator: "-"
-text_extensions:
-  - html
-  - htm
-  - txt
-  - md
-bintext_extensions:
-  - js
-  - css
-  - scss
-bin_extensions:
-  - gif
-  - ico
-  - jpg
-  - jpeg
-  - png
-  - otf
-  - ttf
-  - eot
-  - woff
-dynamic_extensions:
-  - erb
-  - scss
-  - md