frag 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+== 0.2.0 2012-08-11
+
+ * Allow setting options in the file itself via $frag-config lines.
+ * Fix error messages about missing delimters.
+ * Better help text.
+ * Add version option.
+
 == 0.1.0 2012-08-05
 
  * Use 'frag:'...'frag end' for delimiters.

data/README.markdown

@@ -23,9 +23,9 @@ Now `frag` that file:
 
     frag ~/.ssh/config
 
-and the region delimited by the `GEN`..`frag end` lines will be filled in with the
-output from [knife sshgen][knife-sshgen]. The delimiter lines remain, so you can
-re-`frag` anytime to bring it up to date.
+and the fragment delimited by the `frag:`...`frag end` lines will be filled in
+with the output from [knife sshgen][knife-sshgen]. The delimiter lines remain,
+so you can re-`frag` anytime to bring it up to date.
 
 Or maybe you want your `/etc/hosts` to set a list of local subdomains from a
 database:
@@ -38,37 +38,21 @@ database:
     # frag: mysql myapp -Bre 'select subdomain from sites | sed -e 's/.*/127.0.0.1 &.myapp.local/'
     # frag end
 
-Pipelines work - woo!
-
-Or maybe you're authoring this README and want to show all the options `frag`
-takes:
-
-<!-- frag: echo; ruby -Ilib bin/frag --help | sed -e 's/^/    /'; echo  -->
-
-    USAGE: bin/frag [options] file ...
-        -b, --begin DELIMITER
-        -e, --end DELIMITER
-        -l, --leader STRING
-        -t, --trailer STRING
-        -p, --backup-prefix PREFIX
-        -s, --backup-suffix SUFFIX
-
-<!-- frag end -->
-
-(Check the source... ;-)
+The command is passed through the [standard shell][standard-shell], so pipelines
+work fine.
 
 [chef]: http://www.opscode.com/chef
 [knife-sshgen]: https://github.com/harvesthq/knife-plugins/blob/master/.chef/plugins/knife/sshgen.rb
+[standard-shell]: http://www.ruby-doc.org/core-1.9.3/Process.html#method-c-exec
 
 ## Too simple?
 
-Make things complicated with these customizable options.
+Make life complicated with these customizable options.
 
 ### Comment Syntax
 
-By default, frag assumes the beginning and ending lines for each fragment start
-with a '#' (followed by optional whitespace). Change that with`-l` or
-`--leader`:
+By default, frag assumes the fragment delimiters start with a '#' (followed by
+optional whitespace). Change that with`-l` or `--leader`:
 
     frag -l '--' magic.hs
 
@@ -82,7 +66,7 @@ If you want to choose your own delimiters.
 
     frag -b 'FRAGGED BY' -e 'FRAGGED' file.txt
 
-Now your regions can look like:
+Now your fragments can look like:
 
     # FRAGGED BY ...
     ...
@@ -96,7 +80,35 @@ Back up the original file by providing a suffix:
 
 Or dump all your backups into a directory with a prefix:
 
-    frag -p ~/.frag-backups file.txt
+    frag -p ~/.frag-backups/ file.txt
+
+### Embedded options
+
+If you actually do need those options above, it's a pain to type them on the
+command line every time. Instead, you can embed the frag options in the file
+itself:
+
+    <!-- $frag-config: -b BEGIN -e END -->
+    <!-- BEGIN echo hi -->
+    <!-- END -->
+
+The leader and trailer will be taken from that of the $frag-config line itself,
+so you don't need to specify them with the `-l` and `-t` options like earlier.
+
+You can also use this if you need different comment syntaxes for different parts
+of the file. For example, if you're embedding CSS in HTML:
+
+    <!-- $frag-config: -->
+    <!-- frag: echo hi -->
+    <!-- frag end -->
+
+    ...
+
+    /* $frag-config: */
+    /* frag: echo hi */
+    /* frag end */
+
+    ...
 
 ## Note on Patches/Pull Requests
 

data/lib/frag/app.rb

@@ -1,54 +1,29 @@
 require 'tempfile'
 require 'fileutils'
 require 'optparse'
+require 'shellwords'
 
 module Frag
   class App
     def initialize(args, input=STDIN, output=STDOUT, error=STDERR)
       @input, @output, @error = input, output, error
       @status = 0
+      @version_printed = false
 
-      beginning = 'frag:'
-      ending = 'frag end'
-      leader = '#'
-      trailer = ''
-      @backup_prefix = @backup_suffix = nil
-
-      parser = OptionParser.new do |parser|
-        parser.banner = "USAGE: #$0 [options] file ..."
-
-        parser.on '-b', '--begin DELIMITER' do |value|
-          beginning = Regexp.escape(value)
-        end
-        parser.on '-e', '--end DELIMITER' do |value|
-          ending = Regexp.escape(value)
-        end
-        parser.on '-l', '--leader STRING' do |value|
-          leader = Regexp.escape(value)
-        end
-        parser.on '-t', '--trailer STRING' do |value|
-          trailer = Regexp.escape(value)
-        end
-        parser.on '-p', '--backup-prefix PREFIX' do |value|
-          @backup_prefix = value
-        end
-        parser.on '-s', '--backup-suffix SUFFIX' do |value|
-          @backup_suffix = value
-        end
-      end
+      @state = State.new('frag:', 'frag end', '#', '', nil, nil)
 
       parser.parse!(args)
-      args.size > 0 or
+      args.size > 0 || @version_printed or
         return error "no files given"
 
-      @begin_line = Regexp.new(['^', leader, beginning, '(.*)', trailer, '$'].reject(&:empty?).join('\\s*'))
-      @end_line = Regexp.new(['^', leader, ending, trailer, '$'].reject(&:empty?).join('\\s*'))
       @input_paths = args
     end
 
     def run
       return @status if @status != 0
+      global_state = @state.dup
       @input_paths.each do |input_path|
+        @state = global_state.dup
         manage_files(input_path) do |input, output|
           process(input, output)
         end
@@ -66,6 +41,79 @@ module Frag
       false
     end
 
+    def warn(message)
+      @error.puts "warning: #{message}"
+    end
+
+    def parser
+      @parser ||= OptionParser.new do |parser|
+        parser.banner = "USAGE: #$0 [options] file ..."
+        parser.separator "\nOptions:"
+
+        parser.on '-b', '--begin DELIMITER', "Delimiter that begins each generated fragment. Default: 'frag:'" do |value|
+          @state.beginning = value
+        end
+        parser.on '-e', '--end DELIMITER', "Delimiter that ends each generated fragment. Default: 'frag end'" do |value|
+          @state.ending = value
+        end
+        parser.on '-l', '--leader STRING', "String that precedes each begin or end delimiter. Default: '#'" do |value|
+          if parser.parsing_subconfig
+            warn "-l / --leader is unnecessary in $frag-config line"
+          end
+          @state.leader = value
+        end
+        parser.on '-t', '--trailer STRING', "String that succeeds each begin or end delimiter. Default: ''" do |value|
+          if parser.parsing_subconfig
+            warn "-t / --trailer is unnecessary in $frag-config line"
+          end
+          @state.trailer = value
+        end
+        parser.on '-p', '--backup-prefix PREFIX', "Back up original files with the given prefix. May be a directory." do |value|
+          @state.backup_prefix = value
+        end
+        parser.on '-s', '--backup-suffix SUFFIX', "Back up original files with the given suffix." do |value|
+          @state.backup_suffix = value
+        end
+        parser.on '-v', '--version', "" do
+          @output.puts "Frag version #{Frag::VERSION}"
+          @version_printed = true
+        end
+
+        parser.separator <<-EOS.gsub(/^ *\|/, '')
+          |
+          |## Embedded options
+          |
+          |Options may also be embedded in the file itself via a line that
+          |contains "$frag-config:". Example:
+          |
+          |    <!-- $frag-config: -p ~/.frag-backups/ -->
+          |
+          |Note that the leader and trailer are always taken from the strings
+          |that preceed the "$frag-config" and succeed the last option
+          |respectively. They need not be set with --leader and --trailer.
+          |
+        EOS
+
+        class << parser
+          attr_accessor :parsing_subconfig
+
+          def parse_subconfig!(args)
+            self.parsing_subconfig = true
+            # OptionParser will error on an argument like like "-->".
+            if args.last =~ /\A--?(?:\W|\z)/
+              last_arg = args.pop
+              parse!(args)
+              args << last_arg
+            else
+              parse!(args)
+            end
+          ensure
+            self.parsing_subconfig = false
+          end
+        end
+      end
+    end
+
     def manage_files(input_path)
       File.exist?(input_path) or
         return error "file not found: #{input_path}"
@@ -82,8 +130,8 @@ module Frag
           output
         end
       end
-      if @backup_prefix || @backup_suffix
-        backup_path = "#{@backup_prefix}#{File.expand_path(input_path)}#{@backup_suffix}"
+      if @state.backup_prefix || @state.backup_suffix
+        backup_path = "#{@state.backup_prefix}#{File.expand_path(input_path)}#{@state.backup_suffix}"
         FileUtils.mkdir_p File.dirname(backup_path)
         FileUtils.cp input_path, backup_path
       end
@@ -98,26 +146,90 @@ module Frag
           output.puts line
         end
         case line
-        when @begin_line
+        when @state.begin_line
           region_start.nil? or
             return error "#{input.lineno}: nested region"
           command = $1
           region_start = input.lineno
-        when @end_line
+        when @state.end_line
           region_start or
-            return error "#{input.lineno}: unmatched begin delimiter"
+            return error "#{input.lineno}: unmatched end delimiter"
           output.puts `#{command}`
           if !$?.success?
             return error "#{region_start}: failed: (#{$?.exitstatus}) #{command}"
           end
           region_start = nil
           output.puts line
+        when /\A\s*(?:(\S+)\s*)?\$frag-config:\s*(.*)$/
+          args = Shellwords.shellsplit($2)
+          parser.parse_subconfig!(args)
+          args.size <= 1 or
+            return error "#{input.lineno}: unexpected argument(s): #{args[0..-2].join(' ')}"
+          @state.leader = $1 || ''
+          @state.trailer = args.first || ''
         end
       end
       if region_start
-        return error "#{region_start}: unmatched end delimiter"
+        return error "#{region_start}: unmatched begin delimiter"
       end
       true
     end
   end
+
+  class State
+    def initialize(beginning, ending, leader, trailer, backup_prefix, backup_suffix)
+      @beginning = beginning
+      @ending = ending
+      @leader = leader
+      @trailer = trailer
+      @backup_prefix = backup_prefix
+      @backup_suffix = backup_suffix
+    end
+
+    attr_reader :beginning, :ending, :leader, :trailer, :backup_prefix, :backup_suffix
+
+    def beginning=(value)
+      @beginning = value
+      @begin_line = nil
+    end
+
+    def ending=(value)
+      @ending = value
+      @end_line = nil
+    end
+
+    def leader=(value)
+      @leader = value
+      @begin_line = @end_line = nil
+    end
+
+    def trailer=(value)
+      @trailer = value
+      @begin_line = @end_line = nil
+    end
+
+    attr_writer :backup_prefix, :backup_suffix
+
+    def begin_line
+      @begin_line ||= build_begin_line
+    end
+
+    def end_line
+      @end_line ||= build_end_line
+    end
+
+    def build_begin_line
+      leader = Regexp.escape(@leader)
+      beginning = Regexp.escape(@beginning)
+      trailer = Regexp.escape(@trailer)
+      @begin_line = Regexp.new(['^', leader, beginning, '(.*)', trailer, '$'].reject(&:empty?).join('\\s*'))
+    end
+
+    def build_end_line
+      leader = Regexp.escape(@leader)
+      ending = Regexp.escape(@ending)
+      trailer = Regexp.escape(@trailer)
+      @end_line = Regexp.new(['^', leader, ending, trailer, '$'].reject(&:empty?).join('\\s*'))
+    end
+  end
 end

data/lib/frag/version.rb

@@ -1,5 +1,5 @@
 module Frag
-  VERSION = [0, 1, 0]
+  VERSION = [0, 2, 0]
 
   class << VERSION
     include Comparable

data/test/unit/test_app.rb

@@ -156,30 +156,30 @@ describe Frag::App do
     ['-t', '--trailer'].each do |option|
       it "uses the delimiter trailer given by #{option}" do
         write_file 'input', <<-EOS.demargin
-          |# frag: echo one !!
-          |# frag end !!
+          |# frag: echo one @@
+          |# frag end @@
         EOS
-        frag(option, '!!', 'input').must_equal 0
+        frag(option, '@@', 'input').must_equal 0
         (output.string + error.string).must_equal ''
         File.read('input').must_equal <<-EOS.demargin
-          |# frag: echo one !!
+          |# frag: echo one @@
           |one
-          |# frag end !!
+          |# frag end @@
         EOS
       end
     end
 
     it "supports using delimiter options together" do
       write_file 'input', <<-EOS.demargin
-        |<!-- BEGIN echo one -->
-        |<!-- END -->
+        |/* BEGIN echo one */
+        |/* END */
       EOS
-      frag('-b', 'BEGIN', '-e', 'END', '-l', '<!--', '-t', '-->', 'input').must_equal 0
+      frag('-b', 'BEGIN', '-e', 'END', '-l', '/*', '-t', '*/', 'input').must_equal 0
       (output.string + error.string).must_equal ''
       File.read('input').must_equal <<-EOS.demargin
-        |<!-- BEGIN echo one -->
+        |/* BEGIN echo one */
         |one
-        |<!-- END -->
+        |/* END */
       EOS
     end
   end
@@ -249,7 +249,7 @@ describe Frag::App do
       EOS
     end
 
-    it "does not back up files which produces errors" do
+    it "does not back up files which produce errors" do
       write_file 'a', <<-EOS.demargin
         |# frag: true
         |# frag end
@@ -269,6 +269,248 @@ describe Frag::App do
     end
   end
 
+  ['-v', '--version'].each do |option|
+    it "prints the version if the #{option} option is given" do
+      frag(option).must_equal 0
+      output.string.must_equal "Frag version #{Frag::VERSION}\n"
+      error.string.must_equal ''
+    end
+  end
+
+  describe "a $frag-config line" do
+    it "honors the --begin option" do
+      write_file 'input', <<-EOS.demargin
+        |# BEGIN echo one
+        |# frag: echo one
+        |# frag end
+        |# $frag-config: --begin BEGIN
+        |# BEGIN echo one
+        |# frag: echo one
+        |# frag end
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |# BEGIN echo one
+        |# frag: echo one
+        |one
+        |# frag end
+        |# $frag-config: --begin BEGIN
+        |# BEGIN echo one
+        |one
+        |# frag end
+      EOS
+    end
+
+    it "honors the --end option" do
+      write_file 'input', <<-EOS.demargin
+        |# frag: echo one
+        |# END
+        |# frag end
+        |# $frag-config: --end END
+        |# frag: echo one
+        |# END
+        |# frag end
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |# frag: echo one
+        |one
+        |# frag end
+        |# $frag-config: --end END
+        |# frag: echo one
+        |one
+        |# END
+        |# frag end
+      EOS
+    end
+
+    it "infers the leader and trailer" do
+      write_file 'input', <<-EOS.demargin
+        |/* frag: echo one */
+        |/* frag end */
+        |/* $frag-config: */
+        |/* frag: echo one */
+        |/* frag end */
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |/* frag: echo one */
+        |/* frag end */
+        |/* $frag-config: */
+        |/* frag: echo one */
+        |one
+        |/* frag end */
+      EOS
+    end
+
+    it "can nullify the leader and trailer" do
+      write_file 'input', <<-EOS.demargin
+        |frag: echo one
+        |frag end
+        |$frag-config:
+        |frag: echo one
+        |frag end
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |frag: echo one
+        |frag end
+        |$frag-config:
+        |frag: echo one
+        |one
+        |frag end
+      EOS
+    end
+
+    it "warns if the leader is set via an option" do
+      write_file 'input', <<-EOS.demargin
+        |# $frag-config: --leader %
+      EOS
+      frag('input').must_equal 0
+      error.string.must_equal "warning: -l / --leader is unnecessary in $frag-config line\n"
+    end
+
+    it "warns if the trailer is set via an option" do
+      write_file 'input', <<-EOS.demargin
+        |# $frag-config: --trailer %
+      EOS
+      frag('input').must_equal 0
+      error.string.must_equal "warning: -t / --trailer is unnecessary in $frag-config line\n"
+    end
+
+    it "handles trailers that start with '-', which can trick optparse" do
+      write_file 'input', <<-EOS.demargin
+        |<!-- frag: echo one -->
+        |<!-- frag end -->
+        |<!-- $frag-config: -->
+        |<!-- frag: echo one -->
+        |<!-- frag end -->
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |<!-- frag: echo one -->
+        |<!-- frag end -->
+        |<!-- $frag-config: -->
+        |<!-- frag: echo one -->
+        |one
+        |<!-- frag end -->
+      EOS
+    end
+
+    it "honors the --backup-prefix option" do
+      write_file 'input', <<-EOS.demargin
+        |# $frag-config: --backup-prefix path/to/backups
+        |# frag: echo new
+        |old
+        |# frag end
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |# $frag-config: --backup-prefix path/to/backups
+        |# frag: echo new
+        |new
+        |# frag end
+      EOS
+      File.read("path/to/backups/#{File.expand_path('input')}").must_equal <<-EOS.demargin
+        |# $frag-config: --backup-prefix path/to/backups
+        |# frag: echo new
+        |old
+        |# frag end
+      EOS
+    end
+
+    it "honors the --backup-suffix option" do
+      write_file 'input', <<-EOS.demargin
+        |# $frag-config: --backup-suffix .backup
+        |# frag: echo new
+        |old
+        |# frag end
+      EOS
+      frag('input').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |# $frag-config: --backup-suffix .backup
+        |# frag: echo new
+        |new
+        |# frag end
+      EOS
+      File.read('input.backup').must_equal <<-EOS.demargin
+        |# $frag-config: --backup-suffix .backup
+        |# frag: echo new
+        |old
+        |# frag end
+      EOS
+    end
+
+    it "scopes options to the file it appears in" do
+      write_file 'a', <<-EOS.demargin
+        |/* $frag-config: -b BEGIN -e END */
+        |/* BEGIN echo a */
+        |/* END */
+      EOS
+      write_file 'b', <<-EOS.demargin
+        |/* BEGIN echo b */
+        |/* END */
+        |# frag: echo b
+        |# frag end
+      EOS
+      frag('a', 'b').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('a').must_equal <<-EOS.demargin
+        |/* $frag-config: -b BEGIN -e END */
+        |/* BEGIN echo a */
+        |a
+        |/* END */
+      EOS
+      File.read('b').must_equal <<-EOS.demargin
+        |/* BEGIN echo b */
+        |/* END */
+        |# frag: echo b
+        |b
+        |# frag end
+      EOS
+    end
+
+    it "can be used more than once in a file" do
+      write_file 'input', <<-EOS.demargin
+        |// $frag-config:
+        |// frag: echo one
+        |// frag end
+        |
+        |/* $frag-config: */
+        |/* frag: echo one */
+        |/* frag end */
+      EOS
+      frag('input', '--trailer', '1').must_equal 0
+      (output.string + error.string).must_equal ''
+      File.read('input').must_equal <<-EOS.demargin
+        |// $frag-config:
+        |// frag: echo one
+        |one
+        |// frag end
+        |
+        |/* $frag-config: */
+        |/* frag: echo one */
+        |one
+        |/* frag end */
+      EOS
+    end
+
+    it "errors if there are stray arguments" do
+      write_file 'input', <<-EOS.demargin
+        |# $frag-config: arg trailer
+      EOS
+      frag('input').must_equal 1
+      (output.string + error.string).must_match /unexpected argument/
+    end
+  end
+
   it "prints an error and leaves the input file unchanged if a command fails" do
     write_file 'input', <<-EOS.demargin
       |# frag: echo new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: frag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-05 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ritual
@@ -64,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4503615734379659812
+      hash: -1830703405673240469
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -73,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4503615734379659812
+      hash: -1830703405673240469
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24