wright 0.3.2 → 0.4.0

data/lib/wright/provider/user.rb

@@ -7,13 +7,18 @@ module Wright
     # User provider. Used as a base class for {Resource::User}
     # providers.
     class User < Wright::Provider
-      # Adds the user.
+      # Creates or updates the user.
       #
       # @return [void]
       def create
-        user = @resource.name
-        unless_uptodate(:create, "user already created: '#{user}'") do
-          create_user
+        unless_uptodate(:create, "user already created: '#{user_name}'") do
+          unless_dry_run("create user: '#{user_name}'") do
+            if user_exists?
+              update_user
+            else
+              create_user
+            end
+          end
         end
       end
 
@@ -21,14 +26,47 @@ module Wright
       #
       # @return [void]
       def remove
-        user = @resource.name
-        unless_uptodate(:remove, "user already removed: '#{user}'") do
-          remove_user
+        unless_uptodate(:remove, "user already removed: '#{user_name}'") do
+          unless_dry_run("remove user: '#{user_name}'") do
+            remove_user
+          end
         end
       end
 
       private
 
+      def user_name
+        @resource.name
+      end
+
+      def uid
+        @resource.uid
+      end
+
+      def primary_group
+        @resource.primary_group
+      end
+
+      def full_name
+        @resource.full_name
+      end
+
+      def groups
+        @resource.groups
+      end
+
+      def shell
+        @resource.shell
+      end
+
+      def home
+        @resource.home
+      end
+
+      def system_user?
+        @resource.system
+      end
+
       # @api public
       # Checks if the user is up-to-date for a given action.
       #
@@ -58,64 +96,43 @@ module Wright
           primary_group_uptodate?
       end
 
-      def create_user
-        unless_dry_run("create user: '#{@resource.name}'") do
-          if user_exists?
-            update_user
-          else
-            add_user
-          end
-        end
-      end
-
-      def remove_user
-        unless_dry_run("remove user: '#{@resource.name}'") do
-          delete_user
-        end
-      end
-
       def user_data
-        Etc.getpwnam(@resource.name)
-      rescue ArgumentError
-        nil
+        Wright::Util::User.safe_getpwnam(user_name)
       end
 
       def uid_uptodate?
-        @resource.uid.nil? || user_data.uid == @resource.uid
+        uid.nil? || user_data.uid == uid
       end
 
       def full_name_uptodate?
-        @resource.full_name.nil? ||
-          user_data.gecos.split(',').first == @resource.full_name
+        full_name.nil? || user_data.gecos.split(',').first == full_name
       end
 
       def groups_uptodate?
-        return true if @resource.groups.nil?
-        groups = []
-        Etc.group { |g| groups << g.name if g.mem.include?(@resource.name) }
-        groups.uniq.sort == @resource.groups.uniq.sort
+        return true if groups.nil?
+        target_groups = []
+        Etc.group { |g| target_groups << g.name if g.mem.include?(user_name) }
+        target_groups.sort.uniq == groups.sort.uniq
       end
 
       def shell_uptodate?
-        @resource.shell.nil? || user_data.shell == @resource.shell
+        shell.nil? || user_data.shell == shell
       end
 
       def home_uptodate?
-        @resource.home.nil? || user_data.dir == @resource.home
+        home.nil? || user_data.dir == home
       end
 
       def primary_group_uptodate?
-        return true if @resource.primary_group.nil?
-
-        gid = Wright::Util::User.group_to_gid(@resource.primary_group)
-        user_data.gid == gid
+        return true if primary_group.nil?
+        user_data.gid == Wright::Util::User.group_to_gid(primary_group)
       end
 
       def user_exists?
         !user_data.nil?
       end
 
-      def add_user
+      def create_user
         fail NotImplementedError
       end
 
@@ -123,7 +140,7 @@ module Wright
         fail NotImplementedError
       end
 
-      def delete_user
+      def remove_user
         fail NotImplementedError
       end
     end

data/lib/wright/resource/group.rb

@@ -57,6 +57,7 @@ Wright::DSL.register_resource(Wright::Resource::Group)
 
 group_providers = {
   'debian' => 'Wright::Provider::Group::GnuPasswd',
+  'rhel'   => 'Wright::Provider::Group::GnuPasswd',
   'macosx' => 'Wright::Provider::Group::DarwinDirectoryService'
 }
 Wright::Config[:resources][:group] ||= {}

data/lib/wright/resource/package.rb

@@ -1,3 +1,5 @@
+require 'forwardable'
+
 require 'wright/resource'
 require 'wright/dsl'
 
@@ -20,22 +22,32 @@ module Wright
     #   htop.installed_versions
     #   # => []
     class Package < Wright::Resource
+      extend Forwardable
+
       # @return [String] the package version to install or remove
       attr_accessor :version
 
+      # @return [String, Array<String>] the options passed to the
+      #   package manager
+      attr_accessor :options
+
       # Initializes a Package.
       #
       # @param name [String] the package's name
       def initialize(name)
         super
         @version = nil
+        @options = nil
         @action = :install
       end
 
+      # @!method installed_versions
       # @return [Array<String>] the installed package versions
-      def installed_versions
-        @provider.installed_versions
-      end
+      def_delegator :@provider, :installed_versions
+
+      # @!method installed?
+      # @return [Bool] +true+ if the package is installed
+      def_delegator :@provider, :installed?
 
       # Installs the Package.
       #
@@ -66,6 +78,7 @@ Wright::DSL.register_resource(Wright::Resource::Package)
 
 package_providers = {
   'debian' => 'Wright::Provider::Package::Apt',
+  'rhel'   => 'Wright::Provider::Package::Yum',
   'macosx' => 'Wright::Provider::Package::Homebrew'
 }
 Wright::Config[:resources][:package] ||= {}

data/lib/wright/resource/user.rb

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

data/lib/wright/resource.rb

@@ -123,10 +123,12 @@ module Wright
     def run_update_action
       return if @on_update.nil?
 
+      resource = "#{@resource_name} '#{@name}'"
+      notification = "run update action for #{resource}"
       if Wright.dry_run?
-        resource = "#{@resource_name} '#{@name}'"
-        Wright.log.info "(would) run update action for #{resource}"
+        Wright.log.info "(would) #{notification}"
       else
+        Wright.log.info notification
         @on_update.call
       end
     end

data/lib/wright/util/user.rb

@@ -46,7 +46,7 @@ module Wright
       end
       private_class_method :to_id
 
-      # Returns the the next free uid in a range.
+      # Returns the next free uid in a range.
       #
       # @param uid_range [Range] the uid range
       #
@@ -60,7 +60,7 @@ module Wright
         next_free_id(uid_range, :uid)
       end
 
-      # Returns the the next free gid in a range.
+      # Returns the next free gid in a range.
       #
       # @param gid_range [Range] the gid range
       #
@@ -92,6 +92,38 @@ module Wright
         id_type == :uid ? Etc.method(:passwd) : Etc.method(:group)
       end
       private_class_method :id_iterator
+
+      # Returns a user entry.
+      #
+      # @param username [String] the name of the user
+      #
+      # @example
+      #   Wright::Util::User.safe_getpwnam('this_user_does_not_exist')
+      #   # => nil
+      #
+      # @return [Struct::Passwd, nil] the user entry or nil if the
+      #   user does not exist
+      def self.safe_getpwnam(username)
+        Etc.getpwnam(username)
+      rescue ArgumentError
+        nil
+      end
+
+      # Returns a group entry.
+      #
+      # @param groupname [String] the name of the group
+      #
+      # @example
+      #   Wright::Util::User.safe_getgrnam('this_group_does_not_exist')
+      #   # => nil
+      #
+      # @return [Struct::Group, nil] the group entry or nil if the
+      #   group does not exist
+      def self.safe_getgrnam(groupname)
+        Etc.getgrnam(groupname)
+      rescue ArgumentError
+        nil
+      end
     end
   end
 end

data/lib/wright/version.rb

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

data/man/wright.1

@@ -2,12 +2,12 @@
 .\"     Title: wright
 .\"    Author: [see the "AUTHOR" section]
 .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
-.\"      Date: 04/22/2015
+.\"      Date: 06/03/2015
 .\"    Manual: \ \&
 .\"    Source: \ \&
 .\"  Language: English
 .\"
-.TH "WRIGHT" "1" "04/22/2015" "\ \&" "\ \&"
+.TH "WRIGHT" "1" "06/03/2015" "\ \&" "\ \&"
 .\" -----------------------------------------------------------------
 .\" * Define some portability stuff
 .\" -----------------------------------------------------------------
@@ -48,6 +48,18 @@ Run
 as a wright script\&. When multiple commands are passed, they are joined and run in sequence\&.
 .RE
 .PP
+\fB\-r\fR \fILIBRARY\fR
+.RS 4
+Require
+\fILIBRARY\fR
+before running the wright script\&. When multiple libraries are passed, they are loaded in sequence\&.
+.RE
+.PP
+\fB\-n, \-\-dry\-run\fR
+.RS 4
+Enable dry\-run mode\&. In dry\-run mode, wright resources do not modify the system, but you still have to make sure your own code does not cause any unwanted changes\&.
+.RE
+.PP
 \fB\-v, \-\-verbose\fR
 .RS 4
 Print debugging information\&.
@@ -143,15 +155,7 @@ To install tmux and update its config file from a wright script, create the foll
 .\}
 .nf
 package \*(Aqtmux\*(Aq
-.fi
-.if n \{\
-.RE
-.\}
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
+
 file \*(Aq/etc/tmux\&.conf\*(Aq do |f|
   f\&.content = <<EOF
 unbind C\-b

data/spec/cli_spec.rb

@@ -21,6 +21,18 @@ describe Wright::CLI do
       @cli.send(:commands).must_equal %w(foo bar)
     end
 
+    it 'parses -r LIBRARY' do
+      argv = %w(-r library1 -r library2 -rlibrary3 file.rb)
+      @cli.parse(argv).must_equal %w(file.rb)
+      @cli.send(:requires).must_equal %w(library1 library2 library3)
+    end
+
+    it 'parses --dry-run' do
+      argv = %w(--dry-run file.rb)
+      @cli.parse(argv).must_equal %w(file.rb)
+      @cli.send(:dry_run).must_equal true
+    end
+
     it 'parses --verbose' do
       argv = ['--verbose']
       @cli.parse(argv)
@@ -38,8 +50,14 @@ describe Wright::CLI do
     it 'parses --version' do
       argv = ['--version']
       expected = "wright version #{Wright::VERSION}\n"
+      -> { @cli.run(argv) }.must_output expected
+    end
 
+    it 'enables dry-run mode when requested to do so' do
+      argv = ['--dry-run', '-e', 'print Wright.dry_run?']
+      expected = 'true'
       -> { @cli.run(argv) }.must_output expected
+      Wright.instance_variable_set(:@dry_run, false)
     end
 
     it 'loads files' do