brief 1.9.0 → 1.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b2be8fb315c30c8b5534ffa5b215a5f3ae058fb7
-  data.tar.gz: aaaedeffe0b34d86a724ed4d25dc9cccdbaa712a
+  metadata.gz: 0457268f9d394e5149e2bc1b48189c5c6baf91b2
+  data.tar.gz: 429a4e214373841c3db8281246228f4b00b4d2ea
 SHA512:
-  metadata.gz: 111d44be6dcd95672ccf28adb0149cfa2cc41691f057ce557ce0b18572ce2fe9f124f60f0f0bc5fa89b73ca0a472099aab66d07aa13049ec140fc5a79e803ca4
-  data.tar.gz: 2b5401b3ed0b66b01bc33c100388a0ad911a0e4c5f0a8bcffe44af039ba8ea43a72140619dc7aab5d676040026d65aca0814c7c6a9786ea2768edb4e2d3ba347
+  metadata.gz: 8df3869a124d86b6554fc933648b686a0a308377f5399b79e4a93da25985e992e51283fbeb5f5a2cfb0d0230d8a171e75bd9b4cb537af5a0dc464f7df00303e9
+  data.tar.gz: 011ceb6a4b2c6cb359816b8acc708ed9d32f8095e9b613e14776930677c4b86e0998a4ce4baa235236795c51e50c1592d1ae5d7e68acbb4541d511831e4d4cc0

data/Gemfile.lock

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

data/lib/brief/briefcase.rb

@@ -59,11 +59,11 @@ module Brief
         cache_key: briefcase.cache_key
       }
 
-      if params[:include_schema]
+      if params[:include_schema] || params[:schema]
         base[:schema] = schema_map
       end
 
-      if params[:include_models]
+      if params[:include_models] || params[:models]
         model_settings = {
           docs_path: docs_path
         }
@@ -73,6 +73,7 @@ module Brief
         end
 
         all = all_models.compact
+
         base[:models] = all.map {|m| m.as_json(model_settings) }
       end
 
@@ -80,7 +81,8 @@ module Brief
     end
 
     def as_full_export(options={})
-      as_default(content: true, rendered: true)
+      options.reverse_merge!(content: true, rendered: true, models: true, schema: true)
+      as_default(options)
     end
 
     def use(module_type=:app, module_id)

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

@@ -1,29 +1,39 @@
 class Commander::Command
-  def action(*args, &block)
+  def action(*a, &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))
+      options.default(root: Brief.pwd, config_filename: 'brief.rb', format: :printed)
 
-      block.call(args, options)
-    end
-  end
-end
+      root = Pathname(options.root)
 
-module Brief
-  def self.cli_action(c, &block)
-    c.action do |args, options|
-      options.default(root: Brief.pwd)
+      if root.join(options.config_filename).exist?
+        Brief.case = Brief::Briefcase.new(root: root)
+      end
 
-      Brief.case = Brief::Briefcase.new(root: Pathname(options.root))
+      result = block.call(args, options)
+
+      case
+      when options.output && options.format.to_sym == :json
+        Pathname(options.output).open("w+") do |fh|
+          fh.write(result.to_json)
+        end
+      when options.format.to_sym == :json
+        puts result.to_json
+      when options.format.to_sym == :printed
+        puts result
+      end
 
-      block.call(args, options)
     end
   end
+end
 
+module Brief
   def self.default_cli_options(c)
     c.option '--root DIRECTORY', String, 'The root for the briefcase'
     c.option '--config FILE', String, 'Path to the config file for this briefcase'
+    c.option '--config-filename', String, 'The default filename for a briefcase config: brief.rb'
+    c.option '--output FILE', String, 'Save the output in the specified path'
+    c.option '--format FORMAT', String, 'How to format the CLI output: defaults to printed, accepts printed,json'
   end
 end

data/lib/brief/cli/all.rb

@@ -29,6 +29,8 @@ command 'change' do |c|
     if options.dry_run
       puts documents
     end
+
+    documents
   end
 end
 
@@ -50,6 +52,8 @@ command 'init' do |c|
       require 'brief/briefcase/initializer'
       Brief::Briefcase.create_new_briefcase(root: root, app: options.app)
     end
+
+    false
   end
 end
 
@@ -57,16 +61,15 @@ 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 '--presenter-format FORMAT', String, 'Which presenter to use?'
   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|
+  c.action do |args, options|
     folder = Pathname(args.first)
 
     options.default(config_filename:'brief.rb', presenter_format: 'default')
@@ -77,20 +80,12 @@ command "browse" do |c|
 
     briefcases = roots.map {|root| Brief::Briefcase.new(root: Pathname(root).realpath) }
 
-    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 output.to_json
-    else
-      briefcases.each do |bc|
-        puts bc
-      end
+    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
   end
 end

data/lib/brief/cli/export.rb

@@ -2,31 +2,24 @@ command 'export' do |c|
   c.syntax = 'brief export PATH [OPTIONS]'
   c.description = 'export the briefcase found in PATH'
 
-  c.option '--output PATH', String, 'Save the output to the specified path'
-  c.option '--app APP', String, 'Use the specified app to get our models etc'
-  c.option '--config PATH', String, 'Use the specified config file'
+  c.option '--presenter-format FORMAT', String, 'Which presenter to use?'
+  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.action do |args, options|
-    root = Pathname(args.first || Brief.pwd)
+    options.default(presenter_format: "full_export")
 
-    o = {
-      root: root
-    }
+    root = Pathname(args.first)
+    briefcase = Brief::Briefcase.new(root: root)
+    briefcase.present(options.presenter_format, rendered: options.include_rendered,
+                                                content: options.include_content,
+                                                urls: options.include_urls,
+                                                schema: options.include_schema,
+                                                models: options.include_models)
 
-    o[:app] = options.app if options.app
-    o[:config_path] = options.config if options.config
-
-    briefcase = Brief::Briefcase.new(o)
-
-    export = briefcase.as_full_export.to_json
-
-    if options.output
-      output = Pathname(options.output)
-      output = output.join(briefcase.slug + ".json") if output.directory?
-      output.open("w+") {|fh| fh.write(export) }
-    else
-      puts export
-    end
   end
 end
 

data/lib/brief/cli/parse.rb

@@ -2,21 +2,17 @@ command 'parse' do |c|
   c.syntax = 'brief parse PATH [OPTIONS]'
   c.description = 'parse the briefcase path'
 
-  c.option '--root PATH', String, 'The briefcase root'
-  c.option '--output PATH', String, 'Save the output to the specified path'
-  c.option '--app APP', String, 'Use the specified app to get our models etc'
-  c.option '--config PATH', String, 'Use the specified config file'
-  c.option '--type TYPE', String, 'Valid options: hash, array; Output as a hash keyed by path, or an array. Defaults to array.'
+  c.option '--output-type TYPE', String, 'Valid options: hash, array; Output as a hash keyed by path, or an array. Defaults to array.'
+  c.option '--config-path FILE', String, 'Path to the config file for the briefcase'
 
   c.action do |args, options|
-    options.default(root: Pathname(Brief.pwd), type: "array")
+    options.default(root: Pathname(Brief.pwd), output_type: "array")
 
     o = {
       root: options.root
     }
 
-    o[:app] = options.app if options.app
-    o[:config_path] = options.config if options.config
+    o[:config_path] = options.config_path if options.config_path
 
     briefcase = Brief::Briefcase.new(o)
 
@@ -33,7 +29,7 @@ command 'parse' do |c|
       end.flatten
     end
 
-    if options.type == "hash"
+    if options.output_type == "hash"
       parsed = parsed.inject({}) do |memo, obj|
         path = obj[:path]
         memo[path] = obj
@@ -41,10 +37,6 @@ command 'parse' do |c|
       end
     end
 
-    if options.output
-      Pathname(options.output).open("w+") {|fh| fh.write(parsed.to_json) }
-    else
-      puts parsed.to_json
-    end
+    parsed
   end
 end

data/lib/brief/cli/schema.rb

@@ -2,13 +2,9 @@ command 'schema' do |c|
   c.syntax = "brief schema"
   c.description = "view information about the schema"
 
-  Brief.default_cli_options(c)
-
-  c.option '--output FILE', String, 'Output the contents to the specified file'
   c.option '--all-models', 'Include all models, not just those that have documents'
-  c.option '--list-types', 'Only list the types'
 
-  Brief.cli_action(c) do |args, options|
+  c.action do |args, options|
     schema_map = Brief.case.schema_map(options.all_models)
 
     output = if args.empty?
@@ -18,12 +14,6 @@ command 'schema' do |c|
       detail.to_json if detail
     end
 
-    if options.output
-      Pathname(options.output).open "w+" do |fh|
-        fh.write(output.chomp)
-      end
-    else
-      puts output
-    end
+    output
   end
 end

data/lib/brief/model/serializers.rb

@@ -24,8 +24,8 @@ module Brief::Model::Serializers
       sections: {},
       section_headings: [],
     }.tap do |h|
-      h[:content] = document.combined_data_and_content if options[:content]
-      h[:rendered] = document.to_html if options[:rendered]
+      h[:content] = document.combined_data_and_content if options[:content] || options[:include_content]
+      h[:rendered] = document.to_html if options[:rendered] || options[:include_rendered]
 
       h[:urls] = {
         view_content_url: "/view/content/#{ doc_path }",
@@ -35,7 +35,7 @@ module Brief::Model::Serializers
         remove_url: "/remove/#{ doc_path }",
         schema_url: "/schema/#{ type }",
         actions_url: "/actions/:action/#{ doc_path }"
-      } if options[:urls]
+      } if options[:urls] || options[:include_urls]
     end.tap do |h|
       if document.has_sections?
         h[:section_headings] = document.section_headings

data/lib/brief/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.9.1
 platform: ruby
 authors:
 - Jonathan Soeder