swappy 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c3e0276f5fca1482a5c899ade8efcf1ae6d4c30c
+  data.tar.gz: df71cd71206ce6f64eb0ef393a5e9f38d9a1a3c1
+SHA512:
+  metadata.gz: 747cb60c9dadb4969acac742eea16f3a77ee92aa7647848a849a21bac3e116220b672723d819533f81a15be6475eb367fc167c5134a3505f681653687d346971
+  data.tar.gz: b2d36aec01b2d855ad13a68d90de2e3e0b2a143e84bb5ec625310c3b37486c97c90122a18479e73cfe00d6acee7cce7f1afc6abffba79c629dd5b24d70e874f8

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swappy.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joshua Rieken
+
+MIT License
+
+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,66 @@
+# Swappy
+
+Swappy lets you easily swap between config file sets.
+
+## Use Cases
+
+* You have, for instance, 2 different .vimrc files that you switch back and forth between depending on the circumstances. It doesn't have to be .vimrc files; it can be *any* config file. In fact, it doesn't even have to be a config file, it can be *any file*—even multiple files!
+* You want to take someone's dotfiles out for a spin, and easily switch back to yours.
+
+## Installation
+
+`gem install swappy`
+
+Run `swappy --help` as a sanity check.
+
+## Example
+
+Put this `.swappy.json` config file in your `~`:
+
+    {
+      "config_sets": {
+        "vim_heavy": {
+          "link_root": "~",
+          "source_root": "~/.config_sets/vim_heavy",
+          "configs": {
+            ".vimrc": "vimrc"
+          }
+        },
+        "vim_minimalist": {
+          "link_root": "~",
+          "source_root": "~/.config_sets/vim_minimalist",
+          "configs": {
+            ".vimrc": "vimrc"
+          }
+        }
+      }
+    }
+
+This file has two config sets:
+
+* **vim_heavy** (files live in `~/.config_sets/vim_heavy`)
+* **vim_minimalist** (files live in `~/.config_sets/vim_minimalist`)
+
+You can verify these are configured correctly by running `swappy list`. You should see:
+
+    vim_heavy
+    vim_minimalist
+
+When you issue the command `swappy swap vim_heavy`, `~/.vimrc` will now be a symbolic link to `~/.config_sets/vim_heavy/vimrc`.
+
+"**BUT WAIT!**", you say, "**What happens if I already have a `.vimrc` in my `~`?**" I'm glad you asked. Swappy will back it up within the same directory. The backup file will be named with a timestamp, like this:
+
+    .vimrc.backup.1399229001
+
+Even your symlinks will be backed up!
+
+This effectively means that a history of your swaps will be stored within the same directory.
+
+## Contributing
+
+1. Fork it ( http://github.com/facto/swappy/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write code (don't forget the tests!)
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/swappy

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'swappy/cli'
+Swappy::CLI.new(ARGV).run

data/lib/swappy.rb

@@ -0,0 +1,20 @@
+require 'pathname'
+require 'oj'
+
+require 'swappy/version'
+
+module Swappy
+  APP_ID = 'swappy'
+  APP_NAME = 'Swappy'
+  VERSION_COPYRIGHT = "v#{VERSION} \u00A9 #{Time.now.year}"
+
+  autoload :Config, 'swappy/config'
+  autoload :ConfigSet, 'swappy/config_set'
+  autoload :AppConfig, 'swappy/app_config'
+
+  module Commands
+    autoload :Command, 'swappy/commands/command'
+    autoload :List, 'swappy/commands/list'
+    autoload :Swap, 'swappy/commands/swap'
+  end
+end

data/lib/swappy/app_config.rb

@@ -0,0 +1,44 @@
+module Swappy
+  class AppConfig
+    include Enumerable
+
+    attr_reader :options, :path
+
+    def initialize(options={})
+      @options = options
+      @path = options[:path]
+    end
+
+    def config_sets
+      @config_sets ||= json_config_sets.map { |config_set| ConfigSet.new(config_set) }
+    end
+
+    def each(&block)
+      each_config_set(&block)
+    end
+
+    def each_config_set(&block)
+      config_sets.each do |config_set|
+        block.call(config_set)
+      end
+    end
+
+    def find_config_set_by_name(name)
+      config_sets.find { |set| set.name == name }
+    end
+
+    protected
+
+    def app_config_content
+      @app_config_content ||= File.read(File.expand_path(path))
+    end
+
+    def app_config_json_content
+      @app_config_json_content ||= Oj.load(app_config_content)
+    end
+
+    def json_config_sets
+      app_config_json_content['config_sets']
+    end
+  end
+end

data/lib/swappy/cli.rb

@@ -0,0 +1,67 @@
+require 'rubygems'
+require 'swappy'
+require 'trollop'
+
+module Swappy
+  class CLI
+    attr_reader :cmd
+
+    COMMANDS = %w(
+      list
+      swap
+    )
+
+    def initialize(args)
+      Trollop::options do
+        version VERSION_COPYRIGHT
+        banner <<-EOS
+#{APP_NAME} #{VERSION_COPYRIGHT}
+
+Usage:
+  #{APP_ID} [command]
+
+  commands:
+#{COMMANDS.map { |command| "    #{command}" }.join("\n") }
+        EOS
+        stop_on COMMANDS
+      end
+
+      @cmd = ARGV.shift
+      case cmd
+      when 'list'
+      when 'swap'
+        Trollop::die 'must provide a config set name' if ARGV.empty?
+      else
+        Trollop::die "unknown command"
+      end
+    end
+
+    def run
+      send(cmd)
+    end
+
+  protected
+
+    def swap
+      command = Swappy::Commands::Swap.new(name: config_set_name, app_config_path: app_config_path)
+      command.call
+    rescue Swappy::Commands::Swap::ConfigSetNotFoundError
+      config_sets = Swappy::Commands::List.new.call.join(', ')
+      Trollop::die "unknown config set #{config_set_name}; must be one of #{config_sets}"
+    end
+
+    def list
+      command = Swappy::Commands::List.new(app_config_path: app_config_path)
+      sets = command.call
+      sets.each { |set| puts set }
+    end
+
+    def config_set_name
+      @config_set_name ||= ARGV.shift
+    end
+
+    def app_config_path
+      File.join(Dir.home, '.swappy.json')
+    end
+  end
+end

data/lib/swappy/commands/command.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module Swappy
+  module Commands
+    class Command
+      extend Forwardable
+
+      attr_reader :options, :app_config_path
+
+      def initialize(options={})
+        @options         = options
+        @app_config_path = options[:app_config_path]
+      end
+
+      protected
+
+      def app_config
+        @app_config ||= AppConfig.new(path: app_config_path)
+      end
+    end
+  end
+end

data/lib/swappy/commands/list.rb

@@ -0,0 +1,11 @@
+module Swappy
+  module Commands
+    class List < Command
+      def call
+        app_config.map do |config_set|
+          config_set.name
+        end
+      end
+    end
+  end
+end

data/lib/swappy/commands/swap.rb

@@ -0,0 +1,55 @@
+module Swappy
+  module Commands
+    class Swap < Command
+      ConfigSetNotFoundError = Class.new(StandardError)
+
+      attr_reader :name
+
+      def_delegators :config_set, :link_root, :source_root, :configs
+
+      def initialize(options={})
+        super options
+        @name = options[:name]
+        raise ConfigSetNotFoundError unless config_set
+      end
+
+      def call
+        switch_to_config_set
+      end
+
+      private
+
+      def switch_to_config_set
+        puts "Switching to config set #{config_set.name}..."
+        config_set.each do |config|
+          backup(config.link_path)
+          link(config.source_path, config.link_path)
+        end
+        puts "Done!"
+      end
+
+      def backup(link_path)
+        if File.exists?(link_path)
+          backup_path = backup_path(link_path)
+          puts "backing up #{File.symlink?(link_path) ? 'symlink ' : ' '}#{link_path} to #{backup_path}"
+          File.rename(link_path, backup_path)
+        end
+      end
+
+      def link(source_path, link_path)
+        puts "linking #{link_path} to #{source_path}"
+        File.symlink(source_path, link_path)
+      end
+
+      def config_set
+        @config_set ||= app_config.find_config_set_by_name(name)
+      end
+
+      def backup_path(link_path)
+        timestamp = Time.now.to_i.to_s
+        new_basename = "#{File.basename(link_path)}.backup.#{timestamp}"
+        Pathname.new(File.join(File.dirname(link_path), new_basename))
+      end
+    end
+  end
+end

data/lib/swappy/config.rb

@@ -0,0 +1,27 @@
+module Swappy
+  class Config
+    attr_reader :json_data, :link_root, :source_root
+
+    def initialize(json_data, link_root, source_root)
+      @link_root = link_root
+      @source_root = source_root
+      @json_data = json_data
+    end
+
+    def link_file
+      json_data[0]
+    end
+
+    def source_file
+      json_data[1]
+    end
+
+    def link_path
+      File.expand_path(File.join(link_root, link_file))
+    end
+
+    def source_path
+      File.expand_path(File.join(source_root, source_file))
+    end
+  end
+end

data/lib/swappy/config_set.rb

@@ -0,0 +1,39 @@
+module Swappy
+  class ConfigSet
+    include Enumerable
+
+    attr_reader :json_data
+
+    def initialize(json_data)
+      @json_data = json_data
+    end
+
+    def each(&block)
+      configs.each do |config|
+        block.call(config)
+      end
+    end
+
+    def name
+      json_data[0]
+    end
+
+    def link_root
+      properties['link_root']
+    end
+
+    def source_root
+      properties['source_root']
+    end
+
+    def configs
+      @configs ||= properties['configs'].map { |config| Config.new(config, link_root, source_root) }
+    end
+
+    protected
+
+    def properties
+      json_data[1]
+    end
+  end
+end

data/lib/swappy/version.rb

@@ -0,0 +1,3 @@
+module Swappy
+  VERSION = '0.2.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+begin
+  require 'pry'
+rescue LoadError
+end
+
+require 'swappy'
+
+Dir[File.join(File.dirname(__FILE__), 'fixtures/**/*.rb')].each do |fixture|
+  require fixture
+end
+
+RSpec.configure do |config|
+end

data/spec/swappy/app_config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Swappy::AppConfig do
+  let(:options) do
+    {
+      path: path
+    }
+  end
+
+  let(:path) { 'some_path' }
+
+  let(:app_config) { described_class.new(options) }
+
+  it 'includes Enumerable' do
+    expect(app_config).to respond_to(:each)
+  end
+
+  describe '#initialize' do
+    it 'sets the path' do
+      expect(app_config.path).to eql(path)
+    end
+  end
+
+  describe '#config_sets' do
+    let(:json_config_sets) { ['1','2'] }
+
+    it 'returns the config sets'
+  end
+end

data/spec/swappy/commands/command_sharedspec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+shared_examples_for 'a command' do
+  it 'extends forwardable' do
+    expect(described_class).to respond_to(:def_delegator)
+  end
+end

data/spec/swappy/commands/list_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+require_relative './command_sharedspec'
+
+describe Swappy::Commands::List do
+  it_should_behave_like 'a command'
+
+  let(:list_command) { subject }
+
+  describe '#call' do
+    let(:config_sets) { ['awesome', 'cool', 'bleh'] }
+
+    it 'returns the config sets' do
+      app_config = double('app_config')
+      expect(app_config).to receive(:map).and_return(config_sets)
+      expect(list_command).to receive(:app_config).and_return(app_config)
+      list_command.call
+    end
+  end
+end

data/spec/swappy/commands/swap_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require_relative './command_sharedspec'
+
+describe Swappy::Commands::Swap do
+  it_should_behave_like 'a command'
+
+  describe '#initialize' do
+    let(:options) do
+      {
+        name: name
+      }
+    end
+
+    let(:name) { 'awesome_config_set' }
+
+    let(:swap_command) { described_class.new(options) }
+
+    context 'with an existing matching config set' do
+      let(:config_set) { double('config_set') }
+
+      before :each do
+        allow_any_instance_of(described_class).to receive(:config_set).and_return(config_set)
+      end
+
+      it 'sets the name' do
+        expect(swap_command.name).to eql(name)
+      end
+    end
+
+    context 'with no config set' do
+      before :each do
+        allow_any_instance_of(described_class).to receive(:config_set).and_return(nil)
+      end
+
+      it 'raises ConfigSetNotFoundError if the config set is not found' do
+        expect { swap_command }.to raise_error(described_class::ConfigSetNotFoundError)
+      end
+    end
+  end
+end

data/swappy.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swappy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'swappy'
+  spec.version       = Swappy::VERSION
+  spec.authors       = ['Joshua Rieken']
+  spec.email         = ['joshua@joshuarieken.com']
+  spec.description   = %q{Swap your config files with ease}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/facto/swappy'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'ruby_gntp'
+
+  spec.add_dependency 'oj', '~> 2'
+  spec.add_dependency 'trollop', '~> 2'
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: swappy
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Joshua Rieken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_gntp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Swap your config files with ease
+email:
+- joshua@joshuarieken.com
+executables:
+- swappy
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/swappy
+- lib/swappy.rb
+- lib/swappy/app_config.rb
+- lib/swappy/cli.rb
+- lib/swappy/commands/command.rb
+- lib/swappy/commands/list.rb
+- lib/swappy/commands/swap.rb
+- lib/swappy/config.rb
+- lib/swappy/config_set.rb
+- lib/swappy/version.rb
+- spec/spec_helper.rb
+- spec/swappy/app_config_spec.rb
+- spec/swappy/commands/command_sharedspec.rb
+- spec/swappy/commands/list_spec.rb
+- spec/swappy/commands/swap_spec.rb
+- swappy.gemspec
+homepage: https://github.com/facto/swappy
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Swap your config files with ease
+test_files:
+- spec/spec_helper.rb
+- spec/swappy/app_config_spec.rb
+- spec/swappy/commands/command_sharedspec.rb
+- spec/swappy/commands/list_spec.rb
+- spec/swappy/commands/swap_spec.rb