brief 1.13.2 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b210c7cfbfc6c61d2065de58511cd75b792e6183
-  data.tar.gz: 8d5452b12855d0df0afcdd9dd705df8e8aee296a
+  metadata.gz: 492b8deb3666e930f5319091d35dd864a7978053
+  data.tar.gz: f87bb8973ab58226831c88c125ab0d52f1d6df31
 SHA512:
-  metadata.gz: 1132ffc9ac404ebc966c101f218361bbd3026dd0fc1e2a66b84077cceb7a661f9889b6a95c06636ed55958a8fc6076a31a3733b44a04b74b8f68d1a21897e271
-  data.tar.gz: 6ca953bc15a875623da13b0a67d330cc8890c195e72673091e3679bd51b332d6068d71c5d682d7fcc6b28bce4658f8ed947de1208047b8de2a37a77e4fac0715
+  metadata.gz: 0cf34a058eeb298b8ed33ed6a766d8e24367317194cda8e5151477ec47a44c4588705cf75b282224ca4d6eaacd509e58edbe2a138f2dd134a14148f9cedeefc8
+  data.tar.gz: 3d93821f75f88cded4e5a16d48c1ecf13ae71a8bcb8d37ed8792d4333608d24f59f57e18eeb158b3cc293078e25ce5798bc6db3afc1e7eddb06a49397760f8e9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.13.2)
+    brief (1.14.0)
       activesupport (> 3.2)
       commander (~> 4.3)
       em-websocket (~> 0.5)
@@ -121,3 +121,6 @@ DEPENDENCIES
   rack-test (~> 0.6)
   rake (~> 0)
   rspec (~> 3.0)
+
+BUNDLED WITH
+   1.10.4

data/lib/brief/document/structure.rb

@@ -32,18 +32,57 @@ module Brief
     end
 
     def prescan
+      set_markings_on_headers
+      assign_id_attributes_to_pre_tags
+    end
+
+    def assign_id_attributes_to_pre_tags
+      pres = fragment.css('pre[lang]')
+
+      pres.each do |pre|
+        lang = pre.attr('lang')
+
+        if match_data = lang.match(/\((\w+)\)/)
+          pre.set_attribute 'id', match_data.captures.first
+          pre.set_attribute 'lang', lang.gsub(/\((\w+)\)/,'')
+        end
+      end
+    end
+
+    def set_markings_on_headers
       content_lines.each_with_index do |line, index|
         if line.match(/^#/)
-          line = line.strip
-          level = line.count('#')
-          text = line.gsub('#', '').strip
+          line    = line.strip
+          level   = line.count('#')
+          text    = line.gsub('#', '').strip
 
           if level > 0 && text.length > 0
             line_number = index + 1
+
             heading = find_heading_by(level, text)
 
+            # If it is a heading element, we map it to a line number in
+            # the content that produced it. We also look for the special
+            # syntax {attribute: value; other-attribute: value} which
+            # lets us set attributes on the header
             if heading
-              heading.element.set_attribute('data-line-number', line_number)
+              set_attributes = {"data-line-number" => line_number}
+
+              if attribute_matchers = line.match(/\{(.*)\}/)
+                attributes = attribute_matchers.captures.first.strip
+                attributes.split(';').each do |pair|
+                  key, value = pair.split(':')
+                  set_attributes[key.to_s.strip] = value.to_s.strip
+                end
+
+                value = heading.element.text.to_s.split(/\{.*\}/).join("").strip
+                heading.element.inner_html = value
+                heading.element.set_attribute('data-heading', value)
+              end
+
+              set_attributes.each do |k,v|
+                heading.element.set_attribute(k, v)
+              end
             end
           end
         end
@@ -163,6 +202,10 @@ module Brief
       end
     end
 
+    def find_pre_by_lang(lang)
+      fragment.css("pre[lang='#{lang}']").first
+    end
+
     def find_heading_by(level, heading)
       heading_elements.find do |el|
         el.level.to_s == level.to_s && heading.to_s.strip == el.heading.to_s.strip

data/lib/brief/document.rb

@@ -292,6 +292,8 @@ module Brief
       @parser ||= begin
                     structure.prescan
 
+                    structure.assign_id_attributes_to_pre_tags
+
                     structure.create_wrappers.tap do |f|
                       transformer_for(f).all
                     end

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.13.2'
+  VERSION = '1.14.0'
 end

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

@@ -1,6 +1,6 @@
 ---
 type: concept
-needle: bw3bg25pgdk1dmlcc0i7vgfx8azujn0k7p17
+needle: i5wt25dv3tug69u5at7k0mrd8buy41lbeub9
 ---
 
-# Modified Content v4lk5hmstxxb5abwdg1txe5utwwasdwhdhid
+# Modified Content ponsmqgjrpttz2wxpszae6nfsapnqucwow3b

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

@@ -3,3 +3,13 @@ type: persona
 title: Blueprint Persona Example
 subheading: A description of a typical user of the software 
 ---
+
+# Blueprint Persona Example
+
+## Random Heading {id: randoms; data-random-attr: value}
+
+what up son?
+
+```yaml(rando)
+setting: value
+```

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

@@ -0,0 +1,8 @@
+class Brief::Persona
+  include Brief::Model
+
+  content do
+    msg "[data-random-attr='value']"
+    rando "#rando pre[lang='yaml'] code", :serialize => :yaml
+  end
+end

data/spec/lib/brief/dom_attribute_assignment_spec.rb

@@ -0,0 +1,18 @@
+require "spec_helper"
+
+describe "DOM Attribute Assignment" do
+  let(:doc) { Brief.persona_document  }
+  let(:model) { doc.to_model }
+
+  it "should make targeting elements easier" do
+    binding.pry
+  end
+
+  it "should assign attributes to the headings" do
+    expect(doc.css('[data-random-attr="value"]').length).to eq(1)
+  end
+
+  it "should not include the attribute syntax in the text" do
+    expect(doc.css('h2').text).to eq('Random Heading')
+  end
+end

data/spec/spec_helper.rb

@@ -18,6 +18,12 @@ module Brief
     testcase.document_at(path)
   end
 
+  def self.persona_document
+    path = Brief.example_path.join("docs","persona.html.md")
+    testcase.document_at(path)
+  end
+
+
   def self.page_document
     path = Brief.example_path.join("docs","page.html.md")
     testcase.document_at(path)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.13.2
+  version: 1.14.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -443,6 +443,7 @@ files:
 - spec/fixtures/example/models/concept.rb
 - spec/fixtures/example/models/epic.rb
 - spec/fixtures/example/models/page.rb
+- spec/fixtures/example/models/persona.rb
 - spec/fixtures/example/settings.yml
 - spec/fixtures/example/templates/user_story.md.erb
 - spec/fixtures/structures/one.html.md
@@ -454,6 +455,7 @@ files:
 - spec/lib/brief/content_transformation_spec.rb
 - spec/lib/brief/data_spec.rb
 - spec/lib/brief/document_spec.rb
+- spec/lib/brief/dom_attribute_assignment_spec.rb
 - spec/lib/brief/dsl_spec.rb
 - spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
@@ -541,6 +543,7 @@ test_files:
 - spec/fixtures/example/models/concept.rb
 - spec/fixtures/example/models/epic.rb
 - spec/fixtures/example/models/page.rb
+- spec/fixtures/example/models/persona.rb
 - spec/fixtures/example/settings.yml
 - spec/fixtures/example/templates/user_story.md.erb
 - spec/fixtures/structures/one.html.md
@@ -552,6 +555,7 @@ test_files:
 - spec/lib/brief/content_transformation_spec.rb
 - spec/lib/brief/data_spec.rb
 - spec/lib/brief/document_spec.rb
+- spec/lib/brief/dom_attribute_assignment_spec.rb
 - spec/lib/brief/dsl_spec.rb
 - spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb