hiera-browser 1.2.2 → 1.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2ZhZTJkYTg0OTQyODg5MWFiZGJjNzJiNTFhZTdiYTgwYjU3NjI1Yg==
+    MTJjYmRkM2QwZmU3N2M3OGFhNjM3YjhhZDNkNGNmMGI3NTBiODJhMw==
   data.tar.gz: !binary |-
-    YjllOTYxNDRhYjJjZDY3YTZmYWQ3MGRhN2Y2OTRhNThlMGVkMTZkNg==
+    OWY4MWM2M2ViOTg3MWFlMzA2MGYxN2I1MTk2YTE3MTI3MTkyMzc0Mw==
 SHA512:
   metadata.gz: !binary |-
-    MGJmNjFiYWM1YjFhYzAyYzI5NzZlYWFmZGFjZDQ1ZjI0OTA0MDQ1ZmQ5M2Jm
-    NTczNzM1NTk1YWMzMjQ0ZDFjMzgzZGE5Njk3M2NhMjUwNWRkMmZhMTIyYmZh
-    MjUxZTYwNTVjOTg3YzU4YmQ2OGMxOWRhYjFhZTQ2YjcxMDM3OTY=
+    NjQ1OGY4NDU5MmQ2NmVjN2EwNzAyNTlkN2I2NWM4M2Q3ZDk1ODczMWQ3YmE1
+    YWM5Mzg4YTRlODdjZjMzOTJiYjM5ODZmYzc4NDJhMDUyNjkzNGNkOGFiMzgz
+    OWZlY2U1OTAwMDg0ZGRlNjQ1YjlhNmZiMzQ5NGZiY2Q2MTZjZTY=
   data.tar.gz: !binary |-
-    M2VlNmU1NGZkYzlhNzY1MzExZGZkZDhiNTAzNTVlNWY4YjAzNDQ3Y2JjOTJj
-    YzRjMjBlYmExZmMzODM5NTdmZGU0NTY4NjQyYjNmNWM3NThjYWExMDQwOWJh
-    MGUzZDNiZGQxMjYyOGU2NGZjMWI1ZWIwOTE5YTM5YTJmMzJkYTI=
+    NTE1MjMxOGFmN2YwODlkN2E2YWRjOWYwOTE0N2QxY2RlMDAyMzNhMGE4NGM0
+    ZDEzMjk4YzY3ZmZiOWQ5NzllYjk3OWNlODY1ZGViNmZlMTA1OWIyMWNhMGZj
+    ODk1NmM5ODM2OGJhNzM3MDFhMTU5ZjRhYzgwMTI0OTQyMmM3MTE=

data/lib/app/ui.rb

@@ -12,7 +12,7 @@ use Rack::Session::Cookie, :secret => '4zENWx0ruhWU3ZN'
 class HieraBrowserUI < Sinatra::Application
   # api
   get '/api/v1/nodes' do
-    @nodes = Node.list
+    @nodes = YamlDir.new.node_list
     JSON.generate(@nodes)
   end
 
@@ -35,7 +35,7 @@ class HieraBrowserUI < Sinatra::Application
 
   get '/nodes' do
     @title = "node list"
-    @nodes = Node.list
+    @nodes = YamlDir.new.node_list
     slim :nodes
   end
 

data/lib/hiera_browser.rb

@@ -2,4 +2,5 @@ require 'hiera'
 require 'hiera_browser/hiera_controller'
 require 'hiera_browser/data'
 require 'hiera_browser/node'
-
+require 'hiera_browser/yamldir'
+require 'hiera_browser/parameters'

data/lib/hiera_browser/data.rb

@@ -1,37 +1,43 @@
 require 'yaml'
 
 class DataDir
-  attr_reader :path
+  attr_reader :paths
 
+  # @return [void]
   def initialize(args={})
-    @hiera = args[:hiera]
-    @paths = render_paths(:path => args[:path])
+    @node_dir = args[:node_dir] || YamlDir.new
+    @paths    = render_paths(:path => args[:path])
   end
 
+  # @return [Array]
   def render_paths(args)
     begin
-      variables = args[:path].match(/\%\{([a-z_\:]+)\}/).captures
-      variables.map{|v|
-        Node.parameters[v].map{|param|
-          args[:path].gsub(/\%\{#{v}\}/, param)}.flatten
+      interpolated_variables = args[:path].match(/\%\{([a-z_\:]+)\}/).captures
+      collected_parameters = @node_dir.collected_parameters 
+      # collected_parameters is a ParameterCollection
+      # interpolated_variables might look like ['::environment']
+      interpolated_variables.map{|v|
+        collected_parameters[v].map{|param|
+          args[:path].gsub(/%{#{v}}/, param)}
       }.flatten
     rescue NoMethodError
       [args[:path]]
     end
   end
 
+  # @return [Array]
   def yaml_files
-    @paths.map{|p|
-      Dir.chdir(p) { Dir.glob('**/*.yaml') }
-    }.flatten
+    @paths.map{|p| Dir.chdir(p) { Dir.glob('**/*.yaml') } }.flatten
   end
 
+  # @return [Array]
   def datafiles
     @paths.map{|path|
-      yaml_files.map{|f| DataFile.new(:path => File.join(path,f))}.flatten
+      yaml_files.map{|f| DataFile.new(:path => File.join(path,f))}
     }.flatten
   end
 
+  # @return [Array]
   def keys
     datafiles.map{|datafile| datafile.keys}.flatten.uniq.sort
   end
@@ -40,11 +46,13 @@ end
 class DataFile
   attr_reader :path
 
+  # @return [void]
   def initialize(args={})
     @path = args[:path]
     @keys = keys
   end
 
+  # @return [Array]
   def keys
     YAML.load_file(@path).keys
   end

data/lib/hiera_browser/hiera_controller.rb

@@ -1,22 +1,30 @@
 require 'yaml'
 
+# HieraController gives us a reasonably limited interface for Hiera
+#
+# @author David Gwilliam
 class HieraController
-  @@hiera_yaml = ENV['HIERA_YAML'] || './hiera.yaml'
   attr_reader :hiera_yaml
 
+  # @param args [{:hiera_yaml => String}] path to `hiera.yaml`
+  # @return [void]
   def initialize(args={})
-    @hiera_yaml = args[:hiera_yaml] || @@hiera_yaml
-    @hiera = hiera(:config => @hiera_yaml)
+    @hiera_yaml =  args[:hiera_yaml] || ENV['HIERA_YAML']
+    @hiera      =  hiera(:config => @hiera_yaml)
   end
 
+  # @param args [Hash] arguments to pass to Hiera.new()
+  # @return [Hiera]
   def hiera(args={})
     @hiera || Hiera.new(args)
   end
 
+  # @return [Hash]
   def config
     hiera.config
   end
 
+  # @return [Array]
   def datadirs
     config[:backends].map{|b| 
       path = config[b.to_sym][:datadir]
@@ -27,40 +35,59 @@ class HieraController
     }
   end
 
+  # @return [Array]
   def keys
     datadirs.map{|d| d.keys}.flatten.uniq.sort
   end
 
+  # @return [Array]
   def hierarchy
     config[:hierarchy]
   end
 
-  def top_scopify(args)
-    scope = args[:scope]
-    fix_keys = hierarchy.map{|datasource|
+  def hierarchy_variables
+    hierarchy.map{|datasource|
       begin
         datasource.match(/\%\{([\:a-z_]+)\}/)[1]
       rescue NoMethodError
         datasource
       end
     }
-    fix_keys.select!{|datasource| datasource.start_with?("::")} unless fix_keys.empty?
+  end
+
+  # Return the scope but with the addition of fully qualified 
+  #   variable keys for any level of the hierarchy that's formatted that way, e.g.:
+  #       { 'datacenter' => 'pdx', '::datacenter' => 'pdx' } 
+  #
+  # @note needs to be moved to Node
+  # @param args [{:scope => Hash}]
+  # @return [Hash] 
+  def top_scopify(args)
+    scope = args[:scope]
+    fix_keys = hierarchy_variables.select{|datasource| datasource.start_with?(Parameter.top_scope)}
     scope.inject({}){|a,fact|
-      if fix_keys.include?("::#{fact.first}")
-        a["::#{fact.first}"] = fact.last
-      end
+      a[Parameter.top_scope(fact.first)] = fact.last if fix_keys.include?(Parameter.top_scope(fact.first))
       a[fact.first] = fact.last
-      a
-    }
+      a }
   end
 
-  def lookup(args)
+  # Basically shadows the Hiera#lookup method
+  #
+  # @note needs to be moved to Node#lookup
+  # @param args [{:key => String, :scope => Hash, :resolution_type => Symbol}]
+  # @return [Hash]
+  def lookup(args = {})
+    raise ArgumentError, 'HieraController#lookup requires both :key and :scope args' unless args[:key] and args[:scope]
     key = args[:key]
     scope = top_scopify(:scope => args[:scope])
     resolution_type = args[:resolution_type] || :priority
     Hash[*[key,hiera.lookup(key, nil, scope, nil, resolution_type)]]
   end
 
+  # Retrieve all node values for all known hiera keys
+  #
+  # @param args [{:scope => Hash}]
+  # @return [Hash]
   def get_all(args)
     scope = top_scopify(:scope => args[:scope])
     values = keys.inject({}){|a, k|
@@ -73,6 +100,11 @@ class HieraController
     values
   end
 
+  # Check return value of priority lookup in order to determine which "additive"
+  # resolution type to use, then repeat the lookup with the correct resolution type
+  #
+  # @param args [{:key => String, :scope => Hash}]
+  # @return [Hash]
   def lookup_additive(args)
     key = args[:key]
     scope = top_scopify(:scope => args[:scope])

data/lib/hiera_browser/node.rb

@@ -1,71 +1,69 @@
 require 'yaml'
 require 'puppet'
 
+# A Node represents all that is known about a node in your infrastructure
 class Node
-  attr_reader :certname, :facts, :node_dir
+  # @return [String] e.g., 'testnode.puppetlabs.com'
+  attr_reader :certname
+  # @return [Hash] e.g., { 'datacenter' => 'pdx', 'environment' => 'dev' }
+  attr_reader :facts
+  # @return [YamlDir]
+  attr_reader :node_dir
 
-  @@node_dir = 
-    if ENV['YAML_DIR']
-      ENV['YAML_DIR']
-    elsif File.exist?('/var/opt/lib/pe-puppet/yaml')
-      '/var/opt/lib/pe-puppet/yaml/node'
-    else
-      '/var/lib/puppet/yaml/node'
-    end
 
+  # @param args [Hash{:certname => String, :node_dir => String}]
   def initialize(args)
     @certname    = args[:certname]
+    @node_dir    = YamlDir.new(:node_dir => args[:node_dir])
     @facts       = facts_yaml
     @hiera       = args[:hiera] || HieraController.new
   end
 
+  # @return [ParameterCollection]
+  def parameters
+    collection = ParameterCollection.new
+    facts_yaml.each {|k,v|
+      collection << Parameter.new(:key => k, :value => v)}
+    collection
+  end
+
+  # @return [Hash]
+  def load_yaml
+    path = File.join(@node_dir.path,"#{@certname}.yaml")
+    YAML.load_file(path)
+  end
+
+  # @return [Hash] parameters and facts merged from node cache
   def facts_yaml
-    path = File.join(@@node_dir,"#{@certname}.yaml")
-    node = YAML.load_file(path)
-    node.parameters.merge(node.facts.values)
+    yaml = load_yaml
+    yaml.parameters.merge(yaml.facts.values)
   end
 
-  def hiera_values(args={})
+  # @param args [Hash{:additive_keys => Array}]
+  # @return [Hash] all values for all keys, including additive lookups
+  #   for any keys included in :additive_keys
+  def hiera_values(args = {})
     additive_keys = args[:additive_keys] || []
     @hiera.get_all(:scope => @facts, :additive_keys => additive_keys).
       values.inject({}){|a,v| a.merge!(v)}
   end
 
-  def sorted_values(args)
+  # @param args [{:keys => Array}]
+  # @return [Array] flattened collection of all {#hiera_values} sorted alphabetically by key
+  #   e.g. [['datacenter', 'pdx'], ['environment', 'dev']]
+  def sorted_values(args = {})
     keys = args[:keys]
     hiera_values(:additive_keys => keys).sort_by{|k,v|k}
   end
 
+  # @return [String]
   def environment
     @facts['environment']
   end
 
-  def self.files
-    begin
-      Dir.chdir(@@node_dir) { Dir.glob('**/*.yaml') }
-    rescue Errno::ENOENT => e
-      raise "Can't find your $yamldir: #{e}"
-    end
-  end
-
-  def self.list
-    files = self.files
-    files.map{|f| f.split('.yaml')}.flatten
-  end
-
-  def self.parameters
-    files = self.files
-    files.map{|f| YAML.load_file(File.join(@@node_dir,f)).parameters}.
-      inject({}){|a,params|
-        params.each {|key, value| 
-          a[key] = [] unless a[key]
-          a[key] << value unless a[key].include? value
-        }
-        a 
-      }
-  end
-
-  def self.environments
-    self.parameters["environment"]
+  # @param args [Hash{:key => String}]
+  # @return [Hash]
+  def lookup(args)
+    @hiera.lookup_additive(:key => args[:key], :scope => @facts)
   end
 end

data/lib/hiera_browser/parameters.rb

@@ -0,0 +1,114 @@
+# A collection of {Parameter}s, based on Arrays
+class ParameterCollection
+  # @return [void]
+  def initialize
+    @collection = collection
+  end
+
+  # @return [Array]
+  def collection
+    @collection || []
+  end
+
+  def [](index)
+    stripped_index = index.sub(/^::/,'')
+    collection.select{|param| param.key == stripped_index }.map{|param|param.value}
+  end
+
+  # @param parameter [Parameter]
+  # @return [ParameterCollection]
+  def << (parameter)
+    collection << parameter
+    dedupe!
+    self
+  end
+
+  # @return [Array] all keys in this ParameterCollection
+  def keys
+    collection.map{|param| param.key}.uniq
+  end
+
+  # @param param [Parameter]
+  # @return [TrueClass, FalseClass] True if this ParameterCollection includes a Parameter
+  def include?(param)
+    truth = false
+    collection.each{|p| truth = true if p == param}
+    truth
+  end
+
+  # @return [Fixnum] the number of Parameters in the ParameterCollection
+  def count
+    collection.count
+  end
+
+  # @return [Hash] the parameter collection condensed to a Hash, multiple values 
+  #   for the same key condensed into an Array, all keys duplicated 
+  def to_h
+    self.keys.inject({}){|a, k| 
+      a[k]        = self[k]
+      a[Parameter.top_scope(k)] = self[k]
+      a }
+  end
+
+  private
+
+  def dedupe!
+    @collection = collection.inject([]){|a, param|
+      if a.include?(param)
+        a
+      else
+        a << param
+      end }
+  end
+end
+
+# Structured object for holding key/value parameters, whether they are facts or not
+class Parameter
+  # @param args [Hash{:key => String, :value => Object}]
+  # @return [void]
+  def initialize(args = {})
+    raise ArgumentError, "A Parameter must have both :key and :value" unless
+      args[:key] && args[:value]
+    @key           = descope(args[:key])
+    @value         = args[:value]
+  end
+
+  # @return [String] fully qualified {#key}
+  #   e.g. `::datacenter`
+  def top_scope_key
+    Parameter.top_scope(@key)
+  end
+
+  # @param param [Parameter]
+  # @return [TrueClass, FalseClass]
+  def == (param)
+    if param.class == Parameter && @key == param.key && @value == param.value
+      true
+    else
+      false
+    end
+  end
+
+  # @return [String]
+  attr_reader :key
+
+  # @return [Object]
+  attr_reader :value
+
+  class << self
+    # @param key [String]
+    # @return [String] the provided key, fully qualified, e.g. "::key"
+    def top_scope(key = '')
+      "::#{key}"
+    end
+  end
+
+  private
+
+  # @param key [String] a top-scope variable name / parameter key, e.g. ::key
+  # @return [String] the provided key with any top-scoping removed, e.g. key
+  def descope(key)
+    key.sub(/^::/,'')
+  end
+end
+

data/lib/hiera_browser/yamldir.rb

@@ -0,0 +1,58 @@
+require 'puppet'
+
+# YamlDir allows you to retrieve information from Puppet's node cache
+class YamlDir
+  @@node_dir = 
+    if ENV['YAML_DIR']
+      ENV['YAML_DIR']
+    elsif File.directory?('/var/opt/lib/pe-puppet/yaml')
+      '/var/opt/lib/pe-puppet/yaml/node'
+    else
+      '/var/lib/puppet/yaml/node'
+    end
+
+  def initialize(args = {})
+    @node_dir    = args[:node_dir] || @@node_dir
+    raise Exception.new "Can't find your $yamldir: #{@node_dir}" unless File.directory?(@node_dir)
+  end
+
+  def path
+    @node_dir
+  end
+
+  def file_list
+    Dir.chdir(@node_dir) { Dir.glob('**/*.yaml') }
+  end
+
+  def node_list
+    file_list.map{|f| f.split('.yaml')}.flatten
+  end
+
+  def load_files
+    file_list.map{|f| YAML.load_file(File.join(@node_dir,f))}
+  end
+
+  # @note #parameters is provided for temporary backwards compatibility
+  # @see #collected_parameters
+  def parameters
+    collected_parameters_hash
+  end
+
+  # @note #collected_parameters is preferred over #parameters
+  def collected_parameters
+    collection = ParameterCollection.new
+    load_files.map{|f| f.parameters}.
+      each{|params| params.each {|key, value| 
+          collection << Parameter.new(:key => key, :value => value) } }
+    collection
+  end
+
+  def collected_parameters_hash
+    collected_parameters.to_h
+  end
+
+  def environments
+    collected_parameters["environment"]
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiera-browser
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - David Gwilliam
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-05 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiera
@@ -192,6 +192,76 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
 description: Tries to guess what values hiera will return for any existing node in
   your infrastructure
 email: dhgwilliam@gmail.com
@@ -210,6 +280,8 @@ files:
 - lib/hiera_browser/data.rb
 - lib/hiera_browser/hiera_controller.rb
 - lib/hiera_browser/node.rb
+- lib/hiera_browser/parameters.rb
+- lib/hiera_browser/yamldir.rb
 homepage: 
 licenses:
 - APACHE 2.0