hocon 1.1.3 → 1.2.4

data/README.md

@@ -18,6 +18,12 @@ you may still run into some issues. If you find a problem, feel free to open a g
 The implementation is intended to be as close to a line-for-line port as the two languages allow,
 in hopes of making it fairly easy to port over new changesets from the Java code base over time.
 
+Support
+=======
+
+For best results, if you find an issue with this library, please open an issue on our [Jira issue tracker](https://tickets.puppetlabs.com/browse/HC).  Issues filed there tend to be more visible to the current maintainers than issues on the Github issue tracker.
+
+
 Basic Usage
 ===========
 
@@ -72,6 +78,123 @@ Note that a `ConfigDocument` is used primarily for simple configuration manipula
 whitespace and comments. As such, it is not powerful as the regular `Config` API, and will not resolve
 substitutions.
 
+CLI Tool
+========
+The `hocon` gem comes bundles with a `hocon` command line tool which can be used to get and set values from hocon files
+
+```
+Usage: hocon [options] {get,set,unset} PATH [VALUE]
+
+Example usages:
+  hocon -i settings.conf -o new_settings.conf set some.nested.value 42
+  hocon -f settings.conf set some.nested.value 42
+  cat settings.conf | hocon get some.nested.value
+
+Subcommands:
+  get PATH - Returns the value at the given path
+  set PATH VALUE - Sets or adds the given value at the given path
+  unset PATH - Removes the value at the given path
+
+Options:
+    -i, --in-file HOCON_FILE         HOCON file to read/modify. If omitted, STDIN assumed
+    -o, --out-file HOCON_FILE        File to be written to. If omitted, STDOUT assumed
+    -f, --file HOCON_FILE            File to read/write to. Equivalent to setting -i/-o to the same file
+    -j, --json                       Output values from the 'get' subcommand in json format
+    -h, --help                       Show this message
+    -v, --version                    Show version
+```
+
+CLI Examples
+--------
+### Basic Usage
+```
+$ cat settings.conf
+{
+  foo: bar
+}
+
+$ hocon -i settings.conf get foo
+bar
+
+$ hocon -i settings.conf set foo.baz
+{
+  foo: baz
+}
+
+# Write to a different file
+$ hocon -i settings.conf -o new_settings.conf set some.nested.value 42
+$ cat new_settings.conf
+{
+  foo: bar
+  some: {
+    nested: {
+      value: 42
+
+    }
+  }
+}
+
+# Write back to the same file
+$ hocon -f settings.conf set some.nested.value 42
+$ cat settings.conf
+{
+  foo: bar
+  some: {
+    nested: {
+      value: 42
+
+    }
+  }
+}
+```
+
+### Complex Values
+If you give `set` a properly formatted hocon dictionary or array, it will try to accept it
+
+```
+$ hocon -i settings.conf set foo "{one: [1, 2, 3], two: {hello: world}}"
+{
+  foo: {one: [1, 2, 3], two: {hello: world}}
+}
+```
+
+### Chaining
+If `--in-file` or `--out-file` aren't specified, STDIN and STDOUT are used for the missing options. Therefore it's possible to chain `hocon` calls
+
+```
+$ cat settings.conf
+{
+  foo: bar
+}
+
+$ cat settings.conf | hocon set foo 42 | hocon set one.two three
+{
+  foo: 42
+  one: {
+    two: three
+  }
+}
+```
+
+### JSON Output
+Calls to the `get` subcommand will return the data in HOCON format by default, but setting the `-j/--json` flag will cause it to return a valid JSON object
+
+```
+$ cat settings.conf
+foo: {
+  bar: {
+    baz: 42
+  }
+}
+
+$ hocon -i settings.conf get foo --json
+{
+    "bar": {
+        "baz": 42
+    }
+}
+```
+
 Testing
 =======
 

data/bin/hocon

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'hocon/cli'
+
+Hocon::CLI.main(Hocon::CLI.parse_args(ARGV))
+

data/lib/hocon/cli.rb

@@ -0,0 +1,225 @@
+require 'optparse'
+require 'hocon'
+require 'hocon/version'
+require 'hocon/config_render_options'
+require 'hocon/config_factory'
+require 'hocon/config_value_factory'
+require 'hocon/parser/config_document_factory'
+require 'hocon/config_error'
+
+module Hocon::CLI
+  # Aliases
+  ConfigMissingError = Hocon::ConfigError::ConfigMissingError
+  ConfigWrongTypeError = Hocon::ConfigError::ConfigWrongTypeError
+
+  # List of valid subcommands
+  SUBCOMMANDS = ['get', 'set', 'unset']
+
+  # For when a path can't be found in a hocon config
+  class MissingPathError < StandardError
+  end
+
+  # Parses the command line flags and argument
+  # Returns a options hash with values for each option and argument
+  def self.parse_args(args)
+    options = {}
+    opt_parser = OptionParser.new do |opts|
+      subcommands = SUBCOMMANDS.join(',')
+      opts.banner = "Usage: hocon [options] {#{subcommands}} PATH [VALUE]\n\n" +
+          "Example usages:\n" +
+          "  hocon -i settings.conf -o new_settings.conf set some.nested.value 42\n" +
+          "  hocon -f settings.conf set some.nested.value 42\n" +
+          "  cat settings.conf | hocon get some.nested.value\n\n" +
+          "Subcommands:\n" +
+          "  get PATH - Returns the value at the given path\n" +
+          "  set PATH VALUE - Sets or adds the given value at the given path\n" +
+          "  unset PATH - Removes the value at the given path"
+
+      opts.separator('')
+      opts.separator('Options:')
+
+      in_file_description = 'HOCON file to read/modify. If omitted, STDIN assumed'
+      opts.on('-i', '--in-file HOCON_FILE', in_file_description) do |in_file|
+        options[:in_file] = in_file
+      end
+
+      out_file_description = 'File to be written to. If omitted, STDOUT assumed'
+      opts.on('-o', '--out-file HOCON_FILE', out_file_description) do |out_file|
+        options[:out_file] = out_file
+      end
+
+      file_description = 'File to read/write to. Equivalent to setting -i/-o to the same file'
+      opts.on('-f', '--file HOCON_FILE', file_description) do |file|
+        options[:file] = file
+      end
+
+      json_description = "Output values from the 'get' subcommand in json format"
+      opts.on('-j', '--json', json_description) do |json|
+        options[:json] = json
+      end
+
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
+      end
+
+      opts.on_tail('-v', '--version', 'Show version') do
+        puts Hocon::Version::STRING
+        exit
+      end
+    end
+    # parse! returns the argument list minus all the flags it found
+    remaining_args = opt_parser.parse!(args)
+
+    # Ensure -i and -o aren't used at the same time as -f
+    if (options[:in_file] || options[:out_file]) && options[:file]
+      exit_with_usage_and_error(opt_parser, "--file can't be used with --in-file or --out-file")
+    end
+
+    # If --file is used, set --in/out-file to the same file
+    if options[:file]
+      options[:in_file] = options[:file]
+      options[:out_file] = options[:file]
+    end
+
+    no_subcommand_error(opt_parser) unless remaining_args.size > 0
+
+    # Assume the first arg is the subcommand
+    subcommand = remaining_args.shift
+    options[:subcommand] = subcommand
+
+    case subcommand
+      when 'set'
+        subcommand_arguments_error(subcommand, opt_parser) unless remaining_args.size >= 2
+        options[:path] = remaining_args.shift
+        options[:new_value] = remaining_args.shift
+
+      when 'get', 'unset'
+        subcommand_arguments_error(subcommand, opt_parser) unless remaining_args.size >= 1
+        options[:path] = remaining_args.shift
+
+      else
+        invalid_subcommand_error(subcommand, opt_parser)
+    end
+
+    options
+  end
+
+  # Main entry point into the script
+  # Calls the appropriate subcommand and handles errors raised from the subcommands
+  def self.main(opts)
+    hocon_text = get_hocon_file(opts[:in_file])
+
+    begin
+      case opts[:subcommand]
+        when 'get'
+          puts do_get(opts, hocon_text)
+        when 'set'
+          print_or_write(do_set(opts, hocon_text), opts[:out_file])
+        when 'unset'
+          print_or_write(do_unset(opts, hocon_text), opts[:out_file])
+      end
+
+    rescue MissingPathError
+      exit_with_error("Can't find the given path: '#{opts[:path]}'")
+    end
+
+    exit
+  end
+
+  # Entry point for the 'get' subcommand
+  # Returns a string representation of the the value at the path given on the
+  # command line
+  def self.do_get(opts, hocon_text)
+    config = Hocon::ConfigFactory.parse_string(hocon_text)
+    unless config.has_path?(opts[:path])
+      raise MissingPathError.new
+    end
+
+    value = config.get_any_ref(opts[:path])
+
+    render_options = Hocon::ConfigRenderOptions.defaults
+    # Otherwise weird comments show up in the output
+    render_options.origin_comments = false
+    # If json is false, the hocon format is used
+    render_options.json = opts[:json]
+    # Output colons between keys and values
+    render_options.key_value_separator = :colon
+
+    Hocon::ConfigValueFactory.from_any_ref(value).render(render_options)
+  end
+
+  # Entry point for the 'set' subcommand
+  # Returns a string representation of the HOCON config after adding/replacing
+  # the value at the given path with the given value
+  def self.do_set(opts, hocon_text)
+    config_doc = Hocon::Parser::ConfigDocumentFactory.parse_string(hocon_text)
+    modified_config_doc = config_doc.set_value(opts[:path], opts[:new_value])
+
+    modified_config_doc.render
+  end
+
+  # Entry point for the 'unset' subcommand
+  # Returns a string representation of the HOCON config after removing the
+  # value at the given path
+  def self.do_unset(opts, hocon_text)
+    config_doc = Hocon::Parser::ConfigDocumentFactory.parse_string(hocon_text)
+    unless config_doc.has_value?(opts[:path])
+      raise MissingPathError.new
+    end
+
+    modified_config_doc = config_doc.remove_value(opts[:path])
+
+    modified_config_doc.render
+  end
+
+  # If a file is provided, return it's contents. Otherwise read from STDIN
+  def self.get_hocon_file(in_file)
+    if in_file
+      File.read(in_file)
+    else
+      STDIN.read
+    end
+  end
+
+  # Print an error message and exit the program
+  def self.exit_with_error(message)
+    STDERR.puts "Error: #{message}"
+    exit(1)
+  end
+
+  # Print an error message and usage, then exit the program
+  def self.exit_with_usage_and_error(opt_parser, message)
+    STDERR.puts opt_parser
+    exit_with_error(message)
+  end
+
+  # Exits with an error saying there aren't enough arguments found for a given
+  # subcommand. Prints the usage
+  def self.subcommand_arguments_error(subcommand, opt_parser)
+    error_message = "Too few arguments for '#{subcommand}' subcommand"
+    exit_with_usage_and_error(opt_parser, error_message)
+  end
+
+  # Exits with an error for when no subcommand is supplied on the command line.
+  # Prints the usage
+  def self.no_subcommand_error(opt_parser)
+    error_message = "Must specify subcommand from [#{SUBCOMMANDS.join(', ')}]"
+    exit_with_usage_and_error(opt_parser, error_message)
+  end
+
+  # Exits with an error for when a subcommand doesn't exist. Prints the usage
+  def self.invalid_subcommand_error(subcommand, opt_parser)
+    error_message = "Invalid subcommand '#{subcommand}', must be one of [#{SUBCOMMANDS.join(', ')}]"
+    exit_with_usage_and_error(opt_parser, error_message)
+  end
+
+  # If out_file is not nil, write to that file. Otherwise print to STDOUT
+  def self.print_or_write(string, out_file)
+    if out_file
+      File.open(out_file, 'w') { |file| file.write(string) }
+    else
+      puts string
+    end
+  end
+end

data/lib/hocon/config_render_options.rb

@@ -3,14 +3,15 @@
 require 'hocon'
 
 class Hocon::ConfigRenderOptions
-  def initialize(origin_comments, comments, formatted, json)
+  def initialize(origin_comments, comments, formatted, json, key_value_separator=:equals)
     @origin_comments = origin_comments
     @comments = comments
     @formatted = formatted
     @json = json
+    @key_value_separator = key_value_separator
   end
 
-  attr_accessor :origin_comments, :comments, :formatted, :json
+  attr_accessor :origin_comments, :comments, :formatted, :json, :key_value_separator
 
   def origin_comments?
     @origin_comments

data/lib/hocon/impl/abstract_config_value.rb

@@ -314,20 +314,17 @@ module Hocon::Impl::AbstractConfigValue
 
       if options.json?
         if options.formatted?
-          sb << " : "
+          sb << ": "
         else
           sb << ":"
         end
       else
-        # in non-JSON we can omit the colon or equals before an object
-        if self.is_a?(Hocon::ConfigObject)
-          if options.formatted?
-            sb << ' '
-          end
-        else
-          sb << "="
-        end
-      end
+        case options.key_value_separator
+          when :colon
+            sb << ": "
+          else
+            sb << "="
+        end      end
     end
     render_value_to_sb(sb, indent, at_root, options)
   end

data/lib/hocon/impl/config_delayed_merge.rb

@@ -296,7 +296,7 @@ class Hocon::Impl::ConfigDelayedMerge
       if !at_key.nil?
         sb << Hocon::Impl::ConfigImplUtil.render_json_string(at_key)
         if options.formatted
-          sb << " : "
+          sb << ": "
         else
           sb << ":"
         end

data/lib/hocon/impl/config_node_object.rb

@@ -206,7 +206,6 @@ class Hocon::Impl::ConfigNodeObject
     new_nodes = []
     new_nodes += indentation
     new_nodes.push(desired_path.first)
-    new_nodes.push(Hocon::Impl::ConfigNodeSingleToken.new(Tokens.new_ignored_whitespace(nil, ' ')))
     new_nodes.push(Hocon::Impl::ConfigNodeSingleToken.new(Tokens::COLON))
     new_nodes.push(Hocon::Impl::ConfigNodeSingleToken.new(Tokens.new_ignored_whitespace(nil, ' ')))
 
@@ -281,4 +280,4 @@ class Hocon::Impl::ConfigNodeObject
     path = Hocon::Impl::PathParser.parse_path_node(desired_path, flavor).value
     change_value_on_path(path, nil, flavor)
   end
-end
+end

data/lib/hocon/impl/config_node_root.rb

@@ -57,4 +57,4 @@ class Hocon::Impl::ConfigNodeRoot
     end
     raise Hocon::ConfigError::ConfigBugOrBrokenError, "ConfigNodeRoot did not contain a value"
   end
-end
+end

data/lib/hocon/impl/simple_config_document.rb

@@ -48,4 +48,4 @@ class Hocon::Impl::SimpleConfigDocument
   def hash
     render.hash
   end
-end
+end