yaml_command 0.1.0

data/lib/yaml_command/edit.rb

@@ -0,0 +1,42 @@
+module YAMLCommand
+
+  # Read a YAML file, open in default editor, validate and save.
+  # If directory instead of a file, slurp together as temporary
+  # YAML file and then re-splat to save.
+  #
+  class Command::EditCommand < Command
+
+    TMP_FILE = ".tmp.yml"  # TODO: real tmpfile
+
+    EDITOR = ENV['EDITOR'] || 'vi'
+
+    # Edit a YAML file, or edit a directory via slurp and splt.
+    def call(file_or_dir)
+      if File.directory?(file_or_dir)
+        data0 = Console.slurp(file_or_dir)
+        File.open(TMP_FILE, 'w'){ |f| f << data0.to_yaml }
+        edit_file(tmpfile)
+        data1 = YAML.load_file(TMP_FILE)
+        Console.splat(file_or_dir, :data=>data1)
+      elsif File.file?(file_or_dir)
+        edit_file(file_or_dir)
+      else
+        abort "does not exist"
+      end
+    end
+
+    #
+    def edit_file(file)
+      success = system "#{EDITOR} #{file}"
+      if success
+        begin
+          YAML.load_file(file)
+        rescue
+          edit_file(file)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/yaml_command/get.rb

@@ -0,0 +1,30 @@
+module YAMLCommand
+
+  class Command::GetCommand < Command
+
+    # Output an indexed value of a YAML document.
+    def call(name)
+      case data
+      when Array
+        value = data[name.to_i]
+      else
+        value = data[name] || data[name.to_sym]
+      end
+
+      output(
+        case value
+        when String, Numeric
+          value
+        when Date
+          value.strftime('%Y-%m-%d')
+        when Time
+          value.strftime('%Y-%m-%d %H:%M:%S')
+        else
+          value
+        end
+      )
+    end
+
+  end
+
+end

data/lib/yaml_command/set.rb

@@ -0,0 +1,36 @@
+module YAMLCommand
+
+  class Command::SetCommand < Command
+
+    # Set an indexed value of a YAML document.
+    def call(name, new_value)
+      case data
+      when Array
+        raise ArgumentError unless name.to_s =~ /d+/
+        index = name.to_i
+        old_value = data[index]
+        data[index] = new_value
+      when Hash
+        if data.key?(name)
+          key = name       
+          old_value = data[name]
+          data[name] = new_value
+        elsif data.key?(name.to_sym)
+          key = name.to_sym
+          old_value = data[key]
+          data[key] = new_value
+        end
+      else
+        raise NotImplementedError
+      end
+
+      if !old_value.eql?(new_value)
+        #TODO: save
+        output data
+      end
+
+    end
+
+  end
+
+end

data/lib/yaml_command/slurp.rb

@@ -0,0 +1,52 @@
+module YAMLCommand
+
+  # Given a directory, read each file into a mapping
+  # with directories into a nested mapping.
+  #
+  class Command::SlurpCommand < Command
+
+    # Import each file of a directory into a YAML file.
+    def slurp(dir)
+      output slurp_directory(dir)
+    end
+
+    #
+    alias_method :call, :slurp
+
+    #
+    def recurse?
+      @recurse
+    end
+
+    #
+    def recurse=(boolean)
+      @recurse = boolean
+    end
+
+    alias_switch :r, :recurse
+
+  private
+
+    # Import each file of a directory into a YAML file.
+    def slurp_directory(dir, hash={})
+      Dir.entries(dir).each do |path|
+        next if path == '.' or path == '..'
+        local = File.join(dir, path)
+        if File.directory?(local)
+          if recurse?
+            subhash = {}
+            hash[path] = slurp_directory(local, subhash)
+          end
+        else
+          text = File.read(local)
+          hash[path] = YAML.load(text)  # any cases where this is not good idea?
+        end
+      end
+
+      hash
+    end
+
+  end
+
+end
+

data/lib/yaml_command/sort.rb

@@ -0,0 +1,52 @@
+module YAMLCommand
+
+  # Sort command. 
+  #
+  # Very limited at this point as it will only sort toplevel
+  # sequence or mappings.
+  #
+  class Command::SortCommand < Command
+
+    # Create files recursively?
+    #attr_switch :save
+    #alias_switch :s, :save
+
+    # Select ordering, descending or ascending (default).
+    # Use `descending` or `reverse` or abbreviations `d` or `r` for opposite order.
+    attr_accessor :order
+    alias_accessor :o, :order
+
+    # Sort in ascending or descending order.
+    def call(ypath=nil)
+      if ypath
+        raise NotImplementedError, "YPath not supported yet."
+      end
+
+      case data
+      when Array
+        new_data = data.sort
+      when Hash
+        new_data = {}
+        data.keys.sort.each do |k|
+          new_data[k] = data[k]
+        end
+      end
+
+      #save
+      output new_data
+    end
+
+  private
+
+    def sort(list)
+      case order
+      when /^r/, /^d/  # reverse or descending
+        list.sort.reverse
+      else
+        list.sort
+      end
+    end
+
+  end
+
+end

data/lib/yaml_command/splat.rb

@@ -0,0 +1,130 @@
+module YAMLCommand
+
+  # Writes each entry of a YAML hash to a file.
+  # This is the opposite of #slurp.
+  #
+  class Command::SplatCommand < Command
+
+    # Create files recursively?
+    attr_switch :recurse
+    alias_switch :r, :recurse
+
+    # Dryrun mode.
+    attr_switch :dryrun
+    alias_switch :D, :dryrun
+
+    # Splat a YAML mapping document into a directory of files.
+    # One file is created for each mapping key.
+    def call(dir=nil)
+      raise 'not a mapping' unless Hash === data
+
+      dir ||= file.chomp('.yaml').chomp('.yml')
+
+      old_map = build_old_map(dir)
+      new_map = build_new_map(dir)
+
+      # TODO: get a list of keys that will actually change
+
+      remove = (old_map.keys - new_map.keys).sort
+
+      if dryrun?
+        save_dryrun(remove, new_map.keys)
+        return
+      end
+
+      unless remove.empty? or force?
+        $stderr.puts "This operation will remove:"
+        remove.each do |f|
+          $stderr.puts "  #{f}"
+        end
+        $stderr.puts "Use -f/--force option to proceed."
+        return
+      end
+
+      remove.each do |f|
+        FileUtils.rm_r(f) if File.exist?(f)
+      end
+
+      new_map.each do |f,v|
+        if v != old_map[f]
+          d = File.dirname(f)
+          FileUtils.mkdir_p(d) unless File.directory?(d)
+          File.open(f, 'w'){ |f| f << v }
+        end
+      end
+
+      nil
+    end
+
+  private
+
+    #
+    def save_dryun(remove, write)
+      $stderr.puts "[DRYRUN]"
+      remove.each do |f|
+        $stderr.puts "  (remove)  #{f}"
+      end
+
+      write.each do |f|
+        $stderr.puts "  (write)   #{f}"
+      end
+    end
+
+    #
+    def build_new_map(dir, data=nil)
+      map = {}
+      data ||= data()
+      data.each do |k,v|
+        if Hash === v && recurse?
+          sub_map = build_new_map(File.join(dir, k), v)
+          map.update(sub_map)
+        else
+          value = render_value(v)
+        end
+        map[File.join(dir,k)] = value
+      end
+      map
+    end
+
+    #
+    def build_old_map(dir)
+      return {} unless File.directory?(dir)
+
+      map = {}
+      entries = Dir.entries(dir) - ['.', '..']
+      entries.each do |e|
+        k = File.join(dir, e)
+        if File.directory?(k)
+          if recurse?
+            value = build_old_map(File.join(dir, k))
+            map[k] = value
+          end
+        else
+          v = File.read(k)
+          value = render_value(v)
+          map[k] = value
+        end
+      end
+      map     
+    end
+
+    #
+    def render_value(value)
+      case value
+      when Hash
+        txt = value.to_yaml
+      when String, Numeric
+        txt = value.to_s
+      when Date
+        txt = value.strftime('%Y-%m-%d')
+      when Time
+        txt = value.strftime('%Y-%m-%d %H:%M:%S')
+      else
+        txt = value.to_yaml
+      end
+      txt
+    end
+
+  end
+
+end

data/lib/yaml_command/view.rb

@@ -0,0 +1,49 @@
+module YAMLCommand
+
+  # TODO: View could use a better implmentation, it is very simplistic
+  #       at this point.
+
+  # TODO: Should view make a YAML stream if given multiple files ?
+
+
+  # Display YAML file with color highlighting.
+  #
+  # This command requires the ANSI gem be installed.
+  #
+  class Command::ViewCommand < Command
+
+    #
+    # Invoke view command.
+    #
+    def call(path=nil)
+      require 'ansi'
+
+      colon = ":".ansi(:magenta)
+
+      if path
+        text = File.read(path)
+      else
+        if file
+          text = File.read(file)
+        else
+          text = $stdin.read
+        end
+      end
+
+      text.each_line do |line|
+        case line
+        when /^---/
+          print line
+        when /^(\s*\-)(.*?)$/
+          puts "%s%s" % [$1.ansi(:magenta), $2]
+        when /^(\s*\w+)\:(.*?)$/
+          puts "%s%s%s" % [$1.ansi(:cyan), colon, $2]
+        else
+          print line
+        end
+      end
+    end
+
+  end
+
+end

data/man/yaml-edit.1

@@ -0,0 +1,24 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "YAML\-EDIT" "1" "December 2012" "YAML.ORG" "YAML COMMAND"
+.
+.SH "NAME"
+\fByaml\-edit\fR \- yaml edit command
+.
+.SH "SYNOPSIS"
+\fByaml edit [options] [path]\fR
+.
+.SH "DESCRIPTION"
+Edit a YAML file using the standard editor (via $EDITOR)\. If a directory path is given then splurp the directory, edit the result and when saved splat the result back to the directory\.
+.
+.SH "OPTIONS"
+The following options are available to the edit command\.
+.
+.IP "\(bu" 4
+\fB\-F\fR/\fB\-\-file\fR \fIPATH\fR The YAML file to query, if not by stdin\.
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+yaml(1), yaml\-set(1), yaml\-sort(1), yaml\-slurp(1), yaml\-splurp(1), yaml\-splat(1), yaml\-view(1)

data/man/yaml-edit.1.html

@@ -0,0 +1,107 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
+  <title>yaml-edit(1) - yaml edit command</title>
+  <style type='text/css' media='all'>
+  /* style: man */
+  body#manpage {margin:0}
+  .mp {max-width:100ex;padding:0 9ex 1ex 4ex}
+  .mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
+  .mp h2 {margin:10px 0 0 0}
+  .mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
+  .mp h3 {margin:0 0 0 4ex}
+  .mp dt {margin:0;clear:left}
+  .mp dt.flush {float:left;width:8ex}
+  .mp dd {margin:0 0 0 9ex}
+  .mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
+  .mp pre {margin-bottom:20px}
+  .mp pre+h2,.mp pre+h3 {margin-top:22px}
+  .mp h2+pre,.mp h3+pre {margin-top:5px}
+  .mp img {display:block;margin:auto}
+  .mp h1.man-title {display:none}
+  .mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
+  .mp h2 {font-size:16px;line-height:1.25}
+  .mp h1 {font-size:20px;line-height:2}
+  .mp {text-align:justify;background:#fff}
+  .mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
+  .mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
+  .mp u {text-decoration:underline}
+  .mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
+  .mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
+  .mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
+  .mp b.man-ref {font-weight:normal;color:#434241}
+  .mp pre {padding:0 4ex}
+  .mp pre code {font-weight:normal;color:#434241}
+  .mp h2+pre,h3+pre {padding-left:0}
+  ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
+  ol.man-decor {width:100%}
+  ol.man-decor li.tl {text-align:left}
+  ol.man-decor li.tc {text-align:center;letter-spacing:4px}
+  ol.man-decor li.tr {text-align:right;float:right}
+  </style>
+</head>
+<!--
+  The following styles are deprecated and will be removed at some point:
+  div#man, div#man ol.man, div#man ol.head, div#man ol.man.
+
+  The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
+  .man-navigation should be used instead.
+-->
+<body id='manpage'>
+  <div class='mp' id='man'>
+
+  <div class='man-navigation' style='display:none'>
+    <a href="#NAME">NAME</a>
+    <a href="#SYNOPSIS">SYNOPSIS</a>
+    <a href="#DESCRIPTION">DESCRIPTION</a>
+    <a href="#OPTIONS">OPTIONS</a>
+    <a href="#SEE-ALSO">SEE ALSO</a>
+  </div>
+
+  <ol class='man-decor man-head man head'>
+    <li class='tl'>yaml-edit(1)</li>
+    <li class='tc'>YAML COMMAND</li>
+    <li class='tr'>yaml-edit(1)</li>
+  </ol>
+
+  <h2 id="NAME">NAME</h2>
+<p class="man-name">
+  <code>yaml-edit</code> - <span class="man-whatis">yaml edit command</span>
+</p>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>yaml edit [options] [path]</code></p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Edit a YAML file using the standard editor (via $EDITOR). If a directory
+path is given then splurp the directory, edit the result and when saved
+splat the result back to the directory.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<p>The following options are available to the edit command.</p>
+
+<ul>
+<li><code>-F</code>/<code>--file</code> <var>PATH</var>
+The YAML file to query, if not by stdin.</li>
+</ul>
+
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p><a class="man-ref" href="yaml.1.html">yaml<span class="s">(1)</span></a>, <a class="man-ref" href="yaml-set.1.html">yaml-set<span class="s">(1)</span></a>, <span class="man-ref">yaml-sort<span class="s">(1)</span></span>, <a class="man-ref" href="yaml-slurp.1.html">yaml-slurp<span class="s">(1)</span></a>, <span class="man-ref">yaml-splurp<span class="s">(1)</span></span>, <a class="man-ref" href="yaml-splat.1.html">yaml-splat<span class="s">(1)</span></a>, <a class="man-ref" href="yaml-view.1.html">yaml-view<span class="s">(1)</span></a></p>
+
+
+  <ol class='man-decor man-foot man foot'>
+    <li class='tl'>YAML.ORG</li>
+    <li class='tc'>December 2012</li>
+    <li class='tr'>yaml-edit(1)</li>
+  </ol>
+
+  </div>
+</body>
+</html>