attribute-stats 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c859c509e53910fa8ae29b43e7c34843a9da02f
-  data.tar.gz: 6355de45fcd0dea7370e39665d801b5a8bf79983
+  metadata.gz: 2cc768178279a193172676127468cc10c3f9ee32
+  data.tar.gz: bdef7d993c67edcf4e8b7ca07fa6f9ac13820eba
 SHA512:
-  metadata.gz: e97db1b7cf0a71d90f095e9922f4e1f1d0d801738e331f3f3c052fe5a44d118ca59521138d339b7bc203efcc9808fac1b0af39e50ee26dd4f7c0c78cb62dab7c
-  data.tar.gz: 0774b4ac6d48cfadeec8b8a807f06a87b462b16296967976a00bdaa607080f7dc9ad0589006bdcdfed59b854afd3fc0576cf43ffd8bd45f43c8ea6b10db422a0
+  metadata.gz: 542a32dfb641a8e486c4310249b46403f22c322d39cdbdaeabfdba468ef238e72b009275dd4f7bbe8fe04e7b777abb0612654ca3d2d0da4837b3800615c57c50
+  data.tar.gz: 7d75586f3939d08b5939b6edbf7807c7eeccb3a98c275f3d6b0ef89a5cdf0692d710d452b81c00273cbe6ae2b050cc7c98403b77cd02606ee50599c39aa9d32d

data/README.md

@@ -80,13 +80,11 @@ i.e. `rake db:stats:dormant_tables['1.year.ago',json,false]`
 ---
 
 #### rake attribute-stats:migration
-Generates a sample migration syntax to remove all unused attributes. (This is just output, not saved to disk. See the TODO below.)
+Generates a migration file to remove all unused attributes.
 
 **Argument Options:**
 1. consider_defaults_unused: true or false (default: false). This option considers attributes set to the databse default value to be unused.
 
-*TODO: actually save that generated file to the db/migrate path of the host Rails app.*
-
 ## Caveats
 
 The gem does not support:

data/lib/attribute-stats/tasks/migration.rake

@@ -1,13 +1,14 @@
 require 'attribute-stats'
 namespace :'attribute-stats' do
-	desc "Generate sample migration to remove unused attributes (and optionally those using default values) [options CONSIDER_DEFAULTS_UNUSED: false, FORMAT: json, tabular, VERBOSE: false]"
-	task :migration, [:consider_defaults_unused,:format,:verbose] => :environment do |task, args|
-		args.with_defaults(consider_defaults_unused: 'false', format: 'tabular', verbose: 'true')
+	desc "Generate migration file to remove unused attributes (and optionally those using default values) [options CONSIDER_DEFAULTS_UNUSED: false, VERBOSE: false]"
+	task :migration, [:consider_defaults_unused,:verbose] => :environment do |task, args|
+		args.with_defaults(consider_defaults_unused: 'false', verbose: 'true')
     options = {
       consider_defaults_unused: args[:consider_defaults_unused].downcase != 'false',
-                     formatter: args[:format],
                        verbose: args[:verbose].downcase != 'false',
                         source: :cli }
-    AttributeStats::StatsGenerator.new(options).migration
+    migration_file_path = AttributeStats::StatsGenerator.new(options).generate_migration
+    return unless verbose
+    puts "Generated migration at #{migration_file_path}"
 	end
 end

data/lib/attribute-stats/version.rb

@@ -1,3 +1,3 @@
 module AttributeStats
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/formatters/hash_formatter.rb

@@ -41,9 +41,5 @@ module AttributeStats
       end
       output
     end
-
-    def output_migration
-      @migration.data
-    end
   end
 end

data/lib/formatters/json_formatter.rb

@@ -12,9 +12,5 @@ module AttributeStats
     def output_unused_attributes
       super.to_json
     end
-
-    def output_migration
-      super.to_json
-    end
   end
 end

data/lib/formatters/tabular_formatter.rb

@@ -65,11 +65,6 @@ module AttributeStats
       @buffer
     end
 
-    def output_migration
-      print_section_header "Migration Syntax to delete unused attributes"
-      @migration.to_migration_file
-    end
-
     private
 
     def puts(*values)

data/lib/migration_generator/generate_migration.rb

@@ -0,0 +1,69 @@
+module AttributeStats
+  class GenerateMigration
+    def initialize(table_info: nil, options: {})
+      @table_info, @options = table_info, options
+      @table_info || set_table_info
+    end
+
+    def output_migration
+      return nil if migration_template.blank?
+      File.open(migration_file_path, 'w') do |f|
+        f.write(migration_template)
+      end
+      migration_file_path
+    end
+
+    def set_table_info
+      stats_generator = AttributeStats::StatsGenerator.new(@options)
+      stats_generator.send(:fetch_empty_attributes)
+      @table_info = stats_generator.table_info
+    end
+
+    private
+
+    def migration_file_path
+      "#{base_path}/#{next_migration_number}_remove_unused_attributes_#{migration_class_suffix}.rb"
+    end
+
+    def migration_template
+      MigrationTemplateContents.new(
+        table_info: @table_info, migration_class_suffix: migration_class_suffix
+      ).content
+    end
+
+    def migration_class_suffix
+      @migration_class_suffix ||= find_migration_class_suffix
+    end
+
+    def find_migration_class_suffix
+      existing_migration_suffix = Dir.glob("#{base_path}/[0-9]*_remove_unused_attributes_*.rb").map do |fn|
+        next unless match = fn.match(/(\d+).rb/)
+        match[1].to_i
+      end.compact.max
+      existing_migration_suffix ||= 0
+      existing_migration_suffix + 1
+    end
+
+    # The following methods are extracted from Railties
+    # railties/lib/rails/generators/migration.rb
+    def next_migration_number
+      next_migration_number = current_migration_number + 1
+      ActiveRecord::Migration.next_migration_number(next_migration_number)
+    end
+
+    def current_migration_number
+      existing_migration_lookup.collect do |file|
+        File.basename(file).split("_").first.to_i
+      end.max.to_i
+    end
+
+    def existing_migration_lookup
+      Dir.glob("#{base_path}/[0-9]*_*.rb")
+    end
+    # End Railties methods
+
+    def base_path
+      Rails.root.join('db', 'migrate')
+    end
+  end
+end

data/lib/{stats_generation/generate_migration.rb → migration_generator/migration_template_contents.rb}

@@ -1,46 +1,33 @@
 module AttributeStats
-  class GenerateMigration
-
-    def initialize(table_info: [], options: {})
-      @table_info, @options = table_info, options
-      @up_buffer   = []
-      @down_buffer = []
+  class MigrationTemplateContents
+    def initialize(table_info: nil, migration_class_suffix: nil)
+      @table_info = table_info
+      @table_info || set_table_info
+      @migration_class_suffix = migration_class_suffix
+      @migration_buffer = ''
       @table_info.each do |table_info|
         add_migrations_for_table_to_buffer(table_info)
       end
     end
 
-    def data
-      {
-          up_commands: @up_buffer,
-        down_commands: @down_buffer,
-              warning: warning
-      }
-    end
-
-    def to_migration_file
-      output = "class RemoveUnusedAttributes < ActiveRecord::Migration"
+    def content
+    	return nil if @migration_buffer.blank?
+      output = "class RemoveUnusedAttributes#{@migration_class_suffix} < ActiveRecord::Migration"
       output << "[#{Rails::VERSION::STRING}]" if Rails::VERSION::MAJOR >= 5
       output << "\n#{warning_to_width}"
       output << <<-OUTPUT
-  def up
-    #  #{@up_buffer.join("\n    #  ")}
-  end
-
-  def down
-    #  #{@down_buffer.join("\n    #  ")}
+  def change
+#{@migration_buffer}
   end
 end
       OUTPUT
       output
     end
 
-    def to_json
-      {
-          up_commands: @up_buffer,
-        down_commands: @down_buffer,
-              warning: warning
-      }
+    def set_table_info
+      stats_generator = AttributeStats::StatsGenerator.new
+      stats_generator.send(:fetch_empty_attributes)
+      @table_info = stats_generator.table_info
     end
 
     private
@@ -51,7 +38,7 @@ end
     # ActiveRecord::SchemaDumper cannot be reused for this case, so I had to extract it.
     def add_migrations_for_table_to_buffer(table_info)
       @connection ||= ActiveRecord::Base.connection
-      @types ||= @connection.native_database_types
+      @types      ||= @connection.native_database_types
 
       column_specs = []
       @connection.columns(table_info.table_name).each do |column|
@@ -59,11 +46,10 @@ end
         column_specs << column_spec_for(column)
       end
 
-      quoted_table_name  = @connection.quote_table_name(table_info.table_name)
+      quoted_table_name  = "\"#{table_info.table_name}\""
       column_specs.each do |colspec|
-        down_syntax    = [quoted_table_name, colspec[:name], ":#{colspec[:type]}", colspec[:options].presence].compact.join(', ')
-        @down_buffer  << "add_column #{down_syntax}"
-        @up_buffer    << "remove_column #{quoted_table_name}, #{colspec[:name]}"
+        down_syntax = [quoted_table_name, colspec[:name], ":#{colspec[:type]}", colspec[:options].presence].compact.join(', ')
+        @migration_buffer << "    #  remove_column #{down_syntax}\n"
       end
     end
 
@@ -141,11 +127,11 @@ end
 
     def warning
       <<-WARNING
-BUYER BEWARE/CAVEAT EMPTOR. Review this migration carefully!
-This migration code was autogenerated by analyzing database columns which are empty at the time the script was executed.
+REVIEW THIS MIGRATION CAREFULLY!
+This migration code was generated by analyzing database columns which are empty at the time the script was executed.
 IT IS YOUR RESPONSIBILITY to verify that these attributes are indeed unused in your application before running this migration. For your protection, the generated commands are COMMENTED OUT.
 If you were to uncomment the below commands and migrate your database, it is extremely likely that your application will break due to references to the removed attributes in your application code.
 WARNING
     end
-  end
-end
+	end
+end

data/lib/stats_generation/stats_generator.rb

@@ -29,9 +29,9 @@ module AttributeStats
       output formatter.output_unused_attributes
     end
 
-    def migration
-      generate_migration
-      output formatter.output_migration
+    def generate_migration
+      fetch_empty_attributes
+      GenerateMigration.new(table_info: table_info, options: options).output_migration
     end
 
     def set_formatter(formatter_type)
@@ -104,11 +104,6 @@ module AttributeStats
       end
     end
 
-    def generate_migration
-      fetch_empty_attributes
-      @migration ||= GenerateMigration.new(table_info: table_info, options: options)
-    end
-
     def initialize_tables
       return unless table_info.nil?
       @table_info = []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribute-stats
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Hodges
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -143,7 +143,8 @@ files:
 - lib/formatters/hash_formatter.rb
 - lib/formatters/json_formatter.rb
 - lib/formatters/tabular_formatter.rb
-- lib/stats_generation/generate_migration.rb
+- lib/migration_generator/generate_migration.rb
+- lib/migration_generator/migration_template_contents.rb
 - lib/stats_generation/set_attribute_stats.rb
 - lib/stats_generation/set_dormant_tables.rb
 - lib/stats_generation/stats_generator.rb