brief 1.2.0 → 1.3.0

data/lib/brief/util.rb

@@ -7,19 +7,19 @@ module Brief::Util
         c.syntax = "brief #{identifier}"
         c.description = "run the #{identifier} command"
 
-        c.action do |args, opts|
+        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)
 
           if models.empty?
             model_finder = c.name.to_s.split(' ').last

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = "1.2.0"
+  VERSION = '1.3.0'
 end

data/lib/brief.rb

@@ -1,16 +1,17 @@
-require "pathname"
-require "set"
-require "hashie"
-require "virtus"
-require "inflecto"
-require "active_support"
-require "active_support/core_ext"
-require "redcarpet"
-require "nokogiri"
-require "yaml"
+require 'pathname'
+require 'set'
+require 'hashie'
+require 'virtus'
+require 'inflecto'
+require 'active_support'
+require 'active_support/core_ext'
+require 'redcarpet'
+require 'nokogiri'
+require 'yaml'
+require 'erb'
 
 module Brief
-  def self.case= value
+  def self.case=(value)
     @briefcase = value
   end
 
@@ -26,8 +27,12 @@ module Brief
     Pathname(File.dirname(__FILE__))
   end
 
+  def self.apps_path
+    gem_root.join("..","apps")
+  end
+
   def self.load_commands
-    Dir[gem_root.join("brief","cli","**/*.rb")].each {|f| require(f) }
+    Dir[gem_root.join('brief', 'cli', '**/*.rb')].each { |f| require(f) }
 
     # the instance methods which get defined with the helper
     Brief::Model.classes.each do |klass|
@@ -37,8 +42,16 @@ module Brief
     end
   end
 
-  def self.load_models(from_folder=nil)
-    Brief::Model.load_all(from_folder: from_folder)
+  def self.default_model_class
+    if defined?(Brief::DefaultModel)
+      Brief::DefaultModel
+    else
+      Brief.const_set(:DefaultModel, Class.new { include Brief::Model; def self.type_alias; "default"; end })
+    end
+  end
+
+  def self.load_modules_from(folder)
+    Dir[folder.join('**/*.rb')].each { |f| require(f) }
   end
 
   # Adapters for Rails, Middleman, or Jekyll apps
@@ -49,22 +62,23 @@ module Brief
   end
 end
 
-require "brief/core_ext"
-require "brief/version"
-require "brief/util"
-require "brief/configuration"
-require "brief/document/rendering"
-require "brief/document/front_matter"
-require "brief/document/content_extractor"
-require "brief/document/structure"
-require "brief/document/section"
-require "brief/document/section/mapping"
-require "brief/document/section/builder"
-require "brief/document"
-require "brief/document_mapper"
-require "brief/repository"
-require "brief/model"
-require "brief/model/definition"
-require "brief/model/persistence"
-require "brief/dsl"
-require "brief/briefcase"
+require 'brief/core_ext'
+require 'brief/version'
+require 'brief/util'
+require 'brief/configuration'
+require 'brief/document/rendering'
+require 'brief/document/front_matter'
+require 'brief/document/templating'
+require 'brief/document/content_extractor'
+require 'brief/document/structure'
+require 'brief/document/section'
+require 'brief/document/section/mapping'
+require 'brief/document/section/builder'
+require 'brief/document'
+require 'brief/document_mapper'
+require 'brief/repository'
+require 'brief/model'
+require 'brief/model/definition'
+require 'brief/model/persistence'
+require 'brief/dsl'
+require 'brief/briefcase'

data/spec/fixtures/example/brief.rb

@@ -1,5 +1,6 @@
 config do
   set(:models => Pathname(File.dirname(__FILE__)).join("models"))
+  set(:templates => Pathname(File.dirname(__FILE__)).join("templates"))
 end
 
 define "User Story" do
@@ -9,6 +10,8 @@ define "User Story" do
     epic_title
   end
 
+  template :file => "user_story.md.erb"
+
   content do
     persona "p strong:first-child"
     behavior "p strong:second-child"

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

@@ -7,22 +7,60 @@ class Brief::Epic
     status String, :in => %w(draft published)
   end
 
+  example <<-EOF
+---
+type: epic
+status: draft
+---
+
+# Epic Title
+
+Write a description for your epic.
+
+# User Stories
+
+## User Story Title
+
+As a **PERSONA** I would like to **BEHAVIOR** so that I can **GOAL**
+  EOF
+
+  template <<-EOF
+# <%= object.title %>
+# User Stories
+<% Array(object.user_stories).each do |user_story| %>
+## <%= user_story.title %>
+As a **User** I would like to **Do this** so that I can **succeed**
+<% end %>
+  EOF
+
   content do
-    # have to do this so that the user stories section h1 doesnt get confused
     title "h1:first-of-type"
-
     define_section "User Stories" do
-      # NOT YET Implemented
-      each("h2").is_a :user_story
-
       each("h2").has(:title     => "h2",
                      :paragraph => "p:first-of-type",
                      :components   => "p:first-of-type strong"
                     )
+
+      each("h2").is_a :user_story
+    end
+  end
+
+  helpers do
+    def user_stories
+      sections.user_stories.items.map do |item|
+        item.components = Array(item.components)
+
+        item.merge(goal: item.components[2],
+                   persona: item.components[0],
+                   behavior: item.components[1])
+      end
     end
   end
 
   actions do
+    def publish_to_github
+    end
+
     def custom_action
     end
   end

data/spec/fixtures/example/templates/user_story.md.erb

@@ -0,0 +1,22 @@
+# <%= object.title %>
+
+<% if object.persona && object.behavior %>
+As a **<%= object.persona %>** I would like to <%= object.behavior %>** <% if object.goal; %> so that I can **<%= object.goal %>** <% end; %>
+<% elsif object.paragraph.to_s.length > 0 %>
+<%= object.paragraph %>
+<% end %>
+
+<% if object.wireframes %>
+### Wireframes
+<% Array(object.wireframes).each do |wireframe| %>
+- <%= wireframe %>
+<% end %>
+<% end %>
+
+<% if object.estimates %>
+### Estimates
+<% Array(object.estimates).each do |estimate| %>
+- <%= estimate %>
+<% end %>
+<% end %>
+

data/spec/lib/brief/briefcase_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "The Briefcase" do
-  let(:briefcase) { Brief.example }
+  let(:briefcase) { Brief.testcase }
 
   it "has a root path" do
     expect(briefcase.root).to be_exist

data/spec/lib/brief/dsl_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 
 describe "The Configuration DSL" do
-  let(:briefcase) { Brief.example }
+  let(:briefcase) { Brief.testcase }
 
   it "can create methods on our models" do
     expect(briefcase.user_stories.first.defined_helper_method).to eq(true)

data/spec/lib/brief/model_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "The Brief Model" do
-  let(:briefcase) { Brief.example }
+  let(:briefcase) { Brief.testcase }
   let(:epic) { briefcase.epics.first }
   let(:user_story) { briefcase.user_stories.first }
 
@@ -101,6 +101,11 @@ describe "The Brief Model" do
     it "users the actions block to define CLI dispatchers (dsl)" do
       expect(user_story.class.defined_actions).to include(:custom_action)
     end
+
+    it "lets me define a helper method which utilizes all the extracted data and content structure" do
+      expect(epic.user_stories.length).to eq(3)
+      expect(epic.user_stories.map(&:persona)).to include("User")
+    end
   end
 
   context "Section Mappings" do

data/spec/lib/brief/persistence_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "Updating Model Data" do
-  let(:briefcase) { Brief.example }
+  let(:briefcase) { Brief.testcase }
 
   it "lets me set new attributes on the model" do
   end

data/spec/lib/brief/repository_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe "The Brief Document Repository" do
-  let(:repository) { Brief.example.repository }
+  let(:repository) { Brief.testcase.repository }
 
   it "has a bunch of documents" do
     expect(repository.documents).not_to be_empty

data/spec/lib/brief/template_spec.rb

@@ -0,0 +1,44 @@
+require "spec_helper"
+
+describe "Document Templates" do
+  let(:data) do
+    {
+      title: "Epic Example",
+      status: "published",
+      type: "epic",
+      user_stories:[{
+        title: "A user wants to do something",
+        paragraph: "As a user I would like to do something so that I can succeed",
+        goal: "I can succeed",
+        persona: "user",
+        behavior: "do something"
+      },{
+        title: "A user wants to do something else",
+        paragraph: "As a user I would like to do something else so that I can succeed"
+      }]
+    }
+  end
+
+  it "has template body" do
+    expect(Brief::Epic.template_body).not_to be_empty
+  end
+
+  it "has an example" do
+    expect(Brief::Epic.example_body).not_to be_empty
+  end
+
+  it "takes a hash of data and renders yaml frontmatter" do
+    expect(Brief::Document.create_from_data(data).title).to eq("Epic Example")
+  end
+
+  it "supports more complex renderings" do
+    doc = Brief::Document.create_from_data(data)
+    content = doc.content
+
+    expect(content).to include("# User Stories")
+    expect(content).to include("# Epic Example")
+    expect(content).to include("## A user wants to do something")
+    expect(content).to include("## A user wants to do something else")
+  end
+
+end

data/spec/spec_helper.rb

@@ -9,10 +9,10 @@ module Brief
   end
 
   def self.example_path
-    example.root
+    testcase.root
   end
 
-  def self.example
+  def self.testcase
     @example ||= Brief::Briefcase.new(root:spec_root.join("fixtures","example"))
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -244,6 +244,7 @@ files:
 - lib/brief/document/section/builder.rb
 - lib/brief/document/section/mapping.rb
 - lib/brief/document/structure.rb
+- lib/brief/document/templating.rb
 - lib/brief/document_mapper.rb
 - lib/brief/dsl.rb
 - lib/brief/model.rb
@@ -261,6 +262,7 @@ files:
 - spec/fixtures/example/docs/user_story.html.md
 - spec/fixtures/example/docs/wireframe.html.md
 - spec/fixtures/example/models/epic.rb
+- spec/fixtures/example/templates/user_story.md.erb
 - spec/fixtures/structures/one.html.md
 - spec/fixtures/structures/three.html.md
 - spec/fixtures/structures/two.html.md
@@ -273,6 +275,7 @@ files:
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
 - spec/lib/brief/structure_spec.rb
+- spec/lib/brief/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_helpers.rb
 - tasks/brief/release.rake
@@ -310,6 +313,7 @@ test_files:
 - spec/fixtures/example/docs/user_story.html.md
 - spec/fixtures/example/docs/wireframe.html.md
 - spec/fixtures/example/models/epic.rb
+- spec/fixtures/example/templates/user_story.md.erb
 - spec/fixtures/structures/one.html.md
 - spec/fixtures/structures/three.html.md
 - spec/fixtures/structures/two.html.md
@@ -322,6 +326,7 @@ test_files:
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
 - spec/lib/brief/structure_spec.rb
+- spec/lib/brief/template_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_helpers.rb
 has_rdoc: