structure_conflict_resolver 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45f2a78aeb8694f04b346175b734016414904d54
+  data.tar.gz: 0340ed793b083e778acf7acfb3bbeaffe98b0300
+SHA512:
+  metadata.gz: bb69147dfe7511aaa5a1736732eaa3eaa6aa48fd167c5b726595faab70c0e77f33bf9351e0c7d0588beb961cc1ea481fa8529d754c7c50bfee1eceaebc64acaf
+  data.tar.gz: 8047f4ab247868123e8fdd9e11620c714b201115a6da723a6c22b8ab7f9240af57e29546d643cad2d655360058a90de4b3afe13343d2c5acc32233e876dff0a8

data/.gitignore

@@ -0,0 +1,7 @@
+tmp/
+coverage/
+
+Gemfile.lock
+*.gem
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake"
+gem "coveralls", require: false

data/README.markdown

@@ -0,0 +1,59 @@
+[![Gem Version](http://img.shields.io/gem/v/structure_conflict_resolver.svg)](https://rubygems.org/gems/structure_conflict_resolver)[![Build Status](http://img.shields.io/travis/JustinAiken/structure_conflict_resolver/master.svg)](http://travis-ci.org/JustinAiken/structure_conflict_resolver)[![Coveralls branch](http://img.shields.io/coveralls/JustinAiken/structure_conflict_resolver/master.svg)](https://coveralls.io/r/JustinAiken/structure_conflict_resolver?branch=master)
+
+# structure.sql Conflict Resolver
+
+Ruby 💎 tool for resolving conflicts in `db/structure.sql`
+
+Do you hate it when this happens to you?
+
+![Conflict Detected](doc/conflict.png)
+
+Now you can easily resolve the most common conflicts in the versions list!
+
+#### Before:
+
+```sql
+...
+
+('20180313190020'),
+<<<<<<< HEAD
+('20180319155607');
+
+=======
+('20180319231815');
+>>>>>>> some important commit
+```
+
+#### After:
+
+```sql
+...
+
+('20180313190020'),
+('20180319155607'),
+('20180319231815');
+```
+
+## Installation
+
+```bash
+gem install structure_conflict_resolver
+```
+
+You probably won't want to add this to your `Gemfile`, it's more of a CLI tool.
+
+## Usage
+
+When you run into a merge conflict on `db/structure.sql`, give this a try:
+
+```bash
+structure_conflict_resolver db/structure.sql
+```
+
+It'll smartly resolve any conflicts around the version numbers at the bottom.
+
+Any logical conflicts in the actual table descriptions... you'll have to fix yourself!
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+require "rspec/core"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern    = "spec/**/*_spec.rb"
+  spec.rspec_opts = "--color"
+end
+
+task default: :spec

data/bin/structure_conflict_resolver

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "structure_conflict_resolver"
+
+filename = ARGV[0]
+resolver = StructureConflictResolver::Resolver.new(filename)
+resolver.resolve!

data/lib/structure_conflict_resolver.rb

@@ -0,0 +1,102 @@
+begin
+  require "pry"
+rescue LoadError
+end
+
+require "aasm"
+require "rainbow"
+require "structure_conflict_resolver/version"
+require "structure_conflict_resolver/structure_type"
+require "structure_conflict_resolver/structure_type/modern"
+require "structure_conflict_resolver/structure_type/old_school"
+require "structure_conflict_resolver/structure_type/unresolvable"
+require "structure_conflict_resolver/merge_conflict"
+
+module StructureConflictResolver
+
+  class Resolver
+
+    attr_accessor :filename, :conflicts, :potential_conflict
+
+    def initialize(filename)
+      @filename           = filename
+      @conflicts          = []
+      @potential_conflict = MergeConflict.new
+    end
+
+    def resolve!
+      validate_file
+      scan_for_conflicts
+      substitute_content
+      check_content
+      write_content
+    end
+
+    def validate_file
+      end_with :error, "No filename provided!" if filename.nil?
+      end_with :error, "db/schema.rb is not currently supported" if filename =~ /schema\.rb/
+      end_with :error, "#{filename} not found" unless File.exist?(filename)
+    end
+
+    def scan_for_conflicts
+      content.each_line do |line|
+        potential_conflict.parse! line
+        if potential_conflict.scanning_completed?
+          conflicts << potential_conflict
+          potential_conflict = MergeConflict.new
+        end
+      end
+    end
+
+    def substitute_content
+      conflicts
+        .select(&:scanning_completed?)
+        .each { |c| new_content.gsub! c.original_blob, c.resolved_text }
+    end
+
+    def check_content
+      end_with :error, "Unparsable conflicts!"    if conflicts.any?(&:parse_error?)
+      end_with :error, "No resolvable conflicts!" if conflicts.all? { |c| !c.resolvable? }
+      end_with :error, "Nothing changed!"         if content == new_content
+
+      if new_content =~ /\<{7} |\={7}|\<{7}/ || conflicts.any? { |c| !c.resolvable? }
+        puts Rainbow("Warning!").yellow
+        puts ""
+        puts "There are conflicts remaining.  You'll have to fix those manually"
+        puts ""
+      end
+    end
+
+    def write_content
+      File.open(filename, "w") { |file| file.write new_content }
+      end_with :success, "✅  Version conflicts resolved!\n\n You'll probably want to \`git add #{filename}\`,\n and continue your rebase/merge.\n\n"
+    end
+
+  private
+
+    def content
+      @content ||= File.read(filename)
+    end
+
+    def new_content
+      @new_content ||= content.dup
+    end
+
+    def end_with(exit_type, msg)
+      puts ""
+      if exit_type == :error
+        puts Rainbow("Error!").red
+        puts ""
+        puts msg
+        puts ""
+        exit 1
+      else
+        puts Rainbow("Success!").green
+        puts ""
+        puts msg
+        puts ""
+      end
+      exit 0
+    end
+  end
+end

data/lib/structure_conflict_resolver/merge_conflict.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module StructureConflictResolver
+  class MergeConflict
+    include AASM
+
+    CONFLICT_A = /^\<{7} (.*)$/
+    DIVIDER    = /^\={7}$/
+    CONFLICT_B = /^\>{7} (.+)$/
+
+    attr_accessor :current_line, :original_blob, :head_branch_blob, :our_commit_blob
+
+    def initialize
+      @original_blob    = String.new
+      @head_branch_blob = String.new
+      @our_commit_blob  = String.new
+    end
+
+    aasm do
+      state :not_detected, initial: true
+      state :in_head_blob
+      state :in_our_blob
+      state :scanning_completed
+
+      event :enter_head_blob, if: :matches_conflict_start? do
+        transitions from: :not_detected, to: :in_head_blob
+      end
+
+      event :enter_our_blob, if: :at_divider? do
+        transitions from: :in_head_blob, to: :in_our_blob
+      end
+
+      event :complete_scanning, if: :matches_conflict_end? do
+        transitions from: :in_our_blob, to: :scanning_completed
+      end
+    end
+
+    def parse!(line)
+      @current_line = line
+      enter_head_blob   if may_enter_head_blob?
+      enter_our_blob    if may_enter_our_blob?
+      complete_scanning if may_complete_scanning?
+
+      store_lines!
+    end
+
+    def parse_error?
+      !not_detected? && !scanning_completed?
+    end
+
+    def resolvable?
+      !resolved_text.nil?
+    end
+
+    def resolved_text
+      @resolved_text ||= StructureType.from(head_branch_blob + our_commit_blob).resolved
+    rescue
+    end
+
+  private
+
+    def store_lines!
+      original_blob << current_line if in_head_blob? || in_our_blob? || git_noise?
+
+      unless git_noise?
+        head_branch_blob << current_line if in_head_blob?
+        our_commit_blob  << current_line if in_our_blob?
+      end
+    end
+
+    def git_noise?
+      matches_conflict_start? || at_divider? || matches_conflict_end?
+    end
+
+    def matches_conflict_start?
+      current_line =~ CONFLICT_A
+    end
+
+    def matches_conflict_end?
+      current_line =~ CONFLICT_B
+    end
+
+    def at_divider?
+      current_line =~ DIVIDER
+    end
+  end
+end

data/lib/structure_conflict_resolver/structure_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module StructureConflictResolver
+  module StructureType
+
+    def self.from(text_blob)
+      klass = case text_blob
+      when /INSERT INTO schema_migrations/ then OldSchool
+      when /\(\'\d{5,14}\'\)[,; ]?/        then Modern
+      else                                      Unresolvable
+      end
+
+      klass.new(text_blob)
+    end
+  end
+end

data/lib/structure_conflict_resolver/structure_type/modern.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module StructureConflictResolver
+  module StructureType
+    class Modern
+
+      attr_accessor :original_text
+
+      def initialize(original_text)
+        @original_text = original_text
+      end
+
+      def resolved
+        original_text
+          .gsub(";", ",")
+          .split("\n")
+          .reject(&:empty?)
+          .sort
+          .uniq
+          .tap { |strings| strings.last.gsub! ",", ";\n" }
+          .join("\n")
+      end
+    end
+  end
+end

data/lib/structure_conflict_resolver/structure_type/old_school.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module StructureConflictResolver
+  module StructureType
+    class OldSchool
+
+      attr_accessor :original_text
+
+      def initialize(original_text)
+        @original_text = original_text
+      end
+
+      def resolved
+        original_text
+          .split("\n")
+          .reject { |line| line.empty? }
+          .sort
+          .uniq
+          .join("\n\n") + "\n"
+      end
+    end
+  end
+end

data/lib/structure_conflict_resolver/structure_type/unresolvable.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module StructureConflictResolver
+  module StructureType
+    class Unresolvable
+
+      attr_accessor :original_text
+
+      def initialize(original_text)
+        @original_text = original_text
+      end
+
+      def resolved
+        raise StandardError
+      end
+    end
+  end
+end

data/lib/structure_conflict_resolver/version.rb

@@ -0,0 +1,3 @@
+module StructureConflictResolver
+  VERSION = "0.0.1"
+end

data/spec/lib/structure_conflict_resolver/merge_conflict_spec.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe StructureConflictResolver::MergeConflict do
+  subject(:conflict) { described_class.new }
+
+  describe ".aasm" do
+    it "moves through the states" do
+      conflict.parse! "OK LINE"
+      expect(conflict).to be_not_detected
+      conflict.parse! "OK LINE"
+      expect(conflict).to be_not_detected
+
+      conflict.parse! "<<<<<<< HEAD"
+      expect(conflict).to be_in_head_blob
+      conflict.parse! "foo line"
+      expect(conflict).to be_in_head_blob
+
+      conflict.parse! "======="
+      expect(conflict).to be_in_our_blob
+      conflict.parse! "another line"
+      expect(conflict).to be_in_our_blob
+
+      conflict.parse! ">>>>>>> some commit I just broke"
+      expect(conflict).to be_scanning_completed
+    end
+  end
+
+  describe "#resolvable? / # resolved_text" do
+    before  { lines.each_line { |line| conflict.parse! line } }
+
+    context "when it's a tangled mess" do
+      let(:lines) do
+        <<~TEXT
+          <<<<<<< HEAD
+          CREATE TABLE `foos` (
+          `id` int(11) NOT NULL AUTO_INCREMENT
+          =======
+          `id` int(11) DEFAULT NULL AUTO_INCREMENT
+          >>>>>>> my branch
+        TEXT
+      end
+
+      it { should_not be_resolvable }
+    end
+
+    context "when it's doable with the modern style" do
+      let(:lines) do
+        <<~TEXT
+          <<<<<<< HEAD
+          ('20140521142114'),
+          ('20140521195156');
+          =======
+          ('20140521195156'),
+          ('20140521195156');
+          >>>>>>> my branch
+        TEXT
+      end
+
+      it { should be_resolvable }
+
+      it "is resolved correctly" do
+        expect(conflict.resolved_text).to eq(
+          <<~TEXT
+          ('20140521142114'),
+          ('20140521195156');
+          TEXT
+        )
+      end
+    end
+
+    context "when it's doable with the old school style" do
+      let(:lines) do
+        <<~TEXT
+          <<<<<<< HEAD
+          INSERT INTO schema_migrations (version) VALUES ('20170101120000');
+
+          INSERT INTO schema_migrations (version) VALUES ('20170101150000');
+          =======
+          INSERT INTO schema_migrations (version) VALUES ('20170101110000');
+
+          INSERT INTO schema_migrations (version) VALUES ('20170101130000');
+
+          INSERT INTO schema_migrations (version) VALUES ('20170101150000');
+          >>>>>>> my branch
+        TEXT
+      end
+
+      it { should be_resolvable }
+
+      it "is resolved correctly" do
+        expect(conflict.resolved_text).to eq(
+          <<~TEXT
+          INSERT INTO schema_migrations (version) VALUES ('20170101110000');
+
+          INSERT INTO schema_migrations (version) VALUES ('20170101120000');
+
+          INSERT INTO schema_migrations (version) VALUES ('20170101130000');
+
+          INSERT INTO schema_migrations (version) VALUES ('20170101150000');
+          TEXT
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+unless ENV["NO_COVERALLS"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+require "structure_conflict_resolver"
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+end

data/structure_conflict_resolver.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "structure_conflict_resolver/version"
+
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = "structure_conflict_resolver"
+  s.version     = StructureConflictResolver::VERSION
+  s.authors     = ["Justin Aiken"]
+  s.email       = ["60tonangel@gmail.com"]
+  s.license     = "MIT"
+  s.homepage    = "https://github.com/JustinAiken/structure_conflict_resolver"
+  s.summary     = %q{Automate tedious db/structure.sql conflict resolution}
+  s.description = %q{Automate tedious db/structure.sql conflict resolution}
+
+  s.rubyforge_project = "structure_conflict_resolver"
+
+  s.files           = `git ls-files`.split("\n")
+  s.test_files      = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths   = ["lib"]
+  s.bindir          = "bin"
+  s.executables     = s.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+
+  s.add_dependency "rainbow",       "~> 3.0"
+  s.add_dependency "aasm",          "~> 4.12"
+
+  s.add_development_dependency "rspec", "~> 3.5"
+  s.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: structure_conflict_resolver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Aiken
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: aasm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !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: Automate tedious db/structure.sql conflict resolution
+email:
+- 60tonangel@gmail.com
+executables:
+- structure_conflict_resolver
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.markdown
+- Rakefile
+- bin/structure_conflict_resolver
+- doc/conflict.png
+- lib/structure_conflict_resolver.rb
+- lib/structure_conflict_resolver/merge_conflict.rb
+- lib/structure_conflict_resolver/structure_type.rb
+- lib/structure_conflict_resolver/structure_type/modern.rb
+- lib/structure_conflict_resolver/structure_type/old_school.rb
+- lib/structure_conflict_resolver/structure_type/unresolvable.rb
+- lib/structure_conflict_resolver/version.rb
+- spec/lib/structure_conflict_resolver/merge_conflict_spec.rb
+- spec/spec_helper.rb
+- structure_conflict_resolver.gemspec
+homepage: https://github.com/JustinAiken/structure_conflict_resolver
+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: structure_conflict_resolver
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: Automate tedious db/structure.sql conflict resolution
+test_files: []