declare_schema 0.1.0

data/test/migration_generator_comments.rdoctestDISABLED

@@ -0,0 +1,74 @@
+# DeclareSchema - Migration Generator Comments
+
+Our test requires to prepare the testapp for a different environment:
+{.hidden}
+
+    doctest_require: ENV["RAILS_ENV"] = 'mysql_test'; 'prepare_testapp'
+
+    >> system "cd #{TESTAPP_PATH} && rake --trace db:setup"
+    => true
+
+    >> p Rails.env
+    >>
+     def nuke_model_class(klass)
+       ActiveSupport::DescendantsTracker.instance_eval do
+         class_variable_get('@@direct_descendants')[ActiveRecord::Base].delete(klass)
+       end
+      Object.instance_eval { remove_const klass.name.to_sym }
+     end
+
+{.hidden}
+
+
+## Comments
+
+Comments can be added to tables and fields with DeclareSchema.
+
+    >>
+     class Product < ActiveRecord::Base
+       fields do
+         name :string, comment: "short name"
+         description :string
+       end
+     end
+    >> Rails.env
+    => "mysql_test"
+    >> Rails::Generators.invoke 'declare_schema:migration', %w(-n -m)
+
+These comments will be saved to your schema if you have the [column_comments](http://github.com/bryanlarsen/column_comments) plugin installed.  If you do not have this plugin installed, the comments will be available by querying `field_specs`:
+
+    >> Product.field_specs["name"].comment
+    => "short name"
+
+The plugin [activerecord-comments](http://github.com/bryanlarsen/activerecord-comments) may be used to get the comments from the database directly.  If the plugin is installed, use this instead:
+
+    Product.column("name").comment
+
+Because it will be quite common for people not to have both [column_comments](http://github.com/bryanlarsen/column_comments) and [activerecord-comments](http://github.com/bryanlarsen/activerecord-comments) installed, it is impossible for DeclareSchema to determine the difference between no previous comment and a previously missing plugin.   Therefore, DeclareSchema will not generate a migration if the only change was to add a comment.  DeclareSchema will generate a migration for a comment change, but only if the plugin is installed.
+
+    >> require 'activerecord-comments'
+
+    >> # manually add comment as the column_comments plugin would
+    >> Product.connection.execute "alter table `products` modify `name` varchar(255) default null comment 'short name';"
+
+    >>
+     class Product < ActiveRecord::Base
+       fields do
+         name :string, comment: "Short namex"
+         description :string, comment: "Long name"
+       end
+     end
+    >> up, down = Generators::DeclareSchema::Migration::Migrator.run
+    >> up.split(',').slice(0,3).join(',')
+    => 'change_column :products, :name, :string'
+    >> up.split(',').slice(3,2).sort.join(',')
+    => " :comment => \"Short namex\", :limit => 255"
+
+
+Cleanup
+{.hidden}
+
+    >> nuke_model_class(Product)
+    >> ActiveRecord::Base.connection.execute "drop table `products`;"
+    >> system "cd #{TESTAPP_PATH} && rake db:drop RAILS_ENV=mysql_test"
+{.hidden}

data/test/prepare_testapp.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'tmpdir'
+
+TESTAPP_PATH = ENV['TESTAPP_PATH'] || File.join(Dir.tmpdir, 'declare_schema_testapp')
+system %(rake test:prepare_testapp TESTAPP_PATH=#{TESTAPP_PATH})
+system %(echo "gem 'kramdown'" >> #{TESTAPP_PATH}/Gemfile)
+system %(echo "gem 'RedCloth'" >> #{TESTAPP_PATH}/Gemfile)
+FileUtils.chdir TESTAPP_PATH
+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)

data/test_responses.txt

@@ -0,0 +1,2 @@
+id
+drop id

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: declare_schema
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Invoca Development adapted from hobo_fields by Tom Locke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Declare your Rails/active_record model schemas and have database migrations
+  generated for you!
+email: development@invoca.com
+executables:
+- declare_schema
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dependabot/config.yml"
+- ".github/workflows/gem_release.yml"
+- ".gitignore"
+- ".jenkins/Jenkinsfile"
+- ".jenkins/ruby_build_pod.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/declare_schema
+- declare_schema.gemspec
+- gemfiles/.bundle/config
+- gemfiles/rails_4.gemfile
+- gemfiles/rails_5.gemfile
+- gemfiles/rails_6.gemfile
+- lib/declare_schema.rb
+- lib/declare_schema/command.rb
+- lib/declare_schema/extensions/active_record/fields_declaration.rb
+- lib/declare_schema/extensions/module.rb
+- lib/declare_schema/field_declaration_dsl.rb
+- lib/declare_schema/model.rb
+- lib/declare_schema/model/field_spec.rb
+- lib/declare_schema/model/index_spec.rb
+- lib/declare_schema/railtie.rb
+- lib/declare_schema/version.rb
+- lib/generators/declare_schema/migration/USAGE
+- lib/generators/declare_schema/migration/migration_generator.rb
+- lib/generators/declare_schema/migration/migrator.rb
+- 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/field_declaration_dsl_spec.rb
+- spec/spec_helper.rb
+- test/api.rdoctest
+- test/doc-only.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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Database migration generator for Rails
+test_files: []