bashman 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4406bc629855c0f569157e3d2e64541d461d9578199624f1c2fb4f2c8bfa39fc
+  data.tar.gz: 2d8913b0a9ab19edfc13033de62c5260606bb4d2b5db61612822efaaac11e049
+SHA512:
+  metadata.gz: 3ce0ffd9156b146c180e948c795c597a203c5132e07e6ee224adf19fe19033f472a2f1f808c02a9ec30278d6bac354b791b14c1ee68ff0fcbc99c18806843be3
+  data.tar.gz: 7c099849c04b62733c695108f4bf630e85198c00286b616e32a56f657843bc513aa5f2aa1c287628cdf8956fd9c615359a61c127f14c0cc6be39cc7dfd3bb9cd

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in bashman.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 David Bayer
+
+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,53 @@
+# Bashman
+
+A Ruby gem and executable for *nix profile backup.
+
+## Usage
+
+This gem includes the `bashman` executable for managing profiles. 
+
+```
+$ bashman -h
+Usage: bashman [OPTIONS]
+
+    -a, --apply                      Apply saved profile
+    -i, --items homebrew,shell       Shell components to apply or save. Defaults to 'all'.
+    -p, --profile PROFILE            Profile name. Set to 'default' if not specified.
+    -s, --save                       Save profile settings.
+    -v, --verbose                    Turn on verbose messages.
+    -V, --version                    Show version
+    -y, --yes                        Do not ask for confirmation
+    -h, --help                       Show this help message
+ ```
+
+For script development, the gem provides the following classes:
+|Class Name|Purpose|
+|---|---|
+|Profile|Overall user profile container|
+|Profile::HomeBrew|Homebrew information for Mac users|
+|Profile::Shell|General shell items like .profile, .bashrc, etc.|
+
+## Configuration
+Bashman looks for the `~/.bashman/config` file for configuration information. At present the only configuration is for `[shell]` and controls which shell files to include/exclude from the profile backup. Useful for limiting backup to desired configuration items and omitting sensitive and/or unnecessary components like SSH keys.
+
+```
+[shell]
+    exclude = .vim/bundle
+    include = .bash*, .git* .irb*, .iterm2*, .profile*, .vim*
+```
+
+## Development
+
+This is still in very early stages of development and is likely to be buggy. 
+
+This was built as a learning experience that results in something useful at least to me. Because of this I'm sure there is a lot missing that should probably be included, not the least of which would be code tests. If all goes well that will be included in the not too distant future. 
+
+There are plans for adding more functionality, including applying saved profiles back to the current user. 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/drbayer/bashman.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/bashman.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "bashman/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "bashman"
+  spec.version       = Bashman::VERSION
+  spec.authors       = ["David Bayer"]
+  spec.email         = ["drbayer@eternalstench.com"]
+
+  spec.summary       = %q{Bash Profile Manager}
+  spec.description   = %q{Record bash profile files and settings}
+  spec.homepage      = "https://github.com/drbayer/bashman"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+#  if spec.respond_to?(:metadata)
+#    spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+#  else
+#    raise "RubyGems 2.0 or newer is required to protect against " \
+#      "public gem pushes."
+#  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "parseconfig"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bashman"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/bashman

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+require 'bashman'
+require 'optparse'
+
+options = {
+    apply:      false,
+    items:      ['all'],
+    profile:    'default',
+    save:       false,
+    savedir:    '~/.bashman/profiles',
+    verbose:    false,
+    yes:        false
+}
+
+all_items = ['homebrew', 'shell']
+
+opts = OptionParser.new do |o|
+    o.banner = "Usage: #{$0} [OPTIONS]"
+    o.separator ""
+    o.on("-a", "--apply", "Apply saved profile") {|v| options[:apply] = v}
+    o.on("-i", "--items #{all_items.join(',')}", Array, "Shell components to apply or save. Defaults to 'all'.") {|v| options[:items] = v}
+    o.on("-p", "--profile PROFILE", "Profile name. Set to 'default' if not specified.") {|v| options[:profile] = v}
+    o.on("-s", "--save", "Save profile settings.") {|v| options[:save] = v}
+    o.on("-v", "--verbose", "Turn on verbose messages.") {|v| options[:verbose] = v}
+    o.on("-V", "--version", "Show version") do 
+        puts Bashman.version
+        exit
+    end
+    o.on("-y", "--yes", "Do not ask for confirmation") {|v| options[:yes] = v}
+    o.on_tail("-h", "--help", "Show this help message") do
+        puts o
+        exit
+    end
+end
+
+begin
+    opts.parse! ARGV
+    raise OptionParser::MissingArgument, 'PROFILE' if options[:profile].nil?
+    raise OptionParser::InvalidOption, "Exactly one of (--apply, --save) required." if options[:apply] == options[:save]
+
+    options[:items] = all_items if options[:items] == ['all']
+    items = options[:items].dup
+    n = items.count
+    1.upto(n) do 
+        item = items.pop
+        if items.include?(item) or not all_items.include?(item)
+            raise OptionParser::InvalidArgument, 'ITEMS'
+        end
+    end
+rescue => arg_err
+    puts "#{arg_err.message}"
+    puts opts
+    exit
+end
+
+
+profile = Profile.new
+
+### Save profile
+
+if options[:save] then 
+    if options[:items].include?('homebrew')
+        profile.add_homebrew(options[:verbose])
+    end
+
+    if options[:items].include?('shell')
+        profile.add_shell(options[:verbose])
+    end
+
+    if not options[:yes] then
+        puts "Record profile? [Y/n]  "
+        resp = gets.strip.downcase
+        options[:yes] = true if ['y', 'yes', ''].include?(resp)
+    end
+
+    if options[:yes]
+        profile.save(options[:savedir], options[:overwrite], options[:verbose])
+    end
+end
+
+

data/lib/bashman/homebrew.rb

@@ -0,0 +1,35 @@
+
+class Profile::HomeBrew < JSONable
+
+    include Bashman
+
+    attr_reader :casks
+    attr_reader :formulae
+
+    def get_installed
+        @installed = self.installed? if @installed.nil?
+
+        if @installed
+            @casks = self.get_casks
+            @formulae = self.get_formulae
+        end
+    end
+
+    def installed?
+        path = Profile::HomeBrew.which('brew')
+        @installed = path.empty? ? false : true
+        @installed
+    end
+
+    protected
+
+    def get_casks
+        %x(brew cask list).split("\n")
+    end
+
+    def get_formulae
+        %x(brew list).split("\n")
+    end
+
+end
+

data/lib/bashman/shell.rb

@@ -0,0 +1,132 @@
+
+class Profile::Shell < JSONable
+    include Bashman
+
+    CONFIG = self.get_config('shell')
+    BASEPATH = CONFIG.key?("basepath") ? File.expand_path(CONFIG["basepath"]) : File.expand_path("~/")
+    BLOCKSIZE = 1024
+
+    attr_reader :shell
+    attr_reader :dotfiles
+
+    def initialize
+        @shell = self.get_current
+    end
+
+    def get_dotfiles
+        exc = []
+        inc = []
+
+        if CONFIG.include?('exclude')
+            exc = CONFIG['exclude'].split(',').map {|x| x.strip}
+        end
+
+        if CONFIG.include?('include')
+            inc = CONFIG['include'].split(',').map {|x| x.strip}
+        else
+            inc = ["\.[a-zA-Z0-9-_]*"]
+        end
+
+        files = self.add_includes(inc)
+        files = self.remove_excludes(exc, files)
+        files.delete_if {|f| /\.bashman\/profiles/ =~ f}
+
+        @dotfiles = files
+    end
+
+    def save_dotfiles(tarfile, timestamp = nil, overwrite = false)
+        require 'fileutils'
+        
+        savefile = File.expand_path(tarfile)
+        
+        if File.exists?(savefile)
+            if not overwrite
+                timestamp = File.mtime(savefile).to_i if timestamp.nil?
+                bakfile = "#{savefile}.#{timestamp}"
+                File.delete(bakfile) if File.exists?(bakfile)
+                FileUtils.mv(savefile, bakfile)
+            end
+        end
+
+        begin
+            self.tar_gz(BASEPATH, savefile, *@dotfiles)
+        rescue => e
+            puts "Error saving dotfiles:  #{e.message}"
+            puts e.backtrace
+            File.delete(savefile) if File.exists?(savefile)
+            if not bakfile.nil? and File.exists?(bakfile)
+                FileUtils.mv(bakfile, savefile)
+            end
+            return 1
+        end
+
+    end
+    protected
+
+    def get_current
+        ENV['SHELL']
+    end
+
+    def remove_excludes(excludes, files)
+        excludes.each do |e|
+            e.gsub!('.', '\.')
+            e.gsub!('*', '.*')
+            files.delete_if {|f| /#{e}/ =~ f}
+        end
+        files
+    end
+
+    def add_includes(includes)
+        files = []
+        includes.each do |i|
+            files.concat Dir.glob(i, base: BASEPATH)
+        end
+
+        files.dup.each do |f|
+            if File.directory?("#{BASEPATH}/#{f}")
+                files.concat Dir.glob("#{f}/**/*", base: BASEPATH)
+            end
+        end
+       files
+    end
+
+    def tar_gz(path, tarfile, *src)
+        require 'rubygems/package'
+        require 'find'
+        require 'pathname'
+
+        basepath = Pathname.new(BASEPATH)
+        path = Pathname.new(path)
+
+        raise ArgumentError, "Path #{path} should be an absolute path" unless path.absolute?
+        raise ArgumentError, "Path #{path} should be a directory" unless File.directory?(path)
+        raise ArgumentError, "No files/directories found to tar" if !src or src.length == 0
+
+        src.each {|p| p.sub!(/^/, "#{basepath.to_s}/")}
+        File.open(tarfile, "wb") do |tf|
+            Zlib::GzipWriter.wrap(tf) do |gz|
+                Gem::Package::TarWriter.new(gz) do |tar|
+                    src.each do |f|
+                        next if not File.file?(f)
+                        file = Pathname.new(f)
+                        relpath = file.relative_path_from(basepath).to_s
+                        mode = File.stat(f).mode
+                        size = File.stat(f).size
+                        if File.directory?(f)
+                            tar.mkdir(relpath, mode)
+                        else
+                            tar.add_file_simple(relpath, mode, size) do |tio|
+                                File.open(f, "rb") do |rio|
+                                    while buffer = rio.read(BLOCKSIZE)
+                                        tio.write(buffer)
+                                    end
+                                end
+                            end
+                        end
+                    end
+                end
+            end
+        end
+    end
+
+end

data/lib/bashman/version.rb

@@ -0,0 +1,3 @@
+module Bashman
+  VERSION = "0.1.0"
+end

data/lib/bashman.rb

@@ -0,0 +1,157 @@
+
+module Bashman
+    require "bashman/version"
+
+    CONFIG_PATH = File.expand_path('~/.bashman')
+    CONFIG = File.expand_path("#{CONFIG_PATH}/config")
+
+    FileUtils.mkdir_p(CONFIG_PATH) if not Dir.exists?(CONFIG_PATH)
+    FileUtils.touch(CONFIG) if not File.exists?(CONFIG)
+
+    def self.included(base)
+        base.extend(ClassMethods)
+    end
+
+    # make the following functions available in every class
+    module ClassMethods
+        def which(binary)
+            ret = ''
+            possibles = ENV["PATH"].split(File::PATH_SEPARATOR)
+            possibles.map {|p| File.join(p, binary)}.find {|p| ret = p if File.executable?(p)}
+            ret
+        end
+
+        def get_config(section)
+            require 'parseconfig'
+
+            fullconfig = ParseConfig.new(CONFIG)
+            config = {}
+            config = fullconfig[section] if fullconfig.get_params.include?(section)
+            config
+        end
+    end
+
+    def Bashman.version
+        puts Bashman::VERSION
+    end
+
+end
+
+
+class JSONable
+    require 'json'
+
+    def to_hash
+        hash = {}
+        self.instance_variables.each do |var|
+            hash[var] = self.instance_variable_get(var)
+        end
+        hash
+    end
+
+    def to_json
+        hash = self.to_hash
+        hash.to_json
+    end
+
+    def from_json!(string)
+        JSON.load(string).each do |var, val|
+            self.instance_variable_set(var, val)
+        end
+    end
+end
+
+
+# this is me learning how to write ruby gems
+# no idea why, but if I don't put the Profile class
+# in this file things break in spectacular ways
+
+class Profile < JSONable
+    require "bashman/homebrew"
+    require "bashman/shell"
+
+    include Bashman
+
+    attr_reader :homebrew
+    attr_reader :shell
+    attr_reader :name
+
+    def initialize(profile_name = 'default')
+        @name = profile_name
+    end
+
+    def add_homebrew(verbose = false)
+        @homebrew = Profile::HomeBrew.new
+        puts "Looking for Homebrew" if verbose
+        if @homebrew.installed?
+            puts "Homebrew executable found" if verbose
+            puts "Getting installed homebrew packages and casks"
+            @homebrew.get_installed
+            if verbose
+                puts "Found formulae:"
+                @homebrew.formulae.each {|f| puts "  #{f}"}
+                puts "Found casks:"
+                @homebrew.casks.each {|c| puts "  #{c}"}
+            end
+        else
+            puts "Homebrew executable not found"
+        end
+    end
+
+    def add_shell(verbose = false)
+        @shell = Profile::Shell.new
+        puts "Gathering shell components" if verbose
+        puts "Found shell #{@shell.shell}" if verbose
+        puts "Getting files to save" if verbose
+        @shell.get_dotfiles
+        if verbose
+            puts "Found shell files to save:"
+            @shell.dotfiles.each {|d| puts "  #{d}"}
+        end
+    end
+
+    def save(dir = '~/.bashman/profiles', overwrite = false, verbose = false)
+        dir = File.expand_path(dir)
+        FileUtils.mkdir_p(dir) if not Dir.exists?(dir)
+
+        # get the current unix timestamp for later use when 
+        # creating new saved profiles
+        @timestamp = Time.now.to_i
+
+        # get timestamp from manifest in the event we need to back up files
+        manifest = "#{dir}/#{name}.json"
+        puts "Saving manifest file #{manifest}" if verbose
+        timestamp = nil
+        if not overwrite
+            if File.exists?(manifest)
+                begin 
+                    timestamp = JSON.parse(File.read(manifest))['@timestamp']
+                rescue
+                    timestamp = File.mtime(manifest).to_i if timestamp.nil?
+                end
+                FileUtils.mv(manifest, "#{manifest}.#{timestamp}")
+            end
+        end
+
+        # now save shell files and write manifest
+        if instance_variable_defined?("@shell")
+            shell = @shell.to_hash 
+            @shell.save_dotfiles("#{dir}/#{name}.tar.gz", timestamp, overwrite)
+            @shell = shell
+        end
+
+        if instance_variable_defined?("@homebrew")
+            homebrew = @homebrew.to_hash 
+            @homebrew = homebrew
+        end
+
+        manifest_content = self.to_json
+        File.open(manifest, 'w') do |file|
+            file.write(manifest_content)
+        end
+
+    end
+
+end
+
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: bashman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Bayer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parseconfig
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Record bash profile files and settings
+email:
+- drbayer@eternalstench.com
+executables:
+- bashman
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bashman.gemspec
+- bin/console
+- bin/setup
+- exe/bashman
+- lib/bashman.rb
+- lib/bashman/homebrew.rb
+- lib/bashman/shell.rb
+- lib/bashman/version.rb
+homepage: https://github.com/drbayer/bashman
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Bash Profile Manager
+test_files: []