flora 0.12.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a11f85e869328faff7d9244556f4b6c27ea30460c1ecbb9a691737d10f24daaa
-  data.tar.gz: 7a43d4c8821ce2e8d6899cdae404bb47a1db66c54032ac5cbc123e18cee394af
+  metadata.gz: ffea457870b0ae28e03a55fe032421257ea9eceb19ff282727c01b888a24c05b
+  data.tar.gz: 91d44f3cefd76ee01cbc834163d075564bf5ea9df5adb1487d143e089868d07a
 SHA512:
-  metadata.gz: fc3287be925560cb0ee03df33c04d8cb2de6a811345dc75385359afa94236a5500cac5c5a969b50bfb66b44117d4266e986fd86f624d84e38a83c995ffa503f0
-  data.tar.gz: 4eae0b7459aad9100e813ab916be76ef9c7c0aac7d814ac9524e358a98a06a6fb83f4e869f1bfccca426c2af3c3376cc405d93e3a8fe55950054b5f3a2992dd2
+  metadata.gz: b2fb5f500e39eb1f4f143445bc460a0a501a1bfca8459c8eb0d50ddaee3d66882c731fb823ffc4b3dc2717b5186df6be9d42810cb0d0293497434f06d171c9ec
+  data.tar.gz: bf5d0b9c5d00e2bff223d3aec48b1225e397adea87eac7a780903a1d337e275efefe09a15323508f28c83b19adc6a303b4a6d504adac62663b5067e1b7f5b43c

data/.document

@@ -0,0 +1,2 @@
+lib
+*.md

data/.woodpecker.yml

@@ -0,0 +1,16 @@
+when:
+  - event: push
+  - event: pull_request
+
+matrix:
+  RUBY_VERSION:
+    - 4.0
+    - 3.4
+
+steps:
+    - name: build
+      image: ruby:${RUBY_VERSION}-alpine
+      commands:
+        - apk add alpine-sdk yaml-dev
+        - bundle install
+        - rake

data/lib/flora/config.rb

@@ -1,27 +1,31 @@
 # This is the user-visible configuration class. It lives in ROOT/_config.rb.
 class Flora::Config
 
-  def initialize(file, flora)
+  def initialize(file, plugin_manager)
     @file = file
-    @flora = flora
-    load if @file.exist?
+    @plugin_manager = plugin_manager
   end
 
 
   def use(mod)
-    @flora.load_plugin(mod)
+    @plugin_manager.load(mod)
+
+    # TODO: ideally, this would live in PluginManager, but it needs to pass
+    # Config.
+    mod.loaded(self) if mod.respond_to?(:loaded)
   end
 
 
   def extend_view(mod)
-    Kernel.include(mod)
+    @plugin_manager.global_load(mod)
   end
 
 
-  private
+  # :nodoc:
+  def load
+    return unless @file.exist?
 
-    def load
-      instance_eval(@file.read)
-    end
+    instance_eval(@file.read)
+  end
 
 end

data/lib/flora/factory.rb

@@ -14,10 +14,10 @@ class Flora::Factory
 
     @project.blueprints.each do |blueprint|
       out_filename = out_dir.join(blueprint.page_name)
+      @logger.debug("[Flora] #{blueprint.file} => #{out_filename}")
+
       FileUtils.mkdir_p(out_filename.dirname) unless out_filename.dirname.exist?
       out_filename.write(blueprint.render)
-
-      @logger.debug("[Flora] #{blueprint.file} => #{out_filename}")
     end
   end
 

data/lib/flora/lilac.rb

@@ -87,4 +87,13 @@ module Flora::Lilac
     node
   end
 
+
+  def text(string = nil, &block)
+    string ||= block.call if block_given?
+
+    node = { tag: 'text', opts: {}, text: string, children: [] }
+    $flora_added << node
+    node
+  end
+
 end

data/lib/flora/plugin_manager.rb

@@ -0,0 +1,28 @@
+class Flora::PluginManager
+
+  def initialize(logger)
+    @logger = logger
+    @pluggables = {}
+  end
+
+
+  def create_pluggable_class(klass)
+    @pluggables[klass] = Class.new(klass)
+  end
+
+
+  def load(mod)
+    @pluggables.each do |base_class, anon_class|
+      name = "#{base_class.name.split('::').last}Methods"
+      anon_class.include(mod.const_get(name)) if mod.const_defined?(name)
+    end
+
+    @logger.debug("[Flora] Plugin #{mod} loaded")
+  end
+
+
+  def global_load(mod)
+    Kernel.include(mod)
+  end
+
+end

data/lib/flora/plugins/blog.rb

@@ -68,7 +68,6 @@ module Flora::Plugins::Blog
       end
 
 
-
       # Nokogiri's builder uses method_missing, and some of Lilac's tags are
       # named the same as some of the Atom tags we want to use which causes
       # conflicts. Use this method to get around that!
@@ -81,17 +80,15 @@ module Flora::Plugins::Blog
 
   module ProjectMethods
 
-    def posts
-      @dir.glob('posts/**.md').map { Post.new(it, @dir) }.sort_by(&:date).reverse
+    def self.included(base)
+      base.class_eval do
+        blueprint_classes.prepend(Flora::Plugins::Blog::BlogPost)
+      end
     end
 
-  end
-
-
-  module BlueprintMethods
 
     def posts
-      @project.posts
+      @dir.glob('posts/**.md').map { Post.new(it, @dir) }.sort_by(&:date).reverse
     end
 
   end
@@ -109,7 +106,7 @@ module Flora::Plugins::Blog
   end
 
 
-  module Config
+  module ConfigMethods
 
     def self.included(base)
       base.class_eval do
@@ -119,4 +116,18 @@ module Flora::Plugins::Blog
 
   end
 
+
+  module ViewExtensions
+
+    def posts
+      @project.posts
+    end
+
+  end
+
+
+  def self.loaded(config)
+    config.extend_view(ViewExtensions)
+  end
+
 end

data/lib/flora/plugins/redirector.rb

@@ -26,7 +26,7 @@ module Flora::Plugins::Redirector
   end
 
 
-  module Config
+  module ConfigMethods
 
     def self.included(base)
       base.class_eval do

data/lib/flora/plugins/static_files.rb

@@ -19,7 +19,18 @@ module Flora::Plugins::StaticFiles
   end
 
 
-  module Config
+  module ProjectMethods
+
+    def self.included(base)
+      base.class_eval do
+        blueprint_classes.prepend(Flora::Plugins::StaticFiles::StaticFile)
+      end
+    end
+
+  end
+
+
+  module ConfigMethods
 
     def self.included(base)
       base.class_eval do

data/lib/flora/project/blueprint/has_layout.rb

@@ -0,0 +1,54 @@
+# A Blueprint that includes HasLayout is something that can be nested into a
+# Lilac-based layout.
+module Flora::Project::Blueprint::HasLayout
+
+  def render
+    # The Html DSL uses a global variable internally that needs to be reset every time.
+    $flora_added = []
+
+    layouts = find_layouts
+    tree = render_internal(layouts, layouts.size) do
+      render_lilac
+    end
+
+    Flora::Lilac.to_html(tree)
+  end
+
+
+  private
+
+    def find_layouts
+      layouts = []
+      current = @file.parent
+
+      loop do
+        maybe_layout = current.join('./_layout.rb')
+        layouts << maybe_layout if maybe_layout.exist?
+
+        break if current == @project.dir
+        current = current.parent
+      end
+
+      layouts
+    end
+
+
+    def render_internal(layouts, i, &block)
+      if i <= 0
+        return block.call
+      end
+
+      cont = -> { render_internal(layouts, i-1, &block) }
+      filename = layouts[i-1].to_s
+      eval_with_block(layouts[i-1].read, filename, &cont)
+    end
+
+
+    # This exists because the eval'd code will call yield, and yield will always
+    # grab the current block passed into the current function. We need that to be
+    # a specific proc, not the one passed into render_internal!
+    def eval_with_block(str, filename, &block)
+      eval(str, binding, filename)
+    end
+
+end

data/lib/flora/project/blueprint/markdown.rb

@@ -1,6 +1,6 @@
 class Flora::Project::Blueprint::Markdown < Flora::Project::Blueprint
 
-  include Flora::Project::Blueprint::Nestable
+  include Flora::Project::Blueprint::HasLayout
 
 
   def self.recognize(file, config)

data/lib/flora/project/blueprint/ruby_html.rb

@@ -1,6 +1,6 @@
 class Flora::Project::Blueprint::RubyHtml < Flora::Project::Blueprint
 
-  include Flora::Project::Blueprint::Nestable
+  include Flora::Project::Blueprint::HasLayout
 
 
   def self.recognize(file, config)
@@ -11,7 +11,7 @@ class Flora::Project::Blueprint::RubyHtml < Flora::Project::Blueprint
   private
 
     def render_lilac
-      instance_eval(@file.read)
+      instance_eval(@file.read, @file.to_s)
     end
 
 end

data/lib/flora/project/blueprint.rb

@@ -1,17 +1,11 @@
-# A Blueprint is something can be rendered into a File. Sometimes a Blueprint
-# looks very different than the File it renders into, but other times (like for
+# A Blueprint is something can be rendered into a page. Sometimes a Blueprint
+# looks very different than the page it renders into, but other times (like for
 # static files), nothing changes.
 class Flora::Project::Blueprint
 
   attr_reader(:file)
 
 
-  # :nodoc:
-  def self.types
-    ObjectSpace.each_object(Class).select { it < self }
-  end
-
-
   # Returns true if this Blueprint is appropriate for the file.
   #
   # TODO: should this be an instance method somewhere instead?
@@ -28,15 +22,15 @@ class Flora::Project::Blueprint
   end
 
 
-  # The name of the Page this Blueprint makes. By default this is just the
+  # The name of the page this Blueprint makes. By default this is just the
   # filename, but .html, but subclasses can override this.
   def page_name
     @file.relative_path_from(@project.dir).sub_ext('.html').to_s
   end
 
 
-  # Render a Blueprint into a Page for a Website. This is the String contents
-  # of whatever the Page in the final Website looks like.
+  # Render a Blueprint into a page for a Website. This is the String contents
+  # of whatever the page in the final Website looks like.
   def render
     # Override in subclasses!
   end

data/lib/flora/project.rb

@@ -9,6 +9,10 @@ class Flora::Project
 
   IGNORES = ['.git/*', 'lib/**', '**_*.rb']
 
+  def self.blueprint_classes
+    @blueprint_classes ||= [Blueprint::Markdown, Blueprint::RubyHtml]
+  end
+
 
   def initialize(dir, loader, config)
     @dir = dir
@@ -38,7 +42,7 @@ class Flora::Project
         next if IGNORES.any? { file.fnmatch((@dir / it).to_s) }
         next if file.directory?
 
-        klass = Blueprint.types.find {
+        klass = self.class.blueprint_classes.find {
           it.recognize(file.relative_path_from(@dir), @config)
         }
 

data/lib/flora/version.rb

@@ -1,3 +1,3 @@
 class Flora
-  VERSION = '0.12.0'
+  VERSION = '1.0.1'
 end

data/lib/flora.rb

@@ -5,6 +5,7 @@ require 'fileutils'
 require 'logger'
 
 loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.do_not_eager_load("#{__dir__}/flora/plugins")
 loader.setup
 
 class Flora
@@ -16,19 +17,20 @@ class Flora
     dir = Pathname.new(dir)
 
     @logger = Logger.new(STDOUT, level: ENV['FLORA_LOG'] || 'info')
+    @plugin_manager = PluginManager.new(@logger)
 
     # Inject Lilac into the Kernel so it's available everywhere. Just
     # instance_eval isn't enough because it'll be missing in lib/ code.
     #
     # TODO: is there a less disruptive way to do this?
-    Kernel.include(Flora::Lilac)
+    @plugin_manager.global_load(Flora::Lilac)
 
     # The classes that are pluggable get their own instances to avoid conflicting
     # with other instances of Flora in the same process. This is mostly for the
     # unit tests. Maybe one day we can use Ruby::Box or something here instead.
-    @config_class = Class.new(Config)
-    @project_class = Class.new(Project)
-    @factory_class = Class.new(Factory)
+    @config_class = @plugin_manager.create_pluggable_class(Config)
+    @project_class = @plugin_manager.create_pluggable_class(Project)
+    @factory_class = @plugin_manager.create_pluggable_class(Factory)
 
     # This has to be loaded before Config so Config can reference lib/ code.
     @project_loader = Zeitwerk::Loader.new
@@ -38,7 +40,9 @@ class Flora
     @project_loader.enable_reloading
     @project_loader.setup
 
-    @config = @config_class.new(dir.join('_config.rb'), self)
+    @config = @config_class.new(dir.join('_config.rb'), @plugin_manager)
+    @config.load
+
     @project = @project_class.new(dir, @project_loader, @config)
     @factory = @factory_class.new(@project, @config, @logger)
   end
@@ -60,17 +64,6 @@ class Flora
   end
 
 
-  # TODO: it would be nice if this wasn't exposed here. It's just for Config#plugin.
-  def load_plugin(mod)
-    @config_class.include(mod::Config) if defined?(mod::Config)
-    @project_class.include(mod::ProjectMethods) if defined?(mod::ProjectMethods)
-    @factory_class.include(mod::FactoryMethods) if defined?(mod::FactoryMethods)
-
-    # TODO: make this a little more resilient (like the other classes).
-    Flora::Project::Blueprint.include(mod::BlueprintMethods) if defined?(mod::BlueprintMethods)
-  end
-
-
   private
 
     def bench
@@ -80,8 +73,3 @@ class Flora
     end
 
 end
-
-# Built-in Blueprints need to be explicitly loaded or else they won't show up
-# in Blueprint.types.
-loader.load_file("#{__dir__}/flora/project/blueprint/ruby_html.rb")
-loader.load_file("#{__dir__}/flora/project/blueprint/markdown.rb")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flora
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nick Vladimiroff
@@ -142,6 +142,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".document"
+- ".woodpecker.yml"
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -152,14 +154,15 @@ files:
 - lib/flora/config.rb
 - lib/flora/factory.rb
 - lib/flora/lilac.rb
+- lib/flora/plugin_manager.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/project.rb
 - lib/flora/project/blueprint.rb
+- lib/flora/project/blueprint/has_layout.rb
 - lib/flora/project/blueprint/markdown.rb
-- lib/flora/project/blueprint/nestable.rb
 - lib/flora/project/blueprint/ruby_html.rb
 - lib/flora/version.rb
 - tmp/.keep
@@ -176,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.0
+      version: 3.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/flora/project/blueprint/nestable.rb

@@ -1,51 +0,0 @@
-# A Blueprint that includes Nestable is something that can be nested into a
-# Lilac-based layout.
-module Flora::Project::Blueprint::Nestable
-
-  def render
-    # The Html DSL uses a global variable internally that needs to be reset every time.
-    $flora_added = []
-
-    layouts = find_layouts
-    tree = render_internal(layouts, layouts.size) do
-      render_lilac
-    end
-
-    Flora::Lilac.to_html(tree)
-  end
-
-
-  private
-
-    def find_layouts
-      layouts = []
-
-      @file.ascend do |dir|
-        maybe_layout = dir.join('_layout.rb')
-        layouts << maybe_layout if maybe_layout.exist?
-      end
-
-      # Ascend doesn't go to the top level directory.
-      # TODO: Make this code less brittle.
-      maybe_layout = Pathname.new('./_layout.rb')
-      layouts << maybe_layout if maybe_layout.exist?
-
-      layouts
-    end
-
-
-    def render_internal(layouts, i, &block)
-      if i <= 0
-        return block.call
-      end
-
-      cont = -> { render_internal(layouts, i-1, &block) }
-      eval_with_block(layouts[i-1].read, &cont)
-    end
-
-
-    def eval_with_block(str, &block)
-      eval(str)
-    end
-
-end