Add support for modelling associations

Author: codener

CHANGELOG.md

@@ -1,13 +1,24 @@
 # Changelog
 
+## 0.4.0 on 2018-01-15
+
+### Features
+- Support for has_many/belongs_to associations
+- Create a project README
+- New CHANGELOG
+
+### Fixes
+- Models now inherit from `ApplicationRecord`
+
+
 ## 0.3.0 on 2018-01-11
 
 ### Features
 - Generating a Rails 5.1.4 app on Ruby 2.5.0
 - Dropped asset pipeline in favor of Webpacker
 - The generated application now has a sleek, simple design based on Bootstrap
 - Employing [Unpoly](https://unpoly.com)
-- New application model DSL shortcut `crud` for creating Model plus WebUI
+- New DSL command `crud` for creating Model plus WebUI
 - The generated application model is now a transformable example of katapult's features
 
 ### Development improvements

README.md

@@ -136,6 +136,18 @@ Defined on Model. Takes a name and options:
     model.attr :avoid, type: :plain_json # PostgreSQL "json"
 
 
+### Association
+Defined on Model; takes the name of another model just like you called it in the
+model. Adds a foreign key attribute to the model and `belongs_to`/`has_many`
+calls to the respective models.
+
+    model 'Customer' do |customer|
+      customer.belongs_to 'Group'
+    end
+
+    model 'Group'
+
+
 ### WebUI
 Takes a name, options and a block:
 

features/application_model.feature

@@ -1,5 +1,5 @@
 #@announce-output
-Feature: The application model prepared by Katapult
+Feature: The default application model prepared by Katapult
 
   Scenario: Generating the application model template
     Given a new Rails application with Katapult basics installed
@@ -19,6 +19,9 @@ Feature: The application model prepared by Katapult
       product.attr :mode, assignable_values: %w[public private]
       product.attr :provider, type: :url
       product.attr :import_data, type: :json
+
+      # Reference other models just like you called them
+      product.belongs_to 'user'
     end
 
     # Define a model

features/binary.feature

@@ -67,7 +67,7 @@ Feature: Katapult binary `katapult`
       And the output should contain "Author: katapult <[email protected]>"
 
 
-  Scenario: Transform the application model
+  Scenario: Transform the default application model
     Given a new Rails application with Katapult basics installed
       And the default aruba exit timeout is 45 seconds
 

features/model.feature

@@ -1,4 +1,5 @@
 #@announce-output
+#@announce-stderr
 Feature: Generate Models
 
   Background:
@@ -13,11 +14,13 @@ Feature: Generate Models
     And I successfully transform the application model
     Then the file "app/models/car.rb" should contain exactly:
       """
-      class Car < ActiveRecord::Base
+      class Car < ApplicationRecord
+
 
         def to_s
           "Car##{id}"
         end
+
       end
 
       """
@@ -47,6 +50,10 @@ Feature: Generate Models
       end
 
       """
+    And the file "spec/factories/factories.rb" should contain:
+      """
+        factory :car
+      """
 
 
   Scenario: Generate ActiveRecord Model with attributes
@@ -72,13 +79,16 @@ Feature: Generate Models
     And I successfully transform the application model including migrations
     Then the file "app/models/person.rb" should contain exactly:
       """
-      class Person < ActiveRecord::Base
+      class Person < ApplicationRecord
+
         include DoesFlag[:locked, default: false]
+
         has_defaults({:homepage=>"http://www.makandra.de"})
 
         def to_s
           age.to_s
         end
+
       end
 
       """
@@ -148,6 +158,31 @@ Feature: Generate Models
     Then the output should contain "Katapult::Attribute does not support option :invalid_option. (Katapult::Element::UnknownOptionError)"
 
 
+  Scenario: Specify model associations
+    When I write to "lib/katapult/application_model.rb" with:
+      """
+      model('Company') { |c| c.attr :name }
+      model 'User' do |user|
+        user.belongs_to 'Company'
+      end
+      """
+    And I successfully transform the application model including migrations
+    Then the file "app/models/company.rb" should contain "has_many :users"
+    And the file "app/models/user.rb" should contain "belongs_to :company"
+    And the file "app/models/user.rb" should contain:
+      """
+        assignable_values_for :company, {:allow_blank=>true} do
+          Company.all.to_a
+        end
+      """
+
+    And there should be a migration with:
+      """
+          create_table :users do |t|
+            t.integer :company_id
+      """
+
+
   Scenario: Specify assignable values
     When I write to "lib/katapult/application_model.rb" with:
       """
@@ -159,17 +194,21 @@ Feature: Generate Models
     And I successfully transform the application model including migrations
     Then the file "app/models/person.rb" should contain exactly:
       """
-      class Person < ActiveRecord::Base
+      class Person < ApplicationRecord
+
+
         assignable_values_for :age, {} do
           9..99
         end
+
         assignable_values_for :hobby, {:allow_blank=>true, :default=>"soccer"} do
           ["soccer", "baseball"]
         end
 
         def to_s
           age.to_s
         end
+
       end
 
       """

features/web_ui.feature

@@ -9,7 +9,7 @@ Feature: Web User Interface
   Scenario: Generate a Web User Interface
     When I write to "lib/katapult/application_model.rb" with:
       """
-      model 'customer' do |customer|
+      crud 'customer' do |customer|
         customer.attr :name
         customer.attr :age, type: :integer
 
@@ -22,11 +22,11 @@ Feature: Web User Interface
         customer.attr :first_visit, type: :datetime
         customer.attr :indexable_data, type: :json
         customer.attr :plain_data, type: :plain_json
-      end
 
-      web_ui 'customer', model: 'customer' do |web_ui|
-        web_ui.crud
+        customer.belongs_to 'project'
       end
+
+      model('project') { |p| p.attr :title }
       """
     And I successfully transform the application model including migrations
     Then the file "app/controllers/customers_controller.rb" should contain exactly:
@@ -107,6 +107,7 @@ Feature: Web User Interface
             :first_visit,
             :indexable_data,
             :plain_data,
+            :project_id,
           )
         end
 
@@ -195,6 +196,10 @@ Feature: Web User Interface
           = Customer.human_attribute_name(:first_visit)
         %dd
           = l(@customer.first_visit.to_date) if @customer.first_visit
+        %dt
+          = Customer.human_attribute_name(:project_id)
+        %dd
+          = @customer.project
 
       """
     And the file "app/views/customers/new.html.haml" should contain exactly:
@@ -250,6 +255,10 @@ Feature: Web User Interface
         .form-group
           = form.label :first_visit
           = form.date_field :first_visit, class: 'form-control'
+        .form-group
+          = form.label :project_id
+          = form.collection_select :project_id, form.object.assignable_projects,
+            :id, :title, { include_blank: true }, class: 'form-control'
 
         .action-bar
           - cancel_path = @customer.new_record? ? customers_path : customer_path(@customer)
@@ -272,6 +281,7 @@ Feature: Web User Interface
 
         Scenario: CRUD customers
           Given I am on the list of customers
+            And there is a project with the title "title-string"
 
           # create
           When I follow "Add customer"
@@ -284,6 +294,7 @@ Feature: Web User Interface
             And I check "Locked"
             And I fill in "Notes" with "notes-text"
             And I fill in "First visit" with "2022-03-25"
+            And I select "title-string" from "Project"
             And I press "Save"
 
           # read
@@ -296,6 +307,7 @@ Feature: Web User Interface
             And I should see "Locked Yes"
             And I should see "notes-text"
             And I should see "2022-03-25"
+            And I should see "title-string"
 
           # update
           When I follow "Edit"
@@ -308,6 +320,7 @@ Feature: Web User Interface
             And the "Locked" checkbox should be checked
             And the "Notes" field should contain "notes-text"
             And the "First visit" field should contain "2022-03-25"
+            And "title-string" should be selected for "Project"
 
           # destroy
           When I go to the list of customers
@@ -318,7 +331,6 @@ Feature: Web User Interface
           But I should not see "name-string"
 
       """
-
     When I run cucumber
     Then the features should pass
 

lib/generators/katapult/app_model/templates/lib/katapult/application_model.rb

@@ -13,6 +13,9 @@
   product.attr :mode, assignable_values: %w[public private]
   product.attr :provider, type: :url
   product.attr :import_data, type: :json
+
+  # Reference other models just like you called them
+  product.belongs_to 'user'
 end
 
 # Define a model

lib/generators/katapult/clearance/clearance_generator.rb

@@ -122,8 +122,12 @@ def add_authentication_paths
       end
 
       def add_user_factory
-        inject_into_file 'spec/factories/factories.rb', <<-'CONTENT', after: 'FactoryBot.define do'
+        factories_file = 'spec/factories/factories.rb'
 
+        # Remove empty factory, if it exists
+        gsub_file factories_file, "  factory :user\n\n", ''
+
+        inject_into_file factories_file, <<-'CONTENT', before: /end\n\z/
   factory :user do
     sequence(:email) { |i| "user-#{ i }@example.com" }
     password 'password'

lib/generators/katapult/cucumber_features/cucumber_features_generator.rb

@@ -12,12 +12,22 @@ def create_crud_feature
         template 'feature.feature', "features/#{model.name(:variables)}.feature"
       end
 
+      no_tasks do
+        def belongs_tos
+          app_model.get_belongs_tos_for model.name
+        end
+      end
+
       private
 
       def model
         @element
       end
 
+      def app_model
+        model.application_model
+      end
+
     end
   end
 end

lib/generators/katapult/cucumber_features/templates/feature.feature

@@ -2,6 +2,9 @@ Feature: <%= model.name(:humans).titleize %>
 
   Scenario: CRUD <%= model.name(:humans) %>
     Given I am on the list of <%= model.name(:variables) %>
+<% belongs_tos.each do |model| -%>
+      And there is a <%= model.name(:human) %> with the <%= model.label_attr.name(:human) %> "<%= model.label_attr.test_value %>"
+<% end -%>
 
     # create
     When I follow "Add <%= model.name(:human) %>"
@@ -25,7 +28,7 @@ Feature: <%= model.name(:humans).titleize %>
     Then I should be on the page for the <%= model.name(:variable) %> above
 <% model.attrs.each do |attr| -%>
   <%- case attr.type -%>
-    <%- when :string, :email, :url, :integer, :money, :text -%>
+    <%- when :string, :email, :url, :integer, :money, :text, :foreign_key -%>
       And I should see "<%= attr.test_value %>"
   <%- when :flag -%>
       And I should see "<%= attr.name.humanize %> Yes"
@@ -52,12 +55,10 @@ Feature: <%= model.name(:humans).titleize %>
   <%- end -%>
 <% end -%>
 
-<% if model.label_attr -%>
     # destroy
     When I go to the list of <%= model.name(:variables) %>
     Then I should see "<%= model.label_attr.test_value %>"
 
     When I follow "Destroy <%= model.label_attr.test_value %>"
     Then I should be on the list of <%= model.name(:variables) %>
     But I should not see "<%= model.label_attr.test_value %>"
-<% end -%>

lib/generators/katapult/model/model_generator.rb

@@ -30,11 +30,26 @@ def write_traits
         template 'app/models/shared/does_flag.rb' if flag_attrs.any?
       end
 
+      def write_factory
+        insert_into_file 'spec/factories/factories.rb', <<-FACTORY, before: /end\n\z/
+  factory #{ model.name(:symbol) }
+
+        FACTORY
+      end
+
       def generate_unit_tests
         Generators::ModelSpecsGenerator.new(model).invoke_all
       end
 
       no_commands do
+        def belongs_tos
+          model.application_model.get_belongs_tos_for model.name
+        end
+
+        def has_manys
+          model.application_model.get_has_manys_for model.name
+        end
+
         def flag_attrs
           model.attrs.select(&:flag?)
         end