RubyGems - noumenon - Versions diffs - 0.0.3 → 0.1.0 - Mend

noumenon 0.0.3 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (73) hide show

data/.gitignore +3 -0
data/.travis.yml +0 -4
data/.yardopts +5 -0
data/Gemfile +1 -3
data/README.md +57 -80
data/Rakefile +17 -6
data/bin/noumenon +6 -0
data/features/dynamic_template_rendering.feature +107 -0
data/features/generator/site_generator.feature +25 -0
data/features/mounted_applications.feature +30 -0
data/features/static_template_rendering.feature +43 -0
data/features/step_definitions/asset_steps.rb +7 -0
data/features/step_definitions/content_steps.rb +7 -0
data/features/step_definitions/generator_steps.rb +22 -0
data/features/step_definitions/request_steps.rb +31 -0
data/features/step_definitions/theme_steps.rb +19 -0
data/features/support/env.rb +38 -0
data/features/support/theme/theme.yml +5 -0
data/features/theme_assets.feature +22 -0
data/generators/repository/index.yml +3 -0
data/generators/site/Gemfile +3 -0
data/generators/site/config.ru +7 -0
data/generators/theme/assets/style.css +1 -0
data/generators/theme/layouts/default.nou.html +23 -0
data/generators/theme/templates/default.nou.html +12 -0
data/generators/theme/theme.yml +5 -0
data/lib/noumenon/cli.rb +27 -0
data/lib/noumenon/core.rb +70 -77
data/lib/noumenon/repository/file_system.rb +102 -0
data/lib/noumenon/repository.rb +39 -0
data/lib/noumenon/spec/example_app.rb +19 -6
data/lib/noumenon/spec/theme_helpers.rb +66 -0
data/lib/noumenon/spec.rb +4 -7
data/lib/noumenon/string_extensions.rb +21 -0
data/lib/noumenon/template.rb +113 -72
data/lib/noumenon/theme/assets_middleware.rb +21 -0
data/lib/noumenon/theme.rb +106 -0
data/lib/noumenon/version.rb +3 -1
data/lib/noumenon.rb +68 -100
data/noumenon.gemspec +13 -9
data/spec/noumenon/repository/file_system_spec.rb +115 -0
data/spec/noumenon/repository_spec.rb +40 -0
data/spec/noumenon/template_spec.rb +9 -7
data/spec/noumenon/theme_spec.rb +129 -0
data/spec/noumenon_spec.rb +24 -80
data/spec/spec_helper.rb +5 -14
data/spec/support/file_matchers.rb +45 -0
data/spec/support/templates/basic_template.html +1 -0
data/spec/{fixtures/themes/example_without_layout → support}/templates/template_with_fields.html +1 -1
metadata +143 -62
data/lib/noumenon/configuration.rb +0 -28
data/lib/noumenon/spec/fixtures.rb +0 -34
data/spec/fixtures/fixture_specs/test +0 -1
data/spec/fixtures/missing_application/mounted_app/config.yml +0 -1
data/spec/fixtures/static_example/directory_with_index/index.yml +0 -1
data/spec/fixtures/static_example/found.html +0 -1
data/spec/fixtures/static_example/liquid_example.html +0 -1
data/spec/fixtures/static_example/mounted_app/config.yml +0 -1
data/spec/fixtures/static_example/template_with_substitutions.html +0 -1
data/spec/fixtures/static_example/templates/basic_example.yml +0 -1
data/spec/fixtures/static_example/templates/with_fields.yml +0 -2
data/spec/fixtures/themes/example/assets/example.txt +0 -1
data/spec/fixtures/themes/example/templates/layout.html +0 -3
data/spec/fixtures/themes/example_without_layout/templates/basic_template.html +0 -1
data/spec/fixtures/themes/example_without_layout/templates/fields.html +0 -1
data/spec/fixtures/themes/external_theme/assets/example.txt +0 -1
data/spec/fixtures/themes/unregistered/lib/unregistered.rb +0 -1
data/spec/noumenon/config_spec.rb +0 -29
data/spec/noumenon/core_spec.rb +0 -105
data/spec/noumenon/spec/example_app_spec.rb +0 -14
data/spec/noumenon/spec/fixtures_spec.rb +0 -41
data/spec/noumenon/spec_spec.rb +0 -7
data/watchr.rb +0 -2

data/generators/theme/layouts/default.nou.html ADDED Viewed

@@ -0,0 +1,23 @@
+title:
+  type: string
+  description: The title to put in the browser's title bar.
+  required: false
+content:
+  type: string
+  description: The content from the page template.
+  required: true
+---
+<!doctype html>
+<html>
+  <head>
+    <title>{{ title }}</title>
+    <link rel="stylesheet" href="/themes/Your%20Theme/styles.css" />
+  </head>
+  <body>
+    <section id="content">
+      {{ content }}
+    </section>
+  </body>
+</html>

data/generators/theme/templates/default.nou.html ADDED Viewed

@@ -0,0 +1,12 @@
+title:
+  description: The title of the content block
+  required: true
+  type: string
+body:
+  description: The main content
+  required: true
+  type: text
+---
+<h1>{{ title }}</h1>
+<p>{{ body }}</p>

data/generators/theme/theme.yml ADDED Viewed

@@ -0,0 +1,5 @@
+name: "Generated Theme"
+author: "Your Name"
+email: "you@example.org"
+copyright: "2011, Your Name"
+license: "MIT"

data/lib/noumenon/cli.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'thor'
+class Noumenon::Cli < Thor
+  include Thor::Actions
+  source_root File.expand_path("../../../generators", __FILE__)
+  desc "site PATH", "Generate a new site at PATH"
+  def site(path)
+    say_status :site, path
+    directory "site", path
+    invoke :theme, [ File.join(path, "theme") ]
+    invoke :repository, [ File.join(path, "content") ]
+  end
+  desc "theme PATH", "Generate a new theme at PATH"
+  def theme(path)
+    say_status :theme, path
+    directory "theme", path
+  end
+  desc "repository PATH", "Generate a new content repository at PATH"
+  def repository(path)
+    say_status :repository, path
+    directory "repository", path
+  end
+end

data/lib/noumenon/core.rb CHANGED Viewed

@@ -1,93 +1,86 @@
+require 'noumenon'
 require 'sinatra'
-require 'liquid'
-require 'yaml'
-# :nodoc:
-module Noumenon
-  # The base of all Noumenon sites, responsible for building the URL structure, and providing
-  # access to the content repository.
+# The core Noumenon web application, responsible for loading content from the repository,
+# and then either rendering it with the appropriate template, or passing it to the specified
+# application.
+#
+# @api public
+class Noumenon::Core < Sinatra::Base
+  # Renders a content item within it's template and layout.
   #
-  # By default any request will be routed to the content repository to find an item of content
-  # using #locate_content, which will then be rendered using the template specified by the content
-  # file.
+  # If the template or layout is not specified then it will be set to "default".
   #
-  # A piece of content takes the form of a YAML file, which should provide any fields required by
-  # template specified. If any required fields are missing then a MissingContentError will be raised.
-  #
-  class Core < Sinatra::Base
-    def config
-      Noumenon.config
-    end
-    # Get the path to a file in the content repository.
-    def content_path(path)
-      File.join(config.content_repository_path, path)
-    end
-    # Get the path to a file provided by the current theme.
-    def theme_path(path)
-      File.join(Noumenon.themes[config.theme][:path], path)
+  # @param [ Hash ] page The content item to render.
+  # @option page [ String ] :template The template to use when rendering the item.
+  # @option page [ String ] :layout The layout to put the template within.
+  # @return [ String ] The rendered page, or an error message if any templates could not be rendered.
+  # @api public
+  def render_page(page)
+    page[:template] ||= "default"
+    page[:layout] ||= "default"
+    begin
+      template = Noumenon.theme.template("#{page[:template]}.nou.html")
+      content = template.render(page)
+      wrap_with_layout(content, page)
+    rescue Noumenon::Template::NotFoundError => e
+      halt 500, "<h1>Missing Template</h1><p>The template '#{page[:template]}' does not exist within the current theme.</p>"
+    rescue Noumenon::Template::MissingContentError => e
+      halt 500, "<h1>Missing Fields</h1><p>#{e}</p>"
     end
+  end
+  # Convenience method to access the current content repository.
+  #
+  # @api public
+  # @return [ Noumenon::Repository ] the current content repository
+  def content
+    Noumenon.content_repository
+  end
+  get "*" do |path|
+    page = content.get(path)
-    # Render a template, surrounding it with the theme layout if a theme has been set, and
-    # it provides a layout.
-    #
-    # Any locals provided will be passed onto Liquid for use in the template.
-    #
-    # Valid options:
-    #
-    #   layout: If set to a string, an attempt will be made to use that layout.
-    #           If set to false no layout will be used.
-    #           If set to true (the default) the default layout will be used.
-    def render_template(path, locals = {}, options = {})
-      options[:layout] = "layout" if options[:layout] == true || options[:layout].nil?
-      template = Template.from_file(path)
-      body = template.render(locals)
-      if options[:layout]
-        begin
-          body = render_template(theme_path("templates/#{options[:layout]}.html"), { 'body' => body }, :layout => false)
-        rescue Noumenon::Template::NotFoundError => ignore_missing_layouts
-        end
+    unless page
+      # Search up the tree until we either hit the top, and 404, or find a mounted application.
+      path = path.split("/")
+      while path.size > 0
+        path.pop
+        page = content.get(path.join("/"))
+        break if page && page[:type] == "application"
       end
-      body
+      halt 404, "<h1>Page Not Found</h1>" unless page
+      path = path.join("/")
     end
-    # Render a piece of content from the content repository, using the template specified within
-    # the content item.
-    #
-    # If no template was specified then the template "default" will be used.
-    def render_content(path)
-      content = File.read(content_path(path))
-      item = YAML.load( content )
+    case page[:type]
+    when "application"
+      app = page[:application].constantize
-      [ 200, render_template( theme_path("templates/#{item["template"]}.html"), item ) ]
+      # Rewrite PATH_INFO so that the child application can listen to URLs assuming it's at the root.
+      env["PATH_INFO"].gsub!("#{path}", "")
+      env["PATH_INFO"] = "/" if env["PATH_INFO"] == ""
+      app.new(page).call(env)
+    else
+      render_page(page)
     end
-    # Locate a piece of content in the content repository based on the URL it is being accessed from.
-    #
-    # The following files will satisfy a request for "/example", in the order shown:
-    #
-    # 1. "repository/example.yml
-    # 2. "repository/example/index.yml
-    #
-    def locate_content_for(path)
-      if File.exists?(content_path("#{path}.yml"))
-        return "#{path}.yml"
-      else
-        if File.exists?(content_path(path)) && File.exists?(content_path("#{path}/index.yml"))
-          return "#{path}/index.yml"
+  end
+  private
+    def wrap_with_layout(content, page)
+      begin
+        layout = Noumenon.theme.layout("#{page[:layout]}.nou.html")
+        return layout.render( page.merge(content: content) )
+      rescue Noumenon::Template::NotFoundError => e
+        if page[:layout] == "default"
+          return content
+        else
+          halt 500, "<h1>Missing Layout</h1><p>The layout '#{page[:layout]}' does not exist within the current theme.</p>"
         end
       end
-      nil
     end
-    get '*' do |path|
-      path = locate_content_for(path)
-      path ? render_content(path) : [ 404, "Not Found" ]
-    end
-  end
 end

data/lib/noumenon/repository/file_system.rb ADDED Viewed

@@ -0,0 +1,102 @@
+require 'noumenon/repository'
+require 'yaml'
+require 'fileutils'
+# A content repository which uses YAML files within the filesystem for storage.
+#
+# @example The structure of a filesystem repository
+#   index.yml
+#   |- about
+#      |- index.yml
+#      |- team.yml
+#      |- company.yml
+#   contact.yml
+#
+# @example A piece of content
+#   template: team_member
+#   name: Jon Wood
+#   position: Head Honcho of Awesomeness
+#   bio: Jon's just awesome, we'll leave it at that.
+#
+# @api public
+class Noumenon::Repository::FileSystem < Noumenon::Repository
+  # @param [ Hash ] options A hash of options.
+  # @option options [ String ] :path The path to access the repository at.
+  # @api public
+  def initialize(options = {})
+    unless options.key? :path
+      raise ArgumentError.new("You must provide a path to the content repository: Noumenon::Repository::FileSystem.new(path: '/tmp')")
+    end
+    super options
+  end
+  # Loads a piece of content from the repository.
+  #
+  # @param [ String ] path The path to load from.
+  # @param [ Boolean ] check_for_index Whether sub-directories of the same name should be checked for an index.yml file
+  # @return [ Hash, #each, nil ] The piece of content, or nil if it could not be found.
+  # @api public
+  def get(path, check_for_index = true)
+    file = repository_path("#{path}.yml")
+    if File.exist?(file)
+      YAML.load(File.read(file)).symbolize_keys
+    elsif check_for_index
+      return get("#{path}/index", false)
+    end
+  end
+  # Saves a piece of content to the repsitory.
+  #
+  # @see Noumenon::Repository#put
+  def put(path, content = {})
+    create_tree(path)
+    path = File.join(path, "index") if File.exist?(repository_path(path))
+    File.open(repository_path("#{path}.yml"), "w") { |f| f.print content.symbolize_keys.to_yaml }
+  end
+  private
+  # Return the on-disk path to a repository item.
+  def repository_path(path)
+    File.join(options[:path], path)
+  end
+  # Creates any neccesary directories, and moves files that conflict with newly created
+  # directories to index.yml
+  def create_tree(path)
+    path_on_disk = File.dirname(repository_path(path))
+    unless File.exists?(path_on_disk)
+      FileUtils.mkdir_p(path_on_disk)
+      create_indexes(path)
+    end
+  end
+  # Moves conflicting YAML files into directory/index.yml
+  #
+  # For example given
+  #
+  #   /foo
+  #   /foo.yml
+  #
+  # /foo.yml will be moved to /foo/index.yml
+  def create_indexes(path)
+    sub_path = options[:path]
+    path.split("/").each do |directory|
+      move_to_index File.join(sub_path, directory)
+      sub_path = File.join(sub_path, directory)
+    end
+  end
+  def move_to_index(path)
+    path_on_disk = path
+    yaml_file = "#{path_on_disk}.yml"
+    if File.exist? yaml_file
+      FileUtils.mv yaml_file, File.join("#{path_on_disk}/index.yml")
+    end
+  end
+end

data/lib/noumenon/repository.rb ADDED Viewed

@@ -0,0 +1,39 @@
+require 'noumenon'
+# The base class for content repositories. This class is predominantly present just to document the
+# expected API for a repository.
+#
+# @api public
+class Noumenon::Repository
+  autoload :FileSystem, 'noumenon/repository/file_system'
+  # Provides access to options set on initialization.
+  # @api public
+  attr_reader :options
+  # Create a new Repository instance.
+  #
+  # @param [ Hash, #each ] options A hash of options to use when configuring the repository.
+  # @api public
+  def initialize(options = {})
+    @options = options
+  end
+  # Save an item in the repository. If an item already exists then it should be overwritten.
+  #
+  # @param [ #to_s ] path The path the save the content at.
+  # @param [ Hash, #each ] content A hash of key/value pairs to use as the content.
+  # @api public
+  def put(path, content)
+    raise NotImplementedError.new("This repository type does not support updating it's contents.")
+  end
+  # Load an item from the repository. If the item does not exist then `nil` should be returned.
+  #
+  # @param [ #to_s ] path The path to laod content from
+  # @return [ Hash, #each, nil ] Either the hash stored at the specified path, or nil if no content was found.
+  # @api public
+  def get(path)
+    raise NotImplementedError.new("This repository type does not support reading it's contents.")
+  end
+end

data/lib/noumenon/spec/example_app.rb CHANGED Viewed

@@ -1,9 +1,22 @@
-module Noumenon
-  module Spec
-    class ExampleApp < Noumenon::Core
-      get '/' do
-        [ 200, "This was served by Noumenon::Spec::ExampleApp" ]
-      end
+require 'noumenon'
+class Noumenon::Spec::ExampleApp
+  def initialize(options = {})
+    @options = { message: "This is a mounted application" }.merge(options.symbolize_keys)
+  end
+  def call(env)
+    case env["PATH_INFO"]
+      when "/"
+        respond 200, "<h1>#{@options[:message]}</h1>"
+      when "/sub"
+        respond 200, "<h1>This is a sub-page</h1>"
+      else
+        respond 404, "Page Not Found"
     end
   end
+  def respond(status, content)
+    [ status, { "Content-Type" => "text/html" }, StringIO.new(content) ]
+  end
 end

data/lib/noumenon/spec/theme_helpers.rb ADDED Viewed

@@ -0,0 +1,66 @@
+require 'fileutils'
+module Noumenon
+  module Spec
+    # Methods which can be used in RSpec based tests to create and use themes that will be recreated on
+    # each test run.
+    #
+    # @api public
+    module ThemeHelpers
+      # The path to the current theme.
+      # @return [ String ]
+      # @api public
+      def theme_path
+        File.join(File.dirname(__FILE__), "..", "tmp", "example_theme")
+      end
+      # Create a new theme directory at #theme_path.
+      #
+      # @param [ Hash, nil ] description Either the description to write to theme.yml, or nil to prevent
+      #                                  creation of the theme.yml file.
+      # @return [ Noumenon::Theme, nil ] If a description was provided the theme will be loaded, otherwise
+      #                                  nil will be returned.
+      def create_theme(description = {})
+        FileUtils.mkdir_p theme_path
+        FileUtils.mkdir_p File.join(theme_path, "templates")
+        FileUtils.mkdir_p File.join(theme_path, "layouts")
+        FileUtils.mkdir_p File.join(theme_path, "assets")
+        if description
+          File.open(File.join(theme_path, "theme.yml"), "w") do |f|
+            f.print description.to_yaml
+          end
+          return Noumenon::Theme.load(theme_path)
+        end
+      end
+      # Creates a theme with the provided description, runs the block, and then deletes the theme again.
+      #
+      # Useful in RSpec around blocks:
+      #
+      # @example Using with RSpec
+      #   describe "theme stuff" do
+      #     include Noumenon::Spec::ThemeHelpers
+      #
+      #     around do |ex|
+      #       with_temporary_theme(name: "My Theme") do
+      #         ex.run
+      #       end
+      #     end
+      #
+      #     it "should have the right name" do
+      #       theme = Noumenon::Theme.load(theme_path)
+      #       theme.name.should == "My Theme"
+      #     end
+      #   end
+      def with_temporary_theme(description = {})
+        create_theme(description)
+        yield
+        FileUtils.rm_r theme_path
+      end
+    end
+  end
+end

data/lib/noumenon/spec.rb CHANGED Viewed

@@ -1,9 +1,6 @@
-require 'noumenon/spec/fixtures'
-require 'noumenon/spec/example_app'
+require 'noumenon'
-module Noumenon
-  # Spec helpers used while testing Noumenon, and Noumenon applications.
-  module Spec
-    include Noumenon::Spec::Fixtures
-  end
+module Noumenon::Spec
+  autoload :ExampleApp, 'noumenon/spec/example_app'
+  autoload :ThemeHelpers, 'noumenon/spec/theme_helpers'
 end

data/lib/noumenon/string_extensions.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# Adds some additional methods to String objects.
+#
+# @api public
+module Noumenon::StringExtensions
+  # Attempts to convert a string into a constant.
+  #
+  # If the constant could not be found then a NameError will be raised.
+  #
+  # @example
+  #   "Foo::Bar".constantize # => Foo::Bar
+  def constantize
+    mod = Module
+    split("::").each do |mod_name|
+      mod = mod.const_get(mod_name.to_sym)
+    end
+    mod
+  end
+end
+String.class_eval { include Noumenon::StringExtensions }