brief 1.8.12 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c387f19c8ad49a0779cebe811c4bf7036400381
-  data.tar.gz: 60106d90ac046020fa178b28881ea88af8e672ba
+  metadata.gz: b2be8fb315c30c8b5534ffa5b215a5f3ae058fb7
+  data.tar.gz: aaaedeffe0b34d86a724ed4d25dc9cccdbaa712a
 SHA512:
-  metadata.gz: 4a0f50b0dc77533e07e03b15e644e117856aba281fdf272a0d947175a59b2170162785c8eac04345cf528a8e0b0776839cd65dd7f851f3e018cafb45cbda4904
-  data.tar.gz: 7451362423fef638486fb758d03ca6818e6d82f8d291b29fa8ace319e192955ac1cd3de14d029db3c0a7e44956c4a68d703212fb748f07584721244973eedf6c
+  metadata.gz: 111d44be6dcd95672ccf28adb0149cfa2cc41691f057ce557ce0b18572ce2fe9f124f60f0f0bc5fa89b73ca0a472099aab66d07aa13049ec140fc5a79e803ca4
+  data.tar.gz: 2b5401b3ed0b66b01bc33c100388a0ad911a0e4c5f0a8bcffe44af039ba8ea43a72140619dc7aab5d676040026d65aca0814c7c6a9786ea2768edb4e2d3ba347

data/CHANGELOG.md

@@ -129,3 +129,8 @@ attributes.
 ### 1.8.3
   - General improvements to models & documents api
   - Added support for cache key 
+
+### 1.9.0
+  - Cleaned up some implementations
+  - Fully implemented the command set
+  - CLI can be used to generate JSON data

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.8.12)
+    brief (1.9.0)
       activesupport (>= 4.0)
       commander (>= 4.2.1)
       github-fs

data/apps/blueprint/config.rb

@@ -4,14 +4,22 @@ view(:summary) do |*args|
 
   briefcase.present(:default, params).tap do |hash|
     if summary = briefcase.pages.find {|p| p.title == "Summary" }
-      hash.merge!(summary: summary.to_model.as_json(:rendered=>true, :content=>true))
+      hash[:summary] = summary.to_model.as_json(params)
+    end
+
+    if briefcase.has_table_of_contents?
+      hash[:table_of_contents] = table_of_contents.as_json(params)
     end
   end
 end
 
-view(:table_of_contents) do |*args|
-  briefcase = args.first
+class Brief::Briefcase
+  def has_table_of_contents?
+    docs_path.join('index.md').exist?
+  end
 
-  doc = Brief::Document.new(briefcase.docs_path.join("index.md"), document_type: "outline")
-  doc && doc.to_model
+  def table_of_contents
+    doc = Brief::Document.new(briefcase.docs_path.join("index.md"), document_type: "outline")
+    doc && doc.to_model
+  end
 end

data/apps/blueprint/models/sitemap.rb

@@ -0,0 +1,15 @@
+class Brief::Apps::Blueprint::Sitemap
+  include Brief::Model
+
+  meta do
+    title
+    status
+    revision
+  end
+
+  content do
+    define_section("Pages") do
+      each("h2").has(:title=>"h2:first-of-type")
+    end
+  end
+end

data/lib/brief/briefcase.rb

@@ -51,32 +51,35 @@ module Brief
     def as_default(params={})
       params.symbolize_keys!
 
-      model_settings = {
-        docs_path: docs_path
-      }
-
-      model_settings[:rendered] = !!(params.key?(:rendered))
-      model_settings[:content] = !!(params.key?(:content))
-
-      all = all_models.compact
-
-      schema = schema_map
-      models = all.map {|m| m.as_json(model_settings) }
-
-      {
+      base = {
         views: Brief.views.keys,
         key: briefcase.folder_name.to_s.parameterize,
         name: briefcase.folder_name.to_s.titlecase,
-        schema: schema,
-        models: models,
         settings: settings,
         cache_key: briefcase.cache_key
-      }.tap do |hash|
-        hash[:table_of_contents] = briefcase.table_of_contents.as_json() rescue {}
+      }
+
+      if params[:include_schema]
+        base[:schema] = schema_map
       end
+
+      if params[:include_models]
+        model_settings = {
+          docs_path: docs_path
+        }
+
+        %w(urls content rendered).each do |opt|
+          model_settings[opt.to_sym] = !!(params[opt.to_sym] || params["include_#{opt}".to_sym])
+        end
+
+        all = all_models.compact
+        base[:models] = all.map {|m| m.as_json(model_settings) }
+      end
+
+      base
     end
 
-    def as_full_export
+    def as_full_export(options={})
       as_default(content: true, rendered: true)
     end
 

data/lib/brief/cli/all.rb

@@ -53,29 +53,44 @@ command 'init' do |c|
   end
 end
 
-command 'info' do |c|
-  c.syntax = 'brief info'
-  c.description = 'View info about the brief environment'
+command "browse" do |c|
+  c.syntax = "brief browse FOLDER"
+  c.description = "Lists information about each of the briefcases in FOLDER"
+
+  c.option '--format FORMAT', String, 'Which format to render the output in? default: printed, or json'
+  c.option '--presenter-format FORMAT', String, 'Which presenter to use?'
+  c.option '--config-filename FILENAME', String, 'Which filename has the briefcase config? default(brief.rb)'
+  c.option '--include-schema', 'Include schema information'
+  c.option '--include-models', 'Include individual models as well'
+  c.option '--include-content', 'Gets passed to the model renderers if present'
+  c.option '--include-rendered', 'Gets passed to the model renderers if present'
+  c.option '--include-urls', 'Gets passed to the model renderers if present'
+
+  c.when_called do |args, options|
+    folder = Pathname(args.first)
+
+    options.default(config_filename:'brief.rb', presenter_format: 'default')
+
+    roots = folder.children.select do |root|
+      root.join(options.config_filename).exist?
+    end
 
-  c.option '--print', 'Print output to the terminal'
+    briefcases = roots.map {|root| Brief::Briefcase.new(root: Pathname(root).realpath) }
 
-  c.action do |args, options|
-    if options.print
-      # traveling ruby is reporting this incorrectly
-      puts "\n-- Paths:"
-      puts "Dir.pwd = #{ Dir.pwd }"
-      puts "Brief.pwd = #{ Brief.pwd }"
-
-      puts "\n-- Available apps:"
-      puts Brief::Apps.available_apps.join("\n")
-    else
-      json = {
-        version: Brief::VERSION,
-        available_apps: Brief::Apps.available_apps,
-        pwd: Brief.pwd
-      }.to_json
+    if options.format == 'json'
+      output = briefcases.map do |b|
+        b.present(options.presenter_format, rendered: options.include_rendered,
+                                            content: options.include_content,
+                                            urls: options.include_urls,
+                                            schema: options.include_schema,
+                                            models: options.include_models)
+      end
 
-      puts json
+      puts output.to_json
+    else
+      briefcases.each do |bc|
+        puts bc
+      end
     end
   end
 end

data/lib/brief/model/serializers.rb

@@ -23,7 +23,11 @@ module Brief::Model::Serializers
       hash: file_hash,
       sections: {},
       section_headings: [],
-      urls: {
+    }.tap do |h|
+      h[:content] = document.combined_data_and_content if options[:content]
+      h[:rendered] = document.to_html if options[:rendered]
+
+      h[:urls] = {
         view_content_url: "/view/content/#{ doc_path }",
         view_rendered_url: "/view/rendered/#{ doc_path }",
         view_details_url: "/view/details/#{ doc_path }",
@@ -31,10 +35,7 @@ module Brief::Model::Serializers
         remove_url: "/remove/#{ doc_path }",
         schema_url: "/schema/#{ type }",
         actions_url: "/actions/:action/#{ doc_path }"
-      }
-    }.tap do |h|
-      h[:content] = document.combined_data_and_content if options[:content]
-      h[:rendered] = document.to_html if options[:rendered]
+      } if options[:urls]
     end.tap do |h|
       if document.has_sections?
         h[:section_headings] = document.section_headings

data/lib/brief/server/handlers/browse.rb

@@ -9,7 +9,12 @@ module Brief::Server::Handlers
 
       if available_handlers.include?(model_type)
         models = briefcase.send(model_type.to_s)
-        [200, {"Content-Type"=>"application/json"}, models.map(&:as_json)]
+
+        presented_models = models.map do |model|
+          model.as_json(options.symbolize_keys)
+        end
+
+        [200, {"Content-Type"=>"application/json"}, presented_models]
       else
         [403, {"Content-Type"=>"application/json"}, {error: "Invalid model type"}]
       end

data/lib/brief/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.8.12
+  version: 1.9.0
 platform: ruby
 authors:
 - Jonathan Soeder
@@ -248,6 +248,7 @@ files:
 - apps/blueprint/models/project.rb
 - apps/blueprint/models/release.rb
 - apps/blueprint/models/roadmap.rb
+- apps/blueprint/models/sitemap.rb
 - apps/blueprint/models/user_story.rb
 - apps/blueprint/models/wireframe.rb
 - apps/blueprint/templates/epic.md.erb