brief 1.5.2 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f1e4078f005e4ba5a99b045a245a897ca71683dc
-  data.tar.gz: d810cae63f5c24786b5a48b4af515b33a3fdf36c
+  metadata.gz: 9a7fdb09f6012e32e84d8dbd2389b556d43e2ebd
+  data.tar.gz: 2ac225ed8670e6eba082bac6e548b931bd9d8666
 SHA512:
-  metadata.gz: 833e064d7b2aa8d619c5c8fce6a9bc401c3b4a070f71f1e75f41053d22fb7dd22d533403a82ad76ac8341b50cdd914ad989529c848b6d33c97dc3dfcbee12e18
-  data.tar.gz: 679d1d73a557be8df6a4a0891506cce9c2bc17510bb2db44d8fb1a53988847133d45fde71586cff46d2a4e895dcd6df31e59729bd28b373be848fa78ade9608f
+  metadata.gz: bbad8b3c8b85ea4fe27bb4f56063f7f24f0ce977d7a247b80d719c4d443660ba7ee3cd20dd46f51cde66f4b71eb08401f22c9187fd461f5b6e21248bd3649d61
+  data.tar.gz: 458f15c26bc5c647a7024c9f339cb63d574a98a836a984241ff14de831e6c35cf70e76c77d5f4d4ae3c6285314e36cff6374332474fd556dd62a6c11ead700e7

data/CHANGELOG.md

@@ -121,3 +121,7 @@ attributes.
 ### 1.4.5
   - Introducing a new DSL to define aggregator methods on the briefcase
   - Aggregators have a REST interface
+
+### 1.6.0
+  - Introducing the apps repository for shared model code
+  - Added capability to pull out yaml blocks from the document as deserialized hashes on our models

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.5.1)
+    brief (1.5.2)
       activemodel
       activesupport
       commander

data/apps/blueprint/config.rb

@@ -0,0 +1,7 @@
+view(:summary) do |briefcase, params|
+  briefcase.present(:default, params).tap do |hash|
+    if summary = where(title:"Summary",type:"page").first
+      hash.merge!(summary: summary.to_model.as_json(:rendered=>true, :content=>true))
+    end
+  end
+end

data/apps/blueprint/models/epic.rb

@@ -0,0 +1,68 @@
+class Brief::Apps::Blueprint::Epic
+  include Brief::Model
+
+  meta do
+    title
+    subheading
+    status String, :in => %w(draft published)
+  end
+
+  example <<-EOF
+---
+type: epic
+status: draft
+---
+
+# Epic Title
+
+Write a description for your epic.
+
+# User Stories
+
+## User Story Title
+
+As a **PERSONA** I would like to **BEHAVIOR** so that I can **GOAL**
+  EOF
+
+  template <<-EOF
+# <%= object.title %>
+# User Stories
+<% Array(object.user_stories).each do |user_story| %>
+## <%= user_story.title %>
+As a **User** I would like to **Do this** so that I can **succeed**
+<% end %>
+  EOF
+
+  content do
+    title "h1:first-of-type"
+    define_section "User Stories" do
+      each("h2").has(:title     => "h2",
+                     :paragraph => "p:first-of-type",
+                     :components   => "p:first-of-type strong"
+                    )
+
+      each("h2").is_a :user_story
+    end
+  end
+
+  helpers do
+    def user_stories
+      sections.user_stories.items.map do |item|
+        item.components = Array(item.components)
+
+        item.merge(goal: item.components[2],
+                   persona: item.components[0],
+                   behavior: item.components[1])
+      end
+    end
+  end
+
+  actions do
+    def publish_to_github
+    end
+
+    def custom_action
+    end
+  end
+
+end

data/apps/blueprint/models/page.rb

@@ -0,0 +1,16 @@
+class Brief::Apps::Blueprint::Page
+  include Brief::Model
+
+  meta do
+    title
+    category
+    tags Array
+  end
+
+  content do
+    title "h1:first-of-type"
+    tagline "h2:first-of-type"
+    paragraph "p:first-of-type"
+    yaml_data "code.yaml:first-of-type", :serialize => :yaml
+  end
+end

data/apps/blueprint/models/persona.rb

@@ -0,0 +1,13 @@
+class Brief::Apps::Blueprint::Persona
+  include Brief::Model
+
+  meta do
+    title
+  end
+
+  content do
+    title "h1:first-of-type"
+    temp "h1:first-of-type"
+    paragraph "p:first-of-type"
+  end
+end

data/apps/blueprint/models/user_story.rb

@@ -0,0 +1,22 @@
+class Brief::Apps::Blueprint::UserStory
+  include Brief::Model
+
+  meta do
+    title
+    status :in => %w(draft published)
+    epic_title
+  end
+
+  template :file => "user_story.md.erb"
+
+  content do
+    persona "p strong:first-child"
+    behavior "p strong:second-child"
+    goal "p strong:third-child"
+  end
+
+  actions do
+    def sync_with_github
+    end
+  end
+end

data/apps/blueprint/models/wireframe.rb

@@ -0,0 +1,11 @@
+class Brief::Apps::Blueprint::Wireframe
+  include Brief::Model
+
+  meta do
+    title
+    parent_title
+    category
+    tags
+    annotations Hash
+  end
+end

data/lib/brief.rb

@@ -60,7 +60,10 @@ module Brief
   end
 
   def self.load_modules_from(folder)
-    Dir[folder.join('**/*.rb')].each { |f| require(f) }
+    Dir[folder.join('**/*.rb')].each do |f|
+      #puts "Loading model from #{ f }"
+      require(f)
+    end
   end
 
   # Adapters for Rails, Middleman, or Jekyll apps
@@ -93,3 +96,6 @@ require 'brief/model/serializers'
 require 'brief/dsl'
 require 'brief/server'
 require 'brief/briefcase'
+require 'brief/apps'
+
+Brief::Apps.create_namespaces()

data/lib/brief/apps.rb

@@ -0,0 +1,48 @@
+module Brief
+  class Apps
+    def self.default_path
+      Brief.gem_root.join("..","apps")
+    end
+
+    def self.search_paths
+      paths = [default_path]
+
+      if custom_path = ENV['BRIEF_APPS_PATH']
+        custom_path = custom_path.to_s.to_pathname
+        paths << custom_path if (custom_path.exist? rescue nil)
+      end
+
+      paths
+    end
+
+    def self.app_paths
+      search_paths.map do |base|
+        base.children.select do |child|
+          child.join("config.rb").exist?
+        end
+      end.flatten
+    end
+
+    def self.available?(app_name)
+      available_apps.include?(app_name.to_s)
+    end
+
+    def self.path_for(app_name)
+      app_paths.detect {|b| b.basename.to_s == app_name }
+    end
+
+    def self.available_apps
+      app_paths.map(&:basename).map(&:to_s)
+    end
+
+    def self.create_namespaces
+      available_apps.map(&:camelize).each do |namespace|
+        const_set(namespace, Module.new)
+      end
+    end
+
+    def self.find_namespace(app_name)
+      Brief::Apps.const_get(app_name.to_s.camelize)
+    end
+  end
+end

data/lib/brief/briefcase.rb

@@ -9,6 +9,8 @@ module Brief
       @options = options.to_mash
 
       load_configuration
+      use(:app, options[:app]) if options[:app]
+
       load_model_definitions
 
       if Brief.case.nil?
@@ -71,12 +73,10 @@ module Brief
     end
 
     def use(module_type=:app, module_id)
-      if module_type == :app && apps_path.join(module_id).exist?
-        config = module_type.join("config.rb")
-        models = module_type.join("models")
+      options[:app] = module_id.to_s
 
-        instance_eval(config.read) if config.exist?
-        Brief.load_modules_from(models) if models.exist?
+      if app_path && app_path.exist?
+        instance_eval(app_config_path.read)
       end
     end
 
@@ -103,21 +103,37 @@ module Brief
         config_path = root.join(config_path)
       end
 
-      if uses_app?
-        instance_eval(app_path.join("config.rb").read)
-      end
-
       if config_path.exist?
         instance_eval(config_path.read) rescue nil
       end
     end
 
     def uses_app?
-      options.key?(:app) && Brief.apps_path.join(options[:app]).exist?
+      options.key?(:app) && Brief::Apps.available?(options[:app].to_s)
     end
 
     def app_path
-      uses_app? && Brief.apps_path.join(options[:app])
+      uses_app? && Brief::Apps.path_for(options[:app]).to_pathname
+    end
+
+    def app_config_path
+      uses_app? && app_path.join("config.rb")
+    end
+
+    def app_models_folder
+      uses_app? && app_path.join("models")
+    end
+
+    def model_class_for(document_type)
+      return generic_model_class_for(document_type) unless uses_app?
+
+      namespace = Brief::Apps.find_namespace(options[:app])
+      classes = namespace.constants.map {|c| namespace.const_get(c) }
+      classes.find {|k| k.type_alias == document_type }
+    end
+
+    def generic_model_class_for(document)
+      Brief::Model.for_type(document.document_type) || Brief::Model.for_folder_name(document.parent_folder_name)
     end
 
     def load_model_definitions

data/lib/brief/core_ext.rb

@@ -9,3 +9,9 @@ class String
     Pathname(self)
   end
 end
+
+class Pathname
+  def to_pathname
+    self
+  end
+end

data/lib/brief/document.rb

@@ -25,12 +25,6 @@ module Brief
       elsif options[:contents]
         @raw_content = options[:contents]
       end
-
-      register_model_instance if self.path && self.path.exist?
-    end
-
-    def register_model_instance
-      model_class.try(:models).try(:<<, to_model) unless model_instance_registered?
     end
 
     def raw= val
@@ -171,6 +165,8 @@ module Brief
       case
       when @model_class
         @model_class
+      when briefcase
+        briefcase.model_class_for(self)
       when data && data.type
         Brief::Model.for_type(data.type)
       when parent_folder_name.length > 0

data/lib/brief/document/content_extractor.rb

@@ -8,7 +8,7 @@ module Brief
     attr_reader :document
 
     def model_class
-      Brief::Model.for_type(@model_type)
+      document.model_class
     end
 
     def content_schema_attributes
@@ -39,6 +39,25 @@ module Brief
           else
             matches.first.try(:text)
           end
+        elsif settings.args.first.to_s.match(/code/i) && (settings.args.last.serialize rescue nil)
+          selector = settings.args.first
+          opts = settings.args.last
+
+          matches = document.css(selector)
+
+          val = if matches.length > 1
+            selector.match(/first-of-type/) ? matches.first.text : matches.map(&:text)
+          else
+            matches.first.try(:text)
+          end
+
+          if val && opts.serialize == :yaml
+            return (YAML.load(val) rescue {}).to_mash
+          end
+
+          if val && opts.serialize == :json
+            return (JSON.parse(val) rescue {}).to_mash
+          end
         end
       end
     end

data/lib/brief/document/rendering.rb

@@ -25,7 +25,7 @@ module Brief
                                                  fenced_code_blocks: true,
                                                  footnotes: true)
 
-                          ::Redcarpet::Markdown.new(r)
+                          ::Redcarpet::Markdown.new(r, :tables => true, :autolink => true, :gh_blockcode => true, :fenced_code_blocks => true, :footnotes => true)
                         end
         end
       end

data/lib/brief/model.rb

@@ -108,8 +108,8 @@ module Brief
     end
 
     module ClassMethods
-      def purge
-        models.reject! {|model| !model.document.path.exist? }
+      def ==(other)
+        type_alias && type_alias == other.type_alias
       end
 
       def to_schema

data/lib/brief/repository.rb

@@ -16,6 +16,25 @@ module Brief
       load_documents
     end
 
+    def respond_to?(meth)
+      super || model_groups.include?(meth.to_s)
+    end
+
+    def method_missing(meth, *args, &block)
+      if model_groups.include?(meth.to_s)
+        find_models_by_type(meth)
+      end
+    end
+
+    def find_models_by_type(group_name)
+      type = group_name.to_s.singularize
+      all_models_by_type.fetch(type) { [] }
+    end
+
+    def model_groups
+      documents.map(&:document_type).tap {|l| l.compact!; l.uniq!; l.map! {|i| i.pluralize } }
+    end
+
     def document_at(path)
       path = normalize_path(path)
       found = documents.find {|doc| doc.path == path }
@@ -74,46 +93,35 @@ module Brief
     end
 
     def all_models
-      list = documents.select(&:refresh!).map(&:to_model)
-      list.compact!
-      list.select!(&:exists?)
+      @all_models ||= begin
+                        list = documents.select(&:refresh!).map(&:to_model)
+                        list.compact!
+                        list.select!(&:exists?)
 
-      list
+                        list
+                      end
     end
 
     def all_models_by_type
-      all_models.reduce({}) do |memo, model|
-        (memo[model.class.type_alias] ||= []) << model if model.exists?
-        memo
-      end
+      @all_models_by_type ||= begin
+                                all_models.reduce({}) do |memo, model|
+                                  (memo[model.class.type_alias.to_s] ||= []) << model if model.exists?
+                                  memo
+                                end
+                              end
     end
 
     def purge(model_type=nil)
-      if model_type
-        plural = model_type.to_s.pluralize
-
-        if instance_variable_get("@#{ plural }")
-          instance_variable_set("@#{plural}",nil)
-        end
-      end
-
-      documents.reject! {|doc| !doc.path.exist? }
+      load_documents
+      @all_models_by_type = nil
+      @all_models = nil
     end
 
     def self.define_document_finder_methods
       # Create a finder method on the repository
       # which lets us find instances of models by their class name
       Brief::Model.table.keys.each do |type|
-        plural = type.to_s.pluralize
-
-        define_method("#{ plural }") do
-          instance_variable_get("@#{ plural }") || send("#{ plural }!")
-        end
 
-        define_method("#{ plural }!") do
-          instance_variable_set("@#{plural}", Brief::Model.existing_models_for_type(type))
-          instance_variable_get("@#{ plural }")
-        end
       end
     end
   end

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.5.2'
+  VERSION = '1.6.0'
 end

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

@@ -8,3 +8,7 @@ title: Summary
 The Blueprint by Architects.io is a functional specifications and requirements document that joins together various materials produced by Software Architects, Domain Modelers, Researchers, UX and UI Designers, Engineers, and Product Managers.  The overall purpose is to communicate design intent, vision, and goals, along with the strategy and logistics of implementation.  
 
 Our aim is to reduce the overall communication effort required to deliver products whose results more closely match the intent and goals.  This requires more effective communication tools, a more effortless feedback loop, and a methodology for validating and refining the goals themselves as everyone's understanding develops. 
+
+```yaml
+nested: structure
+```

data/spec/fixtures/example/models/page.rb

@@ -8,5 +8,6 @@ class Brief::Page
   content do
     title "h1:first-of-type"
     paragraph "p:first-of-type"
+    yaml_data "code.yaml:first-of-type", :serialize => :yaml
   end
 end

data/spec/lib/brief/apps_spec.rb

@@ -0,0 +1,31 @@
+require "spec_helper"
+
+describe "Packaged Apps" do
+  let(:sample) do
+    Brief::Briefcase.new(app: "sample")
+  end
+
+  let(:blueprint) do
+    Brief::Briefcase.new(app: "blueprint")
+  end
+
+  it "should find the right path for an app name" do
+    expect(Brief::Apps.path_for("blueprint")).to be_exist
+  end
+
+  it "should be using the blueprint app" do
+    expect(blueprint).to be_uses_app
+  end
+
+  it "should pick up the view defined" do
+    expect(Brief.views.key?(:summary)).to eq(true)
+  end
+
+  it "should be using the blueprint app" do
+    expect(sample).to be_uses_app
+  end
+
+  it "should find the test app, and the gem apps" do
+    expect(Brief::Apps.available_apps).to include("blueprint","sample")
+  end
+end

data/spec/lib/brief/briefcase_spec.rb

@@ -19,13 +19,14 @@ describe "The Briefcase" do
     expect(briefcase.settings.settings).to be_present
   end
 
+  # Need to improve this
   context "Model Loading" do
-    it "loads the model definitions from the models folder" do
-      expect(Brief::Model.classes.length).to eq(4)
+    it "loads the model definitions from the models and the apps folder" do
+      expect(Brief::Model.classes).not_to be_empty
     end
 
     it "loads the model definitions from the DSL in the config file" do
-      expect(Brief::Model.classes.length).to eq(4)
+      expect(Brief::Model.classes).not_to be_empty
     end
 
     it "caches the output" do

data/spec/lib/brief/document_spec.rb

@@ -40,7 +40,7 @@ describe "The Brief Document" do
   end
 
   it "can resolve the model type using the parent folder name if possible" do
-    expect(Brief::Model.for_folder_name(sample.parent_folder_name)).to eq(Brief::Epic)
+    expect(Brief::Model.for_folder_name(sample.parent_folder_name).type_alias).to eq("epic")
   end
 
   context "Content Extraction" do

data/spec/lib/brief/serializers_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe "Serializing From Docs" do
+  let(:page) {
+    Brief.testcase.pages.first
+  }
+
+  it "should serialize the yaml" do
+    expect(page.yaml_data.nested).to eq("structure")
+  end
+end

data/spec/spec_helper.rb

@@ -33,3 +33,5 @@ RSpec.configure do |config|
   config.include Rack::Test::Methods
   config.include TestHelpers
 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.5.2
+  version: 1.6.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -237,6 +237,12 @@ files:
 - README.md
 - Rakefile
 - TUTORIAL.md
+- apps/blueprint/config.rb
+- apps/blueprint/models/epic.rb
+- apps/blueprint/models/page.rb
+- apps/blueprint/models/persona.rb
+- apps/blueprint/models/user_story.rb
+- apps/blueprint/models/wireframe.rb
 - bin/brief
 - brief.gemspec
 - examples/blog/brief.rb
@@ -244,6 +250,7 @@ files:
 - lib/.DS_Store
 - lib/brief.rb
 - lib/brief/adapters/middleman.rb
+- lib/brief/apps.rb
 - lib/brief/briefcase.rb
 - lib/brief/cli/change.rb
 - lib/brief/cli/init.rb
@@ -283,6 +290,7 @@ files:
 - spec/acceptance/modifying_spec.rb
 - spec/acceptance/schema_spec.rb
 - spec/acceptance/showing_spec.rb
+- spec/fixtures/apps/sample/config.rb
 - spec/fixtures/example/brief.rb
 - spec/fixtures/example/docs/concept.html.md
 - spec/fixtures/example/docs/epics/epic.html.md
@@ -300,6 +308,7 @@ files:
 - spec/fixtures/structures/one.html.md
 - spec/fixtures/structures/three.html.md
 - spec/fixtures/structures/two.html.md
+- spec/lib/brief/apps_spec.rb
 - spec/lib/brief/briefcase_spec.rb
 - spec/lib/brief/document_spec.rb
 - spec/lib/brief/dsl_spec.rb
@@ -309,6 +318,7 @@ files:
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
+- spec/lib/brief/serializers_spec.rb
 - spec/lib/brief/server/gateway_spec.rb
 - spec/lib/brief/server/route_spec.rb
 - spec/lib/brief/structure_spec.rb
@@ -346,6 +356,7 @@ test_files:
 - spec/acceptance/modifying_spec.rb
 - spec/acceptance/schema_spec.rb
 - spec/acceptance/showing_spec.rb
+- spec/fixtures/apps/sample/config.rb
 - spec/fixtures/example/brief.rb
 - spec/fixtures/example/docs/concept.html.md
 - spec/fixtures/example/docs/epics/epic.html.md
@@ -363,6 +374,7 @@ test_files:
 - spec/fixtures/structures/one.html.md
 - spec/fixtures/structures/three.html.md
 - spec/fixtures/structures/two.html.md
+- spec/lib/brief/apps_spec.rb
 - spec/lib/brief/briefcase_spec.rb
 - spec/lib/brief/document_spec.rb
 - spec/lib/brief/dsl_spec.rb
@@ -372,6 +384,7 @@ test_files:
 - spec/lib/brief/rendering_spec.rb
 - spec/lib/brief/repository_spec.rb
 - spec/lib/brief/section_builder_spec.rb
+- spec/lib/brief/serializers_spec.rb
 - spec/lib/brief/server/gateway_spec.rb
 - spec/lib/brief/server/route_spec.rb
 - spec/lib/brief/structure_spec.rb