brief 1.6.1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e40ba8497cd64fef959861d1349e7a955bbf0df7
-  data.tar.gz: 596ab5f961548a7ff2088d87bc0e4e68c3ef1b47
+  metadata.gz: 5994d22ccc22af64d2a24fb82f2cbc687eba9dad
+  data.tar.gz: 238e456cc9f8f35cf0b58e6d8963f857935b28ec
 SHA512:
-  metadata.gz: 263dfac1ba20242d8aae3c3fa7d2876bef767141c7d05f66723ac068d10efb3e8b1c5e8fb4f06bc10e4dfd5bc85363d3ef02b6e5b78a3ae98b8163a3460d7737
-  data.tar.gz: cf69dca6f61a98015ee53b8bc54dc64f32160b4533aa89d2200081bb38dd01cfb94e3fab0ee4097122ba0f6737fdd0b3352edb3b564d73421c6ec86fa657fa40
+  metadata.gz: b6923156ac95ba428b498b98290ca2e2a03fcee5ddd28da8f90029e6ec4c5fb5c144de04e87929b7923065f43ada6df779cdf2e025e498a3abc063dbcbad358b
+  data.tar.gz: 2e09b44afca6169797fe7cc31d9bbdf396b824279112dc59d480019abe245029c7e8c3f1c0c7663551eefe85e7de01218f43716ddb565af4513b5c0a023fa907

data/.gitignore

@@ -1,3 +1,3 @@
 # the test suite writes to this
-spec/fixtures/example/docs/epic.html.md
-spec/fixtures/example/docs/concept.html.md
+spec/fixtures/example/docs
+spec/fixtures/example/docs

data/Gemfile.lock

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

data/apps/blueprint/config.rb

@@ -1,6 +1,9 @@
-view(:summary) do |briefcase, params|
+view(:summary) do |*args|
+  params = args.extract_options!
+  briefcase = args.first
+
   briefcase.present(:default, params).tap do |hash|
-    if summary = where(title:"Summary",type:"page").first
+    if summary = briefcase.pages.find {|p| p.title == "Summary" }
       hash.merge!(summary: summary.to_model.as_json(:rendered=>true, :content=>true))
     end
   end

data/apps/blueprint/models/epic.rb

@@ -35,6 +35,9 @@ As a **User** I would like to **Do this** so that I can **succeed**
 
   content do
     title "h1:first-of-type"
+    paragraph "p:first-of-type"
+    paragraphs "p"
+
     define_section "User Stories" do
       each("h2").has(:title     => "h2",
                      :paragraph => "p:first-of-type",

data/apps/blueprint/models/page.rb

@@ -8,9 +8,9 @@ class Brief::Apps::Blueprint::Page
   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
+    title "h1:first-of-type", :hide => true
+    tagline "h2:first-of-type", :hide => true
+    yaml_data "code.yaml:first-of-type", :serialize => :yaml, :hide => true
   end
 end

data/clients/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "brief-client",
+  "version": "0.0.1",
+  "description": "a client for the brief markdown as a database service",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC"
+}

data/lib/brief/briefcase.rb

@@ -17,7 +17,7 @@ module Brief
         Brief.case = self
       end
 
-      Brief.cases[root] ||= self
+      Brief.cases[root.basename.to_s] ||= self
     end
 
     def present(style="default", params={})

data/lib/brief/cli/export.rb

@@ -0,0 +1,21 @@
+command 'export' do |c|
+  c.syntax= 'brief export [OPTIONS]'
+  c.description = 'Export a parsed version of the document collection'
+
+  c.option '--include-content', nil, 'whether to include the unparsed content'
+  c.option '--include-rendered', nil, 'whether to include the rendered content'
+  c.option '--config-path PATH', String, 'Path to the config file'
+
+  c.action do |args, options|
+    options.default :config_path => Pathname(Dir.pwd).join('brief.rb')
+
+
+    briefcase = Brief::Briefcase.new(config_path: Pathname(options.config_path))
+
+    json = briefcase.present("default", content: !!options.include_content, rendered: !!options.include_rendered)
+
+    output = args.first || "briefcase.json"
+
+    Pathname(Dir.pwd).join(output).open("w+") {|fh| fh.write(json.to_json) }
+  end
+end

data/lib/brief/core_ext.rb

@@ -4,6 +4,12 @@ class Hash
   end
 end
 
+class Hashie::Mash
+  def to_mash
+    self
+  end
+end
+
 class String
   def to_pathname
     Pathname(self)

data/lib/brief/document/content_extractor.rb

@@ -12,7 +12,7 @@ module Brief
     end
 
     def content_schema_attributes
-      model_class.definition.content_schema.attributes
+      model_class.definition.content_schema.attributes.symbolize_keys!
     end
 
     def extracted_content_data
@@ -25,39 +25,67 @@ module Brief
     end
 
     def respond_to?(meth)
-      content_schema_attributes.key?(meth) || super
+      supports_extraction?(meth) || super
+    end
+
+    def extraction_rule_for(attribute)
+      content_schema_attributes.fetch(attribute.to_sym, nil)
+    end
+
+    def selector_for(attribute)
+      extraction_rule_for(attribute).first
+    end
+
+    def supports_extraction?(attribute)
+      content_schema_attributes.key?(attribute.to_sym)
     end
 
     def method_missing(meth, *_args, &_block)
-      if settings = content_schema_attributes.fetch(meth, nil)
-        if settings.args.length == 1 && settings.args.first.is_a?(String)
-          selector = settings.args.first
-          matches = document.css(selector)
-
-          if matches.length > 1
-            selector.match(/first-of-type/) ? matches.first.text : matches.map(&:text)
-          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
+      return super unless supports_extraction?(meth)
+      rule = ExtractionRule.new(extraction_rule_for(meth))
+      rule.apply_to(document)
+    end
+
+    class ExtractionRule
+      attr_reader :rule, :args
+
+      def initialize(rule)
+        @rule = rule
+        @args = rule.args
+      end
+
+      def options
+        args[1] || {}.to_mash
+      end
+
+      def deserialize?
+        !!(options.serialize.present? && options.serialize)
+      end
+
+      def format
+        options.serialize.to_sym
+      end
+
+      def selector
+        args.first if args.first.is_a?(String)
+      end
+
+      def apply_to(document)
+        raise 'Must specify a selector' unless selector
+
+        extracted = document.css(selector)
+
+        return nil if extracted.length == 0
+
+        case
+        when deserialize? && format == :json
+          (JSON.parse(extracted.text.to_s) rescue {}).to_mash
+        when deserialize? && format == :yaml
+          (YAML.load(extracted.text.to_s) rescue {}).to_mash
+        when selector.match(/first-of-type/) && extracted.length > 0
+          extracted.first.text
+        else
+          extracted.map(&:text)
         end
       end
     end

data/lib/brief/document.rb

@@ -10,6 +10,18 @@ module Brief
       self
     end
 
+    def to_s
+      "#{ model_class }.at_path(#{relative_path})"
+    end
+
+    def inspect
+      "#{ model_class }.at_path(#{relative_path})"
+    end
+
+    def relative_path
+      briefcase.present? ? path.relative_path_from(briefcase.docs_path) : path
+    end
+
     def initialize(path, options = {})
       if path.respond_to?(:key?) && options.empty?
         @frontmatter = path.to_mash
@@ -27,6 +39,18 @@ module Brief
       end
     end
 
+    def content_hash
+      Digest::MD5.hexdigest(@content.to_s)
+    end
+
+    def file_hash
+      Digest::MD5.hexdigest(path.read.to_s)
+    end
+
+    def content_stale?
+      content_hash != file_hash
+    end
+
     def raw= val
       @raw_set = true
       @raw_content = val
@@ -55,6 +79,7 @@ module Brief
       @frontmatter = nil
       @raw_frontmatter = nil
       @refreshing = true
+      @content_hash = nil
       load_frontmatter
       true
     end
@@ -106,9 +131,10 @@ module Brief
     end
 
     def content
-      if @content.nil?
-        generate_content
+      if @content.nil? && path && path.exist?
+        @content = path.read
       end
+
       @content || generate_content
     end
 
@@ -153,8 +179,14 @@ module Brief
       path.extname
     end
 
+    def model_attributes
+      (data || {}).to_hash
+        .merge(path: path, document: self)
+        .reverse_merge(type: document_type)
+    end
+
     def to_model
-      model_class.new((data || {}).to_hash.merge(path: path, document: self).reverse_merge(:type=>document_type)) if model_class
+      model_class.try(:new, model_attributes)
     end
 
     def exist?

data/lib/brief/model/serializers.rb

@@ -7,7 +7,7 @@ module Brief::Model::Serializers
     doc_path  = path.relative_path_from(docs_path).to_s
 
     # TEMP
-    title = data.try(:[], :title) || extracted_content.try(:title) || (send(:title) rescue nil) || path.basename.to_s.gsub(/\.html.md/,'')
+    title = data.try(:[], :title) || extracted_content_data.try(:title) || (send(:title) rescue nil) || path.basename.to_s.gsub(/\.html.md/,'')
     title = title.to_s.gsub(/\.md/,'')
 
     {
@@ -16,7 +16,7 @@ module Brief::Model::Serializers
       path: path.to_s,
       type: type,
       group: type.to_s.pluralize,
-      title: title,
+      title: document_title,
       actions: self.class.defined_actions,
       urls: {
         view_content_url: "/view/content/#{ doc_path }",

data/lib/brief/model.rb

@@ -29,6 +29,14 @@ module Brief
     end
 
     module AccessorMethods
+      def document_title
+        data.try(:[], :title) ||
+        extracted_content_data.try(:title) ||
+        path.basename.to_s
+          .gsub(/\.html.md/,'')
+          .gsub(/\.md/,'')
+      end
+
       def data
         document.data || {}.to_mash
       end
@@ -112,6 +120,10 @@ module Brief
         type_alias && type_alias == other.type_alias
       end
 
+      def accessor_property_names
+        (definition.content_schema.attributes.keys + definition.metadata_schema.keys).uniq
+      end
+
       def to_schema
         {
           schema: {

data/lib/brief/repository.rb

@@ -21,8 +21,15 @@ module Brief
     end
 
     def method_missing(meth, *args, &block)
-      if model_groups.include?(meth.to_s)
+      in_model_group = model_groups.include?(meth.to_s)
+
+      if in_model_group && args.empty?
         find_models_by_type(meth)
+      elsif in_model_group && !args.empty?
+        group = find_models_by_type(meth)
+        Brief::DocumentMapper::Query.new(group).send(:where, *args)
+      else
+        super
       end
     end
 

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.6.1'
+  VERSION = '1.7.0'
 end

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

@@ -1,8 +1,10 @@
 ---
 type: concept
-title: Blueprint Concept Example
-subheading: A key concept to the domain model
-needle: cbw5astzg5gh0ui3op68054s9sm39me6vjvc
+
 ---
 
-# Modified Content oh5lszxtl7w8uyldpjrum1w5uy3pbr33wsh
+# Modified Content 38inom7nxjlo9z3neuhognu1y75csd79i1ec
+
+1
+
+1

data/spec/lib/brief/hashing_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe "Hashing" do
+  let(:doc) { Brief.concept_document }
+
+  it "has a content hash" do
+    expect(doc.content_hash).not_to be_empty
+  end
+
+  it "has a file system hash" do
+    expect(doc.file_hash).not_to be_empty
+  end
+
+  it "detects when it is stale" do
+    new_content = doc.content += "\n\n1";
+    doc.path.open("w+") {|fh| fh.write("---\ntype: concept\n\n---\n\n#{new_content}") }
+    expect(doc).to be_content_stale
+  end
+
+  it "refreshes itself if stale" do
+    new_content = doc.content += "\n\n1";
+    doc.path.open("w+") {|fh| fh.write("---\ntype: concept\n\n---\n\n#{new_content}") }
+    expect(doc).to be_content_stale
+  end
+
+end

data/spec/lib/brief/repository_spec.rb

@@ -9,11 +9,22 @@ describe "The Brief Document Repository" do
 
   it "gives me the document models for paths" do
     paths = ["./concept.html.md", "wireframe.html.md", "epics/epic.html.md", Brief.example_document.path.realpath]
-
     docs = repository.documents_at(*paths)
+    expect(docs).not_to be_empty
   end
 
   context "querying api" do
+    it "lets me query the model groups with params" do
+      items = Brief.testcase.epics(title:"No Bueno").all
+      expect(items).to be_empty
+    end
+
+    it "lets me query the model group with params" do
+      items = Brief.testcase.epics(title:"Blueprint Epic Example").all
+      expect(items).not_to be_empty
+      expect(items.map(&:title).uniq).to include("Blueprint Epic Example")
+    end
+
     it "finds the first document matching a query" do
       query = repository.where(state:"active")
       expect(query.first.type).to eq("epic")

data/spec/spec_helper.rb

@@ -13,14 +13,19 @@ module Brief
     testcase.root
   end
 
+  def self.concept_document
+    path = Brief.example_path.join("docs","concept.html.md")
+    testcase.document_at(path)
+  end
+
   def self.page_document
     path = Brief.example_path.join("docs","page.html.md")
-    Brief::Document.new(path)
+    testcase.document_at(path)
   end
 
   def self.example_document
     path = Brief.example_path.join("docs","epics","epic.html.md")
-    Brief::Document.new(path)
+    testcase.document_at(path)
   end
 
   def self.testcase

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.7.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-25 00:00:00.000000000 Z
+date: 2015-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -245,6 +245,7 @@ files:
 - apps/blueprint/models/wireframe.rb
 - bin/brief
 - brief.gemspec
+- clients/package.json
 - examples/blog/brief.rb
 - examples/blog/docs/an-intro-to-brief.html.md
 - lib/.DS_Store
@@ -253,6 +254,7 @@ files:
 - lib/brief/apps.rb
 - lib/brief/briefcase.rb
 - lib/brief/cli/change.rb
+- lib/brief/cli/export.rb
 - lib/brief/cli/init.rb
 - lib/brief/cli/write.rb
 - lib/brief/configuration.rb
@@ -312,6 +314,7 @@ files:
 - spec/lib/brief/briefcase_spec.rb
 - spec/lib/brief/document_spec.rb
 - spec/lib/brief/dsl_spec.rb
+- spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
 - spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/persistence_spec.rb
@@ -378,6 +381,7 @@ test_files:
 - spec/lib/brief/briefcase_spec.rb
 - spec/lib/brief/document_spec.rb
 - spec/lib/brief/dsl_spec.rb
+- spec/lib/brief/hashing_spec.rb
 - spec/lib/brief/model_spec.rb
 - spec/lib/brief/models/page_spec.rb
 - spec/lib/brief/persistence_spec.rb