declare_schema 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf5ebc856041d2f6a90e4a6f30a56e5a538545f79b227cd2ca691eb99dcf9a8
-  data.tar.gz: 3d2b3efe4d0647f8c94052e2e8a22433a021503f458203e9f0f73d131d7c6225
+  metadata.gz: 8c1bc236be22c712ca8a65ef4ed294301fc7d2021167dd0e2501066abe30b3ba
+  data.tar.gz: b41b86f51293569be553bab41fc245601ad82f98f4546af8d5d9d46601070fe3
 SHA512:
-  metadata.gz: 4771090d9ef1dbe0267eddfa4ac7d2fc25dd37a9c75a8e76bdb27ea9a072aac894671dc8115387eb9489855f6849ff7cf4c1f2f4e82eb36039824fd83328f2f3
-  data.tar.gz: 7fc9feb7d02f2b71f11ec4c21f3624c3dc503df64c443f304b1d19f75d6a81102a86d0b27be3c32749a191f966440a88c54c86db260123cd2e6457bdacd474cf
+  metadata.gz: 3a7b1808736b5f6c1ed69eb88a6afa7a69dbc6fcb014fbd5afb23734abd177348440caf5394ba941e66f6473011fae7543ce5b1e43b81ec8231ab3abfc369627
+  data.tar.gz: b96afd3ecfc86d51a795e43f5b04859d7e45c7869ffcf9f21a6a8a63da05e8499dd03b66e4e951b967f0e4feb8d21c2c0cf6aa88e952e53b3254c12ab541e0eb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    declare_schema (0.1.0)
+    declare_schema (0.1.1)
       rails (>= 4.2)
 
 GEM

data/README.md

@@ -1,11 +1,68 @@
 # DeclareSchema
 
-Declare your active_record model schemas and have database migrations generated for you!
+Declare your Rails/active_record model schemas and have database migrations generated for you!
 
+## Example
+
+Make a model and declare your schema within a `fields do ... end` block:
+```ruby
+class Company < ActiveRecord::Base
+  fields do
+    company_name :string, limit: 100
+    ticker_symbol :string, limit: 4, null: true, index: true, unique: true
+    employee_count :integer
+    comments :text
+
+    timestamps
+  end
+
+  belongs_to :industry
+end
+```
+Then generate the migration:
+```sh
+$ rails generate declare_schema:migration
+
+---------- Up Migration ----------
+create_table :companies, id: :bigint do |t|
+  t.string   :company_name, null: false, limit: 100
+  t.string   :ticker_symbol, limit: 4
+  t.integer  :employee_count, null: false
+  t.text     :comments, null: false
+  t.datetime :created_at
+  t.datetime :updated_at
+  t.integer  :industry_id, null: false
+end
+add_index :companies, [:ticker_symbol], unique: true, name: 'on_ticker_symbol'
+add_index :companies, [:industry_id], name: 'on_industry_id'
+execute "ALTER TABLE companies ADD CONSTRAINT index_companies_on_industry_id FOREIGN KEY index_companies_on_industry_id(industry_id) REFERENCES industries(id) "
+----------------------------------
+
+---------- Down Migration --------
+drop_table :companies
+----------------------------------
+
+
+What now: [g]enerate migration, generate and [m]igrate now or [c]ancel?  g
+  => "g"
+
+Migration filename: [<enter>=declare_schema_migration_1|<custom_name>]: add_company_model
+```
+Note that the migration generator is interactive -- it can't tell the difference between renaming something vs. adding one thing and removing another, so sometimes it will ask you to clarify.
+
+## Installing
+
+Install the `DeclareSchema` gem directly:
+```
+  $ gem install declare_schema
+```
+or add it to your `bundler` Gemfile:
+```
+  gem 'declare_schema'
+```
 ## Testing
 To run tests:
 ```
 rake test:prepare_testapp[force]
 rake test:all < test_responses.txt
 ```
-(Note: there currently are no unit tests. The above will run the `rdoctests`.)

data/lib/declare_schema/model/field_spec.rb

@@ -41,7 +41,8 @@ module DeclareSchema
 
         @model = model
         @name = name.to_sym
-        @type = type.is_a?(String) ? type.to_sym : type
+        type.is_a?(Symbol) or raise ArgumentError, "type must be a Symbol; got #{type.inspect}"
+        @type = type
         position_option = options.delete(:position)
         @options = options
 
@@ -72,7 +73,7 @@ module DeclareSchema
                                   type
                                 else
                                   field_class = DeclareSchema.to_class(type)
-                                  field_class && field_class::COLUMN_TYPE or raise UnknownSqlTypeError, "#{type.inspect} for #{model}.#{@name}"
+                                  field_class && field_class::COLUMN_TYPE or raise UnknownSqlTypeError, "#{type.inspect} for #{model}##{@name}"
                                 end
                               end
       end

data/lib/declare_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DeclareSchema
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

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

@@ -295,10 +295,6 @@ module Generators
           down = [undo_changes, undo_renames, undo_drops, undo_creates, undo_index_changes, undo_fk_changes].flatten.reject(&:blank?) * "\n\n"
 
           [up, down]
-        rescue Exception => ex
-          puts "Caught exception: #{ex}"
-          puts ex.backtrace.join("\n")
-          raise
         end
 
         def create_table(model)
@@ -473,7 +469,7 @@ module Generators
           return [[], []] if Migrator.disable_indexing
 
           new_table_name = model.table_name
-          existing_fks = DeclareSchema::Model::ForeignKeySpec.for_model(model, old_table_name)
+          existing_fks = ::DeclareSchema::Model::ForeignKeySpec.for_model(model, old_table_name)
           model_fks = model.constraint_specs
           add_fks = model_fks - existing_fks
           drop_fks = existing_fks - model_fks

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: declare_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 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
+date: 2020-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -76,7 +76,6 @@ files:
 - 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

data/test/doc-only.rdoctest

@@ -1,76 +0,0 @@
-# DeclareSchema
-
-## Introduction
-
-Welcome to DeclareSchema -- a spin-off from HoboFields part of the Hobo project (Hobo not required!).
-
-**DeclareSchema writes your Rails migrations for you! Your migration writing days are over!**
-
-All we ask is that you declare your fields in the model. It's still perfectly DRY because you're not having to repeat that in the migration -- DeclareSchema does that for you. In fact, you'll come to love having them there.
-
-It still has all the benefits of writing your own migrations, for example if you want to add some special code to migrate your old data, you can just edit the generated migration.
-
-## Example
-
-First off, pass the `--skip-migration` option when generating your models:
-
-        $ rails generate model blog_post --skip-migration
-
-Now edit your model as follows:
-
-    class BlogPost < ActiveRecord::Base
-      fields do
-        title :string
-        body  :text
-        timestamps
-      end
-    end
-{: .ruby}
-
-
-Then, simply run
-
-        $ rails generate declare_schema:migration
-
-And voila
-
-        ---------- Up Migration ----------
-        create_table :blog_posts do |t|
-          t.string   :title
-          t.text     :body
-          t.datetime :created_at
-          t.datetime :updated_at
-        end
-        ----------------------------------
-
-        ---------- Down Migration --------
-        drop_table :blog_posts
-        ----------------------------------
-{: .ruby}
-
-The migration generator has created a migration to change from the schema that is currently in your database, to the schema that your models need. That's really all there is to it. You are now free to simply hack away on your app and run the migration generator every time the database needs to play catch-up.
-
-Note that the migration generator is interactive -- it can't tell the difference between renaming something vs. adding one thing and removing another, so sometimes it will ask you to clarify. It's a bit picky about what it makes you type in response, because we really don't want you to lose data when someone's amazing twitter distracts you at the wrong moment.
-
-## Installing
-
-The simplest and recommended way to install DeclareSchema is as a gem:
-
-        $ gem install declare_schema
-
-## API
-
-## Migration Generator Details
-
-The migration generator doctests provide a lot more detail. They're not really that great as documentation because doctests run in a single irb session, and that doesn't fit well with the concept of a generator. Skip these unless you're really keen to see the details of the migration generator in action
-
- - [Migration Generator Details](/manual/declare_schema/migration_generator)
-
-## About Doctests
-
-DeclareSchema is documented and tested using *doctests*. This is an idea that comes from Python that we've been experimenting with for Hobo. Whenever you see code-blocks that start "`>>`", read them as IRB sessions. The `rdoctest` tool extracts these and runs them to verify they behave as advertised.
-
-Doctests are a great way to get both documentation and tests from the same source. We're still experimenting with exactly how this all works though, so if the docs seem strange in places, please bear with us!
-
-You may download rubydoctest via [github](http://www.github.com/tablatom/rubydoctest)
-