brief 1.16.2 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ab0c3413dab15b505c92df133f1a4e144352dd9
-  data.tar.gz: 4a613723060393c2b3338ad020cef71b06710ad9
+  metadata.gz: 379b1d59287fbfabb503d50cca774092722c3201
+  data.tar.gz: 76b5128f3003dd991804854e39c4b0c712fc7ca0
 SHA512:
-  metadata.gz: 933b94b0c4b6d1b137eda4eb5c2f73ab6140943cb189fc85e752a9227613159b2df5706fe5f37d6065061da98bf00457311d58ec3083ee98874013d6e5fd91e4
-  data.tar.gz: 3792781b3e13298ff9a6b2d0e5e0626f1c720afea837aa304553801251f15c10e6bdd0c3c4fa7b60120815c62998007b27688c2212c2cdbe613d1c7ab54f36bb
+  metadata.gz: e7a88ddd403c7db77efb356de2e1906f67e346eaa2708c9610228fdae3720f1e21147d33c6b52ccb6aa68d2fed69970f891fc8c807c911e0287b2bbda2c9ba76
+  data.tar.gz: e63bd5e5ea3157cb8367ca99d371f6da4371a05ad15cca6d2a00541b1cf3b4456ebccdb7950a14adf725fdabda01f21b6152767916207c063c688c07a4157546

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.16.2)
+    brief (1.16.3)
       activesupport (> 3.2)
       commander (~> 4.3)
       em-websocket (~> 0.5)

data/apps/blueprint/lib/epic_publisher.rb

@@ -0,0 +1,28 @@
+# The BlueprintEpicPublisher
+# is an adapter class which will route
+# the epic to an API integration capable of
+# publishign the epic, such as pivotal tracker or github
+class BlueprintEpicPublisher
+  def self.publish(epic, options={})
+    via = (options.fetch(:via, :github) || :github)
+
+    if respond_to?("publish_via_#{via}")
+      send("publish_via_#{via}", epic,options)
+    else
+      raise "Invalid publishing source. Need to implement publish_via_#{via} method"
+    end
+  end
+
+  # Epics get published to Pivotal
+  # directly as epics, since Epics have first class support in pivotal
+  def self.publish_via_pivotal(epic, options={})
+    raise 'This is not implemented in the app yet.  You can implement it on your own by implementing BlueprintEpicPublisher.publish_via_pivotal'
+  end
+
+  # Epics get published to Github
+  # as issues, and then get labeled as epics.
+  # epics will reference other issues.
+  def self.publish_via_github(epic, options={})
+    raise 'This is not implemented in the app yet.  You can implement it on your own by implementing BlueprintEpicPublisher.publish_via_github'
+  end
+end

data/apps/blueprint/models/epic.rb

@@ -12,32 +12,6 @@ class Brief::Apps::Blueprint::Epic
     tags Array
   end
 
-  example <<-EOF
----
-type: epic
-status: draft
----
-
-# Epic Title
-
-Write a description for your epic.
-
-# Features
-
-## Feature Title
-
-As a **PERSONA** I would like to **BEHAVIOR** so that I can **GOAL**
-  EOF
-
-  template <<-EOF
-# <%= object.title %>
-# Features
-<% Array(object.features).each do |feature| %>
-## <%= feature.title %>
-As a **User** I would like to **Do this** so that I can **succeed**
-<% end %>
-  EOF
-
   content do
     title "h1:first-of-type"
     paragraph "p:first-of-type"
@@ -54,6 +28,34 @@ As a **User** I would like to **Do this** so that I can **succeed**
     end
   end
 
+  template <<-EOF
+# <%= object.title %>
+# Features
+<% Array(object.features).each do |feature| %>
+## <%= feature.title %>
+<%= feature.paragraph %>
+<% end %>
+  EOF
+
+
+  actions do
+    def validate
+      $brief_cli ? validate_cli : true
+    end
+
+    def estimate
+      estimate_cli if $brief_cli
+    end
+
+    def activate
+      raise 'Need to implement this on your own'
+    end
+
+    def publish
+      BlueprintEpicPublisher.publish(self, via: briefcase.settings.try(:tracking_system))
+    end
+  end
+
   helpers do
     def features
       sections.features.items.map do |item|
@@ -62,6 +64,85 @@ As a **User** I would like to **Do this** so that I can **succeed**
         item.merge(goal: item.components[2],
                    persona: item.components[0],
                    behavior: item.components[1])
+
+      end
+    end
+
+    def raw_content_for_feature(feature_heading, include_heading=true)
+      document.content_under_heading(feature_heading, include_heading)
+    end
+
+    def estimate_cli
+      new_content = ask_editor("# Enter point values next to each feature title\n\n#{estimations_yaml}")
+      parsed      = YAML.load(new_content) rescue nil
+
+      if parsed
+        estimations_yaml_path.open("w+") {|fh| fh.write(new_content) }
+      end
+    end
+
+    def estimations_yaml
+      estimations_data.to_yaml
+    end
+
+    def estimations_data
+      if estimations_yaml_path.exist?
+        YAML.load(estimations_yaml_path.read)
+      else
+        estimates = features.map(&:title).reduce({}) do |memo, feature_title|
+          memo[feature_title] = 0
+          memo
+        end
+
+        {
+          type: "epic_estimations",
+          document_path: document.path,
+          epic_title: title,
+          estimates: estimates
+        }.stringify_keys
+      end
+    end
+
+    def estimations_yaml_path
+      briefcase.data_path.join("estimations","#{title.parameterize}.yml")
+    end
+
+    # prints a validation report of the epic
+    def validation_report
+      warnings = []
+      errors = []
+
+      begin
+        features
+      rescue => e
+        errors.push "Error generating features: #{ e.message }"
+      end
+
+      if title.to_s.length == 0
+        errors.push "Missing epic title"
+      end
+
+      if project.to_s.length == 0
+        warnings.push "Missing project reference"
+      else
+        project_titles = Array((briefcase.projects.map(&:title) rescue nil))
+        warnings.push "Invalid project reference. #{ project } does not refer to a valid project. #{ project_titles }" unless project_titles.include?(project)
+      end
+
+      [warnings, errors]
+    end
+
+    def validate_cli
+      warnings, errors = validation_report
+
+      if !warnings.empty?
+        puts "== Epic Warnings. #{ document.path }".yellow
+        warnings.each {|w| puts "  -- #{ w }" }
+      end
+
+      if !errors.empty?
+        puts "== Epic Errors. #{ document.path }".red
+        errors.each {|w| puts "  -- #{ w }" }
       end
     end
   end

data/bin/brief

@@ -5,6 +5,7 @@ $:.unshift File.join(File.dirname(__FILE__),'..','lib')
 require 'rubygems'
 require 'brief'
 require 'brief/dsl'
+require 'colored'
 
 
 if ARGV[0] == "console"

data/lib/brief.rb

@@ -140,6 +140,7 @@ require 'brief/document/structure'
 require 'brief/document/section'
 require 'brief/document/section/mapping'
 require 'brief/document/section/builder'
+require 'brief/document/source_map'
 require 'brief/document'
 require 'brief/document_mapper'
 require 'brief/repository'

data/lib/brief/briefcase.rb

@@ -26,10 +26,10 @@ module Brief
 
       Brief.cases[root.basename.to_s] ||= self
 
-      load_lib_entries()
+      load_briefcase_lib_entries()
     end
 
-    def load_lib_entries
+    def load_briefcase_lib_entries
       begin
         etc = Dir[briefcase_lib_path.join("**/*.rb")]
         etc.each {|f| require(f) } if briefcase_lib_path.exist?
@@ -254,6 +254,7 @@ module Brief
     def load_model_definitions
       if uses_app?
         Brief.load_modules_from(app_path.join("models"))
+        Dir[app_path.join("lib","**/*.rb")].each {|f| require(f) }
       end
 
       Brief.load_modules_from(models_path) if models_path.exist?

data/lib/brief/document.rb

@@ -4,6 +4,7 @@ module Brief
     include Brief::Document::FrontMatter
     include Brief::Document::Templating
     include Brief::Document::Attachments
+    include Brief::Document::SourceMap
 
     def self.from_contents(content, frontmatter, &block)
     end

data/lib/brief/document/section.rb

@@ -27,8 +27,12 @@ class Brief::Document::Section
       settings = config.selector_config[selector]
 
       if Headings.include?(selector)
-        headings = fragment.css('article > h2')
-        articles = headings.map(&:parent)
+        headings = fragment.css("article > #{selector}")
+
+        articles = headings.map do |el|
+          el.parent.set_attribute('data-parent-heading', el.text)
+          el.parent
+        end
 
         unless settings.empty?
           articles.compact.each do |article|

data/lib/brief/document/source_map.rb

@@ -0,0 +1,55 @@
+module Brief::Document::SourceMap
+  def heading_line_numbers
+    heading_element_tags.map {|el| el.attr('data-line-number') }
+  end
+
+  def heading_element_tags
+    css('h1,h2,h4,h5,h6')
+  end
+
+  def heading_details
+    @heading_details ||= structure.get_heading_details.tap do |list|
+      list.map! {|i| i.line_number = i.line_number.to_i; i.level = i.level.to_i; i }
+      list.sort_by! {|i| i.line_number }
+    end
+  end
+
+  def next_sibling_heading_for(heading_element)
+    if heading_element.is_a?(String) && heading_element.length > 1
+      heading_element = heading_element_tags.find do |el|
+        el.attr('data-heading').include?(heading_element) || el.text.to_s.include?(heading_element)
+      end
+    end
+
+    line  = heading_element.attr('data-line-number').to_i
+    level = heading_element.attr('data-level').to_i
+
+    superior = heading_details.find do |next_element|
+      next_element.line_number.to_i > line && next_element.level.to_i >= level
+    end
+
+    superior && superior.element
+  end
+
+  def content_under_heading(heading_element, include_heading=true)
+    if heading_element.is_a?(String) && heading_element.length > 1
+      heading_element = heading_element_tags.find do |el|
+        el.attr('data-heading').include?(heading_element) || el.text.to_s.include?(heading_element)
+      end
+    end
+
+    start_index = heading_element.attr('data-line-number').to_i
+    end_index = content.lines.length
+
+    if next_heading = next_sibling_heading_for(heading_element)
+      end_index = next_heading.attr('data-line-number').to_i
+    end
+
+    end_index = end_index - start_index
+    start_index = 0 if start_index < 0
+
+    lines = raw_content.lines.dup.slice(start_index - 1, end_index)
+
+    (include_heading ? lines : lines.slice(1, lines.length)).join("")
+  end
+end

data/lib/brief/document/structure.rb

@@ -89,6 +89,10 @@ module Brief
       end
     end
 
+    def heading_element_tags
+      css("h1,h2,h3,h4,h5,h6")
+    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
@@ -180,7 +184,7 @@ module Brief
     end
 
     def headings_at_level(level, options = {})
-      matches = heading_elements.select { |el| el.level.to_i == level.to_i }
+      matches = heading_details.select { |el| el.level.to_i == level.to_i }
 
       if options[:text]
         matches.map(&:text)
@@ -197,7 +201,7 @@ module Brief
     end
 
     def headings_with_text(text)
-      heading_elements.select do |el|
+      heading_details.select do |el|
         el.heading.to_s.strip == text.to_s.strip
       end
     end
@@ -207,17 +211,22 @@ module Brief
     end
 
     def find_heading_by(level, heading)
-      heading_elements.find do |el|
+      heading_details.find do |el|
         el.level.to_s == level.to_s && heading.to_s.strip == el.heading.to_s.strip
       end
     end
 
-    def heading_elements
-      @heading_elements ||= fragment.css('h1,h2,h3,h4,h5,h6').map do |el|
+    def heading_details
+      @heading_details ||= get_heading_details
+    end
+
+    def get_heading_details
+      fragment.css('h1,h2,h3,h4,h5,h6').map do |el|
         if el.attr('data-level').to_i > 0
           {
             level: el.attr('data-level'),
             heading: el.attr('data-heading'),
+            line_number: el.attr('data-line-number'),
             element: el
           }.to_mash
         end

data/lib/brief/util.rb

@@ -22,13 +22,53 @@ module Brief::Util
     end
   end
 
+  def self.create_singular_method_dispatcher_command_for(action, klass)
+    identifier = "#{ action } #{ klass.type_alias }"
+
+    Object.class.class_eval do
+      command "#{identifier}" do |c|
+        c.syntax = "brief #{identifier} PATH"
+        c.description = "run the #{identifier} command on the model specified at path"
+
+        c.action do |args, _opts|
+          briefcase = $briefcase || Brief.case
+
+          path_args = args.select { |arg| arg.is_a?(String) && arg.match(/\.md$/) }
+
+          path_args.select! do |arg|
+            briefcase.root.join(arg).exist?
+          end
+
+          path_args.map! { |p| briefcase.root.join(p) }
+
+          models = briefcase.documents_at(*path_args).map(&:to_model)
+
+          if models.empty?
+            model_finder = c.name.to_s.split(' ').last
+            models = briefcase.send(model_finder)
+          elsif models.length > 1
+            puts "You passed more than one model.  If this is what you want, use the pluralized version of this command to be safe"
+          else
+            model = models.first
+            model && model.send(action)
+          end
+        end
+      end rescue nil
+    end
+  end
+
+  # takes the actions from the models and creates a command
+  # that lets you dispatch the action to a group of models at the
+  # paths / directory / glob you pass
   def self.create_method_dispatcher_command_for(action, klass)
+    create_singular_method_dispatcher_command_for(action,klass)
+
     identifier = "#{ action } #{ klass.type_alias.to_s.pluralize }"
 
     Object.class.class_eval do
       command "#{identifier}" do |c|
-        c.syntax = "brief #{identifier}"
-        c.description = "run the #{identifier} command"
+        c.syntax = "brief #{identifier} PATHS"
+        c.description = "run the #{identifier} command on the models at PATHS"
 
         c.action do |args, _opts|
           briefcase = $briefcase || Brief.case

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.16.2'
+  VERSION = '1.17.0'
 end

data/spec/lib/brief/source_map_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe "Source Maps Feature" do
+  let(:example) { Brief.example_document }
+  let(:heading) { "A user wants to write epics" }
+
+  it "returns the raw content under a given heading" do
+    expect(example.content_under_heading(heading)).to include(heading)
+  end
+
+  it "returns the raw content under a given heading without the heading" do
+    expect(example.content_under_heading(heading, false)).not_to include(heading)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.16.2
+  version: 1.17.0
 platform: ruby
 authors:
 - Jonathan Soeder
@@ -343,6 +343,7 @@ files:
 - apps/blueprint/examples/sitemap.md
 - apps/blueprint/examples/wireframe.md
 - apps/blueprint/extensions/middleman.rb
+- apps/blueprint/lib/epic_publisher.rb
 - apps/blueprint/models/concept.rb
 - apps/blueprint/models/diagram.rb
 - apps/blueprint/models/epic.rb
@@ -396,6 +397,7 @@ files:
 - lib/brief/document/section.rb
 - lib/brief/document/section/builder.rb
 - lib/brief/document/section/mapping.rb
+- lib/brief/document/source_map.rb
 - lib/brief/document/structure.rb
 - lib/brief/document/templating.rb
 - lib/brief/document/transformer.rb
@@ -475,6 +477,7 @@ files:
 - spec/lib/brief/serializers_spec.rb
 - spec/lib/brief/server/gateway_spec.rb
 - spec/lib/brief/server/route_spec.rb
+- spec/lib/brief/source_map_spec.rb
 - spec/lib/brief/structure_spec.rb
 - spec/lib/brief/template_spec.rb
 - spec/spec_helper.rb
@@ -578,6 +581,7 @@ test_files:
 - spec/lib/brief/serializers_spec.rb
 - spec/lib/brief/server/gateway_spec.rb
 - spec/lib/brief/server/route_spec.rb
+- spec/lib/brief/source_map_spec.rb
 - spec/lib/brief/structure_spec.rb
 - spec/lib/brief/template_spec.rb
 - spec/spec_helper.rb