config_curator 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 739cd145342395af3f9bd1629d26006d80d92095
-  data.tar.gz: f34cd95e0a71591d16f01dfef21c3dc7a191bd0d
+  metadata.gz: e025bf5875775d284843dd093df45960f282e908
+  data.tar.gz: 942b7ecffe91f214959dcccbbfaf88fd56c46249
 SHA512:
-  metadata.gz: b3fb7a5b09056a397cda636f7975384b023a3012f65f0ca86f3408078faf0634512d0a2b30b37899d41ad23d96384d443c9e10fb904cb8946baac044e0ced7fb
-  data.tar.gz: e2e1ee6b3cf5e4e185fc2ba4e2a9259eeae9f176470539fdf040bf2511d0bd80293d660a9fc2705decc4947350b40707d2daa14ce81a97555447c4da70dae680
+  metadata.gz: 6456369212a86c78383e814acf404770dcb96719b935bd8f1b88f87a9d65f00c517343846e03c552e36944ca226bcf7444e3f29280866ef66e64d76d88745780
+  data.tar.gz: 1c49c2541f670186678b071d3c307bcfa7a73344d3224a655ff5be6302317ed0c3dd4d4d132309bc8d329ee13fb5bc75e465c4d9103a744ed3e701a875ce828b

data/README.md

@@ -30,6 +30,7 @@ Or install it yourself as:
 ````bash
 $ gem install config_curator
 ````
+
 ## Documentation
 
 The primary documentation for Config Curator is this README and the YARD source documentation.
@@ -41,6 +42,12 @@ Documentation for the latest commits is hosted on
 
 ## 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).
+
 ## Source Repository
 
 The [Config Curator source](https://github.com/razor-x/config_curator)
@@ -53,6 +60,10 @@ $ git clone https://github.com/razor-x/config_curator.git
 
 ## Contributing
 
+Please submit and comment on bug reports and feature requests.
+
+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'`).

data/lib/config_curator/cli.rb

@@ -3,8 +3,11 @@ require 'thor'
 
 module ConfigCurator
 
+  # Thor class for the `curate` command.
   class CLI < Thor
 
+    default_task :install
+
     class_option :verbose, type: :boolean, aliases: %i(v)
     class_option :quiet, type: :boolean, aliases: %i(q)
     class_option :debug, type: :boolean

data/lib/config_curator/collection.rb

@@ -4,6 +4,9 @@ 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.
@@ -108,7 +111,7 @@ module ConfigCurator
     # @return [Unit] the unit object of the appropriate subclass
     def create_unit type, attributes: {}
       options = {}
-      %i(root).each do |k|
+      %i(root package_tool).each do |k|
         options[k] = manifest[k] unless manifest[k].nil?
       end if manifest
 

data/lib/config_curator/package_lookup.rb

@@ -3,6 +3,13 @@ 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.
+  # @example Lookup a package
+  #   PackageLookup.new.installed? 'ruby' #=> true
+  # @example Lookup a package using `pacman`
+  #   PackageLookup.new(tool: :pacman).installed? 'ruby' #=> true
   class PackageLookup
 
     # Error when a package lookup cannot be completed.

data/lib/config_curator/unit.rb

@@ -3,6 +3,9 @@ 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
 
     # Error if the unit will fail to install.

data/lib/config_curator/units/component.rb

@@ -2,11 +2,15 @@ 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
+    # (see Unit#install)
     def install
       s = super
       return s unless s
@@ -16,7 +20,7 @@ module ConfigCurator
       true
     end
 
-    # @see Unit#install?
+    # (see Unit#install?)
     def install?
       s = super
       return s unless s

data/lib/config_curator/units/config_file.rb

@@ -1,25 +1,26 @@
 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.
-    # @see Unit#source
+    # (see Unit#source)
     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
     end
 
-    # Use {#source} by default.
-    # @see Unit#destination
+    # (see Unit#destination)
+    # @note Use {#source} by default.
     def destination
       super
       @destination ||= source
     end
 
-    # @see Unit#install
+    # (see Unit#install)
     def install
       s = super
       return s unless s
@@ -29,7 +30,7 @@ module ConfigCurator
       true
     end
 
-    # @see Unit#install?
+    # (see Unit#install?)
     def install?
       s = super
       return s unless s

data/lib/config_curator/units/symlink.rb

@@ -1,8 +1,11 @@
 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
+    # (see Unit#install)
     def install
       s = super
       return s unless s
@@ -10,7 +13,7 @@ module ConfigCurator
       true
     end
 
-    # @see Unit#install?
+    # (see Unit#install?)
     def install?
       s = super
       return s unless s

data/lib/config_curator/version.rb

@@ -1,4 +1,4 @@
 module ConfigCurator
   # Config Curator version.
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/collection_spec.rb

@@ -84,6 +84,7 @@ describe ConfigCurator::Collection do
       let(:manifest) do
         YAML.load <<-EOF
           :root: /tmp
+          :package_tool: :pacman
           :defaults:
             :fmode: '0640'
             :dmode: '0750'
@@ -100,6 +101,10 @@ describe ConfigCurator::Collection do
         expect(unit.options[:root]).to eq manifest[:root]
       end
 
+      it "sets the unit's package tool" do
+        expect(unit.options[:package_tool]).to eq manifest[:package_tool]
+      end
+
       it "sets the unit specific attributes" do
         expect(unit.dmode).to eq '0700'
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_curator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Evan Boyd Sosenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-09 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport