brief 1.11.10 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05aa8958fb9aa8dd12bce798c8aa606b372e9ddb
-  data.tar.gz: 39193fddf1af3048a2208be447518d587bfde131
+  metadata.gz: 7d3a25a4f211d9862e3c879242f4e83b92adc4ba
+  data.tar.gz: b418898c05d11d75bf7c50fb3e17dc72816cfa81
 SHA512:
-  metadata.gz: 7bf1ba3cc48969be2e07a589f7d12d26d4d6bbc5b4e36011b9b52bda9a542f1994504419c533f4ecc54b1edfa6a3bf82051a0216276c2ee6ae7e6ed6d64f397a
-  data.tar.gz: 48c8a6cd07a18b573a7e8bfa7efe668b43520a190eb86f24aa00188e27293faf75f36858b4fa6df4bfb1b6c678f81f947e61d43502d78d299071085c60a5e79f
+  metadata.gz: 47ebd49ce1aabf8eacaa33b9eee6fc14c33f46df37018b72e2f37f79aef07670bdc21bd7282bf6f66c3c4f6fb2a5929991361489c0b9d27f990608b0c06f31b7
+  data.tar.gz: d75ef3692fbf0b5a6f1139a6dba427f2f3047435275d7d9a64b2e770bd950440dc6a591317798443a20b3eafa6f24c403aab17a61f18dc1e9e5f15f1c6055304

data/Gemfile.lock

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

data/lib/brief/cli/write.rb

@@ -6,37 +6,27 @@ command 'write' do |c|
   # We could potential query the available model classes we are aware of
   # and determine which CLI arguments those model classes may ask for.
   c.action do |args, options|
-    schema_map = Brief.case(true).schema_map(true)
+    options.default(root: Pathname(Brief.pwd))
+    briefcase = Brief.case = Brief::Briefcase.new(root: Pathname(args.first || options.root))
+    schema_map = briefcase.schema_map(true)
+
     type_alias = args.first
 
     model_class = schema_map.fetch(type_alias) do
       raise "Unknown model type: #{ type_alias }. Available types are: #{ schema_map.keys.join(',') }"
     end
 
-    # TODO
-    #
-    # We need to determine the initial content that gets put into the editor.
-    #
-    # Our options are:
-    #
-    # - use an example from the model, if one exists
-    # - deduce the content to use based on some combination of one or more of the items below:
-    #   - specifics of the model
-    #   - the state of the documents that exist for that model already
-    #   - the arguments from the CLI
-    default_example = "---\ntype:#{type_alias}\n---\n\n# Enter some content"
-
-    content = ask_editor(model_class.to_mash.example || default_example)
+    content = ask_editor model_class.writing_prompt()
 
     file = ask("Enter a filename")
 
     if file.to_s.length == 0
-      rand_token = rand(36**36).to_s(36).slice(0,6)
+      rand_token = rand(36**36).to_s(36).slice(0,3)
       file = "new-#{ type_alias }-#{ rand_token }.md"
     end
 
-    folder = Brief.case(true).docs_path.join(type_alias.pluralize)
-    folder = folder.exist? ? folder : Brief.case.docs_path
+    folder = briefcase.docs_path.join(type_alias.pluralize)
+    folder = folder.exist? ? folder : briefcase.docs_path
 
     folder.join(file).open("w+") do |fh|
       fh.write(content)

data/lib/brief/model/definition.rb

@@ -10,6 +10,7 @@ module Brief
                   :section_mappings,
                   :template_body,
                   :example_body,
+                  :_prompt,
                   :documentation_path,
                   :example_path,
                   :template_path
@@ -117,6 +118,10 @@ module Brief
       end
     end
 
+    def prompt(&block)
+      self._prompt = block
+    end
+
     def has_actions?
       self.defined_actions.empty?
     end

data/lib/brief/model.rb

@@ -319,6 +319,12 @@ module Brief
         definition.send(:example_body, *args).to_s.strip
       end
 
+      def writing_prompt(*args)
+        _prompt = definition._prompt
+        return _prompt.call(*args) if _prompt && _prompt.respond_to?(:call)
+        example_body
+      end
+
       def documentation(*args)
         definition.send(:documentation, *args)
       end
@@ -346,7 +352,7 @@ module Brief
         # these methods have a special effect on the behavior of the
         # model definition.  we need to make sure we call finalize after
         # them
-        if %w(meta content template example actions helpers).include?(meth.to_s)
+        if %w(meta content template example actions helpers prompt).include?(meth.to_s)
           definition.send(meth, *args, &block)
           finalize
         elsif %w(defined_helper_methods defined_actions).include?(meth.to_s)

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.11.10'
+  VERSION = '1.12.0'
 end

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

@@ -11,4 +11,8 @@ class Brief::Concept
   content do
     title "h1:first-of-type"
   end
+
+  prompt do
+    "asdf"
+  end
 end

data/spec/lib/brief/models/page_spec.rb

@@ -15,6 +15,5 @@ describe "The Page Document Type" do
     expect(page.extracted_content_data.title).to eq("Summary")
     expect(page.extracted_content_data.paragraph).not_to be_nil
   end
-
 end
 

data/spec/lib/brief/models/writing_prompt_spec.rb

@@ -0,0 +1,14 @@
+require "spec_helper"
+
+describe "The Page Document Type" do
+  let(:page) { Brief.page_document.model_class }
+  let(:concept) { Brief::Concept }
+
+  it "should return the example because there's no prompt defined" do
+    expect(page.writing_prompt).to eq page.example_body
+  end
+
+  it "should return whatever is defined in the prompt dsl" do
+    expect(concept.writing_prompt).to eq "asdf"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.11.10
+  version: 1.12.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-14 00:00:00.000000000 Z
+date: 2015-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -445,6 +445,7 @@ files:
 - spec/lib/brief/models/diagram_spec.rb
 - spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/models/release_spec.rb
+- spec/lib/brief/models/writing_prompt_spec.rb
 - spec/lib/brief/persistence_spec.rb
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb
@@ -542,6 +543,7 @@ test_files:
 - spec/lib/brief/models/diagram_spec.rb
 - spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/models/release_spec.rb
+- spec/lib/brief/models/writing_prompt_spec.rb
 - spec/lib/brief/persistence_spec.rb
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb