katapult 0.1.0

data/lib/generators/katapult/haml/haml_generator.rb

@@ -0,0 +1,90 @@
+# Generate views for a WUI.
+
+require 'katapult/generator'
+require 'generators/katapult/cucumber_features/cucumber_features_generator'
+
+module Katapult
+  module Generators
+    class HamlGenerator < Katapult::Generator
+
+      desc 'Generate HAML views'
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def install_application_layout
+        remove_file 'app/views/layouts/application.html.erb'
+        template 'app/views/layouts/application.html.haml'
+      end
+
+      def create_views_directory
+        FileUtils.mkdir_p views_path
+      end
+
+      def create_rails_standard_action_views
+        actions.select{ |a| a.get? && WUI::RAILS_ACTIONS.include?(a.name) }.each do |action|
+          file_name = "#{action.name}.html.haml"
+
+          create_view file_name, File.join(views_path, file_name)
+        end
+      end
+
+      def create_form_partial_if_needed
+        _form_actions = (actions.map(&:name) & %w[new edit])
+
+        if _form_actions.any?
+          file_name = '_form.html.haml'
+
+          create_view file_name, File.join(views_path, file_name)
+        end
+      end
+
+      def create_views_for_custom_actions
+        wui.custom_actions.select(&:get?).each do |action|
+          @action = action # Make the action object accessible in templates
+          create_view 'custom_action.html.haml', File.join(views_path, "#{action.name}.html.haml")
+        end
+      end
+
+      def generate_integration_tests
+        if wui.model.present?
+          Generators::CucumberFeaturesGenerator.new(wui.model).invoke_all
+        end
+      end
+
+      no_tasks do
+        def model_name(kind = nil)
+          wui.model_name(kind)
+        end
+
+        def views_path
+          File.join('app', 'views', model_name(:variables))
+        end
+
+        def navigation
+          wui.application_model.navigation
+        end
+      end
+
+      private
+
+      # Rails views depend heavily on models. If the WUI has no model, do not
+      # use the templates but create empty files instead.
+      def create_view(template, destination)
+        if wui.model
+          template template, destination
+        else
+          create_file destination
+        end
+      end
+
+      def wui
+        @element
+      end
+
+      def actions
+        wui.actions
+      end
+
+    end
+  end
+end

data/lib/generators/katapult/haml/templates/_form.html.haml

@@ -0,0 +1,38 @@
+= form_for <%= model_name(:ivar) %> do |form|
+
+  %dl.controls
+<% wui.model.attrs.each do |attribute| -%>
+    %dt
+      = form.label <%= attribute.name(:symbol) %>
+    %dd
+  <%- if attribute.assignable_values -%>
+      = form.select <%= attribute.name(:symbol) %>, form.object.assignable_<%= attribute.name(:variables) %>
+  <%- else -%>
+    <%- case attribute.type -%>
+    <%- when :string -%>
+      = form.text_field <%= attribute.name(:symbol) %>
+    <%- when :email -%>
+      = form.email_field <%= attribute.name(:symbol) %>
+    <%- when :url -%>
+      = form.url_field <%= attribute.name(:symbol) %>
+    <%- when :integer -%>
+      = form.number_field <%= attribute.name(:symbol) %>
+    <%- when :money -%>
+      = form.number_field <%= attribute.name(:symbol) %>
+      €
+    <%- when :text -%>
+      = form.text_area <%= attribute.name(:symbol) %>, rows: 5
+    <%- when :markdown -%>
+      = form.text_area <%= attribute.name(:symbol) %>, rows: 15
+    <%- when :flag -%>
+      = form.check_box <%= attribute.name(:symbol) %>
+    <%- when :datetime -%>
+      = form.datetime_field <%= attribute.name(:symbol) %>
+    <%- end -%>
+  <%- end -%>
+<% end -%>
+
+  .tools
+    = form.submit 'Save', class: 'tools__button is_primary'
+    - cancel_path = <%= model_name(:ivar) %>.new_record? ? <%= wui.path(:index) %> : <%= wui.path(:show, model_name(:ivar)) %>
+    = link_to 'Cancel', cancel_path, class: 'tools__button'

data/lib/generators/katapult/haml/templates/app/views/layouts/application.html.haml

@@ -0,0 +1,25 @@
+!!!
+%html
+  %head
+    %title
+      <%= app_name.titlecase %>
+
+    = stylesheet_link_tag 'application', media: 'all'
+    = javascript_include_tag 'application'
+    = csrf_meta_tags
+
+  %body
+    .layout
+
+      .layout__head
+        %h2 <%= app_name.titlecase %>
+        <%- if navigation -%>
+        = render_navigation Navigation.<%= navigation.name(:variable) %>
+        <%- end -%>
+
+      .layout__main
+        =# render 'layouts/flashes'
+        = yield
+
+      .layout__tail
+        powered by makandra

data/lib/generators/katapult/haml/templates/custom_action.html.haml

@@ -0,0 +1,5 @@
+%h1
+  <%= @action.name.humanize.titleize %>
+
+.tools
+  = link_to 'All <%= model_name(:human_plural) %>', <%= wui.path(:index) %>, class: 'tools__button'

data/lib/generators/katapult/haml/templates/edit.html.haml

@@ -0,0 +1,4 @@
+%h1
+  = <%= model_name(:ivar) %>.to_s
+
+= render 'form'

data/lib/generators/katapult/haml/templates/index.html.haml

@@ -0,0 +1,29 @@
+%h1
+  <%= model_name(:human_plural).capitalize %>
+
+.tools
+  = link_to 'Add <%= model_name(:human) %>', <%= wui.path(:new) %>, class: 'tools__button is_primary'
+<% wui.custom_actions.select(&:collection?).each do |action| -%>
+  = link_to '<%= action.name.humanize.titleize %>', <%= wui.path(action) %>, class: 'tools__button'
+<% end -%>
+
+- if <%= model_name(:ivars) %>.any?
+  %table.items
+    <%- object_name = model_name(:variable) -%>
+    - <%= model_name(:ivars) %>.each do |<%= object_name %>|
+      %tr
+        %td
+          = link_to <%= object_name %>.to_s, <%= object_name %>, class: 'hyperlink'
+        %td
+          .items__actions
+            = link_to 'Edit', <%= wui.path(:edit, object_name) %>, class: 'items__action'
+            = link_to 'Destroy', <%= wui.path(:destroy, object_name) %>, method: :delete, class: 'items__action', confirm: 'Really destroy?'
+          <%- wui.custom_actions.select(&:member?).each do |action| -%>
+            = link_to '<%= action.name.humanize.titleize %>', <%= wui.path(action, object_name) %>, class: 'items__action'<%=
+                ", method: :#{action.method}" unless action.get?
+              %>
+          <%- end -%>
+
+- else
+  %p.help-block
+    There are no <%= model_name(:human_plural) %> yet.

data/lib/generators/katapult/haml/templates/new.html.haml

@@ -0,0 +1,4 @@
+%h1
+  Add <%= model_name(:human) %>
+
+= render 'form'

data/lib/generators/katapult/haml/templates/show.html.haml

@@ -0,0 +1,41 @@
+%h1
+  = <%= model_name(:ivar) %>.to_s
+
+.tools
+  = link_to 'All <%= model_name(:human_plural) %>', <%= wui.path(:index) %>, class: 'tools__button'
+  = link_to 'Edit', <%= wui.path(:edit, model_name(:ivar)) %>, class: 'tools__button is_primary'
+  = link_to 'Destroy', <%= wui.path(:destroy, model_name(:ivar)) %>, method: :delete, class: 'tools__button', confirm: 'Really destroy?'
+<% wui.custom_actions.select(&:member?).each do |action| -%>
+  = link_to '<%= action.name(:human).titleize %>', <%= wui.path(action, model_name(:ivar)) %>, class: 'tools__button'<%=
+      ", method: :#{action.method}" unless action.get?
+    %>
+<% end -%>
+
+%dl.values
+<% wui.model.attrs.each do |attribute| -%>
+  <%- model_attribute = "#{model_name(:ivar)}.#{attribute.name}" -%>
+  %dt
+    = <%= model_name(:class_name) %>.human_attribute_name(:<%= attribute.name %>)
+  %dd
+  <%- case attribute.type -%>
+  <%- when :string -%>
+    = <%= model_attribute %>
+  <%- when :email -%>
+    = mail_to <%= model_attribute %>, nil, class: 'hyperlink'
+  <%- when :url -%>
+    = link_to <%= model_attribute %>, <%= model_attribute %>, class: 'hyperlink'
+  <%- when :integer -%>
+    = <%= model_attribute %>
+  <%- when :money -%>
+    = <%= model_attribute %>
+    €
+  <%- when :text -%>
+    = simple_format(<%= model_attribute %>)
+  <%- when :markdown -%>
+    = markdown(<%= model_attribute %>)
+  <%- when :flag -%>
+    = <%= model_attribute %> ? 'Yes' : 'No'
+  <%- when :datetime -%>
+    = l(<%= model_attribute %>) if <%= model_attribute %>
+  <%- end -%>
+<%- end -%>

data/lib/generators/katapult/install/install_generator.rb

@@ -0,0 +1,14 @@
+# Install katapult into an application.
+
+module Katapult
+  class InstallGenerator < Rails::Generators::Base
+
+    desc 'Install katapult into a Rails app'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def setup_lib
+      template 'lib/katapult/application_model.rb'
+    end
+
+  end
+end

data/lib/generators/katapult/install/templates/lib/katapult/application_model.rb

@@ -0,0 +1,18 @@
+# Here you define the fundamentals of your application.
+#
+# Add a model:
+# model 'customer' do |customer|
+#   customer.attr :name
+#   customer.attr :birth, type: :date
+#   customer.attr :email
+# end
+#
+# Add a web user interface:
+# wui 'customer' do |wui|
+#   wui.action :index
+#   wui.action :show
+#   wui.action :lock, scope: :member, method: :post
+# end
+#
+# Add navigation
+# navigation :main

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

@@ -0,0 +1,59 @@
+# Generate a Rails model, including migration and spec.
+
+require 'katapult/generator'
+require 'generators/katapult/model_specs/model_specs_generator'
+
+module Katapult
+  module Generators
+    class ModelGenerator < Katapult::Generator
+
+      desc 'Generate a Rails Model'
+
+      check_class_collision
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def create_migration_file
+        migration_name = "create_#{table_name}"
+        migration_attributes = model.attrs.map(&:for_migration)
+
+        args = [migration_name] + migration_attributes
+        options = { timestamps: true, force: true }
+        invoke 'active_record:migration', args, options
+      end
+
+      def create_model_file
+        template 'model.rb', File.join('app', 'models', "#{file_name}.rb")
+      end
+
+      def write_traits
+        template 'app/models/shared/does_flag.rb' if flag_attrs.any?
+      end
+
+      def generate_unit_tests
+        Generators::ModelSpecsGenerator.new(model).invoke_all
+      end
+
+      no_commands do
+        def flag_attrs
+          model.attrs.select(&:flag?)
+        end
+
+        def defaults
+          {}.tap do |defaults|
+            model.attrs.select(&:has_defaults?).each do |attr|
+              defaults[attr.name.to_sym] = attr.default
+            end
+          end
+        end
+      end
+
+      private
+
+      def model
+        @element
+      end
+
+    end
+  end
+end

data/lib/generators/katapult/model/templates/app/models/shared/does_flag.rb

@@ -0,0 +1,32 @@
+module DoesFlag
+  as_trait do |field, options = {}|
+
+    default = options[:default]
+    virtual = options[:virtual]
+    field_var = "@#{field}"
+    set_field = "#{field}="
+    field_query = "#{field}?"
+
+    validates field.to_sym, inclusion: { in: [true, false] }, allow_nil: !!virtual
+
+    unless default.nil?
+      has_defaults field.to_sym => default
+    end
+
+    if virtual
+
+      attr_reader field
+
+      define_method field_query do
+        send(field)
+      end
+
+      define_method set_field do |value|
+        value = ActiveRecord::ConnectionAdapters::Column.value_to_boolean(value)
+        instance_variable_set(field_var, value)
+      end
+
+    end
+
+  end
+end

data/lib/generators/katapult/model/templates/model.rb

@@ -0,0 +1,21 @@
+class <%= class_name %> < ActiveRecord::Base
+<%- flag_attrs.each do |attr| -%>
+  include DoesFlag[<%= attr.name(:symbol) %>, default: <%= attr.default %>]
+<%- end -%>
+<%- if defaults.any? -%>
+  has_defaults(<%= defaults %>)
+<%- end -%>
+<%- model.attrs.select(&:assignable_values).each do |attr|  -%>
+  assignable_values_for :<%= attr.name %>, <%= attr.options.slice(:allow_blank, :default) %> do
+    <%= attr.assignable_values %>
+  end
+<%- end -%>
+
+  def to_s
+<% if model.label_attr -%>
+    <%= model.label_attr.name %>.to_s
+<% else -%>
+    "<%= model.name %>##{id}"
+<% end -%>
+  end
+end

data/lib/generators/katapult/model_specs/model_specs_generator.rb

@@ -0,0 +1,51 @@
+# Generate model specs.
+
+require 'katapult/generator'
+
+module Katapult
+  module Generators
+    class ModelSpecsGenerator < Katapult::Generator
+
+      desc 'Generate model specs'
+
+      check_class_collision
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def create_model_spec
+        template 'model_spec.rb', File.join('spec', 'models', "#{file_name}_spec.rb")
+      end
+
+      no_tasks do
+        def specable_attrs
+          model.attrs.select do |attr|
+            attr.assignable_values.present? or attr.default != nil
+          end
+        end
+
+        def assignable_value_for(attr)
+          attr.assignable_values.last
+        end
+
+        # Guess a value that is not assignable
+        def unassignable_value_for(attr)
+          case attr.type
+          when :integer
+            attr.assignable_values.max + 1
+          when :string
+            assignable_value_for(attr) + '-unassignable'
+          else
+            raise "Assignable values for :#{attr.type} attributes not supported"
+          end
+        end
+      end
+
+      private
+
+      def model
+        @element
+      end
+
+    end
+  end
+end