jac 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85117aeca4175be823c52ff25aa33e0ebaf6efdf
-  data.tar.gz: b8c98ee89f3a3818cfa906f26e8ac3189282fd18
+  metadata.gz: 2b46834178b5af04b84cb286e7f449a4fc63920b
+  data.tar.gz: 04f6f8bd3f489f28fb78f138d2a665cf8e03e690
 SHA512:
-  metadata.gz: 7f9f97b2551ec8c5ec763673b615cfba497e434e4a3004e396cf106bd080c53398fbea623f3051318097fd419265a3c601e054abf805029b30250780c65b9ce3
-  data.tar.gz: 4f26c83218fffd715448ca87ba96e39d99a17efe702bde663e9aa2c3fb6f3cae20878177dbcac0c3ad97dbace423b57d8ff88a8f36bfb0dae6cbc738f9d3d377
+  metadata.gz: 6586f01ea2192d6abf3c49d525bd0c3586261ba74e5e23b03fc700f8dd0ffa40d97be1ce1b5b8b31fc3dbe07ebe17c66f629eab9768d422bc41e762ec6c68c40
+  data.tar.gz: 93a37896f9a576ae32147bc801463812e2a8b752ecc6cd3066ac032587e8fb29abc85abeae47e129098e964db04bc6bc44cf6e242b615d90e79e3647de4800a4

data/lib/jac/configuration.rb

@@ -9,7 +9,7 @@ module Jac
   # key names (i.e. `extends`) each key in profile is a
   # configuration field. For example following yaml document
   #
-  # ```
+  # ```yml
   #
   #  foo:
   #    bar: 42
@@ -39,7 +39,7 @@ module Jac
   # profiles. To specify this one should use `extends` field
   # like that
   #
-  # ```
+  # ```yml
   #
   # base:
   #   application_name: my-awesome-app
@@ -56,7 +56,7 @@ module Jac
   #
   # In this example `debug` will receive following fields:
   #
-  # ```
+  # ```yml
   # application_name: my-awesome-app  # from base profile
   # port: 9292                        # from debug profile
   # version_name: 0.0.0               # from version profile
@@ -70,7 +70,7 @@ module Jac
   # are merged down together. Having sequence of files like
   # `.application.yml`, `.application.user.yml` with following content
   #
-  # ```
+  # ```yml
   # # .application.yml
   # base:
   #   user: deployer
@@ -80,7 +80,7 @@ module Jac
   #   # ... other values
   # ```
   #
-  # ```
+  # ```yml
   # # .application.user.yml
   # base:
   #  user: developer
@@ -96,14 +96,14 @@ module Jac
   # feature: it allows evaluate strings as ruby expressions
   # like this:
   #
-  # ```
+  # ```yml
   # foo:
   #   build_time: "#{Time.now}" # Will be evaluated at configuration resolving step
   # ```
   #
   # Configuration values are available to and can be referenced with `c`:
   #
-  # ```
+  # ```yml
   # base:
   #   application_name: my-awesome-app
   # debug:
@@ -120,13 +120,47 @@ module Jac
   #
   # ## Merging values
   #
-  # By default if one value definition overwrites another 
+  # By default if one value have multiple defenitions it will be overwritten by
+  # topmost value. Except several cases where Jac handles value resolution
+  # specialy
+  #
   # ### Merging hashes
   #
-  # 
-  # ### Merging sets 
+  # Hashes inside profile are recurseively merged automaticly. This rule works
+  # for profile extensions and value redefenitions too.
+  #
+  # Example:
+  #
+  # ```yml
+  # base:
+  #   servers:
+  #     release: http://release.com
+  #
+  # debug:
+  #   extends: base
+  #     debug: http://debug.com
+  #
+  # ```
   #
+  # ### Merging sets
   #
+  # Sets allowed to be merged with `nil`s and any instance of `Enumerable`.
+  # Merge result is always new `Set` instance.
+  # ```yml
+  # release:
+  #   extends:
+  #     - no_rtti
+  #     - no_debug
+  #   flags: !set {} # empty set
+  # no_rtti:
+  #   flags:
+  #     - -fno-rtti
+  # no_debug:
+  #   flags:
+  #     - -DNDEBUG
+  # ```
+  #
+  # Resulting profile will have `-fno-rtti, -DNDEBUG` in `release profile`
   # ## Generic profiles
   #
   # Same result as shown above can be achieved with generic profiles. Generic profile
@@ -151,18 +185,17 @@ module Jac
       DEFAULT_PROFILE_NAME = 'default'.freeze
       # Creates "empty" config
       DEFAULT_CONFIGURATION = -> () { { DEFAULT_PROFILE_NAME => {} } }
-      # Creates configuration reader
-      # @param streams [Array] of pairs containing YAML document and provided
-      # name for this stream
       attr_reader :merger
+      # Creates configuration reader
+      # @param [Array] streams of pairs containing YAML document and provided
+      #   name for this stream
       def initialize(streams)
         @streams = streams
         @merger = Merger.new
       end
 
       # Parses all streams and resolves requested profile
-      # @param profile [Array] list of profile names to be
-      # merged
+      # @param [Array] profile list of profile names to be merged
       # @return [OpenStruct] instance which contains all resolved profile fields
       def read(*profile)
         result = @streams
@@ -177,7 +210,7 @@ module Jac
         # Each stream consists of one or more documents
         YAML.parse_stream(stream).children.flat_map do |document|
           # Will use separate visitor per YAML document.
-          visitor = Only::Parser::VisitorToRuby.create
+          visitor = Jac::Parser::VisitorToRuby.create
           # Expecting document to be single mapping
           profile_mapping = document.children.first
           raise(ArgumentError, 'Mapping expected') unless profile_mapping.is_a? Psych::Nodes::Mapping
@@ -208,8 +241,8 @@ module Jac
       # @param [Hash] base value mappings
       # @param [Hash] values ovverides.
       # @return [Hash] merged profile
-      def merge!(base, overrides)
-        merger.merge!(base, overrides)
+      def merge!(base, values)
+        merger.merge!(base, values)
       end
 
       def resolve(profile, config)
@@ -261,7 +294,9 @@ module Jac
       def generate_profile(match, matched_profile, profile_name)
         gen_profile = {}
         gen_profile['captures'] = match.captures if match.captures
-        gen_profile['named_captures'] = match.named_captures if match.named_captures
+        if match.respond_to?(:named_captures) && match.named_captures
+          gen_profile['named_captures'] = match.named_captures
+        end
         gen_profile.merge!(config[matched_profile])
 
         config[profile_name] = gen_profile
@@ -373,13 +408,13 @@ module Jac
     end
 
     # List of files where configuration can be placed
-    # * `application.yml` - expected to be main configuration file.
+    # * `jac.yml` - expected to be main configuration file.
     # Usually it placed under version control.
-    # * `application.user.yml` - user defined overrides for main
+    # * `jac.user.yml` - user defined overrides for main
     # configuration, sensitive data which can't be placed
     # under version control.
-    # * `application.override.yml` - final overrides.
-    CONFIGURATION_FILES = %w[application.yml application.user.yml application.override.yml].freeze
+    # * `jac.override.yml` - final overrides.
+    CONFIGURATION_FILES = %w[jac.yml jac.user.yml jac.override.yml].freeze
 
     class << self
       # Generates configuration object for given profile
@@ -394,10 +429,14 @@ module Jac
       end
 
       # Read configuration from configuration files.
+      # @praram [String or Array] profile which should be loaded
+      # @param [Array] files filenames to load
+      # @param [String] dir base directory path for provided files may be nil
+      # @return [OpenStruct] resolved profile values
       def load(profile, files: CONFIGURATION_FILES, dir: Dir.pwd)
         # Read all known files
         streams = files
-                  .map { |f| [File.join(dir, f), f] }
+                  .map { |f| [dir ? File.join(dir, f) : f, f] }
                   .select { |path, _name| File.exist?(path) }
                   .map { |path, name| [IO.read(path), name] }
         read(profile, *streams)

data/lib/jac/parser.rb

@@ -2,16 +2,17 @@ require 'psych'
 require 'set'
 
 module Jac
+  # Custom YAML parsing routines
   module Parser
     # Cutstom Yaml AST visitor
-    # @see {Psych::Visitors::ToRuby}
-    # While standart Psych visitor converts sets to `{ value => nil }` mappings
-    # we need explicitly convert those mappings to ruby {Set}
+    # @see Psych::Visitors::ToRuby
+    # While standard Psych visitor converts sets to `{ value => nil }` mappings
+    # we need explicitly convert those mappings to ruby [Set]
     class VisitorToRuby < Psych::Visitors::ToRuby
       # rubocop: disable Naming/MethodName
 
       # Uses standard Psych visitor to convert mapping to ruby object
-      # except `!set` case. Here we convert mapping to {Set}.
+      # except `!set` case. Here we convert mapping to [Set].
       # @param [Psych::Nodes::Mapping] o YAML AST node
       # @return [Object] parsed ruby object
       def visit_Psych_Nodes_Mapping(o)

data/lib/jac.rb

@@ -1,3 +1,8 @@
 require_relative 'jac/configuration'
 require_relative 'jac/merger'
 require_relative 'jac/parser'
+
+# Just another config top level module
+# @see Jac::Configuration
+module Jac
+end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jac
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - ilya.arkhanhelsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: powerpack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.1.1
+date: 2017-11-15 00:00:00.000000000 Z
+dependencies: []
 description: Profile based configuration lib
 email: ilya.arkhanhelsky@vizor-games.com
 executables: []
@@ -34,7 +20,6 @@ files:
 - lib/jac/configuration.rb
 - lib/jac/merger.rb
 - lib/jac/parser.rb
-- lib/version.rb
 homepage: https://github.com/vizor-games/jac
 licenses:
 - MIT

data/lib/version.rb

@@ -1,14 +0,0 @@
-module Jac
-  # Jac version module
-  module Version
-    class << self
-      def value
-        [ 0, 0, 1]
-      end
-
-      def to_s
-        value.join('.')
-      end
-    end
-  end
-end