declare_schema 0.1.0

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

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

data/lib/generators/declare_schema/model/USAGE

@@ -0,0 +1,19 @@
+Description:
+    Invokes the active_record:model generator, but the generated
+    model file contains the fields block, (and the migration option
+    is false by default).
+
+Examples:
+    $ rails generate declare_schema:model account
+
+        creates an Account model, test and fixture:
+            Model:      app/models/account.rb
+            Test:       test/unit/account_test.rb
+            Fixtures:   test/fixtures/accounts.yml
+
+    $ rails generate declare_schema:model post title:string body:text published:boolean
+
+        creates a Post model with a string title, text body, and published flag.
+
+After the model is created, and the fields are specified, use declare_schema:migration
+to create the migrations incrementally.

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rails/generators/active_record'
+require 'generators/declare_schema/support/model'
+
+module DeclareSchema
+  class ModelGenerator < ActiveRecord::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+
+    include DeclareSchema::Support::Model
+  end
+end

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

@@ -0,0 +1,25 @@
+
+  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/lib/generators/declare_schema/support/eval_template.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module DeclareSchema
+  module Support
+    module EvalTemplate
+      class << self
+        def included(base)
+          base.class_eval do
+            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)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative './eval_template'
+
+module DeclareSchema
+  module Support
+    module Model
+      class << self
+        def included(base)
+          base.class_eval do
+            include EvalTemplate
+
+            argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+            class << self
+              def banner
+                "rails generate declare_schema:model #{arguments.map(&:usage).join(' ')} [options]"
+              end
+            end
+
+            class_option :timestamps, type: :boolean
+
+            def generate_model
+              invoke "active_record:model", [name], { migration: false }.merge(options)
+            end
+
+            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')
+              end
+            end
+
+            protected
+
+            def model_path
+              @model_path ||= File.join("app", "models", "#{file_path}.rb")
+            end
+
+            def max_attribute_length
+              attributes.map { |attribute| attribute.name.length }.max
+            end
+
+            def field_attributes
+              attributes.reject { |a| a.name == "bt" || a.name == "hm" }
+            end
+
+            def accessible_attributes
+              field_attributes.map(&:name) + bts.map { |bt| "#{bt}_id" } + bts + hms
+            end
+
+            def hms
+              attributes.select { |a| a.name == "hm" }.map(&:type)
+            end
+
+            def bts
+              attributes.select { |a| a.name == "bt" }.map(&:type)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DeclareSchema
+  module Support
+    module ThorShell
+      PREFIX = '  => '
+
+      private
+
+      def ask(statement, default = '', color = :magenta)
+        result = super(statement, color)
+        result = default if result.blank?
+        say PREFIX + result.inspect
+        result
+      end
+
+      def yes_no?(statement, _color=:magenta)
+        result = choose(statement + ' [y|n]', /^(y|n)$/i)
+        result == 'y'
+      end
+
+      def choose(prompt, format, default=nil)
+        choice = ask prompt, default
+        if choice =~ format
+          choice
+        elsif choice.blank? && !default.blank?
+          default
+        else
+          say 'Unknown choice! ', :red
+          choose(prompt, format, default)
+        end
+      end
+
+      def say_title(title)
+        say "\n #{title} \n", "\e[37;44m"
+      end
+    end
+  end
+end

data/spec/lib/declare_schema/field_declaration_dsl_spec.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative '../../../lib/declare_schema/field_declaration_dsl'
+
+RSpec.describe DeclareSchema::FieldDeclarationDsl do
+  class TestModel < ActiveRecord::Base
+    fields do
+      name :string, limit: 127
+
+      timestamps
+    end
+  end
+
+  let(:model) { TestModel.new }
+  subject { declared_class.new(model) }
+
+  it 'has fields' do
+    expect(TestModel.field_specs).to be_kind_of(Hash)
+    expect(TestModel.field_specs.keys).to eq(['name', 'created_at', 'updated_at'])
+    expect(TestModel.field_specs.values.map(&:type)).to eq([:string, :datetime, :datetime])
+  end
+
+  it 'stores limits' do
+    expect(TestModel.field_specs['name'].limit).to eq(127)
+  end
+
+  # TODO: fill out remaining tests
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "declare_schema"
+require "climate_control"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  RSpec::Support::ObjectFormatter.default_instance.max_formatted_output_length = 2_000
+
+  def with_modified_env(options, &block)
+    ClimateControl.modify(options, &block)
+  end
+end

data/test/api.rdoctest

@@ -0,0 +1,136 @@
+# 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/doc-only.rdoctest

@@ -0,0 +1,76 @@
+# 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)
+