squasher 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d4dc03c57562e0746d36aebe4a6a8634197d8c9
-  data.tar.gz: a83619cd0c416384c4a818a71350d0c589b13c57
+  metadata.gz: 70564980ec4cb7bc4cad405cd0d173c46bc99f2f
+  data.tar.gz: '051554966cd007618ab03295579a2a1669c449b5'
 SHA512:
-  metadata.gz: 5fd8a985155c33c59d532510fe31a3986cad7aaa98584d41afecd17b4b74d0e0ce4c7f7749939a87e0e1b4c9ffc68ab5c64ec44d29e1b9953833b42c2eac091a
-  data.tar.gz: 6516143788c78bb5b959467282bc126981c6065fb4fab37270da8c8c274fb74a3e04d36ed2acdda6b5c5782f5296254fabc7d2ff6cbd88cc8012e5d06b90c715
+  metadata.gz: 34ebbe7ee512b65417099403b27085cb9ea5c8e329f674fec89dfe644edcce9cd82b915a2cacbef6ff516afb368e26b957abe4a9a59dd66aee5c1ce4c52cad30
+  data.tar.gz: 1a1ce4239174e3b871d45a1a5ad7d3997bfa48da3e540418bdcce852208f8f099711a0ecbb586a22beb18dba2c7b58e5dcc48efb02547015f62d21c05e7af54c

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+- 0.6.0
+  - Support apps with sql schema ([@mpospelov](https://github.com/mpospelov))
+- 0.5.1
+  - Fix work on Windows machines ([@tobmatth](https://github.com/tobmatth))
+- 0.5.0
+  - Rework command line integration. Fix clean process with Rails 5
+- 0.4.0
+  - Support rails versioned migrations which were introduced in Rails 5
+- 0.3.1
+  - fix init migration generation
+- 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
+  - add **dry** mode and ability to reuse the previous squasher database
+  - improve database config processing
+  - raise the minimum supported version of Ruby
+- 0.1.7
+  - a regression fix of the log output ([@lime](https://github.com/lime))
+  - improve a multi-platform support ([@johncarney](https://github.com/johncarney))
+- 0.1.6
+  - support multiple database settings ([@ppworks](https://github.com/ppworks))

data/README.md

@@ -59,51 +59,20 @@ You can tell `squasher` a more detailed date, for example:
 
 ### Options
 
-`-d/--dry` - execute in **dry** mode - test a squashing process without deleting old migrations. The final output will be
-printed in the console.
+Run `squasher -h` or just `squasher` to see how you can use squasher:
 
-`-r/--reuse` - reuse a database from previous squashing process. The option can be used in the next cases:
-  - you've run squasher in **dry** mode before and there were no errors
-  - you're squashing migrations gradually. For example, you want to squash migrations from 2013 till 2015, but the
-process breaks in a migration from 2014. In this situation you squash till 2014, save the squasher's
-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/--engine` - 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 --engine ../my-engine-app 2016`
-
-`-m/--migration` - for correct work with Rails 5 specify a migration version like `squasher -m 5.0 ...`
+- in sql schema rails app
+- in rails 5+ app
+- inside an engine
+- in "dry" mode
+- in "reuse" mode
 
 ## 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).
+It works and was tested on Ruby 2.0+ and Rails 3.1+. It also requires a valid development configuration in `config/database.yml`.
 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.5.1
-  - Fix work on Windows machines ([@tobmatth](https://github.com/tobmatth))
-- 0.5.0
-  - Rework command line integration. Fix clean process with Rails 5
-- 0.4.0
-  - Support rails versioned migrations which were introduced in Rails 5
-- 0.3.1
-  - fix init migration generation
-- 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
-  - add **dry** mode and ability to reuse the previous squasher database
-  - improve database config processing
-  - raise the minimum supported version of Ruby
-- 0.1.7
-  - a regression fix of the log output ([@lime](https://github.com/lime))
-  - improve a multi-platform support ([@johncarney](https://github.com/johncarney))
-- 0.1.6
-  - support multiple database settings ([@ppworks](https://github.com/ppworks))
+## (Changelog)[CHANGELOG.md]
 
 ## Contributing
 

data/bin/squasher

@@ -6,27 +6,33 @@ require 'squasher'
 
 options = {}
 parser = OptionParser.new do |config|
-  config.on('-v', '--version', '-h', '--help')
+  config.banner = 'Supported options:'
 
-  config.on('-d', '--dry') do
+  config.on('-d', '--dry', 'execute in "dry" mode(a test squashing without removing old migrations)') do
     options[:dry] = true
   end
 
-  config.on('-r', '--reuse') do
+  config.on('-s', '--sql', 'run squasher in the app with sql schema') do
+    options[:sql] = true
+  end
+
+  config.on('-m', '--migration', '=VERSION', 'define the rails migration version(since Rails 5)') do |value|
+    options[:migration] = value
+  end
+
+  config.on('-r', '--reuse', 'reuse the database from a previous squashing') do
     options[:reuse] = true
   end
 
-  config.on('-e') do
+  config.on('-e', 'run squasher in the engine(requires the dummy app inside)') do
     options[:engine] = nil
   end
 
-  config.on('--engine=PATH') do |value|
+  config.on('--engine=PATH', 'run squasher in the engine with a custom path to the dummy app') do |value|
     options[:engine] = value
   end
 
-  config.on('-m', '--migration', '=VERSION') do |value|
-    options[:migration] = value
-  end
+  config.on('-v', '--version', '-h', '--help', 'show this message')
 end
 parser.parse!
 
@@ -36,4 +42,6 @@ when /\A\d{4}/ then Squasher.squash(ARGV.first)
 when 'clean' then Squasher.clean
 else
   Squasher.tell(:usage, version: Squasher::VERSION)
+  puts ''
+  puts parser
 end

data/lib/squasher/config.rb

@@ -57,6 +57,9 @@ module Squasher
       elsif key == :migration
         Squasher.error(:invalid_migration_version, value: value) unless value.to_s =~ /\A\d.\d\z/
         @migration_version = "[#{value}]"
+      elsif key == :sql
+        @schema_file = File.join(@app_path, 'db', 'structure.sql')
+        @flags << key
       else
         @flags << key
       end

data/lib/squasher/messages.yml

@@ -18,14 +18,9 @@ usage:
 - "Squasher %{version}"
 - ""
 - "Examples of 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"
-- "  :yellow<-m> 5.0          => specify the rails migration version (added in Rails 5)"
+- "  :green<squasher> [options] :yellow<year[/month][/day]> squash migrations prior to a specified date"
+- "  :green<squasher> [options] :yellow<clean>              generate or update a cleaning migration and apply it"
+
 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:"

data/lib/squasher/render.rb

@@ -17,23 +17,49 @@ module Squasher
       ERB.new(template("#{ name }.rb"), nil, '-').result(binding)
     end
 
-    def each_schema_line
+    def each_schema_line(&block)
       File.open(config.schema_file, 'r') do |stream|
-        inside_schema = false
-        stream.each_line do |line|
-          if inside_schema
-            # reach the end of schema
-            break if line.index("end") == 0
-            yield line.gsub(/\A\s{,2}(.*)\s+\z/, '\1')
-          else
-            inside_schema = true if line.include?("ActiveRecord::Schema")
-          end
+        if @config.set?(:sql)
+          stream_structure(stream, &block)
+        else
+          stream_schema(stream, &block)
         end
       end
     end
 
     private
 
+    def stream_structure(stream)
+      yield 'execute <<-SQL'
+      skip_mode = false
+      ignored_table = ['ar_internal_metadata', 'schema_migrations']
+      stream.each_line do |line|
+        skip_mode = true if ignored_table.any? { |t| line.include?(t) }
+
+        if skip_mode
+          skip_mode = false if line.include?(';')
+          next
+        end
+
+        yield line.gsub(/\A\s{,2}(.*)\s+\z/, '\1')
+      end
+      yield 'SQL'
+    end
+
+    def stream_schema(stream)
+      inside_schema = false
+
+      stream.each_line do |line|
+        if inside_schema
+          # reach the end of schema
+          break if line.index("end") == 0
+          yield line.gsub(/\A\s{,2}(.*)\s+\z/, '\1')
+        else
+          inside_schema = true if line.include?("ActiveRecord::Schema")
+        end
+      end
+    end
+
     def template(name)
       path = File.join(File.dirname(__FILE__), "templates/#{ name }.erb")
       template = File.open(path, "rb")

data/lib/squasher/templates/init_schema.rb.erb

@@ -1,7 +1,8 @@
 class InitSchema < ActiveRecord::Migration<%= @config.migration_version %>
   def up
 <%- each_schema_line do |line| -%>
-<%= line.strip.empty? ? '' : "    #{line}" %>
+<%- next if line.strip.empty?  -%>
+<%= "    #{line}" %>
 <%- end -%>
   end
 

data/lib/squasher/version.rb

@@ -1,3 +1,3 @@
 module Squasher
-  VERSION = "0.5.2"
+  VERSION = "0.6.0"
 end

data/spec/fake_app/db/structure.sql

@@ -0,0 +1,48 @@
+CREATE TABLE cities (
+    id integer NOT NULL,
+    name character varying,
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL,
+);
+
+CREATE TABLE managers (
+    id integer NOT NULL,
+    email character varying,
+    password_digest character varying,
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
+);
+
+CREATE TABLE offices (
+    id integer NOT NULL,
+    name character varying,
+    address character varying,
+    phone character varying,
+    description text,
+    capacity integer,
+    manager_id integer,
+    city_id integer,
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
+);
+
+CREATE TABLE ar_internal_metadata (
+    key character varying NOT NULL,
+    value character varying,
+    created_at timestamp without time zone NOT NULL,
+    updated_at timestamp without time zone NOT NULL
+);
+
+CREATE TABLE schema_migrations (
+    version character varying NOT NULL
+);
+
+ALTER TABLE ONLY ar_internal_metadata
+    ADD CONSTRAINT ar_internal_metadata_pkey PRIMARY KEY (key);
+
+ALTER TABLE ONLY schema_migrations
+    ADD CONSTRAINT schema_migrations_pkey PRIMARY KEY (version);
+
+INSERT INTO "schema_migrations" (version) VALUES
+('20170831152134'),
+('20170907145259');

data/spec/lib/worker_spec.rb

@@ -55,6 +55,64 @@ describe Squasher::Worker do
       Squasher.instance_variable_set(:@config, Squasher::Config.new)
     end
 
+    specify 'the sql mode' do
+      Squasher.config.set(:sql, true)
+      worker = described_class.new(Time.new(2014))
+      allow(worker).to receive(:under_squash_env).and_yield.and_return(true)
+      new_migration_path = File.join(Dir.tmpdir, 'init_schema.rb')
+      allow_any_instance_of(Squasher::Config).to receive(:migration_file).with('20131213090719', :init_schema).and_return(new_migration_path)
+      expect(FileUtils).to receive(:rm).with(File.join(fake_root, 'db', 'migrate', '20131205160936_first_migration.rb'))
+      expect(FileUtils).to receive(:rm).with(File.join(fake_root, 'db', 'migrate', '20131213090719_second_migration.rb'))
+
+      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
+
+      expect(File.exists?(new_migration_path)).to be_truthy
+      File.open(new_migration_path) do |stream|
+        content = stream.read
+        expect(content).to eq(<<-RUBY
+class InitSchema < ActiveRecord::Migration
+  def up
+    execute <<-SQL
+    CREATE TABLE cities (
+      id integer NOT NULL,
+      name character varying,
+      created_at timestamp without time zone NOT NULL,
+      updated_at timestamp without time zone NOT NULL,
+    );
+    CREATE TABLE managers (
+      id integer NOT NULL,
+      email character varying,
+      password_digest character varying,
+      created_at timestamp without time zone NOT NULL,
+      updated_at timestamp without time zone NOT NULL
+    );
+    CREATE TABLE offices (
+      id integer NOT NULL,
+      name character varying,
+      address character varying,
+      phone character varying,
+      description text,
+      capacity integer,
+      manager_id integer,
+      city_id integer,
+      created_at timestamp without time zone NOT NULL,
+      updated_at timestamp without time zone NOT NULL
+    );
+    SQL
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration, "The initial migration is not revertable"
+  end
+end
+        RUBY
+      )
+      end
+    end
+
     specify 'the dry mode' do
       Squasher.config.set(:dry, nil)
       worker = described_class.new(Time.new(2014))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: squasher
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Sergey Pchelintsev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-05 00:00:00.000000000 Z
+date: 2017-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,6 +85,7 @@ files:
 - spec/fake_app/db/migrate/20140101010101_squasher_clean.rb
 - spec/fake_app/db/migrate/20140103124257_third_migration.rb
 - spec/fake_app/db/schema.rb
+- spec/fake_app/db/structure.sql
 - spec/lib/cleaner_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/squasher_spec.rb
@@ -123,6 +125,7 @@ test_files:
 - spec/fake_app/db/migrate/20140101010101_squasher_clean.rb
 - spec/fake_app/db/migrate/20140103124257_third_migration.rb
 - spec/fake_app/db/schema.rb
+- spec/fake_app/db/structure.sql
 - spec/lib/cleaner_spec.rb
 - spec/lib/config_spec.rb
 - spec/lib/squasher_spec.rb