brief 1.8.2 → 1.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 212044b48f259296e12c057ec7d87d9e04b3d238
-  data.tar.gz: edea3d30a403388bdb0c47bdedc9074464a00c5a
+  metadata.gz: be0eef8f655a9b9d5ebe02b3b718ddc36d380bb5
+  data.tar.gz: 2926731279f53b37faa4c905839fca50df24673b
 SHA512:
-  metadata.gz: 8539037809b1f7ee53c640b2443fb5803c4e45a512845b2f7551d9991725257c891c49afa585d6c664b946730bc0b8b5b85ed0ee09d43bd6ac3a29913d64b26b
-  data.tar.gz: 1950386d35ab9f66e60dce58d1998b0166973c15dd957c8c77e4bbe55a21d198c040eee95bc3601cecac6abc887e8ce19dce62320b20cd530ea3da6d499eaac8
+  metadata.gz: 088bf02d1b3cb7399e8a43729da51bb7a42be252ecce8c2ccf704f6e467d00c206d7dcdab579711642bcda7459c3cde624ba8c1007792ce8a2fc643e13d83fe3
+  data.tar.gz: 3e694d6d1114e770ad4792f6e6b685b502340b5d7a8d594213447c0154630e5851184b88624f81fdd4cff4f08c68e1931e3bb46376dc1e131c40d0ea1b4f7ae5

data/CHANGELOG.md

@@ -125,3 +125,7 @@ attributes.
 ### 1.6.0
   - Introducing the apps repository for shared model code
   - Added capability to pull out yaml blocks from the document as deserialized hashes on our models
+
+### 1.8.3
+  - General improvements to models & documents api
+  - Added support for cache key 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.8.2)
+    brief (1.8.3)
       activemodel
       activesupport (>= 4.0)
       commander (>= 4.2.1)
@@ -89,7 +89,7 @@ GEM
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    virtus (1.0.4)
+    virtus (1.0.5)
       axiom-types (~> 0.1)
       coercible (~> 1.0)
       descendants_tracker (~> 0.0, >= 0.0.3)

data/apps/blueprint/models/diagram.rb

@@ -0,0 +1,22 @@
+class Brief::Apps::Blueprint::Diagram
+  include Brief::Model
+
+  meta do
+    title
+    subheading
+    status String, :in => "draft published"
+  end
+
+  content do
+    title "h1:first-of-type"
+
+    subheading "h2:first-of-type"
+
+    define_section "Annotations" do
+      each("h2").has(:title => "h3",
+                     :paragraphs => "p",
+                     :settings => "code")
+    end
+  end
+end
+

data/apps/blueprint/models/milestone.rb

@@ -0,0 +1,16 @@
+class Brief::Apps::Blueprint::Milestones
+  include Brief::Model
+
+  meta do
+    title
+    number
+    due_date
+  end
+
+  content do
+    title "h1:first-of-type", :hide => true
+    paragraph "p:first-of-type"
+    paragraphs "p"
+    yaml_data "code.yaml:first-of-type", :serialize => :yaml, :hide => true
+  end
+end

data/apps/blueprint/models/project.rb

@@ -0,0 +1,16 @@
+class Brief::Apps::Blueprint::Project
+  include Brief::Model
+
+  meta do
+    title
+    category
+    tags Array
+  end
+
+  content do
+    paragraph "p:first-of-type"
+    title "h1:first-of-type", :hide => true
+    tagline "h2:first-of-type", :hide => true
+    yaml_data "code.yaml:first-of-type", :serialize => :yaml, :hide => true
+  end
+end

data/apps/blueprint/models/release.rb

@@ -0,0 +1,24 @@
+class Brief::Apps::Blueprint::Release
+  include Brief::Model
+
+  meta do
+    title
+    status
+    tags Array
+  end
+
+  content do
+    paragraph "p:first-of-type"
+    paragraps "p"
+    title "h1:first-of-type", :hide => true
+    tagline "h2:first-of-type", :hide => true
+    yaml_data "code.yaml:first-of-type", :serialize => :yaml, :hide => true
+
+    define_section "User Stories" do
+      each("h2").has(:title     => "h2",
+                     :paragraph => "p:first-of-type",
+                     :components   => "p:first-of-type strong"
+                    )
+    end
+  end
+end

data/lib/brief/briefcase.rb

@@ -29,6 +29,14 @@ module Brief
       end
     end
 
+    def cache_key
+      "#{slug}:#{repository.cache_key}"
+    end
+
+    def slug
+      options.fetch(:slug) { root.basename.to_s.parameterize }
+    end
+
     def settings
       @settings ||= settings!
     end
@@ -64,7 +72,8 @@ module Brief
         name: briefcase.folder_name.to_s.titlecase,
         schema: schema,
         models: models,
-        settings: settings
+        settings: settings,
+        cache_key: briefcase.cache_key
       }
     end
 

data/lib/brief/cli/export.rb

@@ -12,10 +12,10 @@ command 'export' do |c|
 
     briefcase = Brief::Briefcase.new(config_path: Pathname(options.config_path))
 
-    json = briefcase.present("default", content: !!options.include_content, rendered: !!options.include_rendered)
+    dump = briefcase.as_full_export()
 
-    output = args.first || "briefcase.json"
+    output = args.first || "#{ briefcase.cache_key }.json"
 
-    Pathname(Dir.pwd).join(output).open("w+") {|fh| fh.write(json.to_json) }
+    Pathname(Dir.pwd).join(output).open("w+") {|fh| fh.write(dump.to_json) }
   end
 end

data/lib/brief/repository.rb

@@ -16,6 +16,10 @@ module Brief
       load_documents
     end
 
+    def cache_key
+      "#{documents.count}-#{documents.map {|d| d.path.mtime.to_i }.max}"
+    end
+
     def respond_to?(meth)
       super || model_groups.include?(meth.to_s)
     end

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.8.2'
+  VERSION = '1.8.3'
 end

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

@@ -3,7 +3,7 @@ type: concept
 
 ---
 
-# Modified Content pdgvx3vvbqibhn1sqgljkllwgjnog1io7rkl
+# Modified Content nafl3xeddhzqwa9mev1me356ijxighwm1jg1
 
 1
 

data/spec/lib/brief/briefcase_spec.rb

@@ -7,6 +7,14 @@ describe "The Briefcase" do
     expect(briefcase.root).to be_exist
   end
 
+  it "has a cache key" do
+    expect(briefcase.cache_key).not_to be_nil
+  end
+
+  it "has a slug" do
+    expect(briefcase.slug).to eq("example")
+  end
+
   it "points to a file repository" do
     expect(briefcase.repository).to be_a(Brief::Repository)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.3
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -238,9 +238,13 @@ files:
 - Rakefile
 - TUTORIAL.md
 - apps/blueprint/config.rb
+- apps/blueprint/models/diagram.rb
 - apps/blueprint/models/epic.rb
+- apps/blueprint/models/milestone.rb
 - apps/blueprint/models/page.rb
 - apps/blueprint/models/persona.rb
+- apps/blueprint/models/project.rb
+- apps/blueprint/models/release.rb
 - apps/blueprint/models/user_story.rb
 - apps/blueprint/models/wireframe.rb
 - bin/brief
@@ -320,6 +324,7 @@ files:
 - spec/lib/brief/dsl_spec.rb
 - spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
+- spec/lib/brief/models/diagram_spec.rb
 - spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/models/release_spec.rb
 - spec/lib/brief/persistence_spec.rb
@@ -399,6 +404,7 @@ test_files:
 - spec/lib/brief/dsl_spec.rb
 - spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
+- spec/lib/brief/models/diagram_spec.rb
 - spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/models/release_spec.rb
 - spec/lib/brief/persistence_spec.rb