config_curator 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd8b835a413ec4e9f789730aee2df2afc6b495d3
-  data.tar.gz: 0d5edcc08ff046b1d1271c5426a3a5a2dc5b03ce
+  metadata.gz: 0cc743eac4dc51e37ac3c8c373868ed9b099853e
+  data.tar.gz: c5857e0fc09a20c537069875c4515b706b8d3ebc
 SHA512:
-  metadata.gz: d208bfb15fdb6a0845cb4f9837850e634e05f59a7a4db4e39c0a631452f5f3d63a8272fb32c0837696328d7039a8867d4bc7303d8dc4a83c25d568fd1d31712d
-  data.tar.gz: a6b8394a2e5e7f9d1232f7e4054d278f839d89c6cc19e5dbe34f93da0fda408552d0e0e49f529e8e19710f3e56140d4987f1a945cc01488fc88f18d93052f14d
+  metadata.gz: 815a4f93e970b6cdeeb9e0fa848d7d6d2c50ed192d20ea4c973b2a885d1900732532418126f52ddc0d9d0c16034e3547c223387b707ee64f0f98d34f376cf4ee
+  data.tar.gz: d0cb7b9cff4ac26b07d1405942871a51ce04f388387736e6bca432d32e16321fc1cd93d88174ed2b50b8177dc00a70b6527831b73f0d4c6409f7eb638fc2693d

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Guardfile
+    - Rakefile
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%q': '{}'
+    '%Q': '{}'
+
+Style/RegexpLiteral:
+  Exclude:
+    - Guardfile
+
+Style/SpaceInsideHashLiteralBraces:
+  Enabled: false

data/.travis.yml

@@ -4,4 +4,11 @@ rvm:
   - 2.0.0
   - 2.1.1
   - 2.1.2
+
+before_install:
+  - 'echo ''gem: --no-document'' > ~/.gemrc'
+
+install:
+  - bundle update
+
 script: bundle exec rake travis

data/.yardopts

@@ -1,5 +1,6 @@
 --markup-provider=redcarpet
 --markup=markdown
+--plugin redcarpet-ext
 lib/**/*.rb
 -
 README.md

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-# Config Curator ChangeLog
+# ChangeLog
+
+## 0.2.0
+
+- Merged [ruby-gem](https://github.com/razor-x/ruby-gem) for improved development.
+- Style changes and refactoring to pass Rubocop.
 
 ## 0.1.0
 

data/Guardfile

@@ -1,10 +1,23 @@
-guard :rspec, cmd: 'bundle exec rspec --color --format Fuubar' do
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/config_curator/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^spec/.+_spec\.rb$})
-  watch('spec/spec_helper.rb') { 'spec' }
+scope groups: [:doc, :lint, :unit]
+
+group :doc do
+  guard :yard do
+    watch(%r{^lib/(.+)\.rb$})
+  end
+end
+
+group :lint do
+  guard :rubocop do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
 end
 
-guard :yard do
-  watch(%r{^lib/(.+)\.rb$})
+group :unit do
+  guard :rspec, cmd: 'bundle exec rspec --color --format Fuubar' do
+    watch(%r{^lib/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^lib/config_curator/(.+)\.rb$}) { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r{^spec/.+_spec\.rb$})
+    watch('spec/spec_helper.rb') { 'spec' }
+  end
 end

data/README.md

@@ -1,9 +1,5 @@
 # Config Curator
 
-by Evan Boyd Sosenko.
-
-_Simple and intelligent configuration file management._
-
 [![Gem Version](http://img.shields.io/gem/v/config_curator.svg?style=flat)](https://rubygems.org/gems/config_curator)
 [![MIT License](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](./LICENSE.txt)
 [![Dependency Status](http://img.shields.io/gemnasium/razor-x/config_curator.svg?style=flat)](https://gemnasium.com/razor-x/config_curator)
@@ -11,6 +7,12 @@ _Simple and intelligent configuration file management._
 [![Coverage Status](http://img.shields.io/coveralls/razor-x/config_curator.svg?style=flat)](https://coveralls.io/r/razor-x/config_curator)
 [![Code Climate](http://img.shields.io/codeclimate/github/razor-x/config_curator.svg?style=flat)](https://codeclimate.com/github/razor-x/config_curator)
 
+by Evan Boyd Sosenko.
+
+_Simple and intelligent configuration file management._
+
+## Description
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -48,7 +50,9 @@ Config Curator is fully scriptable for easy inclusion into other Ruby programs.
 The API is well documented for this purpose
 (see [Documentation](#documentation) above).
 
-## Source Repository
+## Development and Testing
+
+### Source Code
 
 The [Config Curator source](https://github.com/razor-x/config_curator)
 is hosted on GitHub.
@@ -58,6 +62,37 @@ To clone the project run
 $ git clone https://github.com/razor-x/config_curator.git
 ````
 
+### Rake
+
+Run `rake -T` to see all Rake tasks.
+
+````
+rake all                   # Run all tasks
+rake build                 # Build config_curator-0.0.0.gem into the pkg directory
+rake bump:current          # Show current gem version
+rake bump:major            # Bump major part of gem version
+rake bump:minor            # Bump minor part of gem version
+rake bump:patch            # Bump patch part of gem version
+rake bump:pre              # Bump pre part of gem version
+rake bump:set              # Sets the version number using the VERSION environment variable
+rake install               # Build and install config_curator-0.0.0.gem into system gems
+rake release               # Create tag v0.0.0 and build and push config_curator-0.0.0.gem to Rubygems
+rake rubocop               # Run RuboCop
+rake rubocop:auto_correct  # Auto-correct RuboCop offenses
+rake spec                  # Run RSpec code examples
+rake yard                  # Generate YARD Documentation
+````
+
+### Guard
+
+Guard tasks have been separated into the following groups:
+
+- `doc`
+- `lint`
+- `unit`
+
+By default, Guard will generate documentation, lint, and run unit tests.
+
 ## Contributing
 
 Please submit and comment on bug reports and feature requests.
@@ -66,9 +101,10 @@ To submit a patch:
 
 1. Fork it (https://github.com/razor-x/config_curator/fork).
 2. Create your feature branch (`git checkout -b my-new-feature`).
-3. Commit your changes (`git commit -am 'Add some feature'`).
-4. Push to the branch (`git push origin my-new-feature`).
-5. Create a new Pull Request.
+3. Make changes. Write and run tests.
+4. Commit your changes (`git commit -am 'Add some feature'`).
+5. Push to the branch (`git push origin my-new-feature`).
+6. Create a new Pull Request.
 
 ## License
 

data/Rakefile

@@ -1,9 +1,23 @@
-require 'bundler/gem_tasks'
 require 'bump/tasks'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'yard'
+
+task default: [:yard, :rubocop, :spec]
+task travis: [:rubocop, :spec]
+
+desc 'Run all tasks'
+task all: [:yard, :rubocop, :spec]
 
-RSpec::Core::RakeTask.new :spec
+YARD::Config.load_plugin 'redcarpet-ext'
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['**/*.rb', '-', 'README.md', 'CHANGELOG.md', 'LICENSE.txt']
+  t.options = ['--markup-provider=redcarpet', '--markup=markdown']
+end
 
-task default: :spec
+RuboCop::RakeTask.new do |t|
+  t.formatters = ['progress']
+end
 
-task travis: [:spec]
+RSpec::Core::RakeTask.new

data/config_curator.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'config_curator/version'
@@ -8,14 +7,14 @@ Gem::Specification.new do |spec|
   spec.version       = ConfigCurator::VERSION
   spec.authors       = ['Evan Boyd Sosenko']
   spec.email         = ['razorx@evansosenko.com']
-  spec.summary       = %q{Simple and intelligent configuration file management.}
   spec.description   = %q{}
+  spec.summary       = %q{Simple and intelligent configuration file management.}
   spec.homepage      = 'https://github.com/razor-x/config_curator'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(features|spec|test)/})
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.0.0'
@@ -24,17 +23,24 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'thor', '~> 0.19.1'
 
   spec.add_development_dependency 'bundler', '~> 1.6'
-  spec.add_development_dependency 'rake', '~> 10.3.1'
   spec.add_development_dependency 'bump', '~> 0.5.0'
 
-  spec.add_development_dependency 'yard', '0.8.7.4'
-  spec.add_development_dependency 'redcarpet', '3.1.1'
+  spec.add_development_dependency 'yard', '~> 0.8.7.4'
+  spec.add_development_dependency 'yard-redcarpet-ext', '~> 0.0.3'
+  spec.add_development_dependency 'redcarpet', '~> 3.1.2'
   spec.add_development_dependency 'github-markup', '1.2.1'
 
-  spec.add_development_dependency 'rspec', '~> 2.14.1'
+  spec.add_development_dependency 'rubocop', '~> 0.23.0'
+
+  spec.add_development_dependency 'rake', '~> 10.3.2'
+
+  spec.add_development_dependency 'guard', '~> 2.6.1'
+  spec.add_development_dependency 'guard-yard', '~> 2.1.0'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.1.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.2.9'
+
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
   spec.add_development_dependency 'simplecov', '~> 0.8.2'
   spec.add_development_dependency 'coveralls', '~> 0.7.0'
-  spec.add_development_dependency 'fuubar', '~> 1.3.2'
-  spec.add_development_dependency 'guard-rspec', '~> 4.2.8'
-  spec.add_development_dependency 'guard-yard', '~> 2.1.1'
+  spec.add_development_dependency 'fuubar', '~> 2.0.0.rc1'
 end

data/lib/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+Style/LineLength:
+  Max: 100

data/lib/config_curator.rb

@@ -7,7 +7,3 @@ require 'config_curator/unit'
 require 'config_curator/units/config_file'
 require 'config_curator/units/symlink'
 require 'config_curator/units/component'
-
-# Simple and intelligent configuration file management.
-module ConfigCurator
-end

data/lib/config_curator/cli.rb

@@ -2,10 +2,8 @@ require 'logger'
 require 'thor'
 
 module ConfigCurator
-
   # Thor class for the `curate` command.
   class CLI < Thor
-
     default_task :install
 
     class_option :verbose, type: :boolean, aliases: %i(v)
@@ -15,11 +13,12 @@ module ConfigCurator
     # Installs the collection.
     # @param manifest [String] path to the manifest file to use
     # @return [Boolean] value of {Collection#install} or {Collection#install?}
-    desc "install", "Installs all units in collection."
-    option :dryrun, type: :boolean, aliases: %i(n),
-      desc: %q{Only simulate the install. Don't make any actual changes.}
-    def install manifest='manifest.yml'
-      unless File.exists? manifest
+    desc 'install', 'Installs all units in collection.'
+    option :dryrun,
+           type: :boolean, aliases: %i(n),
+           desc: %q{Only simulate the install. Don't make any actual changes.}
+    def install(manifest = 'manifest.yml')
+      unless File.exist? manifest
         logger.fatal { "Manifest file '#{manifest}' does not exist." }
         return false
       end
@@ -27,21 +26,12 @@ module ConfigCurator
       collection.load_manifest manifest
       result = options[:dryrun] ? collection.install? : collection.install
 
-      msg = "Install #{'simulation ' if options[:dryrun]}" + \
-        if result
-          'completed without error.'
-        elsif result.nil?
-          'failed.'
-        else
-          'failed. No changes were made.'
-        end
-
-      if result then logger.info msg else logger.error msg end
-      return result
+      msg = install_message(result, options[:dryrun])
+      result ? logger.info(msg) : logger.error(msg)
+      result
     end
 
     no_commands do
-
       # Makes a collection object to use for the instance.
       # @return [Collection] the collection object
       def collection
@@ -56,19 +46,34 @@ module ConfigCurator
           log.formatter = proc do |severity, _, _, msg|
             "#{severity} -- #{msg}\n"
           end
-          log.level = \
-            if options[:debug]
-              Logger::DEBUG
-            elsif options[:verbose]
-              Logger::INFO
-            elsif options[:quiet]
-              Logger::FATAL
-            else
-              Logger::WARN
-            end
+          log.level = log_level(options)
         end
       end
     end
-  end
 
+    private
+
+    def log_level(options)
+      if options[:debug]
+        Logger::DEBUG
+      elsif options[:verbose]
+        Logger::INFO
+      elsif options[:quiet]
+        Logger::FATAL
+      else
+        Logger::WARN
+      end
+    end
+
+    def install_message(result, dryrun)
+      "Install #{'simulation ' if dryrun}" + \
+        if result
+          'completed without error.'
+        elsif result.nil?
+          'failed.'
+        else
+          'failed. No changes were made.'
+        end
+    end
+  end
 end

data/lib/config_curator/collection.rb

@@ -3,30 +3,28 @@ require 'logger'
 require 'yaml'
 
 module ConfigCurator
-
   # Manages collections of units.
   # @example Load a list of units and install them
   #  Collection.new(manifest_path: 'manifest.yml').install
   class Collection
-
     # Supported unit types.
     UNIT_TYPES = %i(unit component config_file symlink)
 
     # The possible attributes specific to each unit type.
     # This should not include generic attributes
     # such as {Unit#source} and {Unit#destination}.
-    UNIT_ATTRIBUTESS = {
+    UNIT_ATTRIBUTES = {
       unit: %i(hosts packages),
       component: %i(hosts packages fmode dmode owner group),
       config_file: %i(hosts packages fmode owner group),
-      symlink: %i(hosts packages),
+      symlink: %i(hosts packages)
     }
 
     attr_accessor :logger, :manifest, :units
 
-    def initialize manifest_path: nil, logger: nil
+    def initialize(manifest_path: nil, logger: nil)
       self.logger = logger unless logger.nil?
-      self.load_manifest manifest_path unless manifest_path.nil?
+      load_manifest manifest_path unless manifest_path.nil?
     end
 
     # Logger instance to use.
@@ -40,7 +38,7 @@ module ConfigCurator
     # Loads the manifest from file.
     # @param file [Hash] the yaml file to load
     # @return [Hash] the loaded manifest
-    def load_manifest file
+    def load_manifest(file)
       self.manifest = YAML.load_file file
     end
 
@@ -52,32 +50,22 @@ module ConfigCurator
           k = type.to_s.pluralize.to_sym
           u[k] = []
 
-          if manifest
-            manifest[k].each do |v|
-              u[k] << create_unit(type, attributes: v)
-            end unless manifest[k].nil?
-          end
+          next unless manifest
+          next if manifest[k].nil?
+
+          manifest[k].each { |v| u[k] << create_unit(type, attributes: v) }
         end
       end
     end
 
     # Installs all units from the manifest.
-    # @return [Boolean, nil] if units were installed or nil when fails mid-install
+    # @return [Boolean, nil] if units were installed or nil if fails mid-install
     def install
       return false unless install? quiet: !(logger.level == Logger::DEBUG)
 
-      UNIT_TYPES.each do |t|
-        type_name = t.to_s.humanize capitalize: false
-
-        units[t.to_s.pluralize.to_sym].each do |unit|
-          begin
-            if unit.install
-              logger.info { "Installed #{type_name}: #{unit.source} ⇨ #{unit.destination_path}" }
-            end
-          rescue Unit::InstallFailed => e
-            logger.fatal { "Halting install! Install attempt failed for #{type_name}: #{e}" }
-            return nil
-          end
+      UNIT_TYPES.each do |type|
+        units[type.to_s.pluralize.to_sym].each do |unit|
+          return nil unless install_unit(unit, type)
         end
       end
       true
@@ -86,20 +74,11 @@ module ConfigCurator
     # Checks all units in the manifest for any detectable install issues.
     # @param quiet [Boolean] suppress some {#logger} output
     # @return [Boolean] if units can be installed
-    def install? quiet: false
+    def install?(quiet: false)
       result = true
-      UNIT_TYPES.each do |t|
-        type_name = t.to_s.humanize capitalize: false
-
-        units[t.to_s.pluralize.to_sym].each do |unit|
-          begin
-            if unit.install?
-              logger.info { "Testing install for #{type_name}: #{unit.source} ⇨ #{unit.destination_path}" }
-            end unless quiet
-          rescue Unit::InstallFailed => e
-            result = false
-            logger.error { "Cannot install #{type_name}: #{e}" }
-          end
+      UNIT_TYPES.each do |type|
+        units[type.to_s.pluralize.to_sym].each do |unit|
+          result = install_unit?(unit, type, quiet) ? result : false
         end
       end
       result
@@ -107,21 +86,16 @@ module ConfigCurator
 
     # Creates a new unit object for the collection.
     # @param type [Symbol] a unit type in {UNIT_TYPES}
-    # @param attributes [Hash] attributes for the unit from {UNIT_ATTRIBUTESS}
+    # @param attributes [Hash] attributes for the unit from {UNIT_ATTRIBUTES}
     # @return [Unit] the unit object of the appropriate subclass
-    def create_unit type, attributes: {}
-      options = {}
-      %i(root package_tool).each do |k|
-        options[k] = manifest[k] unless manifest[k].nil?
-      end if manifest
-
+    def create_unit(type, attributes: {})
       "#{self.class.name.split('::').first}::#{type.to_s.camelize}".constantize
-      .new(options: options, logger: logger).tap do |unit|
+      .new(options: unit_options, logger: logger).tap do |unit|
         {src: :source, dst: :destination}.each do |k, v|
           unit.send "#{v}=".to_sym, attributes[k] unless attributes[k].nil?
         end
 
-        UNIT_ATTRIBUTESS[type].each do |v|
+        UNIT_ATTRIBUTES[type].each do |v|
           unit.send "#{v}=".to_sym, defaults[v] unless defaults[v].nil?
           unit.send "#{v}=".to_sym, attributes[v] unless attributes[v].nil?
         end
@@ -130,11 +104,64 @@ module ConfigCurator
 
     private
 
+    # Formats a unit type for display.
+    # @param type [Symbol] the unit type
+    # @return [String] formatted unit type
+    def type_name(type)
+      type.to_s.humanize capitalize: false
+    end
+
     # Hash of any defaults given in the manifest.
+    # @return [Hash] the defaults
     def defaults
       return {} unless manifest
       manifest[:defaults].nil? ? {} : manifest[:defaults]
     end
-  end
 
+    # Load basic unit options from the manifest.
+    # @return [Hash] the options
+    def unit_options
+      options = {}
+      return options unless manifest
+      %i(root package_tool).each do |k|
+        options[k] = manifest[k] unless manifest[k].nil?
+      end
+      options
+    end
+
+    # Installs a unit.
+    # @param unit [Unit] the unit to install
+    # @param type [Symbol] the unit type
+    # @param quiet [Boolean] suppress some {#logger} output
+    # @return [Boolean] if unit was installed
+    def install_unit(unit, type, quiet = false)
+      unit.install
+      logger.info do
+        "Installed #{type_name(type)}: #{unit.source} ⇨ #{unit.destination_path}"
+      end unless quiet
+      return true
+
+      rescue Unit::InstallFailed => e
+        logger.fatal { "Halting install! Install attempt failed for #{type_name(type)}: #{e}" }
+        return false
+    end
+
+    # Checks if a unit can be installed.
+    # @param unit [Unit] the unit to check
+    # @param type [Symbol] the unit type
+    # @param quiet [Boolean] suppress some {#logger} output
+    # @return [Boolean] if unit can be installed
+    def install_unit?(unit, type, quiet = false)
+      unit.install?
+      logger.info do
+        "Testing install for #{type_name(type)}:" \
+        " #{unit.source} ⇨ #{unit.destination_path}"
+      end unless quiet
+      return true
+
+      rescue Unit::InstallFailed => e
+        logger.error { "Cannot install #{type_name(type)}: #{e}" }
+        return false
+    end
+  end
 end

data/lib/config_curator/package_lookup.rb

@@ -2,7 +2,6 @@ require 'mkmf'
 require 'open3'
 
 module ConfigCurator
-
   # Lookup if a package is installed on the system.
   # See {TOOLS} for supported package tools.
   # If {#tool} is not explicitly set, it will try and choose one automatically.
@@ -11,7 +10,6 @@ module ConfigCurator
   # @example Lookup a package using `pacman`
   #   PackageLookup.new(tool: :pacman).installed? 'ruby' #=> true
   class PackageLookup
-
     include Utils
 
     # Error when a package lookup cannot be completed.
@@ -22,12 +20,12 @@ module ConfigCurator
     TOOLS = {
       dpkg: 'dpkg',
       pacman: 'pacman',
-      pkgng: 'pkg',
+      pkgng: 'pkg'
     }
 
     attr_accessor :tool, :tools
 
-    def initialize tool: nil
+    def initialize(tool: nil)
       self.tool = tool
     end
 
@@ -44,9 +42,8 @@ module ConfigCurator
       return @tool if @tool
 
       tools.each do |k, v|
-        if command? v
-          return @tool = k
-        end
+        next unless command? v
+        return @tool = k
       end
       @tool
     end
@@ -54,7 +51,7 @@ module ConfigCurator
     # Checks if package is installed.
     # @param package [String] package name to check
     # @return [Boolean] if package is installed
-    def installed? package
+    def installed?(package)
       fail LookupFailed, 'No supported package tool found.' if tool.nil?
 
       cmd = tools[tool]
@@ -69,26 +66,25 @@ module ConfigCurator
     # Tool specific package lookup methods below.
     #
 
-    def dpkg package
+    def dpkg(package)
       cmd = command? 'dpkg'
       Open3.popen3 cmd, '-s', package do |_, _ , _, wait_thr|
         wait_thr.value.to_i == 0
       end
     end
 
-    def pacman package
+    def pacman(package)
       cmd = command? 'pacman'
       Open3.popen3 cmd, '-qQ', package do |_, _ , _, wait_thr|
         wait_thr.value.to_i == 0
       end
     end
 
-    def pkgng package
+    def pkgng(package)
       cmd = command? 'pkg'
       Open3.popen3 cmd, 'info', package do |_, _ , _, wait_thr|
         wait_thr.value.to_i == 0
       end
     end
   end
-
 end

data/lib/config_curator/unit.rb

@@ -2,12 +2,10 @@ require 'logger'
 require 'socket'
 
 module ConfigCurator
-
   # A unit is the base class for a type of configuration
   # that should be installed.
   # All units must specify a {#source} and a {#destination}.
   class Unit
-
     include Utils
 
     # Error if the unit will fail to install.
@@ -21,10 +19,10 @@ module ConfigCurator
       root: Dir.home,
 
       # Package tool to use. See #package_lookup.
-      package_tool: nil,
+      package_tool: nil
     }
 
-    def initialize options: {}, logger: nil
+    def initialize(options: {}, logger: nil)
       self.options options
       self.logger = logger unless logger.nil?
     end
@@ -32,7 +30,7 @@ module ConfigCurator
     # Uses {DEFAULT_OPTIONS} as initial value.
     # @param options [Hash] merged with current options
     # @return [Hash] current options
-    def options options = {}
+    def options(options = {})
       @options ||= DEFAULT_OPTIONS
       @options = @options.merge options
     end
@@ -99,7 +97,7 @@ module ConfigCurator
     # Checks if the packages required for this unit are installed.
     # @return [Boolean] if the packages in {#packages} are installed
     def packages_installed?
-      packages.map(&method(:pkg_exists?)).delete_if{ |e| e }.empty?
+      packages.map(&method(:pkg_exists?)).delete_if { |e| e }.empty?
     end
 
     private
@@ -110,9 +108,8 @@ module ConfigCurator
     end
 
     # @return [Boolean] if the package exists on the system
-    def pkg_exists? pkg
+    def pkg_exists?(pkg)
       package_lookup.installed? pkg
     end
   end
-
 end

data/lib/config_curator/units/component.rb

@@ -1,13 +1,11 @@
 require 'mkmf'
 
 module ConfigCurator
-
   # A component is a folder that should be copied.
   # The {#destination} will become a mirror of the {#source}.
   # The contents of the {#destination_path} is
   # completely replaced by the contents of the {#source_path}.
   class Component < Unit
-
     attr_accessor :fmode, :dmode, :owner, :group
 
     # (see Unit#install)
@@ -24,9 +22,9 @@ module ConfigCurator
     def install?
       s = super
       return s unless s
-      fail InstallFailed, "No component source path specified." if source_path.nil?
-      fail InstallFailed, "No component install path specified." if destination_path.nil?
-      fail InstallFailed, "Source path does not exist: #{source}" unless Dir.exists? source_path
+      fail InstallFailed, 'No component source path specified.' if source_path.nil?
+      fail InstallFailed, 'No component install path specified.' if destination_path.nil?
+      fail InstallFailed, "Source path does not exist: #{source}" unless Dir.exist? source_path
       true
     end
 
@@ -40,7 +38,7 @@ module ConfigCurator
         FileUtils.mkdir_p destination_path
         cmd = [command?('rsync'), '-rt', '--del', "#{source_path}/", destination_path]
         logger.debug { "Running command: #{cmd.join ' '}" }
-        system *cmd
+        system(*cmd)
       else
         FileUtils.remove_entry_secure destination_path
         FileUtils.mkdir_p destination_path
@@ -53,14 +51,15 @@ module ConfigCurator
     def set_mode
       chmod = command? 'chmod'
       find = command? 'find'
-      if chmod && find
-        {fmode: 'f', dmode: 'd'}.each do |k, v|
-          next if self.send(k).nil?
-          cmd = [find,  destination_path, '-type', v, '-exec']
-          cmd.concat [chmod, self.send(k).to_s(8), '{}', '+']
-          logger.debug { "Running command: #{cmd.join ' '}" }
-          system *cmd
-        end
+
+      return unless chmod && find
+
+      {fmode: 'f', dmode: 'd'}.each do |k, v|
+        next if send(k).nil?
+        cmd = [find,  destination_path, '-type', v, '-exec']
+        cmd.concat [chmod, send(k).to_s(8), '{}', '+']
+        logger.debug { "Running command: #{cmd.join ' '}" }
+        system(*cmd)
       end
     end
 
@@ -69,12 +68,12 @@ module ConfigCurator
     def set_owner
       return unless owner || group
       chown = command? 'chown'
-      if chown
-        cmd = [chown, '-R', "#{owner}:#{group}", destination_path]
-        logger.debug { "Running command: #{cmd.join ' '}" }
-        system *cmd
-      end
+
+      return unless chown
+
+      cmd = [chown, '-R', "#{owner}:#{group}", destination_path]
+      logger.debug { "Running command: #{cmd.join ' '}" }
+      system(*cmd)
     end
   end
-
 end

data/lib/config_curator/units/config_file.rb

@@ -1,8 +1,6 @@
 module ConfigCurator
-
   # A config file is a file that should be copied.
   class ConfigFile < Unit
-
     attr_accessor :fmode, :owner, :group
 
     # Will use files of the form `filename.hostname.ext` if found.
@@ -10,7 +8,12 @@ module ConfigCurator
     def source
       path = super
       host_specific_file = search_for_host_specific_file path if path
-      if host_specific_file then return host_specific_file else return path end
+
+      if host_specific_file
+        return host_specific_file
+      else
+        return path
+      end
     end
 
     # (see Unit#destination)
@@ -34,8 +37,8 @@ module ConfigCurator
     def install?
       s = super
       return s unless s
-      fail InstallFailed, "No file source path specified." if source_path.nil?
-      fail InstallFailed, "Source path does not exist: #{source}" unless File.exists? source_path
+      fail InstallFailed, 'No file source path specified.' if source_path.nil?
+      fail InstallFailed, "Source path does not exist: #{source}" unless File.exist? source_path
       true
     end
 
@@ -61,11 +64,11 @@ module ConfigCurator
 
     # Will look for files with the naming pattern `filename.hostname.ext`.
     # @param path [String] path to the non-host-specific file
-    def search_for_host_specific_file path
+    def search_for_host_specific_file(path)
       directory = File.dirname path
       extension = File.extname path
       basename = File.basename path.chomp(extension)
-      if Dir.exists? directory
+      if Dir.exist? directory
         file = Dir.entries(directory).grep(/^#{basename}.#{hostname.downcase}/).first
         File.join directory, file unless file.nil?
       else
@@ -73,5 +76,4 @@ module ConfigCurator
       end
     end
   end
-
 end

data/lib/config_curator/units/symlink.rb

@@ -1,10 +1,8 @@
 module ConfigCurator
-
   # A symlink is a symbolic link that should be created.
   # The {#destination_path} will be a link
   # that points to the {#source_path}.
   class Symlink < Unit
-
     # (see Unit#install)
     def install
       s = super
@@ -17,8 +15,8 @@ module ConfigCurator
     def install?
       s = super
       return s unless s
-      fail InstallFailed, "No source file specified." if source_path.nil?
-      fail InstallFailed, "No destination specified." if destination_path.nil?
+      fail InstallFailed, 'No source file specified.' if source_path.nil?
+      fail InstallFailed, 'No destination specified.' if destination_path.nil?
       true
     end
 
@@ -30,5 +28,4 @@ module ConfigCurator
       FileUtils.symlink source_path, destination_path, force: true
     end
   end
-
 end

data/lib/config_curator/utils.rb

@@ -1,18 +1,15 @@
 module ConfigCurator
-
   # Utility class.
   module Utils
-
     private
 
     # Checks if command exists.
     # @param command [String] command name to check
     # @return [String, nil] full path to command or nil if not found
-    def command? command
+    def command?(command)
       MakeMakefile::Logging.instance_variable_set :@logfile, File::NULL
       MakeMakefile::Logging.quiet = true
       MakeMakefile.find_executable command.to_s
     end
   end
-
 end

data/lib/config_curator/version.rb

@@ -1,4 +1,5 @@
+# Simple and intelligent configuration file management.
 module ConfigCurator
   # Config Curator version.
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/spec/.rubocop.yml

@@ -0,0 +1,7 @@
+inherit_from: ../.rubocop.yml
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/LineLength:
+  Max: 120

data/spec/cli_spec.rb

@@ -25,7 +25,7 @@ describe ConfigCurator::CLI do
   describe "#install" do
 
     it "installs the collection" do
-      allow(File).to receive(:exists?).with('manifest.yml').and_return(true)
+      allow(File).to receive(:exist?).with('manifest.yml').and_return(true)
       expect(cli.collection).to receive(:load_manifest).with('manifest.yml')
       expect(cli.collection).to receive(:install).and_return(true)
       expect(cli.install 'manifest.yml').to be true
@@ -33,10 +33,10 @@ describe ConfigCurator::CLI do
 
     context "when --dryrun is set" do
 
-      before(:each) { allow(cli).to receive(:options).and_return({dryrun: true}) }
+      before(:each) { allow(cli).to receive(:options).and_return(dryrun: true) }
 
       it "only checks if install would succeed" do
-        allow(File).to receive(:exists?).with('manifest.yml').and_return(true)
+        allow(File).to receive(:exist?).with('manifest.yml').and_return(true)
         expect(cli.collection).to receive(:load_manifest).with('manifest.yml')
         expect(cli.collection).to receive(:install?).and_return(true)
         expect(cli.collection).to_not receive(:install)
@@ -47,7 +47,7 @@ describe ConfigCurator::CLI do
     context "manifest not found" do
 
       it "returns false and doesn't do anything else" do
-        allow(File).to receive(:exists?).with('manifest.yml').and_return(false)
+        allow(File).to receive(:exist?).with('manifest.yml').and_return(false)
         expect(cli.collection).to_not receive(:install)
         expect(cli.collection).to_not receive(:install?)
         expect(cli.install 'manifest.yml').to be false
@@ -55,10 +55,10 @@ describe ConfigCurator::CLI do
 
       context "when --dryrun is set" do
 
-        before(:each) { allow(cli).to receive(:options).and_return({dryrun: true}) }
+        before(:each) { allow(cli).to receive(:options).and_return(dryrun: true) }
 
         it "returns false and doesn't do anything else" do
-          allow(File).to receive(:exists?).with('manifest.yml').and_return(false)
+          allow(File).to receive(:exist?).with('manifest.yml').and_return(false)
           expect(cli.collection).to_not receive(:install)
           expect(cli.collection).to_not receive(:install?)
           expect(cli.install 'manifest.yml').to be false

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-require 'config_curator'
-
 require 'coveralls'
 require 'simplecov'
 
@@ -10,9 +8,15 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 
 SimpleCov.start
 
+require 'config_curator'
+
 RSpec.configure do |c|
   c.expect_with(:rspec) { |e| e.syntax = :expect }
 
+  c.before(:each) do
+    allow(FileUtils).to receive(:remove_entry_secure).with(anything)
+  end
+
   stderr = $stderr
   stdout = $stdout
   c.before(:all) do
@@ -23,6 +27,4 @@ RSpec.configure do |c|
     $stderr = stderr
     $stdout = stdout
   end
-
-  c.before(:each) { allow(FileUtils).to receive(:remove_entry_secure).with(anything) }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_curator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Boyd Sosenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-30 00:00:00.000000000 Z
+date: 2014-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,61 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.1
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: bump
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.8.7.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.8.7.4
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: yard-redcarpet-ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: 0.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 3.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.1
+        version: 3.1.2
 - !ruby/object:Gem::Dependency
   name: github-markup
   requirement: !ruby/object:Gem::Requirement
@@ -123,89 +123,145 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.2.1
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 0.23.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 0.23.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 10.3.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: 10.3.2
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 2.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 2.6.1
 - !ruby/object:Gem::Dependency
-  name: fuubar
+  name: guard-yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.2
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 4.2.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.8
+        version: 4.2.9
 - !ruby/object:Gem::Dependency
-  name: guard-yard
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: fuubar
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.0.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.1
+        version: 2.0.0.rc1
 description: ''
 email:
 - razorx@evansosenko.com
@@ -216,6 +272,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -226,6 +283,7 @@ files:
 - Rakefile
 - bin/curate
 - config_curator.gemspec
+- lib/.rubocop.yml
 - lib/config_curator.rb
 - lib/config_curator/cli.rb
 - lib/config_curator/collection.rb
@@ -236,6 +294,7 @@ files:
 - lib/config_curator/units/symlink.rb
 - lib/config_curator/utils.rb
 - lib/config_curator/version.rb
+- spec/.rubocop.yml
 - spec/cli_spec.rb
 - spec/collection_spec.rb
 - spec/package_lookup_spec.rb
@@ -269,6 +328,7 @@ signing_key:
 specification_version: 4
 summary: Simple and intelligent configuration file management.
 test_files:
+- spec/.rubocop.yml
 - spec/cli_spec.rb
 - spec/collection_spec.rb
 - spec/package_lookup_spec.rb