brief 1.11.5 → 1.11.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38fdd7c93772bcfc613fcf91c68a7473d46e52fc
-  data.tar.gz: 157873b94414f9560e862b0551800243665519d8
+  metadata.gz: c777abc6c9fd2ef3ac8b46e526ea2ca0ad8dab05
+  data.tar.gz: a334054f14e1227ce91bff94e1cdd7b4a7339c47
 SHA512:
-  metadata.gz: 9f8ad4c6c40af589138a012d82efc2d08999b6923cb43e7b2833d3113386752b45f82f8db282b21c2d96978b9afd55c2c75a13127522494a2b5d0ee5001e6af4
-  data.tar.gz: 3e96c0094a9b7cd5c3abe1b21668ab00dff6d2ed37535b0931babe7b540d455eeef6f25489325d72f0172306502c659e1ed044da505d39b827355739011156e6
+  metadata.gz: 4ecf27b3d5f36288b54bd0cbd7a4dc142a95dacc22e0afc315f04141aed26e9e22fa0f7c62dce4bf1e57218fd023d1cacc5a5a78f148afc3871147cea756e3d7
+  data.tar.gz: 20fa631cc45a9bbf33f51ecd97f1b001904eab11817dc0f376a2b5df2d47e196951bc07d1d65fa5228883758ba277949c364bdf5cf8cdaaf333cbc6ae09053b4

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.2.2
+RUN useradd -m -d /home/ruby -p ruby ruby && adduser ruby sudo && chsh -s /bin/bash ruby
+
+ENV HOME /home/ruby
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+RUN mkdir /briefcases && chown ruby:ruby /briefcases /usr/local/bundle
+
+WORKDIR /home/ruby
+RUN gem install bundler datapimp brief
+RUN brief start socket server --root /briefcases
+EXPOSE 9094

data/README.md

@@ -138,6 +138,19 @@ You can use an `app` by saying so in your config file:
 use "blueprint" # => $BRIEF_GEM/apps/blueprint
 ```
 
+This will give you access to all of the models and document types from
+that app.
+
+#### Creating your own app
+
+```bash
+brief help create app
+brief create app cookbook # => $HOME/.brief/apps/cookbook 
+```
+
+This will let you start defining models, and then re-using this app
+across different writing projects.
+
 ## Other neat features (TODO)
 
 ### Special Link & Image Tags

data/ROADMAP.md

@@ -0,0 +1,14 @@
+# Roadmap
+
+### Revisit App Structure
+
+Why not follow conventional rails organization?
+
+- app
+  - models/
+  - views/
+  - editors/
+- bin
+- config
+- documents
+- export

data/apps/blueprint/documentation/index.md

@@ -0,0 +1,16 @@
+# Software Blueprint
+
+Why are you building what you are building, and how you will measure
+whether it is successful?  Which projects are required to accomplish the
+overall vision, and how will they relate to one another? What are the core
+concepts of the domain? How will the information be organized? What are
+the different screens that need to be developed, and how should actions
+taken on these screens be relayed to a database or an API? 
+
+Developing a successful software project with a team of designers,
+developers, marketers, and project managers requires maintaining an attention to
+detail as well as clarity and alignment on the big picture.  And it
+requires this over a long period of time, as things change and evolve,
+and as members of the team come and go.
+
+Consider this a living guide for your software project, telling you where you are today, how you got here, and where you are going next month and how you will get there.

data/brief.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'hashie', '>= 3.0.4' 
   spec.add_dependency 'commander', '~> 4.3'
+  spec.add_dependency 'terminal-table'
   spec.add_dependency 'github-fs', '~> 0'
   spec.add_dependency 'virtus', '~> 1.0'
   spec.add_dependency 'inflecto', '~> 0'

data/lib/brief/apps.rb

@@ -11,6 +11,8 @@ module Brief
     def self.search_paths
       paths = [default_path]
 
+      paths << home_apps_path if home_apps_path.exist?
+
       if custom_path = ENV['BRIEF_APPS_PATH']
         custom_path = custom_path.to_s.to_pathname
         paths << custom_path if (custom_path.exist? rescue nil)

data/lib/brief/briefcase.rb

@@ -82,7 +82,7 @@ module Brief
       end
 
       if params[:include_schema] || params[:schema]
-        base[:schema] = schema_map
+        base[:schema] = schema_map(!!(params[:include_schema] == "full"))
       end
 
       if params[:include_documentation] || params[:documentation]

data/lib/brief/briefcase/documentation.rb

@@ -4,7 +4,7 @@ module Brief
 
       class ModelDoc
         def initialize(path)
-          @content = Pathname(path).read
+          @content = Pathname(path).read rescue ""
         end
 
         def content

data/lib/brief/cli/browse.rb

@@ -1,3 +1,18 @@
+command 'browse apps' do |c|
+  c.syntax = "brief browse apps"
+  c.description = "browse the available apps"
+
+  c.action do |args, options|
+    require 'terminal-table'
+    rows = Brief::Apps.app_paths.map do |folder|
+      [folder.basename, folder.to_s]
+    end
+
+    table = Terminal::Table.new(:rows => rows, :headings => %w(Name Found-In-Path))
+    puts table
+  end
+end
+
 command 'browse documents' do |c|
   c.syntax = 'brief browse documents PATHS [OPTIONS]'
   c.description = 'browse documents in the briefcase path'

data/lib/brief/cli/create.rb

@@ -5,17 +5,76 @@ command "create app" do |c|
   c.option '--clone EXISTING_APP', String, 'Clone an existing app'
 
   c.action do |args, options|
-    name = args.first
+    name = args.first.to_s
+    raise 'Must specify a name for your app' unless name.length > 0
+
+    folder = Brief::Apps.home_apps_path.join(name.downcase)
+
+    if folder.exist?
+      raise 'An app with this name already exists'
+    end
+
+    FileUtils.mkdir_p(folder)
+
+    if options.clone && Brief::Apps.available?(options.clone.downcase.to_s)
+      puts "== Cloning #{ options.clone.downcase }"
+      FileUtils.cp_r(Brief::Apps.path_for(options.clone.downcase.to_s), Brief::Apps.home_apps_path.join(name.downcase))
+    else
+      %w(models examples documentation).each do |subfolder|
+        FileUtils.mkdir_p folder.join(subfolder)
+      end
+
+      folder.join("config.rb").open("w+") do |fh|
+        fh.write("config do\n  set(:documentation_path, File.join(File.dirname(__FILE__),'documentation'))\nend")
+      end
+
+      puts "== Created app #{ name }"
+    end
   end
 end
 
 command "create briefcase" do |c|
-  c.syntax = "brief create app PATH"
+  c.syntax = "brief create briefcase PATH"
   c.description = "create a new briefcase"
 
   c.option '--app APP_NAME', String, 'Use the specified app'
   c.option '--use-local-models', nil, 'When using an app, this option will copy over the models locally instead, so you can customize them.'
+  c.option '--force', nil, 'Required if PATH already exists'
 
   c.action do |args, options|
+    arg = args.first || "./briefcase"
+
+    folder = Pathname(arg)
+
+    if !options.force && folder.exist?
+      raise 'Folder already exists. Pass --force to continue'
+    end
+
+    FileUtils.mkdir_p(folder)
+
+    folder.join("config.rb").open("w+") do |fh|
+      fh.write("config do\n  set(:models_path, \"./models\") \nend")
+    end
+
+    case
+    when options.app && options.use_local_models
+      folder.join("brief.rb").open("a") do |fh|
+        fh.write "\nuse #{ options.app }"
+      end
+
+      models_path = Brief::Apps.path_for(options.app).join("models")
+      FileUtils.cp_r(models_path, folder)
+
+    when options.app
+      folder.join("brief.rb").open("a") do |fh|
+        fh.write "\nuse #{ options.app }"
+      end
+    end
+
+    %w(docs assets data models).each do |subfolder|
+      FileUtils.mkdir_p folder.join(subfolder)
+    end
+
+    puts "Created briefcase in #{ folder }"
   end
 end

data/lib/brief/cli/edit.rb

@@ -0,0 +1,14 @@
+command "show app" do |c|
+  c.syntax = "brief edit app NAME"
+  c.description = "edit a brief app"
+
+  c.action do |args, options|
+    app = args.first.to_s.downcase
+
+    if Brief::Apps.available?(app)
+      puts "#{ Brief::Apps.path_for(app) }"
+    end
+  end
+end
+
+

data/lib/brief/cli/schema.rb

@@ -2,10 +2,10 @@ command 'schema' do |c|
   c.syntax = "brief schema"
   c.description = "view information about the schema"
 
-  c.option '--all-models', 'Include all models, not just those that have documents'
+  c.option '--existing-models', 'Include all models, not just those that have documents'
 
   c.action do |args, options|
-    schema_map = Brief.case(true).schema_map(options.all_models)
+    schema_map = Brief.case(true).schema_map(!!!options.existing_models)
 
     output = if args.empty?
       schema_map.to_json

data/lib/brief/cli/server.rb

@@ -1,4 +1,4 @@
-command 'start gateway server' do |c|
+command 'start server' do |c|
   c.option '--host HOSTNAME', nil, 'What hostname to listen on'
   c.option '--port PORT', nil, 'What port to listen on'
 
@@ -8,7 +8,19 @@ command 'start gateway server' do |c|
     require 'thin'
     require 'rack/handler/thin'
     require 'brief/server/gateway'
-    Brief::Server::Gateway.start(port: options.port, host: options.host, root: Pathname(options.root))
+    require 'brief/server/socket'
+    require 'em-websocket'
+
+    fork do
+      Brief::Server::Gateway.start(port: options.port, host: options.host, root: Pathname(options.root))
+    end
+
+    EM.run {
+      EM::WebSocket.run(:host=>"0.0.0.0",:port => 8089) do |ws|
+        Brief::Server::Socket.new(root: options.root, websocket: ws)
+      end
+    }
+
   end
 end
 
@@ -21,7 +33,6 @@ command 'start socket server' do |c|
     require 'brief/server/socket'
     require 'em-websocket'
 
-
     EM.run {
       EM::WebSocket.run(:host=>"0.0.0.0",:port => 8089) do |ws|
         Brief::Server::Socket.new(root: options.root, websocket: ws)

data/lib/brief/version.rb

@@ -1,3 +1,3 @@
 module Brief
-  VERSION = '1.11.5'
+  VERSION = '1.11.6'
 end

data/servers/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.2.2
+RUN useradd -m -d /home/ruby -p ruby ruby && adduser ruby sudo && chsh -s /bin/bash ruby
+
+ENV HOME /home/ruby
+ENV PATH /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
+
+RUN mkdir /briefcases && chown ruby:ruby /briefcases /usr/local/bundle
+
+WORKDIR /home/ruby
+RUN gem install bundler datapimp brief
+EXPOSE 8089
+

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

@@ -12,3 +12,29 @@ class Brief::Page
     yaml "pre[lang='yaml'] code", :serialize => :yaml
   end
 end
+
+__END__
+
+@@ example
+---
+  type: page
+  title: Example Page
+---
+
+# This is the title of the page
+
+this is the first paragraph
+
+## other heading
+
+below is some yaml.  you can embed data under a heading, if it is relevant to that heading.
+
+```yaml
+setting: value
+```
+
+@@ template
+
+<% if object.title %>
+# <%= object.title %>
+<% end %>

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

@@ -15,5 +15,6 @@ describe "The Page Document Type" do
     expect(page.extracted_content_data.title).to eq("Summary")
     expect(page.extracted_content_data.paragraph).not_to be_nil
   end
+
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.11.5
+  version: 1.11.6
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-04 00:00:00.000000000 Z
+date: 2015-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: github-fs
   requirement: !ruby/object:Gem::Requirement
@@ -275,11 +289,13 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - REFACTOR.md
+- ROADMAP.md
 - Rakefile
 - TUTORIAL.md
 - apps/blueprint/config.rb
@@ -287,6 +303,7 @@ files:
 - apps/blueprint/documentation/diagram.md
 - apps/blueprint/documentation/epic.md
 - apps/blueprint/documentation/feature.md
+- apps/blueprint/documentation/index.md
 - apps/blueprint/documentation/milestone.md
 - apps/blueprint/documentation/mockup.md
 - apps/blueprint/documentation/outline.md
@@ -344,6 +361,7 @@ files:
 - lib/brief/cli/all.rb
 - lib/brief/cli/browse.rb
 - lib/brief/cli/create.rb
+- lib/brief/cli/edit.rb
 - lib/brief/cli/export.rb
 - lib/brief/cli/parse.rb
 - lib/brief/cli/render.rb
@@ -386,6 +404,7 @@ files:
 - lib/brief/util.rb
 - lib/brief/version.rb
 - packaging/wrapper.sh
+- servers/Dockerfile
 - spec/acceptance/aggregators_spec.rb
 - spec/acceptance/browsing_spec.rb
 - spec/acceptance/data_manipulation_spec.rb