typesafe_config 0.0.1

data/LICENSE

@@ -0,0 +1,202 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,2 @@
+ruby-typesafe-config
+==========

data/lib/typesafe/config/config_error.rb

@@ -0,0 +1,12 @@
+require 'typesafe/config'
+
+class Typesafe::Config::ConfigError < StandardError
+  def initialize(origin, message, cause)
+    super(message)
+    @origin = origin
+    @cause = cause
+  end
+
+  class ConfigParseError < Typesafe::Config::ConfigError
+  end
+end

data/lib/typesafe/config/config_factory.rb

@@ -0,0 +1,9 @@
+require 'typesafe/config'
+require 'typesafe/config/config_parse_options'
+require 'typesafe/config/impl/parseable'
+
+class Typesafe::Config::ConfigFactory
+  def self.parse_file(file_path, options = Typesafe::Config::ConfigParseOptions.defaults)
+    Typesafe::Config::Impl::Parseable.new_file(file_path, options).parse.to_config
+  end
+end

data/lib/typesafe/config/config_object.rb

@@ -0,0 +1,4 @@
+require 'typesafe/config'
+
+module Typesafe::Config::ConfigObject
+end

data/lib/typesafe/config/config_parse_options.rb

@@ -0,0 +1,53 @@
+require 'typesafe/config'
+
+class Typesafe::Config::ConfigParseOptions
+  attr_accessor :syntax, :origin_description, :allow_missing, :includer
+
+  def self.defaults
+    self.new(nil, nil, true, nil)
+  end
+
+  def initialize(syntax, origin_description, allow_missing, includer)
+    @syntax = syntax
+    @origin_description = origin_description
+    @allow_missing = allow_missing
+    @includer = includer
+  end
+
+  def allow_missing?
+    @allow_missing
+  end
+
+  def with_syntax(syntax)
+    if @syntax == syntax
+      self
+    else
+      Typesafe::Config::ConfigParseOptions.new(syntax,
+                                    @origin_description,
+                                    @allow_missing,
+                                    @includer)
+    end
+  end
+
+  def with_includer(includer)
+    if @includer == includer
+      self
+    else
+      Typesafe::Config::ConfigParseOptions.new(@syntax,
+                                    @origin_description,
+                                    @allow_missing,
+                                    includer)
+    end
+  end
+
+  def append_includer(includer)
+    if @includer == includer
+      self
+    elsif @includer
+      with_includer(@includer.with_fallback(includer))
+    else
+      with_includer(includer)
+    end
+  end
+
+end

data/lib/typesafe/config/config_render_options.rb

@@ -0,0 +1,46 @@
+require 'typesafe/config'
+
+class Typesafe::Config::ConfigRenderOptions
+  def initialize(origin_comments, comments, formatted, json)
+    @origin_comments = origin_comments
+    @comments = comments
+    @formatted = formatted
+    @json = json
+  end
+
+  attr_writer :origin_comments, :comments, :formatted, :json
+
+  def origin_comments?
+    @origin_comments
+  end
+  def comments?
+    @comments
+  end
+  def formatted?
+    @formatted
+  end
+  def json?
+    @json
+  end
+
+  #
+  # Returns the default render options which are verbose (commented and
+  # formatted). See {@link ConfigRenderOptions#concise} for stripped-down
+  # options. This rendering will not be valid JSON since it has comments.
+  #
+  # @return the default render options
+  #
+  def self.defaults
+    Typesafe::Config::ConfigRenderOptions.new(true, true, true, true)
+  end
+
+  #
+  # Returns concise render options (no whitespace or comments). For a
+  # resolved {@link Config}, the concise rendering will be valid JSON.
+  #
+  # @return the concise render options
+  #
+  def self.concise
+    Typesafe::Config::ConfigRenderOptions.new(false, false, false, true)
+  end
+end

data/lib/typesafe/config/config_syntax.rb

@@ -0,0 +1,7 @@
+require 'typesafe/config'
+
+module Typesafe::Config::ConfigSyntax
+  JSON = 0
+  CONF = 1
+  PROPERTIES = 2
+end

data/lib/typesafe/config/config_value_type.rb

@@ -0,0 +1,26 @@
+require 'typesafe/config'
+
+#
+# The type of a configuration value (following the <a
+# href="http://json.org">JSON</a> type schema).
+#
+module Typesafe::Config::ConfigValueType
+  OBJECT = 0
+  LIST = 1
+  NUMBER = 2
+  BOOLEAN = 3
+  NULL = 4
+  STRING = 5
+
+  def self.name(config_value_type)
+    case config_value_type
+      when OBJECT then "OBJECT"
+      when LIST then "LIST"
+      when NUMBER then "NUMBER"
+      when BOOLEAN then "BOOLEAN"
+      when NULL then "NULL"
+      when STRING then "STRING"
+      else raise ConfigBugError, "Unrecognized value type '#{config_value_type}'"
+    end
+  end
+end

data/lib/typesafe/config/impl/abstract_config_object.rb

@@ -0,0 +1,64 @@
+require 'typesafe/config/impl'
+require 'typesafe/config/impl/abstract_config_value'
+require 'typesafe/config/impl/simple_config'
+require 'typesafe/config/config_object'
+require 'typesafe/config/config_value_type'
+require 'typesafe/config/impl/resolve_status'
+require 'typesafe/config/impl/simple_config_origin'
+
+class Typesafe::Config::Impl::AbstractConfigObject < Typesafe::Config::Impl::AbstractConfigValue
+  include Typesafe::Config::ConfigObject
+
+  def initialize(origin)
+    super(origin)
+    @config = Typesafe::Config::Impl::SimpleConfig.new(self)
+  end
+
+  def to_config
+    @config
+  end
+
+  def to_fallback_value
+    self
+  end
+
+  def value_type
+    Typesafe::Config::ConfigValueType::OBJECT
+  end
+
+  def new_copy(origin)
+    new_copy_with_status(resolve_status, origin)
+  end
+
+  def merge_origins(stack)
+    if stack.empty?
+      raise ConfigBugError, "can't merge origins on empty list"
+    end
+    origins = []
+    first_origin = nil
+    num_merged = 0
+    stack.each do |v|
+      if first_origin.nil?
+        first_origin = v.origin
+      end
+
+      if (v.is_a?(Typesafe::Config::Impl::AbstractConfigObject)) &&
+          (v.resolve_status == Typesafe::Config::Impl::ResolveStatus::RESOLVED) &&
+          v.empty?
+        # don't include empty files or the .empty()
+        # config in the description, since they are
+        # likely to be "implementation details"
+      else
+        origins.push(v.origin)
+        num_merged += 1
+      end
+    end
+
+    if num_merged == 0
+      # the configs were all empty, so just use the first one
+      origins.push(first_origin)
+    end
+
+    Typesafe::Config::Impl::SimpleConfigOrigin.merge_origins(origins)
+  end
+end

data/lib/typesafe/config/impl/abstract_config_value.rb

@@ -0,0 +1,130 @@
+require 'typesafe/config/impl'
+require 'stringio'
+require 'typesafe/config/config_render_options'
+require 'typesafe/config/config_object'
+require 'typesafe/config/impl/resolve_status'
+require 'typesafe/config/impl/unmergeable'
+require 'typesafe/config/impl/abstract_config_object'
+require 'typesafe/config/impl/config_impl_util'
+
+##
+## Trying very hard to avoid a parent reference in config values; when you have
+## a tree like this, the availability of parent() tends to result in a lot of
+## improperly-factored and non-modular code. Please don't add parent().
+##
+class Typesafe::Config::Impl::AbstractConfigValue
+  ConfigImplUtil = Typesafe::Config::Impl::ConfigImplUtil
+
+  def initialize(origin)
+    @origin = origin
+  end
+
+  attr_reader :origin
+
+  def resolve_status
+    Typesafe::Config::Impl::ResolveStatus::RESOLVED
+  end
+
+  # this is virtualized rather than a field because only some subclasses
+  # really need to store the boolean, and they may be able to pack it
+  # with another boolean to save space.
+  def ignores_fallbacks?
+    # if we are not resolved, then somewhere in this value there's
+    # a substitution that may need to look at the fallbacks.
+    resolve_status == Typesafe::Config::Impl::ResolveStatus::RESOLVED
+  end
+
+  # the withFallback() implementation is supposed to avoid calling
+  # mergedWith* if we're ignoring fallbacks.
+  def require_not_ignoring_fallbacks
+    if ignores_fallbacks?
+      raise ConfigBugError, "method should not have been called with ignoresFallbacks=true #{self.class.name}"
+    end
+  end
+
+  def with_origin(origin)
+    if @origin == origin
+      self
+    else
+      new_copy(origin)
+    end
+  end
+
+  def with_fallback(mergeable)
+    if ignores_fallbacks?
+      self
+    else
+      other = mergeable.to_fallback_value
+      if other.is_a?(Typesafe::Config::Impl::Unmergeable)
+        merged_with_the_unmergeable(other)
+      elsif other.is_a?(Typesafe::Config::Impl::AbstractConfigObject)
+        merged_with_object(other)
+      else
+        merged_with_non_object(other)
+      end
+    end
+  end
+
+  def to_s
+    sb = StringIO.new
+    render_to_sb(sb, 0, true, nil, Typesafe::Config::ConfigRenderOptions.concise)
+    "#{self.class.name}(#{sb.string})"
+  end
+
+  def indent(sb, indent_size, options)
+    if options.formatted?
+      remaining = indent_size
+      while remaining > 0
+        sb << "    "
+        remaining -= 1
+      end
+    end
+  end
+
+  def render_to_sb(sb, indent, at_root, at_key, options)
+    if !at_key.nil?
+      rendered_key =
+          if options.json?
+            ConfigImplUtil.render_json_string(at_key)
+          else
+            ConfigImplUtil.render_string_unquoted_if_possible(at_key)
+          end
+
+      sb << rendered_key
+
+      if options.json?
+        if options.formatted?
+          sb << " : "
+        else
+          sb << ":"
+        end
+      else
+        # in non-JSON we can omit the colon or equals before an object
+        if self.is_a?(Typesafe::Config::ConfigObject)
+          if options.formatted?
+            sb << ' '
+          end
+        else
+          sb << "="
+        end
+      end
+    end
+    render_value_to_sb(sb, indent, at_root, options)
+  end
+
+  # to be overridden by subclasses
+  def render_value_to_sb(sb, indent, at_root, options)
+    u = unwrapped
+    sb << u.to_s
+  end
+
+  def render(options = Typesafe::Config::ConfigRenderOptions.defaults)
+    sb = StringIO.new
+    render_to_sb(sb, 0, true, nil, options)
+    # We take a substring that ends at sb.pos, because we've been decrementing
+    # sb.pos at various points in the code as a means to remove characters from
+    # the end of the StringIO
+    sb.string[0, sb.pos]
+  end
+
+end