brief 1.11.6 → 1.11.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c777abc6c9fd2ef3ac8b46e526ea2ca0ad8dab05
-  data.tar.gz: a334054f14e1227ce91bff94e1cdd7b4a7339c47
+  metadata.gz: fd687a96421413cf2b583197c999a635c776270f
+  data.tar.gz: a099d2c06a067176634a00a89b0277b3a57230fa
 SHA512:
-  metadata.gz: 4ecf27b3d5f36288b54bd0cbd7a4dc142a95dacc22e0afc315f04141aed26e9e22fa0f7c62dce4bf1e57218fd023d1cacc5a5a78f148afc3871147cea756e3d7
-  data.tar.gz: 20fa631cc45a9bbf33f51ecd97f1b001904eab11817dc0f376a2b5df2d47e196951bc07d1d65fa5228883758ba277949c364bdf5cf8cdaaf333cbc6ae09053b4
+  metadata.gz: 35eec77e8ba37daf91350e9a3b4a91c526ec02b4f2148c9058a002a2c2f993cc9048f8b8f7994521d40e3d18e4d92bfbc22e917c7d82d815852ff57135e27226
+  data.tar.gz: 75e7f2d9201a49d96262e7871bbdf3b1c4b2c373adca20b4ed68857e6e1ea57eaa30c669f8ee916bda98f01f0c646ffd31959284e91ebd7b577aa989e29ec6ce

data/CHANGELOG.md

@@ -144,3 +144,7 @@ attributes.
 ### 1.9.12
   - Included ability to transform content using special markdown link syntax
   - Included ability to inline svg assets
+
+### 1.11.7
+  - Added ability to define briefcase commands and dispatch these
+    commands from the CLI

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    brief (1.11.5)
+    brief (1.11.7)
       activesupport (> 3.2)
       commander (~> 4.3)
       em-websocket (~> 0.5)
@@ -12,6 +12,7 @@ PATH
       hike (>= 1.2)
       inflecto (~> 0)
       nokogiri (~> 1.6)
+      terminal-table
       thin (= 1.6.3)
       virtus (~> 1.0)
 
@@ -91,6 +92,7 @@ GEM
       addressable (~> 2.3.5)
       faraday (~> 0.8, < 0.10)
     slop (3.6.0)
+    terminal-table (1.4.5)
     thin (1.6.3)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0)

data/lib/brief/briefcase.rb

@@ -21,6 +21,27 @@ module Brief
       Brief.cases[root.basename.to_s] ||= self
     end
 
+    # Runs a command
+    #
+    # Commands are defined in the briefcase configuration.
+    #
+    # You define a command by passing a block. This block will
+    # get called with the briefcase, and whatever other arguments
+    def run_command(name, *args)
+      if handler = Brief.commands.fetch(name.to_sym)
+        block = handler[:handler]
+        args.unshift(self)
+        block.call(*args)
+      else
+        raise 'Command not found'
+      end
+    end
+
+    # Returns a Hash object which presents some
+    # view of the briefcase. Accepts a params hash
+    # of options that will be passed to the presenter.
+    #
+    # The default presenter is Brief::Briefcase#as_default
     def present(style="default", params={})
       style = "default" if style.nil?
 

data/lib/brief/cli/run.rb

@@ -1,3 +1,21 @@
+command "run command" do |c|
+  c.syntax = 'brief run FILE'
+  c.description = 'run a script in the context of the briefcase'
+
+  c.action do |args, options|
+    command = args.first.to_s.to_sym
+
+    bc = Brief.case
+    bc = bc.call if bc.respond_to?(:call)
+
+    if !Brief.commands[command.to_sym]
+      puts "Invalid command. #{ Brief.commands.keys }"
+    else
+      bc.run_command(command.to_sym, *args)
+    end
+  end
+end
+
 command "run" do |c|
   c.syntax = 'brief run FILE'
   c.description = 'run a script in the context of the briefcase'

data/lib/brief/cli/write.rb

@@ -2,6 +2,9 @@ command 'write' do |c|
   c.syntax = 'brief write MODEL_TYPE [OPTIONS]'
   c.description = 'Create a new document for a given model type'
 
+  # TODO
+  # We could potential query the available model classes we are aware of
+  # and determine which CLI arguments those model classes may ask for.
   c.action do |args, options|
     schema_map = Brief.case(true).schema_map(true)
     type_alias = args.first
@@ -10,6 +13,17 @@ command 'write' do |c|
       raise "Unknown model type: #{ type_alias }. Available types are: #{ schema_map.keys.join(',') }"
     end
 
+    # TODO
+    #
+    # We need to determine the initial content that gets put into the editor.
+    #
+    # Our options are:
+    #
+    # - use an example from the model, if one exists
+    # - deduce the content to use based on some combination of one or more of the items below:
+    #   - specifics of the model
+    #   - the state of the documents that exist for that model already
+    #   - the arguments from the CLI
     default_example = "---\ntype:#{type_alias}\n---\n\n# Enter some content"
 
     content = ask_editor(model_class.to_mash.example || default_example)

data/lib/brief/dsl.rb

@@ -6,10 +6,27 @@ module Brief
       Brief::Configuration.instance.instance_eval(&block) if block_given?
     end
 
+    # Define a view of the briefcase.  Pass a block
+    # which returns a hash that displays the desired
+    # content
     def view(name, &block)
       Brief.views[name.to_sym] = block
     end
 
+    # Register a new command for this briefcase.
+    #
+    # Pass the name of the command, options, and a block.
+    #
+    # The block will get called with the briefcase, and any arguments
+    #
+    # currently doesn't accept any options
+    def command(name, options={}, &block)
+      Brief.commands[name.to_sym] = {
+        options: options,
+        handler: block
+      }
+    end
+
     # Extends an existing class
     def extend(*args, &block)
       options     = args.dup.extract_options!

data/lib/brief/version.rb

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

data/lib/brief.rb

@@ -45,10 +45,15 @@ module Brief
     end
   end
 
+
   def self.views
     @views ||= {}
   end
 
+  def self.commands
+    @commands ||= {}
+  end
+
   def self.environment_info
     {
       VERSION: Brief::VERSION,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brief
 version: !ruby/object:Gem::Version
-  version: 1.11.6
+  version: 1.11.7
 platform: ruby
 authors:
 - Jonathan Soeder
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2015-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie