brief 1.11.8 → 1.11.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4eb7080fe6495a3998a7ebda464a4f1399b93c1
-  data.tar.gz: 604c41c7ae50c473b94a2705a2fad554f4d69834
+  metadata.gz: 7a8689c2a2ceb352cc525a5739fd3936256664f1
+  data.tar.gz: b699ab744e6e570f815304f34d58cbe8207470ba
 SHA512:
-  metadata.gz: d45ca5dba5242fa0ee6b90b7cd6fadf1e6d473be899c146ffe3a24c282d9ec5db54bebb32ee942dd2e536c29b9578db7bb0aaf8f22b7a02c590a447dbaa8e439
-  data.tar.gz: fac37b173292b3a0605111f32e4bb0797cb7a209d74b904dae47838a5053e41042d3646890d6083889f7da9594a4bb036d5672fce8e780d7117c2cfd4a3747f1
+  metadata.gz: 1857df21a19cb17bdcb58f11fd85711f81ea2776274329eb1fb83253f424009c79c09f95be02e0f425a1704be12d51e33c2d58757b9c7c1f11be3c7ebfc51dd1
+  data.tar.gz: da9cbc07f175690ff3a49022e7c63678d8547a80447d2eb3fc4b334147d04265ae4d32b7fd5ef6687200617f02f19f6043a45dd289e7d94b7996c34947e4d62d

data/CHANGELOG.md

@@ -142,9 +142,13 @@ attributes.
   - Added a websocket server for easy on the fly parsing / querying
 
 ### 1.9.12
-  - Included ability to transform content using special markdown link syntax
+  - Included ability to embed content using special markdown link syntax
   - Included ability to inline svg assets
 
 ### 1.11.7
   - Added ability to define briefcase commands and dispatch these
     commands from the CLI
+
+### 1.11.9
+  - By Setting `Brief.href_builder` to a Proc, you can control the URI
+    that are generated through the brief markdown link syntax

data/Gemfile.lock

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

data/lib/brief.rb

@@ -45,7 +45,6 @@ module Brief
     end
   end
 
-
   def self.views
     @views ||= {}
   end
@@ -112,6 +111,16 @@ module Brief
       raise "Invalid adapter: #{ identifier }" unless adapter
     end
   end
+
+  # This can be overridden so that you can generate uri values
+  # in the renderings that fit within the medium (e.g. website, electron app)
+  def self.href_builder
+    @href_builder || ->(o){o}
+  end
+
+  def self.href_builder= value
+    @href_builder = value
+  end
 end
 
 require 'brief/core_ext'

data/lib/brief/briefcase.rb

@@ -90,6 +90,10 @@ module Brief
       }
     end
 
+    def get_href_for(brief_uri)
+      Brief.href_builder.call(brief_uri)
+    end
+
     # TODO
     # The serialization of an entire briefcase at once
     # is important enough to be its own module

data/lib/brief/document/transformer.rb

@@ -1,3 +1,6 @@
+# The Document Transformer allows for special usage of markdown
+# link and image embedding syntax.  This lets us piggy back on these syntax
+# and use them as include directives to embed other documents, or SVG diagrams.
 module Brief
   class Document::Transformer
     attr_reader :document, :fragment
@@ -12,6 +15,10 @@ module Brief
       inline_svg_content
     end
 
+    def briefcase
+      @briefcase ||= document.briefcase
+    end
+
     def inline_svg_content
       inline_svg_images.each do |img|
         src = img['src'].to_s
@@ -23,7 +30,7 @@ module Brief
         end
 
         begin
-          if asset = document.briefcase.find_asset(value)
+          if asset = briefcase.find_asset(value)
             img.replace("<div class='svg-wrapper'>#{ asset.read }</div>")
           end
         rescue
@@ -39,14 +46,14 @@ module Brief
 
         if instruction == "link" && attribute == "path"
           begin
-            link_to_doc = document.briefcase.document_at(value)
+            link_to_doc = briefcase.document_at(value)
 
             if link_to_doc.exist?
               text = link_to_doc.send(strategy)
               node.inner_html = text
-              node['href'] = "brief://#{ link_to_doc.path }"
+              node['href'] = briefcase.get_href_for("brief://#{ link_to_doc.path }")
             else
-              node['href'] = "brief://document-not-found"
+              node['href'] = briefcase.get_href_for("brief://document-not-found")
             end
           rescue
             nil
@@ -59,7 +66,7 @@ module Brief
         instruction, strategy = node.text.to_s.split(':')
 
         if instruction == "include" && attribute == "path"
-          include_doc = document.briefcase.document_at(value)
+          include_doc = briefcase.document_at(value)
 
           replacement = nil
 

data/lib/brief/dsl.rb

@@ -13,6 +13,10 @@ module Brief
       Brief.views[name.to_sym] = block
     end
 
+    def href_builder(&block)
+      Brief.href_builder = block
+    end
+
     # Register a new command for this briefcase.
     #
     # Pass the name of the command, options, and a block.

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.11.8'
+  VERSION = '1.11.9'
 end

data/spec/lib/brief/content_transformation_spec.rb

@@ -15,4 +15,12 @@ describe "Content Transformation" do
     expect(html).to include("svg-wrapper")
     expect(html).to include("svg version")
   end
+
+  describe "HREF Generation" do
+    it "does nothing by default" do
+      expect(Brief.testcase.get_href_for("brief://me")).to eq("brief://me")
+    end
+  end
 end
+
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.11.8
+  version: 1.11.9
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie