squasher 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12116f56ac7b71bdd918cd878a4954efa0a9ef46
-  data.tar.gz: 0cc5ba3d421e63497336b8e71ed79a25fa00d279
+  metadata.gz: cc559f05a448e4588dbc9bad9e58d638ae7b00ce
+  data.tar.gz: a68a4350108a577fc3e245ce1d6e3b800b4ebef1
 SHA512:
-  metadata.gz: 151aa2462ff4415923bcb36cc85d601c48deb7271d44d0702e3095551e75b9e859ccaf62ba2885ae3c3921ad6aab6420f2645125adf2feee5b7767a9bec02647
-  data.tar.gz: 353e4d710717f72cbd2e7a9ebc0d434d0864ae497d7f49e9a0fd609df3e86949eedc032175fa55a7df56503a5f4b9a81152a11817e073274ffbcec0e215d6fb1
+  metadata.gz: 6ac40501ddb62f825bbea4c776218bfacfc50d35dc80bc6181b8ced3324a7b6f1a3952c8dff0a99e165505ab4146e139362f885e48298f935ab334cc50532b64
+  data.tar.gz: 9d184455efd6c40609c8cd11374f02ed250a616d7f667761c760dfa6e44fb470461abb5448ff37752f1641d5c684616b5077b5cb93597898117b1e892d59faa7

data/.gitignore

@@ -3,6 +3,7 @@
 /.bundle
 /.config
 /.rspec
+/dummy
 Gemfile.custom
 Gemfile.lock
 InstalledFiles

data/README.md

@@ -50,12 +50,20 @@ process breaks in a migration from 2014. In this situation you squash till 2014,
 database at the end, make a patch in the broken migration and run again the suite with `-r` option. As the result
 squasher will not need to create the db schema and all data from the previous migrations will be there.
 
+`-e` - tell squasher that you are squashing a Rails engine. To squash migrations you need to configure a dummy app. If your dummy app located outside the engine's folder provide path to it as the next argument `squasher -e ../my-engine-app 2016`
+
 ## Requirements
 
 It works and was tested on Ruby 2.0+ and Rails 3.1+. It also requires a valid development configuration in `config/database.yml` and using Ruby format in `db/schema.rb` (default Rails use-case).
 If an old migration inserted data (created ActiveRecord model records) you will lose this code in the squashed migration, **BUT** `squasher` will ask you to leave a tmp database which will have all data that was inserted while migrating. Using this database you could add that data as another migration, or into `config/seed.rb` (the expected place for this stuff).
 
 ## Changelog
+- 0.3.0
+  - **rails engines support** ([@JakeTheSnake3p0](https://github.com/JakeTheSnake3p0))
+  - move messages from JSON file to YAML
+  - allow to use a db config with a "soft" parsing errors
+- 0.2.2
+  - strip white spaces in init migrations
 - 0.2.1
   - support rails 5
 - 0.2.0

data/lib/squasher.rb

@@ -6,19 +6,32 @@ module Squasher
   autoload :Render,  'squasher/render'
   autoload :Worker,  'squasher/worker'
 
-  def squash(raw_date, raw_options)
+  attr_reader :config
+
+  @config = Config.new
+
+  def squash(raw_date, options)
     parts = raw_date.to_s.split('/').map(&:to_i)
     date = Time.new(*parts)
 
-    options = raw_options.map do |o|
-      o = o.gsub('-', '').to_sym
-      unless Worker::OPTIONS.include?(o)
-        tell(:wrong_option, o: o)
+    options.reduce([]) do |acc, arg|
+      if arg.index('-') == 0
+        arg = arg.gsub('-', '').to_sym
+        unless Config::OPTIONS.include?(arg)
+          tell(:wrong_option, arg: arg)
+          error(:usage)
+        end
+        acc.push([arg])
+      elsif acc.empty?
+        tell(:invalid_param, arg: arg)
         error(:usage)
+      else
+        acc.last[1] = arg
       end
-      o
-    end
-    Worker.process(date, options)
+      acc
+    end.each { |(k, v)| config.set(k, v) }
+
+    Worker.process(date)
   end
 
   def clean
@@ -27,7 +40,9 @@ module Squasher
 
   def rake(command, description = nil)
     tell(description) if description
-    system("RAILS_ENV=development DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle exec rake #{ command }")
+    config.in_app_root do
+      system("RAILS_ENV=development DISABLE_DATABASE_ENVIRONMENT_CHECK=1 bundle exec rake #{ command }")
+    end
   end
 
   def ask(*args)
@@ -44,7 +59,7 @@ module Squasher
 
   def error(*args)
     tell(*args)
-    exit
+    abort
   end
 
   private
@@ -52,9 +67,9 @@ module Squasher
   def messages
     return @messages if @messages
 
-    require 'json'
-    path = File.join(File.dirname(__FILE__), 'squasher/messages.json')
-    @messages = JSON.load(File.open(path))
+    require 'yaml'
+    path = File.join(File.dirname(__FILE__), 'squasher/messages.yml')
+    @messages = YAML.load(File.open(path))
   end
 
   COLORS = ['red', 'green', 'yellow', 'blue'].each_with_index.inject({}) { |r, (k, i)| r.merge!(k => "03#{ i + 1 }") }

data/lib/squasher/cleaner.rb

@@ -25,7 +25,7 @@ module Squasher
     private
 
     def config
-      @config ||= Squasher::Config.new
+      Squasher.config
     end
 
     def prev_migration

data/lib/squasher/config.rb

@@ -4,14 +4,65 @@ require 'erb'
 
 module Squasher
   class Config
+    OPTIONS = [:d, :r, :e].freeze
+
+    module Render
+      extend self
+
+      def process(path)
+        @error = false
+
+        str = YAML.load(ERB.new(File.read(path)).result(binding))
+        [str, @error]
+      end
+
+      def method_missing(*args)
+        @error = true
+        self
+      end
+
+      def const_missing(*args)
+        @error = true
+        self
+      end
+
+      def to_s
+        ''
+      end
+
+      def inspect
+        ''
+      end
+    end
+
     attr_reader :schema_file
 
     def initialize
-      root_path = Dir.pwd
+      @root_path = Dir.pwd.freeze
+      @migrations_folder = File.join(@root_path, 'db', 'migrate')
+      @flags = []
+      set_app_path(@root_path)
+    end
+
+    def set(key, value)
+      if key == :e
+        base = value.nil? ? @root_path : File.expand_path(value, @root_path)
+        list = Dir.glob(File.join(base, '**', '*', 'config', 'application.rb'))
+        case list.size
+        when 1
+          set_app_path(File.expand_path('../..', list.first))
+        when 0
+          Squasher.error(:cannot_find_dummy, base: base)
+        else
+          Squasher.error(:multi_dummy_case, base: base)
+        end
+      else
+        @flags << key
+      end
+    end
 
-      @schema_file = File.join(root_path, 'db', 'schema.rb')
-      @migrations_folder = File.join(root_path, 'db', 'migrate')
-      @dbconfig_file = File.join(root_path, 'config', 'database.yml')
+    def with?(k)
+      @flags.include?(k)
     end
 
     def migration_files
@@ -50,6 +101,10 @@ module Squasher
       end
     end
 
+    def in_app_root(&block)
+      Dir.chdir(@app_path, &block)
+    end
+
     private
 
     attr_reader :migrations_folder, :dbconfig_file
@@ -61,13 +116,23 @@ module Squasher
       @dbconfig = nil
 
       begin
-        content = YAML.load(ERB.new(File.read(dbconfig_file)).result(binding))
+        content, soft_error = Render.process(dbconfig_file)
         if content.has_key?('development')
           @dbconfig = { 'development' => content['development'].merge('database' => 'squasher') }
         end
       rescue
       end
+
+      if soft_error && @dbconfig
+        exit unless Squasher.ask(:use_dbconfig, config: @dbconfig.fetch('development'))
+      end
       @dbconfig
     end
+
+    def set_app_path(path)
+      @app_path = path
+      @schema_file = File.join(path, 'db', 'schema.rb')
+      @dbconfig_file = File.join(path, 'config', 'database.yml')
+    end
   end
 end

data/lib/squasher/messages.yml

@@ -0,0 +1,30 @@
+keep_database:
+- "Squasher's created the `:green<squasher>` database for its needs."
+- It might be useful to keep it if any of your deleted migrations inserts data or
+- you squash migrations in a few steps (look at -r option).
+- "Keep it (:green<yes> / :red<no>)?"
+apply_clean: "Do you want to clean your database from the old schema migration records(:red<yes>/:green<no>)?"
+migration_folder_missing:
+- The folder with migrations is missing.
+- "Are you sure that you're in the :red<root of a rails> application?"
+no_migrations: "There are no migrations in the folder prior to :red<%{date}>"
+use_dbconfig: "There were problems in parsing `:green<database.yml>`. Do you want to use the config below (:green<yes>/:red<no>)?\n\n%{config}\n"
+dbconfig_invalid: "Squasher couldn't load `:green<database.yml>`. Please, make sure that it's present and doesn't include any ruby code."
+db_create: Squasher is creating a tmp database
+db_migrate: Squasher is applying migrations on a tmp database
+db_cleaning: Squasher is applying the clean migration
+db_reuse: Squasher is reusing the database from the previous squashing
+usage:
+- "Example usage:"
+- "  :green<squasher> [options] :yellow<year[/month][/day]> => squash migrations prior to a specified date"
+- "  :green<squasher> :yellow<clean>                        => generate or update a cleaning migration and apply it"
+- "  :green<squasher> :yellow<info>                         => show the message\n"
+- "Options:"
+- "  :yellow<-d>              => execute in :blue<`dry`> mode - test a squashing process without removing old migrations"
+- "  :yellow<-r>              => reuse a database from the previous squashing"
+- "  :yellow<-e> [dummy-root] => execute in :blue<`engine`> mode - requires a dummy app"
+wrong_option: "You provided a wrong option :red<%{arg}>\n\n"
+invalid_param: "You provided a wrong param :red<%{arg}>\n\n"
+dry_mode_finished: "The `dry` mode is finished. Below the init schema's content:"
+cannot_find_dummy: "Squasher can't find a dummy app inside :yellow<%{base}>"
+multi_dummy_case: "Squasher found a few config/application.rb inside :yellow<%{base}>. Please specify the path more precisely"

data/lib/squasher/worker.rb

@@ -2,24 +2,21 @@ require 'fileutils'
 
 module Squasher
   class Worker
-    OPTIONS = [:d, :r]
-
-    attr_reader :date, :options
+    attr_reader :date
 
     def self.process(*args)
       new(*args).process
     end
 
-    def initialize(date, options = [])
+    def initialize(date)
       @date = date
-      @options = options
     end
 
     def process
       check!
 
       result = under_squash_env do
-        if options.include?(:d)
+        if Squasher.config.with?(:d)
           Squasher.tell(:dry_mode_finished)
           puts Render.render(:init_schema, config)
         else
@@ -37,7 +34,7 @@ module Squasher
     private
 
     def config
-      @config ||= ::Squasher::Config.new
+      Squasher.config
     end
 
     def check!
@@ -50,9 +47,7 @@ module Squasher
     end
 
     def migrations
-      return @migrations if @migrations
-
-      @migrations = config.migration_files.select { |file| before_date?(get_timestamp(file)) }.sort
+      @migrations ||= config.migration_files.select { |file| before_date?(get_timestamp(file)) }.sort
     end
 
     def get_timestamp(file)
@@ -71,7 +66,7 @@ module Squasher
 
     def under_squash_env
       config.stub_dbconfig do
-        if options.include?(:r)
+        if Squasher.config.with?(:r)
           Squasher.tell(:db_reuse)
         else
           return unless Squasher.rake("db:drop db:create", :db_create)

data/spec/lib/squasher_spec.rb

@@ -6,7 +6,7 @@ describe Squasher do
     specify { expected_covert("2013", Time.new(2013, 1, 1)) }
 
     def expected_covert(input, expected)
-      expect(Squasher::Worker).to receive(:process).with(expected, [])
+      expect(Squasher::Worker).to receive(:process).with(expected)
       Squasher.squash(input, [])
     end
   end

data/spec/lib/worker_spec.rb

@@ -50,21 +50,29 @@ describe Squasher::Worker do
     end
   end
 
-  specify 'the dry mode' do
-    worker = described_class.new(Time.new(2014), [:d])
-    allow(worker).to receive(:under_squash_env).and_yield.and_return(true)
-    expect(Squasher).to receive(:tell).with(:dry_mode_finished).and_call_original
-    expect(Squasher).to receive(:ask).with(:keep_database).and_return(false)
-    expect(Squasher).to receive(:rake).with("db:drop")
-    expect(Squasher).to receive(:ask).with(:apply_clean).and_return(false)
-    worker.process
-  end
+  context 'with flags' do
+    before do
+      Squasher.instance_variable_set(:@config, Squasher::Config.new)
+    end
 
-  specify 'reuse of an existing database' do
-    worker = described_class.new(Time.new(2014), [:r])
-    expect(Squasher).to receive(:tell).with(:db_reuse).and_call_original
-    expect(Squasher).not_to receive(:rake).with("db:drop db:create", :db_create)
-    allow(Squasher).to receive(:rake).with("db:migrate VERSION=20131213090719", :db_migrate).and_return(false)
-    worker.process
+    specify 'the dry mode' do
+      Squasher.config.set(:d, nil)
+      worker = described_class.new(Time.new(2014))
+      allow(worker).to receive(:under_squash_env).and_yield.and_return(true)
+      expect(Squasher).to receive(:tell).with(:dry_mode_finished).and_call_original
+      expect(Squasher).to receive(:ask).with(:keep_database).and_return(false)
+      expect(Squasher).to receive(:rake).with("db:drop")
+      expect(Squasher).to receive(:ask).with(:apply_clean).and_return(false)
+      worker.process
+    end
+
+    specify 'reuse of an existing database' do
+      Squasher.config.set(:r, nil)
+      worker = described_class.new(Time.new(2014))
+      expect(Squasher).to receive(:tell).with(:db_reuse).and_call_original
+      expect(Squasher).not_to receive(:rake).with("db:drop db:create", :db_create)
+      allow(Squasher).to receive(:rake).with("db:migrate VERSION=20131213090719", :db_migrate).and_return(false)
+      worker.process
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,3 @@
-require 'bundler/setup'
-Bundler.require
-
 module SpecHelpers
   def fake_root
     File.join(File.dirname(__FILE__), 'fake_app')
@@ -15,6 +12,9 @@ module Squasher
   end
 end
 
+require 'bundler/setup'
+Bundler.require
+
 RSpec.configure do |config|
   config.order = 'random'
   config.include SpecHelpers

data/squasher.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "squasher"
-  spec.version       = "0.2.2"
+  spec.version       = "0.3.0"
   spec.authors       = ["Sergey Pchelintsev"]
   spec.email         = ["mail@sergeyp.me"]
   spec.description   = %q{Squash your old migrations}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squasher
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Sergey Pchelintsev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,7 +70,7 @@ files:
 - lib/squasher.rb
 - lib/squasher/cleaner.rb
 - lib/squasher/config.rb
-- lib/squasher/messages.json
+- lib/squasher/messages.yml
 - lib/squasher/render.rb
 - lib/squasher/templates/init_schema.rb.erb
 - lib/squasher/templates/squasher_clean.rb.erb
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Squash your old migrations
@@ -125,4 +125,3 @@ test_files:
 - spec/lib/squasher_spec.rb
 - spec/lib/worker_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/lib/squasher/messages.json

@@ -1,42 +0,0 @@
-{
-  "keep_database" : [
-    "Squasher's created the `:green<squasher>` database for its needs.",
-    "It might be useful to keep it if any of your deleted migrations inserts data or",
-    "you squash migrations in few steps (look at -r option).",
-    "Keep it (:green<yes> / :red<no>)?"
-  ],
-
-  "apply_clean": "Do you want to clean your database from the old schema migration records(:red<yes>/:green<no>)?",
-
-  "migration_folder_missing" : [
-    "The folder with migrations is missing.",
-    "Are you sure that you're in the :red<root of a rails> application?"
-  ],
-
-  "no_migrations" : "There are no migrations in the folder prior to :red<%{date}>",
-
-  "dbconfig_invalid" : "Squasher couldn't load `:green<database.yml>`. Please, make sure that it's present and doesn't include any ruby code.",
-
-  "db_create": "Squasher is creating a tmp database",
-
-  "db_migrate": "Squasher is applying migrations on a tmp database",
-
-  "db_cleaning": "Squasher is applying the clean migration",
-
-  "db_reuse": "Squasher is reusing the database from the previous squashing",
-
-  "usage": [
-    "Example usage:",
-    "  :green<squasher> [options] :yellow<year[/month][/day]> => squash migrations prior to a specified date",
-    "  :green<squasher> :yellow<clean>                        => generate or update a cleaning migration and apply it",
-    "  :green<squasher> :yellow<info>                         => show the message",
-    "",
-    "Options:",
-    "  :yellow<-d>       => execute in :blue<`dry`> mode - test a squashing process without removing old migrations",
-    "  :yellow<-r>       => reuse a database from the previous squashing"
-  ],
-
-  "wrong_option": "You provided a wrong option :red<%{o}>",
-
-  "dry_mode_finished": "The `dry` mode is finished. Below the init schema's content:"
-}