declare_schema 0.1.3 → 0.2.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a1596f905dad5d9dd2f08787607c7b9adc742bbb54702bf4cf4aca812e6912
-  data.tar.gz: 60ec900d6aeb5981d0dd2df7dc689ad01a243e3c1f5b575f33813f5196614c26
+  metadata.gz: 8ce85b3e273a189a4ab8b48e333c2f12b2aea4962c0c277ae3c289f1904cddd8
+  data.tar.gz: d12345f0a483effa2724e0cd315efa759b2ace23e82ef9a1ae2cdaae28aa2571
 SHA512:
-  metadata.gz: b5dc90e36aeb33f00426de19f9df2b85d2bd40754d3bbd6bb8ff8ba410dda808139434d656e305cb9c13320e3cc4130613f06c06ef5abef7e34be4f3ed55e498
-  data.tar.gz: 39e445fb41afbf2a91dcaa1271040ede91997abcd8e6237616f1e24983d5e88c5aa77c23bcd6c98c9b104f1c8ad68b9456c34a067a807044c2d72893f52e7b3b
+  metadata.gz: 84cfbdd55c37a0404b672fbbca5c12dfeee765b0582cdf369b8b3f95159cfb8f82eb3fb1e6149e830ba4fe4481d6df6ef4df45398e30985380ae6681c731f8a9
+  data.tar.gz: adeda560e6bb859104b78e3710fb94d438606cf42c10b199527e5d14545505dda6dde3206500a5f7ea38b79530952182954f5e3892779f9d96db9270d59a28f1

data/CHANGELOG.md

@@ -4,6 +4,13 @@ Inspired by [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 Note: this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.0] - Unreleased
+### Added
+- Automatically eager_load! all Rails::Engines before generating migrations.
+
+### Changed
+- Changed tests from rdoctest to rspec.
+
 ## [0.1.3] - Unreleased
 ### Changed
 - Updated the `always_ignore_tables` list in `Migrator` to access Rails metadata table names
@@ -18,6 +25,7 @@ using the appropriate Rails configuration attributes.
 ### Added
 - Initial version from https://github.com/Invoca/hobo_fields v4.1.0.
 
+[0.2.0]: https://github.com/Invoca/declare_schema/compare/v0.1.3...v0.2.0
 [0.1.3]: https://github.com/Invoca/declare_schema/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/Invoca/declare_schema/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/Invoca/declare_schema/tree/v0.1.1

data/Gemfile

@@ -18,6 +18,5 @@ gem 'rails',            '~> 5.2', '>= 5.2.4.3'
 gem 'responders'
 gem 'rspec'
 gem 'rubocop'
-gem 'rubydoctest'
 gem 'sqlite3'
 gem 'yard'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.1.3)
+    declare_schema (0.2.0.pre.1)
       rails (>= 4.2)
 
 GEM
@@ -159,7 +159,6 @@ GEM
     rubocop-ast (0.4.2)
       parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
-    rubydoctest (1.1.5)
     sprockets (4.0.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -194,7 +193,6 @@ DEPENDENCIES
   responders
   rspec
   rubocop
-  rubydoctest
   sqlite3
   yard
 

data/Rakefile

@@ -14,7 +14,6 @@ $LOAD_PATH.unshift File.expand_path('lib', __dir__)
 require 'declare_schema'
 
 RUBY = 'ruby'
-RUBYDOCTEST = ENV['RUBYDOCTEST'] || "#{RUBY} -S rubydoctest"
 GEM_ROOT = __dir__
 TESTAPP_PATH = ENV['TESTAPP_PATH'] || File.join(Dir.tmpdir, 'declare_schema_testapp')
 BIN = File.expand_path('bin/declare_schema', __dir__)
@@ -24,13 +23,7 @@ task default: 'test:all'
 include Rake::DSL
 
 namespace "test" do
-  task all: [:doctest, :spec]
-
-  desc "Run the doctests"
-  task :doctest do |_t|
-    files = Dir['test/*.rdoctest'].sort.map { |f| File.expand_path(f) }.join(' ')
-    system("#{RUBYDOCTEST} --trace --verbose #{files}") or exit(1)
-  end
+  task all: :spec
 
   desc "Prepare a rails application for testing"
   task :prepare_testapp, :force do |_t, args|
@@ -38,19 +31,19 @@ namespace "test" do
       FileUtils.remove_entry_secure(TESTAPP_PATH, true)
       sh %(#{BIN} new #{TESTAPP_PATH} --skip-wizard --skip-bundle)
       FileUtils.chdir TESTAPP_PATH
-      sh %(bundle install)
-      sh %(echo "" >> Gemfile)
-      sh %(echo "gem 'irt', :group => :development" >> Gemfile) # to make the bundler happy
-      sh %(echo "gem 'therubyracer'" >> Gemfile)
-      sh %(echo "gem 'kramdown'" >> Gemfile)
-      sh %(echo "" > app/models/.gitignore) # because git reset --hard would rm the dir
-      rm %(.gitignore) # we need to reset everything in a testapp
-      sh %(git init && git add . && git commit -m "initial commit")
-      puts %(The testapp has been created in '#{TESTAPP_PATH}')
+      sh "bundle install"
+      sh "(echo '';
+           echo \"gem 'irt', :group => :development\";
+           echo \"gem 'therubyracer'\";
+           echo \"gem 'kramdown'\") > Gemfile"
+      sh "echo '' > app/models/.gitignore" # because git reset --hard would rm the dir
+      rm ".gitignore" # we need to reset everything in a testapp
+      sh "git init && git add . && git commit -m \"initial commit\""
+      puts "The testapp has been created in '#{TESTAPP_PATH}'"
     else
-      FileUtils.chdir TESTAPP_PATH
-      sh %(git add .)
-      sh %(git reset --hard -q HEAD)
+      FileUtils.chdir(TESTAPP_PATH)
+      sh "git add ."
+      sh "git reset --hard -q HEAD"
     end
   end
 end

data/gemfiles/rails_4.gemfile

@@ -11,7 +11,6 @@ gem "rails", "~> 4.2"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "rubydoctest"
 gem "sqlite3", "~> 1.3.0"
 gem "yard"
 

data/gemfiles/rails_5.gemfile

@@ -11,7 +11,6 @@ gem "rails", "~> 5.2"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "rubydoctest"
 gem "sqlite3"
 gem "yard"
 

data/gemfiles/rails_6.gemfile

@@ -11,7 +11,6 @@ gem "rails", "~> 6.0"
 gem "responders"
 gem "rspec"
 gem "rubocop"
-gem "rubydoctest"
 gem "sqlite3"
 gem "yard"
 

data/lib/declare_schema/model.rb

@@ -117,7 +117,6 @@ module DeclareSchema
         end
         column_options = {}
         column_options[:null] = options.delete(:null) || false
-        column_options[:comment] = options.delete(:comment) if options.has_key?(:comment)
         column_options[:default] = options.delete(:default) if options.has_key?(:default)
         column_options[:limit] = options.delete(:limit) if options.has_key?(:limit)
 

data/lib/declare_schema/model/field_spec.rb

@@ -102,10 +102,6 @@ module DeclareSchema
         @options[:default]
       end
 
-      def comment
-        @options[:comment]
-      end
-
       def same_type?(col_spec)
         type = sql_type
         normalized_type           = TYPE_SYNONYMS[type] || type
@@ -115,13 +111,6 @@ module DeclareSchema
 
       def different_to?(col_spec)
         !same_type?(col_spec) ||
-          # we should be able to use col_spec.comment, but col_spec has
-          # a nil table_name for some strange reason.
-          (model.table_exists? &&
-            ActiveRecord::Base.respond_to?(:column_comment) &&
-            !(col_comment = ActiveRecord::Base.column_comment(col_spec.name, model.table_name)).nil? &&
-            col_comment != comment
-          ) ||
           begin
             native_type = native_types[type]
             check_attributes = [:null, :default]

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.1.3"
+  VERSION = "0.2.0.pre.1"
 end

data/lib/generators/declare_schema/migration/migration_generator.rb

@@ -3,7 +3,7 @@
 require 'rails/generators/migration'
 require 'rails/generators/active_record'
 require 'generators/declare_schema/support/thor_shell'
-require_relative '../../../declare_schema/model/field_spec'
+require 'declare_schema/model/field_spec'
 
 module DeclareSchema
   class MigrationGenerator < Rails::Generators::Base
@@ -86,7 +86,7 @@ module DeclareSchema
         @down = down
         @migration_class_name = final_migration_name.camelize
 
-        migration_template 'migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb"
+        migration_template('migration.rb.erb', "db/migrate/#{final_migration_name.underscore}.rb")
         if action == 'm'
           case Rails::VERSION::MAJOR
           when 4
@@ -118,14 +118,13 @@ module DeclareSchema
                              ActiveRecord::Migrator.new(:up, migrations, ActiveRecord::SchemaMigration).pending_migrations
                            end
 
-      if pending_migrations.any?
-        say "You have #{pending_migrations.size} pending migration#{'s' if pending_migrations.size > 1}:"
-        pending_migrations.each do |pending_migration|
-          say format('  %4d %s', pending_migration.version, pending_migration.name)
+      pending_migrations.any?.tap do |any|
+        if any
+          say "You have #{pending_migrations.size} pending migration#{'s' if pending_migrations.size > 1}:"
+          pending_migrations.each do |pending_migration|
+            say format('  %4d %s', pending_migration.version, pending_migration.name)
+          end
         end
-        true
-      else
-        false
       end
     end
 
@@ -139,10 +138,10 @@ module DeclareSchema
           loop do
             if rename_to_choices.empty?
               say "\nCONFIRM DROP! #{kind_str} #{name_prefix}#{t}"
-              resp = ask("Enter 'drop #{t}' to confirm or press enter to keep:")
-              if resp.strip == "drop #{t}"
+              resp = ask("Enter 'drop #{t}' to confirm or press enter to keep:").strip
+              if resp == "drop #{t}"
                 break
-              elsif resp.strip.empty?
+              elsif resp.empty?
                 to_drop.delete(t)
                 break
               else
@@ -151,8 +150,7 @@ module DeclareSchema
             else
               say "\nDROP, RENAME or KEEP?: #{kind_str} #{name_prefix}#{t}"
               say "Rename choices: #{to_create * ', '}"
-              resp = ask "Enter either 'drop #{t}' or one of the rename choices or press enter to keep:"
-              resp = resp.strip
+              resp = ask("Enter either 'drop #{t}' or one of the rename choices or press enter to keep:").strip
 
               if resp == "drop #{t}"
                 # Leave things as they are
@@ -183,3 +181,11 @@ module DeclareSchema
     end
   end
 end
+
+module Generators
+  module DeclareSchema
+    module Migration
+      MigrationGenerator = ::DeclareSchema::MigrationGenerator
+    end
+  end
+end

data/lib/generators/declare_schema/migration/migrator.rb

@@ -106,15 +106,23 @@ module Generators
 
         attr_accessor :renames
 
+        # TODO: Add an application callback (maybe an initializer in a special group?) that
+        # the application can use to load other models that live in the database, to support DeclareSchema migrations
+        # for them.
         def load_rails_models
+          ActiveRecord::Migration.verbose = false
+
           Rails.application.eager_load!
+          Rails::Engine.subclasses.each(&:eager_load!)
         end
 
         # Returns an array of model classes that *directly* extend
         # ActiveRecord::Base, excluding anything in the CGI module
         def table_model_classes
           load_rails_models
-          ActiveRecord::Base.send(:descendants).reject { |c| (c.base_class != c) || c.name.starts_with?("CGI::") }
+          ActiveRecord::Base.send(:descendants).select do |klass|
+            klass.base_class == klass && !klass.name.starts_with?("CGI::")
+          end
         end
 
         def connection
@@ -217,7 +225,7 @@ module Generators
           end
         end
 
-        def always_ignore_tables
+        def self.always_ignore_tables
           sessions_table =
             begin
               if defined?(CGI::Session::ActiveRecordStore::Session) &&
@@ -231,8 +239,8 @@ module Generators
 
           [
             'schema_info',
-            ActiveRecord::Base.schema_migrations_table_name,
-            ActiveRecord::Base.internal_metadata_table_name,
+            ActiveRecord::Base.try(:schema_migrations_table_name) || 'schema_migrations',
+            ActiveRecord::Base.try(:internal_metadata_table_name) || 'ar_internal_metadata',
             sessions_table
           ].compact
         end
@@ -256,7 +264,7 @@ module Generators
           model_table_names = models_by_table_name.keys
 
           to_create = model_table_names - db_tables
-          to_drop = db_tables - model_table_names - always_ignore_tables
+          to_drop = db_tables - model_table_names - self.class.always_ignore_tables
           to_change = model_table_names
           to_rename = extract_table_renames!(to_create, to_drop)
 
@@ -411,7 +419,6 @@ module Generators
               change_spec[:scale]     = spec.scale     unless spec.scale.nil?
               change_spec[:null]      = spec.null      unless spec.null && col.null
               change_spec[:default]   = spec.default   unless spec.default.nil? && col.default.nil?
-              change_spec[:comment]   = spec.comment   unless spec.comment.nil? && (col.comment if col.respond_to?(:comment)).nil?
 
               changes << "change_column :#{new_table_name}, :#{c}, " +
                          ([":#{spec.sql_type}"] + format_options(change_spec, spec.sql_type, changing: true)).join(", ")

data/lib/generators/declare_schema/migration/templates/migration.rb.erb

@@ -1,4 +1,4 @@
-class <%= @migration_class_name %> < ActiveRecord::Migration<%= Rails::VERSION::MAJOR > 4 ? '[4.2]' : '' %>
+class <%= @migration_class_name %> < ActiveRecord::Migration<%= ('[4.2]' if Rails::VERSION::MAJOR >= 5) %>
   def self.up
     <%= @up %>
   end

data/lib/generators/declare_schema/support/eval_template.rb

@@ -9,9 +9,18 @@ module DeclareSchema
             private
 
             def eval_template(template_name)
-              source  = File.expand_path(find_in_source_paths(template_name))
-              context = instance_eval('binding')
-              ERB.new(::File.binread(source), trim_mode: '-').result(context)
+              source = File.expand_path(find_in_source_paths(template_name))
+              erb = ERB.new(::File.read(source).force_encoding(Encoding::UTF_8), trim_mode: '>')
+              erb.filename = source
+              begin
+                erb.result(binding)
+              rescue Exception => ex
+                raise ex.class, <<~EOS
+                  #{ex.message}
+                  #{erb.src}
+                    #{ex.backtrace.join("\n  ")}
+                EOS
+              end
             end
           end
         end

data/lib/generators/declare_schema/support/model.rb

@@ -4,6 +4,39 @@ require_relative './eval_template'
 
 module DeclareSchema
   module Support
+    class IndentedBuffer
+      def initialize(indent: 0)
+        @string = +""
+        @indent = indent
+        @column = 0
+        @indent_amount = 2
+      end
+
+      def to_string
+        @string
+      end
+
+      def indent!
+        @indent += @indent_amount
+        yield
+        @indent -= @indent_amount
+      end
+
+      def newline!
+        @column = 0
+        @string << "\n"
+      end
+
+      def <<(str)
+        if (difference = @indent - @column) > 0
+          @string << ' ' * difference
+        end
+        @column += difference
+        @string << str
+        newline!
+      end
+    end
+
     module Model
       class << self
         def included(base)
@@ -26,9 +59,51 @@ module DeclareSchema
 
             def inject_declare_schema_code_into_model_file
               gsub_file(model_path, /  # attr_accessible :title, :body\n/m, "")
-              inject_into_class model_path, class_name do
-                eval_template('model_injection.rb.erb')
+              inject_into_class(model_path, class_name) do
+                declare_model_fields_and_associations
+              end
+            end
+
+            private
+
+            def declare_model_fields_and_associations
+              buffer = ::DeclareSchema::Support::IndentedBuffer.new(indent: 2)
+              buffer.newline!
+              buffer << 'fields do'
+              buffer.indent! do
+                field_attributes.each do |attribute|
+                  decl = "%-#{max_attribute_length}s" % attribute.name + ' ' +
+                    attribute.type.to_sym.inspect +
+                    case attribute.type.to_s
+                    when 'string'
+                      ', limit: 255'
+                    else
+                      ''
+                    end
+                  buffer << decl
+                end
+                if options[:timestamps]
+                  buffer.newline!
+                  buffer << 'timestamps'
+                end
+              end
+              buffer << 'end'
+
+              if bts.any?
+                buffer.newline!
+                bts.each do |bt|
+                  buffer << "belongs_to #{bt.to_sym.inspect}"
+                end
               end
+              if hms.any?
+                buffer.newline
+                hms.each do |hm|
+                  buffer << "has_many #{hm.to_sym.inspect}, dependent: :destroy"
+                end
+              end
+              buffer.newline!
+
+              buffer.to_string
             end
 
             protected

data/spec/lib/declare_schema/api_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'rails/generators'
+
+RSpec.describe 'DeclareSchema API' do
+  before do
+    load File.expand_path('prepare_testapp.rb', __dir__)
+  end
+
+  describe 'example models' do
+    it 'generates a model' do
+      expect(system("bundle exec rails generate declare_schema:model advert title:string body:text")).to be_truthy
+
+      # The above will generate the test, fixture and a model file like this:
+      # model_declaration = Rails::Generators.invoke('declare_schema:model', ['advert2', 'title:string', 'body:text'])
+      # expect(model_declaration.first).to eq([["Advert"], nil, "app/models/advert.rb", nil,
+      #                                       [["AdvertTest"], "test/models/advert_test.rb", nil, "test/fixtures/adverts.yml"]])
+
+      expect(File.read("#{TESTAPP_PATH}/app/models/advert.rb")).to eq(<<~EOS)
+        class Advert < #{active_record_base_class}
+
+          fields do
+            title :string, limit: 255
+            body  :text
+          end
+
+        end
+      EOS
+      system("rm -rf #{TESTAPP_PATH}/app/models/advert2.rb #{TESTAPP_PATH}/test/models/advert2.rb #{TESTAPP_PATH}/test/fixtures/advert2.rb")
+
+      # The migration generator uses this information to create a migration.
+      # The following creates and runs the migration:
+
+      expect(system("bundle exec rails generate declare_schema:migration -n -m")).to be_truthy
+
+      # We're now ready to start demonstrating the API
+
+      Rails.application.config.autoload_paths += ["#{TESTAPP_PATH}/app/models"]
+
+      $LOAD_PATH << "#{TESTAPP_PATH}/app/models"
+
+      unless Rails::VERSION::MAJOR >= 6
+        # TODO: get this to work on Travis for Rails 6
+        Rails::Generators.invoke('declare_schema:migration', %w[-n -m])
+      end
+
+      require 'advert'
+
+      ## The Basics
+
+      # The main feature of DeclareSchema, aside from the migration generator, is the ability to declare rich types for your fields. For example, you can declare that a field is an email address, and the field will be automatically validated for correct email address syntax.
+
+      ### Field Types
+
+      # Field values are returned as the type you specify.
+
+      Advert.destroy_all
+
+      a = Advert.new(body: "This is the body", id: 1, title: "title")
+      expect(a.body).to eq("This is the body")
+
+      # This also works after a round-trip to the database
+
+      a.save!
+      expect(a.reload.body).to eq("This is the body")
+
+      ## Names vs. Classes
+
+      ## Model extensions
+
+      # DeclareSchema adds a few features to your models.
+
+      ### `Model.attr_type`
+
+      # Returns the type (i.e. class) declared for a given field or attribute
+
+      Advert.connection.schema_cache.clear!
+      Advert.reset_column_information
+
+      expect(Advert.attr_type(:title)).to eq(String)
+      expect(Advert.attr_type(:body)).to eq(String)
+
+      ## Field validations
+
+      # DeclareSchema gives you some shorthands for declaring some common validations right in the field declaration
+
+      ### Required fields
+
+      # The `:required` argument to a field gives a `validates_presence_of`:
+
+      class AdvertWithRequiredTitle < ActiveRecord::Base
+        self.table_name = 'adverts'
+
+        fields do
+          title :string, :required, limit: 255
+        end
+      end
+
+      a = AdvertWithRequiredTitle.new
+      expect(a.valid? || a.errors.full_messages).to eq(["Title can't be blank"])
+      a.id = 2
+      a.body = "hello"
+      a.title = "Jimbo"
+      a.save!
+
+      ### Unique fields
+
+      # The `:unique` argument in a field declaration gives `validates_uniqueness_of`:
+
+      class AdvertWithUniqueTitle < ActiveRecord::Base
+        self.table_name = 'adverts'
+
+        fields do
+          title :string, :unique, limit: 255
+        end
+      end
+
+      a = AdvertWithUniqueTitle.new :title => "Jimbo", id: 3, body: "hello"
+      expect(a.valid? || a.errors.full_messages).to eq(["Title has already been taken"])
+      a.title = "Sambo"
+      a.save!
+    end
+  end
+end