brief 1.14.3 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b274378ab543ef47fe650ee8e460b76b082ad923
-  data.tar.gz: e1a26dc9aeba6e4fa64c2435b604809a347b9bd1
+  metadata.gz: 0ad121f8e79a00d9ab6b1e3606a082756228bfa1
+  data.tar.gz: ec53781530954e351b7fb5b772592ac8b4910a8c
 SHA512:
-  metadata.gz: 6547e89d1f24d62e0bc6d169fff21b67c57c4862a2d8c134fd0e284c6c79fd8a24435f5a15a94f6d8ca4d43b2e65d4cf596817a3ce17a9ddb0e9a8166e537c87
-  data.tar.gz: 4439705a16ca9d2e49fc01e2666d07ca9ebe756e3901565f0776af49e918a0082cf1cd390181d795c0f688587c72e7df17884e2cded9fb6fe2d211fc26bf5954
+  metadata.gz: 8401196bdea0358cc80773e59dbaa0bdcf6c39cf24347dcc7cc758cf29a6be166fbb4ab6949babc32841e6c1705c5d21e635686a11b8c63fb0bf8847db5bdd8b
+  data.tar.gz: c98664f6aa2614b25d55433c2f172f5c30a0532ac0dbedbdf0639d6c3fe7ecaa48014abd5e48f86fd0000455dad3bf6d8f7336028089b682b3df012fe8fe0bdd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.14.2)
+    brief (1.15.0)
       activesupport (> 3.2)
       commander (~> 4.3)
       em-websocket (~> 0.5)

data/lib/brief/model/reports.rb

@@ -0,0 +1,32 @@
+class Brief::GenericReport
+  attr_reader :document
+
+  def initialize(document)
+    @document = document
+  end
+
+  def briefcase
+    document.try(:briefcase)
+  end
+
+  def entries
+    []
+  end
+
+  def headers
+    []
+  end
+end
+
+module Brief::Model::Reports
+  def generate_report report_type
+    if data.reports && data.reports.fetch(report_type, nil)
+      klass = data.reports.fetch(report_type.to_s)
+      klass = Object.const_get(klass) unless klass.is_a?(Class)
+    else
+      klass = Brief::GenericReport
+    end
+
+    klass && klass.new(self)
+  end
+end

data/lib/brief/model.rb

@@ -13,6 +13,7 @@ module Brief
       include AccessorMethods
       include Persistence
       include Serializers
+      include Reports
 
       class_attribute :models, :after_initialization_hooks
 

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.14.3'
+  VERSION = '1.15.0'
 end

data/lib/brief.rb

@@ -144,7 +144,7 @@ require 'brief/model'
 require 'brief/model/definition'
 require 'brief/model/persistence'
 require 'brief/model/serializers'
-require 'brief/model/serializers'
+require 'brief/model/reports'
 require 'brief/data'
 require 'brief/dsl'
 require 'brief/server'

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

@@ -1,6 +1,10 @@
 ---
 type: concept
-needle: i5wt25dv3tug69u5at7k0mrd8buy41lbeub9
+
 ---
 
-# Modified Content ponsmqgjrpttz2wxpszae6nfsapnqucwow3b
+# Modified Content m080vwvx12ilsu4c7ayty4xxlilnf8s7qw1r
+
+1
+
+1

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

@@ -6,6 +6,8 @@ status: Planned
 date: 2018-12-18
 attachments:
   - diagrams/test
+reports:
+  sample: SampleReport
 ---
 
 This is a release it is a simple file with no real structure.

data/spec/fixtures/example/lib/sample_report.rb

@@ -0,0 +1,5 @@
+class SampleReport < Brief::GenericReport
+  def entries
+    [document.title]
+  end
+end

data/spec/lib/brief/reports_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+
+describe "Document Reports" do
+  it "should be able to generate reports using custom report classes" do
+    sample = Brief.testcase.releases.first
+    report = sample.generate_report(:sample)
+    expect(report.entries).to include(sample.title)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.14.3
+  version: 1.15.0
 platform: ruby
 authors:
 - Jonathan Soeder
@@ -403,6 +403,7 @@ files:
 - lib/brief/model.rb
 - lib/brief/model/definition.rb
 - lib/brief/model/persistence.rb
+- lib/brief/model/reports.rb
 - lib/brief/model/serializers.rb
 - lib/brief/repository.rb
 - lib/brief/server.rb
@@ -440,6 +441,7 @@ files:
 - spec/fixtures/example/docs/resource.html.md
 - spec/fixtures/example/docs/user_story.html.md
 - spec/fixtures/example/docs/wireframe.html.md
+- spec/fixtures/example/lib/sample_report.rb
 - spec/fixtures/example/lib/should_be_defined.rb
 - spec/fixtures/example/models/concept.rb
 - spec/fixtures/example/models/epic.rb
@@ -466,6 +468,7 @@ files:
 - spec/lib/brief/models/release_spec.rb
 - spec/lib/brief/persistence_spec.rb
 - spec/lib/brief/rendering_spec.rb
+- spec/lib/brief/reports_spec.rb
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
 - spec/lib/brief/serializers_spec.rb
@@ -541,6 +544,7 @@ test_files:
 - spec/fixtures/example/docs/resource.html.md
 - spec/fixtures/example/docs/user_story.html.md
 - spec/fixtures/example/docs/wireframe.html.md
+- spec/fixtures/example/lib/sample_report.rb
 - spec/fixtures/example/lib/should_be_defined.rb
 - spec/fixtures/example/models/concept.rb
 - spec/fixtures/example/models/epic.rb
@@ -567,6 +571,7 @@ test_files:
 - spec/lib/brief/models/release_spec.rb
 - spec/lib/brief/persistence_spec.rb
 - spec/lib/brief/rendering_spec.rb
+- spec/lib/brief/reports_spec.rb
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
 - spec/lib/brief/serializers_spec.rb