chronicler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e5c6897edb863ebbc3182d2b256a6c26d7d6763a
+  data.tar.gz: a31860fa336b1002d751ecb8df6ae2834a529c6e
+SHA512:
+  metadata.gz: 4261895f88d52900c8e451eee93b04d40dfdf6feb30dfc889b95f75c41e087be53051e48abd47de3765e12753158d0070963866844f5700bfe2b1204e60778ba
+  data.tar.gz: 90758496816f9b8516406ad909cb4dd138b00d50ec3a9191e9b322966a1fe7b9dff7c36862731f0570992626850278897ca8a2b75c86bb936d93e7532201ff10

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+.bundle
+.yardoc
+.rvmrc
+Gemfile.lock
+doc
+pkg

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Paul Engel
+
+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,48 @@
+# Chronicler
+
+Version control your (development) databases using Git
+
+## Installation
+
+Run the following command to install `Chronicler`:
+
+    $ gem install "chronicler"
+
+## Usage
+
+Chronicler is a command-line-tool so for starters, you can print help instructions:
+
+    $ crn --help
+    Commands:
+      crn branch                 # List branches
+      crn checkout [IDENTIFIER]  # Switch and load the specified branch or commit or tag (IDENTIFIER is optional)
+      crn commit                 # Commit current state of databases
+      crn destroy                # Remove Chronicler entirely
+      crn help [COMMAND]         # Describe available commands or one specific command
+      crn init [NAME]            # Create a new repository (NAME defaults to current Git repository or current user)
+      crn list                   # List repositories
+      crn log [INTERFACE]        # Show commit logs (INTERFACE is optional)
+      crn new [BRANCH]           # Create a new branch (BRANCH defaults to current Git branch)
+      crn open                   # Open current repository
+      crn reset                  # Reset database(s) to last commit
+      crn select                 # Select which databases to store
+      crn status                 # Show current status
+      crn tree                   # Print branch graph tree
+      crn use [NAME]             # Use existing repository (NAME is optional)
+
+## TODO
+
+* Watch and unwatch switching branches
+* Added memoization within CLI and Repository
+
+## License
+
+Copyright (c) 2016 Paul Engel, released under the MIT license
+
+http://github.com/archan937 – http://twitter.com/archan937 – pm_engel@icloud.com
+
+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/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/crn

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "chronicler/cli"
+
+begin
+  Chronicler::CLI.start
+rescue Interrupt
+end

data/chronicler.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paul Engel"]
+  gem.email         = ["pm_engel@icloud.com"]
+  gem.summary       = %q{Version control your (development) databases using Git}
+  gem.description   = %q{Version control your (development) databases using Git}
+  gem.homepage      = "https://github.com/archan937/chronicler"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "chronicler"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+
+  gem.add_dependency "thor"
+  gem.add_dependency "toml-rb"
+  gem.add_dependency "inquirer"
+
+  gem.add_development_dependency "pry"
+end

data/lib/chronicler.rb

@@ -0,0 +1,48 @@
+require "toml"
+
+require "chronicler/core_ext"
+require "chronicler/config"
+require "chronicler/git"
+require "chronicler/repository"
+
+class Chronicler
+
+  CONFIG = ".chronicler"
+  DEFAULT_PATH = "~/Chronicles"
+
+  def self.setup(path)
+    path = DEFAULT_PATH if path.to_s.strip.empty?
+    path = File.expand_path(path)
+
+    FileUtils.mkdir_p(path)
+    config[:store] = path
+  end
+
+  def self.store
+    config[:store]
+  end
+
+  def self.repositories
+    if store
+      Dir[File.join(store, "*")]
+        .select{|file| File.directory?(file)}
+        .collect{|dir| File.basename(dir)}
+    else
+      []
+    end
+  end
+
+  def self.config_path
+    File.join(Dir.home, CONFIG)
+  end
+
+  def self.config
+    Config[config_path]
+  end
+
+  def self.destroy!
+    FileUtils.rm_rf(store) if File.exists?(store)
+    File.delete(config_path) if File.exists?(config_path)
+  end
+
+end

data/lib/chronicler/cli.rb

@@ -0,0 +1,235 @@
+require "thor"
+require "inquirer"
+require "chronicler"
+
+class Chronicler
+  class CLI < Thor
+
+    desc "init [NAME]", "Create a new repository (NAME defaults to current Git repository or current user)"
+    def init(name = defacto_name)
+      ensure_store
+      if path = repository(name).init
+        puts "Created empty Chronicler repository at #{path}"
+      end
+      config_use name
+    end
+
+    desc "use [NAME]", "Use existing repository (NAME is optional)"
+    def use(name = nil)
+      name ||= begin
+        current = current_name
+        repositories = Chronicler.repositories - [current]
+
+        no_repository_available! if repositories.empty?
+
+        postfix = " (on #{current})" if repositories.include?(current)
+        repositories[Ask.list("Which repository do you want to use?#{postfix}", repositories)]
+      end
+
+      config_use name
+    end
+
+    desc "open", "Open current repository"
+    def open
+      repository.run "open ."
+    end
+
+    desc "list", "List repositories"
+    def list
+      if Chronicler.repositories.any?
+        name = [current_name, whoami].detect do |x|
+          Chronicler.repositories.include?(x)
+        end
+
+        puts "Located at #{Chronicler.store.gsub(Dir.home, "~")}"
+
+        Chronicler.repositories.each do |repo|
+          current = (repo == name)
+          prefix = current ? "* " : "  "
+          repo = repo.green if current
+          puts "#{prefix}#{repo}"
+        end
+      else
+        puts "No Chronicler repositories initialized yet."
+      end
+    end
+
+    desc "branch", "List branches"
+    def branch
+      puts "On repository #{repository.name}"
+      repository.git("branch", :system)
+    end
+
+    desc "status", "Show current status"
+    def status
+      puts "On branch #{repository.name}:#{repository.branch}"
+      if (changes = repository.changes).empty?
+        puts "Nothing to commit."
+      else
+        puts "Changes for commit:"
+        puts
+        (changes[:added] || []).each do |(table, checksum)|
+          puts "       added:  #{table}"
+        end
+        (changes[:modified] || []).each do |(table, checksum)|
+          puts "    modified:  #{table} (#{checksum})"
+        end
+        (changes[:deleted] || []).each do |(table, checksum)|
+          puts "     deleted:  #{table}"
+        end
+        puts
+      end
+    end
+
+    desc "log [INTERFACE]", "Show commit logs (INTERFACE is optional)"
+    def log(interface = nil)
+      repository # check available repository
+      interface ||= begin
+        ensure_interface
+        Chronicler.config[:interface]
+      end
+      command = (interface == "git") ? "git log" : interface
+      repository.run(command, :system)
+    end
+
+    desc "tree", "Print branch graph tree"
+    def tree
+      puts "On repository #{repository.name}"
+      repository.git("log --graph --oneline --decorate --date=relative --all", :system)
+    end
+
+    desc "new [BRANCH]", "Create a new branch (BRANCH defaults to current Git branch)"
+    def new(branch = nil)
+      if repository && branch.nil? && Git.current.nil?
+        puts "Please specify the branch name as Chronicler cannot determine one."
+      else
+        repository.new(branch || Git.branch)
+      end
+    end
+
+    desc "select", "Select which databases to store"
+    def select
+      repository_databases = repository.databases
+      databases = []
+
+      options = `mysql -u root -e "SHOW DATABASES" -sN`.split(/\s+/).reject do |database|
+        %w(information_schema mysql performance_schema test).include? database
+      end
+      selected = options.collect{|database| repository_databases.include?(database)}
+
+      Ask.checkbox("Which databases would you like to store?", options, default: selected).each_with_index do |checked, index|
+        databases << options[index] if checked
+      end
+
+      repository.select databases
+    end
+
+    desc "commit", "Commit current state of databases"
+    method_options [:message, "-m"] => :string, [:tag, "-t"] => :string
+    def commit
+      if repository.new?
+        select
+      elsif !repository.dirty?
+        puts "Nothing to commit."
+        return
+      end
+      message = options[:message] || "Updated databases"
+      repository.commit message, options[:tag]
+    end
+
+    desc "reset", "Reset database(s) to last commit"
+    def reset
+      if repository && Ask.confirm("Are you sure you want to reset to the last commit? (Changes will be lost)")
+        repository.reset
+      end
+    end
+
+    desc "checkout [IDENTIFIER]", "Switch and load the specified branch or commit or tag (IDENTIFIER is optional)"
+    def checkout(identifier = nil)
+      identifier ||= begin
+        branches = repository.branches - [repository.branch]
+        branches[Ask.list("Which branch do you want to checkout? (on #{repository.branch})", branches)]
+      end
+
+      if repository.dirty? && Ask.confirm("Current state is dirty. Do you want to commit first?")
+        commit
+      end
+
+      repository.checkout identifier
+      puts "Successfully loaded database#{"s" unless repository.databases.size == 1} of '#{identifier}'"
+    end
+
+    desc "destroy", "Remove Chronicler entirely"
+    def destroy
+      if File.exists?(Chronicler.config_path)
+        if Ask.confirm("Are you sure you want to continue? (Everything will be LOST)")
+          Chronicler.destroy!
+        end
+      else
+        puts "Nothing to destroy."
+      end
+    end
+
+  private
+
+    def ensure_store
+      if Chronicler.store.nil?
+        path = Ask.input("Where should Chronicler repositories be located at?", default: Chronicler::DEFAULT_PATH)
+        Chronicler.setup(path)
+      end
+    end
+
+    def ensure_interface
+      if Chronicler.config[:interface].nil?
+        default = `which gitx`.strip.empty? ? "git" : "gitx"
+        interface = Ask.input("Which Git interface would you like to use?", default: default)
+        Chronicler.config[:interface] = interface
+      end
+    end
+
+    def config_use(selected)
+      defacto = defacto_name
+      if defacto == selected
+        use = (Chronicler.config[:use] || {}).reject{|k, v| k == defacto}
+        Chronicler.config[:use] = (use unless use.empty?)
+      else
+        Chronicler.config[:"use.#{defacto}"] = selected
+      end
+    end
+
+    def whoami
+      `whoami`.strip
+    end
+
+    def defacto_name
+      Git.current || whoami
+    end
+
+    def current_name
+      defacto = defacto_name
+      (Chronicler.config[:use] || {})[defacto] || defacto
+    end
+
+    def repository(name = nil)
+      name ||= [current_name, whoami].detect do |x|
+        Chronicler.repositories.include?(x)
+      end
+
+      if name
+        Repository.new name
+      else
+        no_repository_available!
+      end
+    end
+
+    def no_repository_available!
+      puts "fatal: No Chronicler repository available."
+      exit!
+    end
+
+    def method_missing(method, *args)
+      raise Error, "Unrecognized command \"#{method}\". Please consult `ds help`."
+    end
+
+  end
+end

data/lib/chronicler/config.rb

@@ -0,0 +1,44 @@
+class Chronicler
+  class Config
+    attr_reader :file
+
+    def self.[](file)
+      new(file)
+    end
+
+    def initialize(file)
+      @file = file
+    end
+
+    def [](key)
+      split(key).inject(load_file){|h, k| (h || {})[k]}
+    end
+
+    def []=(key, value)
+      config = load_file
+
+      keys = split(key)
+      hash = keys[0..-2].inject(config){|h, k| h[k] ||= {}}
+      hash[keys.last] = value
+
+      dump_file config.reject{|k, v| v.nil?}
+    end
+
+  private
+
+    def load_file
+      (TOML.load_file(file) if File.exists?(file)) || {}
+    end
+
+    def dump_file(config)
+      File.open(file, "w") do |f|
+        f.write TOML.dump(config)
+      end
+    end
+
+    def split(key)
+      key.to_s.split(".")
+    end
+
+  end
+end

data/lib/chronicler/core_ext.rb

@@ -0,0 +1 @@
+require "chronicler/core_ext/string"

data/lib/chronicler/core_ext/string.rb

@@ -0,0 +1,18 @@
+class String
+
+  COLORS = {:red => 31, :green => 32, :yellow => 33, :blue => 36, :white => 37}
+
+  COLORS.keys.each do |color|
+    define_method color do
+      colorize color
+    end
+  end
+
+private
+
+  def colorize(color)
+    color = COLORS[color]
+    "\e[1m\e[#{color}m#{self}\e[0m"
+  end
+
+end

data/lib/chronicler/git.rb

@@ -0,0 +1,32 @@
+class Chronicler
+  module Git
+    extend self
+
+    def current(path = nil)
+      if git("rev-parse --is-inside-work-tree 2> /dev/null", path) == "true"
+        File.basename git("rev-parse --show-toplevel", path)
+      end
+    end
+
+    def head(path = nil)
+      git "rev-parse HEAD", path
+    end
+
+    def branch(path = nil)
+      git "rev-parse --abbrev-ref HEAD", path
+    end
+
+    def branches(path = nil)
+      git("for-each-ref refs/heads/ --format='%(refname:short)'", path).split("\n")
+    end
+
+  # private
+
+    def git(command, path)
+      `cd #{path || "."} && git #{command}`.strip
+    end
+
+    private_class_method :git
+
+  end
+end

data/lib/chronicler/repository.rb

@@ -0,0 +1,144 @@
+class Chronicler
+  class Repository
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def path
+      File.join(Chronicler.store, name)
+    end
+
+    def branch
+      Git.branch(path)
+    end
+
+    def branches
+      Git.branches(path)
+    end
+
+    def init
+      return if File.exists?(path)
+
+      FileUtils.mkdir(path)
+      File.open(File.join(path, ".gitignore"), "w+") do |file|
+        file.puts ".DS_Store"
+      end
+
+      git "init"
+      git "add .gitignore"
+      git "commit -m 'Initial commit'"
+
+      path
+    end
+
+    def new(branch)
+      config[:"repository.origin"] = Git.head(path)
+      git "checkout -b #{branch}"
+    end
+
+    def select(*databases)
+      config[:"repository.databases"] = [databases].flatten.sort
+    end
+
+    def commit(message, tag = nil)
+      dump
+      config[:"repository.origin"] = Git.head(path) if config[:"repository.origin"].nil?
+      config[:"repository.checksums"] = checksums
+      git "add ."
+      git "commit -m #{message.inspect}"
+      git "tag #{tag}" if tag
+    end
+
+    def reset
+      load
+    end
+
+    def checkout(branch)
+      git "checkout #{branch}"
+      load
+    end
+
+    def git(command, output = :silence)
+      run "git #{command}", output
+    end
+
+    def run(command, output = :silence)
+      command = "cd #{path} && #{command}"
+      command << " > /dev/null" if output == :silence
+      if output == :system
+        system command
+      else
+        `#{command}`.strip
+      end
+    end
+
+    def new?
+      [nil, Git.head(path)].include?(config[:"repository.origin"])
+    end
+
+    def dirty?
+      changes.any?
+    end
+
+    def databases
+      config[:"repository.databases"] || []
+    end
+
+    def changes
+      selected_databases = databases
+      stored = (config[:"repository.checksums"] || {}).select{|table, checksum| selected_databases.include?(table.gsub(/-.*/, ""))}
+      current = checksums
+
+      added = current.reject{|table, checksum| stored.keys.include?(table)}
+      modified = current.select{|table, checksum| stored.keys.include?(table) && (stored[table] != checksum)}
+      deleted = stored.reject{|table, checksum| current.keys.include?(table)}
+
+      {}.tap do |changes|
+        changes[:added] = added if added.any?
+        changes[:modified] = modified if modified.any?
+        changes[:deleted] = deleted if deleted.any?
+      end
+    end
+
+    def checksums
+      checksums = databases.collect do |database|
+        `mysql -u root #{database} -e "SHOW TABLES" -sN`.split("\n").collect do |table|
+          `mysql -u root #{database} -e "CHECKSUM TABLE #{table}"`.split("\n").last
+        end
+      end.flatten.collect do |checksum|
+        table, size = checksum.split("\t")
+        [table.gsub(".", "-"), size.to_i]
+      end
+      Hash[checksums]
+    end
+
+  private
+
+    def config
+      Config[File.join(path, Chronicler::CONFIG)]
+    end
+
+    def dump
+      Dir[File.join(path, "*.sql.gz")].each do |file|
+        unless databases.include?(File.basename(file, ".sql.gz"))
+          File.delete(file)
+        end
+      end
+
+      changed = changes.values.flatten
+      changed_databases = changed.collect{|h| h.keys.collect{|t| t.gsub(/-.*/, "")}}.flatten.uniq
+      changed_databases.each do |database|
+        run "mysqldump -u root #{database} | gzip -c | cat > #{database}.sql.gz", true
+      end
+    end
+
+    def load
+      databases.each do |database|
+        run "gunzip < #{database}.sql.gz | mysql -u root #{database}", true
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: chronicler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul Engel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  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: toml-rb
+  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: inquirer
+  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: 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'
+description: Version control your (development) databases using Git
+email:
+- pm_engel@icloud.com
+executables:
+- crn
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- bin/crn
+- chronicler.gemspec
+- lib/chronicler.rb
+- lib/chronicler/cli.rb
+- lib/chronicler/config.rb
+- lib/chronicler/core_ext.rb
+- lib/chronicler/core_ext/string.rb
+- lib/chronicler/git.rb
+- lib/chronicler/repository.rb
+homepage: https://github.com/archan937/chronicler
+licenses: []
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Version control your (development) databases using Git
+test_files: []