brief 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1274b95c43a49d1b2090319bd2835032a85379fe
-  data.tar.gz: 602de90a32e517581da9a6fc10b6d146de3cd751
+  metadata.gz: 9a3acf77feeaf14fa2cd960e182ef9d3983272bb
+  data.tar.gz: a49c26a0ab788f553faef5e06c2ee4c78935fad8
 SHA512:
-  metadata.gz: 4ba19577490cbf2f2fcab6bb7398d58db0335a1bb700877778a41be3bf2fd75eb4a4b68f6081587ba4e1a917d801a95da454b2c81e56c6baad3a62ccf255fbad
-  data.tar.gz: 0d378928c0c0c1d1dd634b6089c64a81ff7a77104df846c1fc8dca486587afb2febae85e53e5bbed95d0ba652a47a7e94bb796f5d2fc60f593979ea8e1d5e913
+  metadata.gz: d8d95128ea80a9a7b03c49eb1d12cccfdc1792468e2fc713e74d34ff342086a3748d66243969deae46df73876da2d99284ab32e46001a6c6ac23c830fb48747d
+  data.tar.gz: abfdd1bc9606144883135179ecf6b28316caf9b886c9d33b60eb41057fb4e0a953748ec2c5b7d02fd92ebcd8c937739c9b72e24cd44374bbedf2d047b7e76275

data/.gitignore

@@ -1,3 +1,4 @@
 # the test suite writes to this
 spec/fixtures/example/docs
 spec/fixtures/example/docs
+tests/middleman/build

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    brief (1.7.1)
+    brief (1.7.2)
       activemodel
-      activesupport
+      activesupport (>= 4.0)
       commander (>= 4.2.1)
       github-fs
       hashie

data/brief.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'virtus', '>= 1.0.3'
   spec.add_dependency 'inflecto'
   spec.add_dependency 'activemodel'
-  spec.add_dependency 'activesupport'
+  spec.add_dependency 'activesupport', '>= 4.0'
   spec.add_dependency 'redcarpet', '>= 3.2.2'
   spec.add_dependency 'nokogiri'
 

data/lib/brief.rb

@@ -69,8 +69,9 @@ module Brief
   # Adapters for Rails, Middleman, or Jekyll apps
   def self.activate_adapter(identifier)
     require "brief/adapters/#{ identifier }"
-    adapter = (Brief::Adapters.const_get(identifier.camelize) rescue nil)
-    adapter.try(:activate_adapter)
+    (Brief::Adapters.const_get(identifier.camelize) rescue nil).tap do |adapter|
+      raise "Invalid adapter: #{ identifier }" unless adapter
+    end
   end
 end
 
@@ -99,3 +100,4 @@ require 'brief/briefcase'
 require 'brief/apps'
 
 Brief::Apps.create_namespaces()
+Brief.activate_adapter("middleman_extension").activate_brief_extension() if defined?(::Middleman)

data/lib/brief/adapters/middleman_extension.rb

@@ -0,0 +1,41 @@
+module Brief::Adapters
+  class MiddlemanExtension < ::Middleman::Extension
+    def self.activate_brief_extension
+      ::Middleman::Extensions.register(:brief, Brief::Adapters::MiddlemanExtension)
+    end
+
+    def initialize(app, options_hash = {}, &block)
+      super
+
+    end
+
+    helpers do
+      def brief_config_path
+        Pathname(root).join("brief.rb")
+      end
+
+      def briefs
+        briefcase
+      end
+
+      def briefcase
+        if !brief_config_path.exist?
+          brief_config_path.open("w+") {|fh| fh.write("# See github.com/datapimp/brief for documentation")}
+        end
+
+        if development?
+           Brief::Briefcase.new(root: root,
+                                config_path: brief_config_path,
+                                caching: false)
+        else
+          @briefs ||= begin
+                       Brief::Briefcase.new(root: root,
+                                            config_path: brief_config_path,
+                                            caching: true)
+                     end
+        end
+      end
+    end
+
+  end
+end

data/lib/brief/briefcase.rb

@@ -80,8 +80,10 @@ module Brief
       end
     end
 
-    def config
-      Brief::Configuration.instance
+    def config(&block)
+      Brief::Configuration.instance.tap do |cfg|
+        cfg.instance_eval(&block) if block.respond_to?(:call)
+      end
     end
 
     def server(options={})

data/lib/brief/document.rb

@@ -106,6 +106,11 @@ module Brief
 
     def in_briefcase(briefcase)
       @briefcase_root = briefcase.root
+
+      unless Brief::Util.ensure_child_path(briefcase.docs_path, path)
+        raise 'Invalid document path'
+      end
+
       self
     end
 

data/lib/brief/document/structure.rb

@@ -154,7 +154,7 @@ module Brief
         end
 
         def level(element)
-          element.name.to_s.gsub(/^h/i, '').to_i
+          (element && element.name.to_s.gsub(/^h/i, '')).to_i
         end
       end
     end

data/lib/brief/repository.rb

@@ -23,6 +23,11 @@ module Brief
     def method_missing(meth, *args, &block)
       in_model_group = model_groups.include?(meth.to_s)
 
+      if options[:caching] == false || options[:cache] == false
+        @all_models = nil
+        @all_models_by_type = nil
+      end
+
       if in_model_group && args.empty?
         find_models_by_type(meth)
       elsif in_model_group && !args.empty?
@@ -52,8 +57,14 @@ module Brief
       documents_at(*paths).select {|doc| doc.path.exist? }
     end
 
+    InvalidPath = Class.new(Exception)
+
     def normalize_path(p)
-      docs_path.join(p)
+      docs_path.join(p).tap do |normalized|
+        if normalized.to_s.split("/").length < docs_path.realpath.to_s.split("/").length
+          raise InvalidPath
+        end
+      end
     end
 
     def documents_at(*paths)
@@ -96,7 +107,7 @@ module Brief
     end
 
     def document_paths
-      Dir[root.join('**/*.md').to_s].map { |p| Pathname(p) }
+      Dir[docs_path.join('**/*.md').to_s].map { |p| Pathname(p) }
     end
 
     def all_models

data/lib/brief/server/handlers/browse.rb

@@ -1,8 +1,18 @@
 module Brief::Server::Handlers
   class Browse
+    def self.available_handlers
+      Brief::Model.classes.map(&:type_alias).map(&:pluralize)
+    end
+
     def self.handle(path_args, briefcase, options={})
-      models = Array((briefcase.send(path_args) rescue nil))
-      [200, {"Content-Type"=>"application/json"}, models.map(&:as_json)]
+      model_type = Array(path_args).first
+
+      if available_handlers.include?(model_type)
+        models = briefcase.send(model_type.to_s)
+        [200, {"Content-Type"=>"application/json"}, models.map(&:as_json)]
+      else
+        [403, {"Content-Type"=>"application/json"}, {error: "Invalid model type"}]
+      end
     end
   end
 end

data/lib/brief/server/handlers/modify.rb

@@ -56,6 +56,11 @@ module Brief::Server::Handlers
           return @errors
         end
 
+        if !Brief::Util.ensure_child_path(briefcase.docs_path, path)
+          @errors[:path] = "Invalid Path"
+          return @errors
+        end
+
         doc = Brief::Document.new(path).tap do |document|
           document.in_briefcase(briefcase)
 

data/lib/brief/server/handlers/show.rb

@@ -7,7 +7,11 @@ module Brief::Server::Handlers
       view      = parts.shift.to_s.downcase
       path      = parts.join("/")
 
-      document = briefcase.document_at(path) rescue nil
+      document = begin
+                   briefcase.document_at(path)
+                 rescue Brief::Repository::InvalidPath
+                   :forbidden
+                 end
 
       code          = 200
       content_type  = "application/json"
@@ -16,6 +20,9 @@ module Brief::Server::Handlers
       when document.nil?
         code = 404
         body = {error: "Not found"}
+      when document == :forbidden
+        code = 403
+        body = {error: "Access denied." }
       when !%w(content rendered details).include?(view)
         code = 400
         body = {error: "Invalid view: must be content, rendered, details" }

data/lib/brief/util.rb

@@ -1,4 +1,17 @@
 module Brief::Util
+  def self.ensure_child_path(root, testpath)
+    root = Pathname(root).realpath.to_s.downcase
+    testpath = Pathname(testpath).parent.realpath.to_s.downcase
+
+    outside = !!(root.split("/").length > testpath.split("/").length)
+
+    if !outside && testpath.match(/^#{root}/)
+      return true
+    end
+
+    false
+  end
+
   def self.split_doc_content(raw_content)
     if raw_content =~ /^(---\s*\n.*?\n?)^(---\s*$\n?)/m
       content = raw_content[(Regexp.last_match[1].size + Regexp.last_match[2].size)..-1]

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.7.2'
+  VERSION = '1.7.3'
 end

data/spec/acceptance/modifying_spec.rb

@@ -1,6 +1,11 @@
 require "spec_helper"
 
 describe "Modifying Documents", :type => :request do
+  it "will not let me work with a document outside of the root" do
+    post "/create/epics/../../../newly-created-epic.html.md", content: "# Epic Title"
+    expect(last_response.status).to eq(500)
+  end
+
   it "lets me create new documents by passing data and content" do
     begin
       post "/create/epics/newly-created-epic.html.md", content: "# Epic Title"

data/spec/acceptance/showing_spec.rb

@@ -1,6 +1,12 @@
 require "spec_helper"
 
 describe "Viewing a Briefcase Document", :type => :request do
+
+  it "does not show the document content if it is invalid" do
+    get("/view/content/../../../../spec_helper.rb")
+    expect(last_response.status).to eq(403)
+  end
+
   it "shows the document content" do
     get("/view/content/epics/epic.html.md")
     expect(last_response.status).to eq(200)

data/spec/lib/brief/document_spec.rb

@@ -5,6 +5,9 @@ describe "The Brief Document" do
     Brief.example_document
   end
 
+  it "wont let me create a document outside of the briefcase" do
+    expect(lambda { Brief::Document.new("/test.html.md").in_briefcase(Brief.testcase) }).to raise_error
+  end
   it "creates a new doc if the path doesn't exist" do
     begin
       new_path = Brief.testcase.docs_path.join("newly-created.html.md")

data/spec/lib/brief/models/release_spec.rb

@@ -4,6 +4,6 @@ describe "Simple Files" do
   let(:doc) { Brief.testcase.releases.first }
 
   it "still renders simple html with no headings" do
-    binding.pry
+    expect(lambda { doc.to_html }).not_to raise_error
   end
 end

data/tests/middleman/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'middleman', '~> 3.3.9'
+gem  "pry"
+gem "brief", :path => File.join(File.dirname(__FILE__), "..","..")

data/tests/middleman/Gemfile.lock

@@ -0,0 +1,178 @@
+PATH
+  remote: /Users/jonathan/Gems/brief
+  specs:
+    brief (1.7.2)
+      activemodel
+      activesupport (>= 4.0)
+      commander (>= 4.2.1)
+      github-fs
+      hashie
+      inflecto
+      nokogiri
+      redcarpet (>= 3.2.2)
+      virtus (>= 1.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (4.1.9)
+      activesupport (= 4.1.9)
+      builder (~> 3.1)
+    activesupport (4.1.9)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.1)
+      tzinfo (~> 1.1)
+    addressable (2.3.7)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    builder (3.2.2)
+    celluloid (0.16.0)
+      timers (~> 4.0.0)
+    chunky_png (1.3.4)
+    coderay (1.1.0)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    coffee-script (2.3.0)
+      coffee-script-source
+      execjs
+    coffee-script-source (1.9.1)
+    commander (4.3.0)
+      highline (~> 1.6.11)
+    compass (1.0.3)
+      chunky_png (~> 1.2)
+      compass-core (~> 1.0.2)
+      compass-import-once (~> 1.0.5)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      sass (>= 3.3.13, < 3.5)
+    compass-core (1.0.3)
+      multi_json (~> 1.0)
+      sass (>= 3.3.0, < 3.5)
+    compass-import-once (1.0.5)
+      sass (>= 3.2, < 3.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.9)
+    erubis (2.7.0)
+    execjs (2.4.0)
+    faraday (0.9.1)
+      multipart-post (>= 1.2, < 3)
+    ffi (1.9.6)
+    github-fs (0.0.1)
+      activesupport (> 3.2.0)
+      octokit
+      rack
+    haml (4.0.6)
+      tilt
+    hashie (3.4.0)
+    highline (1.6.21)
+    hike (1.2.3)
+    hitimes (1.2.2)
+    hooks (0.4.0)
+      uber (~> 0.0.4)
+    i18n (0.7.0)
+    ice_nine (0.11.1)
+    inflecto (0.0.2)
+    json (1.8.2)
+    kramdown (1.6.0)
+    listen (2.9.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    method_source (0.8.2)
+    middleman (3.3.10)
+      coffee-script (~> 2.2)
+      compass (>= 1.0.0, < 2.0.0)
+      compass-import-once (= 1.0.5)
+      execjs (~> 2.0)
+      haml (>= 4.0.5)
+      kramdown (~> 1.2)
+      middleman-core (= 3.3.10)
+      middleman-sprockets (>= 3.1.2)
+      sass (>= 3.4.0, < 4.0)
+      uglifier (~> 2.5)
+    middleman-core (3.3.10)
+      activesupport (~> 4.1.0)
+      bundler (~> 1.1)
+      erubis
+      hooks (~> 0.3)
+      i18n (~> 0.7.0)
+      listen (>= 2.7.9, < 3.0)
+      padrino-helpers (~> 0.12.3)
+      rack (>= 1.4.5, < 2.0)
+      rack-test (~> 0.6.2)
+      thor (>= 0.15.2, < 2.0)
+      tilt (~> 1.4.1, < 2.0)
+    middleman-sprockets (3.4.2)
+      middleman-core (>= 3.3)
+      sprockets (~> 2.12.1)
+      sprockets-helpers (~> 1.1.0)
+      sprockets-sass (~> 1.3.0)
+    mini_portile (0.6.2)
+    minitest (5.5.1)
+    multi_json (1.11.0)
+    multipart-post (2.0.0)
+    nokogiri (1.6.6.2)
+      mini_portile (~> 0.6.0)
+    octokit (3.8.0)
+      sawyer (~> 0.6.0, >= 0.5.3)
+    padrino-helpers (0.12.5)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.12.5)
+      tilt (~> 1.4.1)
+    padrino-support (0.12.5)
+      activesupport (>= 3.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rack (1.6.0)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.5)
+      ffi (>= 0.5.0)
+    redcarpet (3.2.2)
+    sass (3.4.13)
+    sawyer (0.6.0)
+      addressable (~> 2.3.5)
+      faraday (~> 0.8, < 0.10)
+    slop (3.6.0)
+    sprockets (2.12.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-helpers (1.1.0)
+      sprockets (~> 2.0)
+    sprockets-sass (1.3.1)
+      sprockets (~> 2.0)
+      tilt (~> 1.1)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tilt (1.4.1)
+    timers (4.0.1)
+      hitimes
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    uber (0.0.13)
+    uglifier (2.7.1)
+      execjs (>= 0.3.0)
+      json (>= 1.8.0)
+    virtus (1.0.4)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  brief!
+  middleman (~> 3.3.9)
+  pry

data/tests/middleman/brief.rb

@@ -0,0 +1,16 @@
+dir = Pathname(File.dirname(__FILE__))
+
+config do
+  set(:docs_path, dir.join("documents"))
+end
+
+define "Page" do
+  meta do
+    title
+  end
+
+  content do
+    title "h1:first-of-type"
+    paragraphs "p"
+  end
+end

data/tests/middleman/config.rb

@@ -0,0 +1 @@
+activate :brief

data/tests/middleman/documents/pages/one.md

@@ -0,0 +1,8 @@
+---
+type: page
+title: Page One
+---
+
+# This is page one
+
+This is incredible.

data/tests/middleman/documents/pages/two.md

@@ -0,0 +1,8 @@
+---
+type: page
+title: Page Two
+---
+
+# This is page two
+
+This is super.

data/tests/middleman/source/index.html.erb

@@ -0,0 +1,6 @@
+
+<% briefs.pages.each do |page| %>
+  <h1><%= page.title %></h1>
+  <p>This page has <%= page.paragraphs.length %> paragraphs</p>
+<% end %>
+

data/tests/middleman/source/layouts/layout.erb

@@ -0,0 +1,7 @@
+<html>
+  <head>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -250,7 +250,7 @@ files:
 - examples/blog/docs/an-intro-to-brief.html.md
 - lib/.DS_Store
 - lib/brief.rb
-- lib/brief/adapters/middleman.rb
+- lib/brief/adapters/middleman_extension.rb
 - lib/brief/apps.rb
 - lib/brief/briefcase.rb
 - lib/brief/cli/change.rb
@@ -330,6 +330,14 @@ files:
 - spec/spec_helper.rb
 - spec/support/test_helpers.rb
 - tasks/brief/release.rake
+- tests/middleman/Gemfile
+- tests/middleman/Gemfile.lock
+- tests/middleman/brief.rb
+- tests/middleman/config.rb
+- tests/middleman/documents/pages/one.md
+- tests/middleman/documents/pages/two.md
+- tests/middleman/source/index.html.erb
+- tests/middleman/source/layouts/layout.erb
 homepage: ''
 licenses:
 - MIT

data/lib/brief/adapters/middleman.rb

@@ -1,17 +0,0 @@
-module Brief::Adapters
-  class MiddlemanExtension
-    def self.activate_brief_extension
-      ::Middleman::Extensions.register(:brief, Brief::Adapters::MiddlemanExtension)
-    end
-
-    def initialize(app, options_hash = {}, &block)
-      super
-
-      app.include(ClassMethods)
-
-      options_hash.each do |key, value|
-        app.set(key, value)
-      end
-    end
-  end
-end