munge 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21f94ee6721dd5a6248f8cc682e7c20b25e37c3c
-  data.tar.gz: 4bc2576726939c6ec80482b94fdb05d700dfeab2
+  metadata.gz: 94019c2c419a44b2c4be2aca94cbc587e7875439
+  data.tar.gz: b8113ced2804eb5b33093ba9a33da97324fbbb7a
 SHA512:
-  metadata.gz: b5953027d4225360dfe10436c2c65956cdffe57657e766709b753948f6a212295bcf6aeb198127719749c15db09cdb19fd27cce7eb7b16887cf47a7d75e36d8b
-  data.tar.gz: 38649c10faff0d936d49b72f2f72a2a05e2fd134f599030f6d7ac589b05758699b9098e3cce14c2035d069333290cdb9145690d6c134236d96277db674863231
+  metadata.gz: a75c4565e8cf70ca137a5516b5d320300dc51d181f28fa5c18b69c68aee7fe2e0d9f86a353c152b89552a1979a85059fb7025279e1aada0e2150597d1ed51d51
+  data.tar.gz: b1a255bde2c32b711c5751261a5eb2c5545a5f3aeb1e433c151059fb8549d9202eeb3a157b2cc0733caf54679de8a79f8d8c396d4f748248cfb7acfde75ba943

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in munge.gemspec
 gemspec

data/README.md

@@ -6,6 +6,9 @@
 
 Munge is a static site generator aiming to simplify complex build rules.
 
+It's built partially to emulate unix pipes and scripts; small transformations
+can be joined, composed, and applied to create almost any site you can think up.
+
 SemVer will be followed once 1.0.0 is released.
 Until then,
 the API should be considered experimental.
@@ -13,16 +16,22 @@ the API should be considered experimental.
 
 ## Features
 
+- No DSL
 - No metaprogramming
-- Suitable for large, complex sites (e.g., multiple blogs with different templates, a single blog with multiple data sources)
+- LiveReload
+- Optional frontmatter
+- Suitable for large, complex sites (e.g., multiple blogs with different
+  templates, a single blog with multiple data sources)
+- Very configurable
 - Concise rule definition
-- Rules defined by iterating through arrays and modifying objects
+- Rules defined by iterating through arrays and modifying matching objects
 
 
 ## Caveats
 
-- Not optimized (Pull requests welcome, gradual optimizations preferred)
-- Rules can seem pretty dense (because of its conciseness)
+- Not yet optimized (Pull requests welcome, gradual optimizations preferred)
+- User facing API has mostly stabilized, but plugins have yet to be fully worked
+  out
 
 
 ## Installation
@@ -30,7 +39,7 @@ the API should be considered experimental.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'munge'
+gem "munge"
 ```
 
 And then execute:
@@ -49,8 +58,9 @@ After installing your gem, you can start a project using the command line client
 ```bash
 munge init path/to/project  # create a barebones project
 cd path/to/project
-munge build                 # compiles your project
-munge view                  # open http://localhost:7000/ to see output
+munge server                # starts auto-compiling dev server http://localhost:7000/
+munge build                 # compiles your project for production
+munge view                  # preview production build on http://localhost:7000/
 ```
 
 The three main files of your application are `config.yml`, `data.yml`, and `rules.rb`.

data/lib/munge/cli/dispatch.rb

@@ -8,8 +8,8 @@ module Munge
       end
 
       desc "build", "Build site"
-      method_option :reporter,    desc: "Set reporting formatter", default: "Default", type: :string
-      method_option :dry_run,     desc: "Run without writing files", default: false, type: :boolean
+      method_option :reporter, desc: "Set reporting formatter", default: "Default", type: :string
+      method_option :dry_run, desc: "Run without writing files", default: false, type: :boolean
       method_option :verbosity, aliases: "-v", desc: "Preferred amount of output", enum: %w(all written silent), default: "written", type: :string
       def build
         ENV["MUNGE_ENV"] ||= "production"

data/lib/munge/extras/livereload/server.rb

@@ -16,10 +16,13 @@ module Munge
                 socket << @messaging.reload(file)
               end
             rescue Reel::SocketError
+              print_error("error pushing livereload notification to browser")
             end
           end
         end
 
+        private
+
         def on_connection(connection)
           connection.each_request do |request|
             if request.websocket?
@@ -41,6 +44,7 @@ module Munge
             end
           end
         rescue Reel::SocketError
+          print_error("error with livereload socket")
         end
 
         def handle_request(request)
@@ -51,6 +55,10 @@ module Munge
             request.respond(:not_found, "not found")
           end
         end
+
+        def print_error(message)
+          $stderr.puts(message)
+        end
       end
     end
   end

data/lib/munge/item.rb

@@ -41,6 +41,14 @@ module Munge
       Munge::Util::Path.basename_no_extension(@relpath)
     end
 
+    # @return [String] relpath, without extensions
+    def basepath
+      dirname = Munge::Util::Path.dirname(@relpath)
+      basename = Munge::Util::Path.basename_no_extension(@relpath)
+
+      Munge::Util::Path.join(dirname, basename)
+    end
+
     # @return [Array<String>] extensions (everything following the first ".")
     def extensions
       Munge::Util::Path.extnames(@relpath)

data/lib/munge/runner.rb

@@ -39,8 +39,6 @@ module Munge
         @written_items.push(route)
       when :double_write_error
         raise Errors::DoubleWriteError, item.route
-      when :identical
-        # Defer to the reporter
       end
 
       @reporter.call(item, relpath, write_status)

data/lib/munge/system/item_factory.rb

@@ -60,14 +60,14 @@ module Munge
       private
 
       def item_file_type(abspath)
-        if has_text_extension?(abspath)
+        if text_file_extension?(abspath)
           :text
         else
           :binary
         end
       end
 
-      def has_text_extension?(filepath)
+      def text_file_extension?(filepath)
         extensions = Munge::Util::Path.extnames(filepath)
         intersection = extensions & @text_extensions
 

data/lib/munge/version.rb

@@ -1,3 +1,3 @@
 module Munge
-  VERSION = "0.16.0".freeze
+  VERSION = "0.17.0".freeze
 end

data/seeds/Gemfile.tt

@@ -1,3 +1,3 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'munge', '~> <%= Munge::VERSION %>'
+gem "munge", "~> <%= Munge::VERSION %>"

data/seeds/layouts/blog.html.erb

@@ -0,0 +1,5 @@
+<% layout("default") do %>
+  <h1>Blog</h1>
+
+  <%= yield %>
+<% end %>

data/seeds/layouts/blog_archives.html.erb

@@ -1,4 +1,4 @@
-<% layout("default") do %>
+<% layout("blog") do %>
   <ul>
     <% posts.each do |post| %>
       <li><a href="<%= path_to(post) %>"><%= post.basename %></a></li>

data/seeds/layouts/blog_index.html.erb

@@ -1,7 +1,6 @@
-<% layout("default") do %>
-  <h1>Blog</h1>
-
+<% layout("blog") do %>
   <% posts.each do |post| %>
     <%= render(post) %>
+    <%= link_to(post, "Permalink") %>
   <% end %>
 <% end %>

data/seeds/layouts/blog_show.html.erb

@@ -1,3 +1,3 @@
-<% layout("default") do %>
+<% layout("blog") do %>
   <%= yield %>
 <% end %>

data/seeds/rules.rb

@@ -32,7 +32,8 @@ app.create("blog-archive.html.erb", "", posts: blog_public_items)
 # Home page rules
 app.nonrouted
   .select { |item| item.relpath?("home") }
-  .each   { |item| item.route = "#{item.id.sub(%r{^home/}, "")}" }
+  .select { |item| item.type == :text }
+  .each   { |item| item.route = "#{item.basepath.sub(%r{^home/}, "")}" }
   .each   { |item| item.layout = "default" }
   .each(&transform)
 

data/seeds/src/blog/01-first-post.html

@@ -0,0 +1,3 @@
+<h2>First Post</h2>
+
+<p>I love using munge!</p>

data/seeds/src/blog/02-second-post.html

@@ -0,0 +1,3 @@
+<h2>Wow!</h2>
+
+<p>This is really cool!</p>

data/seeds/src/blog/03-third-post.draft.html

@@ -0,0 +1,3 @@
+<h2>This is a draft</h2>
+
+<p>This file is hidden from the primary view, but it is still compiled.</p>

data/seeds/src/home/index.html.erb

@@ -22,10 +22,11 @@ title: Woohoo!
 </p>
 
 <p>
-  <strong><code>config.yml</code>:</strong>
+  <strong><code>config.rb</code>:</strong>
   The keys defined here are used to change the behavior of the app.
   Many of the keys are passed directly into the initializers in
-  <code>setup.rb</code>.
+  <code>setup.rb</code>. It is possible to create arbitrary configuration keys
+  and use them in custom plugins, etc.
 </p>
 
 <h2>Example Links</h2>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: munge
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Zach Ahn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -302,7 +302,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-description: Documentation for this release is located in https://github.com/zachahn/munge/blob/v0.16.0/README.md
+description: Documentation for this release is located in https://github.com/zachahn/munge/blob/v0.17.0/README.md
 email:
 - zach.ahn@gmail.com
 executables:
@@ -376,6 +376,7 @@ files:
 - seeds/Gemfile.tt
 - seeds/config.rb
 - seeds/data.yml
+- seeds/layouts/blog.html.erb
 - seeds/layouts/blog_archives.html.erb
 - seeds/layouts/blog_index.html.erb
 - seeds/layouts/blog_show.html.erb
@@ -392,9 +393,9 @@ files:
 - seeds/src/assets/javascripts/.empty_directory
 - seeds/src/assets/stylesheets/_vars.scss
 - seeds/src/assets/stylesheets/basic.css.scss
-- seeds/src/blog/01-first-post.md
-- seeds/src/blog/02-second-post.md
-- seeds/src/blog/03-third-post.draft.md
+- seeds/src/blog/01-first-post.html
+- seeds/src/blog/02-second-post.html
+- seeds/src/blog/03-third-post.draft.html
 - seeds/src/home/about.html.erb
 - seeds/src/home/index.html.erb
 homepage: https://github.com/zachahn/munge

data/seeds/src/blog/01-first-post.md

@@ -1,3 +0,0 @@
-## First Post
-
-I love using munge!

data/seeds/src/blog/02-second-post.md

@@ -1,3 +0,0 @@
-## Wow!
-
-This is really cool!

data/seeds/src/blog/03-third-post.draft.md

@@ -1,3 +0,0 @@
-## This is a draft
-
-This file is hidden from the primary view, but it is still compiled.