declare_schema 0.1.2 → 0.3.0.pre.2

data/spec/lib/declare_schema/prepare_testapp.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+
+TESTAPP_PATH = ENV['TESTAPP_PATH'] || File.join(Dir.tmpdir, 'declare_schema_testapp') unless defined?(TESTAPP_PATH)
+FileUtils.chdir(TESTAPP_PATH)
+
+system "rm -rf app/models/ad* app/models/alpha*"
+system "rm -rf test/models/ad* test/models/alpha*"
+system "rm -rf test/fixtures/ad* test/fixtures/alpha*"
+system "rm -rf db/migrate/*"
+system "mkdir -p #{TESTAPP_PATH}/app/assets/config"
+system "echo '' >> #{TESTAPP_PATH}/app/assets/config/manifest.js"
+
+require "#{TESTAPP_PATH}/config/environment"
+
+require 'rails/generators'
+Rails::Generators.configure!(Rails.application.config.generators)
+
+(ActiveRecord::Base.connection.tables - Generators::DeclareSchema::Migration::Migrator.always_ignore_tables).each do |table|
+  ActiveRecord::Base.connection.execute("DROP TABLE #{ActiveRecord::Base.connection.quote_table_name(table)}")
+end
+
+ActiveRecord::Base.send(:descendants).each do |model|
+  unless model.name['Active'] || model.name['Application']
+    nuke_model_class(model)
+  end
+end

data/spec/lib/generators/declare_schema/migration/migrator_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'rails/generators'
+
+module Generators
+  module DeclareSchema
+    module Migration
+      RSpec.describe Migrator do
+        before do
+          ActiveRecord::Base.connection.tables
+        end
+
+        subject { described_class.new }
+
+        describe 'format_options' do
+          let(:mysql_longtext_limit) { 0xffff_ffff }
+
+          context 'MySQL' do
+            before do
+              expect(::DeclareSchema::Model::FieldSpec).to receive(:mysql_text_limits?).and_return(true)
+            end
+
+            it 'returns text limits' do
+              expect(subject.format_options({ limit: mysql_longtext_limit }, :text)).to eq(["limit: #{mysql_longtext_limit}"])
+            end
+          end
+
+          context 'non-MySQL' do
+            before do
+              expect(::DeclareSchema::Model::FieldSpec).to receive(:mysql_text_limits?).and_return(false)
+            end
+
+            it 'returns text limits' do
+              expect(subject.format_options({ limit: mysql_longtext_limit }, :text)).to eq([])
+            end
+          end
+        end
+
+        describe '#before_generating_migration' do
+          it 'requires a block be passed' do
+            expect { described_class.before_generating_migration }.to raise_error(ArgumentError, 'A block is required when setting the before_generating_migration callback')
+          end
+        end
+
+        describe 'load_rails_models' do
+          before do
+            expect(Rails.application).to receive(:eager_load!)
+            expect(Rails::Engine).to receive(:subclasses).and_return([])
+          end
+
+          subject { described_class.new.load_rails_models }
+
+          context 'when a before_generating_migration callback is configured' do
+            let(:dummy_proc) { -> {} }
+
+            before do
+              described_class.before_generating_migration(&dummy_proc)
+              expect(dummy_proc).to receive(:call).and_return(true)
+            end
+
+            it { should be_truthy }
+          end
+
+          context 'when no before_generating_migration callback is configured' do
+            it { should be_nil }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -22,6 +22,32 @@ RSpec.configure do |config|
 
   RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
 
+  def active_record_base_class
+    if Rails::VERSION::MAJOR == 4
+      'ActiveRecord::Base'
+    else
+      'ApplicationRecord'
+    end
+  end
+
+  def migrate(renames = {})
+    up, down = Generators::DeclareSchema::Migration::Migrator.run(renames)
+    ActiveRecord::Migration.class_eval(up)
+    ActiveRecord::Base.send(:descendants).each { |model| model.reset_column_information }
+    [up, down]
+  end
+
+  def nuke_model_class(klass)
+    ActiveSupport::DescendantsTracker.instance_eval do
+      direct_descendants = class_variable_get('@@direct_descendants')
+      direct_descendants[ActiveRecord::Base] = direct_descendants[ActiveRecord::Base].to_a.reject { |descendant| descendant == klass }
+      if defined?(ApplicationRecord)
+        direct_descendants[ApplicationRecord] = direct_descendants[ApplicationRecord].to_a.reject { |descendant| descendant == klass }
+      end
+    end
+    Object.instance_eval { remove_const(klass.name.to_sym) rescue nil }
+  end
+
   def with_modified_env(options, &block)
     ClimateControl.modify(options, &block)
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0.pre.2
 platform: ruby
 authors:
 - Invoca Development adapted from hobo_fields by Tom Locke
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-30 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -68,24 +68,23 @@ files:
 - lib/generators/declare_schema/migration/templates/migration.rb.erb
 - lib/generators/declare_schema/model/USAGE
 - lib/generators/declare_schema/model/model_generator.rb
-- lib/generators/declare_schema/model/templates/model_injection.rb.erb
 - lib/generators/declare_schema/support/eval_template.rb
 - lib/generators/declare_schema/support/model.rb
 - lib/generators/declare_schema/support/thor_shell.rb
+- spec/lib/declare_schema/api_spec.rb
 - spec/lib/declare_schema/field_declaration_dsl_spec.rb
+- spec/lib/declare_schema/generator_spec.rb
+- spec/lib/declare_schema/interactive_primary_key_spec.rb
+- spec/lib/declare_schema/migration_generator_spec.rb
+- spec/lib/declare_schema/prepare_testapp.rb
+- spec/lib/generators/declare_schema/migration/migrator_spec.rb
 - spec/spec_helper.rb
-- test/api.rdoctest
-- test/generators.rdoctest
-- test/interactive_primary_key.rdoctest
-- test/migration_generator.rdoctest
-- test/migration_generator_comments.rdoctestDISABLED
-- test/prepare_testapp.rb
 - test_responses.txt
 homepage: https://github.com/Invoca/declare_schema
 licenses: []
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Database migration generator for Rails
 test_files: []

data/lib/generators/declare_schema/model/templates/model_injection.rb.erb

@@ -1,25 +0,0 @@
-
-  fields do
-<% for attribute in field_attributes -%>
-    <%= "%-#{max_attribute_length}s" % attribute.name %> :<%= attribute.type %><%=
-      case attribute.type.to_s
-      when 'string'
-        ', limit: 255'
-      else
-        ''
-      end
-    %>
-<% end -%>
-<% if options[:timestamps] -%>
-    timestamps
-<% end -%>
-  end
-
-<% for bt in bts -%>
-  belongs_to :<%= bt %>
-<% end -%>
-<%= "\n" unless bts.empty? -%>
-<% for hm in hms -%>
-  has_many :<%= hm %>, dependent: :destroy
-<% end -%>
-<%= "\n" unless hms.empty? -%>

data/test/api.rdoctest

@@ -1,136 +0,0 @@
-# DeclareSchema API
-
-In order for the API examples to run we need to load the rails generators of our testapp:
-{.hidden}
-
-    doctest: prepare testapp environment
-    doctest_require: 'prepare_testapp'
-{.hidden}
-
-## Example Models
-
-Let's define some example models that we can use to demonstrate the API. With DeclareSchema we can use the 'declare_schema:model' generator like so:
-
-    $ rails generate declare_schema:model advert title:string body:text
-
-This will generate the test, fixture and a model file like this:
-
-    >> Rails::Generators.invoke 'declare_schema:model', %w(advert title:string body:text)
-{.hidden}
-
-    class Advert < ActiveRecord::Base
-      fields do
-        title :string
-        body :text, limit: 0xffff, null: true
-      end
-    end
-
-The migration generator uses this information to create a migration. The following creates and runs the migration so we're ready to go.
-
-    $ rails generate declare_schema:migration -n -m
-
-We're now ready to start demonstrating the API
-
-    >> require_relative "#{Rails.root}/app/models/advert.rb" if Rails::VERSION::MAJOR > 5
-    >> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
-    >> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
-{.hidden}
-
-## 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.
-
-        >> a = Advert.new :body => "This is the body", id: 1, title: "title"
-        >> a.body.class
-        => String
-
-This also works after a round-trip to the database
-
-        >> a.save
-        >> b = Advert.find(a.id)
-        >> b.body.class
-        => String
-
-## Names vs. Classes
-
-The full set of available symbolic names is
-
- * `:integer`
- * `:float`
- * `:decimal`
- * `:string`
- * `:text`
- * `:boolean`
- * `:date`
- * `:datetime`
- * `:html`
- * `:textile`
- * `:markdown`
- * `:password`
-
-You can add your own types too. More on that later.
-
-
-## 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
-        >> Advert.attr_type :title
-        => String
-        >> Advert.attr_type :body
-        => 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 Advert
-           fields do
-             title :string, :required, limit: 255
-           end
-         end
-        >> a = Advert.new
-        >> a.valid?
-        => false
-        >> a.errors.full_messages
-        => ["Title can't be blank"]
-        >> a.id = 2
-        >> a.body = "hello"
-        >> a.title = "Jimbo"
-        >> a.save
-        => true
-
-
-### Unique fields
-
-The `:unique` argument in a field declaration gives `validates_uniqueness_of`:
-
-        >>
-         class Advert
-           fields do
-             title :string, :unique, limit: 255
-           end
-         end
-        >> a = Advert.new :title => "Jimbo", id: 3, body: "hello"
-        >> a.valid?
-        => false
-        >> a.errors.full_messages
-        => ["Title has already been taken"]
-        >> a.title = "Sambo"
-        >> a.save
-        => true

data/test/generators.rdoctest

@@ -1,62 +0,0 @@
-doctest: prepare testapp environment
-doctest_require: 'prepare_testapp'
-
-doctest: generate declare_schema:model
->> begin; Rails::Generators.invoke 'declare_schema:model', %w(alpha/beta one:string two:integer); rescue => ex; $stderr.puts "#{ex.class}: #{ex}\n#{ex.backtrace.join("\n")}"; end
-
-
-doctest: model file exists
->> File.exist? 'app/models/alpha/beta.rb'
-=> true
-
-doctest: model content matches
->> File.read 'app/models/alpha/beta.rb'
-=> "class Alpha::Beta < #{Rails::VERSION::MAJOR > 4 ? 'ApplicationRecord' : 'ActiveRecord::Base'}\n\n  fields do\n    one :string, limit: 255\n    two :integer\n  end\n\nend\n"
-
-doctest: module file exists
->> File.exist? 'app/models/alpha.rb'
-=> true
-
-doctest: module content matches
->> File.read 'app/models/alpha.rb'
-=> "module Alpha\n  def self.table_name_prefix\n    'alpha_'\n  end\nend\n"
-
-
-doctest: test file exists
->> File.exist? 'test/models/alpha/beta_test.rb'
-=> true
-
-doctest: test content matches
->> File.read 'test/models/alpha/beta_test.rb'
-=>
-require 'test_helper'
-
-class Alpha::BetaTest < ActiveSupport::TestCase
-  # test "the truth" do
-  #   assert true
-  # end
-end
-
-doctest: fixture file exists
->> File.exist? 'test/fixtures/alpha/beta.yml'
-=> true
-
-
-doctest: generate declare_schema:migration
->> puts "#{Rails.root}/app/models/alpha.rb"
->> require "#{Rails.root}/app/models/alpha.rb" if Rails::VERSION::MAJOR > 4
->> require "#{Rails.root}/app/models/alpha/beta.rb" if Rails::VERSION::MAJOR > 4
->> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
-
-doctest: schema.rb file exists
->> system("ls -al db")
->> File.exist? 'db/schema.rb'
-=> true
-
-doctest: db file exists
->> File.exist?("db/development.sqlite3") || File.exist?("db/test.sqlite3")
-=> true
-
-doctest: Alpha::Beta class exists
->> Alpha::Beta
-# will error if class doesn't exist

data/test/interactive_primary_key.rdoctest

@@ -1,56 +0,0 @@
--*- indent-tabs-mode:nil; -*-
-
-# DeclareSchema - Migration Generator
-
-Our test requires to prepare the testapp:
-{.hidden}
-
-    doctest_require: 'prepare_testapp'
-
-{.hidden}
-
-And requires also that you enter the right choice when prompted. OK we're ready to get going.
-
-## Alternate Primary Keys
-
-### create
-   doctest: create table with custom primary_key
-   >>
-    class Foo < ActiveRecord::Base
-      fields do
-      end
-      self.primary_key="foo_id"
-    end
-   >> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
-   >> Foo.primary_key
-   => 'foo_id'
-
-### migrate from
-   doctest: rename from custom primary_key
-   >>
-    class Foo < ActiveRecord::Base
-      self.primary_key="id"
-    end
-    puts "\n\e[45m Please enter 'id' (no quotes) at the next prompt \e[0m"
-   >> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
-   >> Foo.primary_key
-   => 'id'
-
-### migrate to
-
-   doctest: rename to custom primary_key
-   >>
-    class Foo < ActiveRecord::Base
-      self.primary_key="foo_id"
-    end
-    puts "\n\e[45m Please enter 'drop id' (no quotes) at the next prompt \e[0m"
-   >> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
-   >> Foo.primary_key
-   => 'foo_id'
-
-### ensure it doesn't cause further migrations
-
-   doctest: check no further migrations
-   >> up, down = Generators::DeclareSchema::Migration::Migrator.run
-   >> up
-   => ""