config_curator 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e2b559882994bb8018bbe48134184ae10ff7f77
-  data.tar.gz: 2f9dc98e7e92abed3919cd1254ec1ead0d92a136
+  metadata.gz: 60147ff36c757ecf906de200cfee1119dc440f33
+  data.tar.gz: fee2526348a940b0c24868f3cbb70c0a5ff52179
 SHA512:
-  metadata.gz: 743e75e64d381dad366fcd0edbab0c3e9ffa2540492883a6ccf4ada91ab24a5b3519652f0ea0d061aafc63b0d6bdb73ef3af2eeb13c36c081a0c876d75ee711c
-  data.tar.gz: 42344300ff9789b36ac74860167ba3338910a7aabffa8a38b9c3974b23425498302306109c2cd27ac86b9d43e55a32ed41d7e0d59de76df2173c86c924f6ead8
+  metadata.gz: e38e6a073ea040e258bddcd6d768e1c874dc13487cbc0f8fef0d1d0c46c32e6eacc3fe8c4d55900ff2aca8a1ce74b7f9bf14f749a6461bd6218dfcc8f9af0ad2
+  data.tar.gz: d7b8d47e299d248d4d9e29e6e693a9ee04920ae9482036eb614f6811ec7791d5a8b1b5a542a7c4d650a4fafa176d8b76b1e4cf0fdeb545ff559a915b2f972dc6

data/.travis.yml

@@ -1,9 +1,8 @@
 language: ruby
-cache: bundler
 rvm:
   - 2.0.0
-  - 2.1.5
-  - 2.2.0
+  - 2.1.6
+  - 2.2.2
 cache: bundler
 sudo: false
 

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## 0.3.0
+
+- Force rsync to use checksums when installing components.
+- Units have a new `uninstall` action.
+  See the README for details.
+
 ## 0.2.4
 
 - Fix issue where wrong host-specific file would be installed.

data/README.md

@@ -1,10 +1,10 @@
 # Config Curator
 
 [![Gem Version](https://img.shields.io/gem/v/config_curator.svg)](https://rubygems.org/gems/config_curator)
-[![MIT License](https://img.shields.io/badge/license-MIT-red.svg)](./LICENSE.txt)
+[![MIT License](https://img.shields.io/github/license/razor-x/config_curator.svg)](./LICENSE.txt)
 [![Dependency Status](https://img.shields.io/gemnasium/razor-x/config_curator.svg)](https://gemnasium.com/razor-x/config_curator)
 [![Build Status](https://img.shields.io/travis/razor-x/config_curator.svg)](https://travis-ci.org/razor-x/config_curator)
-[![Coverage Status](https://img.shields.io/coveralls/razor-x/config_curator.svg)](https://coveralls.io/r/razor-x/config_curator)
+[![Coverage Status](https://img.shields.io/codecov/c/github/razor-x/config_curator.svg)](https://codecov.io/github/razor-x/config_curator)
 [![Code Climate](https://img.shields.io/codeclimate/github/razor-x/config_curator.svg)](https://codeclimate.com/github/razor-x/config_curator)
 
 by Evan Boyd Sosenko.
@@ -30,6 +30,24 @@ e.g., file, directory, symbolic link, etc.,
 is actually a subclass of the more generic `Unit` type.
 Other types can be added simply by adding more subclasses.
 
+## Quick start
+
+1. Install the `config_curator` gem
+   (make sure installed gem binaries are in your PATH).
+
+2. Create a `manifest.yml` file, e.g.,
+
+  ```yaml
+  config_files:
+    - src: .config/git/config
+  ```
+
+3. Add `.config/git/config` to your project and run
+
+  ```bash
+  $ curate -v
+  ```
+
 ## Usage
 
 ### The `manifest.yml` file
@@ -45,7 +63,7 @@ or a unit type: `components`, `config_files`, or `symlinks`.
 Optional global Config Curator settings.
 Defaults listed below.
 
-````yaml
+```yaml
 # All units installed relative to the root.
 root: "~/"
 
@@ -53,7 +71,7 @@ root: "~/"
 # Will automatically detect if not explicitly set.
 # Available tools: pacman, dpkg, pkgng.
 package_tool:
-````
+```
 
 #### `defaults`
 
@@ -64,7 +82,7 @@ Any per-unit attribute will override the value here.
 Any attribute not set here will use
 the Config Curator defined defaults below.
 
-````yaml
+```yaml
 defaults:
   # File and directory permissions.
   # Empty values will not change permissions.
@@ -83,7 +101,7 @@ defaults:
   # Only install this unit if packages are present.
   # Empty array will not check for any packages.
   packages: []
-````
+```
 
 #### Units
 
@@ -109,7 +127,7 @@ Components are installed before other units.
 The source will be mirrored to the destination.
 **Any existing files in the destination will be lost.**
 
-````yaml
+```yaml
 components:
   - src: .config/terminator
 
@@ -118,7 +136,7 @@ components:
     fmode: 640
     dmode: 0750
     packages: [ tmux ]
-````
+```
 
 ##### Config files are copied individually
 
@@ -130,7 +148,7 @@ In this example, the files `.tmux.conf` and `.tmux.baz.conf` both exist:
 the first will be installed on hosts `foo` and `bar`,
 while the second will be installed on host `baz`.
 
-````yaml
+```yaml
 config_files:
   - src: .gitconfig
   - src: .bundle/config
@@ -142,7 +160,7 @@ config_files:
 
   - src: .tmux.conf
     hosts: [ foo, bar, baz ]
-````
+```
 
 ##### Symlinks
 
@@ -150,26 +168,26 @@ Symlinks create a symbolic link to the `src` at the `dst`.
 
 They are installed last.
 
-````yaml
+```yaml
 symlinks:
   - src: ~/Wallpaper/tux.png
     dst: .config/awesome/wall.png
     packages: [ awesome ]
-````
+```
 
 ### The `curate` command
 
 Once you have prepared your manifest, simply run
 
-````bash
+```bash
 $ curate
-````
+```
 
 Or if you prefer more verbose feedback
 
-````bash
+```bash
 $ curate -v
-````
+```
 
 You can always get help with
 
@@ -186,12 +204,25 @@ Options:
       [--debug], [--no-debug]
 ```
 
+#### Uninstalling units
+
+Currently all units have an uninstall method.
+Smart uninstall via `curate uninstall` is planned for an
+[upcoming release](https://github.com/razor-x/config_curator/issues/7).
+
 ### Scripting
 
 Config Curator is fully scriptable for easy inclusion into other Ruby programs.
 The API is well documented for this purpose
 (see [Documentation](#documentation) above).
 
+### Plugins
+
+Plugin support is
+[planned for an upcoming release](https://github.com/razor-x/config_curator/issues/8).
+If you like Config Curator and want to write a plugin,
+please let me know!
+
 ## Installation
 
 You can install the gem either with Bundler or directly.
@@ -203,21 +234,21 @@ along with `manifest.yml` into version control.
 
 Add this line to your application's Gemfile:
 
-````ruby
+```ruby
 gem 'config_curator'
-````
+```
 
 And then execute:
 
-````bash
+```bash
 $ bundle
-````
+```
 
 Or install it yourself as:
 
-````bash
+```bash
 $ gem install config_curator
-````
+```
 
 ## Documentation
 
@@ -225,8 +256,8 @@ The primary documentation for Config Curator is this README and the YARD source
 
 YARD documentation for all gem versions is hosted on the
 [Config Curator gem page](https://rubygems.org/gems/config_curator).
-Documentation for the latest commits is hosted on
-[the RubyDoc.info project page](http://rubydoc.info/github/razor-x/config_curator/frames).
+Also checkout
+[Omniref's interactive documentation](https://www.omniref.com/ruby/gems/config_curator).
 
 ## Development and Testing
 
@@ -236,30 +267,31 @@ The [Config Curator source](https://github.com/razor-x/config_curator)
 is hosted on GitHub.
 To clone the project run
 
-````bash
+```bash
 $ 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 build                 # Build config_curator-0.3.0.gem into the pkg directory
+rake bump:current[tag]     # Show current gem version
+rake bump:major[tag]       # Bump major part of gem version
+rake bump:minor[tag]       # Bump minor part of gem version
+rake bump:patch[tag]       # Bump patch part of gem version
+rake bump:pre[tag]         # 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 install               # Build and install config_curator-0.3.0.gem into system gems
+rake install:local         # Build and install config_curator-0.3.0.gem into system gems without network access
+rake release               # Create tag v0.3.0 and build and push config_curator-0.3.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
 

data/config_curator.gemspec

@@ -41,6 +41,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'simplecov', '~> 0.9'
-  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'codecov', '~> 0.1'
   spec.add_development_dependency 'fuubar', '~> 2.0'
 end

data/lib/config_curator/collection.rb

@@ -143,9 +143,9 @@ module ConfigCurator
       end unless quiet || !success
       return true
 
-      rescue Unit::InstallFailed => e
-        logger.fatal { "Halting install! Install attempt failed for #{type_name(type)}: #{e}" }
-        return false
+    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.
@@ -161,9 +161,9 @@ module ConfigCurator
       end unless quiet
       return true
 
-      rescue Unit::InstallFailed => e
-        logger.error { "Cannot install #{type_name(type)}: #{e}" }
-        return false
+    rescue Unit::InstallFailed => e
+      logger.error { "Cannot install #{type_name(type)}: #{e}" }
+      return false
     end
   end
 end

data/lib/config_curator/unit.rb

@@ -18,6 +18,9 @@ module ConfigCurator
       # Unit installed relative to this path.
       root: Dir.home,
 
+      # Automatically uninstall units that would not be installed.
+      uninstall: false,
+
       # Package tool to use. See #package_lookup.
       package_tool: nil
     }
@@ -73,7 +76,22 @@ module ConfigCurator
       @package_lookup ||= PackageLookup.new tool: options[:package_tool]
     end
 
+    # Uninstalls the unit.
+    # @return [Boolean] if the unit was uninstalled
+    def uninstall(force: false)
+      return true if uninstall? || force
+      false
+    end
+
+    # Checks if the unit should be uninstalled.
+    # @return [Boolean] if the unit should be uninstalled
+    def uninstall?
+      return true if !install? && options[:uninstall]
+      false
+    end
+
     # Installs the unit.
+    # @return [Boolean] if the unit was installed
     def install
       return false unless install?
       true

data/lib/config_curator/units/component.rb

@@ -8,6 +8,14 @@ module ConfigCurator
   class Component < Unit
     attr_accessor :fmode, :dmode, :owner, :group
 
+    # (see Unit#uninstall)
+    def uninstall(*args)
+      s = super(*args)
+      return s unless s
+      uninstall_component
+      true
+    end
+
     # (see Unit#install)
     def install
       s = super
@@ -30,13 +38,18 @@ module ConfigCurator
 
     private
 
+    # Uninstalls the component by removing the directory.
+    def uninstall_component
+      FileUtils.remove_entry_secure destination_path if Dir.exist? destination_path
+    end
+
     # Recursively creates the necessary directories and installs the component.
     # Any files in the install directory not in the source directory are removed.
     # Use rsync if available.
     def install_component
       if command? 'rsync'
         FileUtils.mkdir_p destination_path
-        cmd = [command?('rsync'), '-rt', '--del', '--links', "#{source_path}/", destination_path]
+        cmd = [command?('rsync'), '-rtc', '--del', '--links', "#{source_path}/", destination_path]
         logger.debug { "Running command: #{cmd.join ' '}" }
         system(*cmd)
       else
@@ -56,7 +69,7 @@ module ConfigCurator
 
       {fmode: 'f', dmode: 'd'}.each do |k, v|
         next if send(k).nil?
-        cmd = [find,  destination_path, '-type', v, '-exec']
+        cmd = [find, destination_path, '-type', v, '-exec']
         cmd.concat [chmod, send(k).to_s(8), '{}', '+']
         logger.debug { "Running command: #{cmd.join ' '}" }
         system(*cmd)

data/lib/config_curator/units/config_file.rb

@@ -23,6 +23,14 @@ module ConfigCurator
       @destination ||= @source
     end
 
+    # (see Unit#uninstall)
+    def uninstall(*args)
+      s = super(*args)
+      return s unless s
+      uninstall_file
+      true
+    end
+
     # (see Unit#install)
     def install
       s = super
@@ -44,6 +52,11 @@ module ConfigCurator
 
     private
 
+    # Uninstalls the file by removing it.
+    def uninstall_file
+      FileUtils.remove_entry_secure destination_path if File.exist? destination_path
+    end
+
     # Recursively creates the necessary directories and install the file.
     def install_file
       FileUtils.mkdir_p File.dirname(destination_path)

data/lib/config_curator/units/symlink.rb

@@ -3,6 +3,14 @@ module ConfigCurator
   # The {#destination_path} will be a link
   # that points to the {#source_path}.
   class Symlink < Unit
+    # (see Unit#uninstall)
+    def uninstall(*args)
+      s = super(*args)
+      return s unless s
+      uninstall_symlink
+      true
+    end
+
     # (see Unit#install)
     def install
       s = super
@@ -22,6 +30,11 @@ module ConfigCurator
 
     private
 
+    # Uninstalls the symlink by removing it.
+    def uninstall_symlink
+      FileUtils.remove_entry_secure destination_path if File.exist? destination_path
+    end
+
     # Recursively creates the necessary directories and make the symlink.
     def install_symlink
       FileUtils.mkdir_p File.dirname(destination_path)

data/lib/config_curator/version.rb

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

data/spec/spec_helper.rb

@@ -1,13 +1,14 @@
-require 'coveralls'
 require 'simplecov'
 
-SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-  SimpleCov::Formatter::HTMLFormatter,
-  Coveralls::SimpleCov::Formatter
-]
-
 SimpleCov.start
 
+if ENV['CI'] == 'true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+else
+  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+end
+
 require 'config_curator'
 
 RSpec.configure do |c|

data/spec/unit_spec.rb

@@ -91,6 +91,55 @@ describe ConfigCurator::Unit do
     end
   end
 
+  describe "#uninstall" do
+    context "when unit should be uninstalled" do
+      it "returns true" do
+        expect(unit).to receive(:uninstall?).and_return(true)
+        expect(unit.uninstall).to be true
+      end
+
+      it "returns true when uninstall is forced" do
+        expect(unit).to receive(:uninstall?).and_return(false)
+        expect(unit.uninstall force: true).to be true
+      end
+    end
+
+    context "when unit should not be uninstalled" do
+      it "returns false" do
+        expect(unit).to receive(:uninstall?).and_return(false)
+        expect(unit.uninstall).to be false
+      end
+    end
+  end
+
+  describe "#uninstall?" do
+    context "unit should not be installed" do
+      it "returns false by default" do
+        expect(unit).to receive(:install?).and_return(false)
+        expect(unit.uninstall?).to be false
+      end
+
+      it "returns true when uninstall option is set" do
+        unit.options[:uninstall] = true
+        expect(unit).to receive(:install?).and_return(false)
+        expect(unit.uninstall?).to be true
+      end
+    end
+
+    context "unit should be installed" do
+      it "returns false" do
+        expect(unit).to receive(:install?).and_return(true)
+        expect(unit.uninstall?).to be false
+      end
+
+      it "returns false when uninstall option is set" do
+        unit.options[:uninstall] = true
+        expect(unit).to receive(:install?).and_return(true)
+        expect(unit.uninstall?).to be false
+      end
+    end
+  end
+
   describe "#install" do
     context "when unit should be installed" do
       it "returns true" do
@@ -117,6 +166,28 @@ describe ConfigCurator::Unit do
       expect(unit).to receive(:packages_installed?)
       unit.install?
     end
+
+    context "when requirements are met" do
+      it "returns true" do
+        expect(unit).to receive(:allowed_host?).and_return(true)
+        expect(unit).to receive(:packages_installed?).and_return(true)
+        expect(unit.install?).to be true
+      end
+    end
+
+    context "when not on an allowed host" do
+      it "returns false" do
+        expect(unit).to receive(:allowed_host?).and_return(false)
+        expect(unit.install?).to be false
+      end
+    end
+
+    context "when required packages are not installed" do
+      it "returns false" do
+        expect(unit).to receive(:packages_installed?).and_return(false)
+        expect(unit.install?).to be false
+      end
+    end
   end
 
   describe "#allowed_host?" do

data/spec/units/component_spec.rb

@@ -3,6 +3,24 @@ require 'spec_helper'
 describe ConfigCurator::Component do
   subject(:component) { ConfigCurator::Component.new }
 
+  describe "#uninstall" do
+    context "when component should be uninstalled" do
+      it "uninstalls the component and returns true" do
+        expect(component).to receive(:uninstall?).and_return(true)
+        expect(component).to receive(:uninstall_component)
+        expect(component.uninstall).to be true
+      end
+    end
+
+    context "when component should not be uninstalled" do
+      it "does not uninstall the component and returns false" do
+        expect(component).to receive(:uninstall?).and_return(false)
+        expect(component).to_not receive(:uninstall_component)
+        expect(component.uninstall).to be false
+      end
+    end
+  end
+
   describe "#install" do
     context "when component should be installed" do
       it "installs the component and returns true" do

data/spec/units/config_file_spec.rb

@@ -45,6 +45,24 @@ describe ConfigCurator::ConfigFile do
     end
   end
 
+  describe "#uninstall" do
+    context "when config file should be uninstalled" do
+      it "uninstalls the config file and returns true" do
+        expect(config_file).to receive(:uninstall?).and_return(true)
+        expect(config_file).to receive(:uninstall_file)
+        expect(config_file.uninstall).to be true
+      end
+    end
+
+    context "when config file should not be uninstalled" do
+      it "does not uninstall the config file and returns false" do
+        expect(config_file).to receive(:uninstall?).and_return(false)
+        expect(config_file).to_not receive(:uninstall_file)
+        expect(config_file.uninstall).to be false
+      end
+    end
+  end
+
   describe "#install" do
     context "when config file should be installed" do
       it "installs the config file and returns true" do

data/spec/units/symlink_spec.rb

@@ -3,6 +3,24 @@ require 'spec_helper'
 describe ConfigCurator::Symlink do
   subject(:symlink) { ConfigCurator::Symlink.new }
 
+  describe "#uninstall" do
+    context "when symlink should be uninstalled" do
+      it "uninstalls the symlink and returns true" do
+        expect(symlink).to receive(:uninstall?).and_return(true)
+        expect(symlink).to receive(:uninstall_symlink)
+        expect(symlink.uninstall).to be true
+      end
+    end
+
+    context "when symlink should not be uninstalled" do
+      it "does not uninstall the symlink and returns false" do
+        expect(symlink).to receive(:uninstall?).and_return(false)
+        expect(symlink).to_not receive(:uninstall_symlink)
+        expect(symlink.uninstall).to be false
+      end
+    end
+  end
+
   describe "#install" do
     context "when symbolic link should be installed" do
       it "installs the symbolic link and returns true" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_curator
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Evan Boyd Sosenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-17 00:00:00.000000000 Z
+date: 2015-08-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -235,19 +235,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: fuubar
   requirement: !ruby/object:Gem::Requirement