chef-steel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0347e49b84d3e3d0e0075ce03507cbff50721da7
+  data.tar.gz: 289cfe57544a0f38d6ea7135f04a651a9055d39d
+SHA512:
+  metadata.gz: 27be27899ebd28569bd4fe2527066d7e09eae74e48c4cf65e215415ccadeb53f735e1b1cea681236a7a9b53363f00c37983b1cced34362547c558e008556755c
+  data.tar.gz: 9806a3bcc0a3a19b157179892792171df82f8f49ba81da29fbc0aa469831da06a2e94892aa9ae5a7ae444134bd5d7ac5a87a551324cc8ea8371bc31854c372a2

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ryan Frantz
+
+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 the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+# chef-steel
+A tool to keep testing-related configurations up-to-date
+
+## See `chef-steel` in Action!
+
+[![asciicast](https://asciinema.org/a/140663.png)](https://asciinema.org/a/140663)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/steel

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+chef_steel_lib = File.expand_path(File.join(File.dirname(__FILE__), "..", "lib"))
+$:.unshift(chef_steel_lib)
+require "chef/steel/runner"
+
+Chef::Steel::Runner.new.run

data/chef-steel.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "chef/steel/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "chef-steel"
+  spec.version       = Chef::Steel::VERSION
+  spec.authors       = ["Ryan Frantz"]
+  spec.email         = ["ryanleefrantz@gmail.com"]
+
+  spec.summary       = %q{A tool to keep testing-related configurations up-to-date}
+  spec.description   = <<-EOD
+    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.
+  EOD
+  spec.homepage      = 'https://github.com/RyanFrantz/chef-steel'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'choice', '~> 0.2', '>= 0.2.0'
+  spec.add_runtime_dependency 'colorize', '~> 0.8', '>= 0.8.1'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/chef/steel.rb

@@ -0,0 +1,6 @@
+require "chef/steel/version"
+
+module Chef
+  module Steel
+  end
+end

data/lib/chef/steel/exceptions.rb

@@ -0,0 +1,11 @@
+module Chef
+	module Steel
+
+  	class MissingConfigFile < StandardError
+  	end
+
+  	class NotInAGitRepository < StandardError
+  	end
+
+	end
+end

data/lib/chef/steel/filetools.rb

@@ -0,0 +1,33 @@
+require 'chef/steel/logger'
+require 'digest'
+
+module Chef
+  module Steel
+    module FileTools
+
+      include Chef::Steel::Logger
+
+      # Compare two files' digests to determine if they're the same file.
+      # Returns true/false based on the comparison of digest strings.
+      def same_file?(local_file, remote_file)
+        local_digest = Digest::SHA256.file(local_file).hexdigest
+        remote_digest = Digest::SHA256.file(remote_file).hexdigest
+        local_digest == remote_digest
+      end
+
+      # Copy a file from its source to its destination.
+      def copy_file(src, dst)
+        FileUtils.cp(src, dst)
+      end
+
+      # Remove the temporary directory using a naive guard to ensure we're
+      # deleting what we expect.
+      def clean_up(tmp_dir)
+        info "\nCleaning up temporary directory '#{tmp_dir}"
+        re_tmp_dir = Regexp.new('chef-steel')
+        FileUtils.rm_rf(tmp_dir) if tmp_dir.match(re_tmp_dir)
+      end
+
+    end
+  end
+end

data/lib/chef/steel/git.rb

@@ -0,0 +1,30 @@
+require 'chef/steel/logger'
+
+module Chef
+  module Steel
+    module Git
+
+      include Chef::Steel::Logger
+
+      # Clone a repo into a given destination. We assume the destination is
+      # a temporary directory.
+      def git_clone(repo, destination)
+        result = `git clone -q #{repo} #{destination}`
+        if $?.exitstatus != 0
+          error "Failed to clone #{repo} into #{destination} (Exit status: #{$?.exitstatus})!"
+          error "Result: #{result}" unless result.empty?
+          exit $?.exitstatus
+        end
+      end
+
+      def git_diff(local_file, remote_file)
+        result = `git diff --color=always #{local_file} #{remote_file}`
+        log ""
+        result.split("\n").each do |line|
+          raw_log "\t" + line
+        end
+      end
+
+    end
+  end
+end

data/lib/chef/steel/logger.rb

@@ -0,0 +1,38 @@
+module Chef
+  module Steel
+    module Logger
+
+      require 'colorize'
+
+			# Print the raw string (including escape sequences, if any).
+      def raw_log(msg = '')
+        puts msg
+      end
+
+      def prompt(msg = '')
+        print msg
+      end
+
+      def info(msg = '')
+        log(msg, :green)
+      end
+
+      def notice(msg = '')
+        log(msg, :light_magenta)
+      end
+
+      def warn(msg = '')
+        log(msg, :yellow)
+      end
+
+      def error(msg = '')
+        log(msg, :red)
+      end
+
+      def log(msg = '', color = nil)
+        puts msg.colorize(color)
+      end
+
+    end
+  end
+end

data/lib/chef/steel/runner.rb

@@ -0,0 +1,216 @@
+require 'chef/steel/git'
+require 'chef/steel/exceptions'
+require 'chef/steel/filetools'
+require 'chef/steel/logger'
+require 'chef/steel/version'
+require 'choice'
+require 'tmpdir' # Extends Dir
+require 'yaml'
+
+module Chef
+  module Steel
+    class Runner
+
+      include Chef::Steel::FileTools
+      include Chef::Steel::Git
+      include Chef::Steel::Logger
+
+      def initialize
+        @config = config
+        @clone_destination = nil # Wait until we need it...
+        @file_candidates = nil # Wait until we need it...
+      end
+
+      # Validate we're in a git repo. If not, we likely don't want to do anything.
+      def validate_in_repo
+        unless File.exist?('.git')
+          raise NotInAGitRepository, "We don't appear to be inside a Git repository!"
+        end
+      end
+
+      # A hash of values describing our config.
+    	def config
+    	  @config ||= {}
+    	end
+
+      # An array of path names for files that are candidates for being copied.
+    	def file_candidates
+    	  @file_candidates ||= []
+    	end
+
+      # Create a temporary directory to clone the repo into.
+      def clone_destination
+        @clone_destination ||= Dir.mktmpdir('chef-steel-')
+      end
+
+      # Look for and parse steel.yml.
+      # Supports a global and local config (in the repo).
+      # Order matters with latter configs' definitions overriding
+      # previous configs' values.
+      def parse_config
+        %w(/etc/steel/steel/yml steel.yml).each do |cfg|
+          if File.exist?(cfg)
+            begin
+              y = YAML.load_file(cfg)
+            rescue Psych::SyntaxError => e
+              error "[#{e.class}] Failed to parse '#{cfg}'!!"
+              error e.message
+              exit 1
+            end
+            # Merge the contents of the config into @config.
+            config.merge!(y)
+          end
+        end
+      end
+
+      # Command line options.
+      def parse_options
+        Choice.options do
+          header ''
+          header 'Hone your tools!'
+          header ''
+          header 'Options:'
+
+          default_xfiles = %w(
+            .gitignore
+            Policyfile.rb
+            README.md
+            metadata.rb
+          )
+          option :exclude_files do
+            short '-e'
+            long  '--exclude-files *XFILES' # Yeah, XFILES!
+            desc  'One or more explicit file names (space-separated) to *exclude* from being copied from the repo'
+            desc  'Ex. -e README.md'
+            desc  'Ex. --exclude-files README.md metadata.rb'
+            desc  "Default: #{default_xfiles.to_s}"
+            default default_xfiles
+          end
+
+          option :files do
+            short '-f'
+            long  '--files *FILES'
+            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)'
+          end
+
+          option :repo do
+            short '-r'
+            long  '--repo'
+            desc  'The full URL of a repo containing config files to clone'
+          end
+
+          option :version do
+            short '-v'
+            long  '--version'
+            desc  'Show version and exit'
+            action do
+              puts "chef-steel v#{Chef::Steel::VERSION}"
+              exit
+            end
+          end
+
+          option :answer_yes do
+            short '-y'
+            long  '--yes'
+            desc  'Answer "yes" to all prompts'
+            desc  'Default: false'
+            default false
+          end
+
+          footer ''
+        end
+        # Merge command line options on top of the config values.
+        # Command line option win. Every. Time.
+        config.merge!(Choice.choices)
+      end
+
+      # After we've parsed the config and command line options, let's
+      # ensure the final config includes a minimal set of options.
+      def validate_config
+        if config['repo'].nil? || !config['repo'].is_a?(String) || config['repo'].empty?
+          error "No 'repo' value found in 'steel.yml' or on the command line!"
+          error "Which repo would you like to pull files from?"
+          Choice.help
+          exit 2
+        end
+      end
+
+      # Locate potential files at the top of the directory.
+      # We won't traverse into any subdirectories.
+      # use Dir.glob rather than Find.find as the latter doesn't
+      # 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.
+          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
+      end
+
+      # Copy files from the cloned repo into this local repo.
+      def copy_files
+        file_candidates.each do |remote_file|
+          local_file = File.basename(remote_file)
+          if File.exist?(local_file)
+            if same_file?(local_file, remote_file)
+              info "\n>> '#{local_file}' has the same contents here as in the repo. Leaving it alone."
+            else
+              if config['answer_yes']
+                warn "\n>> '#{local_file}' is different than its counterpart in the repo."
+                info "Copying #{remote_file} to #{local_file}... (answer_yes is true)"
+                copy_file(remote_file, local_file)
+              else
+                warn "\n>> '#{local_file}' is different than its counterpart in the repo (see below)"
+                git_diff(local_file, remote_file)
+                prompt "\nDo you want to overwrite #{local_file} with the version from the repo? [y/N]: "
+
+                answer = $stdin.gets.chomp
+                case answer
+                when ''
+                  error 'Moving on.' # Default behavior.
+                when /y/i
+                  info "Copying #{remote_file} to #{local_file}..."
+                  copy_file(remote_file, local_file)
+                when /n/i
+                  error 'Moving on.'
+                else
+                  error 'Unknown selection. Moving on.'
+                end
+              end
+
+            end
+          else
+            info "\n>> '#{local_file}' does not exist locally."
+            info "Copying #{remote_file} to #{local_file}..."
+            copy_file(remote_file, local_file)
+          end
+        end
+      end
+
+      def run
+        validate_in_repo
+        parse_config
+        parse_options
+        validate_config
+
+        # Do work, son.
+        repo = config['repo']
+        log "\nCloning #{repo} into #{clone_destination}..."
+        git_clone(repo, clone_destination)
+        find_top_files(clone_destination)
+        copy_files
+        clean_up(clone_destination)
+        info "\nAll done!"
+      end
+
+    end
+  end
+end

data/lib/chef/steel/version.rb

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

data/steel.yml.example

@@ -0,0 +1,21 @@
+# chef-steel
+# Define values that instruct steel what to do. These values can be overridden
+# on the command line.
+
+# Set 'repo' to the URL of a repository from which steel will clone and copy
+# top-level files.
+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.
+#answer_yes: true
+
+# 'files' is a list of files that should explicitly be copied.
+#files:
+#    - .rubocop.yml
+#    - Jenkinsfile
+
+# 'exclude_files' is a list of files that should not be copied.
+#exclude_files:
+#    - .gitignore
+#    - .rspec

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: chef-steel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Frantz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      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.
+email:
+- ryanleefrantz@gmail.com
+executables:
+- steel
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/steel
+- chef-steel.gemspec
+- lib/chef/steel.rb
+- lib/chef/steel/exceptions.rb
+- lib/chef/steel/filetools.rb
+- lib/chef/steel/git.rb
+- lib/chef/steel/logger.rb
+- lib/chef/steel/runner.rb
+- lib/chef/steel/version.rb
+- steel.yml.example
+homepage: https://github.com/RyanFrantz/chef-steel
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A tool to keep testing-related configurations up-to-date
+test_files: []