crawling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b73a78419ddf8c722d1472d4c671caa74143cc14
+  data.tar.gz: 7c36f3ee9ba92e5189da56ab39db21aec2cea3b3
+SHA512:
+  metadata.gz: be515f16be2dc6f2cde139cda1cc867d62e006a9d2816bbcea5d2f35fca6d3149aac6a24af3f78151e27ddc9af95ea1ffad41f3fd512bebf61757d3db79dd332
+  data.tar.gz: 4e20bb27c661023040a4b749d29271b94e5f53f4de67e86f31a53655b455ea3e540621df54e7bd7f6f661fc9d4fbdca25cff32017776e71c8d48b4b682faf147

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 James Pike
+
+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,33 @@
+# crawling
+
+[![build status](https://circleci.com/gh/ohjames/crawling.png)](https://circleci.com/gh/ohjames/crawling)
+
+Welcome to crawling, documentation coming soon!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'crawling'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install crawling
+
+## Usage
+
+Coming soon.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ohjames/crawling.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "crawling"
+
+# 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

data/bin/crawling

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'crawling'
+require 'moister'
+require 'ostruct'
+
+module Crawling::Command
+  def self.run args
+    config = nil
+    command = nil
+    positionals = nil
+
+    Moister::SubcommandOptionParser.new do |op|
+      op.banner = 'usage: crawling [global options] command [command options]'
+
+      op.for_all do |op|
+        op.on_tail '-h', '--help', 'show this help message' do
+          puts op
+          exit
+        end
+      end
+
+      op.on '-c', '--config dir', 'path to configuration directory', 'config_dir'
+      op.on '-H', '--home dir', 'path to home directory', 'home_dir'
+
+      op.subcommand 'cd', 'run shell in store directory'
+      op.subcommand 'add', 'add files to store directory'
+      op.subcommand 'get', 'get files from store directory'
+      op.subcommand 'diff', 'show differences between store directory and filesystem'
+      op.subcommand 'merge', 'merge differences between store directory and filesystem' do |subop|
+        op.on '-m', '--merge-app app', 'command used to merge files', 'merge_app'
+      end
+      op.subcommand 'clone', 'clone or pull latest store using configured commands'
+
+      parsed_cfg = op.parse(args)
+      positionals = parsed_cfg.positionals
+      command = parsed_cfg.command
+      config = OpenStruct.new parsed_cfg[:config]
+    end
+
+    unless command
+      puts 'please supply a command, see --help'
+      exit
+    end
+
+    crawling = Crawling::Instance.new(**config.to_h)
+    case command
+    when 'cd'
+      crawling.cd positionals[0]
+    when 'add'
+      crawling.add positionals
+    when 'get'
+      crawling.get positionals
+    when 'diff'
+      crawling.diff positionals
+    when 'merge'
+      crawling.merge positionals
+    when 'clone'
+      crawling.clone
+    end
+  rescue RuntimeError => e
+    puts e.to_s
+  rescue Interrupt => e
+    exit 1
+  end
+end
+
+Crawling::Command::run ARGV

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/circle.yml

@@ -0,0 +1,3 @@
+machine:
+  ruby:
+    version: 2.2.3

data/crawling.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'crawling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "crawling"
+  spec.version       = Crawling::VERSION
+  spec.authors       = ["James Pike"]
+  spec.email         = ["github@chilon.net"]
+
+  spec.summary       = %q{Tool to manage personal configuration and environment files.}
+  spec.description   = spec.summary
+  spec.homepage      = "http://github.com/ohjames/crawling"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency "moister", "~> 0.2"
+  spec.add_dependency "diffy", "~> 3.1.0"
+end

data/lib/crawling/version.rb

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

data/lib/crawling.rb

@@ -0,0 +1,213 @@
+require "crawling/version"
+require "diffy"
+require "pathname"
+
+module Crawling
+  # path to repository for user(s)
+  HOME_PARENT_DIR = 'home'
+
+  # path to repository for the system
+  SYSTEM_PARENT_DIR = 'system'
+
+  N_LINES_DIFF_CONTEXT = 3
+
+  def self.child_files_recursive path
+    Dir.glob("#{path}/**/*", File::FNM_DOTMATCH).reject(&File.method(:directory?))
+  end
+
+  # Like File.cp but also creates the parent directory at destination if it doesn't exist
+  def self.copy_file src_file, dest_file
+    dest_parent_dir = File.dirname dest_file
+    FileUtils.mkdir_p dest_parent_dir unless Dir.exist? dest_parent_dir
+    begin
+      FileUtils.cp(src_file, dest_file)
+    rescue
+      raise "could not copy from #{src_file} to #{dest_file}"
+    end
+  end
+
+  class Instance
+    def initialize(config_dir: nil, home_dir: nil, merge_app: nil)
+      @home_dir = home_dir || ENV['HOME']
+      @home_pathname = Pathname.new(@home_dir).expand_path
+      @config_dir = config_dir || "#{@home_dir}/.config/crawling"
+      @config_pathname = Pathname.new(@config_dir).expand_path
+      @merge_app = merge_app || 'vimdiff %s %h'
+    end
+
+    def cd(subdir = nil)
+      cd_dir = get_config_dir
+      cd_dir = Path.join(cd_dir, subdir) if subdir
+      raise "directory #{subdir} doesn't exist" unless Dir.exists? cd_dir
+
+      Dir.chdir cd_dir
+      puts "creating shell in #{cd_dir}, type exit or ctrl-D to exit"
+      system ENV['SHELL']
+      puts "crawling shell exited"
+    end
+
+    def add paths
+      raise "add command requires paths" if paths.empty?
+
+      paths.each do |path|
+        raise "path #{path} does not exist" unless File.exists? path
+
+        each_with_storage_path(files_from path) do |file, storage_file|
+          Crawling.copy_file file, storage_file
+        end
+      end
+    end
+
+    def get paths
+      raise "get command requires paths" if paths.empty?
+
+      each_with_storage_path(paths) do |path, storage_path|
+        raise "path #{path} does not exist in storage" unless File.exists? storage_path
+
+        files_from(storage_path).each do |storage_file|
+          sys_path = from_storage_path storage_file
+          Crawling.copy_file storage_file, sys_path
+        end
+      end
+    end
+
+    def diff paths
+      each_with_storage_path(files_from_paths_or_all paths) do |file, storage_file|
+        missing_from = file_or_storage_file_doesnt_exist file, storage_file
+        if missing_from
+          puts "#{file}: doesn't exist in #{missing_from}"
+          next
+        end
+
+        diff = get_diff storage_file, file
+        unless diff == ''
+          puts "#{file}:"
+          puts diff
+          puts
+        end
+      end
+    end
+
+    def merge paths
+      each_with_storage_path(files_from_paths_or_all paths) do |file, storage_file|
+        missing_from = file_or_storage_file_doesnt_exist file, storage_file
+        if missing_from
+          case missing_from
+          when 'home'
+            puts "#{file}: creating from store"
+            Crawling.copy_file storage_file, file
+          when 'store'
+            puts "#{file}: creating in store from home"
+            Crawling.copy_file storage_file, file
+          else
+            puts "#{file}: does not exist in home or store"
+          end
+
+          next
+        end
+
+        while (diff_string = get_diff storage_file, file) != ''
+          print "#{file}: show [d]iff, [m]erge, take [h]ome, take [S]tore, skip [n]ext? "
+          answer = STDIN.gets.chomp
+          case answer
+          when 'd'
+            puts diff_string
+            puts
+            redo
+          when 'h'
+            Crawling.copy_file file, storage_file
+            break
+          when 'm'
+            system *@merge_app.sub('%s', storage_file).sub('%h', file).split(' ')
+          when 'n'
+            break
+          when 'S'
+            Crawling.copy_file storage_file, file
+            break
+          else
+            puts 'please answer with d, h, m, n or S'
+            redo
+          end
+        end
+      end
+    end
+
+    def clone
+      raise "clone: command not supported yet"
+    end
+
+    private
+    def get_config_dir
+      FileUtils::mkdir_p @config_dir unless Dir.exists? @config_dir
+      @config_dir
+    end
+
+    def relative_path_to target, relative_to
+      Pathname.new(target).expand_path.relative_path_from relative_to
+    end
+
+    def each_with_storage_path paths
+      paths.each do |path|
+        yield path, get_storage_path(path)
+      end
+    end
+
+    def get_home_path path
+      relative_path_to path, @home_pathname
+    end
+
+    def get_storage_path path
+      # TODO: get system or home path depending on whether it is a subdirectory of the current user
+      File.join @config_dir, HOME_PARENT_DIR, get_home_path(path)
+    end
+
+    def from_storage_path path
+      cfg_rel_path = Pathname.new(relative_path_to path, @config_pathname)
+      head, *tail = Pathname(cfg_rel_path).each_filename.to_a
+      if head === 'home'
+        File.join @home_dir, *tail
+      else
+        raise "storage type #{head} not supported yet"
+      end
+    end
+
+    # if paths is empty then get home paths for all paths in storage, else get the
+    # files recursively reachable from the provided paths
+    def files_from_paths_or_all paths
+      if paths.empty?
+        # TODO: also support 'SYSTEM_PARENT_DIR'
+        Crawling.child_files_recursive(
+          File.join(@config_dir, HOME_PARENT_DIR)
+        ).map &method(:from_storage_path)
+      else
+        paths.map(&method(:files_from)).flatten
+      end
+    end
+
+    def files_from path
+      Dir.exists?(path) ? Crawling.child_files_recursive(path) : [path]
+    end
+
+    def file_or_storage_file_doesnt_exist file, storage_file
+      if not File.exists? file
+        if File.exists? storage_file
+          'home'
+        else
+          'home directory or store'
+        end
+      elsif not File.exists? storage_file
+        'store'
+      end
+    end
+
+    def get_diff src_file, dest_file
+      diff = Diffy::Diff.new(
+        src_file,
+        dest_file,
+        source: 'files',
+        include_diff_info: true,
+        context: N_LINES_DIFF_CONTEXT
+      ).to_s
+    end
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: crawling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Pike
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moister
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Tool to manage personal configuration and environment files.
+email:
+- github@chilon.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/crawling
+- bin/setup
+- circle.yml
+- crawling.gemspec
+- lib/crawling.rb
+- lib/crawling/version.rb
+homepage: http://github.com/ohjames/crawling
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Tool to manage personal configuration and environment files.
+test_files: []