wright 0.2.0 → 0.3.0

data/lib/wright/provider/user.rb

@@ -11,26 +11,20 @@ module Wright
       #
       # @return [void]
       def create
-        if uptodate?(:create)
-          Wright.log.debug "user already created: '#{@resource.name}'"
-          return
+        user = @resource.name
+        unless_uptodate(:create, "user already created: '#{user}'") do
+          create_user
         end
-
-        create_user
-        @updated = true
       end
 
       # Removes the user.
       #
       # @return [void]
       def remove
-        if uptodate?(:remove)
-          Wright.log.debug "user already removed: '#{@resource.name}'"
-          return
+        user = @resource.name
+        unless_uptodate(:remove, "user already removed: '#{user}'") do
+          remove_user
         end
-
-        remove_user
-        @updated = true
       end
 
       private

data/lib/wright/provider.rb

@@ -1,3 +1,5 @@
+require 'open3'
+
 require 'wright/config'
 require 'wright/dry_run'
 require 'wright/util/recursive_autoloader'
@@ -45,6 +47,22 @@ module Wright
       end
     end
 
+    # @api public
+    # Checks if the provider is up-to-date, runs a code block and sets
+    # `@updated` to `true` if it is not.
+    #
+    # @param action [String] the target action
+    # @param message [String] a log message that is displayed if the
+    #   provider is up-to-date
+    def unless_uptodate(action, message)
+      if uptodate?(action)
+        Wright.log.debug message
+      else
+        yield
+        @updated = true
+      end
+    end
+
     # @api public
     # Runs a command or fails with an error message.
     #
@@ -54,10 +72,10 @@ module Wright
     # @param error_message [String] the error message to display in
     #   case of an error
     # @raise [RuntimeError] if the command did not exit successfully
-    # @return [void]
+    # @return [String] the stdout output of the command
     def exec_or_fail(command, args, error_message)
       stdout, stderr, status = Open3.capture3(env, command, *args)
-      return if status.success?
+      return stdout if status.success?
 
       error = stderr.chomp
       error = stdout.chomp if error.empty?

data/lib/wright/resource/directory.rb

@@ -1,5 +1,8 @@
+require 'forwardable'
+
 require 'wright/resource'
 require 'wright/dsl'
+require 'wright/util/file_owner'
 
 module Wright
   class Resource
@@ -9,38 +12,34 @@ module Wright
     #   dir = Wright::Resource::Directory.new('/tmp/foobar')
     #   dir.create
     class Directory < Wright::Resource
+      extend Forwardable
+
       # Initializes a Directory.
       #
       # @param name [String] the directory's name
       def initialize(name)
         super
         @mode = nil
-        @owner = nil
-        @group = nil
+        @owner = Wright::Util::FileOwner.new
         @action = :create
       end
 
-      # @return [String, Integer] the directory's mode
+      # @return [String, Integer] the directory's intended mode
       attr_accessor :mode
 
-      # @return [String] the directory's owner
-      attr_reader :owner
-
-      # Sets the directory's owner.
-      def owner=(owner)
-        target_owner, target_group =
-          Wright::Util::User.owner_to_owner_group(owner)
-        @owner = target_owner unless target_owner.nil?
-        @group = target_group unless target_group.nil?
-      end
-
-      # @return [String] the directory's group
-      attr_reader :group
+      # @!attribute owner
+      #   @return [String, Integer] the directory's intended owner
+      # @!method owner=
+      #   @see #owner
+      def_delegator :@owner, :user_and_group=, :owner=
+      def_delegator :@owner, :user, :owner
 
-      # Sets the directory's group.
-      def group=(group)
-        @group = Wright::Util::User.group_to_gid(group)
-      end
+      # @!attribute group
+      #   @return [String, Integer] the directory's intended group
+      # @!method group=
+      #   @see #group
+      def_delegator :@owner, :group
+      def_delegator :@owner, :group=
 
       # Creates or updates the directory.
       #

data/lib/wright/resource/file.rb

@@ -1,5 +1,8 @@
+require 'forwardable'
+
 require 'wright/resource'
 require 'wright/dsl'
+require 'wright/util/file_owner'
 
 module Wright
   class Resource
@@ -10,17 +13,27 @@ module Wright
     #   file.content = 'bar'
     #   file.create
     class File < Wright::Resource
+      extend Forwardable
+
       # @return [String] the file's intended content
       attr_accessor :content
 
-      # @return [String] the file's intended group
-      attr_accessor :group
-
       # @return [String, Integer] the file's intended mode
       attr_accessor :mode
 
-      # @return [String] the file's intended owner
-      attr_reader :owner
+      # @!attribute owner
+      #   @return [String, Integer] the directory's intended owner
+      # @!method owner=
+      #   @see #owner
+      def_delegator :@owner, :user_and_group=, :owner=
+      def_delegator :@owner, :user, :owner
+
+      # @!attribute group
+      #   @return [String, Integer] the directory's intended group
+      # @!method group=
+      #   @see #group
+      def_delegator :@owner, :group=
+      def_delegator :@owner, :group
 
       # Initializes a File.
       #
@@ -29,19 +42,10 @@ module Wright
         super
         @content = nil
         @mode = nil
-        @owner = nil
-        @group = nil
+        @owner = Wright::Util::FileOwner.new
         @action = :create
       end
 
-      # Sets the file's owner.
-      def owner=(owner)
-        target_owner, target_group =
-          Wright::Util::User.owner_to_owner_group(owner)
-        @owner = target_owner unless target_owner.nil?
-        @group = target_group unless target_group.nil?
-      end
-
       # Creates or updates the file.
       #
       # @return [Bool] true if the file was updated and false

data/lib/wright/resource/symlink.rb

@@ -27,6 +27,7 @@ module Wright
       # @return [Bool] true if the symlink was updated and false
       #   otherwise
       def create
+        fail ArgumentError, 'Symlink target undefined' unless @to
         might_update_resource do
           @provider.create
         end

data/lib/wright/resource/user.rb

@@ -69,7 +69,8 @@ end
 Wright::DSL.register_resource(Wright::Resource::User)
 
 user_providers = {
-  'debian' => 'Wright::Provider::User::GnuPasswd'
+  'debian' => 'Wright::Provider::User::GnuPasswd',
+  'macosx' => 'Wright::Provider::User::DarwinDirectoryService'
 }
 Wright::Config[:resources][:user] ||= {}
 Wright::Config[:resources][:user][:provider] ||=

data/lib/wright/resource.rb

@@ -125,7 +125,7 @@ module Wright
 
       if Wright.dry_run?
         resource = "#{@resource_name} '#{@name}'"
-        Wright.log.info "Would trigger update action for #{resource}"
+        Wright.log.info "(would) run update action for #{resource}"
       else
         @on_update.call
       end

data/lib/wright/util/file_owner.rb

@@ -0,0 +1,61 @@
+module Wright
+  module Util
+    # Helper class to support +user:group+ notation in file owner
+    # strings.
+    class FileOwner
+      # @return [String, Integer] the user's name or uid
+      attr_accessor :user
+
+      # @return [String, Integer] the group's name or gid
+      attr_accessor :group
+
+      # Sets user and group simultaneously.
+      #
+      # @param [String, Integer] user_and_group a user in +user:group+
+      #   notation or a uid
+      #
+      # @example
+      #   owner = FileOwner.new
+      #
+      #   owner.user_and_group = 'user:group'
+      #   owner.user
+      #   # => "user"
+      #   owner.group
+      #   # => "group"
+      #
+      #   owner.user_and_group = 'newuser'
+      #   owner.user
+      #   # => "newuser"
+      #   owner.group
+      #   # => "group"
+      #
+      #   owner.user_and_group = 42
+      #   owner.user
+      #   # => 42
+      #
+      # @return [void]
+      # @raise [ArgumentError] if the owner string contains more than
+      #   one colon
+      def user_and_group=(user_and_group)
+        user, group = split_user_and_group(user_and_group)
+        @user = user
+        @group = group if group
+      end
+
+      private
+
+      def split_user_and_group(user_and_group)
+        user = user_and_group
+        group = nil
+        return [user, group] unless user_and_group.is_a?(String)
+
+        if user_and_group.count(':') > 1
+          fail ArgumentError, "Invalid owner: '#{user_and_group}'"
+        end
+
+        user, group = user_and_group.split(':')
+        [user, group]
+      end
+    end
+  end
+end

data/lib/wright/util/file_permissions.rb

@@ -14,26 +14,27 @@ module Wright
       #
       # @return [Wright::Util::FilePermissions] the FilePermissions
       #   object
+      # @raise [ArgumentError] if the user or group are invalid
       def self.create_from_resource(resource, filetype)
         filepath = ::File.expand_path(resource.name)
         p = Wright::Util::FilePermissions.new(filepath, filetype)
-        p.owner = resource.owner
-        p.group = resource.group
+        p.uid = Wright::Util::User.user_to_uid(resource.owner)
+        p.gid = Wright::Util::User.group_to_gid(resource.group)
         p.mode = resource.mode
         p
       end
 
-      # @return [String] the target file's name
+      # @return [String] the filename
       attr_accessor :filename
 
-      # @return [Integer] the file's target group id
-      attr_reader :group
+      # @return [Integer] the file's intended uid
+      attr_accessor :uid
 
-      # @return [Integer] the file's target mode
-      attr_reader :mode
+      # @return [Integer] the file's intended gid
+      attr_accessor :gid
 
-      # @return [Integer] the file's target owner uid
-      attr_reader :owner
+      # @return [Integer] the file's intended mode
+      attr_reader :mode
 
       VALID_FILETYPES = [:file, :directory]
       private_constant :VALID_FILETYPES
@@ -50,17 +51,7 @@ module Wright
         @filetype = filetype
       end
 
-      # Sets the file's owner
-      def owner=(owner)
-        @owner = Util::User.user_to_uid(owner)
-      end
-
-      # Sets the file's group
-      def group=(group)
-        @group = Util::User.group_to_gid(group)
-      end
-
-      # Sets the file's mode
+      # @return [Integer] the file's target mode
       def mode=(mode)
         if mode.nil?
           @mode = nil
@@ -75,23 +66,23 @@ module Wright
         @mode = mode_i
       end
 
-      # Checks if the file's owner, group and mode are up-to-date
+      # Checks if the file's uid, gid and mode are up-to-date
       # @return [Bool] +true+ if the file is up to date, +false+
       #   otherwise
       def uptodate?
         if ::File.exist?(@filename)
-          owner_uptodate? && group_uptodate? && mode_uptodate?
+          uid_uptodate? && gid_uptodate? && mode_uptodate?
         else
           false
         end
       end
 
-      # Updates the file's owner, group and mode.
+      # Updates the file's uid, gid and mode.
       #
       # @return [void]
       def update
         ::File.chmod(@mode, @filename) if @mode
-        ::File.chown(@owner, @group, @filename) if @owner || @group
+        ::File.chown(@uid, @gid, @filename) if @uid || @gid
       end
 
       # @return [Integer] the file's current mode
@@ -100,23 +91,23 @@ module Wright
       end
 
       # @return [Integer] the file's current owner's uid
-      def current_owner
+      def current_uid
         Wright::Util::File.file_owner(@filename)
       end
 
       # @return [Integer] the file's current group's gid
-      def current_group
+      def current_gid
         Wright::Util::File.file_group(@filename)
       end
 
       private
 
-      def owner_uptodate?
-        @owner.nil? || current_owner == @owner
+      def uid_uptodate?
+        @uid.nil? || current_uid == @uid
       end
 
-      def group_uptodate?
-        @group.nil? || current_group == @group
+      def gid_uptodate?
+        @gid.nil? || current_gid == @gid
       end
 
       def mode_uptodate?

data/lib/wright/util/stolen_from_activesupport.rb

@@ -85,7 +85,7 @@ module Wright
       # @return [String] the camelized string
       def self.camelize(s)
         s.to_s
-          .gsub(/\/(.?)/) { "::#{Regexp.last_match[1].upcase}" }
+          .gsub(%r{/(.?)}) { "::#{Regexp.last_match[1].upcase}" }
           .gsub(/(?:^|_)(.)/) { Regexp.last_match[1].upcase }
       end
 

data/lib/wright/util/user.rb

@@ -18,8 +18,7 @@ module Wright
       # @return [Integer] the integer uid of the given user or nil if
       #   user was nil
       def self.user_to_uid(user)
-        return nil if user.nil?
-        user.is_a?(String) ? Etc.getpwnam(user).uid : user.to_i
+        to_id(user, :user)
       end
 
       # Returns a group's gid.
@@ -36,37 +35,63 @@ module Wright
       # @return [Integer] the integer gid of the given group or nil if
       #   group was nil
       def self.group_to_gid(group)
-        return nil if group.nil?
-        group.is_a?(String) ? Etc.getgrnam(group).gid : group.to_i
+        to_id(group, :group)
       end
 
-      # Splits a colon-separated owner string into owner and group.
+      def self.to_id(object, type)
+        fail ArgumentError unless [:group, :user].include?(type)
+        return nil if object.nil?
+        return object.to_i unless object.is_a?(String)
+        type == :user ? Etc.getpwnam(object).uid : Etc.getgrnam(object).gid
+      end
+      private_class_method :to_id
+
+      # Returns the the next free uid in a range.
       #
-      # @param owner [String] the owner string
+      # @param uid_range [Range] the uid range
       #
       # @example
-      #   Wright::Util::User.owner_to_owner_group('foo:bar')
-      #   # => ["foo", "bar"]
+      #   Wright::Util::User.next_free_uid(1...500)
+      #   # => 2
       #
-      #   Wright::Util::User.owner_to_owner_group('foo')
-      #   # => ["foo", nil]
+      # @return [Integer] the next free uid
+      # @raise [RuntimeError] if there are no free uids in the range
+      def self.next_free_uid(uid_range)
+        next_free_id(uid_range, :uid)
+      end
+
+      # Returns the the next free gid in a range.
       #
-      #   Wright::Util::User.owner_to_owner_group(23)
-      #   # => [23, nil]
+      # @param gid_range [Range] the gid range
       #
-      # @return [Array<(String, String)>] the owner and group. Returns
-      #   nil if no group was specified. Non-string owners are
-      #   returned unmodified.
-      # @raise [ArgumentError] if the owner string contains more than
-      #   one colon
-      def self.owner_to_owner_group(owner)
-        group = nil
-        return [owner, group] unless owner.is_a?(String)
+      # @example
+      #   Wright::Util::User.next_free_gid(1...500)
+      #   # => 11
+      #
+      # @return [Integer] the next free gid
+      # @raise [RuntimeError] if there are no free gids in the range
+      def self.next_free_gid(gid_range)
+        next_free_id(gid_range, :gid)
+      end
+
+      def self.next_free_id(id_range, id_type)
+        iterator = id_iterator(id_type)
+        used_ids = []
+        iterator.call do |o|
+          id = o.method(id_type).call
+          used_ids << id if id_range.include?(id)
+        end
+        free_ids = id_range.to_a - used_ids
+        fail "No free #{id_type} in range #{id_range}" if free_ids.empty?
+        free_ids.min
+      end
+      private_class_method(:next_free_id)
 
-        fail ArgumentError, "Invalid owner: '#{owner}'" if owner.count(':') > 1
-        owner, group = owner.split(':')
-        [owner, group]
+      def self.id_iterator(id_type)
+        fail ArgumentError unless [:uid, :gid].include?(id_type)
+        id_type == :uid ? Etc.method(:passwd) : Etc.method(:group)
       end
+      private_class_method :id_iterator
     end
   end
 end

data/lib/wright/util.rb

@@ -1,5 +1,4 @@
 require 'wright/util/stolen_from_activesupport'
-require 'open3'
 
 module Wright
   # @api private
@@ -43,9 +42,10 @@ module Wright
       return default unless ::File.exist?(release_file)
 
       os_release = ::File.read(release_file)
-      /^ID_LIKE=(?<id_like>.*)$/ =~ os_release
-      /^ID=(?<id>.*)$/ =~ os_release
-      id_like || id || default
+      /^ID_LIKE="?(?<id_like>[^"]*)"?$/ =~ os_release
+      /^ID="?(?<id>[^"]*)"?$/ =~ os_release
+      return id_like.split(' ').first if id_like
+      id || default
     end
     private_class_method :distro
 
@@ -72,7 +72,12 @@ module Wright
       end
     end
 
-    # :nocov:
+    # Runs a code block in a clean bundler environment.
+    #
+    # @example
+    #   Wright::Util.bundler_clean_env { `brew search /^git$/` }
+    #   # => "git\n"
+    # @return [Object] the return value of the code block
     def self.bundler_clean_env
       if defined?(Bundler)
         Bundler.with_clean_env { yield }
@@ -80,6 +85,5 @@ module Wright
         yield
       end
     end
-    # :nocov:
   end
 end

data/lib/wright/version.rb

@@ -1,4 +1,4 @@
 module Wright # rubocop:disable Documentation
   # Current wright version
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/wright.rb

@@ -2,6 +2,7 @@ require 'wright/config'
 require 'wright/dsl'
 require 'wright/provider'
 require 'wright/resource'
+require 'wright/version'
 
 require 'wright/resource/directory'
 require 'wright/resource/file'