brief 0.0.5 → 1.0.0

data/spec/lib/brief/model_spec.rb

@@ -0,0 +1,84 @@
+require "spec_helper"
+
+describe "The Brief Model" do
+  let(:briefcase) { Brief.example }
+  let(:epic) { briefcase.epics.first }
+  let(:user_story) { briefcase.user_stories.first }
+
+  context "DSL Style Declarations" do
+    it "picks up a definition of 'User Story'" do
+      expect(briefcase.model("User Story")).to be_present
+    end
+
+    it "defines a class for us" do
+      expect((Brief::Model::UserStory rescue nil)).to be_present
+    end
+
+    it "shows up in the model definitions table" do
+      expect(Brief::Model.table.user_story).to be_present
+    end
+
+    it "has a definition" do
+      expect(Brief::Model::UserStory.definition).to be_a(Brief::Model::Definition)
+    end
+
+    it "has paths and document attributes by default" do
+      set = Brief::Model::UserStory.attribute_set.map(&:name)
+      expect(set).to include(:path, :document)
+    end
+
+    it "has the attributes defined in the DSL" do
+      set = Brief::Model::UserStory.attribute_set.map(&:name)
+      expect(set).to include(:title, :status, :epic_title)
+    end
+  end
+
+  context "Class Definitions" do
+    it "picks up a defintion of 'Epic'" do
+      expect((Brief::Epic rescue nil)).to be_present
+    end
+
+    it "shows up in the model definitions table" do
+      expect(Brief::Model.table.epic).to be_present
+    end
+
+    it "has a definition" do
+      expect(Brief::Epic.definition).to be_a(Brief::Model::Definition)
+    end
+
+    it "has paths and document attributes by default" do
+      set = Brief::Epic.attribute_set.map(&:name)
+      expect(set).to include(:path, :document)
+    end
+
+    it "has the attributes defined inline in the class methods" do
+      set = Brief::Epic.attribute_set.map(&:name)
+      expect(set).to include(:path, :document, :title, :status)
+    end
+  end
+
+  context "Briefcase Finders" do
+    it "creates methods on the briefcase for each class" do
+      expect(briefcase.epics).not_to be_empty
+      expect(briefcase.user_stories).not_to be_empty
+    end
+
+    it "finds instances of the desired model" do
+      expect(briefcase.epics.first).to be_a(Brief::Epic)
+    end
+  end
+
+  context "Document Content Extraction" do
+    it "has a relationship to the underlying document" do
+      expect(epic.document).to be_a(Brief::Document)
+    end
+
+    it "has a content extractor" do
+      expect(epic.extracted).to be_a(Brief::Document::ContentExtractor)
+    end
+
+    it "uses the configured content extractor settings" do
+      expect(epic.extracted.title).to eq("Blueprint Epic Example")
+    end
+  end
+end

data/spec/lib/brief/repository_spec.rb

@@ -0,0 +1,60 @@
+require "spec_helper"
+
+describe "The Brief Document Repository" do
+  let(:repository) { Brief.example.repository }
+
+  it "has a bunch of documents" do
+    expect(repository.documents).not_to be_empty
+  end
+
+  context "querying api" do
+    it "finds the first document matching a query" do
+      query = repository.where(state:"active")
+      expect(query.first.type).to eq("epic")
+    end
+
+    it "finds the last document matching a query" do
+      query = repository.where(state:"active")
+      expect(query.last.type).to eq("user_story")
+    end
+
+    it "respects the ordering" do
+      types = repository.order_by(:type).map(&:type)
+      expect(types.first).to eq("concept")
+      expect(types.last).to eq("wireframe")
+
+      types = repository.order_by(:type => :desc).map(&:type)
+      expect(types.last).to eq("concept")
+      expect(types.first).to eq("wireframe")
+    end
+
+    it "supports different operators" do
+      query = repository.where(:type.neq => "epic")
+      expect(query.length).to eq(6)
+    end
+
+    it "limits the results to the specified size" do
+      query = repository.where(:type.neq => "epic").limit(3)
+      expect(query.length).to eq(3)
+    end
+
+    it "allows me to use an offset" do
+      one = repository.where(:type.neq => "epic").limit(3).offset(1).map(&:type).to_set
+      two = repository.where(:type.neq => "epic").limit(3).offset(2).map(&:type).to_set
+      expect(one).not_to eq(two)
+    end
+
+    it "can filter documents by their attributes" do
+      query = repository.where(state:"active")
+      expect(query.length).to eq(2)
+      query = repository.where(title:"Blueprint Epic Example")
+      expect(query.length).to eq(1)
+    end
+
+    it "returns empty result set when nothing matches" do
+      query = repository.where(type:"some bullshit")
+      expect(query.length).to eq(0)
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -1,25 +1,23 @@
-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'
 
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
 module Brief
-  def self.project_overview_example
-    @project_overview_example ||= Brief::Document.new fixtures.join("project_overview.md")
+  def self.spec_root
+    Pathname(File.dirname(__FILE__))
   end
 
-  def self.test_documents
-    @test_documents ||= fixtures.children.select {|f| f.file? }.map {|c| Brief::Document.new(c) }
+  def self.example_path
+    example.root
   end
 
-  def self.fixtures
-    spec = File.dirname(__FILE__)
-    Pathname(spec).join("fixtures")
+  def self.example
+    @example ||= Brief::Briefcase.new(root:spec_root.join("fixtures","example"))
   end
 end
 
-Brief.test_documents
+RSpec.configure do |config|
+  config.mock_with :rspec
+  #config.order = "random"
+end

metadata

@@ -1,186 +1,213 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-15 00:00:00.000000000 Z
+date: 2015-01-07 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
+  name: github-fs
   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: activesupport
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: inflecto
+  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
+  name: activemodel
   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
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  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: pry-nav
+  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: guard
+  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-rspec
+  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'
-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.
+description: Brief is a library for developing applications whose primary interface
+  is the text editor
 email:
 - jonathan.soeder@gmail.com
 executables:
@@ -188,76 +215,52 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
 - Gemfile
 - Gemfile.lock
-- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/brief
 - brief.gemspec
-- examples/project_overview.md
+- examples/blog/brief.rb
+- examples/blog/docs/an-intro-to-brief.html.md
+- lib/.DS_Store
 - lib/brief.rb
-- lib/brief/cli/commands/config.rb
-- lib/brief/cli/commands/publish.rb
-- lib/brief/cli/commands/write.rb
+- lib/brief/briefcase.rb
+- lib/brief/cli/change.rb
+- lib/brief/cli/init.rb
+- lib/brief/cli/publish.rb
+- lib/brief/cli/write.rb
 - lib/brief/configuration.rb
+- lib/brief/core_ext.rb
 - lib/brief/document.rb
+- lib/brief/document/content_extractor.rb
+- lib/brief/document/front_matter.rb
+- lib/brief/document/rendering.rb
+- lib/brief/document_mapper.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/model.rb
+- lib/brief/model/definition.rb
+- lib/brief/repository.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/fixtures/example/brief.rb
+- spec/fixtures/example/docs/concept.html.md
+- spec/fixtures/example/docs/epic.html.md
+- spec/fixtures/example/docs/persona.html.md
+- spec/fixtures/example/docs/release.html.md
+- spec/fixtures/example/docs/resource.html.md
+- spec/fixtures/example/docs/user_story.html.md
+- spec/fixtures/example/docs/wireframe.html.md
+- spec/fixtures/example/models/epic.rb
+- spec/lib/brief/briefcase_spec.rb
 - 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/lib/brief/model_spec.rb
+- spec/lib/brief/repository_spec.rb
 - spec/spec_helper.rb
-homepage: http://architects.io/brief
+- spec/support/test_helpers.rb
+- tasks/brief/release.rake
+homepage: ''
 licenses:
 - MIT
 metadata: {}
@@ -267,28 +270,35 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Brief is a utility to make writing more productive for software architects.
+summary: Brief makes writing more powerful
 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/fixtures/example/brief.rb
+- spec/fixtures/example/docs/concept.html.md
+- spec/fixtures/example/docs/epic.html.md
+- spec/fixtures/example/docs/persona.html.md
+- spec/fixtures/example/docs/release.html.md
+- spec/fixtures/example/docs/resource.html.md
+- spec/fixtures/example/docs/user_story.html.md
+- spec/fixtures/example/docs/wireframe.html.md
+- spec/fixtures/example/models/epic.rb
+- spec/lib/brief/briefcase_spec.rb
 - 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/lib/brief/model_spec.rb
+- spec/lib/brief/repository_spec.rb
 - spec/spec_helper.rb
+- spec/support/test_helpers.rb
+has_rdoc: 

data/.gitignore

@@ -1 +0,0 @@
-*.gem

data/Guardfile

@@ -1,5 +0,0 @@
-guard 'rspec', :all_on_start => true do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec/" }
-end

data/examples/project_overview.md

@@ -1,23 +0,0 @@
-```settings
-status: proposed
-edited_by: jonathan soeder
-```
-
-# This is a project overview
-
-A body paragraph or two here will be the content for a cover page. You can supply whatever background
-info, domain knowledge requirements, processes, file dependencies and links, whatever.
-
-The content for the nested milestones and issues below will be transformed into raw markdown
-which will generate a status summary of the milestones and issues as they get created in the Github API.
-
-## This is a milestone heading
-
-A milestone is some logical way of grouping issues and attaching a date to them. You will write the body
-of the individual issues and optionally assign them or label them by writing them below. When this brief
-gets published, the issues will be created and added to the milestone.
-
-### This is an issue that belongs to the above milestone
-
-The content of your issue goes here. Normal github flavored markdown is supported.
-

data/lib/brief/cli/commands/config.rb

@@ -1,40 +0,0 @@
-command :config do |c|
-  c.syntax = 'brief config [options]'
-  c.description = 'manipulate brief configuration settings'
-
-  c.action do |args, options|
-    Brief::Configuration.initialize!
-
-    # Setting a value manually
-    if args.first == 'set'
-      args.slice(1, args.length).map(&:strip).each do |pair|
-        key, value = pair.split('=')
-        Brief.configuration.set(key, value, false)
-      end
-
-      Brief.configuration.save!
-    end
-
-    if args.empty? && !(Brief.config.github_username || Brief.config.github_token)
-      args.push "github"
-    end
-
-    if args.first == "github"
-      username = ask("What is your github username: ", String)
-
-      say "If you haven't generated a personal access token yet, do so here: https://github.com/settings/tokens/new"
-      access_token = ask("Enter your private access token: ")
-
-      if username
-        Brief.config.set "github_username", username
-      end
-
-      if access_token
-        # TODO
-        # We could validate the token for them.
-        Brief.config.set "github_token", access_token
-      end
-    end
-
-  end
-end