brief 1.2.0 → 1.3.0

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

@@ -1,15 +1,15 @@
 class Brief::Document::Section
   class Builder
-    def self.run(source, options={})
+    def self.run(source, options = {})
       new(source, options).to_fragment
     end
 
     attr_accessor :source, :nodes, :low, :high
 
-    def initialize(source, options={})
+    def initialize(source, options = {})
       @source = source.map do |item|
         level, group = item
-        [level, group.map {|f| f.is_a?(String) ? Nokogiri::HTML.fragment(f) : f }]
+        [level, group.map { |f| f.is_a?(String) ? Nokogiri::HTML.fragment(f) : f }]
       end
 
       @low = options.fetch(:low, 1)
@@ -28,7 +28,7 @@ class Brief::Document::Section
           next_level, next_fragments = source[n]
 
           if next_level && (next_level == level) && (level > low)
-            new_fragment = (fragments + next_fragments).map(&:to_html).join("")
+            new_fragment = (fragments + next_fragments).map(&:to_html).join('')
             source[index] = [level, [Nokogiri::HTML.fragment(new_fragment)]]
             source[n] = nil
           end
@@ -49,7 +49,7 @@ class Brief::Document::Section
           next_level, next_fragment = source[n]
 
           if fragment && next_level && (next_level > level)
-            parent = fragment.css("section, article").first
+            parent = fragment.css('section, article').first
             parent.add_child(next_fragment)
             source[index] = [level, fragment]
             source[n] = nil
@@ -63,14 +63,14 @@ class Brief::Document::Section
 
       self.nodes = source.map(&:last)
 
-      self.nodes.each do |node|
-        parent = node.css("section, article").first
+      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
         end
       end
 
-      self.nodes.map!(&:to_html)
+      nodes.map!(&:to_html)
     end
 
     def maxed_out?
@@ -82,8 +82,8 @@ class Brief::Document::Section
     end
 
     def to_fragment
-      @html = nodes.join("") unless nodes.empty?
-      Nokogiri::HTML.fragment(@html || "<div/>")
+      @html = nodes.join('') unless nodes.empty?
+      Nokogiri::HTML.fragment(@html || '<div/>')
     end
   end
 end

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

@@ -1,6 +1,6 @@
 class Brief::Document::Section
   class Mapping
-    def initialize(title, options={})
+    def initialize(title, options = {})
       @title = title
       @options = options
       @config  = {}.to_mash
@@ -14,23 +14,17 @@ class Brief::Document::Section
       config.selectors
     end
 
-    def config
-      @config
-    end
+    attr_reader :config
 
-    def options
-      @options
-    end
+    attr_reader :options
 
-    def title
-      @title
-    end
+    attr_reader :title
 
     def selector
       @selector || :next
     end
 
-    def each(*args, &block)
+    def each(*args, &_block)
       @selector = args.first
       self
     end

data/lib/brief/document/section.rb

@@ -19,10 +19,10 @@ class Brief::Document::Section
       settings = config.selector_config[selector]
 
       if Headings.include?(selector)
-        headings = fragment.css("article > h2")
+        headings = fragment.css('article > h2')
         articles = headings.map(&:parent)
 
-        if !settings.empty?
+        unless settings.empty?
           articles.compact.each do |article|
             data.push(settings.inject({}.to_mash) do |memo, pair|
               attribute, selector = pair
@@ -38,4 +38,3 @@ class Brief::Document::Section
     @items = data
   end
 end
-

data/lib/brief/document/structure.rb

@@ -2,7 +2,7 @@ module Brief
   class Document::Structure
     attr_accessor :fragment, :content_lines
 
-    def initialize(fragment,content_lines=[])
+    def initialize(fragment, content_lines = [])
       @fragment = fragment
       @content_lines = content_lines
     end
@@ -12,7 +12,7 @@ module Brief
         if line.match(/^#/)
           line = line.strip
           level = line.count('#')
-          text = line.gsub('#','').strip
+          text = line.gsub('#', '').strip
 
           if level > 0 && text.length > 0
             line_number = index + 1
@@ -55,16 +55,16 @@ module Brief
 
       mapping.map! do |item|
         level, group = item
-        group.reject! {|i| i.text == "\n" }
+        group.reject! { |i| i.text == "\n" }
 
         if level == 0
-          base_fragment = fragment = Nokogiri::HTML.fragment("<div class='brief top level'>#{ group.map(&:to_html).join("") }</div>")
+          base_fragment = fragment = Nokogiri::HTML.fragment("<div class='brief top level'>#{ group.map(&:to_html).join('') }</div>")
         elsif level <= lowest_level
-          fragment = Nokogiri::HTML.fragment("<section>#{ group.map(&:to_html).join("") }</section>")
+          fragment = Nokogiri::HTML.fragment("<section>#{ group.map(&:to_html).join('') }</section>")
         elsif level > lowest_level
           # should be able to look at the document section mappings and
           # apply custom css classes to these based on the name of the section
-          fragment = Nokogiri::HTML.fragment("<article>#{ group.map(&:to_html).join("") }</article>")
+          fragment = Nokogiri::HTML.fragment("<article>#{ group.map(&:to_html).join('') }</article>")
         end
 
         [level, [fragment]]
@@ -74,9 +74,9 @@ module Brief
     end
 
     def levels
-      l = fragment.css("[data-level]").map {|el| el.attr('data-level').to_i }
+      l = fragment.css('[data-level]').map { |el| el.attr('data-level').to_i }
       l.reject!(&:nil?)
-      l.reject! {|v| v.to_i == 0 }
+      l.reject! { |v| v.to_i == 0 }
       l.uniq!
       l
     end
@@ -89,8 +89,8 @@ module Brief
       levels.min
     end
 
-    def headings_at_level(level, options={})
-      matches = heading_elements.select {|el| el.level.to_i == level.to_i }
+    def headings_at_level(level, options = {})
+      matches = heading_elements.select { |el| el.level.to_i == level.to_i }
 
       if options[:text]
         matches.map(&:text)
@@ -101,9 +101,8 @@ module Brief
 
     def heading_with_text(text)
       headings_with_text(text).tap do |results|
-        raise 'no section found with content: ' + text if results.length == 0
-        raise 'more than one section found with content: ' + text if results.length >= 2
-
+        fail 'no section found with content: ' + text if results.length == 0
+        fail 'more than one section found with content: ' + text if results.length >= 2
       end.first
     end
 
@@ -120,7 +119,7 @@ module Brief
     end
 
     def heading_elements
-      @heading_elements ||= fragment.css("h1,h2,h3,h4,h5,h6").map do |el|
+      @heading_elements ||= fragment.css('h1,h2,h3,h4,h5,h6').map do |el|
         if el.attr('data-level').to_i > 0
           {
             level: el.attr('data-level'),
@@ -138,7 +137,7 @@ module Brief
         end
 
         def level(element)
-          element.name.to_s.gsub(/^h/i,'').to_i
+          element.name.to_s.gsub(/^h/i, '').to_i
         end
       end
     end

data/lib/brief/document/templating.rb

@@ -0,0 +1,14 @@
+module Brief::Document::Templating
+  extend ActiveSupport::Concern
+
+  def generate_content
+    model_class.generate_template_content_from(@frontmatter)
+  end
+
+  module ClassMethods
+    def create_from_data(data = {})
+      data = data.to_mash if data.is_a?(Hash)
+      new(data)
+    end
+  end
+end

data/lib/brief/document.rb

@@ -2,19 +2,27 @@ module Brief
   class Document
     include Brief::Document::Rendering
     include Brief::Document::FrontMatter
+    include Brief::Document::Templating
 
     attr_accessor :path, :content, :frontmatter, :raw_content
 
-    def initialize(path, options={})
-      @path = Pathname(path)
-      @options = options
+    def initialize(path, options = {})
+      if path.respond_to?(:key?) && options.empty?
+        @frontmatter = path.to_mash
+      else
+        @path = Pathname(path)
+      end
+
+      @options = options.to_mash
 
-      if self.path.exist?
+      if @path && self.path.exist?
         @raw_content = path.read
         load_frontmatter
+      elsif options[:contents]
+        @raw_content = options[:contents]
       end
 
-      self.model_class.try(:models).try(:<<, to_model) unless model_instance_registered?
+      model_class.try(:models).try(:<<, to_model) unless model_instance_registered?
     end
 
     def data
@@ -34,6 +42,10 @@ module Brief
       @sections
     end
 
+    def content
+      @content || generate_content
+    end
+
     # Shortcut for querying the rendered HTML by css selectors.
     #
     # This will allow for model data attributes to be pulled from the
@@ -87,8 +99,8 @@ module Brief
     # and ensures that there is a 1-1 relationship between a document path
     # and the model.
     def model_instance_registered?
-      self.model_class && self.model_class.models.any? do |model|
-        model.path == self.path
+      model_class && model_class.models.any? do |model|
+        model.path == path
       end
     end
 
@@ -97,7 +109,7 @@ module Brief
     end
 
     def structure
-      @structure_analyzer ||= Brief::Document::Structure.new(fragment, self.raw_content.lines.to_a)
+      @structure_analyzer ||= Brief::Document::Structure.new(fragment, raw_content.lines.to_a)
     end
 
     def parser
@@ -120,4 +132,3 @@ module Brief
     end
   end
 end
-

data/lib/brief/document_mapper.rb

@@ -20,7 +20,7 @@ module Brief::DocumentMapper
 
     def initialize(opts = {})
       unless Brief::DocumentMapper::VALID_OPERATORS.include?(opts[:operator])
-        raise 'Operator not supported'
+        fail 'Operator not supported'
       end
 
       @attribute, @operator = opts[:attribute], opts[:operator]
@@ -36,18 +36,18 @@ module Brief::DocumentMapper
     end
 
     def where(constraints_hash)
-      selector_hash = constraints_hash.reject { |key, value| !key.is_a? Selector }
-      symbol_hash = constraints_hash.reject { |key, value| key.is_a? Selector }
+      selector_hash = constraints_hash.reject { |key, _value| !key.is_a? Selector }
+      symbol_hash = constraints_hash.reject { |key, _value| key.is_a? Selector }
       symbol_hash.each do |attribute, value|
-        selector = Selector.new(:attribute => attribute, :operator => 'equal')
-        selector_hash.update({ selector => value })
+        selector = Selector.new(attribute: attribute, operator: 'equal')
+        selector_hash.update(selector => value)
       end
       @where.merge! selector_hash
       self
     end
 
     def order_by(field)
-      @order_by = field.is_a?(Symbol) ? {field => :asc} : field
+      @order_by = field.is_a?(Symbol) ? { field => :asc } : field
       self
     end
 
@@ -62,11 +62,11 @@ module Brief::DocumentMapper
     end
 
     def first
-      self.all.first
+      all.first
     end
 
     def last
-      self.all.last
+      all.last
     end
 
     def run_query
@@ -129,7 +129,7 @@ module Brief::DocumentMapper
     end
 
     def inspect
-      "Query: #{ @where.map {|k,v| "#{k.attribute} #{k.operator} #{v}" }}"
+      "Query: #{ @where.map { |k, v| "#{k.attribute} #{k.operator} #{v}" }}"
     end
 
     def method_missing(meth, *args, &block)
@@ -153,7 +153,7 @@ class Symbol
 
   unless method_defined?(:"<=>")
     def <=>(other)
-      self.to_s <=> other.to_s
+      to_s <=> other.to_s
     end
   end
 end

data/lib/brief/dsl.rb

@@ -2,8 +2,7 @@ module Brief
   module DSL
     extend ActiveSupport::Concern
 
-    def config(options={}, &block)
-      Brief::Configuration.instance.load_options(options) unless options.nil? || options.empty?
+    def config(options = {}, &block)
       Brief::Configuration.instance.instance_eval(&block) if block_given?
     end
 
@@ -23,7 +22,7 @@ module Brief
     #
     # this will find all of the Post models from the documents matching PATH_GLOB
     # and call the publish method on them
-    def action(identifier, options={}, &block)
+    def action(identifier, _options = {}, &block)
       Object.class.class_eval do
         command "#{identifier}" do |c|
           c.syntax = "brief #{identifier}"
@@ -32,16 +31,16 @@ module Brief
           c.action do |args, opts|
             briefcase = Brief.case
 
-            path_args = args.select {|arg| arg.is_a?(String) && arg.match(/\.md$/) }
+            path_args = args.select { |arg| arg.is_a?(String) && arg.match(/\.md$/) }
 
             path_args.select! do |arg|
               path = briefcase.repository.root.join(arg)
               path.exist?
             end
 
-            path_args.map! {|p| briefcase.repository.root.join(p) }
+            path_args.map! { |p| briefcase.repository.root.join(p) }
 
-            models = path_args.map {|path| Brief::Document.new(path) }.map(&:to_model)
+            models = path_args.map { |path| Brief::Document.new(path) }.map(&:to_model)
 
             block.call(Brief.case, models, opts)
           end

data/lib/brief/model/definition.rb

@@ -6,15 +6,17 @@ module Brief
                   :content_schema,
                   :options,
                   :defined_helpers,
-                  :section_mappings
+                  :section_mappings,
+                  :template_body,
+                  :example_body
 
-    def initialize(name, options={})
+    def initialize(name, options = {})
       @name             = name
       @options          = options
-      @type_alias       = options.fetch(:type_alias) { name.downcase.parameterize.gsub(/-/,'_') }
+      @type_alias       = options.fetch(:type_alias) { name.downcase.parameterize.gsub(/-/, '_') }
       @metadata_schema  = {}.to_mash
       @section_mappings = {}.to_mash
-      @content_schema   = {attributes:{}}.to_mash
+      @content_schema   = { attributes: {} }.to_mash
       @model_class      = options[:model_class]
     end
 
@@ -44,13 +46,19 @@ module Brief
     def apply_config
       # define a virtus attribute mapping
       metadata_schema.values.each do |settings|
-        model_class.send(:attribute, *(settings[:args]))
+        begin
+          settings[:args] = Array(settings[:args])
+          settings[:args][1] = String if settings[:args][1] == ''
+          model_class.send(:attribute, *(settings[:args]))
+        rescue => e
+          raise "Error in metadata schema definition.\n #{ settings.inspect } \n\n #{e.message}"
+        end
       end
 
       # defined helpers adds an anonymous module include
-      Array(self.defined_helpers).each {|mod| model_class.send(:include, mod) }
+      Array(defined_helpers).each { |mod| model_class.send(:include, mod) }
 
-      model_class.defined_actions += Array(self.defined_actions)
+      model_class.defined_actions += Array(defined_actions)
       true
     end
 
@@ -61,23 +69,39 @@ module Brief
     end
 
     def model_class
-      @model_class || model_namespace.const_get(type_alias.camelize) rescue nil
+      @model_class || model_namespace.const_get(type_alias.camelize) rescue Brief.default_model_class
     end
 
     def model_namespace
       Brief.configuration.model_namespace || Brief::Model
     end
 
-    def meta(options={}, &block)
+    def meta(_options = {}, &block)
       @current = :meta
       instance_eval(&block)
     end
 
-    def content(options={}, &block)
+    def content(_options = {}, &block)
       @current = :content
       instance_eval(&block)
     end
 
+    def example(body = nil, _options = {})
+      if body.is_a?(Hash)
+        options = body
+      elsif body.is_a?(String)
+        self.example_body = body
+      end
+    end
+
+    def template(body = nil, _options = {})
+      if body.is_a?(Hash)
+        options = body
+      elsif body.is_a?(String)
+        self.template_body = body
+      end
+    end
+
     def has_actions?
       !@defined_actions.empty?
     end
@@ -120,17 +144,17 @@ module Brief
         if meth.to_sym == :define_section
           opts = args.extract_options!
           identifier = args.first
-          self.section_mappings[identifier] ||= Brief::Document::Section::Mapping.new(identifier, opts)
+          section_mappings[identifier] ||= Brief::Document::Section::Mapping.new(identifier, opts)
           section_mapping(identifier).instance_eval(&block) if block
         else
-          self.content_schema.attributes[meth] = {args: args, block: block}
+          content_schema.attributes[meth] = { args: args, block: block }
         end
       elsif inside_meta?
         if args.first.is_a?(Hash)
           args.unshift(String)
         end
         args.unshift(meth)
-        self.metadata_schema[meth] = {args: args, block: block}
+        metadata_schema[meth] = { args: args, block: block }
       else
         super
       end

data/lib/brief/model/persistence.rb

@@ -1,7 +1,5 @@
 module Brief
   module Model::Persistence
     extend ActiveSupport::Concern
-
-
   end
 end

data/lib/brief/model.rb

@@ -15,8 +15,8 @@ module Brief
 
       class_attribute :models, :after_initialization_hooks, :defined_actions
 
-      self.models = Array(self.models).to_set
-      self.defined_actions = Array(self.defined_actions).to_set
+      self.models = Array(models).to_set
+      self.defined_actions = Array(defined_actions).to_set
 
       class << self
         include Enumerable
@@ -68,16 +68,24 @@ module Brief
       table[type_alias]
     end
 
+    def self.lookup_class_from_args(args = [])
+      args = Array(args)
+
+      if model_class = for_type(args.first)
+        model_class
+      end
+    end
+
     def self.finalize
       Virtus.finalize
       classes.each(&:finalize)
     end
 
     def ==(other)
-      self.path == other.path
+      path == other.path
     end
 
-    def extract_content(options={})
+    def extract_content(options = {})
       document.extract_content(options)
     end
 
@@ -90,7 +98,7 @@ module Brief
         klass = self
 
         klass.name ||= klass.to_s.split('::').last.humanize
-        klass.type_alias ||= klass.name.parameterize.gsub(/-/,'_')
+        klass.type_alias ||= klass.name.parameterize.gsub(/-/, '_')
 
         klass.attribute_set.map(&:name).each do |attr|
           unless klass.method_defined?("find_by_#{ attr }")
@@ -105,39 +113,35 @@ module Brief
         Brief::Repository.define_document_finder_methods
       end
 
-      def where(*args, &block)
+      def where(*args, &_block)
         Brief::DocumentMapper::Query.new(self).send(:where, *args)
       end
 
       def each(*args, &block)
-        Array(self.models).send(:each, *args, &block)
+        Array(models).send(:each, *args, &block)
       end
 
       def after_initialize(&block)
         (self.after_initialization_hooks ||= []).push(block)
       end
 
-      def name=(value)
-        @name = value
-      end
+      attr_writer :name
 
       def name
-        @name || to_s.split('::').last.underscore.gsub('_',' ').titlecase
+        @name || to_s.split('::').last.underscore.gsub('_', ' ').titlecase
       end
 
-      def type_alias=(value)
-        @type_alias = value
-      end
+      attr_writer :type_alias
 
       def type_alias
-        @type_alias || name.parameterize.gsub(/-/,'_')
+        @type_alias || name.parameterize.gsub(/-/, '_')
       end
 
       def definition
         @definition ||= Brief::Model::Definition.new(name, type_alias: type_alias, model_class: self)
       end
 
-      def definition=(value)
+      def definition=(_value)
         @definition
       end
 
@@ -149,18 +153,43 @@ module Brief
         definition.send(:section_mappings, *args)
       end
 
+      def generate_template_content_from(object, include_frontmatter = true)
+        @erb ||= ERB.new(template_body)
+        content = @erb.result(binding)
+        frontmatter = object.slice(*attribute_names)
+
+        base = ''
+        base += frontmatter.to_hash.to_yaml + "---\n" if include_frontmatter
+        base += content
+
+        base
+      end
+
+      def attribute_names
+        attribute_set.map(&:name)
+      end
+
+      def template_body(*args)
+        res = definition.send(:template_body, *args)
+        res.to_s.length == 0 ? example_body : res.to_s.strip
+      end
+
+      def example_body(*args)
+        definition.send(:example_body, *args).to_s.strip
+      end
+
       def method_missing(meth, *args, &block)
-        if %w(meta content actions helpers).include?(meth.to_s)
+        if %w(meta content template example actions helpers).include?(meth.to_s)
           definition.send(meth, *args, &block)
           finalize
         elsif meth.to_s.match(/^on_(.*)_change$/)
-          create_change_handler($1, *args, &block)
+          create_change_handler(Regexp.last_match[1], *args, &block)
         else
           super
         end
       end
 
-      def create_change_handler(attribute, *args, &block)
+      def create_change_handler(_attribute, *_args, &block)
         block.call(self)
       end
     end
@@ -178,8 +207,8 @@ module Brief
         end
       end
 
-      def set_slug_from(column=:name)
-        self.slug = send(column).to_s.downcase.parameterize if self.slug.to_s.length == 0
+      def set_slug_from(column = :name)
+        self.slug = send(column).to_s.downcase.parameterize if slug.to_s.length == 0
       end
     end
   end

data/lib/brief/repository.rb

@@ -9,7 +9,7 @@ module Brief
       documents.send(:each, *args, &block)
     end
 
-    def initialize(briefcase, options={})
+    def initialize(briefcase, options = {})
       @briefcase = briefcase
       @options = options
 
@@ -40,7 +40,7 @@ module Brief
     end
 
     def document_paths
-      Dir[root.join("**/*.md").to_s].map {|p| Pathname(p) }
+      Dir[root.join('**/*.md').to_s].map { |p| Pathname(p) }
     end
 
     def self.define_document_finder_methods
@@ -52,6 +52,5 @@ module Brief
         end
       end
     end
-
   end
 end