hieracles 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9408641017def345036eb056db2f779c97775f0
-  data.tar.gz: b385041d4e5a05e1f427695e3eaea00ae2f529de
+  metadata.gz: 8c2b378bf82fee62a7577b514281f9ed47af9886
+  data.tar.gz: 6af4a764f1138d3e274b5f72752d2602f32d3966
 SHA512:
-  metadata.gz: bdad42ab493fda2652e02ff5a34847a7f1ab2aacdb1ef27907f6c3e5f15fc5ed47f8059e8a709c56f9fffee4b6acee2f0ff63cc1ea4ac67b8674c60ad71019a5
-  data.tar.gz: 345e4e5f501fc673b5b8fd9586a120f5455593a9b805fe3dbce0c2eceb6661062e7af884e21c0032d4ec058184c4936921a8d377a4ea7021180c229637085a7e
+  metadata.gz: 64d4bd38c3e9859edd3c2583180f640fc318eae6f0dfbcf336f38d22b0b4ede390a1589f6c2d9b7b81c73f66ca5c85872015ec3f1dcd498b13937c2d023ef55e
+  data.tar.gz: 3f1e85e5a9dd5e726e1542be700c7a7e2838e017ee32bfff962d02b43985900956b0e7db50c95a7c0465dc5b9fba2691829de34c1a1c831e666f0d7a4f103380

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 Hieracles Changelog
 =======================
 
+### 0.1.5 - 2015-11-15
+- add `interactive` new option `-i` for having 
+  CLI user promtped to fill up missing scope vars
+- implement interpolation adapted from the code of hiera
+- fixed the single option parsing for `-i`
+
 ### 0.1.4 - 2015-11-13
 - no real change, just preparing for BSD port
 

data/README.md

@@ -83,6 +83,7 @@ Usage
       -v - displays version
       -y <fact_file> - facts in yaml format
       -j <fact_file> - facts in json format
+      -i - interactive mode
 
 
 About facts aka. scope
@@ -99,7 +100,6 @@ Like with Hiera CLI you can use hieracles with defined top-scope variables. Thos
 You can define a default scope in your configuration file `defaultscope` in `~/.confg/hieracles/config.yml`. For example:
 
     ---
-    colors: true
     classpath: farm_modules/%s/manifests/init.pp
     hierafile: dev/hiera-local.yaml
     encpath: enc 
@@ -113,6 +113,10 @@ In order the scope with be built from:
 - if `-y <file>` option (or `-j`) is present the `defaultscope` in the config file will be totally ignored
 - the `-p key=value` option with overide variable per variable
 
+Note that if the scope var is not defined or if the file declared in hiera config is not found, this entry is silently ignored.
+
+An option, `-i` enables the `interactive mode` in which you are prompted to fill up for undefined scope variables encountered in the hiera config file. This behavior can be made systematic by enabling `interactive: true` in hieracles configuration file.
+
 
 Completion
 -------------
@@ -122,13 +126,15 @@ If you use [oh-my-zsh][omz] put it in `~/.oh-my-zsh/completions`
 
     wget -O ~/.oh-my-zsh/completions/_hc https://raw.githubusercontent.com/Gandi/hieracles/master/tools/completion/_hc
     echo 'compdef _hc hc "bundle exec hc"' >> ~/.zshrc
-
+    echo 'autoload -U _hc' >> ~/.zshrc
+    
 Otherwise 
 
     mkdir ~/.zsh-completions
     wget -O ~/.zsh-completions/_hc https://raw.githubusercontent.com/Gandi/hieracles/master/tools/completion/_hc
     echo 'fpath=(~/.zsh-completions $fpath)' >> ~/.zshrc
     echo 'compdef _hc hc "bundle exec hc"' >> ~/.zshrc
+    echo 'autoload -U _hc' >> ~/.zshrc
 
 
 Debian packaging

data/hc.1

@@ -1,4 +1,4 @@
-.TH hc 1 "2015-11-08" "version 0.1.0" "Hieracles command manual"
+.TH hc 1 "2015-11-08" "version 0.1.5" "Hieracles command manual"
 
 .SH NAME
 hc \- Command tool for Hieracles
@@ -13,10 +13,10 @@ hc \- Command tool for Hieracles
 .SH DESCRIPTION
 .PP
 Hieracles is a command-line tool for analysis and deep examination
-of [Hiera][hiera] paramaters in a [Puppet][puppet] setup. It's used
+of [Hiera][hiera] parameters in a [Puppet][puppet] setup. It's used
 internally at Gandi and its first incarnation is strongly
 tied to Gandi puppet architecture. But Hieracles tends to become, in
-time, a generic Hiera overlay visualisation tool.
+time, a generic Hiera overlay visualization tool.
 .PP
 hc command takes at minimum 2 arguments:
 .RS 4
@@ -72,7 +72,7 @@ outputs version.
 outputs in the selected format. Available formats are
 csv, json, console, plain, yaml and rawyaml
 .IP
-Note that the difference betrween yaml and rawyaml 
+Note that the difference between yaml and rawyaml 
 is that rawyaml don't include comments with the 
 provenance of each params.
 
@@ -109,7 +109,7 @@ stated in the configfile.
 .TP
 .PD
 .B \-\-basepath \fRpath
-the basepath is prepended to the paths found in the configfile and the hierafile. Default is ./ but you can change thise using the -b option.
+the basepath is prepended to the paths found in the configfile and the hierafile. Default is ./ but you can change this using the -b option.
 
 .TP
 .PD 0
@@ -117,9 +117,52 @@ the basepath is prepended to the paths found in the configfile and the hierafile
 .TP
 .PD
 .B \-\-encdir \fRpath
-encdir is where we can find the ENC definitions. It's stated in the configfile but can be overriden by the -e option.
+encdir is where we can find the ENC definitions. It's stated in the configfile but can be overridden by the -e option.
 
 
+.TP
+.PD 0
+.B \-y \fRfile
+.TP
+.PD
+.B \-\-yaml \fRfile
+use an arbitrary facts file that can be obtained with
+.B "facter -y"
+on the given node. This is useful for having a set of default fact
+and test locally what would be the consequences of switching from 
+one environment to another. It's also good for anticipation
+of how new node, that don't have facts yet, will behave.
+
+
+.TP
+.PD 0
+.B \-j \fRfile
+.TP
+.PD
+.B \-\-json \fRfile
+same as the 
+.B "-y"
+flag but in json format, which can be obtained on the node with 
+.B "facter -j"
+and this behave the same way. Note that the \-y has precedence on
+the \-j in this context.
+
+
+.TP
+.PD 0
+.B \-i
+.TP
+.PD
+.B \-\-interactive
+if a scope var is not defined or if the file declared in hiera config is not found, this entry is silently ignored.
+.RS
+This option enables the 
+.B "interactive mode"
+in which you are prompted to fill up for undefined scope variables encountered in the hiera config file. This behavior can be made systematic by enabling 
+.I "interactive: true"
+in hieracles configuration file.
+.RE
+
 .SH FILES
 .I ~/.config/hieracles/config.yaml
 .RS
@@ -132,9 +175,6 @@ A typical config file would look like:
 ---
 .RE
 .RS
-colors: true
-.RE
-.RS
 classpath: farm_modules/%s/manifests/init.pp
 .RE
 .RS
@@ -143,6 +183,9 @@ hierafile: dev/hiera-local.yaml
 .RS
 encpath: enc
 .RE
+.RS
+interactive: false
+.RE
 
 .SH SEE ALSO
 hiera(1), puppet(8)

data/hieracles.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
                         lib/hieracles/formats/yaml.rb
                         lib/hieracles/help.rb
                         lib/hieracles/hiera.rb
+                        lib/hieracles/interpolate.rb
                         lib/hieracles/node.rb
                         lib/hieracles/optparse.rb
                         lib/hieracles/registry.rb

data/lib/hieracles/config.rb

@@ -10,7 +10,7 @@ module Hieracles
     extend self
 
     attr_reader :extraparams, :server, :classpath, :scope,
-      :modulepath, :hierafile, :basepath, :encpath, :format
+      :modulepath, :hierafile, :basepath, :encpath, :format, :interactive
 
     def load(options)
       @optionfile = options[:config] || defaultconfig
@@ -27,6 +27,7 @@ module Hieracles
       facts_file = options[:yaml_facts] || options[:json_facts]
       facts_format = options[:json_facts] ? :json : :yaml
       @scope = sym_keys((facts_file && load_facts(facts_file, facts_format)) || values['defaultscope'] || {})
+      @interactive = options[:interactive] || values['interactive']
     end
 
     def initconfig(file)

data/lib/hieracles/interpolate.rb

@@ -0,0 +1,23 @@
+module Hieracles
+  module Interpolate
+
+    def parse(data, values, interactive = false)
+      data.gsub(/%\{(?:(scope|hiera|literal|alias) *)?([^\}]*)\}/) do |match|
+        if interactive && !values[$2.to_sym]
+          puts
+          puts "#{match} is not defined."
+          puts "Is it missing in your ENC source?"
+          puts "Maybe you should define a default value for that scope variable in your config file?"
+          puts "Do you want to provide a temmporary value? [input value]"
+          print "#{$2} = "
+          val = $stdin.gets.chomp
+          values[$2.to_sym] = val
+          val
+        else
+          values[$2.to_sym]
+        end
+      end
+    end
+
+  end
+end

data/lib/hieracles/node.rb

@@ -5,6 +5,7 @@ require "yaml"
 module Hieracles
   class Node
     include Hieracles::Utils
+    include Hieracles::Interpolate
 
     attr_reader :hiera_params, :hiera
 
@@ -28,8 +29,8 @@ module Hieracles
     end
 
     def files(without_common = true)
-      @hiera.hierarchy.reduce([]) do |a, f|
-        file = format("#{f}.yaml", @hiera_params) rescue nil
+      @__files ||= @hiera.hierarchy.reduce([]) do |a, f|
+        file = parse("#{f}.yaml", @hiera_params, Config.interactive)
         if file && 
            File.exist?(File.join(@hiera.datapath, file)) &&
            (!without_common ||

data/lib/hieracles/optparse.rb

@@ -40,6 +40,10 @@ module Hieracles
       json_facts: {
         has_arg: true,
         aliases: ['j', 'json']
+      },
+      interactive: {
+        has_arg: false,
+        aliases: ['i', 'interactive']
       }
     }
 
@@ -49,8 +53,13 @@ module Hieracles
       ok = optionkeys
       while x = array.shift
         if x[0] == '-'
-          if ok[x[/[a-z][-_a-z]*$/]]
-            @options[ok[x[/[a-z][-_a-z]*$/]]] = array.shift
+          found = ok[x[/[a-z][-_a-z]*$/]]
+          if found
+            if found[:has_args]
+              @options[found[:var]] = array.shift
+            else
+              @options[found[:var]] = true
+            end
           else
             array.shift
           end
@@ -64,7 +73,7 @@ module Hieracles
       back = {}
       OPTIONS.each do |k, v|
         v[:aliases].each do |a|
-          back[a] = k
+          back[a] = { var: k, has_args: v[:has_arg] }
         end
       end
       back

data/lib/hieracles.rb

@@ -1,3 +1,4 @@
+require 'hieracles/interpolate'
 require 'hieracles/optparse'
 require 'hieracles/config'
 require 'hieracles/hiera'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hieracles
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - lib/hieracles/formats/yaml.rb
 - lib/hieracles/help.rb
 - lib/hieracles/hiera.rb
+- lib/hieracles/interpolate.rb
 - lib/hieracles/node.rb
 - lib/hieracles/optparse.rb
 - lib/hieracles/registry.rb