wright 0.4.4 → 0.5.0

data/lib/wright/resource/symlink.rb

@@ -6,17 +6,19 @@ module Wright
     # Symlink resource, represents a symlink.
     #
     # @example
-    #   link = Wright::Resource::Symlink.new('/tmp/fstab')
-    #   link.to = '/etc/fstab'
+    #   link = Wright::Resource::Symlink.new('/tmp/fstab', to: '/etc/fstab')
     #   link.create
     class Symlink < Wright::Resource
       # Initializes a Symlink.
       #
       # @param name [String] the symlink's name
-      def initialize(name)
+      # @param args [Hash] the arguments
+      # @option args [Symbol] :action (:create) the action
+      # @option args [String] :to the symlink's target
+      def initialize(name, args = {})
         super
-        @to = nil
-        @action = :create
+        @action = args.fetch(:action, :create)
+        @to     = args.fetch(:to, nil)
       end
 
       # @return [String] the symlink's intended target
@@ -27,9 +29,9 @@ module Wright
       # @return [Bool] true if the symlink was updated and false
       #   otherwise
       def create
-        fail ArgumentError, 'Symlink target undefined' unless @to
+        fail ArgumentError, 'Symlink target undefined' unless to
         might_update_resource do
-          @provider.create
+          provider.create
         end
       end
 
@@ -39,7 +41,7 @@ module Wright
       #   otherwise
       def remove
         might_update_resource do
-          @provider.remove
+          provider.remove
         end
       end
     end

data/lib/wright/resource/user.rb

@@ -6,8 +6,7 @@ module Wright
     # User resource, represents a user.
     #
     # @example
-    #   johndoe = Wright::Resource::User.new('johndoe')
-    #   johndoe.home = '/home/johndoe'
+    #   johndoe = Wright::Resource::User.new('johndoe', home: '/home/johndoe')
     #   johndoe.create
     class User < Wright::Resource
       # @return [Integer] the user's intended user id
@@ -37,10 +36,26 @@ module Wright
       # Initializes a user.
       #
       # @param name [String] the user's name
-      def initialize(name)
+      # @param args [Hash] the arguments
+      # @option args [Symbol] :action (:create) the action
+      # @option args [Integer] :uid the user's uid
+      # @option args [String] :full_name the user's full name
+      # @option args [Array<String>] :groups the user's groups
+      # @option args [String] :shell the user's shell
+      # @option args [String] :home the user's home directory
+      # @option args [String] :primary_group the user's primary group
+      # @option args [Bool] :system (false) denotes whether the user
+      #   should be a system user or not
+      def initialize(name, args = {})
         super
-        @action = :create
-        @system = false
+        @action        = args.fetch(:action, :create)
+        @uid           = args.fetch(:uid, nil)
+        @full_name     = args.fetch(:full_name, nil)
+        @groups        = args.fetch(:groups, nil)
+        @shell         = args.fetch(:shell, nil)
+        @home          = fetch_last(args, [:home, :homedir], nil)
+        @primary_group = fetch_last(args, [:primary_group, :login_group], nil)
+        @system        = args.fetch(:system, false)
       end
 
       # Creates or updates the user.
@@ -49,7 +64,7 @@ module Wright
       #   otherwise
       def create
         might_update_resource do
-          @provider.create
+          provider.create
         end
       end
 
@@ -59,9 +74,15 @@ module Wright
       #   otherwise
       def remove
         might_update_resource do
-          @provider.remove
+          provider.remove
         end
       end
+
+      private
+
+      def fetch_last(hash, candidate_keys, default = nil)
+        Wright::Util.fetch_last(hash, candidate_keys, default)
+      end
     end
   end
 end
@@ -70,9 +91,9 @@ Wright::DSL.register_resource(Wright::Resource::User)
 
 user_providers = {
   'debian' => 'Wright::Provider::User::GnuPasswd',
-  'rhel'   => 'Wright::Provider::User::GnuPasswd',
   'fedora' => 'Wright::Provider::User::GnuPasswd',
-  'macosx' => 'Wright::Provider::User::DarwinDirectoryService'
+  'rhel'   => 'Wright::Provider::User::GnuPasswd',
+  'osx'    => 'Wright::Provider::User::DarwinDirectoryService'
 }
 Wright::Config[:resources][:user] ||= {}
 Wright::Config[:resources][:user][:provider] ||=

data/lib/wright/util.rb

@@ -56,7 +56,7 @@ module Wright
     #   # => "debian"
     # @example
     #   Wright::Util.os_family
-    #   # => "macosx"
+    #   # => "osx"
     #
     # @return [String] the system's OS family (base distribution for
     #   GNU/Linux systems) or 'other' for unknown operating systems
@@ -64,7 +64,7 @@ module Wright
       system_arch = RbConfig::CONFIG['target_os']
       case system_arch
       when /darwin/
-        'macosx'
+        'osx'
       when /linux/
         distro
       else
@@ -85,5 +85,17 @@ module Wright
         yield
       end
     end
+
+    # Fetches the value of the candidate key that occurs last in a hash.
+    #
+    # @param hash [Hash] the hash
+    # @param candidate_keys [Array<Object>] the candidate keys
+    # @param default [Object] the default value
+    # @return [Object] the value of the candidate key that occurs last in
+    #   the hash or +default+ if none of the candidate keys can be found
+    def self.fetch_last(hash, candidate_keys, default = nil)
+      candidates = hash.select { |k, _v| candidate_keys.include?(k) }
+      candidates.empty? ? default : candidates.values.last
+    end
   end
 end

data/lib/wright/util/erb_renderer.rb

@@ -0,0 +1,29 @@
+require 'erb'
+
+module Wright
+  module Util
+    # ERB renderer.
+    #
+    # @example
+    #   template = "foo is <%= foo %>."
+    #   hash = { foo: :bar }
+    #   Wright::Util::ErbRenderer.new(hash).render(template)
+    #   # => "foo is bar."
+    class ErbRenderer
+      def initialize(hash)
+        hash.each do |k, v|
+          instance_var = "@#{k}"
+          instance_variable_set(instance_var, v)
+          define_singleton_method(k) { instance_variable_get(instance_var) }
+        end
+      end
+
+      # Renders an ERB template.
+      # @param template [String] the template
+      # @return [String] the rendered template
+      def render(template)
+        ERB.new(template).result(binding)
+      end
+    end
+  end
+end

data/lib/wright/util/file.rb

@@ -54,7 +54,7 @@ module Wright
       private_constant :MODE_MAP
 
       def self.mode_mask(mode, is_directory)
-        mode.gsub!('X', 'x') if is_directory
+        mode.tr!('X', 'x') if is_directory
         mode.chars.reduce(0) { |a, e| a | MODE_MAP[e].to_i }
       end
       private_class_method :mode_mask

data/lib/wright/util/file_owner.rb

@@ -9,9 +9,14 @@ module Wright
       # @return [String, Integer] the group's name or gid
       attr_accessor :group
 
+      def initialize(user_and_group = nil, group = nil)
+        self.user_and_group = user_and_group
+        self.group = group if group
+      end
+
       # Sets user and group simultaneously.
       #
-      # @param [String, Integer] user_and_group a user in +user:group+
+      # @param user_and_group [String, Integer] a user in +user:group+
       #   notation or a uid
       #
       # @example
@@ -38,8 +43,8 @@ module Wright
       #   one colon
       def user_and_group=(user_and_group)
         user, group = split_user_and_group(user_and_group)
-        @user = user
-        @group = group if group
+        self.user = user
+        self.group = group if group
       end
 
       private

data/lib/wright/util/file_permissions.rb

@@ -60,8 +60,8 @@ module Wright
 
         mode_i = File.numeric_mode_to_i(mode)
         unless mode_i
-          base_mode_i = ::File.exist?(@filename) ? current_mode : default_mode
-          mode_i = File.symbolic_mode_to_i(mode, base_mode_i, @filetype)
+          base_mode_i = ::File.exist?(filename) ? current_mode : default_mode
+          mode_i = File.symbolic_mode_to_i(mode, base_mode_i, filetype)
         end
         @mode = mode_i
       end
@@ -70,7 +70,7 @@ module Wright
       # @return [Bool] +true+ if the file is up to date, +false+
       #   otherwise
       def uptodate?
-        if ::File.exist?(@filename)
+        if ::File.exist?(filename)
           uid_uptodate? && gid_uptodate? && mode_uptodate?
         else
           false
@@ -81,41 +81,43 @@ module Wright
       #
       # @return [void]
       def update
-        ::File.chmod(@mode, @filename) if @mode
-        ::File.chown(@uid, @gid, @filename) if @uid || @gid
+        ::File.chmod(mode, filename) if mode
+        ::File.chown(uid, gid, filename) if uid || gid
       end
 
       # @return [Integer] the file's current mode
       def current_mode
-        Wright::Util::File.file_mode(@filename)
+        Wright::Util::File.file_mode(filename)
       end
 
       # @return [Integer] the file's current owner's uid
       def current_uid
-        Wright::Util::File.file_owner(@filename)
+        Wright::Util::File.file_owner(filename)
       end
 
       # @return [Integer] the file's current group's gid
       def current_gid
-        Wright::Util::File.file_group(@filename)
+        Wright::Util::File.file_group(filename)
       end
 
       private
 
+      attr_reader :filetype
+
       def uid_uptodate?
-        @uid.nil? || current_uid == @uid
+        uid.nil? || current_uid == uid
       end
 
       def gid_uptodate?
-        @gid.nil? || current_gid == @gid
+        gid.nil? || current_gid == gid
       end
 
       def mode_uptodate?
-        @mode.nil? || current_mode == @mode
+        mode.nil? || current_mode == mode
       end
 
       def default_mode
-        case @filetype
+        case filetype
         when :file
           ~::File.umask & 0666
         when :directory

data/lib/wright/util/file_renderer.rb

@@ -0,0 +1,50 @@
+require 'wright/util/erb_renderer'
+require 'wright/util/mustache_renderer'
+
+module Wright
+  module Util
+    # File renderer.
+    #
+    # @example
+    #   filename = 'template.erb'
+    #   template = "foo is <%= foo %>."
+    #   hash = { foo: :bar }
+    #   File.write(filename, template)
+    #   renderer = Wright::Util::FileRenderer.new(hash)
+    #   renderer.render(filename)
+    #   # => "foo is bar."
+    class FileRenderer
+      # Initializes a FileTemplate.
+      # @param hash [Hash] the attribute hash of the template
+      def initialize(hash)
+        @hash = hash
+      end
+
+      # Renders a template file.
+      # @param filename [String] the filename of the template
+      # @raise [ArgumentError] if the given file type is not supported
+      def render(filename)
+        renderer = renderer_for_file(filename)
+        template = ::File.read(::File.expand_path(filename))
+        renderer.render(template)
+      end
+
+      private
+
+      attr_reader :hash
+
+      FILE_RENDERERS = {
+        '.erb' => ErbRenderer,
+        '.mustache' => MustacheRenderer
+      }
+
+      def renderer_for_file(filename)
+        file_extension = ::File.extname(filename)
+        rendering_class = FILE_RENDERERS[file_extension]
+        unknown_template_type = "unknown template type '#{file_extension}'"
+        fail ArgumentError, unknown_template_type unless rendering_class
+        rendering_class.new(hash)
+      end
+    end
+  end
+end

data/lib/wright/util/mustache_renderer.rb

@@ -0,0 +1,41 @@
+begin
+  require 'mustache'
+rescue LoadError # rubocop:disable Lint/HandleExceptions
+end
+
+require 'wright/util/pencil_mustache'
+
+module Wright
+  module Util
+    # Mustache renderer.
+    #
+    # @example
+    #   template = "foo is {{foo}}."
+    #   hash = { foo: :bar }
+    #   Wright::Util::MustacheRenderer.new(hash).render(template)
+    #   # => "foo is bar."
+    class MustacheRenderer
+      def initialize(hash)
+        @hash = hash
+        @mustache = select_mustache
+      end
+
+      # Renders a Mustache template.
+      # @param template [String] the template
+      # @return [String] the rendered template
+      def render(template)
+        @mustache.render(template, @hash)
+      end
+
+      private
+
+      def select_mustache
+        return PencilMustache.new unless defined?(Mustache)
+
+        mustache = Mustache.new
+        mustache.raise_on_context_miss = true
+        mustache
+      end
+    end
+  end
+end

data/lib/wright/util/pencil_mustache.rb

@@ -0,0 +1,58 @@
+# The code in this file is largely copied from PencilMustache by
+# Benjamin Oakes. The original code can be found at
+# https://github.com/benjaminoakes/pencil_mustache.
+#
+# The following is a verbatim copy of the original license (MIT):
+#
+#   Copyright (c) 2012 Benjamin Oakes
+#
+#   Permission is hereby granted, free of charge, to any person obtaining
+#   a copy of this software and associated documentation files (the
+#   "Software"), to deal in the Software without restriction, including
+#   without limitation the rights to use, copy, modify, merge, publish,
+#   distribute, sublicense, and/or sell copies of the Software, and to
+#   permit persons to whom the Software is furnished to do so, subject to
+#   the following conditions:
+#
+#   The above copyright notice and this permission notice shall be
+#   included in all copies or substantial portions of the Software.
+#
+#   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+#   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+#   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+#   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+#   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Wright
+  module Util
+    # PencilMustache class.
+    #
+    # @example
+    #   pencil_mustache = Wright::Util::PencilMustache.new
+    #   template = "foo is {{foo}}."
+    #   hash = { foo: :bar }
+    #   pencil_mustache.render(template, hash)
+    #   # => "foo is bar."
+    class PencilMustache
+      # Renders a Mustache template using the supplied hash.
+      # @param template [String] the template
+      # @param hash [Hash] the hash
+      # @return [String] the rendered template
+      # @todo Raise NameError if necessary.
+      # @todo Add support for triple whiskers.
+      def render(template, hash)
+        template.gsub(/{{.*?}}/, add_whiskers(hash))
+      end
+
+      private
+
+      def add_whiskers(doc)
+        with_whiskers = {}
+        doc.keys.each { |k| with_whiskers["{{#{k}}}"] = doc[k] }
+        with_whiskers
+      end
+    end
+  end
+end