chef-steel 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0347e49b84d3e3d0e0075ce03507cbff50721da7
-  data.tar.gz: 289cfe57544a0f38d6ea7135f04a651a9055d39d
+  metadata.gz: f2057aa9a1c5a8ac12d94ca01bcce96d475baf54
+  data.tar.gz: 29b45285a443fe0a62c5a524f276d8c5f6fac0c1
 SHA512:
-  metadata.gz: 27be27899ebd28569bd4fe2527066d7e09eae74e48c4cf65e215415ccadeb53f735e1b1cea681236a7a9b53363f00c37983b1cced34362547c558e008556755c
-  data.tar.gz: 9806a3bcc0a3a19b157179892792171df82f8f49ba81da29fbc0aa469831da06a2e94892aa9ae5a7ae444134bd5d7ac5a87a551324cc8ea8371bc31854c372a2
+  metadata.gz: 9fd8fd7caf7ee1f1c89b4fd7b4ca41507ce23f0ce515eaf9f53ca3e0e6ea43d7c146e40e1d661a168bea95b8354fbc0d5ebcb58b77c51aa0d1fb215ac605613f
+  data.tar.gz: 2ead2883757812f0c34e320982b5f5902a8badf8a9622eb9e5011ba1632e239369f68da9437cd7007453c6bdfdcba49f153f5b1be47119f490452452353fd998

data/README.md

@@ -1,5 +1,54 @@
 # chef-steel
-A tool to keep testing-related configurations up-to-date
+
+Hone your tools with chef-steel!
+
+`chef-steel` is a tool that can keep testing-related configurations up-to-date
+within one or more repos. If you work within many different repos that share
+a common set of testing tools (i.e. Rubocop, Foodcritic, Travis, Jenkins, etc.)
+it can be easy for their configuration to drift. With `chef-steel` you can
+update one or more of these configuration files from a central repository,
+as needed.
+
+**NOTE**: This tool ain't just for Chef developers! Use it for *any* repo whose
+testing-related configurations you want to keep up-to-date.
+
+## Installing `chef-steel`
+
+To begin honing your tools, install `chef-steel` via `gem`:
+
+`gem install chef-steel`
+
+## `chef-steel` Usage
+
+```
+[ryanleefrantz@remington ~/git/chef-steel] (master) $ steel -h
+Usage: steel [-efrvy]
+
+Hone your tools!
+
+Options:
+    -e, --exclude-files *XFILES      One or more explicit file names (space-separated) to *exclude* from being copied from the repo
+                                     Ex. -e README.md
+                                     Ex. --exclude-files README.md metadata.rb
+                                     Default: [".gitignore", "Policyfile.rb", "README.md", "metadata.rb"]
+    -f, --files *FILES               One or more explicit file names (space-separated) to copy from the repo
+                                     Ex. -f .rubocop.yml
+                                     Ex. --files .rubocop.yml .rspec
+                                     Default: All top-level files in the repo (excluding the value if --exclude-files)
+    -r, --repo                       The full URL of a repo containing config files to clone
+    -v, --version                    Show version and exit
+    -y, --yes                        Answer "yes" to all prompts
+                                     Default: false
+```
+
+`chef-steel` has a few command line options. See above for the help output.
+
+Each of the command line options can be defined in a config file (command line
+options always take precedence). `chef-steel` will look for `/etc/steel/steel.yml`
+and `./steel.yml`, in that order, applying configuration values in a last-defined-wins
+manner.
+
+See [steel.yml.example](/steel.yml.example) for more details.
 
 ## See `chef-steel` in Action!
 

data/lib/chef/steel/runner.rb

@@ -29,14 +29,14 @@ module Chef
       end
 
       # A hash of values describing our config.
-    	def config
-    	  @config ||= {}
-    	end
+      def config
+        @config ||= {}
+      end
 
       # An array of path names for files that are candidates for being copied.
-    	def file_candidates
-    	  @file_candidates ||= []
-    	end
+      def file_candidates
+        @file_candidates ||= []
+      end
 
       # Create a temporary directory to clone the repo into.
       def clone_destination
@@ -48,7 +48,7 @@ module Chef
       # Order matters with latter configs' definitions overriding
       # previous configs' values.
       def parse_config
-        %w(/etc/steel/steel/yml steel.yml).each do |cfg|
+        %w(/etc/steel/steel.yml steel.yml).each do |cfg|
           if File.exist?(cfg)
             begin
               y = YAML.load_file(cfg)
@@ -72,11 +72,8 @@ module Chef
           header 'Options:'
 
           default_xfiles = %w(
-            .gitignore
-            Policyfile.rb
-            README.md
-            metadata.rb
           )
+
           option :exclude_files do
             short '-e'
             long  '--exclude-files *XFILES' # Yeah, XFILES!
@@ -93,7 +90,7 @@ module Chef
             desc  'One or more explicit file names (space-separated) to copy from the repo'
             desc  'Ex. -f .rubocop.yml'
             desc  'Ex. --files .rubocop.yml .rspec'
-            desc  'Default: All top-level files in the repo (excluding the value if --exclude-files)'
+            desc  'Default: All top-level files in the repo (excluding the value of --exclude-files)'
           end
 
           option :repo do
@@ -144,15 +141,15 @@ module Chef
       # provide a native way to minimize depth (like the `find` command).
       # File::FNM_DOTMATCH is handy flag that surfaces dotfiles.
       def find_top_files(clone_destination)
-        globule = File.join(clone_destination, '*') # Define a variable here to the next line is legible.
-				Dir.glob(globule, File::FNM_DOTMATCH).each do |path|
-					next if File.directory?(path) # Should omit '.' and '..' as well.
+        globule = File.join(clone_destination, '*') # Define a variable here so the next line is legible.
+        Dir.glob(globule, File::FNM_DOTMATCH).each do |path|
+          next if File.directory?(path) # Should omit '.' and '..' as well.
           next if config['exclude_files'].include? File.basename(path)
           unless config['files'].nil? || config['files'].empty?
             next unless config['files'].include? File.basename(path)
           end
-					file_candidates << path
-				end
+          file_candidates << path
+        end
       end
 
       # Copy files from the cloned repo into this local repo.

data/lib/chef/steel/version.rb

@@ -1,5 +1,5 @@
 module Chef
   module Steel
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/steel.yml.example

@@ -4,18 +4,23 @@
 
 # Set 'repo' to the URL of a repository from which steel will clone and copy
 # top-level files.
+# Command line option: -r, --repo
 repo: git@github.com:RyanFrantz/chef-testing-configs.git
 #repo: https://github.com/RyanFrantz/chef-testing-configs.git
 
 # Set 'answer_yes' to true to perform any operation that steel would normally prompt for.
+# Command line option: -y, --yes
+# Default is false.
 #answer_yes: true
 
 # 'files' is a list of files that should explicitly be copied.
+# Command line option: -f, --files
 #files:
 #    - .rubocop.yml
 #    - Jenkinsfile
 
 # 'exclude_files' is a list of files that should not be copied.
+# Command line option: -e, --exclude-files
 #exclude_files:
 #    - .gitignore
 #    - .rspec

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-steel
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryan Frantz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2018-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: choice