inert 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9fa03de85cd5a1d823843221a17b25ba4a48608c
-  data.tar.gz: 3d5c640a2cf87564991504c84435820016a6eaab
+  metadata.gz: f79a5379e8bc3c2efef1112aa3594a0d21c5ebd2
+  data.tar.gz: dac79be86b3228b75c50344d97a1af2131efa962
 SHA512:
-  metadata.gz: e9c3978a0924899c9d3cb7f326d727a07364b0ca6814b07ea931f46a8ea3cfd5660bb537de3e8c2b5fe35ede51fca105aa06f6cc53da71eb129e9a1a6f3db1da
-  data.tar.gz: 3b57e1472757407d5a3b00725f7aedc1f089055eb674425c6e43a43449ab44d1dbb127fc2d4c06e2cbf3542502c53ead4ed227fdea6358a254d930262c1e4ac1
+  metadata.gz: 958d318d85847d81d45b76d7e2a42f2e6b8d437b0dc1fa896676ddd0e4ae4603fa9aac2bdf575fd53cc02f2751276d5374bb3aebfdbaae83165c9c79ef4a3194
+  data.tar.gz: 96b3d288ead98c0e282eddec337bcd01de90d32a8c1eff0ad11b86ea09d5860c6dd28fe01b4eb621e47b6c2b6cd24ffe0e472248a254e82102d0b5761bcf5552

data/README.md

@@ -8,6 +8,105 @@ An experimental static site builder with unambitious goals.
 - Allow reading of YAML frontmatter
 - Allow queueing of manual URLs for preservation
 
+
+## Usage
+
+Install the gem:
+
+    gem install inert
+
+Create a few folders:
+
+    mkdir static views
+
+And a layout file:
+
+    echo "<%= yield %>" > views/layout.erb
+
+And then start the Inert server:
+
+    inert
+
+When you're ready to deploy, build the site:
+
+    inert build
+
+## Configuring
+
+By default, Inert expects a few things, and should work without configuration.
+Because it's built on top of Roda, it's very easily extendable, and Inert
+provides hooks to do this via the `Inertfile` it will read from your project
+root at runtime.
+
+```ruby
+# Inertfile
+Inert.config do |inert|
+   inert.helpers do
+     def generator
+       "Inert v#{Inert::VERSION}"
+     end
+   end
+  
+  inert.app do
+    plugin :h
+  end
+  
+  inert.routes do |r|
+    r.on "employees.html" do
+      @employees = [] # Read in actual data here
+      view("employees.html.erb")
+    end
+  end
+end
+```
+
+## Asset Fingerprinting
+
+Use asset fingerprinting to enable max-cache times on all your static assets.
+
+```ruby
+# Inertfile
+Inert.config do |inert|
+  inert.app do
+    plugin :timestamp_public
+  end
+
+  inert.routes do |r|
+    r.timestamp_public
+  end
+end
+```
+
+And inside your views, use the `timestamp_path` helper with the name of the file
+in `static/` wherever you'd just use the filename itself:
+
+```ruby
+<img src="<%= timestamp_path "some_image_in_static_folder.png" %>">
+```
+
+## Live Reloads
+
+Use the `roda-live_reload` gem to enable live reloads:
+
+
+```ruby
+# Gemfile
+gem "roda-live_reload"
+gem "puma" # Webrick wont' currently work with roda-live_reload
+
+
+# Inertfile
+Inert.config do |inert|
+  inert.app do
+    plugin :live_reload if ENV["RACK_ENV"] == "development"
+  end
+
+  inert.routes do |r|
+    r.live_reload if ENV["RACK_ENV"] == "development"
+  end
+end
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/adam12/inert.

data/exe/inert

@@ -1,11 +1,18 @@
 #!/usr/bin/env ruby
-require "inert"
+require "inert/config"
+
+inertfile = File.join(Dir.pwd, "Inertfile")
+if File.exist?(inertfile)
+  load inertfile
+end
 
 case ARGV[0]
 when "build"
   ENV["RACK_ENV"] = "production"
+  require "inert"
   Inert.build
 else
   ENV["RACK_ENV"] = "development"
+  require "inert"
   Inert.start
 end

data/lib/inert.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
-require_relative "inert/page"
-require_relative "inert/builder"
-require_relative "inert/middleware"
+require_relative "inert/config"
 
 module Inert
   module_function
 
   def start
-    app = Inert::Middleware
+    app = Rack::Builder.app do
+      if ENV["RACK_ENV"] != "production"
+        use Rack::ShowExceptions
+        use Rack::CommonLogger
+      end
 
-    if ENV["RACK_ENV"] != "production"
-      app = Rack::ShowExceptions.new(app)
+      run Inert::Middleware
     end
 
     Rack::Server.start(app: app)
@@ -19,4 +20,12 @@ module Inert
   def build
     Inert::Builder.new(Inert::Middleware).call("/")
   end
+
+  def view_path
+    File.expand_path(Inert.config.views, Dir.pwd)
+  end
 end
+
+require_relative "inert/page"
+require_relative "inert/builder"
+require_relative "inert/middleware"

data/lib/inert/builder.rb

@@ -2,6 +2,7 @@
 require "fileutils"
 require "set"
 require "oga"
+require "uri"
 
 module Inert
   class Builder
@@ -30,7 +31,7 @@ module Inert
       warn "Saving #{url}"
       request = Rack::MockRequest.new(app)
 
-      dest = url.dup
+      dest = URI(url.dup).path
       dest << "index.html"  if dest.end_with?("/")
       dest << ".html"       unless dest =~ /\.\w+$/
       dest = File.expand_path(dest[1..-1], build_path)

data/lib/inert/config.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+module Inert
+  # Configure your Inert build by creating an Inertfile in the project root,
+  # and call Inert.config with a block which receives the inert config instance.
+  #
+  # This config instance allows you to access the Roda application underneath,
+  # configuring plugins, helpers, and adding routes that run prior to the catch-all.
+  #
+  #   Inert.config do |inert|
+  #     inert.helpers do
+  #       def generator
+  #         "Inert v#{Inert::VERSION}"
+  #       end
+  #     end
+  #
+  #     inert.app do
+  #       plugin :h
+  #     end
+  #
+  #     inert.routes do |r|
+  #       r.on "employees.html" do
+  #         @employees = [] # Read in actual data here
+  #         view("employees.html.erb")
+  #       end
+  #     end
+  #   end
+  class Config
+    # Folder containing your pages or view files.
+    attr_accessor :views
+
+    def initialize
+      @app = proc{}
+      @helpers = proc{}
+      @routes = proc{}
+      @views = "views"
+    end
+
+    # Helpers to make available in your views.
+    # Pass a module to be included, or a block to be evaluates.
+    def helpers(value=nil, &block)
+      @helpers = ->{ include value } if value
+      @helpers = block if block_given?
+      @helpers
+    end
+
+    # Configuration changes on the underlying Roda app.
+    # Pass a block which will be class evaled.
+    def app(&block)
+      return @app unless block_given?
+      @app = block
+    end
+
+    # Extra routes that run before the catch-all route (but after the assets route).
+    # Pass a block which will be instance evaluated.
+    def routes(&block)
+      return @routes unless block_given?
+      @routes = block
+    end
+  end
+
+  module_function
+  def config
+    @config ||= Config.new
+    yield @config if block_given?
+    @config
+  end
+end

data/lib/inert/middleware.rb

@@ -3,31 +3,41 @@ require "roda"
 
 module Inert
   class Middleware < Roda
-    plugin :render, cache: ENV["RACK_ENV"] == "production"
+    plugin :render,
+      cache: ENV["RACK_ENV"] == "production",
+      views: Inert.config.views
+
     plugin :partials
     plugin :public, root: "static"
+    plugin :content_for
+
+    class_exec &Inert.config.app
 
     attr_reader :page
 
     route do |r|
       r.public
 
+      Inert.config.routes.call(r)
+
       view_file = r.remaining_path.dup
       view_file << "index.html" if view_file.end_with?("/")
 
       begin
-        page = Page.load_from_file("./views#{view_file}.erb")
+        page = Page.load_from_file(File.join(Inert.view_path, view_file))
       rescue Errno::ENOENT
         r.halt([404, {}, ["Not found"]])
       end
 
       @page = page.frontmatter
 
-      view(inline: page.body, layout: page.layout)
+      view(inline: page.body, layout: page.layout, template_class: Tilt[page.filename])
     end
 
+    class_exec &Inert.config.helpers
+
     def inline(file)
-      File.read("./views/#{file}")
+      File.read(File.join(Inert.view_path, file))
     end
   end
 end

data/lib/inert/page.rb

@@ -4,17 +4,22 @@ require "ostruct"
 
 module Inert
   class Page
-    attr_reader :body, :frontmatter, :layout
+    attr_reader :body, :frontmatter, :layout, :filename
 
-    def initialize(body: "", frontmatter: {})
+    def initialize(body: "", frontmatter: {}, filename: nil)
       @body = body
       @frontmatter = frontmatter
-      @layout = @frontmatter.delete(:layout) || "layout"
+      @layout = @frontmatter.delete("layout") || "layout"
+      @filename = filename
 
       @frontmatter = OpenStruct.new(@frontmatter)
     end
 
     def self.load_from_file(filename)
+      filename = find_file(filename)
+
+      raise Errno::ENOENT if filename.nil?
+
       body = File.read(filename)
       frontmatter = {}
 
@@ -23,7 +28,11 @@ module Inert
         ""
       end.lstrip
 
-      new(body: body, frontmatter: frontmatter)
+      new(body: body, frontmatter: frontmatter, filename: filename)
+    end
+
+    def self.find_file(filename)
+      Dir[filename + ".*"].first
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inert
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Adam Daniels
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-08 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roda
@@ -81,6 +81,7 @@ files:
 - exe/inert
 - lib/inert.rb
 - lib/inert/builder.rb
+- lib/inert/config.rb
 - lib/inert/middleware.rb
 - lib/inert/page.rb
 homepage: https://github.com/adam12/inert