katapult 0.1.0

data/features/model.feature

@@ -0,0 +1,203 @@
+Feature: Generate Models
+
+  Background:
+    Given a pristine Rails application
+    And I install katapult
+    And I generate katapult basics
+
+
+  Scenario: Generate ActiveRecord Model
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Car'
+      """
+    And I successfully transform the application model
+    Then the file "app/models/car.rb" should contain exactly:
+      """
+      class Car < ActiveRecord::Base
+
+        def to_s
+          "Car##{id}"
+        end
+      end
+
+      """
+    And there should be a migration with:
+      """
+      class CreateCars < ActiveRecord::Migration
+        def change
+          create_table :cars do |t|
+
+            t.timestamps
+          end
+        end
+      end
+
+      """
+    And the file "spec/models/car_spec.rb" should contain exactly:
+      """
+      require 'rails_helper'
+
+      describe Car do
+
+        describe '#to_s' do
+          it 'returns its class name with its id' do
+            subject.id = 17
+            expect(subject.to_s).to eql("Car#17")
+          end
+        end
+
+      end
+
+      """
+
+
+  Scenario: Generate ActiveRecord Model with attributes
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Person' do |person|
+
+        # Basic types
+        person.attr :age, type: :integer
+        person.attr :nick, type: :string
+        person.attr :hobby # string is default
+
+        # Special types
+        person.attr :email # type is detected as email
+        person.attr :income, type: :money
+        person.attr :homepage, type: :url, default: 'http://www.makandra.de'
+        person.attr :locked, type: :flag, default: false
+      end
+      """
+    And I successfully transform the application model
+    Then the file "app/models/person.rb" should contain exactly:
+      """
+      class Person < ActiveRecord::Base
+        include DoesFlag[:locked, default: false]
+        has_defaults({:homepage=>"http://www.makandra.de"})
+
+        def to_s
+          age.to_s
+        end
+      end
+
+      """
+    And there should be a migration with:
+      """
+      class CreatePeople < ActiveRecord::Migration
+        def change
+          create_table :people do |t|
+            t.integer :age
+            t.string :nick
+            t.string :hobby
+            t.string :email
+            t.decimal :income, precision: 10, scale: 2
+            t.string :homepage
+            t.boolean :locked
+
+            t.timestamps
+          end
+        end
+      end
+
+      """
+    And the file "spec/models/person_spec.rb" should contain exactly:
+      """
+      require 'rails_helper'
+
+      describe Person do
+
+        describe '#to_s' do
+          it 'returns the #age attribute' do
+            subject.age = 778
+            expect(subject.to_s).to eql("778")
+          end
+        end
+
+        describe '#homepage' do
+
+          it 'has a default' do
+            expect( subject.homepage ).to eql("http://www.makandra.de")
+          end
+        end
+
+        describe '#locked' do
+
+          it 'has a default' do
+            expect( subject.locked ).to eql(false)
+          end
+        end
+
+      end
+
+      """
+    And the specs should pass
+
+
+  Scenario: Get a helpful error message when an attribute has an unknown option
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Person' do |person|
+        person.attr :x, invalid_option: 'here'
+      end
+      """
+    And I transform the application model
+    Then the output should contain "Katapult::Attribute does not support option :invalid_option. (Katapult::Element::UnknownOptionError)"
+
+
+  Scenario: Specify assignable values
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Person' do |person|
+        person.attr :age, type: :integer, assignable_values: 9..99
+        person.attr :hobby, assignable_values: %w[soccer baseball], default: 'soccer', allow_blank: true
+      end
+      """
+    And I successfully transform the application model
+    Then the file "app/models/person.rb" should contain exactly:
+      """
+      class Person < ActiveRecord::Base
+        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
+
+      """
+    And the file "spec/models/person_spec.rb" should contain exactly:
+      """
+      require 'rails_helper'
+
+      describe Person do
+
+        describe '#to_s' do
+          it 'returns the #age attribute' do
+            subject.age = 9
+            expect(subject.to_s).to eql("9")
+          end
+        end
+
+        describe '#age' do
+          it { is_expected.to allow_value(99).for(:age) }
+          it { is_expected.to_not allow_value(100).for(:age) }
+        end
+
+        describe '#hobby' do
+          it { is_expected.to allow_value("baseball").for(:hobby) }
+          it { is_expected.to_not allow_value("baseball-unassignable").for(:hobby) }
+
+          it 'has a default' do
+            expect( subject.hobby ).to eql("soccer")
+          end
+        end
+
+      end
+
+      """
+    And the specs should pass

data/features/navigation.feature

@@ -0,0 +1,80 @@
+Feature: Navigation
+
+  Background:
+    Given a pristine Rails application
+    And I install katapult
+    And I generate katapult basics
+
+
+  Scenario: Generate navigation
+
+    The navigation is rendered from all WUIs in the application model. It
+    consists of links to their index pages.
+
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Customer' do |customer|
+        customer.attr :name
+      end
+
+      wui 'Customer', model: 'Customer' do |wui|
+        wui.action :index
+        wui.action :show
+        wui.action :create
+        wui.action :update
+        wui.action :destroy
+      end
+
+      navigation 'main'
+      """
+    And I successfully transform the application model
+    Then the file "app/models/navigation.rb" should contain exactly:
+      """
+      class Navigation
+        include Navy::Description
+
+        navigation :main do
+          section :customers, "Customers", customers_path
+        end
+
+      end
+
+      """
+    And the file "app/views/layouts/application.html.haml" should contain:
+      """
+      = render_navigation Navigation.main
+      """
+    And the file "app/controllers/customers_controller.rb" should contain:
+      """
+      before_filter :set_section
+      """
+    And the file "app/controllers/customers_controller.rb" should contain:
+      """
+        def set_section
+          in_sections :customers
+        end
+      """
+
+
+  Scenario: Homepage (aka root route) is set automatically
+
+    The first WUI with an index action is set as home page
+
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Customer'
+      model 'Elephant'
+
+      wui 'Elephant' do |wui|
+        wui.action :trumpet, scope: :member, method: :post
+      end
+
+      wui 'Customer' do |wui|
+        wui.crud
+      end
+      """
+    And I successfully transform the application model
+    Then the file "config/routes.rb" should contain:
+      """
+      root 'customers#index'
+      """

data/features/step_definitions/db_steps.rb

@@ -0,0 +1,8 @@
+Then(/^a db table named "(.*?)" should exist$/) do |table|
+  require 'sequel'
+  db_path = "sqlite://#{current_dir}/db/development.sqlite3"
+  
+  Sequel.connect(db_path) { |db|
+    db.table_exists?(table)
+  }.should == true
+end

data/features/step_definitions/file_steps.rb

@@ -0,0 +1,14 @@
+When /^I replace "(.*?)" with "(.*?)" inside "(.*?)"$/ do |a, b, path|
+  in_current_dir do
+    content = File.read(path)
+    content.gsub! a, b
+    File.open(path, 'w') { |file| file.puts(content) }
+  end
+end
+
+Then /^there should be a migration with:$/ do |migration|
+  migrations_path = File.join(current_dir, 'db', 'migrate', '*.rb')
+
+  all_migrations = Dir.glob(migrations_path).map(&File.method(:read)).join
+  all_migrations.should include(migration)
+end

data/features/step_definitions/katapult_steps.rb

@@ -0,0 +1,14 @@
+When /^I install katapult$/ do
+  append_to_file 'Gemfile', "gem 'katapult', path: '../../..'"
+  run_simple('bin/rails generate katapult:install')
+end
+
+# This step is required for any feature because it generates config/database.yml
+When /^I generate katapult basics$/ do
+  run_simple('bin/rails generate katapult:basics')
+end
+
+When /^I( successfully)? transform the application model$/ do |require_success|
+  # the second parameter would be true when not specified
+  run_simple('bin/rails generate katapult:transform lib/katapult/application_model.rb', !!require_success)
+end

data/features/step_definitions/rails_steps.rb

@@ -0,0 +1,44 @@
+module KatapultRailsHelper
+
+  def with_aruba_timeout(timeout, &block)
+    original_aruba_timeout = @aruba_timeout_seconds
+    @aruba_timeout_seconds = timeout
+
+    block.call
+  ensure
+    @aruba_timeout_seconds = original_aruba_timeout
+  end
+
+  def create_cached_app(name)
+    job = 'Cached Rails app generation'
+    rails_new_command = "bundle exec rails new #{name} --skip-test-unit --skip-bundle --database mysql"
+
+    puts "#{job} started (in #{Dir.pwd})"
+    system(rails_new_command) or raise "#{job} failed"
+    puts "#{job} done."
+  end
+
+  def ensure_bundled(path)
+    Dir.chdir(path) do
+      Bundler.with_clean_env do
+        system('bundle check &> /dev/null') or system('bundle install')
+      end
+    end
+  end
+
+end
+World(KatapultRailsHelper)
+
+
+Given /^a pristine Rails application$/ do
+  with_aruba_timeout(120) do
+    Dir.chdir('tmp') do
+      create_cached_app('cached_test_app') unless File.directory?('cached_test_app')
+      ensure_bundled('cached_test_app')
+    end
+
+    # copy cached app to aruba directory
+    FileUtils.cp_r('tmp/cached_test_app', File.join(current_dir, 'katapult_test_app'))
+    cd 'katapult_test_app' # Aruba::Api method
+  end
+end

data/features/step_definitions/test_steps.rb

@@ -0,0 +1,7 @@
+Then /^the specs should pass$/ do
+  run_simple('bin/rspec')
+end
+
+Then /^the features should pass$/ do
+  run_simple('bin/cucumber')
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'pry'
+
+# Make sure tests use the correct katapult gem
+ENV['KATAPULT_GEMFILE_OPTIONS'] = ", path: '../../..'"
+
+Before do
+  @aruba_timeout_seconds = 30
+
+  unset_bundler_env_vars
+  run_simple 'spring stop # Clean up in case the After hook did not run'
+end
+
+After do
+  run_simple 'spring stop'
+end

data/features/wui.feature

@@ -0,0 +1,319 @@
+Feature: Web User Interface
+
+  Background:
+    Given a pristine Rails application
+    And I install katapult
+    And I generate katapult basics
+
+
+  Scenario: Generate a Web User Interface
+    When I overwrite "lib/katapult/application_model.rb" with:
+      """
+      model 'Customer' do |customer|
+        customer.attr :name
+        customer.attr :age, type: :integer
+
+        customer.attr :email
+        customer.attr :revenue, type: :money
+        customer.attr :homepage, type: :url, default: 'http://www.makandra.de'
+        customer.attr :locked, type: :flag, default: false
+      end
+
+      wui 'Customer', model: 'Customer' do |wui|
+        wui.crud
+        wui.action :get_member, method: :get, scope: :member
+        wui.action :post_member, method: :post, scope: :member
+        wui.action :get_collection, method: :get, scope: :collection
+        wui.action :put_collection, method: :put, scope: :collection
+      end
+      """
+    And I successfully transform the application model
+    Then the file "app/controllers/customers_controller.rb" should contain exactly:
+      """
+      class CustomersController < ApplicationController
+
+        def index
+          load_customers
+        end
+
+        def show
+          load_customer
+        end
+
+        def new
+          build_customer
+        end
+
+        def create
+          build_customer
+          save_customer or render :new
+        end
+
+        def edit
+          load_customer
+          build_customer
+        end
+
+        def update
+          load_customer
+          build_customer
+          save_customer or render :edit
+        end
+
+        def destroy
+          load_customer
+          @customer.destroy
+          redirect_to customers_path
+        end
+
+        def get_member
+          load_customer
+        end
+
+        def post_member
+          load_customer
+          redirect_to @customer
+        end
+
+        def get_collection
+          load_customers
+        end
+
+        def put_collection
+          load_customers
+          redirect_to customers_path
+        end
+
+        private
+
+        def load_customers
+          @customers ||= customer_scope.to_a
+        end
+
+        def load_customer
+          @customer ||= customer_scope.find(params[:id])
+        end
+
+        def build_customer
+          @customer ||= customer_scope.build
+          @customer.attributes = customer_params
+        end
+
+        def save_customer
+          if @customer.save
+            redirect_to @customer
+          end
+        end
+
+        def customer_params
+          customer_params = params[:customer]
+          customer_params ? customer_params.permit([:name, :age, :email, :revenue, :homepage, :locked]) : {}
+        end
+
+        def customer_scope
+          Customer.scoped
+        end
+
+      end
+
+      """
+    And the file "config/routes.rb" should contain:
+      """
+        resources :customers, only: [:index, :show, :new, :create, :edit, :update, :destroy] do
+          member do
+            get 'get_member'
+            post 'post_member'
+          end
+          collection do
+            get 'get_collection'
+            put 'put_collection'
+          end
+        end
+      """
+    And the file "app/views/customers/index.html.haml" should contain exactly:
+      """
+      %h1
+        Customers
+
+      .tools
+        = link_to 'Add customer', new_customer_path, class: 'tools__button is_primary'
+        = link_to 'Get Collection', get_collection_customers_path, class: 'tools__button'
+        = link_to 'Put Collection', put_collection_customers_path, class: 'tools__button'
+
+      - if @customers.any?
+        %table.items
+          - @customers.each do |customer|
+            %tr
+              %td
+                = link_to customer.to_s, customer, class: 'hyperlink'
+              %td
+                .items__actions
+                  = link_to 'Edit', edit_customer_path(customer), class: 'items__action'
+                  = link_to 'Destroy', customer_path(customer), method: :delete, class: 'items__action', confirm: 'Really destroy?'
+                  = link_to 'Get Member', get_member_customer_path(customer), class: 'items__action'
+                  = link_to 'Post Member', post_member_customer_path(customer), class: 'items__action', method: :post
+
+      - else
+        %p.help-block
+          There are no customers yet.
+
+      """
+    And the file "app/views/customers/show.html.haml" should contain exactly:
+      """
+      %h1
+        = @customer.to_s
+
+      .tools
+        = link_to 'All customers', customers_path, class: 'tools__button'
+        = link_to 'Edit', edit_customer_path(@customer), class: 'tools__button is_primary'
+        = link_to 'Destroy', customer_path(@customer), method: :delete, class: 'tools__button', confirm: 'Really destroy?'
+        = link_to 'Get Member', get_member_customer_path(@customer), class: 'tools__button'
+        = link_to 'Post Member', post_member_customer_path(@customer), class: 'tools__button', method: :post
+
+      %dl.values
+        %dt
+          = Customer.human_attribute_name(:name)
+        %dd
+          = @customer.name
+        %dt
+          = Customer.human_attribute_name(:age)
+        %dd
+          = @customer.age
+        %dt
+          = Customer.human_attribute_name(:email)
+        %dd
+          = mail_to @customer.email, nil, class: 'hyperlink'
+        %dt
+          = Customer.human_attribute_name(:revenue)
+        %dd
+          = @customer.revenue
+          €
+        %dt
+          = Customer.human_attribute_name(:homepage)
+        %dd
+          = link_to @customer.homepage, @customer.homepage, class: 'hyperlink'
+        %dt
+          = Customer.human_attribute_name(:locked)
+        %dd
+          = @customer.locked ? 'Yes' : 'No'
+
+      """
+    And the file "app/views/customers/new.html.haml" should contain exactly:
+      """
+      %h1
+        Add customer
+
+      = render 'form'
+
+      """
+    And the file "app/views/customers/edit.html.haml" should contain exactly:
+      """
+      %h1
+        = @customer.to_s
+
+      = render 'form'
+
+      """
+    And the file "app/views/customers/_form.html.haml" should contain exactly:
+      """
+      = form_for @customer do |form|
+
+        %dl.controls
+          %dt
+            = form.label :name
+          %dd
+            = form.text_field :name
+          %dt
+            = form.label :age
+          %dd
+            = form.number_field :age
+          %dt
+            = form.label :email
+          %dd
+            = form.email_field :email
+          %dt
+            = form.label :revenue
+          %dd
+            = form.number_field :revenue
+            €
+          %dt
+            = form.label :homepage
+          %dd
+            = form.url_field :homepage
+          %dt
+            = form.label :locked
+          %dd
+            = form.check_box :locked
+
+        .tools
+          = form.submit 'Save', class: 'tools__button is_primary'
+          - cancel_path = @customer.new_record? ? customers_path : customer_path(@customer)
+          = link_to 'Cancel', cancel_path, class: 'tools__button'
+
+      """
+    And the file "app/views/customers/get_member.html.haml" should contain exactly:
+      """
+      %h1
+        Get Member
+
+      .tools
+        = link_to 'All customers', customers_path, class: 'tools__button'
+
+      """
+    But a file named "app/views/customers/post_member.html.haml" should not exist
+    And the file "app/views/customers/get_collection.html.haml" should contain exactly:
+      """
+      %h1
+        Get Collection
+
+      .tools
+        = link_to 'All customers', customers_path, class: 'tools__button'
+
+      """
+    But a file named "app/views/customers/put_collection.html.haml" should not exist
+    And the file "features/customers.feature" should contain exactly:
+      """
+      Feature: Customers
+
+        Scenario: CRUD customers
+          Given I am on the list of customers
+
+          # create
+          When I follow "Add customer"
+            And I fill in "Name" with "name-string"
+            And I fill in "Age" with "778"
+            And I fill in "Email" with "email@example.com"
+            And I fill in "Revenue" with "2.21"
+            And I fill in "Homepage" with "homepage.example.com"
+            And I check "Locked"
+            And I press "Save"
+
+          # read
+          Then I should be on the page for the customer above
+            And I should see "name-string"
+            And I should see "778"
+            And I should see "email@example.com"
+            And I should see "2.21"
+            And I should see "homepage.example.com"
+            And I should see "Locked Yes"
+
+          # update
+          When I follow "Edit"
+          Then I should be on the form for the customer above
+            And the "Name" field should contain "name-string"
+            And the "Age" field should contain "778"
+            And the "Email" field should contain "email@example.com"
+            And the "Revenue" field should contain "2.21"
+            And the "Homepage" field should contain "homepage.example.com"
+            And the "Locked" checkbox should be checked
+
+          # destroy
+          When I go to the list of customers
+          Then I should see "name-string"
+
+          When I follow "Destroy"
+          Then I should be on the list of customers
+            But I should not see "name-string"
+
+      """
+    And the features should pass