brief 1.8.6 → 1.8.8

data/lib/brief/cli/export.rb

@@ -1,21 +1,32 @@
 command 'export' do |c|
-  c.syntax= 'brief export [OPTIONS]'
-  c.description = 'Export a parsed version of the document collection'
+  c.syntax = 'brief export PATH [OPTIONS]'
+  c.description = 'export the briefcase found in PATH'
 
-  c.option '--include-content', nil, 'whether to include the unparsed content'
-  c.option '--include-rendered', nil, 'whether to include the rendered content'
-  c.option '--config-path PATH', String, 'Path to the config file'
+  c.option '--output PATH', String, 'Save the output to the specified path'
+  c.option '--app APP', String, 'Use the specified app to get our models etc'
+  c.option '--config PATH', String, 'Use the specified config file'
 
   c.action do |args, options|
-    options.default :config_path => Pathname(Dir.pwd).join('brief.rb')
+    root = Pathname(args.first || Brief.pwd)
 
+    o = {
+      root: root
+    }
 
-    briefcase = Brief::Briefcase.new(config_path: Pathname(options.config_path))
+    o[:app] = options.app if options.app
+    o[:config_path] = options.config if options.config
 
-    dump = briefcase.as_full_export()
+    briefcase = Brief::Briefcase.new(o)
 
-    output = args.first || "#{ briefcase.cache_key }.json"
+    export = briefcase.as_full_export.to_json
 
-    Pathname(Dir.pwd).join(output).open("w+") {|fh| fh.write(dump.to_json) }
+    if options.output
+      output = Pathname(options.output)
+      output = output.join(briefcase.slug + ".json") if output.directory?
+      output.open("w+") {|fh| fh.write(export) }
+    else
+      puts export
+    end
   end
 end
+

data/lib/brief/cli/parse.rb

@@ -9,7 +9,7 @@ command 'parse' do |c|
   c.option '--type TYPE', String, 'Valid options: hash, array; Output as a hash keyed by path, or an array. Defaults to array.'
 
   c.action do |args, options|
-    options.default(root: Pathname(Dir.pwd), type: "array")
+    options.default(root: Pathname(Brief.pwd), type: "array")
 
     o = {
       root: options.root

data/lib/brief/cli/render.rb

@@ -9,7 +9,7 @@ command 'render' do |c|
   c.option '--include-raw', nil, 'Whether or not to include the raw content'
 
   c.action do |args, options|
-    options.default(root: Pathname(Dir.pwd))
+    options.default(root: Pathname(Brief.pwd))
 
     o = {
       root: options.root

data/lib/brief/data.rb

@@ -19,7 +19,7 @@ module Brief
       attr_accessor :sources, :root
 
       def initialize(options={})
-        @root = options.fetch(:root) { Pathname(Dir.pwd).join('data') }
+        @root = options.fetch(:root) { Pathname(Brief.pwd).join('data') }
         @sources = {}.to_mash
 
         load_files.each do |source, data|

data/lib/brief/document.rb

@@ -4,23 +4,10 @@ module Brief
     include Brief::Document::FrontMatter
     include Brief::Document::Templating
 
-    attr_accessor :path, :content, :frontmatter, :raw_content, :options
-
-    def document
-      self
-    end
-
-    def to_s
-      "#{ model_class }.at_path(#{relative_path})"
+    def self.from_contents(content, frontmatter, &block)
     end
 
-    def inspect
-      "#{ model_class }.at_path(#{relative_path})"
-    end
-
-    def relative_path
-      briefcase.present? ? path.relative_path_from(briefcase.docs_path) : path
-    end
+    attr_accessor :path, :content, :frontmatter, :raw_content, :options
 
     def initialize(path, options = {})
       if path.respond_to?(:key?) && options.empty?
@@ -39,6 +26,22 @@ module Brief
       end
     end
 
+    def document
+      self
+    end
+
+    def to_s
+      "#{ model_class }.at_path(#{relative_path})"
+    end
+
+    def inspect
+      "#{ model_class }.at_path(#{relative_path})"
+    end
+
+    def relative_path
+      briefcase.present? ? path.relative_path_from(briefcase.docs_path) : path
+    end
+
     def content_hash
       Digest::MD5.hexdigest(@content.to_s)
     end

data/lib/brief/document/rendering.rb

@@ -1,38 +1,23 @@
-module Brief
-  class Document
-    module Rendering
-      extend ActiveSupport::Concern
+module GitHub
+  class Markdown
 
-      # Uses a custom Redcarpet::Render::HTML subclass
-      # which simply inserts data attributes on each heading element
-      # so that they can be queried with CSS more deliberately.
-      class HeadingWrapper < ::Redcarpet::Render::HTML
-        def header(text, level)
-          "<h#{level} data-level='#{level}' data-heading='#{ text }'>#{text}</h#{level}>"
-        end
-      end
+    def self.render_gfm(content)
+      html = self.to_html(content, :gfm)
+      html = add_level_and_heading(html)
+      html
+    end
 
-      module ClassMethods
-        def renderer_class
-          HeadingWrapper
-        end
+    def self.add_level_and_heading(html)
+      html.gsub(/<h([1-6])>(.+?)<\/h\1>/,"<h\\1 data-level='\\1' data-heading='\\2'>\\2<\/h\\1>")
+    end
 
-        def renderer
-          @renderer ||= begin
-                          r = renderer_class.new(tables: true,
-                                                 autolink: true,
-                                                 gh_blockcode: true,
-                                                 fenced_code_blocks: true,
-                                                 footnotes: true)
+  end
+end
 
-                          ::Redcarpet::Markdown.new(r, :tables => true,
-                                                       :autolink => true,
-                                                       :gh_blockcode => true,
-                                                       :fenced_code_blocks => true,
-                                                       :footnotes => true)
-                        end
-        end
-      end
+module Brief
+  class Document
+    module Rendering
+      extend ActiveSupport::Concern
 
       def script_preamble
         <<-EOF
@@ -78,11 +63,11 @@ module Brief
       protected
 
       def to_raw_html
-        renderer.render(content)
+        renderer.render_gfm(content)
       end
 
       def renderer
-        @renderer ||= self.class.renderer
+        @renderer ||= GitHub::Markdown
       end
 
       attr_writer :renderer

data/lib/brief/document_mapper.rb

@@ -71,7 +71,7 @@ module Brief::DocumentMapper
 
     def run_query
       if query_is_empty?
-        select
+        model.to_a
       else
         model.select do |obj|
           match = true

data/lib/brief/model/serializers.rb

@@ -19,8 +19,8 @@ module Brief::Model::Serializers
       title: document_title,
       actions: self.class.defined_actions,
       updated_at: File.mtime(path).to_i,
-      id: (doc_id = file_hash),
-      hash: doc_id,
+      id: Digest::MD5.hexdigest(path.to_s),
+      hash: file_hash,
       urls: {
         view_content_url: "/view/content/#{ doc_path }",
         view_rendered_url: "/view/rendered/#{ doc_path }",

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.8.6'
+  VERSION = '1.8.8'
 end

data/packaging/wrapper.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+export BRIEF_PWD=$PWD
+set -e
+
+TARGET_FILE=$0
+
+cd `dirname $TARGET_FILE`
+TARGET_FILE=`basename $TARGET_FILE`
+
+# Iterate down a (possible) chain of symlinks
+while [ -L "$TARGET_FILE" ]
+do
+    TARGET_FILE=`readlink $TARGET_FILE`
+    cd `dirname $TARGET_FILE`
+    TARGET_FILE=`basename $TARGET_FILE`
+done
+
+# Compute the canonicalized name by finding the physical path
+# for the directory we're in and appending the target file.
+PHYS_DIR=`pwd -P`
+RESULT=$PHYS_DIR/$TARGET_FILE
+
+# Figure out where this script is located.
+SELFDIR=$(dirname "$RESULT")
+
+# Tell Bundler where the Gemfile and gems are.
+export BUNDLE_GEMFILE="$SELFDIR/lib/app/Gemfile"
+unset BUNDLE_IGNORE_CONFIG
+
+# Run the actual app using the bundled Ruby interpreter.
+exec "$SELFDIR/lib/ruby/bin/ruby" -rbundler/setup "$SELFDIR/lib/app/bin/brief" "$@"

data/spec/fixtures/example/docs/epics/epic.html.md

@@ -0,0 +1,25 @@
+---
+type: epic
+title: Blueprint Epic Example
+subheading: An example of an Epic
+state: active
+---
+
+# Blueprint Epic Example
+
+This is an example of an Epic Document.  An Epic is a single document
+which contains user stories and such.
+
+# User Stories
+
+## A user wants to write epics
+
+As a **User** I want to **write epics** so that I can **write a bunch of user stories in one file**
+
+## A user wants to annotate wireframes
+
+As a **User** I want to  **annotate wireframes** so that I can **augment diagrams with targeted explanations**
+
+## A user wants to provide details about domain concepts
+
+As a **User** I want to **provide some detailed explanations of domain concepts** so that I can **augment diagrams with targeted explanations**

data/spec/fixtures/example/docs/index.md

@@ -0,0 +1,15 @@
+---
+type: outline
+---
+
+# Table of contents
+
+## Personas
+## Epics
+## Wireframes
+## Concepts
+
+```yaml
+option: one
+other: two
+```

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

@@ -0,0 +1,14 @@
+---
+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. 
+
+```yaml
+nested: structure
+```

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

@@ -0,0 +1,5 @@
+---
+type: persona
+title: Blueprint Persona Example
+subheading: A description of a typical user of the software 
+---

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

@@ -0,0 +1,9 @@
+---
+type: release
+title: Blueprint Release Example
+subheading: A release milestone for the software 
+status: Planned
+date: 2018-12-18
+---
+
+This is a release it is a simple file with no real structure.

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

@@ -0,0 +1,5 @@
+---
+type: resource
+title: Blueprint Example Resource
+subheading: An example API Resource document
+---

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

@@ -0,0 +1,24 @@
+---
+type: user_story
+title: Blueprint User Story Example
+subheading: A way of describing desired behavior of the software, from the perspective of a persona who has a goal 
+epic: Blueprint Epic Example 
+release: Blueprint Release Example
+state: active
+title: A Blueprint Persona Example wants this behavior
+---
+
+As a **Blueprint Persona Example** I would like to **do this certain thing in the software** so that I can **accomplish this goal**
+
+#### Wireframes
+
+- Blueprint Wireframe Example
+
+#### Concepts
+
+- Blueprint Concept Example
+
+#### Resources
+
+- Blueprint Example Resource
+

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

@@ -0,0 +1,5 @@
+---
+type: wireframe
+title: Blueprint Wireframe Example
+subheading: A key concept to the domain model 
+---

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

@@ -8,6 +8,7 @@ class Brief::Page
   content do
     title "h1:first-of-type"
     paragraph "p:first-of-type"
-    yaml_data "code.yaml:first-of-type", :serialize => :yaml
+    yaml_data "pre[lang='yaml'] code", :serialize => :yaml
+    yaml "pre[lang='yaml'] code", :serialize => :yaml
   end
 end

data/spec/lib/brief/serializers_spec.rb

@@ -6,6 +6,6 @@ describe "Serializing From Docs" do
   }
 
   it "should serialize the yaml" do
-    expect(page.yaml_data.nested).to eq("structure")
+    expect(page.yaml.nested).to eq("structure")
   end
 end

data/tasks/distribution/configuration.rb

@@ -0,0 +1,15 @@
+module Distribution
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+
+  class Configuration
+    attr_accessor :package_name, :packaging_dir, :version, :rb_version,
+                  :native_extensions
+  end
+end

data/tasks/distribution/executable.rb

@@ -0,0 +1,28 @@
+Dir[File.join(Dir.pwd, 'tasks', '**', '*.rb')].each { |f| require f }
+
+module Distribution
+  class Executable
+    include PackageHelpers
+    extend Forwardable
+
+    attr_reader :package
+
+    def_delegators :@package, :dir, :package_name
+
+    def initialize(package)
+      @package = package
+    end
+
+    def self.create(package)
+      executable = new(package)
+      executable.copy_wrapper
+      executable
+    end
+
+    def copy_wrapper
+      print_to_console 'Creating exexutable...'
+
+      FileUtils.cp 'packaging/wrapper.sh', "#{dir}/#{package_name}"
+    end
+  end
+end

data/tasks/distribution/package.rb

@@ -0,0 +1,85 @@
+require 'fileutils'
+require 'forwardable'
+
+Dir[File.join(Dir.pwd, 'tasks', '**', '*.rb')].each { |f| require f }
+
+module Distribution
+  class Package
+    extend Forwardable
+    include PackageHelpers
+
+    attr_reader :config, :dir, :tarball, :package, :arch, :root
+
+    def_delegators :@config, :version, :rb_version, :package_name,
+                   :packaging_dir, :native_extensions
+
+    def initialize(arch)
+      abort 'Ruby 2.1.x required' if RUBY_VERSION !~ /^2\.1\./
+
+      @arch = arch
+      @config = ::Distribution.configuration
+      @dir = "#{package_name}-#{version}-#{arch}"
+      @package = self
+      @root = File.expand_path '.'
+    end
+
+    def self.create(args)
+      new(*args).build
+    end
+
+    def build
+      initialize_install_dir
+      copy_brief
+      install_ruby_and_gems
+      create_executable
+      post_cleanup
+      @tarball = create_tarball
+      clean_dir
+    end
+
+    private
+
+    def clean_dir
+      FileUtils.cd root do
+        FileUtils.remove_dir(dir, true) if Dir.exist? dir
+      end
+    end
+
+    def post_cleanup
+      print_to_console 'Cleaning up...'
+
+      files = ["#{packaging_dir}/traveling-ruby-#{rb_version}-#{arch}.tar.gz"]
+
+      files.each { |file| FileUtils.rm file if File.exist? file }
+    end
+
+    def create_tarball
+      Tarball.new self
+    end
+
+    def create_executable
+      Executable.create self
+    end
+
+    def install_ruby_and_gems
+      TravellingRuby.install self
+    end
+
+    def initialize_install_dir
+      clean_dir
+
+      FileUtils.cd root do
+        FileUtils.mkdir_p "#{dir}/lib/app"
+      end
+    end
+
+    def copy_brief
+      print_to_console 'Copying brief...'
+
+      %w(brief.gemspec Gemfile Gemfile.lock lib assets apps bin)
+        .each do |folder|
+        FileUtils.cp_r File.join(root, folder), "#{dir}/lib/app"
+      end
+    end
+  end
+end