brief 1.8.6 → 1.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 142e8f462cc9f7d9a8a504788cff6a7b7562f2d8
-  data.tar.gz: 54f32f83c554275697f798a377498f6eb75ae9a7
+  metadata.gz: 903817ba42bbf2c8231ebe66c95bf636feea9094
+  data.tar.gz: fdc126615c19f6d93f6221501e65b92c0153e860
 SHA512:
-  metadata.gz: fdad0e4836b46a6e474cff0732f90a467013315f18f75377dbb4880fdc28896ead148c1ab6942fbff4678c330496c877d1378b933ce9dd93951b0d40039c3250
-  data.tar.gz: 34506086a0dad0d5d91484da8af8922e726322e5c7f3a023f79d7833ac85310c70cc7df12df7cd00b5e7d8a51549e1ac52c00e18cc6996528044ba4655481b35
+  metadata.gz: 246599c7a7fe9c2fd1ce77fca49f53767d9927c9f7a935cc1a94acc649f805147a8b889e4f1753a0ecd06862fdcbbb8dd92b23c00a688a2879076709aefff1da
+  data.tar.gz: 4dabf6f9d9d274b8af89ff2122f302b63bce3a594a17d7a70466a034b87362b4d3ffbe445cc9cb1ae86dcfb63a3af8df5e303b86ad2cfd3ac6d350f155ed7609

data/.gitignore

@@ -1,4 +1,6 @@
-# the test suite writes to this
-spec/fixtures/example/docs
-spec/fixtures/example/docs
+spec/fixtures/example/docs/concept.html.md
 tests/middleman/build
+distro/
+pkg/
+.DS_Store
+node_modules/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+script:
+  - bundle exec rake
+
+rvm:
+  - '2.2.0'
+  - '2.1.5'

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    brief (1.8.6)
+    brief (1.8.7)
       activemodel
       activesupport (>= 4.0)
       commander (>= 4.2.1)
       github-fs
+      github-markdown (~> 0.6.8)
       hashie
       inflecto
-      nokogiri
-      redcarpet (>= 3.2.2)
+      nokogiri (= 1.6.5)
       virtus (>= 1.0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.0)
-      activesupport (= 4.2.0)
+    activemodel (4.2.1)
+      activesupport (= 4.2.1)
       builder (~> 3.1)
-    activesupport (4.2.0)
+    activesupport (4.2.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -45,6 +45,7 @@ GEM
       activesupport (> 3.2.0)
       octokit
       rack
+    github-markdown (0.6.8)
     hashie (3.4.0)
     highline (1.6.21)
     i18n (0.7.0)
@@ -55,7 +56,7 @@ GEM
     mini_portile (0.6.2)
     minitest (5.5.1)
     multipart-post (2.0.0)
-    nokogiri (1.6.6.2)
+    nokogiri (1.6.5)
       mini_portile (~> 0.6.0)
     octokit (3.8.0)
       sawyer (~> 0.6.0, >= 0.5.3)
@@ -69,7 +70,6 @@ GEM
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (10.4.2)
-    redcarpet (3.2.2)
     rspec (3.1.0)
       rspec-core (~> 3.1.0)
       rspec-expectations (~> 3.1.0)
@@ -101,6 +101,7 @@ PLATFORMS
 DEPENDENCIES
   brief!
   bundler (~> 1.3)
+  octokit
   pry
   pry-nav
   rack-test

data/Rakefile

@@ -1,21 +1,25 @@
-require "bundler/gem_tasks"
-
-#!/usr/bin/env rake
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-Bundler::GemHelper.install_tasks
-
-Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+Dir[File.join(Dir.pwd, 'tasks', '**', '*.rb')].each { |f| require f }
+Dir[File.join(Dir.pwd, 'tasks', '*.rake')].each { |f| load f }
 
-require 'rspec/core'
+require "bundler/gem_tasks"
 require 'rspec/core/rake_task'
 
-desc "Run all specs in spec directory (excluding plugin specs)"
-
 RSpec::Core::RakeTask.new(:spec)
 
+Distribution.configure do |config|
+  config.package_name = 'brief'
+  config.version = Brief::VERSION
+  config.rb_version = '20150210-2.1.5'
+  config.packaging_dir = File.expand_path 'packaging'
+  config.native_extensions = [
+    'github-markdown-0.6.8',
+    'escape_utils-1.0.1',
+    #'charlock_holmes-0.7.3',
+    #'posix-spawn-0.3.9',
+    #'nokogumbo-1.3.0',
+    #'rugged-0.21.4',
+    'nokogiri-1.6.5',
+  ]
+end
+
 task :default => :spec

data/apps/blueprint/models/page.rb

@@ -11,6 +11,6 @@ class Brief::Apps::Blueprint::Page
     paragraph "p:first-of-type"
     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
+    yaml "pre[lang='yaml'] code:first-of-type", :serialize => :yaml, :hide => true
   end
 end

data/apps/blueprint/models/roadmap.rb

@@ -0,0 +1,14 @@
+class Brief::Apps::Blueprint::Roadmap
+  include Brief::Model
+
+  meta do
+    title
+    subheading
+  end
+
+  content do
+    define_section "Milestones" do
+      each("h2").has(:title => "h2", :due_date => "li:first-of-type", :paragraph => "p:first-of-type")
+    end
+  end
+end

data/bin/brief

@@ -6,17 +6,17 @@ require 'rubygems'
 require 'brief'
 require 'brief/dsl'
 
-$briefcase = Brief::Briefcase.new(root: Dir.pwd())
 
 if ARGV[0] == "console"
   require 'pry'
+  $briefcase = Brief::Briefcase.new(root: Brief.pwd)
   Pry.start($briefcase)
 else
   require 'commander/import'
 
   program :name, "Brief"
-  program :description, "Brief makes writing markdown more productive"
-  program :version, "0.0.1"
+  program :description, "Brief lets you treat your markdown files like active record objects"
+  program :version, Brief::VERSION 
 
   Brief.load_commands()
 end

data/brief.gemspec

@@ -25,8 +25,14 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'inflecto'
   spec.add_dependency 'activemodel'
   spec.add_dependency 'activesupport', '>= 4.0'
-  spec.add_dependency 'redcarpet', '>= 3.2.2'
-  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'nokogiri', '1.6.5'
+
+  #spec.add_dependency 'github-markup',       '~> 1.3.1'
+  #spec.add_dependency 'github-linguist',     '~> 4.2.5'
+  #spec.add_dependency 'html-pipeline',       '~> 1.11.0'
+  #spec.add_dependency 'sanitize',            '~> 3.1.0'
+  spec.add_dependency 'github-markdown',     '~> 0.6.8'
+ 
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
@@ -34,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-nav"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rack-test"
-
+  spec.add_development_dependency 'octokit'
 end
 
 

data/examples/blog/brief.rb

@@ -1,28 +1,23 @@
-# configuration options for this briefcase
+root = Pathname(Dir.pwd)
+
 config do
-  set(:models_path => Pathname(__FILE__).parent.join("models"))
+  # You can put any special brief configuration here
+  # set(models_path: root.join('models')) if root.join('models').exist?
+  # set(templates_path: root.join('templates')) if root.join('templates').exist?
+  # set(docs_path: root.join('documents')) if root.join('documents').exist?
 end
 
-# define a Post model
-define("Post") do
 
-  # the post model will have YAML frontmatter
-  # with values for 'status' and 'date'
+define "Post" do
   meta do
-    status
-    date DateTime, :default => lambda {|post, attr| post.document.created_at }
+    title
+    status :in => %w(draft published)
+    tags Array
   end
+  
 
-  # the post model will have a 'title' method which returns the text
-  # from the first h1 heading
   content do
-    title "h1"
-    has_many :subheadings, "h2"
-  end
-
-  actions do
-    def publish(options={})
-      puts "The publish action"
-    end
+    title "h1:first-of-type"
+    subheading "h2:first-of-type"
   end
 end

data/examples/blog/docs/posts/this-is-my-first-post.md

@@ -0,0 +1,12 @@
+---
+type: post
+title: This is my first post
+status: published
+tags:
+  - default
+  - intro
+---
+
+# This is my first post
+
+I should write something clever.

data/lib/brief.rb

@@ -5,12 +5,18 @@ require 'virtus'
 require 'inflecto'
 require 'active_support'
 require 'active_support/core_ext'
-require 'redcarpet'
+require 'github/markdown'
 require 'nokogiri'
 require 'yaml'
 require 'erb'
 
 module Brief
+  # When packaging this up through the traveling ruby system
+  # Dir.pwd is not accurate because of the wrapper. We shim it
+  # by setting a special ENV variable in that file
+  def self.pwd
+    ENV.fetch('BRIEF_PWD') { Dir.pwd }
+  end
 
   def self.cases
     @cases ||= {}
@@ -32,16 +38,16 @@ module Brief
     Brief::Configuration.instance
   end
 
-  def self.gem_root
+  def self.lib_root
     Pathname(File.dirname(__FILE__))
   end
 
   def self.apps_path
-    gem_root.join("..","apps")
+    lib_root.join("..","apps")
   end
 
   def self.load_commands
-    Dir[gem_root.join('brief', 'cli', '**/*.rb')].each { |f| require(f) }
+    Dir[lib_root.join('brief', 'cli', '**/*.rb')].each { |f| require(f) }
 
     # the instance methods which get defined with the helper
     Brief::Model.classes.each do |klass|

data/lib/brief/apps.rb

@@ -1,7 +1,7 @@
 module Brief
   class Apps
     def self.default_path
-      Brief.gem_root.join("..","apps")
+      Brief.lib_root.join("..","apps")
     end
 
     def self.search_paths

data/lib/brief/briefcase.rb

@@ -94,9 +94,7 @@ module Brief
     def use(module_type=:app, module_id)
       options[:app] = module_id.to_s
 
-      if app_path && app_path.exist?
-        instance_eval(app_config_path.read)
-      end
+      run(app_config_path) if app_path.try(&:exist?)
     end
 
     def data
@@ -132,9 +130,12 @@ module Brief
         config_path = root.join(config_path)
       end
 
-      if config_path.exist?
-        instance_eval(config_path.read) rescue nil
-      end
+      run(config_path) if config_path.exist?
+    end
+
+    def run(code_or_file)
+      code = code_or_file.is_a?(Pathname) ? code_or_file.read : code
+      instance_eval(code)
     end
 
     def uses_app?
@@ -191,7 +192,7 @@ module Brief
     end
 
     def root
-      Pathname(options.fetch(:root) { Dir.pwd })
+      Pathname(options.fetch(:root) { Brief.pwd })
     end
 
     def docs_path
@@ -206,7 +207,7 @@ module Brief
       value = options.fetch(:models_path) { config.models_path }
 
       if value.to_s.match(/\./)
-        Pathname(Dir.pwd).join(value)
+        Pathname(Brief.pwd).join(value)
       elsif value.to_s.match(/\//)
         Pathname(value)
       else
@@ -228,5 +229,9 @@ module Brief
         super
       end
     end
+
+    def self.create_new_briefcase(options={})
+      Brief::Briefcase::Initializer.new(options).run
+    end
   end
 end

data/lib/brief/briefcase/initializer.rb

@@ -0,0 +1,64 @@
+class Brief::Briefcase
+  class Initializer
+    def initialize(options={})
+      @options = options.to_mash
+    end
+
+    def run
+      options = @options
+      root    = options.root
+
+      FileUtils.mkdir_p(root.join("docs","posts"))
+
+      config = "use(#{options.app})\n" if options.app
+
+      config = <<-EOF
+      root = Pathname(Dir.pwd)
+
+      config do
+        # You can put any special brief configuration here
+        # set(models_path: root.join('models')) if root.join('models').exist?
+        # set(templates_path: root.join('templates')) if root.join('templates').exist?
+        # set(docs_path: root.join('documents')) if root.join('documents').exist?
+      end
+      \n
+      define "Post" do
+        meta do
+          title
+          status :in => %w(draft published)
+          tags Array
+        end
+        \n
+        content do
+          title "h1:first-of-type"
+          subheading "h2:first-of-type"
+        end
+      end
+      EOF
+
+      example = <<-EOF
+      ---
+      type: post
+      title: This is my first post
+      status: published
+      tags:
+        - default
+        - intro
+      ---
+
+      # This is my first post
+
+      I should write something clever.
+      EOF
+
+      config.gsub!(/^\ {1,6}/m, '')
+      example.gsub!(/^\ {1,6}/m, '')
+
+      root.join("docs","posts","this-is-my-first-post.md").open("w+") {|fh| fh.write(example) }
+
+      root.join("brief.rb").open("w+") do |fh|
+        fh.write(config)
+      end
+    end
+  end
+end

data/lib/brief/cli/all.rb

@@ -0,0 +1,69 @@
+command 'change' do |c|
+  c.syntax = 'brief change ATTRIBUTE [OPTIONS]'
+  c.description = 'change attributes of brief documents'
+
+  c.option '--from VALUE', String, 'Only apply when the attributes current value matches.'
+  c.option '--to VALUE', String, 'Only apply when the attributes current value matches.'
+  c.option '--root PATH', String, 'The root directory for the briefcase'
+  c.option '--operator VALUE', String, 'What operator to use in matching the from value. (eq,neq,gt,gte,lt,lte). defaults: eq'
+  c.option '--dry-run', nil, "Don't actually save"
+
+  c.action do |args, options|
+    options.default(root: Pathname(Brief.pwd), operator: "eq")
+    attribute = args.shift
+    paths     = args.map {|a| Dir[options.root.join(a)] }.flatten
+
+    briefcase = Brief::Briefcase.new(root: options.root)
+    documents = briefcase.documents_at(*paths)
+
+    if options.from
+      #attribute = attribute.to_sym.send(options.operator)
+      attribute = attribute.to_sym
+      documents = Brief::DocumentMapper::Query.new(documents).where({attribute => options.from}).all
+    end
+
+    if documents.length == 0
+      puts "No documents match this selection"
+    end
+
+    if options.dry_run
+      puts documents
+    end
+  end
+end
+
+command 'init' do |c|
+  c.syntax = 'brief init NAME [OPTIONS]'
+  c.description = 'Create a new brief project, aka a briefcase'
+
+  c.option '--root', String, 'The root folder for the new project.'
+  c.option '--app', String, 'Which existing app would you like to use?'
+
+  c.action do |args, options|
+    options.default :root => (args.first || Brief.pwd)
+
+    root = Pathname(options.root)
+
+    if root.join('brief.rb').exist?
+      puts "A Brief project already exists in this folder"
+    else
+      require 'brief/briefcase/initializer'
+      Brief::Briefcase.create_new_briefcase(root: root, app: options.app)
+    end
+  end
+end
+
+command 'info' do |c|
+  c.syntax = 'brief info'
+  c.description = 'View info about the brief environment'
+
+  c.action do |args, options|
+    # traveling ruby is reporting this incorrectly
+    puts "\n-- Paths:"
+    puts "Dir.pwd = #{ Dir.pwd }"
+    puts "Brief.pwd = #{ Brief.pwd }"
+
+    puts "\n-- Available apps:"
+    puts Brief::Apps.available_apps.join("\n")
+  end
+end