ytools 0.1.9 → 0.2.0

data/Gemfile

@@ -0,0 +1,10 @@
+source :rubygems
+
+gem 'choosy', '~> 0.2.4'
+
+group :development do
+  gem 'rspec', :require => "spec"
+  gem 'autotest'
+  gem 'autotest-notification'
+end
+

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ZenTest (4.5.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-notification (2.3.1)
+      autotest (~> 4.3)
+    choosy (0.2.5)
+    diff-lcs (1.1.2)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  autotest-notification
+  choosy (~> 0.2.4)
+  rspec

data/Rakefile

@@ -10,10 +10,7 @@ require 'ytools/version'
 task :default => :spec
 
 desc "Run the RSpec tests"
-RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = ['-b', '-c', '-f', 'p']
-  t.fail_on_error = false
-end
+RSpec::Core::RakeTask.new
 
 begin
   require 'jeweler'
@@ -27,8 +24,9 @@ begin
     gem.authors        = ['Gabe McArthur']
     gem.homepage       = 'http://github.com/gabemc/ytools'
     gem.files          = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
-
-    gem.add_development_dependency 'rspec', '~> 2.5'
+    
+    gem.add_dependency             'choosy', '>=0.2.5'
+    gem.add_development_dependency 'rspec', '>=2.5.0'
   end
 rescue LoadError
   puts "Jeweler or dependencies are not available.  Install it with: sudo gem install jeweler"

data/lib/VERSION

@@ -1 +1 @@
-0.1.9
+0.2.0

data/lib/ytools/basecli.rb

@@ -1,67 +1,70 @@
-require 'optparse'
 require 'ytools/errors'
+require 'ytools/utils'
 require 'ytools/version'
 
 module YTools
-
   class BaseCLI
-    attr_reader :options, :args
-
     def initialize(args)
-      @args = args
-      @options = {}
+      @args = args.dup
     end
 
     def execute!
-      begin
-        sargs = args.dup
-        parse(sargs)
-        validate(sargs)
-        execute(sargs)
-      rescue SystemExit => e
-        raise
-      rescue YTools::ConfigurationError => e
-        print_error(e.message)
-      rescue OptionParser::InvalidOption => e
-        print_error(e.message)
-      rescue Exception => e
-        STDERR.puts e.backtrace
-        print_error(e.message)
-      end
+      tail(command).execute!(@args)
     end
 
-    protected
-    def parse(args)
-      # To override
+    def parse(propagate=nil)
+      tail(command).parse!(@args, propagate)
     end
 
-    def validate(args)
-      # To override
+    def command
+      # overridden
     end
 
-    def execute(args)
-      # To override
-    end
+    protected
+    def tail(command)
+      command.alter do
+        string :literal, "Evaluate a literal string in addition to any file paths."
+        boolean :strict, "Checks to make sure all of the YAML files exist before proceeding."
+        boolean :examples, "Show some examples on how to use the path syntax." do
+          validate do |show, options|
+            if show
+              YTools::Utils.print_example(File.join(File.dirname(__FILE__), command.name.to_s.gsub(/^y/, '')))
+            end
+          end
+        end
+        boolean_ :debug, "Prints out the merged YAML as a ruby object to STDERR."
+        version YTools::Version
+        help
+        
+        arguments do
+          metaname 'YAML_FILES'
+          count :at_least => 0
 
-    def print_version
-      puts "#{File.basename($0)} version: #{YTools::Version.to_s}"
-      exit 0
-    end
+          validate do |files, options|
+            if files.length == 0 && options[:literal].nil? && !YTools::Utils.stdin?
+              die "no YAML files given as arguments"
+            end
 
-    def print_examples(basedir)
-      examples = File.join(basedir, 'examples.txt')
-      File.open(examples, 'r') do |f|
-        f.each_line do |line|
-          puts line
+            begin
+              yaml_object = YTools::YamlObject.from_files(files, options[:strict])
+              if options[:literal]
+                yaml_object.merge(YAML::load(options[:literal]))
+              end
+              if YTools::Utils.stdin?
+                yaml_object.merge(YAML::load(STDIN.read))
+              end
+              options[:yaml_object] = yaml_object
+            rescue Exception => e
+              if options[:debug]
+                STDERR.puts e.stacktrace
+              end
+              die e.message
+            end
+          end
         end
       end
-      exit 0
-    end
 
-    def print_error(e)
-      STDERR.puts "ERROR: #{File.basename($0)}: #{e}"
-      STDERR.puts "ERROR: #{File.basename($0)}: Try '--help' for more information"
-      exit 1
+      command
     end
   end
 end

data/lib/ytools/path/cli.rb

@@ -1,120 +1,39 @@
-require 'optparse'
+require 'rubygems'
+require 'choosy'
 require 'ytools/basecli'
-require 'ytools/errors'
 require 'ytools/path/executor'
-require 'yaml'
+require 'ytools/path/parser'
 
 module YTools::Path
   class CLI < YTools::BaseCLI
-    protected 
-    def execute(sargs)
-      begin
-        yaml_object = if sargs.length != 0
-                        YTools::YamlObject.from_files(sargs)
-                      else
-                        YTools::YamlObject.new
-                      end
-
-        if options[:literal]
-          yaml_object.merge(YAML::load(options[:literal]))
-        end
-
-        executor = Executor.new(options[:path], yaml_object)
-
-        if options[:debug]
-          STDERR.puts yaml_object
-        end
-
-        output = executor.process!
-        puts output if !output.empty?
-      rescue YTools::Path::ParseError => e
-        print_path_error(e)
-      end
-    end
-
-    def parse(args)
-      OptionParser.new do |opts| 
-        opts.banner = "Usage: #{File.basename($0)} [OPTIONS] YAML_FILES"
-        opts.separator <<EOF
-Description:
-    This tool uses a kind of XPath syntax for locating and printing elements
-    from within YAML files.  Check out the '--examples' flag for details
-    on the exact path syntax.
-
-    It accepts multiple yaml files, and will merge their contents in the
-    order in which they are given.  Thus, files listed later, if their
-    keys conflict with ones listed earlier, override the earlier listed
-    values.  If you pass in files that don't exist, no error will be 
-    raised unless the '--strict' flag is passed.
-
-Options:
-EOF
-
-        opts.on('-p', '--path PATTERN',
-                "The pattern to use to access the",
-                "configuration.") do |p|
-          options[:path] = p
-        end
-        opts.on('-l', '--literal STRING',
-                "Evaluate a literal string in addition",
-                "to any file paths") do |l|
-          options[:literal] = l
-        end
-        opts.on('-s', '--strict',
-                "Checks to make sure all of the YAML files",
-                "exist before proceeding.") do |s|
-          options[:strict] = true
-        end
-        opts.separator ""
-        
-        opts.on('-e', '--examples',
-                "Show some examples on how to use the",
-                "path syntax.") do
-          print_examples(File.dirname(__FILE__))
-        end
-        opts.on('-v', '--version',
-                "Show the version information") do |v|
-          print_version
-        end
-        opts.on('-d', '--debug',
-                "Prints out the merged yaml as a",
-                "ruby object to STDERR.") do |d|
-          options[:debug] = true
-        end
-        opts.on('-h', '--help',
-                "Show this help message.") do
-          puts opts
-          exit 0
-        end
-      end.parse!(args)
-    end
-
-    def validate(args)
-      if options[:path].nil?
-        raise YTools::ConfigurationError.new("The path expression was empty.")
-      end
-      if args.length == 0 && options[:literal].nil?
-        raise YTools::ConfigurationError.new("No YAML files given as arguments")
-      end
-
-      if options[:strict]
-        args.each do |arg|
-          if !File.exists?(arg)
-            raise YTools::ConfigurationError.new("Non-existant YAML file: #{arg}")
+    def command
+      Choosy::Command.new :ypath do
+        printer :standard, :max_width => 80
+        executor Executor.new
+
+        header 'Description:'
+        para "This tool uses a kind of XPath syntax for locating and printing elements from within YAML files.  Check out the '--examples' flag for details on the exact path syntax."
+        para "It accepts multiple yaml files, and will merge their contents in the order in which they are given.  Thus, files listed later, if their keys conflict with ones listed earlier, override the earlier listed values.  If you pass in files that don't exist, no error will be  raised unless the '--strict' flag is passed."
+
+        header 'Option:'
+        string :path, "The YAML Path pattern syntax to run against the input." do
+          required
+          depends_on :examples
+          validate do |path, options|
+            begin
+              options[:selector] = YTools::Path::Parser.new(path).parse!
+            rescue YTools::Path::ParseError => e
+              if e.token.path == ""
+                die "error parsing expression: #{e.message}"
+              else
+                die "error parsing expression: #{e.message}
+    #{e.token.path}
+    #{' ' * e.token.offset}^"
+              end
+            end
           end
         end
       end
     end
-
-    def print_path_error(e)
-      STDERR.puts "ERROR: Path error: #{e.token.path}"
-      spacer = "ERROR:             "
-      e.token.offset.downto(1) do 
-        spacer << " "
-      end
-      spacer << "^"
-      STDERR.puts spacer
-      print_error("Path expression parsing error - #{e.message}")
-    end
   end # CLI
 end

data/lib/ytools/path/executor.rb

@@ -2,20 +2,28 @@ require 'ytools/yaml_object'
 require 'ytools/path/parser'
 
 module YTools::Path
-
   class Executor
-    attr_reader :path, :yaml_object
+    attr_reader :selector, :yaml_object
 
-    def initialize(path, yaml_object)
-      @path = path
+    def initialize(path=nil, yaml_object=nil)
+      @selector = Parser.new(path).parse! if path
       @yaml_object = yaml_object
     end
 
-    def process!
-      parser = Parser.new(path)
-      selectors = parser.parse!
+    def execute!(yaml_files, options)
+      @yaml_object = options[:yaml_object]
+
+      if options[:debug]
+        STDERR.puts @yaml_object.to_s
+      end
 
-      found = selectors.select(yaml_object)
+      @selector = options[:selector]
+      output = process!
+      puts output if !output.empty?
+    end
+
+    def process!
+      found = @selector.select(yaml_object)
       if found.is_a?(YTools::YamlObject)
         show_yaml_object(found)
       elsif found.is_a?(Array)
@@ -53,6 +61,5 @@ module YTools::Path
       end
       output
     end
-
   end
 end

data/lib/ytools/templates/cli.rb

@@ -1,133 +1,34 @@
-require 'optparse'
-require 'ytools/basecli'
 require 'ytools/errors'
+require 'ytools/basecli'
 require 'ytools/templates/executor'
+require 'rubygems'
+require 'choosy'
 
 module YTools::Templates
   class CLI < YTools::BaseCLI
-    protected
-    def execute(args)
-      yaml_object = if args.length != 0
-                      YTools::YamlObject.from_files(args)
-                    else
-                      YTools::YamlObject.new
-                    end
-            
-      if options[:literal]
-        yaml_object.merge(YAML::load(options[:literal]))
-      end
-
-      template = options[:expression]
-      if template.nil?
-        File.open(options[:template], 'r') { |f| template = f.read}
-      end
-
-      executor = Executor.new(template, yaml_object)
-
-      if options[:debug]
-        STDERR.puts yaml_object
-      end
-      
-      executor.write!(options[:output])
-    end
-
-    def parse(args)
-      OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename($0)} [OPTIONS] YAML_FILES"
-        opts.separator <<EOF
-Description:
-    This tool uses an ERB template file and a set of YAML files to
-    generate a merged file.  For convenience, all of the keys in
-    hashes in regular YAML can work like methods in the ERB templates.
-    Thus, the YAML "{ 'a' : {'b' : 3 } }" could be used in an 
-    ERB template with "<%= a.b %>" instead of the more verbose hash 
-    syntax.  Indeed, the root hash values can only be accessed by
-    those method attributes, because the root YAML context object
-    is simply assumed.
-
-    It accepts multiple yaml files, and will merge their contents in the
-    order in which they are given.  Thus, files listed later, if their
-    keys conflict with ones listed earlier, override the earlier listed
-    values.  If you pass in files that don't exist, no error will be 
-    raised unless the '--strict' flag is passed.
-
-    Check out the '--examples' flag for more details.
-
-Options:
-EOF
-        opts.on('-t', '--template ERB',
-                "The ERB template file to use for generation") do |t|
-          options[:template] = t
-        end
-        opts.on('-e', '--expression EXPR',
-                "The ERB expression to use for generation",
-                "overrides --template") do |e|
-          options[:expression] = e
-        end
-        opts.on('-l', '--literal STRING',
-                "Evaluate a literal string in addition",
-                "to any file paths") do |l|
-          options[:literal] = l
-        end
-        opts.on('-o', '--output FILE',
-                "Write the generated output to a file instead",
-                "of STDOUT") do |o|
-          options[:output] = o
-        end
-        opts.on('-s', '--strict',
-                "Checks to make sure all of the YAML files",
-                "exist before proceeding.") do |s|
-          options[:strict] = true
-        end
-        opts.separator ""
-        
-        opts.on('--examples',
-                "Show some examples on how to use the",
-                "path syntax.") do
-          print_examples(File.dirname(__FILE__))
-        end
-        opts.on('-v', '--version',
-                "Show the version information") do |v|
-          print_version
-        end
-        opts.on('-d', '--debug',
-                "Prints out the merged yaml as a",
-                "ruby object to STDERR.") do |d|
-          options[:debug] = true
-        end
-        opts.on('-h', '--help',
-                "Show this help message.") do
-          puts opts
-          exit 0
-        end
-      end.parse!(args)
-    end
-
-    def validate(args)
-      if options[:expression].nil? && options[:template].nil?
-        raise YTools::ConfigurationError.new("No template expression or file was indicated")
-      end
-
-      if options[:expression].nil? && !File.exists?(options[:template])
-        raise YTools::ConfigurationError.new("Unable to locate the template file: #{options[:template]}")
-      end
-
-      if options[:output] &&
-          !File.exists?(File.dirname(options[:output]))
-        raise YTools::ConfigurationError.new("The output directory doesn't exist: #{option[:output]}")
-      end
-
-      if args.length == 0 && options[:literal].nil?
-        raise YTools::ConfigurationError.new("No YAML files were given")
-      end
-
-      if options[:strict]
-        args.each do |file|
-          if !File.exists?(file)
-            raise YTools::ConfigurationError.new("Unable to locate YAML file: #{file}")
+    def command
+      Choosy::Command.new :ytemplates do
+        executor Executor.new
+        printer :standard, :max_width => 80
+
+        header 'Description:'
+        para 'This tool uses an ERB template file and a set of YAML files to generate a merged file.  For convenience, all of the keys in hashes in regular YAML can work like methods in the ERB templates. Thus, the YAML "{ \'a\' : {\'b\' : 3 } }" could be used in an ERB template with "<%= a.b %>" instead of the more verbose hash syntax.  Indeed, the root hash values can only be accessed by those method attributes, because the root YAML context object is simply assumed.'
+        para "It accepts multiple yaml files, and will merge their contents in the order in which they are given.  Thus, files listed later, if their keys conflict with ones listed earlier, override the earlier listed values.  If you pass in files that don't exist, no error will be raised unless the '--strict' flag is passed."
+        para "Check out the '--examples' flag for more details."
+
+        header 'Options:'
+        file :template, "The ERB template file to use for generation" do
+          required
+          depends_on :examples
+        end
+        string :output, "Write the generated output to a file instead of STDOUT" do
+          validate do |path, options|
+            if !File.exists?(File.dirname(options[:output]))
+              die "The output directory doesn't exist: #{option[:output]}"
+            end
           end
         end
       end
     end
-  end
+  end # CLI
 end

data/lib/ytools/templates/executor.rb

@@ -6,11 +6,22 @@ module YTools::Templates
   class Executor
     attr_reader :template, :yaml_object
 
-    def initialize(template, yaml_object)
+    def initialize(template=nil, yaml_object=nil)
       @template = template
       @yaml_object = yaml_object
     end
 
+    def execute!(yaml_files, options)
+      @template = options[:template]
+      @yaml_object = options[:yaml_object]
+
+      if options[:debug]
+        STDERR.puts @yaml_object.to_s
+      end
+      
+      write!(options[:output])
+    end
+
     def write!(outfile)
       generator = ERB.new(template)
       output = generator.result(yaml_object.erb_binding)

data/lib/ytools/utils.rb

@@ -0,0 +1,26 @@
+require 'optparse'
+require 'ytools/errors'
+require 'ytools/version'
+
+module YTools
+  module Utils
+    def self.print_example(basedir)
+      examples = File.join(basedir, 'examples.txt')
+      File.open(examples, 'r') do |f|
+        f.each_line do |line|
+          puts line
+        end
+      end
+      exit 0
+    end
+
+    def self.stdin?
+      begin
+        require 'fcntl'
+        STDIN.fcntl(Fcntl::F_GETFL, 0) == 0
+      rescue
+        $stdin.stat.size != 0
+      end
+    end
+  end
+end

data/lib/ytools/yaml_object.rb

@@ -2,13 +2,15 @@ require 'yaml'
 
 module YTools
   class YamlObject
-    def self.from_files(files)
+    def self.from_files(files, strict=nil)
       yo = YTools::YamlObject.new
       files.each do |file|
         if File.exists?(file)
           contents = nil
           File.open(file, 'r') { |f| contents = f.read}
           yo.merge(YAML::load(contents))
+        elsif strict
+          raise YTools::PathError.new("non-existant YAML file: #{file}")
         end
       end
       yo
@@ -30,7 +32,12 @@ module YTools
       merge(@yhash)
     end
 
-    def merge(hash)
+    def merge(hash) 
+      return if hash.nil?
+      if !hash.is_a?(Hash)
+        raise YTools::PathError.new("malformed YAML:\n#{hash}")
+      end
+
       hash.each do |key, value|
         add_entry(key, value)
       end
@@ -41,7 +48,7 @@ module YTools
       hash_key = @methods[method_name]
 
       if hash_key.nil?
-        raise YTools::PathError.new("Unable to locate attribute '#{relative_ypath}/#{method_name}'")
+        raise YTools::PathError.new("unable to locate attribute: '#{relative_ypath}/#{method_name}'")
       else
         @yhash[hash_key]
       end
@@ -50,7 +57,7 @@ module YTools
     def [](key)
       value = @yhash[key]
       if value.nil?
-        raise YTools::PathError.new("Unable to locate key \"#{relative_ypath}@['#{key}']\"")
+        raise YTools::PathError.new("unable to locate key: \"#{relative_ypath}@['#{key}']\"")
       end
       value
     end

metadata

@@ -1,40 +1,119 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: ytools
-version: !ruby/object:Gem::Version
-  version: 0.1.9
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
-authors:
+authors: 
 - Gabe McArthur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-02-12 00:00:00.000000000 -08:00
+
+date: 2011-03-10 00:00:00 -08:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &85986530 !ruby/object:Gem::Requirement
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: choosy
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.5'
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: autotest
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: autotest-notification
   prerelease: false
-  version_requirements: *85986530
-description: Installs the ypath tool for reading YAML files using an XPath-like syntax.  Installs
-  the ytemplates tool for writing ERB templates using YAML files as the template binding
-  object.
-email:
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: choosy
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 2
+        - 5
+        version: 0.2.5
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 5
+        - 0
+        version: 2.5.0
+  type: :development
+  version_requirements: *id006
+description: Installs the ypath tool for reading YAML files using an XPath-like syntax.  Installs the ytemplates tool for writing ERB templates using YAML files as the template binding object.
+email: 
 - madeonamac@gmail.com
-executables:
+executables: 
 - ypath
 - ytemplates
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.markdown
-files:
+files: 
+- Gemfile
+- Gemfile.lock
 - README.markdown
 - Rakefile
 - bin/ypath
@@ -52,6 +131,7 @@ files:
 - lib/ytools/templates/examples.txt
 - lib/ytools/templates/executor.rb
 - lib/ytools/templates/yaml_object.rb
+- lib/ytools/utils.rb
 - lib/ytools/version.rb
 - lib/ytools/yaml_object.rb
 - lib/ytools/yreader.rb
@@ -70,29 +150,36 @@ files:
 has_rdoc: true
 homepage: http://github.com/gabemc/ytools
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: For reading or writing configuration files using YAML.
-test_files:
+test_files: 
 - spec/helpers.rb
 - spec/path/executor_spec.rb
 - spec/path/lexer_spec.rb