wright 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9ff506ba7676ffd4953acf95f89567d8f67a88c3
-  data.tar.gz: 15f2d5ee585dcaf17acdd7b1e189f7aca4c0e695
+  metadata.gz: a9d5eb3fb564f26c7d3c7e2dbc90aa4086e74fbb
+  data.tar.gz: f742866f8bfe1e1c8c40a61bf919b052ebe2744c
 SHA512:
-  metadata.gz: 17805205d6096faceb9db3b7432b10da5243a399d4874bc7705e30890b8f2810511871abdcf05b88f0d4c0111d264ff8034bb221b710d0c912ccdbddb4ae73f6
-  data.tar.gz: c7d5668cdc7ea3488614742ab697f72b04d597a8abac48a66ab16982509e6156f7ce17aba953828ba89d8d7144e7a1a37b39457fd791fb29d51625f54fbc5d72
+  metadata.gz: e84a4542c49ef1d19c1f04bfa645d7d5308dfbdce16cc7804f927e0a4ec24f2a451f9b09b8395b3085c68190234f21c2ca7ec5ee4a2c9db71e334b2a3f4b58b7
+  data.tar.gz: e3a4531204757348c7a5d139f8196443d8ac542e6225d4fd2032a7cb2a5760f75b6139b64ed82621fb9de8c69256386ca6381e1e7a0c4c106bae6714d48ed530

data/CONTRIBUTING.md

@@ -1,12 +1,10 @@
 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].
 
@@ -19,7 +17,6 @@ report them via the [issue tracker][github-issues].
 
 Submitting pull requests
 ------------------------
-
 - Fork the project.
 - Open a new feature branch (`git checkout -b hackety-hack`).
 - Write [proper commit messages][commit-messages].
@@ -32,3 +29,13 @@ Submitting 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/
+
+Running the tests
+-----------------
+To start hacking on wright, simply install the development
+dependencies via bundler and run the tests:
+
+ - `bundle install --path .bundle`
+ - `bundle exec rake test`
+
+All tests should pass.

data/NEWS.md

@@ -1,4 +1,12 @@
 # wright NEWS
+## 0.5.0 (2015-09-21)
+- Add attribute hash support to DSL and resources
+- Add template helpers
+  - Add util.render_erb to DSL
+  - Add util.render_mustache to DSL
+  - Add util.render_file to DSL
+- Add support for Fedora
+
 ## 0.4.4 (2015-08-06)
 - Fix update status for file provider if content attribute is nil and
   file already has content (#16)

data/README.md

@@ -17,21 +17,20 @@ Performing simple administrative tasks with wright is easy.
 
 package 'sudo'
 
-file '/etc/sudoers.d/env_keep-editor' do |f|
-  f.content = "Defaults env_keep += EDITOR\n"
-  f.owner   = 'root:root'
-  f.mode    = '440'
-end
+file '/etc/sudoers.d/env_keep-editor',
+     content: "Defaults env_keep += EDITOR\n",
+     owner:   'root:root',
+     mode:    '440'
 ```
 
 Scripts can also be run directly from the shell.
 
-    wright -e "package('tmux')"
+    wright -e "package 'tmux'"
 
 If you would rather see the effects of running a wright script first,
 use the dry-run option:
 
-    wright --dry-run -e "package('tmux')"
+    wright --dry-run -e "package 'tmux'"
 
 For a list of command-line parameters, see
 [the manpage][wright-manpage]. For a more in-depth list of tasks you
@@ -68,10 +67,11 @@ interest to you:
 - [wright manpage][wright-manpage]
 - [list of wright resources][wright-resources]
 - [wright is just Ruby][wright-is-ruby]
+- [list of supported platforms][wright-platforms]
 
 As a wright developer, you might also be interested in the
 [wright developer docs](http://www.rubydoc.info/gems/wright/) which
-can also be generated via `bundle exec yard`.
+can be generated via `bundle exec yard`.
 
 Contributing
 ------------
@@ -79,14 +79,6 @@ Contributions to wright are greatly appreciated. If you would like to
 contribute to wright, please have a look at the
 [contribution guidelines](CONTRIBUTING.md).
 
-To start hacking on wright, simply install the development
-dependencies via bundler:
-
- - `bundle install --path .bundle`
- - `bundle exec rake test`
-
-All tests should pass.
-
 Copyright
 ---------
 Copyright (c) 2012-2015 Sebastian Boehm. See [LICENSE](LICENSE) for
@@ -100,3 +92,4 @@ details.
 [wright-manpage]: http://wright.sometimesfood.org/man/wright.1.html
 [wright-resources]: http://wright.sometimesfood.org/doc/resources.html
 [wright-is-ruby]: http://wright.sometimesfood.org/doc/wright-is-ruby.html
+[wright-platforms]: http://wright.sometimesfood.org/doc/supported-platforms.html

data/lib/wright/cli.rb

@@ -16,38 +16,39 @@ module Wright
     # @param argv [Array<String>] the arguments passed to bin/wright
     def run(argv)
       arguments = parse(argv)
-      return if @quit
+      return if quit
 
-      Wright.activate_dry_run if @dry_run
-      Wright.log.level = @log_level if @log_level
-      @main.extend Wright::DSL
-      @requires.each { |r| require r }
+      Wright.activate_dry_run if dry_run
+      Wright.log.level = log_level if log_level
+      main.extend Wright::DSL
+      requires.each { |r| require r }
 
       run_script(arguments)
     end
 
     private
 
-    attr_reader :commands, :requires, :dry_run, :log_level
+    attr_accessor :parser, :quit, :log_level, :dry_run
+    attr_reader :commands, :requires, :main
 
     def parse(argv)
       # use OptionParser#order! instead of #parse! so CLI#run does not
       # consume --arguments passed to wright scripts
-      @parser.order!(argv)
+      parser.order!(argv)
     end
 
     def run_script(arguments)
-      if @commands.empty? && arguments.any?
+      if commands.empty? && arguments.any?
         script = File.expand_path(arguments.shift)
         load script
       else
-        commands = @commands.empty? ? $stdin.read : @commands.join("\n")
-        @main.instance_eval(commands, '<main>', 1)
+        cmds = commands.empty? ? $stdin.read : commands.join("\n")
+        main.instance_eval(cmds, '<main>', 1)
       end
     end
 
     def set_up_parser
-      @parser = OptionParser.new
+      self.parser = OptionParser.new
       set_up_command_option
       set_up_require_option
       set_up_dry_run_option
@@ -56,38 +57,38 @@ module Wright
     end
 
     def set_up_command_option
-      @parser.on('-e COMMAND', 'Run COMMAND') do |e|
-        @commands << e
+      parser.on('-e COMMAND', 'Run COMMAND') do |e|
+        commands << e
       end
     end
 
     def set_up_require_option
-      @parser.on('-r LIBRARY',
-                 'Require LIBRARY before running the script') do |r|
-        @requires << r
+      parser.on('-r LIBRARY',
+                'Require LIBRARY before running the script') do |r|
+        requires << r
       end
     end
 
     def set_up_dry_run_option
-      @parser.on('-n', '--dry-run', 'Enable dry-run mode') do
-        @dry_run = true
+      parser.on('-n', '--dry-run', 'Enable dry-run mode') do
+        self.dry_run = true
       end
     end
 
     def set_up_verbosity_options
-      @parser.on('-v', '--verbose', 'Increase verbosity') do
-        @log_level = Wright::Logger::DEBUG
+      parser.on('-v', '--verbose', 'Increase verbosity') do
+        self.log_level = Wright::Logger::DEBUG
       end
 
-      @parser.on('-q', '--quiet', 'Decrease verbosity') do
-        @log_level = Wright::Logger::ERROR
+      parser.on('-q', '--quiet', 'Decrease verbosity') do
+        self.log_level = Wright::Logger::ERROR
       end
     end
 
     def set_up_version_option
-      @parser.on_tail('--version', 'Show wright version') do
+      parser.on_tail('--version', 'Show wright version') do
         puts "wright version #{Wright::VERSION}"
-        @quit = true
+        self.quit = true
       end
     end
   end

data/lib/wright/config.rb

@@ -14,7 +14,9 @@ module Wright
     @config_hash = {}
     class << self
       extend Forwardable
-      def_delegators :@config_hash, :[], :[]=, :size
+      def_delegators :config_hash, :[], :[]=, :size
+      attr_reader :config_hash
+      private :config_hash
     end
     private_class_method :new
 
@@ -34,7 +36,7 @@ module Wright
     #   otherwise.
     def self.nested_key?(*path)
       last_key = path.pop
-      last_hash = path.reduce(@config_hash) do |hash, key|
+      last_hash = path.reduce(config_hash) do |hash, key|
         return false unless hash.respond_to?(:fetch)
         hash.fetch(key, {})
       end
@@ -55,7 +57,7 @@ module Wright
     #
     # @return the configuration value or nil if the value is not set
     def self.nested_value(*path)
-      nested_key?(*path) ? path.reduce(@config_hash) { |a, e| a[e] } : nil
+      nested_key?(*path) ? path.reduce(config_hash) { |a, e| a[e] } : nil
     end
   end
 end

data/lib/wright/dsl.rb

@@ -1,4 +1,7 @@
 require 'wright/util'
+require 'wright/util/erb_renderer'
+require 'wright/util/mustache_renderer'
+require 'wright/util/file_renderer'
 
 module Wright
   # Includable Wright script DSL.
@@ -27,22 +30,58 @@ module Wright
   #   a_sink_to_remember.class
   #   # => KitchenSink
   module DSL
+    # DSL helper class.
+    class Util
+      # Renders an ERB template using the supplied hash.
+      # @param template [String] the template
+      # @param hash [Hash] the hash
+      # @return [String] the rendered template
+      def render_erb(template, hash)
+        Wright::Util::ErbRenderer.new(hash).render(template)
+      end
+
+      # Renders a mustache template using the supplied hash.
+      # @param template [String] the template
+      # @param hash [Hash] the hash
+      # @return [String] the rendered template
+      def render_mustache(template, hash)
+        Wright::Util::MustacheRenderer.new(hash).render(template)
+      end
+
+      # Renders a template file according to the file's extension
+      # using the supplied hash. Currently supports ERB (+.erb+) and
+      # Mustache (+.mustache+).
+      #
+      # @param filename [String] the filename of the template file
+      # @param hash [Hash] the hash
+      # @return [String] the rendered template
+      def render_file(filename, hash)
+        Wright::Util::FileRenderer.new(hash).render(filename)
+      end
+    end
+
+    # Supplies access to various useful helper methods.
+    # @return [Wright::DSL::Util] a utility helper
+    def util
+      Wright::DSL::Util.new
+    end
+
     # Registers a class as a resource.
     #
     # Creates a resource method in the DSL module. Uses the
     # snake-cased class name as method name.
     #
-    # Typically resource_class is a subclass of {Resource}. It is
-    # initialized with the resource's name as an argument.
-    #
-    # @param resource_class the resource class
+    # Typically +resource_class+ is a subclass of {Resource}. It is
+    # initialized with the resource's name and the attribute hash as
+    # arguments.
     #
+    # @param resource_class [Class] the resource class
     # @return [void]
     def self.register_resource(resource_class)
-      method_name = Util.class_to_resource_name(resource_class)
+      method_name = Wright::Util.class_to_resource_name(resource_class)
       this_module = self
-      define_method(method_name) do |name, &block|
-        this_module.yield_resource(resource_class, name, &block)
+      define_method(method_name) do |name, args = {}, &block|
+        this_module.yield_resource(resource_class, name, args, &block)
       end
     end
 
@@ -52,10 +91,14 @@ module Wright
     # Implicitly invoking a block from within another block does not
     # work: http://blog.sidu.in/2007/11/ruby-blocks-gotchas.html
     #
+    # @param resource_class [Class] the resource class
+    # @param name [String] the name of the resource object
+    # @param args [Hash<Symbol, Object] the attribute hash of the resource
+    #
     # @yield [Resource] the resource
     # @return [void]
-    def self.yield_resource(resource_class, name)
-      r = resource_class.new(name)
+    def self.yield_resource(resource_class, name, args)
+      r = resource_class.new(name, args)
       yield(r) if block_given?
       r.run_action if r.respond_to?(:run_action)
       r

data/lib/wright/logger.rb

@@ -58,7 +58,7 @@ module Wright # rubocop:disable Documentation
     def initialize(logdev = $stdout)
       super
       Wright::Config[:log] ||= {}
-      return if Wright::Config[:log].has_key?(:colorize)
+      return if Wright::Config[:log].key?(:colorize)
 
       Wright::Config[:log][:colorize] = logdev.tty?
     end

data/lib/wright/provider.rb

@@ -26,13 +26,16 @@ module Wright
     # @return [Bool] true if the provider was updated and false
     #   otherwise
     def updated?
-      updated = @updated
-      @updated = false
-      updated
+      updated_since_last_call = updated
+      self.updated = false
+      updated_since_last_call
     end
 
     private
 
+    attr_accessor :updated
+    attr_reader :resource
+
     # @api public
     # Logs an info message and runs a code block unless dry run mode
     # is active.
@@ -49,7 +52,7 @@ module Wright
 
     # @api public
     # Checks if the provider is up-to-date, runs a code block and sets
-    # `@updated` to `true` if it is not.
+    # `updated` to `true` if it is not.
     #
     # @param action [String] the target action
     # @param message [String] a log message that is displayed if the
@@ -59,7 +62,7 @@ module Wright
         Wright.log.debug message
       else
         yield
-        @updated = true
+        self.updated = true
       end
     end
 

data/lib/wright/provider/directory.rb

@@ -42,11 +42,11 @@ module Wright
       private
 
       def dir_name
-        @resource.name
+        resource.name
       end
 
       def permissions
-        Wright::Util::FilePermissions.create_from_resource(@resource,
+        Wright::Util::FilePermissions.create_from_resource(resource,
                                                            :directory)
       end
 

data/lib/wright/provider/file.rb

@@ -14,7 +14,7 @@ module Wright
       # Creates or updates the file.
       #
       # @return [void]
-      # @raise [Errno::EISDIR] if there is already a directory with
+      # @raise [Errno::EISDIR] if there already is a directory with
       #   the specified name
       def create
         fail_if_directory
@@ -44,15 +44,15 @@ module Wright
       private
 
       def file_name
-        @resource.name
+        resource.name
       end
 
       def content
-        @resource.content
+        resource.content
       end
 
       def permissions
-        Wright::Util::FilePermissions.create_from_resource(@resource, :file)
+        Wright::Util::FilePermissions.create_from_resource(resource, :file)
       end
 
       def write_content_to_file

data/lib/wright/provider/group.rb

@@ -32,19 +32,19 @@ module Wright
       private
 
       def group_name
-        @resource.name
+        resource.name
       end
 
       def gid
-        @resource.gid
+        resource.gid
       end
 
       def members
-        @resource.members
+        resource.members
       end
 
       def system_group?
-        @resource.system
+        resource.system
       end
 
       def ensure_group_exists