brief 1.9.7 → 1.9.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 983069845db550df399f38eaba6b784c2dcb05ac
-  data.tar.gz: 9d42901a7a21ba82dcf6e54d24cc7c2d03ed4e19
+  metadata.gz: 6e9d4f96cdfb13d6e754b942a4687f60e7d8888e
+  data.tar.gz: 59caee15c35018c1b1bfebcec9bc2c9455fdc41a
 SHA512:
-  metadata.gz: 881959cd3db5dfcd955669a1a70bbb16bdfcd9f8ef1dc2db58ec0e621af7f337be8d8eaf2374d125383c97c62912030df5c1e56625ac88e24c431912aada1125
-  data.tar.gz: 0b4fec2df6686cdd302f9e5460996c54f3b2d3a8e67da30603c4eb93bd4f389651165cf9358b8211dca377c00fcc8a10682d67fc2eb64945fee6749115054506
+  metadata.gz: 9bddeba5d8229e39e3fb5e7d939ae57b2104862fd26d5d2f737404a965af4ba30bed1fa272937b2f814b793174fff0a082b6ab4c7bbb301d8726539628296acc
+  data.tar.gz: 48af2ae16f06cef85620f6fe59c9f184748e2ffadb529645900be9da06f36db071174d1cfe8f79abb33f6fa0bb56ac194433823a770631b51505cc6161b5cbf7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.9.6)
+    brief (1.9.8)
       activesupport (~> 4.0)
       commander (~> 4.3)
       em-websocket (= 0.5.1)
@@ -12,7 +12,6 @@ PATH
       hike (~> 2.1)
       inflecto (~> 0)
       nokogiri (= 1.6.5)
-      nokogiri (= 1.6.5)
       thin (= 1.6.3)
       virtus (~> 1.0)
 

data/lib/brief/briefcase.rb

@@ -21,6 +21,8 @@ module Brief
     end
 
     def present(style="default", params={})
+      style = "default" if style.nil?
+
       if respond_to?("as_#{style}")
         send("as_#{style}", params)
       elsif Brief.views.key?(style.to_sym)
@@ -53,10 +55,10 @@ module Brief
 
       base = {
         views: Brief.views.keys,
-        key: briefcase.folder_name.to_s.parameterize,
-        name: briefcase.folder_name.to_s.titlecase,
+        key: folder_name.to_s.parameterize,
+        name: folder_name.to_s.titlecase,
         settings: settings,
-        cache_key: briefcase.cache_key
+        cache_key: cache_key
       }
 
       if params[:include_data] || params[:data]
@@ -196,7 +198,7 @@ module Brief
     end
 
     def root
-      Pathname(options.fetch(:root) { Brief.pwd })
+      Pathname(options.fetch(:root) { Brief.pwd }).expand_path
     end
 
     def find_asset(needle)
@@ -205,7 +207,15 @@ module Brief
     end
 
     def assets_path
-      root.join options.fetch(:assets_path) { config.assets_path }
+      root.join(options.fetch(:assets_path) { config.assets_path }).expand_path
+    end
+
+    def docs_path
+      root.join(options.fetch(:docs_path) { config.docs_path }).expand_path
+    end
+
+    def data_path
+      root.join(options.fetch(:data_path) { config.data_path }).expand_path
     end
 
     def assets_trail
@@ -222,13 +232,6 @@ module Brief
       end
     end
 
-    def docs_path
-      root.join options.fetch(:docs_path) { config.docs_path }
-    end
-
-    def data_path
-      root.join options.fetch(:data_path) { config.data_path }
-    end
 
     def data_trail
       @docs_trail ||= Hike::Trail.new(data_path).tap do |trail|

data/lib/brief/cli/export.rb

@@ -1,3 +1,55 @@
+command 'dispatch export' do |c|
+  c.syntax = 'brief dispatch export PATH [OPTIONS]'
+  c.description = 'dispatch the export the briefcase found in PATH'
+
+  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-data', 'Gets passed to the model renderers if present'
+  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-attachments', 'Gets passed to the model renderers if present'
+  c.option '--include-urls', 'Gets passed to the model renderers if present'
+  c.option '--gateway', 'The remote server is a gateway'
+  c.option '--port DRB_PORT', String, 'The DRb port to use'
+  c.option '--briefcase KEY', String, 'Which briefcase should we use? if this is a gateway'
+  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'
+  c.option '--prefix-output CONTENT', String, 'Prefix the generated output with the following content'
+
+  c.when_called do |args, options|
+    require 'drb'
+    options.default(:port => 9000, briefcase: Pathname(Brief.pwd).dirname.to_s)
+
+    remote = DRbObject.new(nil, "druby://:#{ options.port }")
+
+    if options.gateway
+      remote = remote.briefcases[options.briefcase]
+    end
+
+    result = remote.present(options.presenter_format, rendered: options.include_rendered,
+                                             content: options.include_content,
+                                             urls: options.include_urls,
+                                             schema: options.include_schema,
+                                             data: options.include_data,
+                                             attachments: options.include_attachments,
+                                             models: options.include_models).as_json
+
+      case
+      when options.output && options.format.to_sym == :json
+        Pathname(options.output).open("w+") do |fh|
+          fh.write("#{options.prefix_output}#{result.to_json}")
+        end
+      when options.format.to_sym == :json
+        puts "#{options.prefix_output}#{result.to_json}"
+      when options.format.to_sym == :printed
+        puts result
+      end
+
+
+  end
+end
+
 command 'export' do |c|
   c.syntax = 'brief export PATH [OPTIONS]'
   c.description = 'export the briefcase found in PATH'

data/lib/brief/cli/run.rb

@@ -0,0 +1,9 @@
+command "run" do |c|
+  c.syntax = 'brief run FILE'
+  c.description = 'run a script in the context of the briefcase'
+
+  c.action do |args, options|
+    code = Pathname(args.first).read
+    Brief.case.instance_eval(code)
+  end
+end

data/lib/brief/cli/server.rb

@@ -12,16 +12,27 @@ command 'start gateway server' do |c|
   end
 end
 
-command 'start socket gateway' do |c|
+command 'start drb server' do |c|
   c.option '--host HOSTNAME', String, 'What hostname to listen on'
   c.option '--port PORT', String, 'What port to listen on'
+  c.option '--gateway', 'Create a gateway instead of a briefcase'
 
   c.action do |args, options|
     options.default(root: Brief.pwd)
 
-    require 'em-websocket'
-    require 'brief/server/gateway'
-    require 'brief/server/socket'
-    Brief::Server::Socket.start(port: options.port, host: options.host, root: Pathname(options.root))
+    require 'drb'
+
+    root = Pathname(options.root)
+
+    object = if options.gateway
+               Brief::Server::Distributed.new(root: root, briefcase_options: {eager: true})
+             else
+               Brief::Briefcase.new(root: root, eager: true)
+             end
+
+    puts "== starting distributed service"
+    DRb.start_service "druby://:#{ options.port || 9000 }", object
+    trap("INT") { DRb.stop_service }
+    DRb.thread.join()
   end
 end

data/lib/brief/document/section.rb

@@ -10,6 +10,14 @@ class Brief::Document::Section
     @config = config
   end
 
+  def to_html
+    fragment.to_html
+  end
+
+  def text
+    fragment.text
+  end
+
   def items
     return @items if @items
 

data/lib/brief/document.rb

@@ -127,7 +127,7 @@ module Brief
     end
 
     def briefcase
-      (@briefcase_root && Brief.cases[@briefcase_root]) || Brief.case
+      (@briefcase_root && Brief.cases[@briefcase_root]) || Brief.case(true)
     end
 
     def has_sections?
@@ -265,7 +265,8 @@ module Brief
       end
     end
 
-    def respond_to?(method)
+    def respond_to?(*args)
+      method = args.first
       super || (data && data.respond_to?(method)) || (data && data.key?(method))
     end
 

data/lib/brief/repository.rb

@@ -13,14 +13,15 @@ module Brief
       @briefcase = briefcase
       @options = options
 
-      load_documents
+      load_documents if options[:eager]
     end
 
     def cache_key
       "#{documents.count}-#{documents.map {|d| d.path.mtime.to_i }.max}"
     end
 
-    def respond_to?(meth)
+    def respond_to?(*args)
+      meth = args.first
       super || model_groups.include?(meth.to_s)
     end
 

data/lib/brief/server/gateway.rb

@@ -8,6 +8,8 @@ class Brief::Server::Gateway
     Rack::Handler::Thin.run(app, Port: port, Host: host)
   end
 
+  attr_reader :briefcases
+
   def initialize(options={})
     @root = options.fetch(:root)
     @briefcases = {}.to_mash

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.9.7'
+  VERSION = '1.9.8'
 end

data/spec/lib/brief/attachments_spec.rb

@@ -1,9 +1,19 @@
 require "spec_helper"
 
 describe "Rendering Attachments" do
-  let(:doc) { Brief.testcase.releases.first }
+  let(:release) { Brief.testcase.releases.first }
+  let(:doc) { release.document }
 
-  it "should include attachments in the serialized version" do
-    expect(doc.render_attachments['test.svg']).not_to be_empty
+  it "detects attachments" do
+    expect(doc).to be_has_attachments
+  end
+
+  it "makes attachments content available" do
+    expect(doc.render_attachments).not_to be_empty
+  end
+
+  it "optionally makes attachments available in the model serializer" do
+    expect(release.as_json()).not_to have_key(:attachments)
+    expect(release.as_json(attachments: true)[:attachments]).not_to be_empty
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.9.7
+  version: 1.9.8
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-01 00:00:00.000000000 Z
+date: 2015-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -319,6 +319,7 @@ files:
 - lib/brief/cli/export.rb
 - lib/brief/cli/parse.rb
 - lib/brief/cli/render.rb
+- lib/brief/cli/run.rb
 - lib/brief/cli/schema.rb
 - lib/brief/cli/server.rb
 - lib/brief/cli/write.rb
@@ -352,7 +353,6 @@ files:
 - lib/brief/server/handlers/schema.rb
 - lib/brief/server/handlers/show.rb
 - lib/brief/server/route.rb
-- lib/brief/server/socket.rb
 - lib/brief/util.rb
 - lib/brief/version.rb
 - packaging/wrapper.sh

data/lib/brief/server/socket.rb

@@ -1,53 +0,0 @@
-class Brief::Server::Socket
-  def self.start(options={}, &block)
-    require 'em-websocket' unless defined?(EM::WebSocket)
-
-    host = options.fetch(:host, '0.0.0.0')
-    host = options.fetch(:port, '8023')
-
-    gateway = Brief::Server::Gateway.new(options)
-
-    socket = new(gateway: gateway)
-
-    EM.run {
-      socket.start
-    }
-  end
-
-  attr_reader :gateway,
-              :options,
-              :host,
-              :port
-
-  def initialize(options={})
-    @options = options
-    @gateway = gateway
-    @host    = options.fetch(:host, '0.0.0.0')
-    @port    = options.fetch(:port, 9099)
-  end
-
-  def log(message)
-    if options[:log_to_console]
-      puts(message)
-    end
-  end
-
-  def start
-    log "Starting socket gateway: #{port} host: #{ host }"
-    EM::WebSocket.run(:host => host, :port => port) do |ws|
-      ws.onopen do |handshake|
-        log("== Brief client connected")
-        log(handshake.inspect)
-      end
-
-      ws.onclose do
-        log("brief Connection closed")
-      end
-
-      ws.onmessage do |data|
-         message = OpenStruct.new(JSON.parse(data))
-         log "== Websocket Command: #{ message }"
-      end
-    end
-  end
-end