brief 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1051f1c7f8b82c1325913b4a8daa9e113404de69
-  data.tar.gz: cbb53d874b7f6b24d8d16164590f489d74f31fc5
+  metadata.gz: 79796113d0d8f8f21e6d5143efa8a8da8faa46f8
+  data.tar.gz: 9a788247f96dc6386db346f203acc6a6f227d207
 SHA512:
-  metadata.gz: c7885b7fef9d6705d66a930b0e4e522bac85c53afc11560b5b4dcceb7026551c0ee1c5f585d58a0d777a230b2fde11b2062915f0412f27e8ba221781c9d0bbbf
-  data.tar.gz: a5f1c7ee952d2b8ba5ceb3d72b324ebea099025cf03df6f7ef9f7de539b7d3d34feb6141fdf95b97231756d0883ec0bd93e88f1bdd6339dd6bb067d481bbc4c4
+  metadata.gz: 01fd22902ed25d4660b8e1b72cd6045541895459f766ad71ee58990703f1a4de4e7075d81e9f883249fe6df0ee1a7e7a762edddfdb63d1aa40dbf588f35912df
+  data.tar.gz: ab24732776aa546dc91b46a1ff5d21ddbcd8081d311bf9733fd259b1e017db84c88a776c167b8507168ba091b399fe5895e9af5e7b79c6ee50fe6cd75c8419a1

data/CHANGELOG.md

@@ -117,3 +117,7 @@ attributes.
 - Brief::Server provides a REST interface to a briefcase
 - Brief::Server::Gateway provdies a REST wrapper around a folder of
   briefcases
+
+### 1.4.5
+  - Introducing a new DSL to define aggregator methods on the briefcase
+  - Aggregators have a REST interface

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.4.3)
+    brief (1.4.5)
       activemodel
       activesupport
       commander

data/lib/brief/briefcase.rb

@@ -14,6 +14,60 @@ module Brief
       if Brief.case.nil?
         Brief.case = self
       end
+
+      Brief.cases[root] ||= self
+    end
+
+    def present(style="default", params={})
+      if respond_to?("as_#{style}")
+        send("as_#{style}", params)
+      elsif Brief.views.key?(style.to_sym)
+        block = Brief.views[style.to_sym]
+        block.call(self, params)
+      end
+    end
+
+    def settings
+      @settings ||= settings!
+    end
+
+    def settings!
+      if root.join("settings.yml").exist?
+        y = YAML.load(root.join("settings.yml").read) rescue nil
+        (y || {}).to_mash
+      end
+    end
+
+    def as_default(params={})
+      params.symbolize_keys!
+
+      model_settings = {
+        docs_path: docs_path
+      }
+
+      model_settings[:rendered] = !!(params.key?(:rendered))
+      model_settings[:content] = !!(params.key?(:content))
+
+      all = all_models.compact
+
+      schema = all.map(&:class).uniq.compact
+                 .map(&:to_schema)
+                 .reduce({}) {|m, k| m[k[:type_alias]] = k; m }
+
+      models = all.map {|m| m.as_json(model_settings) }
+
+      {
+        views: Brief.views.keys,
+        key: briefcase.folder_name.to_s.parameterize,
+        name: briefcase.folder_name.to_s.titlecase,
+        schema: schema,
+        models: models,
+        settings: settings
+      }
+    end
+
+    def as_full_export
+      as_default(content: true, rendered: true)
     end
 
     def use(module_type=:app, module_id)
@@ -111,7 +165,10 @@ module Brief
     end
 
     def method_missing(meth, *args, &block)
-      if repository.respond_to?(meth)
+      if Brief.views.key?(meth.to_sym)
+        block = Brief.views[meth.to_sym]
+        block.call(self, args.extract_options!)
+      elsif repository.respond_to?(meth)
         repository.send(meth, *args, &block)
       else
         super

data/lib/brief/document/content_extractor.rb

@@ -11,16 +11,25 @@ module Brief
       Brief::Model.for_type(@model_type)
     end
 
-    def attribute_set
+    def content_schema_attributes
       model_class.definition.content_schema.attributes
     end
 
+    def extracted_content_data
+      me = self
+      content_schema_attributes.keys.reduce({}.to_mash) do |memo, attr|
+        val = me.send(attr) rescue nil
+        memo[attr] = val if val
+        memo
+      end
+    end
+
     def respond_to?(meth)
-      attribute_set.key?(meth) || super
+      content_schema_attributes.key?(meth) || super
     end
 
     def method_missing(meth, *_args, &_block)
-      if settings = attribute_set.fetch(meth, nil)
+      if settings = content_schema_attributes.fetch(meth, nil)
         if settings.args.length == 1 && settings.args.first.is_a?(String)
           selector = settings.args.first
           matches = document.css(selector)

data/lib/brief/document/rendering.rb

@@ -37,12 +37,14 @@ module Brief
       # attributes, and other things to the HTML so that the output HTML retains its
       # relationship to the underlying data and document structure.
       def to_html(options = {})
-        if options[:wrap] == false
+        html = if options[:wrap] == false
           unwrapped_html
         else
           wrapper = options.fetch(:wrapper, 'div')
           "<#{ wrapper } data-brief-model='#{ model_class.type_alias }' data-brief-path='#{ relative_path_identifier }'>#{ unwrapped_html }</#{wrapper}>"
         end
+
+        html.respond_to?(:html_safe) ? html.html_safe : html.to_s
       end
 
       def unwrapped_html

data/lib/brief/document/section/builder.rb

@@ -61,12 +61,14 @@ class Brief::Document::Section
         @cycles += 1
       end
 
-      self.nodes = source.map(&:last)
+      self.nodes = source.map(&:last).flatten
 
       nodes.each do |node|
         parent = node.css('section, article').first
-        if %w(h1 h2 h3 h4 h5 h6).include?(parent.children.first.name)
-          parent['data-heading'] = parent.children.first.text
+        parents_first_el = parent.children.first
+
+        if parents_first_el && %w(h1 h2 h3 h4 h5 h6).include?(parent.children.first.name)
+          parent['data-heading'] = parents_first_el.text
         end
       end
 

data/lib/brief/document/structure.rb

@@ -26,12 +26,24 @@ module Brief
       end
     end
 
+    # Markdown rendered HTML comes in the forms of a bunch of siblings,
+    # and no parents.  We need to introduce the concept of ownership of
+    # sections of the document, by using the heading level (h1 - h6) as
+    # a form of rank.
+    #
+    # All h1 elements will 'own' the h2,h3,h4,h5,h6
+    # elements underneath them.
     def create_wrappers
       return if @elements_have_been_wrapped
 
       elements      = fragment.children
 
+      # The different groups of elements
       mapping = []
+
+      # The current bucket of elements that is being
+      # collected, will get reset whenever it runs into
+      # an element that is a greater heading rank
       bucket = []
 
       current_level = Util.level(elements.first)
@@ -39,6 +51,8 @@ module Brief
       elements.each_cons(2) do |element, next_element|
         bucket << element
 
+        # We will have run into a greater header, so close up the bucket
+        # and put it into the mapping
         if Util.is_header?(next_element) && Util.level(next_element) >= current_level
           mapping.push([current_level, bucket])
           bucket = []
@@ -49,7 +63,10 @@ module Brief
         end
       end
 
-      mapping.push([current_level, bucket]) unless mapping.include?(bucket)
+      # we never ended up reaching a header, so close up and move on
+      if !mapping.include?(bucket)
+        mapping.push([current_level, bucket])
+      end
 
       base_fragment = Nokogiri::HTML.fragment("<div class='brief top level' />")
 

data/lib/brief/document.rb

@@ -6,6 +6,10 @@ module Brief
 
     attr_accessor :path, :content, :frontmatter, :raw_content
 
+    def document
+      self
+    end
+
     def initialize(path, options = {})
       if path.respond_to?(:key?) && options.empty?
         @frontmatter = path.to_mash
@@ -13,24 +17,55 @@ module Brief
         @path = Pathname(path)
       end
 
+      if options[:Test]
+        binding.pry
+      end
+
       @options = options.to_mash
 
       if @path && self.path.exist?
-        @raw_content = path.read
+        @raw_content = self.path.read
         load_frontmatter
       elsif options[:contents]
         @raw_content = options[:contents]
       end
 
+      register_model_instance if self.path && self.path.exist?
+    end
+
+    def register_model_instance
       model_class.try(:models).try(:<<, to_model) unless model_instance_registered?
     end
 
+    def raw= val
+      @raw_set = true
+      @raw_content = val
+      #document.load_frontmatter
+      @raw_content
+    end
+
+    def set_raw?
+      !!@raw_set
+    end
+
     def save
-      path.open('w') {|fh| fh.write(combined_data_and_content) }
+      if set_raw?
+        file_contents = raw_content
+      else
+        file_contents = combined_data_and_content
+      end
+
+      path.open('w') {|fh| fh.write(file_contents) }
     end
 
     def save!
-      path.open('w+') {|fh| fh.write(combined_data_and_content) }
+      if set_raw?
+        file_contents = raw_content
+      else
+        file_contents = combined_data_and_content
+      end
+
+      path.open('w+') {|fh| fh.write(file_contents) }
     end
 
     def combined_data_and_content
@@ -43,12 +78,12 @@ module Brief
     end
 
     def in_briefcase(briefcase)
-      @briefcase = briefcase
+      @briefcase_root = briefcase.root
       self
     end
 
     def briefcase
-      @briefcase || Brief.case
+      (@briefcase_root && Brief.cases[@briefcase_root]) || Brief.case
     end
 
     def sections
@@ -69,6 +104,9 @@ module Brief
     end
 
     def content
+      if @content.nil?
+        generate_content
+      end
       @content || generate_content
     end
 
@@ -114,7 +152,7 @@ module Brief
     end
 
     def to_model
-      model_class.new((data || {}).to_hash.merge(path: path, document: self)) if model_class
+      model_class.new((data || {}).to_hash.merge(path: path, document: self).reverse_merge(:type=>document_type)) if model_class
     end
 
     def exist?
@@ -172,6 +210,10 @@ module Brief
       @fragment ||= Nokogiri::HTML.fragment(to_raw_html)
     end
 
+    def type
+      document_type
+    end
+
     def method_missing(meth, *args, &block)
       if data.respond_to?(meth)
         data.send(meth, *args, &block)

data/lib/brief/dsl.rb

@@ -6,6 +6,10 @@ module Brief
       Brief::Configuration.instance.instance_eval(&block) if block_given?
     end
 
+    def view(name, &block)
+      Brief.views[name.to_sym] = block
+    end
+
     def define(*args, &block)
       options     = args.dup.extract_options!
       name        = args.first

data/lib/brief/model/serializers.rb

@@ -1,15 +1,10 @@
 module Brief::Model::Serializers
   def as_json(options={})
+    options.symbolize_keys!
+    docs_path = options.fetch(:docs_path) { briefcase.docs_path }
+    docs_path = docs_path.to_pathname if docs_path.is_a?(String)
 
-    if options[:docs_path]
-      if path.absolute?
-        doc_path = path.relative_path_from(options[:docs_path])
-      else
-        doc_path = path
-      end
-    else
-      doc_path = path.to_s
-    end
+    doc_path  = path.relative_path_from(docs_path).to_s
 
     # TEMP
     title = data.try(:[], :title) || extracted_content.try(:title) || (send(:title) rescue nil) || path.basename.to_s.gsub(/\.html.md/,'')
@@ -17,7 +12,8 @@ module Brief::Model::Serializers
 
     {
       data: data,
-      path: doc_path.to_s,
+      extracted: extracted_content_data,
+      path: path.to_s,
       type: type,
       title: title,
       actions: self.class.defined_actions,
@@ -30,6 +26,9 @@ module Brief::Model::Serializers
         schema_url: "/schema/#{ type }",
         actions_url: "/actions/:action/#{ doc_path }"
       }
-    }
+    }.tap do |h|
+      h[:content] = document.combined_data_and_content if options[:content]
+      h[:rendered] = document.to_html if options[:rendered]
+    end
   end
 end

data/lib/brief/model.rb

@@ -30,7 +30,7 @@ module Brief
 
     module AccessorMethods
       def data
-        document.data
+        document.data || {}.to_mash
       end
 
       def content
@@ -52,6 +52,10 @@ module Brief
           super
         end
       end
+
+      def exists?
+        document && document.path && document.path.exist?
+      end
     end
 
     def self.classes
@@ -72,6 +76,11 @@ module Brief
       table[type_alias]
     end
 
+    def self.existing_models_for_type(type_alias)
+      klass = for_type(type_alias)
+      klass.models.select(&:exists?)
+    end
+
     def self.for_folder_name(folder_name=nil)
       folder_name = folder_name.to_s.downcase
       table[folder_name.singularize] || table[folder_name]
@@ -99,6 +108,10 @@ module Brief
     end
 
     module ClassMethods
+      def purge
+        models.reject! {|model| !model.document.path.exist? }
+      end
+
       def to_schema
         {
           schema: {

data/lib/brief/repository.rb

@@ -72,6 +72,33 @@ module Brief
       Dir[root.join('**/*.md').to_s].map { |p| Pathname(p) }
     end
 
+    def all_models
+      list = documents.map(&:to_model)
+      list.compact!
+      list.select!(&:exists?)
+
+      list
+    end
+
+    def all_models_by_type
+      all_models.reduce({}) do |memo, model|
+        (memo[model.class.type_alias] ||= []) << model if model.exists?
+        memo
+      end
+    end
+
+    def purge(model_type=nil)
+      if model_type
+        plural = model_type.to_s.pluralize
+
+        if instance_variable_get("@#{ plural }")
+          instance_variable_set("@#{plural}",nil)
+        end
+      end
+
+      documents.reject! {|doc| !doc.path.exist? }
+    end
+
     def self.define_document_finder_methods
       # Create a finder method on the repository
       # which lets us find instances of models by their class name
@@ -83,7 +110,7 @@ module Brief
         end
 
         define_method("#{ plural }!") do
-          instance_variable_set("@#{plural}", Brief::Model.for_type(type).models.to_a)
+          instance_variable_set("@#{plural}", Brief::Model.existing_models_for_type(type))
           instance_variable_get("@#{ plural }")
         end
       end

data/lib/brief/server/gateway.rb

@@ -25,9 +25,15 @@ class Brief::Server::Gateway
 
   def call(env)
     request = Rack::Request.new(env)
-
-    if request.path.match(/__info$/)
-      return [200, {}, [@briefcases.keys.to_json]]
+    params  = request.params.symbolize_keys
+
+    if request.path.match(/\/all$/)
+      presenter = params.fetch(:presenter, 'default')
+      return [200, {}, [
+        @briefcases.values.map do |bc|
+          bc.present(presenter, params)
+        end.to_json
+      ]]
     end
 
     name    = request.path.match(/\/\w+\/(\w+)/)[1] rescue nil

data/lib/brief/server/handlers/aggregator.rb

@@ -0,0 +1,8 @@
+module Brief::Server::Handlers
+  class Aggregator
+    def self.handle(path, briefcase, options={})
+      [200, {"Content-Type"=>"application/json"}, briefcase.send(path)]
+    end
+  end
+end
+

data/lib/brief/server/handlers/browse.rb

@@ -1,6 +1,7 @@
 module Brief::Server::Handlers
   class Browse
     def self.handle(path_args, briefcase, options={})
+      briefcase.purge(path_args)
       models = Array((briefcase.send(path_args) rescue nil))
       [200, {"Content-Type"=>"application/json"}, models.map(&:as_json)]
     end

data/lib/brief/server/handlers/info.rb

@@ -2,19 +2,10 @@ module Brief::Server::Handlers
   class Info
     def self.handle(path, briefcase, options={})
       request = options.fetch(:request)
-      action = options.fetch(:action)
+      params  = request.params.symbolize_keys
+      style   = params.fetch(:presenter, "default")
 
-      schema = {}
-      models = {}
-
-      Brief::Model.classes.map do |k|
-        schema[k.type_alias] = k.to_schema
-
-        a = k.type_alias.to_s.pluralize
-        models[a] = briefcase.send(a).map {|m| m.as_json(docs_path: briefcase.docs_path) }
-      end
-
-      [200, {}, {name: briefcase.folder_name.to_s, schema: schema, models: models}]
+      [200, {}, briefcase.present(style, params)]
     end
   end
 end

data/lib/brief/server/handlers/modify.rb

@@ -48,7 +48,8 @@ module Brief::Server::Handlers
 
       def create
         data      = params[:data]
-        contents  = params[:contents]
+        contents  = params[:content] || params[:contents]
+        raw       = params[:raw]
 
         if path && path.exist?
           @errors[:path] = "Path already exists"
@@ -56,8 +57,15 @@ module Brief::Server::Handlers
         end
 
         doc = Brief::Document.new(path).tap do |document|
-          document.content = contents if contents.to_s.length > 0
-          document.data = data if data && !data.empty?
+          document.in_briefcase(briefcase)
+
+          if raw
+            document.raw = raw
+          elsif contents || data
+            document.content = contents if contents.to_s.length > 0
+            document.data = data if data && !data.empty?
+          end
+
           document.save!
         end
 
@@ -75,14 +83,23 @@ module Brief::Server::Handlers
       end
 
       def update
-        document = Brief::Document.new(path)
+        data      = params[:data]
+        contents  = params[:content] || params[:contents]
+        raw       = params[:raw]
+
+        document = Brief::Document.new(path).in_briefcase(briefcase)
 
         if document.nil? || !document.exist?
           @errors[:document] = "No document was found at #{ path_args }"
           @errors
         else
-          document.contents = params[:contents] if params[:contents]
-          document.data = (document.data || {}).merge(params[:data]) if params[:data].is_a?(Hash)
+          if raw
+            document.raw = raw
+          elsif contents || data
+            document.content = contents if contents.to_s.length > 0
+            document.data = (document.data || {}).merge(params[:data]) if params[:data].is_a?(Hash)
+          end
+
           document.save
 
           document.to_model

data/lib/brief/server/handlers/show.rb

@@ -26,7 +26,7 @@ module Brief::Server::Handlers
         body = document.to_html
         content_type = "text/html"
       when document && view == "details"
-        body = document.to_model.as_json
+        body = document.to_model.as_json(request.params)
       end
 
       [code, {"Content-Type"=>content_type}, body]

data/lib/brief/server/route.rb

@@ -37,6 +37,8 @@ class Brief::Server::Route
       case
       when request.path.match(/^\/schema/)
         handlers.const_get(:Schema)
+      when path_action == "aggregator"
+        handlers.const_get(:Aggregator)
       when path_action == "browse"
         handlers.const_get(:Browse)
       when %w(create update delete remove).include?(path_action)
@@ -73,3 +75,4 @@ require "brief/server/handlers/browse"
 require "brief/server/handlers/modify"
 require "brief/server/handlers/schema"
 require "brief/server/handlers/show"
+require "brief/server/handlers/aggregator"

data/lib/brief/server.rb

@@ -12,6 +12,8 @@ class Brief::Server
 
     body = body.to_json if body.is_a?(Hash)
     body = body.to_json if body.is_a?(Array)
+    body = body.as_json.to_json if body.is_a?(Brief::Model)
+
     body = "" if body.nil?
 
     headers["Content-Length"]                 = Rack::Utils.bytesize(body).to_s

data/lib/brief/util.rb

@@ -1,4 +1,14 @@
 module Brief::Util
+  def self.split_doc_content(raw_content)
+    if raw_content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
+      content = raw_content[(Regexp.last_match[1].size + Regexp.last_match[2].size)..-1]
+      frontmatter = YAML.load(Regexp.last_match[1]).to_mash
+      [content, frontmatter]
+    else
+      [nil, {}.to_mash]
+    end
+  end
+
   def self.create_method_dispatcher_command_for(action, klass)
     identifier = "#{ action } #{ klass.type_alias.to_s.pluralize }"
 

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.4.4'
+  VERSION = '1.5.0'
 end

data/lib/brief.rb

@@ -11,6 +11,11 @@ require 'yaml'
 require 'erb'
 
 module Brief
+
+  def self.cases
+    @cases ||= {}
+  end
+
   def self.case=(value)
     @briefcase = value
   end
@@ -19,6 +24,10 @@ module Brief
     @briefcase
   end
 
+  def self.views
+    @views ||= {}
+  end
+
   def self.configuration
     Brief::Configuration.instance
   end

data/spec/acceptance/aggregators_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+
+describe "Document Aggregators", :type => :request do
+  it "runs an aggregator on the briefcase" do
+    get "/aggregator/custom_aggregator"
+    expect(json["aggregator"]).to eq("custom")
+  end
+end

data/spec/acceptance/browsing_spec.rb

@@ -6,6 +6,17 @@ describe "Browsing a Briefcase REST Interface", :type => :request do
     expect(last_response.status).to eq(200)
   end
 
+  it "lets me request the briefcase info view in whatever format" do
+    Brief.views[:special_format] = lambda do |briefcase, params|
+      briefcase.as_default.merge({format: "special"})
+    end
+
+    resp = Brief.testcase.special_format
+    get("/info?presenter=special_format")
+
+    expect(json["format"]).to eq(resp[:format])
+  end
+
   it "shows me all of the documents for the requested type" do
     get "/browse/epics"
     expect(json).to be_a(Array)

data/spec/acceptance/modifying_spec.rb

@@ -1,19 +1,44 @@
 require "spec_helper"
 
 describe "Modifying Documents", :type => :request do
-  it "lets me create new documents" do
-    post "/create/epics/newly-created-epic.html.md", contents: "# Epic Title"
+  it "lets me create new documents by passing data and content" do
+    begin
+      post "/create/epics/newly-created-epic.html.md", content: "# Epic Title"
+      expect(json["path"]).to be_present
+      expect(json["path"].to_pathname).to be_exist
+      expect(last_response.status).to eq(200)
+    ensure
+      doc = Brief.case.docs_path.join("epics","newly-created-epic.html.md")
+      doc.unlink if doc.exist?
+    end
+  end
+
+  it "lets me create documents passing raw yaml and content" do
+    begin
+      needle = rand(36**36).to_s(36)
+      data = {newly: needle, type: "epic"}.to_yaml
+      post "/create/epics/newly-created-epic-raw.html.md", raw: "#{ data }\n---\n\n# Epic Title"
+      doc = Brief::Document.new(Brief.case.docs_path.join("epics","newly-created-epic-raw.html.md"))
+      expect(doc.path.read).to include(needle)
+      expect(last_response.status).to eq(200)
+    ensure
+      doc = Brief.case.docs_path.join("epics","newly-created-epic-raw.html.md")
+      doc.unlink if doc.exist?
+    end
   end
 
   it "lets me update existing documents" do
     needle = rand(36**36).to_s(36)
-    post "/update/concept.html.md", contents: "# Modified Content #{ needle }"
+    post "/update/concept.html.md", content: "# Modified Content #{ needle }"
+    doc = Brief.case.document_at("concept.html.md")
+    expect(doc.content).to include(needle)
     expect(last_response.status).to eq(200)
   end
 
   it "lets me update just the metadata for an existing document" do
     needle = rand(36**36).to_s(36)
     post "/update/concept.html.md", data: {needle: needle}
+
     expect(last_response.status).to eq(200)
   end
 

data/spec/acceptance/showing_spec.rb

@@ -15,4 +15,15 @@ describe "Viewing a Briefcase Document", :type => :request do
     get("/view/details/epics/epic.html.md")
     expect(last_response.status).to eq(200)
   end
+
+  it "includes raw content in details mode if asked" do
+    get("/view/details/epics/epic.html.md?content=true&rendered=true")
+    expect(json["rendered"]).not_to be_empty
+    expect(json["content"]).not_to be_empty
+  end
+
+  it "includes rendered content in details mode if asked" do
+    get("/view/details/epics/epic.html.md?rendered=true")
+    expect(json["rendered"]).not_to be_empty
+  end
 end

data/spec/fixtures/example/brief.rb

@@ -3,6 +3,10 @@ config do
   set(:templates => Pathname(File.dirname(__FILE__)).join("templates"))
 end
 
+view :custom_aggregator do
+  {aggregator:"custom"}
+end
+
 define "User Story" do
   meta do
     title

data/spec/fixtures/example/docs/concept.html.md

@@ -2,7 +2,9 @@
 type: concept
 title: Blueprint Concept Example
 subheading: A key concept to the domain model
-contents: "# Modified Content sflavhtnupa7u6zniwsl4f8u7fhi16dkddbk"
-needle: p2hrybcv4jp6nfuenrm671xq3cgfyp30v9vk
+contents: "# Modified Content yl14qj9ziu9imkidvmon70us1qsnd8jgxula"
+needle: 10knkzqyphkv3mzorm8g1wpnq1qi6d0mnb5n
+fucker: shit
 ---
 
+# Modified Content 40o17xs3mlkcv5sa0xf0aa0a83mhyvsqqsyu

data/spec/fixtures/example/docs/page.html.md

@@ -0,0 +1,10 @@
+---
+type: page
+title: Summary
+---
+
+# Summary
+
+The Blueprint by Architects.io is a functional specifications and requirements document that joins together various materials produced by Software Architects, Domain Modelers, Researchers, UX and UI Designers, Engineers, and Product Managers.  The overall purpose is to communicate design intent, vision, and goals, along with the strategy and logistics of implementation.  
+
+Our aim is to reduce the overall communication effort required to deliver products whose results more closely match the intent and goals.  This requires more effective communication tools, a more effortless feedback loop, and a methodology for validating and refining the goals themselves as everyone's understanding develops. 

data/spec/fixtures/example/models/page.rb

@@ -0,0 +1,12 @@
+class Brief::Page
+  include Brief::Model
+
+  meta do
+    title
+  end
+
+  content do
+    title "h1:first-of-type"
+    paragraph "p:first-of-type"
+  end
+end

data/spec/fixtures/example/settings.yml

@@ -0,0 +1,2 @@
+---
+settings: "nice"

data/spec/lib/brief/briefcase_spec.rb

@@ -11,13 +11,21 @@ describe "The Briefcase" do
     expect(briefcase.repository).to be_a(Brief::Repository)
   end
 
+  it "defines methods which combine models in arbitrary ways" do
+    expect(briefcase.custom_aggregator).to be_a(Hash)
+  end
+
+  it "reads the settings.yml" do
+    expect(briefcase.settings.settings).to be_present
+  end
+
   context "Model Loading" do
     it "loads the model definitions from the models folder" do
-      expect(Brief::Model.classes.length).to eq(2)
+      expect(Brief::Model.classes.length).to eq(3)
     end
 
     it "loads the model definitions from the DSL in the config file" do
-      expect(Brief::Model.classes.length).to eq(2)
+      expect(Brief::Model.classes.length).to eq(3)
     end
 
     it "caches the output" do
@@ -29,7 +37,7 @@ describe "The Briefcase" do
   context "Document Mappings" do
     it "has all of the documents" do
       expect(briefcase.epics.length).to eq(1)
-      expect(briefcase.documents.length).to eq(7)
+      expect(briefcase.documents.length).to eq(8)
     end
   end
 end

data/spec/lib/brief/document_spec.rb

@@ -23,6 +23,10 @@ describe "The Brief Document" do
     expect(sample.to_html).to match(/h1.*User Stories.*h1\>/)
   end
 
+  it "renders html" do
+    expect(Brief.page_document.to_html).to be_present
+  end
+
   it "parses the html" do
     expect(sample.css("h1").length).to eq(2)
   end

data/spec/lib/brief/models/page_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe "The Page Document Type" do
+  let(:page) { Brief.page_document.to_model }
+
+  it "should have content" do
+    expect(page.to_html).to include("Summary")
+  end
+
+  it "should have the paragraph" do
+    expect(page.paragraph).not_to be_nil
+  end
+
+  it "should have the right extracted content data" do
+    expect(page.extracted_content_data.title).to eq("Summary")
+    expect(page.extracted_content_data.paragraph).not_to be_nil
+  end
+end
+

data/spec/lib/brief/repository_spec.rb

@@ -36,7 +36,7 @@ describe "The Brief Document Repository" do
 
     it "supports different operators" do
       query = repository.where(:type.neq => "epic")
-      expect(query.length).to eq(6)
+      expect(query.length).to eq(7)
     end
 
     it "limits the results to the specified size" do

data/spec/lib/brief/server/gateway_spec.rb

@@ -13,6 +13,6 @@ describe "Briefcase Server Gateway" do
 
     expect(status).to eq(200)
     expect(headers["Access-Control-Allow-Origin"]).to eq("*")
-    expect(json.length).to eq(2)
+    expect(json.length).to eq(1)
   end
 end

data/spec/lib/brief/server/route_spec.rb

@@ -1,7 +1,6 @@
 require "spec_helper"
 
 describe Brief::Server::Route do
-
   it "routes to the browse handler" do
     expect(handler_for("/browse/epics")).to eq(Brief::Server::Handlers::Browse)
   end

data/spec/spec_helper.rb

@@ -13,6 +13,11 @@ module Brief
     testcase.root
   end
 
+  def self.page_document
+    path = Brief.example_path.join("docs","page.html.md")
+    Brief::Document.new(path)
+  end
+
   def self.example_document
     path = Brief.example_path.join("docs","epics","epic.html.md")
     Brief::Document.new(path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 1.5.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-19 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -269,6 +269,7 @@ files:
 - lib/brief/server.rb
 - lib/brief/server/gateway.rb
 - lib/brief/server/handlers/action.rb
+- lib/brief/server/handlers/aggregator.rb
 - lib/brief/server/handlers/browse.rb
 - lib/brief/server/handlers/info.rb
 - lib/brief/server/handlers/modify.rb
@@ -277,6 +278,7 @@ files:
 - lib/brief/server/route.rb
 - lib/brief/util.rb
 - lib/brief/version.rb
+- spec/acceptance/aggregators_spec.rb
 - spec/acceptance/browsing_spec.rb
 - spec/acceptance/modifying_spec.rb
 - spec/acceptance/schema_spec.rb
@@ -284,12 +286,15 @@ files:
 - spec/fixtures/example/brief.rb
 - spec/fixtures/example/docs/concept.html.md
 - spec/fixtures/example/docs/epics/epic.html.md
+- spec/fixtures/example/docs/page.html.md
 - spec/fixtures/example/docs/persona.html.md
 - spec/fixtures/example/docs/release.html.md
 - spec/fixtures/example/docs/resource.html.md
 - spec/fixtures/example/docs/user_story.html.md
 - spec/fixtures/example/docs/wireframe.html.md
 - spec/fixtures/example/models/epic.rb
+- spec/fixtures/example/models/page.rb
+- spec/fixtures/example/settings.yml
 - spec/fixtures/example/templates/user_story.md.erb
 - spec/fixtures/structures/one.html.md
 - spec/fixtures/structures/three.html.md
@@ -298,6 +303,7 @@ files:
 - spec/lib/brief/document_spec.rb
 - spec/lib/brief/dsl_spec.rb
 - spec/lib/brief/model_spec.rb
+- spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/persistence_spec.rb
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb
@@ -334,6 +340,7 @@ signing_key:
 specification_version: 4
 summary: Brief makes writing more powerful
 test_files:
+- spec/acceptance/aggregators_spec.rb
 - spec/acceptance/browsing_spec.rb
 - spec/acceptance/modifying_spec.rb
 - spec/acceptance/schema_spec.rb
@@ -341,12 +348,15 @@ test_files:
 - spec/fixtures/example/brief.rb
 - spec/fixtures/example/docs/concept.html.md
 - spec/fixtures/example/docs/epics/epic.html.md
+- spec/fixtures/example/docs/page.html.md
 - spec/fixtures/example/docs/persona.html.md
 - spec/fixtures/example/docs/release.html.md
 - spec/fixtures/example/docs/resource.html.md
 - spec/fixtures/example/docs/user_story.html.md
 - spec/fixtures/example/docs/wireframe.html.md
 - spec/fixtures/example/models/epic.rb
+- spec/fixtures/example/models/page.rb
+- spec/fixtures/example/settings.yml
 - spec/fixtures/example/templates/user_story.md.erb
 - spec/fixtures/structures/one.html.md
 - spec/fixtures/structures/three.html.md
@@ -355,6 +365,7 @@ test_files:
 - spec/lib/brief/document_spec.rb
 - spec/lib/brief/dsl_spec.rb
 - spec/lib/brief/model_spec.rb
+- spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/persistence_spec.rb
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb