brief 1.8.11 → 1.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3de7498537562e1af987a1dde8f953ac597e43bf
-  data.tar.gz: 485d59167686ab6a22fc7c21692e6c0fdb55dcee
+  metadata.gz: 2c387f19c8ad49a0779cebe811c4bf7036400381
+  data.tar.gz: 60106d90ac046020fa178b28881ea88af8e672ba
 SHA512:
-  metadata.gz: 602e813382b61bb65234e80162d2cc02dbce676e11529b2b9e89471f0a4486c481907482bc7d9e12310da18303b88a77f4f343e422524d4f6f3a881bbfab4a88
-  data.tar.gz: 72737aded296ed97a129db549f5a46d19e08428373a2434cab50094df9fd5c5a4982909a70d692ea984691c710f3a30f514be147cb42f7ee6c06a05a37e7b7bd
+  metadata.gz: 4a0f50b0dc77533e07e03b15e644e117856aba281fdf272a0d947175a59b2170162785c8eac04345cf528a8e0b0776839cd65dd7f851f3e018cafb45cbda4904
+  data.tar.gz: 7451362423fef638486fb758d03ca6818e6d82f8d291b29fa8ace319e192955ac1cd3de14d029db3c0a7e44956c4a68d703212fb748f07584721244973eedf6c

data/.gitignore

@@ -1,4 +1,3 @@
-spec/fixtures/example/docs/concept.html.md
 tests/middleman/build
 distro/
 pkg/

data/Gemfile.lock

@@ -1,8 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.8.10)
-      activemodel
+    brief (1.8.12)
       activesupport (>= 4.0)
       commander (>= 4.2.1)
       github-fs
@@ -15,9 +14,6 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.1)
-      activesupport (= 4.2.1)
-      builder (~> 3.1)
     activesupport (4.2.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
@@ -29,7 +25,6 @@ GEM
       descendants_tracker (~> 0.0.4)
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
-    builder (3.2.2)
     coderay (1.1.0)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)

data/README.md

@@ -1,4 +1,6 @@
 # Brief 
+[![Build
+Status](https://travis-ci.org/datapimp/brief.svg?branch=master)](https://travis-ci.org/datapimp/brief)
 
 Brief is a tool for building applications on top of collections of
 documents written in markdown.  

data/apps/blueprint/config.rb

@@ -8,3 +8,10 @@ view(:summary) do |*args|
     end
   end
 end
+
+view(:table_of_contents) do |*args|
+  briefcase = args.first
+
+  doc = Brief::Document.new(briefcase.docs_path.join("index.md"), document_type: "outline")
+  doc && doc.to_model
+end

data/brief.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'github-fs'
   spec.add_dependency 'virtus', '>= 1.0.3'
   spec.add_dependency 'inflecto'
-  spec.add_dependency 'activemodel'
+  #spec.add_dependency 'activemodel'
   spec.add_dependency 'activesupport', '>= 4.0'
   spec.add_dependency 'nokogiri', '1.6.5'
 

data/lib/brief/briefcase.rb

@@ -33,14 +33,6 @@ module Brief
       "#{slug}:#{repository.cache_key}"
     end
 
-    def table_of_contents
-      table_of_contents_document.to_model
-    end
-
-    def table_of_contents_document
-      Brief::Document.new(docs_path.join("index.md"), document_type: "outline")
-    end
-
     def slug
       options.fetch(:slug) { root.basename.to_s.parameterize }
     end
@@ -97,7 +89,7 @@ module Brief
     def schema_map(include_all=false)
       list = include_all ? Brief::Model.classes : model_classes
       list.map(&:to_schema)
-        .reduce({}) {|m, k| m[k[:type_alias]] = k; m }
+        .reduce({}.to_mash) {|m, k| m[k[:type_alias]] = k; m }
     end
 
     def data

data/lib/brief/cli/01_extensions.rb

@@ -1,3 +1,16 @@
+class Commander::Command
+  def action(*args, &block)
+    Brief.default_cli_options(self)
+
+    when_called do |args, options|
+      options.default(root: Brief.pwd)
+      Brief.case = Brief::Briefcase.new(root: Pathname(options.root))
+
+      block.call(args, options)
+    end
+  end
+end
+
 module Brief
   def self.cli_action(c, &block)
     c.action do |args, options|

data/lib/brief/cli/write.rb

@@ -2,22 +2,32 @@ command 'write' do |c|
   c.syntax = 'brief write MODEL_TYPE [OPTIONS]'
   c.description = 'Create a new document for a given model type'
 
-  c.action do |args, _options|
-    string_args = args.select { |a| a.is_a?(String) }
-    model_class = Brief::Model.lookup_class_from_args(string_args)
+  c.action do |args, options|
+    schema_map = Brief.case.schema_map(true)
+    type_alias = args.first
 
-    base_content = ''
+    model_class = schema_map.fetch(type_alias) do
+      raise "Unknown model type: #{ type_alias }. Available types are: #{ schema_map.keys.join(',') }"
+    end
+
+    default_example = "---\ntype:#{type_alias}\n---\n\n# Enter some content"
+
+    content = ask_editor(model_class.to_mash.example || default_example)
 
-    if model_class && model_class.example_body.to_s.length > 0
-      base_content = model_class.example_body
-    else
-      # document_contents = model_class.inspect + model_class.example_body.to_s
+    file = ask("Enter a filename")
+
+    if file.to_s.length == 0
+      rand_token = rand(36**36).to_s(36).slice(0,6)
+      file = "new-#{ type_alias }-#{ rand_token }.md"
     end
 
-    document_contents = ask_editor(base_content)
-    file = ask('enter a name for this file:', String)
+    folder = Brief.case.docs_path.join(type_alias.pluralize)
+    folder = folder.exist? ? folder : Brief.case.docs_path
+
+    folder.join(file).open("w+") do |fh|
+      fh.write(content)
+    end
 
-    puts file
-    puts document_contents
+    puts "== Successfully created #{ folder.join(file) }"
   end
 end

data/lib/brief/document.rb

@@ -121,6 +121,23 @@ module Brief
       (@briefcase_root && Brief.cases[@briefcase_root]) || Brief.case
     end
 
+    def has_sections?
+      model_class.section_mappings.length > 0
+    end
+
+    def section_headings
+      sections.keys
+    end
+
+    def sections_data
+      section_headings.reduce({}) do |memo, heading|
+        section = sections.send(heading)
+        items = section.items rescue nil
+        memo[heading] = items if items
+        memo
+      end
+    end
+
     def sections
       mappings = model_class.section_mappings
 

data/lib/brief/model/serializers.rb

@@ -21,6 +21,8 @@ module Brief::Model::Serializers
       updated_at: File.mtime(path).to_i,
       id: Digest::MD5.hexdigest(path.to_s),
       hash: file_hash,
+      sections: {},
+      section_headings: [],
       urls: {
         view_content_url: "/view/content/#{ doc_path }",
         view_rendered_url: "/view/rendered/#{ doc_path }",
@@ -33,6 +35,11 @@ module Brief::Model::Serializers
     }.tap do |h|
       h[:content] = document.combined_data_and_content if options[:content]
       h[:rendered] = document.to_html if options[:rendered]
+    end.tap do |h|
+      if document.has_sections?
+        h[:section_headings] = document.section_headings
+        h[:sections] = document.sections_data
+      end
     end
   end
 end

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.8.11'
+  VERSION = '1.8.12'
 end

data/spec/fixtures/example/brief.rb

@@ -3,6 +3,11 @@ config do
   set(:templates => Pathname(File.dirname(__FILE__)).join("templates"))
 end
 
+view :table_of_contents do
+  doc = Brief::Document.new(docs_path.join("index.md"), document_type: "outline")
+  doc && doc.to_model
+end
+
 view :custom_aggregator do
   {aggregator:"custom"}
 end

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

@@ -0,0 +1,10 @@
+---
+type: concept
+
+---
+
+# Modified Content sorqvyr5bygiotiqfp2jnj3ku0k240xhv8uf
+
+1
+
+1

data/spec/lib/brief/document_spec.rb

@@ -54,6 +54,18 @@ describe "The Brief Document" do
   end
 
   context "defining sections" do
+    it "has sections" do
+      expect(sample).to be_has_sections
+    end
+
+    it "gives me info about the section headings" do
+      expect(sample.section_headings).to include("user_stories")
+    end
+
+    it "has the information from the sections" do
+      expect(sample.sections_data).not_to be_empty
+    end
+
     it "lets me define content sections" do
       expect(sample.sections).not_to be_empty
       expect(sample.sections.user_stories).to be_present

data/spec/lib/brief/repository_spec.rb

@@ -26,12 +26,12 @@ describe "The Brief Document Repository" do
     end
 
     it "finds the first document matching a query" do
-      query = repository.where(state:"active")
+      query = repository.where(state:"active", type: "epic")
       expect(query.first.type).to eq("epic")
     end
 
     it "finds the last document matching a query" do
-      query = repository.where(state:"active")
+      query = repository.where(state:"active", type:"user_story")
       expect(query.last.type).to eq("user_story")
     end
 

data/spec/spec_helper.rb

@@ -37,6 +37,10 @@ RSpec.configure do |config|
   config.mock_with :rspec
   config.include Rack::Test::Methods
   config.include TestHelpers
+
+  config.after(:suite) do
+    `git checkout spec/fixtures/example/docs` rescue nil
+  end
 end
 
 ENV['BRIEF_APPS_PATH'] = Brief.spec_root.join("fixtures","apps").to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.8.11
+  version: 1.8.12
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-28 00:00:00.000000000 Z
+date: 2015-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement