flora 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b340a03e054b40453f05f5b751bd3abc4cf186111bb825dbe5990fa26f970d42
-  data.tar.gz: b35a8ede2c532cd62b779c47501533a559722a92881e4e9fe6f4461b317798db
+  metadata.gz: 1b44217297cbd020d161b21d49829be840dd7ec4b99327108aa1b0c14e4f3286
+  data.tar.gz: 32871444dfee770b17d99e57aa4753e1f8a40e02d3743e7e52e3a1ef77098a8d
 SHA512:
-  metadata.gz: ba753c9a4eae80973985438f154c30cfbd3706ffd29acccb7918b3fe212c1d248f6a63c3148635f89d874e62f3b50f61fedec9dff2f67ef0948ccf0944ad4895
-  data.tar.gz: 14c102dae1d31a85bd12bc3d9f50d5775230ed94f4342312d94d97df13ee0759770a5b576118fb5776fc9275cc348a20cb802686e307719a195a54155de07801
+  metadata.gz: 6567dab062a120dca84dabec2246266c5f482fcc2ba8899c541f2d4fd5a0801f7e6c7a9ef8f4af47896495dcf1768ce6eb763eea9df8b33db935a70fdc561617
+  data.tar.gz: f24f358cb9c3da51053b2c1301f2d5c0f85aaebadf1956558f623839e8c24acc241157b77962f7772e83a6e7d3542a768e488d0efbd6785878ba5431386dd747

data/README.md

@@ -1,3 +1,27 @@
 # Flora
 
 A static site generator.
+
+## Quickstart
+
+Make a new directory with a Gemfile that looks like this:
+
+```ruby
+source "https://rubygems.org"
+
+gem 'flora'
+```
+
+Make a new `index.rb` file that looks like this:
+
+```ruby
+html do
+  body do
+    h1 do
+      'Hello world!'
+    end
+  end
+end
+```
+
+Install everything with `bundle install`, and then run `bundle exec flora serve` and open up http://localhost:3000!

data/lib/flora/app.rb

@@ -7,7 +7,7 @@ class Flora::App
 
     def initialize(app, dir)
       @app = app
-      @dir = dir
+      @dir = Pathname.new(dir)
     end
 
     def call(env)
@@ -24,13 +24,13 @@ class Flora::App
 
 
   def self.app(path)
-    flora = Flora::Engine.new(path, '/tmp/flora/')
+    flora = Flora.new(path)
     # TODO: rebuild every req?
-    flora.build
+    flora.build('/tmp/flora/')
 
     Rack::Builder.new do
-      use StaticWithoutHtml, flora.out_dir
-      use Rack::Static, urls: [''], root: flora.out_dir.to_s, index: 'index.html'
+      use StaticWithoutHtml, '/tmp/flora'
+      use Rack::Static, urls: [''], root: '/tmp/flora', index: 'index.html'
       map "/" do
         run ->(env) do
           [404, {'Content-Type' => 'text/plain'}, ['Page Not Found!']]

data/lib/flora/cli.rb

@@ -4,7 +4,7 @@ class Flora::Cli < Thor
 
   desc 'build OUT_DIR', 'Build a site'
   def build(out_dir)
-    Flora::Engine.new('.', out_dir).build
+    Flora.new('.').build(out_dir)
   end
 
 

data/lib/flora/engine/config.rb

@@ -1,15 +1,12 @@
 class Flora::Engine::Config
 
-  attr_reader(:plugins)
-
-
-  def initialize
-    @plugins = []
+  def initialize(plugin_loader)
+    @plugin_loader = plugin_loader
   end
 
 
   def plugin(mod)
-    @plugins << mod
+    @plugin_loader.load_plugin(mod)
   end
 
 end

data/lib/flora/engine/page/html.rb

@@ -9,7 +9,7 @@ module Flora::Engine::Page::Html
     fieldset figcaption figure footer form
     h1 h2 h3 h4 h5 h6 head header hr html i iframe img input ins
     kbd keygen
-    label legend li
+    label legend li link
     main map mark menu meter
     nav
     object ol optgroup option output

data/lib/flora/engine/page.rb

@@ -10,6 +10,7 @@ class Flora::Engine::Page
       path.find do |file|
         next if IGNORES.any? { file.fnmatch((path / it).to_s) }
         next if file.directory?
+        next unless supported_file_type?(file)
 
         yield(self.for(path, file))
       end
@@ -25,6 +26,13 @@ class Flora::Engine::Page
       end
     end
 
+
+    private
+
+      def supported_file_type?(file)
+        file.extname == '.rb' || file.extname == '.md'
+      end
+
   end
 
 

data/lib/flora/engine.rb

@@ -1,61 +1,69 @@
 class Flora::Engine
 
-  attr_reader(:out_dir)
+  def initialize(path)
+    @path = Pathname.new(path)
+    @config = Config.new(self)
 
+    @site_loader = Zeitwerk::Loader.new
 
-  def initialize(path, out_dir)
-    @path = Pathname.new(path)
-    @out_dir = Pathname.new(out_dir)
-    @out_dir.mkdir unless @out_dir.exist?
-    @config = Config.new
+    if site_has_supporting_code?
+      setup_site_loader
+    end
 
     Kernel.prepend(Flora::Engine::Page::Html)
   end
 
 
-  def build
-    with_load_path(@path) do
-      config_file = @path.join('_config.rb')
-      @config.instance_eval(config_file.read)  if config_file.exist?
+  def configure
+    config_file = @path.join('_config.rb')
+    @config.instance_eval(config_file.read)  if config_file.exist?
+  end
 
-      init_plugins
 
-      Page.each(@path) do |page|
-        layouts = []
-        page.dir.ascend do |dir|
-          maybe_layout = dir.join('_layout.rb')
-          layouts << maybe_layout if maybe_layout.exist?
-          break if dir == @path
-        end
+  def build(out_dir)
+    @out_dir = Pathname.new(out_dir)
+    @out_dir.mkdir unless @out_dir.exist?
 
-        $flora_added = []
-        tree = Page::Layout.new(layouts).render do
-          page.render
-        end
-        html = Page::Html.to_html(tree)
+    Page.each(@path) do |page|
+      layouts = []
+      page.dir.ascend do |dir|
+        maybe_layout = dir.join('_layout.rb')
+        layouts << maybe_layout if maybe_layout.exist?
+        break if dir == @path
+      end
 
-        out_filename = @out_dir.join(page.outname)
-        out_filename.dirname.mkdir unless out_filename.dirname.exist?
-        out_filename.write(html)
+      $flora_added = []
+      tree = Page::Layout.new(layouts).render do
+        page.render
       end
+      html = Page::Html.to_html(tree)
+
+      out_filename = @out_dir.join(page.outname)
+      out_filename.dirname.mkdir unless out_filename.dirname.exist?
+      out_filename.write(html)
     end
+
+  end
+
+
+  def load_plugin(mod)
+    self.class.include(mod::EngineMethods) if defined?(mod::EngineMethods)
+    Page::RubyPage.include(mod::PageMethods) if defined?(mod::PageMethods)
+    Config.include(mod::Config) if defined?(mod::Config)
   end
 
 
   private
 
-    def with_load_path(path)
-      $LOAD_PATH << path.to_s
-      yield
-      $LOAD_PATH.delete(path.to_s)
+    def site_has_supporting_code?
+      @path.join('lib').exist?
     end
 
 
-    def init_plugins
-      @config.plugins.each do |plugin|
-        Page.include(plugin::Page) if self.class.const_defined?("#{plugin}::Page")
-        Page::RubyPage.include(plugin::RubyPage) if self.class.const_defined?("#{plugin}::RubyPage")
-      end
+    def setup_site_loader
+      @site_loader.push_dir(@path.join('lib').to_s)
+      @site_loader.enable_reloading
+      @site_loader.setup
     end
 
 end

data/lib/{flora_blog → flora/plugins/blog}/post.rb

@@ -1,18 +1,19 @@
-class FloraBlog::Post
+class Flora::Plugins::Blog::Post
 
-  def initialize(page)
+  def initialize(page, root)
     @page = page
+    @root = root
     @frontmatter = parse_frontmatter
   end
 
 
   def url
-    'https://google.com'
+    '/' + @page.relative_path_from(@root).sub(@page.extname, '').to_s
   end
 
 
   def title
-    'google'
+    @frontmatter['title']
   end
 
 

data/lib/flora/plugins/blog.rb

@@ -0,0 +1,11 @@
+module Flora::Plugins::Blog
+
+  module PageMethods
+
+    def posts
+      @root.glob('posts/**').map { Post.new(it, @root) }
+    end
+
+  end
+
+end

data/lib/flora/plugins/redirector.rb

@@ -0,0 +1,39 @@
+module Flora::Plugins::Redirector
+
+  module EngineMethods
+
+    def build(*)
+      super
+
+      @config.redirects.each do |src, dest|
+        out_filename = @out_dir.join(src + '.html')
+        out_filename.dirname.mkdir unless out_filename.dirname.exist?
+        out_filename.write(build_redir_file(dest))
+      end
+    end
+
+
+    def build_redir_file(url)
+      <<~HTML
+        <html>
+          <head>
+            <meta http-equiv="refresh" content="0; url=#{url}" />
+          </head>
+        </html>
+      HTML
+    end
+
+  end
+
+
+  module Config
+
+    def self.included(base)
+      base.class_eval do
+        attr_accessor(:redirects)
+      end
+    end
+
+  end
+
+end

data/lib/flora/plugins/static_files.rb

@@ -0,0 +1,46 @@
+module Flora::Plugins::StaticFiles
+
+  class Copier
+
+    def initialize(dir)
+      @dir = dir
+    end
+
+
+    def copy_to(out)
+      @dir.find do |public_file|
+        next if public_file.directory?
+
+        out_filename = out.join(Pathname.new(public_file).relative_path_from(@dir))
+        out_filename.dirname.mkdir unless out_filename.dirname.exist?
+        out_filename.write(File.read(public_file))
+      end
+    end
+
+  end
+
+
+  module EngineMethods
+
+    def build(*)
+      super
+
+      base = @config.static_files_dir || 'public'
+      copier = Copier.new(@path.join(base))
+      copier.copy_to(@out_dir.join(base))
+    end
+
+  end
+
+
+  module Config
+
+    def self.included(base)
+      base.class_eval do
+        attr_accessor(:static_files_dir)
+      end
+    end
+
+  end
+
+end

data/lib/flora/version.rb

@@ -1,3 +1,3 @@
-module Flora
-  VERSION = "0.1.2"
+class Flora
+  VERSION = "0.4.0"
 end

data/lib/flora.rb

@@ -5,5 +5,17 @@ require 'kramdown'
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 loader.setup
 
-module Flora
+class Flora
+
+  def initialize(dir)
+    # A new class so plugins only affect one instance.
+    @engine = Class.new(Engine).new(dir)
+    @engine.configure
+  end
+
+
+  def build(out)
+    @engine.build(out)
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flora
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Nick Vladimiroff
@@ -113,11 +113,12 @@ files:
 - lib/flora/engine/page/html.rb
 - lib/flora/engine/page/layout.rb
 - lib/flora/engine/page/markdown_page.rb
-- lib/flora/engine/page/plugin_hooks.rb
 - lib/flora/engine/page/ruby_page.rb
+- lib/flora/plugins/blog.rb
+- lib/flora/plugins/blog/post.rb
+- lib/flora/plugins/redirector.rb
+- lib/flora/plugins/static_files.rb
 - lib/flora/version.rb
-- lib/flora_blog.rb
-- lib/flora_blog/post.rb
 - tmp/.keep
 homepage: https://code.kat5.dev/nick/flora
 licenses:

data/lib/flora/engine/page/plugin_hooks.rb

@@ -1,10 +0,0 @@
-module Flora::Engine::Page::PluginHooks
-
-  def before_render
-  end
-
-
-  def after_render(html)
-  end
-
-end

data/lib/flora_blog.rb

@@ -1,13 +0,0 @@
-module FloraBlog
-
-  module RubyPage
-
-    def render
-      @posts = @root.glob('posts/**').map { Post.new(it) }
-
-      super
-    end
-
-  end
-
-end