brief 1.12.9 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e029139c4d4b69a786ce3fc4c93710cae1e67af4
-  data.tar.gz: 6fae60ab3d35eb214cca44e2a5d10b5a360cd989
+  metadata.gz: d3968688e5ae49cef9636811719c29cc5c1daf89
+  data.tar.gz: 5da2122fc2a71f3878370db8ee26feba3fde0330
 SHA512:
-  metadata.gz: 97f4ea6389de3ac57a42765ba49852f045188ab2fc87bd022506bcd69df808c938961c098bdb1bdf7c3385e5d1a525af8438f947dd91567d645756c61f4bca71
-  data.tar.gz: 2ea9f5d4cbb2d3c20daae79344dccbe891eeb5e138b2331cc010464e661612134dd67ff4d49816dfbed3a5aa1c029f5311d72fb59d988f0e94429de0cbfd1f2a
+  metadata.gz: f7cab87cbc755465bf708e72ba6da50bbb171dd15293e6eb0c1939f137668e058d6db04d227f1cc51a39f53a30e70e8041e46dce863aa1045a1fdc85ef52e11b
+  data.tar.gz: 27650f973ec79d0e9ea9299d2b54379c1ab90f3a5dfdb12e8383c9fe80215ff22d95e36c444186f9a75443cdaeec90b086f7bbd580b9011fec834f113dd7c355

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.12.9)
+    brief (1.13.1)
       activesupport (> 3.2)
       commander (~> 4.3)
       em-websocket (~> 0.5)
@@ -30,9 +30,12 @@ GEM
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
+    byebug (5.0.0)
+      columnize (= 0.9.0)
     coderay (1.1.0)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
+    columnize (0.9.0)
     commander (4.3.4)
       highline (~> 1.7.2)
     daemons (1.2.2)
@@ -112,6 +115,7 @@ PLATFORMS
 DEPENDENCIES
   brief!
   bundler (~> 1.3)
+  byebug (~> 5.0.0)
   octokit (~> 3.0)
   pry (~> 0.10)
   rack-test (~> 0.6)

data/apps/blueprint/extensions/middleman.rb

@@ -0,0 +1,52 @@
+class Brief::Apps
+  class Blueprint::MiddlemanExtension < ::Middleman::Extension
+
+    option :blueprint_root, nil, 'Which path to use for the blueprint?'
+
+    def initialize(app, options_hash = {}, &block)
+      super
+
+      app.set(:blueprint_root, options_hash.fetch(:blueprint_root) { ENV['BLUEPRINT_ROOT'] || "./blueprint" })
+
+      # import the blueprint assets into the sprockets path
+      app.ready do
+        logger.info "== Adding blueprint assets to sprockets paths"
+        patterns = [
+          '.png',  '.gif', '.jpg', '.jpeg', '.svg', # Images
+          '.eot',  '.otf', '.svc', '.woff', '.ttf', # Fonts
+          '.js',                                    # Javascript
+        ].map { |e| File.join(blueprint.assets_path, "**", "*#{e}" ) }
+
+        sprockets.prepend_path(blueprint.assets_path)
+
+        patterns.map! {|p| Dir[p] }
+        patterns.flatten!
+
+        patterns.each do |f|
+          sprockets.import_asset(Pathname.new(f).relative_path_from(Pathname.new(blueprint.assets_path)))
+        end
+      end
+    end
+
+    helpers do
+      def blueprint_model_groups
+        blueprint.model_classes.map {|m| m.name.to_s.pluralize }
+      end
+
+      def blueprint
+        return @blueprint if @blueprint && !development?
+
+        @blueprint = get_briefcase.tap do |b|
+          b.href_builder = ->(uri) {uri = uri.to_s; uri.gsub('brief://','').gsub(/\.\w+$/,'.html').gsub(b.docs_path.to_s,'') }
+          b.asset_finder = ->(asset) { needle = asset.relative_path_from(b.assets_path).to_s; image_path(needle) }
+        end
+      end
+
+      def get_briefcase
+        Brief::Briefcase.new(root: blueprint_root, caching: !development?)
+      end
+    end
+  end
+end if defined?(::Middleman)
+
+::Middleman::Extensions.register(:blueprint, Brief::Apps::Blueprint::MiddlemanExtension) if defined?(::Middleman)

data/brief.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 0"
   spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "byebug", "~> 5.0.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rack-test", "~> 0.6"
   spec.add_development_dependency 'octokit', "~> 3.0"

data/lib/brief/cli/write.rb

@@ -12,17 +12,17 @@ command 'write' do |c|
 
     model_class = briefcase.model_classes.find {|c| c.type_alias == type_alias }
 
-    if !model_class.nil?
-      content = ask_editor model_class.writing_prompt()
-    else
+    content = if model_class.nil?
       model_class = briefcase.schema_map.fetch(type_alias, nil)
-      content = ask_editor(model_class.example)
+      ask_editor(model_class.example)
+    else
+      ask_editor(model_class.new_doc_template)
     end
 
     raise "Inavlid model class. Run the schema command to see what is available." if model_class.nil?
 
 
-    file = ask("Enter a filename")
+    file = ask("Enter a filename: ") { |q| q.default = model_class.new_doc_name }
 
     if file.to_s.length == 0
       rand_token = rand(36**36).to_s(36).slice(0,3)

data/lib/brief/model.rb

@@ -319,10 +319,24 @@ 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_content
+      def new_doc_template(&block)
+        if block
+          definition.new_doc_template_block = block
+        elsif definition.new_doc_template_block
+          definition.new_doc_template_block.call
+        else
+          example_content
+        end
+      end
+
+      def new_doc_name(&block)
+        if block
+          definition.new_doc_name_block = block
+        elsif definition.new_doc_name_block
+          definition.new_doc_name_block.call
+        else
+          "#{ self.type_alias }-#{ DateTime.now.strftime("%Y-%m-%d") }.md"
+        end
       end
 
       def documentation(*args)
@@ -352,7 +366,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 prompt).include?(meth.to_s)
+        if %w(meta content template example actions helpers).include?(meth.to_s)
           definition.send(meth, *args, &block)
           finalize
         elsif %w(defined_helper_methods defined_actions).include?(meth.to_s)

data/lib/brief/model/definition.rb

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

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.12.9'
+  VERSION = '1.13.1'
 end

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

@@ -12,7 +12,11 @@ class Brief::Concept
     title "h1:first-of-type"
   end
 
-  prompt do
-    "asdf"
+  new_doc_template do
+    "The concept new doc template"
+  end
+
+  new_doc_name do
+    "somecustomname.md"
   end
 end

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

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe "The Page Document Type" do
+  let(:page) { Brief.page_document.model_class }
+  let(:concept) { Brief::Concept }
+
+  it "should have some example content" do
+    expect(page.example_content).not_to be_empty
+  end
+
+  it "should return the example because there's no new_doc_template defined" do
+    expect(page.new_doc_template).to eq page.example_content
+  end
+
+  it "should return whatever is defined in the new_doc_template dsl" do
+    expect(concept.new_doc_template).to eq "The concept new doc template"
+  end
+
+  it "should return the default document name because there's no new_doc_name defined" do
+    expect(page.new_doc_name).to eq "page-2015-06-17.md"
+  end
+
+  it "should return the new document name if new_doc_name is defined" do
+    expect(concept.new_doc_name).to eq "somecustomname.md"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.12.9
+  version: 1.13.1
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-17 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -234,6 +234,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -328,6 +342,7 @@ files:
 - apps/blueprint/examples/roadmap.md
 - apps/blueprint/examples/sitemap.md
 - apps/blueprint/examples/wireframe.md
+- apps/blueprint/extensions/middleman.rb
 - apps/blueprint/models/concept.rb
 - apps/blueprint/models/diagram.rb
 - apps/blueprint/models/epic.rb
@@ -443,9 +458,9 @@ files:
 - spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
 - spec/lib/brief/models/diagram_spec.rb
+- spec/lib/brief/models/new_doc_content_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
@@ -541,9 +556,9 @@ test_files:
 - spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
 - spec/lib/brief/models/diagram_spec.rb
+- spec/lib/brief/models/new_doc_content_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

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

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