yaml_command 0.1.0

data/.index

@@ -0,0 +1,58 @@
+---
+type: ruby
+revision: 2013
+sources:
+- Index.yml
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: ansi
+- name: executable
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/yaml_command
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/yaml_command
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/yaml_command/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/rubyworks-mailinglist
+  label: Mailing List
+- type: chat
+  uri: irc://chat.us.freenode.net/rubyworks
+  label: IRC Channel
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/yaml_command.git
+categories: []
+load_path:
+- lib
+copyrights:
+- holder: RubyWorks
+  year: '2011'
+  license: BSD-2-Clause
+name: yaml_command
+title: YAML Command
+version: 0.1.0
+summary: Command-line access to YAML files.
+description: YAML Command provides a command line interface to teasing apart and reconstructing
+  YAML files.
+created: '2011-10-22'
+date: '2012-12-12'

data/HISTORY.md

@@ -0,0 +1,23 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2012-12-12
+
+The project has been renamed `yaml-command` instead of the
+abbreviated `yc`. Makes it more obvious what the project is
+about.
+
+Changes:
+
+* Fix missing output of `splat`.
+* Fix yaml output of `get` command.
+* Add manpages for all commands.
+
+
+## 0.0.1 / 2012-03-18
+
+This is the initial public release of YC.
+
+Changes:
+
+* Happy First Release Day!
+

data/LICENSE.txt

@@ -0,0 +1,27 @@
+YC - YAML Command
+
+Copyright (c) 2011 Rubyworks. All rights reserved
+
+Licensed (spdx) BSD-2-Clause
+
+Redistribution and use in source and binary forms, with or without modification, are
+permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of
+      conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright notice, this list
+      of conditions and the following disclaimer in the documentation and/or other materials
+      provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING,
+BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+(http://rubyworks.github.com/yc)

data/README.md

@@ -0,0 +1,94 @@
+# YAML COMMAND
+
+[Website](http://rubyworks.github.com/yaml_command) /
+[Report Issue](http://github.com/rubyworks/yaml_command/issues) /
+[Development](http://github.com/rubyworks/yaml_command) /
+[IRC Channel](irc://chat.us.freenode.net/rubyworks)
+
+
+## Description
+
+YAML Command is a command line tool for working with YAML files.
+
+While currently a work in progress, the goal is evolve the design
+for a standardized `yaml` command line tool. While this early
+implementation is written in Ruby, ultimately the final version
+would be written in C and be widely available.
+
+## Usage
+
+Commands are invoked on the command line with:
+
+    $ yaml <command> [options...] [arguments...]
+
+### Commands
+
+The following commands are currently supported:
+
+* **get** <br/>
+  The `get` command simply extracts a portion of a YAML file and outputs
+  it to stdout.
+
+* **set** <br/>
+  The `set` commnd is the opposite of `get` in that it lets you change
+  a portion of a YAML file. By defult the changed YAML document will go
+  to stdout, using the `-s/--save` option rewrites the file with the change.
+
+* **sort** <br/>
+  The `sort` command can be used to sort portions of a YAML document.
+
+* **slurp** <br/>
+  The `slurp` command takes a directory and converts it's contents into a YAML file.
+
+* **splat** <br/>
+  The `splat` command take a YAML file and converts it into a file directory structure.
+  It is essentially the opposite of slurp.
+
+* **edit** <br/>
+  Edit will open a YAML file for editing in the default editor (as defined by 
+  $EDITOR), and allow you to edit it.
+
+  If instead you edit a directory, then the directory will be automatically 
+  slurped into a temporary file. After editing the temporary file will be
+  splatted back out to update the directory and it's files.
+
+* **view** <br/>
+  Outputs a colorized rendering of the YAML file.
+
+### Options
+
+Some commands has special options. Use `yaml <command> --help` to learn about those.
+All (or nearly all) commands support the following options.
+
+* **-F** / **--file [PATH]** <br/>
+  Use the given YAML file instead of using stdin.
+
+* **-y** / **--yaml** <br/>
+  Output results in YAML format.
+
+* **-j** / **--json** <br/>
+  Output results in JSON format.
+
+* **-m** / **--mute** <br/>
+  Surpress all output.
+
+* **-f** / **--force** <br/>
+  Used to force overwrites when necessary.
+
+* **--debug** <br/>
+  Turn on debug mode to get detailed error report if there is a problem.
+
+
+## Requirements
+
+* [Executable](http://rubyworks.github.com/executable) library handle CLI parsing.
+* [ANSI](http://rubyworks.github.com/ansi) library provides console colorization.
+
+
+## Copyrights
+
+Copyright (c) 2011 Rubyworks. All rights reserved.
+
+YAML Comamnd may be distributed in accordance with the **BSD-2-Clause** license.
+
+See the LICENSE.txt file for details.

data/bin/yaml

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+require 'yaml_command'
+begin
+  YAMLCommand::Command.run(ARGV)
+rescue Exception => error
+  raise if $DEBUG
+  puts error
+end
+

data/lib/yaml_command.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+require 'fileutils'
+require 'executable'
+require 'yaml_command/base'
+require 'yaml_command/get'
+require 'yaml_command/set'
+require 'yaml_command/sort'
+require 'yaml_command/splat'
+require 'yaml_command/slurp'
+require 'yaml_command/edit'
+require 'yaml_command/view'
+
+module YAMLCommand
+
+  #
+  module Console
+    extend self
+
+    #
+    def slurp(dir, options={})
+      slurp = SlurpCommand.new(options)
+      slurp.call(dir)
+    end
+
+    #
+    def splat(file, options={})
+      splat = SplatCommand.new(options)
+      splat.call(file)
+    end
+
+  end
+
+  #
+  def self.const_missing(name)
+    index[name.to_s.downcase] || super(name)
+  end
+
+  #
+  def self.index
+    @index ||= begin
+      file = File.dirname(__FILE__) + '/yaml_command.yml'
+      YAML.load_file(file)
+    rescue
+      {}
+    end
+  end
+
+end
+

data/lib/yaml_command.yml

@@ -0,0 +1,58 @@
+---
+type: ruby
+revision: 2013
+sources:
+- Index.yml
+authors:
+- name: Thomas Sawyer
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- name: ansi
+- name: executable
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - test
+  development: true
+  name: qed
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/yaml_command
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/yaml_command
+  label: Source Code
+- type: bugs
+  uri: http://github.com/rubyworks/yaml_command/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/rubyworks-mailinglist
+  label: Mailing List
+- type: chat
+  uri: irc://chat.us.freenode.net/rubyworks
+  label: IRC Channel
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/yaml_command.git
+categories: []
+load_path:
+- lib
+copyrights:
+- holder: RubyWorks
+  year: '2011'
+  license: BSD-2-Clause
+name: yaml_command
+title: YAML Command
+version: 0.1.0
+summary: Command-line access to YAML files.
+description: YAML Command provides a command line interface to teasing apart and reconstructing
+  YAML files.
+created: '2011-10-22'
+date: '2012-12-12'

data/lib/yaml_command/base.rb

@@ -0,0 +1,139 @@
+module YAMLCommand
+
+  # Abstract base command that all others use.
+  #
+  class Command < Executable::Command
+
+    #
+    def self.command_name
+      'yaml'
+    end
+
+    # Debug mode.
+    def debug=(boolean)
+      $DEBUG = boolean ? true : false
+    end
+
+    # Debug mode.
+    def debug?
+      $DEBUG
+    end
+
+    # Force file overwrites.
+    attr_switch :force
+    alias_switch :f, :force
+
+    # YAML file to use as data source. 
+    # This can be used as an alternative to `$stdin`.
+    attr_accessor :file
+    alias_accessor :F, :file
+
+    # Output using Ruby's #inspect method.
+    def inspect=(boolean)
+      @format = :inspect if boolean
+    end
+
+    # Output using Ruby's #inspect method.
+    def inspect?
+      @format == :inspect
+    end
+
+    # Output using #to_yaml.
+    def yaml=(boolean)
+      @format = :yaml if boolean
+    end
+
+    # Output using #to_yaml.
+    def yaml?
+      @format == :yaml
+    end
+
+    alias_switch :y, :yaml
+
+    # Output using #to_json.
+    def json=(boolean)
+      @format = :json if boolean
+    end
+
+    # Output using #to_json.
+    def json?
+      @format == :json
+    end
+
+    alias_switch :j, :json
+
+    # Surpress all output.
+    def mute?
+      @format == :mute
+    end
+
+    # Surpress all output.
+    def mute=(boolean)
+      @format = :mute if boolean
+    end
+
+    alias_switch :m, :mute
+
+    # Show detailed help message.
+    def help!
+      cli.show_help
+      exit
+    end
+
+    # Show minimal help message.
+    def h!
+      puts cli
+      exit
+    end
+
+    # YAML Command Language
+    def call
+      if file
+        output(data)
+      else
+        puts cli
+      end
+    end
+
+  #protected
+
+    #
+    def data=(data)
+      @data = data
+    end
+
+  private
+
+    attr_reader :format
+
+    #
+    def data
+      @data ||= (
+        if file
+          YAML.load_file(file)
+        else
+          YAML.load($stdin)
+        end
+      )
+    end
+
+    #
+    def output(result)
+      case format
+      when :yaml
+        puts result.to_yaml
+      when :json
+        require 'json'
+        puts result.to_json
+      when :inspect
+        puts result.inspect
+      when :mute
+        # no output
+      else
+        puts result
+      end
+    end
+
+  end
+
+end