wright 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0005b749e54ff7904188cbd497f1757c460c0b4d
-  data.tar.gz: b1fc596dc236a11f9a18c9de89823c91f0d20fee
+  metadata.gz: 6d159205080df87b4a9c8935b0486335c74ef84e
+  data.tar.gz: 35cdf663151ab32900d9be2566574cfc0648f980
 SHA512:
-  metadata.gz: d9eaae5610049c8407782fd8089f789a9dbbe7208d08a46f5de4e8618b258824830c653f18c59bb0175d83b5d5661d90c276996fed278ebaa223ffce7748a706
-  data.tar.gz: 0975e81800682d9e93ec0d365f20ef9a4effdab230c217b2b6661eb2ffc8e1ed7d2e1ec39933f30f46795c5a42ce01343eab154bb104e3009558ceb52552abc5
+  metadata.gz: 0dd9b03ffecb5ca5bd6bbe272f672fcd8546fdeebc7df4ac307f94148ca10312734ab99afd78720ba1d56e458e6c277424b6479decadbd0181b528fa05451316
+  data.tar.gz: 61b6d41688576e1736bf63d9e75eb4fd25c3a5de1d480f7a546df90f8802b4e91387556b38cbcb1393a2a7094b5f72117a65ddf336a8022bb416008880009475

data/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+Contributing
+============
+
+Contributions to wright are greatly appreciated. Here's how you can
+help.
+
+Reporting issues
+----------------
+
+If you encounter any problems with wright, please take the time to
+report them via the [issue tracker][github-issues].
+
+[github-issues]: https://github.com/sometimesfood/wright/issues
+
+- Make sure your problem has not already been reported.
+- Explain how to reproduce your problem.
+- Include your version of wright as well as your Ruby version and
+  operating system.
+
+Submitting pull requests
+------------------------
+
+- Fork the project.
+- Open a new feature branch (`git checkout -b hackety-hack`).
+- Write [proper commit messages][commit-messages].
+- If you add new features, please add tests and make sure all tests
+  are passing (`bundle exec rake test`).
+- Please make sure that your code does not introduce any Rubocop
+  warnings (`bundle exec rubocop`).
+- Squash or rebase your commits if necessary.
+- Open a [pull request][pull-requests].
+
+[commit-messages]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[pull-requests]: https://help.github.com/articles/using-pull-requests/

data/NEWS.md

@@ -0,0 +1,22 @@
+# wright NEWS
+## 0.2.0 (2015-03-13)
+- Add Homebrew package provider for OS X
+- Add group resource
+  - Add group provider for GNU systems
+  - Add group provider for OS X
+- Add user resource (provider)
+  - Add user provider for GNU systems
+- Fix name error in symlink provider
+- Add `Provider#exec_or_fail`
+- Pass arguments to `Open3::capture3` properly
+
+## 0.1.2 (2015-01-31)
+- Convert docs to YARD
+- Fix color code for warnings
+
+## 0.1.1 (2015-01-20)
+- Remove hardcoded package provider config
+- Specify Ruby version in gemspec
+
+## 0.1.0 (2015-01-16)
+- First public release

data/README.md

@@ -1,9 +1,10 @@
 wright
 ======
 
-[![Gem Version](http://img.shields.io/gem/v/wright.svg?style=flat-square)][gem]
-[![Build Status](http://img.shields.io/travis/sometimesfood/wright.svg?style=flat-square)][travis]
-[![Code Climate](http://img.shields.io/codeclimate/github/sometimesfood/wright.svg?style=flat-square)][codeclimate]
+[![Gem Version](https://img.shields.io/gem/v/wright.svg?style=flat-square)][gem]
+[![Build Status](https://img.shields.io/travis/sometimesfood/wright.svg?style=flat-square)][travis]
+[![Code Climate](https://img.shields.io/codeclimate/github/sometimesfood/wright.svg?style=flat-square)][codeclimate]
+[![Test Coverage](https://img.shields.io/codeclimate/coverage/github/sometimesfood/wright.svg?style=flat-square)][codeclimate]
 
 [gem]: https://rubygems.org/gems/wright
 [travis]: https://travis-ci.org/sometimesfood/wright
@@ -16,14 +17,57 @@ Requirements
 
  - Ruby ≥1.9
 
+Getting Started
+---------------
+
+To start a wright IRB session, simply run:
+
+    $ bundle console
+
+In order to create some resources using the wright DSL:
+
+```ruby
+require 'wright'
+extend Wright::DSL
+
+foo_dir = directory '/tmp/foo'
+fstab = symlink '/tmp/foo/fstab' do |s|
+  s.to = '/etc/fstab'
+end
+
+puts File.directory? '/tmp/foo'
+puts File.symlink? '/tmp/foo/fstab'
+
+fstab.remove
+foo_dir.remove
+```
+
+If you don't want to use the DSL:
+
+```ruby
+require 'wright'
+
+foo_dir = Wright::Resource::Directory.new('/tmp/foo')
+foo_dir.create
+fstab = Wright::Resource::Symlink.new('/tmp/foo/fstab')
+fstab.to = '/etc/fstab'
+fstab.create
+
+puts File.directory? '/tmp/foo'
+puts File.symlink? '/tmp/foo/fstab'
+
+fstab.remove
+foo_dir.remove
+```
+
 Documentation
 -------------
 
 There is not too much useful documentation that is targeted towards
 users at the moment.
 
-Run `bundle exec rake rdoc` to generate HTML docs for wright
-developers.
+Run `bundle exec yard` to generate
+[HTML docs for wright developers](http://rubydoc.info/gems/wright/).
 
 Hacking
 -------
@@ -36,43 +80,15 @@ dependencies via bundler:
 
 All tests should pass.
 
-Getting Started
----------------
-
-To start a wright IRB session, simply run:
-
-    $ bundle console
-
-In order to create some resources using the wright DSL:
-
-    extend Wright::DSL
-    
-    foo_dir = directory '/tmp/foo'
-    fstab = symlink '/tmp/foo/fstab' do |s|
-      s.to = '/etc/fstab'
-    end
-    
-    puts File.directory? '/tmp/foo'
-    puts File.symlink? '/tmp/foo/fstab'
-    
-    fstab.remove
-    foo_dir.remove
-
-If you don't want to use the DSL:
+Contributing
+------------
 
-    foo_dir = Wright::Resource::Directory.new('/tmp/foo')
-    foo_dir.create
-    fstab = Wright::Resource::Symlink.new('/tmp/foo/fstab')
-    fstab.to = '/etc/fstab'
-    fstab.create
-   
-    puts File.directory? '/tmp/foo'
-    puts File.symlink? '/tmp/foo/fstab'
-    
-    fstab.remove
-    foo_dir.remove
+Contributions to wright are greatly appreciated. If you would like to
+contribute to wright, please have a look at the
+[contribution guidelines](CONTRIBUTING.md).
 
 Copyright
 ---------
 
-Copyright (c) 2012-2015 Sebastian Boehm. See LICENSE for details.
+Copyright (c) 2012-2015 Sebastian Boehm. See [LICENSE](LICENSE) for
+details.

data/lib/wright/dsl.rb

@@ -52,8 +52,7 @@ module Wright
     # Implicitly invoking a block from within another block does not
     # work: http://blog.sidu.in/2007/11/ruby-blocks-gotchas.html
     #
-    # @yield [resource] the resource
-    #
+    # @yield [Resource] the resource
     # @return [void]
     def self.yield_resource(resource_class, name)
       r = resource_class.new(name)

data/lib/wright/provider/directory.rb

@@ -47,21 +47,14 @@ module Wright
 
       def create_directory
         dir_permissions = permissions
-
-        if Wright.dry_run?
-          Wright.log.info "(would) create directory: '#{@resource.name}'"
-        else
-          Wright.log.info "create directory: '#{@resource.name}'"
+        unless_dry_run("create directory: '#{@resource.name}'") do
           FileUtils.mkdir_p(dirname)
           dir_permissions.update
         end
       end
 
       def remove_directory
-        if Wright.dry_run?
-          Wright.log.info "(would) remove directory: '#{@resource.name}'"
-        else
-          Wright.log.info "remove directory: '#{@resource.name}'"
+        unless_dry_run("remove directory: '#{@resource.name}'") do
           FileUtils.rmdir(dirname)
         end
       end

data/lib/wright/provider/file.rb

@@ -1,10 +1,10 @@
-require 'wright/provider'
-require 'wright/util/file_permissions'
-require 'wright/util/user'
 require 'fileutils'
 require 'digest'
 require 'tempfile'
 require 'tmpdir'
+require 'wright/provider'
+require 'wright/util/file_permissions'
+require 'wright/util/user'
 
 module Wright
   class Provider
@@ -43,11 +43,7 @@ module Wright
 
       def create_file
         file_permissions = permissions
-
-        if Wright.dry_run?
-          Wright.log.info "(would) create file: '#{@resource.name}'"
-        else
-          Wright.log.info "create file: '#{@resource.name}'"
+        unless_dry_run("create file: '#{@resource.name}'") do
           write_content_to_file
           file_permissions.update
         end
@@ -68,10 +64,7 @@ module Wright
       end
 
       def remove_file
-        if Wright.dry_run?
-          Wright.log.info "(would) remove file: '#{@resource.name}'"
-        else
-          Wright.log.info "remove file: '#{@resource.name}'"
+        unless_dry_run("remove file: '#{@resource.name}'") do
           FileUtils.rm(filename)
         end
       end
@@ -87,7 +80,7 @@ module Wright
       def content_uptodate?
         return false unless ::File.exist?(filename)
         content = @resource.content || ''
-        target_checksum = checksum(content)
+        target_checksum = checksum(content.to_s)
         current_checksum = checksum(::File.read(filename))
         current_checksum == target_checksum
       end

data/lib/wright/provider/group/darwin_directory_service.rb

@@ -0,0 +1,61 @@
+require 'wright/dry_run'
+require 'wright/provider'
+require 'wright/provider/group'
+
+module Wright
+  class Provider
+    class Group
+      # Darwin DirectoryService group provider. Used as a provider for
+      # {Resource::Group} on OS X systems.
+      class DarwinDirectoryService < Wright::Provider::Group
+        private
+
+        def add_group(group_name, gid, system)
+          gid ||= next_system_gid if system
+          options = gid.nil? ? [] : ['-i', gid.to_s]
+          cmd = 'dseditgroup'
+          args = ['-o', 'create', *options, group_name]
+          exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
+        end
+
+        def delete_group(group_name)
+          cmd = 'dseditgroup'
+          args = ['-o', 'delete', group_name]
+          exec_or_fail(cmd, args, "cannot remove group '#{group_name}'")
+        end
+
+        def set_members(group_name, members)
+          options = ['GroupMembership', *members]
+          cmd = 'dscl'
+          args = ['.', 'create', "/Groups/#{group_name}", *options]
+          exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
+        end
+
+        def set_gid(group_name, gid)
+          cmd = 'dseditgroup'
+          args = ['-o', 'edit',
+                  '-i', gid.to_s,
+                  group_name]
+          exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
+        end
+
+        # Overrides Provider::Group#group_data to work around caching
+        # issues with getgrnam(3) on OS X.
+        def group_data
+          Etc.group { |g| break g if g.name == @resource.name }
+        end
+
+        def next_system_gid
+          system_gid_range = (1...500)
+          used_system_gids = []
+          Etc.group do |g|
+            used_system_gids << g.gid if system_gid_range.include?(g.gid)
+          end
+          free_system_gids = system_gid_range.to_a - used_system_gids
+          fail 'No free gids in system gid range' if free_system_gids.empty?
+          free_system_gids.max
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/group/gnu_passwd.rb

@@ -0,0 +1,42 @@
+require 'wright/dry_run'
+require 'wright/provider'
+require 'wright/provider/group'
+
+module Wright
+  class Provider
+    class Group
+      # GNU passwd group provider. Used as a provider for
+      # {Resource::Group} on GNU systems.
+      class GnuPasswd < Wright::Provider::Group
+        private
+
+        def add_group(group_name, gid, system)
+          options = []
+          options << '--system' if system
+          options += ['-g', gid.to_s] if gid
+          cmd = 'groupadd'
+          args = [*options, group_name]
+          exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
+        end
+
+        def delete_group(group_name)
+          cmd = 'groupdel'
+          args = [group_name]
+          exec_or_fail(cmd, args, "cannot remove group '#{group_name}'")
+        end
+
+        def set_members(group_name, members)
+          cmd = 'gpasswd'
+          args = ['-M', "'#{members.join(',')}'", group_name]
+          exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
+        end
+
+        def set_gid(group_name, gid)
+          cmd = 'groupmod'
+          args = ['-g', gid.to_s, group_name]
+          exec_or_fail(cmd, args, "cannot create group '#{group_name}'")
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/group.rb

@@ -0,0 +1,111 @@
+require 'etc'
+require 'wright/provider'
+
+module Wright
+  class Provider
+    # Group provider. Used as a base class for {Resource::Group}
+    # providers.
+    class Group < Wright::Provider
+      # Adds the group.
+      #
+      # @return [void]
+      def create
+        if uptodate?(:create)
+          Wright.log.debug "group already created: '#{@resource.name}'"
+          return
+        end
+
+        create_group
+        @updated = true
+      end
+
+      # Removes the group.
+      #
+      # @return [void]
+      def remove
+        if uptodate?(:remove)
+          Wright.log.debug "group already removed: '#{@resource.name}'"
+          return
+        end
+
+        remove_group
+        @updated = true
+      end
+
+      private
+
+      # @api public
+      # Checks if the group is up-to-date for a given action.
+      #
+      # @param action [Symbol] the action. Currently supports
+      #   +:create+ and +:remove+.
+      #
+      # @return [Bool] +true+ if the group is up-to-date and +false+
+      #   otherwise
+      # @raise [ArgumentError] if the action is invalid
+      def uptodate?(action)
+        case action
+        when :create
+          group_exists? && gid_uptodate? && members_uptodate?
+        when :remove
+          !group_exists?
+        else
+          fail ArgumentError, "invalid action '#{action}'"
+        end
+      end
+
+      def create_group
+        group = @resource.name
+        unless_dry_run("create group: '#{group}'") do
+          if group_exists?
+            set_gid(group, @resource.gid) unless gid_uptodate?
+          else
+            add_group(group, @resource.gid, @resource.system)
+          end
+          set_members(group, @resource.members) unless members_uptodate?
+        end
+      end
+
+      def remove_group
+        group = @resource.name
+        unless_dry_run("remove group: '#{group}'") do
+          delete_group(group)
+        end
+      end
+
+      def group_data
+        Etc.getgrnam(@resource.name)
+      rescue ArgumentError
+        nil
+      end
+
+      def gid_uptodate?
+        @resource.gid.nil? || group_data.gid == @resource.gid
+      end
+
+      def members_uptodate?
+        @resource.members.nil? || group_data.mem == @resource.members
+      end
+
+      def group_exists?
+        !group_data.nil?
+      end
+
+      def set_members
+        group = @resource.name
+        new_members = @resource.members - group_data.mem
+        unwanted_members = group_data.mem - @resource.members
+        new_members.each { |m| add_member(m, group) }
+        unwanted_members.each { |m| remove_member(m, group) }
+      end
+
+      def add_member(_member, _group)
+        fail NotImplementedError
+      end
+
+      def remove_member(_member, _group)
+        fail NotImplementedError
+      end
+    end
+  end
+end

data/lib/wright/provider/package/apt.rb

@@ -7,13 +7,14 @@ require 'wright/provider/package'
 module Wright
   class Provider
     class Package
-      # Apt package provider. Used as a Provider for
+      # Apt package provider. Used as a provider for
       # {Resource::Package} on Debian-based systems.
       class Apt < Wright::Provider::Package
         # @return [Array<String>] the installed package versions
         def installed_versions
-          cmd = "dpkg-query -s #{@resource.name}"
-          cmd_stdout, _cmd_stderr, cmd_status = Open3.capture3(env, cmd)
+          cmd = 'dpkg-query'
+          args = ['-s', @resource.name]
+          cmd_stdout, _, cmd_status = Open3.capture3(env, cmd, *args)
           installed_re = /^Status: install ok installed$/
 
           if cmd_status.success? && installed_re =~ cmd_stdout
@@ -24,62 +25,27 @@ module Wright
           end
         end
 
-        # Installs the package.
-        #
-        # @return [void]
-        def install
-          if uptodate?(:install)
-            Wright.log.debug "package already installed: '#{@resource.name}'"
-            return
-          end
-
-          install_package
-          @updated = true
-        end
-
-        # Removes the package.
-        #
-        # @return [void]
-        def remove
-          if uptodate?(:remove)
-            Wright.log.debug "package already removed: '#{@resource.name}'"
-            return
-          end
-
-          remove_package
-          @updated = true
-        end
-
         private
 
         def install_package
           package = @resource.name
-          if Wright.dry_run?
-            Wright.log.info "(would) install package: '#{package}'"
-          else
-            Wright.log.info "install package: '#{package}'"
+          unless_dry_run("install package: '#{package}'") do
             apt_get(:install, package, @resource.version)
           end
         end
 
         def remove_package
           package = @resource.name
-          if Wright.dry_run?
-            Wright.log.info "(would) remove package: '#{package}'"
-          else
-            Wright.log.info "remove package: '#{package}'"
+          unless_dry_run("remove package: '#{package}'") do
             apt_get(:remove, package)
           end
         end
 
         def apt_get(action, package, version = nil)
           package_version = version.nil? ? '' : "=#{version}"
-          apt_cmd = "apt-get #{action} -qy #{package}#{package_version}"
-          _cmd_stdout, cmd_stderr, cmd_status = Open3.capture3(env, apt_cmd)
-          return if cmd_status.success?
-
-          apt_error = cmd_stderr.chomp
-          fail %(cannot #{action} package '#{package}': "#{apt_error}")
+          cmd = 'apt-get'
+          args = [action.to_s, '-qy', package + package_version]
+          exec_or_fail(cmd, args, "cannot #{action} package '#{package}'")
         end
 
         def env

data/lib/wright/provider/package/homebrew.rb

@@ -0,0 +1,68 @@
+require 'open3'
+require 'json'
+
+require 'wright/dry_run'
+require 'wright/provider'
+require 'wright/provider/package'
+
+module Wright
+  class Provider
+    class Package
+      # Homebrew package provider. Used as a provider for
+      # {Resource::Package} on OS X systems.
+      class Homebrew < Wright::Provider::Package
+        # @return [Array<String>] the installed package versions
+        def installed_versions
+          cmd = 'brew'
+          args = ['info', '--json=v1', @resource.name]
+          cmd_stdout, _, cmd_status = Wright::Util.bundler_clean_env do
+            Open3.capture3(env, cmd, *args)
+          end
+
+          if cmd_status.success?
+            JSON[cmd_stdout].first['installed'].map { |v| v['version'] }
+          else
+            []
+          end
+        end
+
+        private
+
+        def install_package
+          package = @resource.name
+          unless_dry_run("install package: '#{package}'") do
+            brew(:install, package, @resource.version)
+          end
+        end
+
+        def remove_package
+          package = @resource.name
+          unless_dry_run("remove package: '#{package}'") do
+            brew(:uninstall, package)
+          end
+        end
+
+        def brew(action, package, version = nil)
+          ignore_version(version)
+
+          cmd = 'brew'
+          args = [action.to_s, package]
+
+          _, cmd_stderr, cmd_status = Wright::Util.bundler_clean_env do
+            Open3.capture3(env, cmd, *args)
+          end
+          return if cmd_status.success?
+
+          brew_error = cmd_stderr.chomp
+          fail %(cannot #{action} package '#{package}': "#{brew_error}")
+        end
+
+        def ignore_version(version)
+          return unless version
+          package_info = "#{@resource.name} (#{version})"
+          Wright.log.warn "ignoring package version: '#{package_info}'"
+        end
+      end
+    end
+  end
+end

data/lib/wright/provider/package.rb

@@ -5,6 +5,32 @@ module Wright
     # Package provider. Used as a base class for Resource::Package
     # providers.
     class Package < Wright::Provider
+      # Installs the package.
+      #
+      # @return [void]
+      def install
+        if uptodate?(:install)
+          Wright.log.debug "package already installed: '#{@resource.name}'"
+          return
+        end
+
+        install_package
+        @updated = true
+      end
+
+      # Removes the package.
+      #
+      # @return [void]
+      def remove
+        if uptodate?(:remove)
+          Wright.log.debug "package already removed: '#{@resource.name}'"
+          return
+        end
+
+        remove_package
+        @updated = true
+      end
+
       private
 
       # @api public