railsmachine-shadow_facter 0.1.0

data/Readme.rdoc

@@ -0,0 +1,33 @@
+= ShadowFacter
+
+ShadowFacter is a Ruby DSL for Facter, extracted out of the work we at Rails
+Machine are doing on Moonshine[http://blog.railsmachine.com/articles/2009/01/16/moonshine-configuration-management-and-deployment/].
+
+ShadowFacter provides a DSL for creating facts and processing them using Facter. A binary[http://railsmachine.github.com/shadow_facter/files/bin/shadow_facter.html] is provided to parse facts.
+
+
+Example:
+
+ $ cat examples/lib/facts/kernel.rb
+  require 'shadow_facter'
+
+  namespace :kernel do
+    fact :name do
+      exec "uname -s"
+    end
+
+    fact :release do
+      exec "uname -r"
+    end
+
+    fact :version do
+      value(:release).to_s.split('.')[0]
+    end
+  end
+
+Executing this fact:
+
+ $ bin/shadow_facter examples/lib/facts/kernel.rb
+ kernel_name => Darwin
+ kernel_version => 9
+ kernel_release => 9.6.0

data/bin/shadow_facter

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+# ShadowFacter allows the simple definition and gathering of facts
+# using Facter[http://reductivelabs.com/projects/facter/].
+#
+#== Sample facts:
+#
+#  $ cat examples/lib/facts/kernel.rb
+#  require 'shadow_facter'
+#
+#  namespace :kernel do
+#    fact :name do
+#      exec "uname -s"
+#    end
+#
+#    fact :release do
+#      exec "uname -r"
+#    end
+#
+#    fact :version do
+#      facts(:kernel)[:release].to_s.split('.')[0]
+#    end
+#  end
+#
+#== Executing this fact:
+#
+# $ bin/shadow_facter examples/lib/facts/kernel.rb
+# kernel_name => Darwin
+# kernel_version => 9
+# kernel_release => 9.6.0
+# $
+#
+# The shadow_facter binary parses the given ruby code, which is
+# expected to contain a definition of a namespace and some facts. Facts are
+# gathered and outputed.
+
+begin
+
+  require 'optparse'
+  opts = OptionParser.new do |opts|
+    opts.banner = <<-EOF
+    NAME
+      ShadowFacter
+
+    AUTHOR
+      Bradley Taylor
+      bradley@railsmachine.com
+
+    DESCRIPTION
+      A Ruby DSL for Facter
+
+    EXAMPLES
+      Sample fact:
+
+        $ cat examples/lib/facts/kernel.rb
+        require 'shadow_facter'
+
+        namespace :kernel do
+          fact :name do
+            exec "uname -s"
+          end
+
+          fact :release do
+            exec "uname -r"
+          end
+
+          fact :version do
+            value(:release).to_s.split('.')[0]
+          end
+        end
+
+      Executing this fact:
+
+        $ bin/shadow_facter examples/lib/facts/kernel.rb
+        kernel_name => Darwin
+        kernel_version => 9
+        kernel_release => 9.6.0
+        $
+
+      The shadow_facter binary parses the given ruby code, which is
+      expected to contain a definition of a namespace and some facts. Facts are
+      gathered and returned and pretty printed.
+
+  EOF
+  end
+
+  opts.parse!
+
+  filename = ARGV[0]
+  raise ArgumentError unless filename
+
+  require 'rubygems'
+  require 'shadow_facter'
+
+  load filename
+
+  namespaces.each do |namespace|
+    facts(namespace).to_hash.each do |k, v|
+      puts namespace.to_s + "_" + k.to_s + " => " + v.to_s
+    end
+  end
+end

data/lib/shadow_facter/base.rb

@@ -0,0 +1,150 @@
+# ShadowFacter allows the simple definition and gathering of facts
+# using Facter[http://reductivelabs.com/projects/facter/]
+#
+
+require 'facter'
+
+module ShadowFacter
+  class Facts
+
+    def initialize(namespace, keys)
+      @namespace = namespace
+      @keys = keys
+    end
+
+    # Return a fact value by key. Returns nil if non-existent or not constrained.
+    def [](key)
+      value(key)
+    end
+
+    # Return a fact value by key. Returns nil if non-existent or not constrained.
+    def value(key)
+      f = Facter[Base.facter_key(@namespace, key)]
+      f.value unless f.nil?
+    end
+
+    # Return an array of all of the constrained fact keys.
+    def keys
+      @keys.uniq.select { |k| !value(k).nil? }
+    end
+
+    # Return a boolean on the availability of a fact.
+    def has_fact?(key)
+      !value(key).nil?
+    end
+
+    # Return a hash of all of the constrained fact keys and values.
+    def to_hash
+      keys.inject({}) do |h, k|
+        h[k] = value(k)
+        h
+      end
+    end
+
+    # Return yaml of all of the constrained fact keys and values.
+    def to_yaml
+      require 'yaml'
+      to_hash.to_yaml
+    end
+
+    # Return json of all of the constrained fact keys and values.
+    def to_json
+      require 'json'
+      JSON.pretty_generate to_hash
+    end
+
+    # Reload facts in namespace.
+    def reload!
+      keys.each { |key| Facter[Base.facter_key(@namespace, key)].flush }
+    end
+
+  end
+
+
+  class Base
+    class << self
+
+      # Define a namespace.
+      def namespace(name)
+        @namespaces ||= Hash.new
+        raise "Nested namespaces not supported yet!" unless @current_namespace.nil?
+        @current_namespace = name
+        yield
+        @current_namespace = nil
+      end
+
+      # Return an array of defined namespaces names.
+      def namespaces()
+        @namespaces.keys
+      end
+
+      # Define a fact in Facter using a value or block. Can be confined with a hash
+      # of Facter keys (namespace_key) and value.
+      #
+      # Examples:
+      #   fact :tea, "oolong"
+      #   fact :tea, "puerh", {:drinks_season => "winter"}
+      #   fact(:rand) { rand }
+      def fact(key, value=nil, confine_args={}, &block)
+        raise "Namespace required!" unless current_namespace
+        @namespaces[current_namespace] ||= []
+        @namespaces[current_namespace] << key
+        block = lambda { value.to_s } unless block_given?
+        Facter.add(current_key(key)) do
+          confine confine_args unless confine_args.empty?
+          setcode block
+        end
+      end
+
+      # Return an instance of the Facts class for the specified namespace.
+      def facts(namespace)
+        ShadowFacter::Facts.new(namespace, @namespaces[namespace])
+      end
+
+      # Construct a namespaced key for using with Facter.
+      def facter_key(namespace, key)
+        (namespace.to_s + "_" + key.to_s).to_sym
+      end
+      
+      def current_namespace
+        @current_namespace
+      end
+
+      def current_key(key)
+        facter_key(current_namespace, key)
+      end
+      
+      private :current_namespace, :current_key
+    end
+  end
+end
+
+# Return an array of defined namespaces names.
+def namespaces()
+  ShadowFacter::Base.namespaces
+end
+
+# Define a namespace.
+def namespace(name, &b)
+  ShadowFacter::Base.namespace(name, &b)
+end
+
+# Define a fact in Facter using a value or block. Can be confined with a hash
+# of Facter keys (namespace_key) and value.
+# Examples:
+#   fact :tea, "oolong"
+#   fact :tea, "puerh", {:drinks_season => "winter"}
+#   fact(:rand) { rand }
+def fact(key, value=nil, confine_args={}, &b)
+  ShadowFacter::Base.fact(key, value, confine_args, &b)
+end
+
+# Return an instance of the Facts class for the specified namespace.
+def facts(namespace)
+  ShadowFacter::Base.facts(namespace)
+end
+
+# Execute a system command via Facter.
+def exec(command)
+  Facter::Util::Resolution.exec(command)
+end

data/lib/shadow_facter.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__) + '/shadow_facter', 'base.rb')
+
+
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: railsmachine-shadow_facter
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bradley Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-19 00:00:00 -08:00
+default_executable: shadow_facter
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: facter
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+    version: 
+description: Ruby simple DSL wrapper library for Facter
+email: 
+- bradley@railsmachine.com
+executables: 
+- shadow_facter
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Readme.rdoc
+- lib/shadow_facter.rb
+- lib/shadow_facter/base.rb
+- bin/shadow_facter
+has_rdoc: true
+homepage: http://railsmachine.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: moonshine
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Facter wrapper library
+test_files: []
+