config_curator 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9753c5a06c3b4ee8154f677ee19e096c31503646
-  data.tar.gz: b7b258c1b60446f82a5c8db2731d85ca0573329f
+  metadata.gz: 5263cfbd7c7ece8e543723b99bd670e8a7cd614e
+  data.tar.gz: 9338e9254ec5cca6f8b3cbf5ac0eb682b69475c8
 SHA512:
-  metadata.gz: 129f1da431c6d4afab659dbca31bf5b11523b6e21033d3508b0e3b3c51d7f2528f39d65f4282ac6c3399c7d6037919f9b6988c4078dd08eebf9188724a01f14a
-  data.tar.gz: efba699dc4727c0bb018ea4cd8afa20d17eb0007a9ae04e5b53a3dbb386943077d1bd6feff16640044b625428296b9a33ae354e3edf7d6b0389d2e5406ef5478
+  metadata.gz: c2a92f1df9aab781816fcf7c4e8a6b4e4d4ff1565a2b4d001dfd8ad16596d48f30c1aacb00502779cad4e9f79386f038246304c330253fb8e8075890f50cc2fd
+  data.tar.gz: c8020790230fdebadbe86266840bb9b95dbdcbf7af9ecadcc8d723e7bee65788de73467f99af2c4ec3c74cddd4507377c3626d814fcc08c7599082f7c7c7a497

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # ChangeLog
 
+## 0.2.2
+
+- Copy system links in components when using rsync.
+
 ## 0.2.1
 
 - Allow all keys in manifest to be strings or symbols.

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Evan Boyd Sosenko
+Copyright (c) 2014-2015 Evan Boyd Sosenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -13,8 +13,194 @@ _Simple and intelligent configuration file management._
 
 ## Description
 
+Config Curator is a flexible configuration and dotfile manager.
+Simply define what to manage in `manifest.yml`,
+then run `curate` to install and update your **configuration units**.
+
+Currently, Config Curator supports installing
+directories, files, and symbolic links.
+It also handles setting other properties such as
+permissions and ownership.
+Additionally, configuration units can be installed per-host
+or only if certain packages are installed.
+
+Config Curator is written to be extensible:
+each type of configuration unit,
+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.
+
+## Usage
+
+### The `manifest.yml` file
+
+The `manifest.yml` file is a YAML file that defines
+the configuration units to install.
+
+Each key is either a global setting, `default`,
+or a unit type: `components`, `config_files`, or `symlinks`.
+
+#### Settings
+
+Optional global Config Curator settings.
+Defaults listed below.
+
+````yaml
+# All units installed relative to the root.
+root: "~/"
+
+# Package tool to use.
+# Will automatically detect if not explicitly set.
+# Available tools: pacman, dpkg, pkgng.
+package_tool:
+````
+
+#### `defaults`
+
+Optional key that sets the default attribute values for each unit.
+
+Any per-unit attribute will override the value here.
+
+Any attribute not set here will use
+the Config Curator defined defaults below.
+
+````yaml
+defaults:
+  # File and directory permissions.
+  # Empty values will not change permissions.
+  fmode:
+  dmode:
+
+  # File and directory owner and group.
+  # Empty values will not change ownership.
+  owner:
+  group:
+
+  # Hosts to install this unit on.
+  # Empty array will install on all hosts.
+  hosts: []
+
+  # Only install this unit if packages are present.
+  # Empty array will not check for any packages.
+  packages: []
+````
+
+#### Units
+
+Each unit must have a `src` which defines the source file or directory.
+
+You may give a `dst` to override the install location.
+Otherwise the destination will mimic the source path relative to the `root` path.
+This is required for symlinks.
+
+You can define an array of `hosts` to control what hostnames the unit will install on.
+Similarly you can give a list of packages that must be present to install the unit.
+You can also use any other attribute in the `defaults` key listed in the previous section.
+
+Best to see some examples.
+Note in the examples below how some units are installed from the `bower_components` directory:
+external configuration is thus managed as a Bower dependency and installed using `curate`.
+You can always visit [my dotfiles for a real-world example](https://github.com/razor-x/dotfiles).
+
+##### Components are entire directories
+
+Components are installed before other units.
+
+The source will be mirrored to the destination.
+**Any existing files in the destination will be lost.**
+
+````yaml
+components:
+  - src: .config/terminator
+
+  - src: bower_components/tmuxinator-profiles
+    dst: .tmuxinator
+    fmode: 640
+    dmode: 0750
+    packages: [ tmux ]
+````
+
+##### Config files are copied individually
+
+Files are installed after components.
+
+Subdirectories are created as needed.
+
+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
+config_files:
+  - src: .gitconfig
+  - src: .bundle/config
+
+  - src: bower_components/ssh-config/config
+    dst: .ssh/config
+    fmode: 600
+    dmode: 0700
+
+  - src: .tmux.conf
+    hosts: [ foo, bar, baz ]
+````
+
+##### Symlinks
+
+Symlinks create a symbolic link to the `src` at the `dst`.
+
+They are installed last.
+
+````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
+$ curate
+````
+
+Or if you prefer more verbose feedback
+
+````bash
+$ curate -v
+````
+
+You can always get help with
+
+```
+$ curate help
+
+Commands:
+  curate help [COMMAND]  # Describe available commands or one specific command
+  curate install         # Installs all units in collection.
+
+Options:
+  v, [--verbose], [--no-verbose]
+  q, [--quiet], [--no-quiet]
+      [--debug], [--no-debug]
+```
+
+### 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).
+
 ## Installation
 
+You can install the gem either with Bundler or directly.
+Bundler is preferred, however the direct method may be convenient
+when initially bootstrapping a system with an initial configuration.
+
+The recommend setup is to check your configuration
+along with `manifest.yml` into version control.
+
 Add this line to your application's Gemfile:
 
 ````ruby
@@ -42,14 +228,6 @@ YARD documentation for all gem versions is hosted on the
 Documentation for the latest commits is hosted on
 [the RubyDoc.info project page](http://rubydoc.info/github/razor-x/config_curator/frames).
 
-## Usage
-
-### 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).
-
 ## Development and Testing
 
 ### Source Code

data/lib/config_curator/units/component.rb

@@ -36,7 +36,7 @@ module ConfigCurator
     def install_component
       if command? 'rsync'
         FileUtils.mkdir_p destination_path
-        cmd = [command?('rsync'), '-rt', '--del', "#{source_path}/", destination_path]
+        cmd = [command?('rsync'), '-rt', '--del', '--links', "#{source_path}/", destination_path]
         logger.debug { "Running command: #{cmd.join ' '}" }
         system(*cmd)
       else

data/lib/config_curator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_curator
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Evan Boyd Sosenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-14 00:00:00.000000000 Z
+date: 2015-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport