brief 0.0.1 → 0.0.2

data/spec/fixtures/front_end_tutorial.md

@@ -0,0 +1,33 @@
+# Backbone View Tutorial
+
+Below is an example of how you can style a backbone view.
+
+## Template Content
+
+First write a basic template.
+
+```slim
+nav.nav.navbar-inverse
+  .container
+    .row-fluid
+```
+
+## Style Content
+
+Make the text pink, because it is manly.
+
+```scss
+nav.navbar-inverse {
+  color: pink;
+}
+```
+
+## Script Content
+
+Then you'll wanna do some stuff with the coffeescript.
+
+```coffeescript
+MyView = Backbone.View.extend
+  className: "navbar-inverse"
+```
+

data/spec/fixtures/generator_dsl_example.rb

@@ -0,0 +1,22 @@
+Brief.define "Project Overview" do
+  aliases :project_overview
+
+  levels do
+    level(1) do
+      name "Wiki Page"
+      define_handler :create => "Brief::Handlers::GithubWiki"
+      replaces_items_from_level 2, :with => "Brief::Formatters::GithubMilestoneRollup"
+    end
+
+    level(2) do
+      name "Github Milestone"
+      define_handler :create => "Brief::Handlers::GithubMilestone"
+      replaces_items_from_level 3, :with => nil
+    end
+
+    level(3) do
+      name "Github Issue"
+      define_handler :create => "Brief::Handlers::GithubIssue"
+    end
+  end
+end

data/spec/fixtures/project_overview.md

@@ -0,0 +1,48 @@
+# Wiki Page Heading
+
+Content. Will go on a wiki page.  The content below here, and the subheadings, will be replaced with a roll-up / summary of the elements.  
+
+## Milestone Heading
+
+This content will go in the milestone body.  The wiki page that this belongs to, will include a different kind of view of this content.  
+
+### An issue title
+
+This goes in the issue's body. The wiki page this belongs to will possibly have a link to the issue and a label for its status.  
+
+### Another issue title
+
+This goes in this issue's body.  Same thing. It obviously belongs to the milestone.  
+
+## Milestone Heading Two
+
+Additional content for the milestone heading.  
+
+### Another nested issue
+
+This one has some content, as well as a code block.
+
+```ruby
+class MyClass
+  def sup
+    puts "Sup?"
+  end
+end
+```
+
+Some more content for safety's sake.
+
+### Another nested issue my man
+
+Some plain old content with a list:
+
+- item one
+  - item two 
+  - item three
+- item four
+
+#### What about this deep heading? It should be meaningless.
+
+## A Third milestone
+
+No content exists.

data/spec/fixtures/sample.md

@@ -0,0 +1,19 @@
+# Heading One
+
+Content under heading one.
+
+## Subheading One
+
+Subheading One is my parent. Heading One is my grandparent.
+
+## Subheading Two
+
+Subheading Two is my parent. Heading one is my grandparent.
+
+# Heading Two
+
+Heading two content.
+
+## Subheading Three
+
+Subheading Three is my parent.  Heading Two is my grandparent.

data/spec/lib/brief/document_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe Brief::Document do
+  let(:path) { Brief.fixtures.join("sample.md") }
+
+  let(:tutorial) do
+    Brief::Document.new(path: path)
+  end
+
+  it "should let me pass raw markdown" do
+    level_one = Brief::Document.new(path.read).tree.level(1)
+    expect(level_one.first.title).to eq("Heading One")
+  end
+
+  it "should let me pass a markdown file" do
+    level_one = Brief::Document.new(path).tree.level(1)
+    expect(level_one.first.title).to eq("Heading One")
+  end
+
+  describe "Parsers and Publishers" do
+    it "should have a parser" do
+      expect(tutorial.parser).not_to be_nil
+    end
+
+    it "should have a publisher" do
+      expect(tutorial.publisher).not_to be_nil
+    end
+  end
+
+  describe "Finding code blocks by language" do
+    it "should find the blocks of code and group them by their language" do
+      expect(tutorial.code_blocks_by_language).not_to be_empty
+    end
+  end
+end

data/spec/lib/brief/dsl_spec.rb

@@ -0,0 +1,21 @@
+require "spec_helper"
+
+describe "The Publisher definition DSL" do
+  before(:all) do
+    require Brief.fixtures.join("generator_dsl_example.rb")
+  end
+
+  it "should define a generator called Project Overview" do
+    expect(Brief::Publisher.fetch("Project Overview")).to be_present
+  end
+
+  it "should find the appropriate Publisher by using an alias" do
+    expect(Brief::Publisher.fetch("project_overview")).to be_present
+  end
+
+  it "should find the appropriate Publisher using a case insensitve search" do
+    expect(Brief::Publisher.fetch("project overview")).to be_present
+  end
+
+
+end

data/spec/lib/brief/line_spec.rb

@@ -0,0 +1,11 @@
+require "spec_helper"
+
+describe Brief::Line do
+  let(:heading1) { Brief::Line.new("# sup?", 1, false) }
+  let(:heading2) { Brief::Line.new("##sup?", 2, false) }
+
+  it "should set the level" do
+    expect(heading1.level).to eq(1)
+    expect(heading2.level).to eq(2)
+  end
+end

data/spec/lib/brief/parser_spec.rb

@@ -0,0 +1,12 @@
+require "spec_helper"
+
+describe Brief::Parser do
+  let(:sample) do
+    Brief::Document.new(Brief.fixtures.join("sample.md")).parser
+  end
+
+  it "should give me information about the headings" do
+    expect(sample.headings_at_level(1)).to eq(["Heading One", "Heading Two"])
+    expect(sample.headings_at_level(2)).to eq(["Subheading One", "Subheading Two", "Subheading Three"])
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,25 @@
+spec = File.dirname(__FILE__)
+$LOAD_PATH.unshift(spec) unless $LOAD_PATH.include?(spec)
+
+lib = File.join(File.dirname(__FILE__), '../lib')
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'pry'
+require 'brief'
+
+module Brief
+  def self.project_overview_example
+    @project_overview_example ||= Brief::Document.new fixtures.join("project_overview.md")
+  end
+
+  def self.test_documents
+    @test_documents ||= fixtures.children.select {|f| f.file? }.map {|c| Brief::Document.new(c) }
+  end
+
+  def self.fixtures
+    spec = File.dirname(__FILE__)
+    Pathname(spec).join("fixtures")
+  end
+end
+
+Brief.test_documents

metadata

@@ -1,15 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-25 00:00:00.000000000 Z
+date: 2014-07-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: commander
+  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: colored
+  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: active_support
+  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: i18n
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -28,23 +98,165 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Brief is a utility to make writing more productive for software architects.
+  It allows you write to places like Github Wiki, The Github Issues API all from the
+  command line and a single file.
 email:
 - jonathan.soeder@gmail.com
-executables: []
+executables:
+- brief
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/brief
+- brief-0.0.1.gem
+- brief.gemspec
+- examples/project_overview.md
+- lib/brief.rb
+- lib/brief/cli/commands/config.rb
+- lib/brief/cli/commands/publish.rb
+- lib/brief/cli/commands/write.rb
+- lib/brief/configuration.rb
+- lib/brief/document.rb
+- lib/brief/dsl.rb
+- lib/brief/formatters/base.rb
+- lib/brief/formatters/github_milestone_rollup.rb
+- lib/brief/git.rb
+- lib/brief/github.rb
+- lib/brief/github/wiki.rb
+- lib/brief/github_client.rb
+- lib/brief/github_client/authentication.rb
+- lib/brief/github_client/client.rb
+- lib/brief/github_client/commands.rb
+- lib/brief/github_client/issue_labels.rb
+- lib/brief/github_client/issues.rb
+- lib/brief/github_client/milestone_issues.rb
+- lib/brief/github_client/organization_activity.rb
+- lib/brief/github_client/organization_issues.rb
+- lib/brief/github_client/organization_repositories.rb
+- lib/brief/github_client/organization_users.rb
+- lib/brief/github_client/repository_events.rb
+- lib/brief/github_client/repository_issue_events.rb
+- lib/brief/github_client/repository_issues.rb
+- lib/brief/github_client/repository_labels.rb
+- lib/brief/github_client/repository_milestones.rb
+- lib/brief/github_client/request.rb
+- lib/brief/github_client/request_wrapper.rb
+- lib/brief/github_client/response_object.rb
+- lib/brief/github_client/single_repository.rb
+- lib/brief/github_client/user_activity.rb
+- lib/brief/github_client/user_gists.rb
+- lib/brief/github_client/user_info.rb
+- lib/brief/github_client/user_issues.rb
+- lib/brief/github_client/user_organizations.rb
+- lib/brief/github_client/user_repositories.rb
+- lib/brief/handlers/base.rb
+- lib/brief/handlers/github_issue.rb
+- lib/brief/handlers/github_milestone.rb
+- lib/brief/handlers/github_wiki.rb
+- lib/brief/line.rb
+- lib/brief/parser.rb
+- lib/brief/publisher.rb
+- lib/brief/publisher/handler_manager.rb
+- lib/brief/tree.rb
+- lib/brief/version.rb
+- lib/core_ext.rb
+- spec/fixtures/front_end_tutorial.md
+- spec/fixtures/generated/project_overview.json
+- spec/fixtures/generator_dsl_example.rb
+- spec/fixtures/project_overview.md
+- spec/fixtures/sample.md
+- spec/lib/brief/document_spec.rb
+- spec/lib/brief/dsl_spec.rb
+- spec/lib/brief/line_spec.rb
+- spec/lib/brief/parser_spec.rb
+- spec/spec_helper.rb
 homepage: http://architects.io/brief
 licenses:
 - MIT
@@ -55,12 +267,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -69,4 +281,14 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: Brief is a utility to make writing more productive for software architects.
-test_files: []
+test_files:
+- spec/fixtures/front_end_tutorial.md
+- spec/fixtures/generated/project_overview.json
+- spec/fixtures/generator_dsl_example.rb
+- spec/fixtures/project_overview.md
+- spec/fixtures/sample.md
+- spec/lib/brief/document_spec.rb
+- spec/lib/brief/dsl_spec.rb
+- spec/lib/brief/line_spec.rb
+- spec/lib/brief/parser_spec.rb
+- spec/spec_helper.rb