katapult 0.1.0

data/lib/generators/katapult/model_specs/templates/model_spec.rb

@@ -0,0 +1,34 @@
+require 'rails_helper'
+
+describe <%= model.name :class %> do
+
+  describe '#to_s' do
+  <%- if model.label_attr -%>
+    it 'returns the #<%= model.label_attr.name %> attribute' do
+      subject.<%= model.label_attr.name %> = <%= model.label_attr.test_value.inspect %>
+      expect(subject.to_s).to eql(<%= model.label_attr.test_value.to_s.inspect %>)
+    end
+  <%- else -%>
+    it 'returns its class name with its id' do
+      subject.id = 17
+      expect(subject.to_s).to eql("<%= model.name %>#17")
+    end
+  <%- end -%>
+  end
+<% specable_attrs.each do |attr| -%>
+
+  describe '#<%= attr.name %>' do
+  <%- if attr.assignable_values.present? -%>
+    it { is_expected.to allow_value(<%= assignable_value_for(attr).inspect %>).for(:<%= attr.name %>) }
+    it { is_expected.to_not allow_value(<%= unassignable_value_for(attr).inspect %>).for(:<%= attr.name %>) }
+  <%- end -%>
+  <%- unless attr.default.nil? -%>
+
+    it 'has a default' do
+      expect( subject.<%= attr.name %> ).to eql(<%= attr.default.inspect %>)
+    end
+  <%- end -%>
+  end
+<% end -%>
+
+end

data/lib/generators/katapult/navigation/navigation_generator.rb

@@ -0,0 +1,25 @@
+# Generate navigation.
+
+require 'katapult/generator'
+
+module Katapult
+  module Generators
+    class NavigationGenerator < Katapult::Generator
+
+      desc 'Generate the navigation'
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def create_navigation
+        template 'app/models/navigation.rb'
+      end
+
+      private
+
+      def navigation
+        @element
+      end
+
+    end
+  end
+end

data/lib/generators/katapult/navigation/templates/app/models/navigation.rb

@@ -0,0 +1,12 @@
+class Navigation
+  include Navy::Description
+
+  navigation :<%= name.downcase %> do
+<% navigation.wuis.each do |wui| -%>
+  <%- if wui.find_action(:index) -%>
+    section <%= navigation.section_name(wui) %>, <%= wui.model_name(:human_plural).titlecase.inspect %>, <%= wui.path(:index) %>
+  <%- end -%>
+<% end -%>
+  end
+
+end

data/lib/generators/katapult/transform/transform_generator.rb

@@ -0,0 +1,47 @@
+# Generate files and directories from an application model file. Afterwards do
+# any setup left necessary (e.g. updating the database).
+
+# The application model transformation is split into two parts:
+# 1) parse the model into an object-based representation
+# 2) render the parsed model into code
+
+require 'katapult/parser'
+
+module Katapult
+  class TransformGenerator < Rails::Generators::Base
+    desc 'Transform the katapult application model'
+
+    argument :path, required: true, type: :string,
+      description: 'The path to the application model file'
+
+
+    def transform_application_model
+      say_status :parse, path
+      @app_model = Katapult::Parser.new.parse(path)
+
+      say_status :render, "into #{application_name}"
+      @app_model.render
+    end
+
+    def write_root_route
+      root_wui = @app_model.wuis.find do |wui|
+        wui.find_action :index
+      end
+
+      route "root '#{ root_wui.model_name(:variables) }#index'" if root_wui
+    end
+
+    def migrate
+      run 'bin/rake db:drop:all &> /dev/null'
+      run 'bin/rake db:create db:migrate RAILS_ENV=development'
+      run 'bin/rake db:create db:migrate RAILS_ENV=test'
+    end
+
+    private
+
+    def application_name
+       File.basename(Dir.pwd)
+    end
+
+  end
+end

data/lib/generators/katapult/w_u_i/templates/_route.rb

@@ -0,0 +1,13 @@
+% rails_actions = wui.actions - wui.custom_actions
+resources <%= model_name(:symbols) %>, only: <%= rails_actions.map(&:name).map(&:to_sym) %> do
+    member do
+% wui.custom_actions.select(&:member?).each do |action|
+      <%= action.method %> '<%= action.name %>'
+% end
+    end
+    collection do
+% wui.custom_actions.select(&:collection?).each do |action|
+      <%= action.method %> '<%= action.name %>'
+% end
+    end
+  end

data/lib/generators/katapult/w_u_i/templates/controller.rb

@@ -0,0 +1,106 @@
+class <%= model_name(:classes) %>Controller < ApplicationController
+<%- if navigation -%>
+
+  before_filter :set_section
+<%- end -%>
+<% if wui.find_action :index -%>
+
+  def index
+    <%= method_name(:load_collection) %>
+  end
+<% end -%>
+<% if wui.find_action :show -%>
+
+  def show
+    <%= method_name(:load_object) %>
+  end
+<% end -%>
+<% if wui.find_action :new -%>
+
+  def new
+    <%= method_name(:build) %>
+  end
+<% end -%>
+<% if wui.find_action :create -%>
+
+  def create
+    <%= method_name(:build) %>
+    <%= method_name(:save) %> or render :new
+  end
+<% end -%>
+<% if wui.find_action :edit -%>
+
+  def edit
+    <%= method_name(:load_object) %>
+    <%= method_name(:build) %>
+  end
+<% end -%>
+<% if wui.find_action :update -%>
+
+  def update
+    <%= method_name(:load_object) %>
+    <%= method_name(:build) %>
+    <%= method_name(:save) %> or render :edit
+  end
+<% end -%>
+<% if wui.find_action :destroy -%>
+
+  def destroy
+    <%= method_name(:load_object) %>
+    <%= model_name(:ivar) %>.destroy
+    redirect_to <%= wui.path(:index) %>
+  end
+<% end -%>
+<% wui.custom_actions.each do |action|  -%>
+
+  def <%= action.name %>
+<% if action.member? -%>
+    <%= method_name(:load_object) %>
+  <%- unless action.get? -%>
+    redirect_to <%= model_name(:ivar) %>
+  <%- end -%>
+<% elsif action.collection? -%>
+    <%= method_name(:load_collection) %>
+  <%- unless action.get? -%>
+    redirect_to <%= wui.path(:index) %>
+  <%- end -%>
+<% end -%>
+  end
+<% end -%>
+
+  private
+
+  def <%= method_name(:load_collection) %>
+    <%= model_name(:ivars) %> ||= <%= method_name(:scope) %>.to_a
+  end
+
+  def <%= method_name(:load_object) %>
+    <%= model_name(:ivar) %> ||= <%= method_name(:scope) %>.find(params[:id])
+  end
+
+  def <%= method_name(:build) %>
+    <%= model_name(:ivar) %> ||= <%= method_name(:scope) %>.build
+    <%= model_name(:ivar) %>.attributes = <%= method_name(:params) %>
+  end
+
+  def <%= method_name(:save) %>
+    if <%= model_name(:ivar) %>.save
+      redirect_to <%= model_name(:ivar) %>
+    end
+  end
+
+  def <%= method_name(:params) %>
+    <%= method_name(:params) %> = params[:<%= model_name(:variable) %>]
+    <%= method_name(:params) %> ? <%= method_name(:params) %>.permit(<%= wui.model.attrs.map(&:name).map(&:to_sym) %>) : {}
+  end
+
+  def <%= method_name(:scope) %>
+    <%= model_name(:class_name) %>.scoped
+  end
+
+<%- if navigation -%>
+  def set_section
+    in_sections <%= navigation.section_name(wui) %>
+  end
+<%- end -%>
+end

data/lib/generators/katapult/w_u_i/w_u_i_generator.rb

@@ -0,0 +1,57 @@
+# Generate a controller, routes and view files for a WUI.
+
+require 'katapult/generator'
+require 'generators/katapult/haml/haml_generator'
+
+module Katapult
+  module Generators
+    class WUIGenerator < Katapult::Generator
+
+      desc 'Generate a Web User Interface'
+
+      check_class_collision suffix: 'Controller'
+      source_root File.expand_path('../templates', __FILE__)
+
+
+      def create_controller_file
+        template 'controller.rb', File.join('app', 'controllers', "#{ model_name(:variables) }_controller.rb")
+      end
+
+      def add_route
+        route render_partial('_route.rb')
+      end
+
+      def generate_views
+        Generators::HamlGenerator.new(wui).invoke_all
+      end
+
+      no_tasks do
+        def method_name(name)
+          case name
+          when :load_collection then "load_#{model_name :variables}"
+          when :load_object     then "load_#{model_name :variable}"
+          when :build           then "build_#{model_name :variable}"
+          when :save            then "save_#{model_name :variable}"
+          when :params          then "#{model_name :variable}_params"
+          when :scope           then "#{model_name :variable}_scope"
+          end
+        end
+
+        def model_name(kind = nil)
+          wui.model_name(kind)
+        end
+
+        def navigation
+          wui.application_model.navigation
+        end
+      end
+
+      private
+
+      def wui
+        @element
+      end
+
+    end
+  end
+end

data/lib/katapult.rb

@@ -0,0 +1,5 @@
+require 'active_support'
+require 'active_support/core_ext/hash/slice'
+
+module Katapult
+end

data/lib/katapult/action.rb

@@ -0,0 +1,44 @@
+# Models a controller action. To be used within the block of a WUI.
+
+require 'katapult/element'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/string/inquiry'
+
+module Katapult
+  class Action < Element
+
+    options :method, :scope
+
+    def initialize(*args)
+      super
+
+      self.scope ||= (name == 'index') ? :collection : :member
+      set_method
+    end
+
+    delegate :post?, :get?, :put?, to: :method_inquiry
+    delegate :member?, :collection?, to: :scope_inquiry
+
+    private
+
+    def method_inquiry
+      @method.to_s.inquiry
+    end
+
+    def scope_inquiry
+      @scope.to_s.inquiry
+    end
+
+    def set_method
+      self.method ||= case name
+      when 'create', 'update'
+        :post
+      when 'destroy'
+        :delete
+      else # index, show, new, edit + custom actions
+        :get
+      end
+    end
+
+  end
+end

data/lib/katapult/application_model.rb

@@ -0,0 +1,45 @@
+# Internal representation of an application model file.
+
+module Katapult
+  class ApplicationModel
+
+    attr_reader :models, :wuis, :navigation
+
+    def initialize
+      @models = []
+      @wuis = []
+    end
+
+    def add_model(model)
+      model.set_application_model(self)
+      @models << model
+    end
+
+    def get_model(name)
+      models.find { |m| m.name == name }
+    end
+
+    def add_wui(wui)
+      wui.set_application_model(self)
+      @wuis << wui
+    end
+
+    def get_wui(name)
+      wuis.find { |w| w.name == name }
+    end
+
+    def set_navigation(navigation)
+      navigation.set_application_model(self)
+      @navigation = navigation
+    end
+
+    # ---
+
+    def render
+      models.each &:render
+      wuis.each &:render
+      navigation.render if navigation
+    end
+
+  end
+end

data/lib/katapult/attribute.rb

@@ -0,0 +1,83 @@
+# Models a model attribute. To be used within the block of a model element.
+
+require 'katapult/element'
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/string/inquiry'
+require 'zlib'
+
+module Katapult
+  class Attribute < Element
+
+    options :type, :default, :assignable_values, :allow_blank
+
+    UnknownTypeError = Class.new(StandardError)
+    MissingOptionError = Class.new(StandardError)
+    TYPES = %i(string email url integer money text markdown flag datetime)
+
+    def initialize(*args)
+      super
+
+      self.type ||= :email if name.to_s =~ /email/
+      self.type ||= :string
+
+      validate
+    end
+
+    delegate :flag?, to: :type_inquiry
+
+    def has_defaults?
+      default and not [flag?, assignable_values].any?
+    end
+
+    def for_migration
+      db_type = case type
+      when :email, :url
+        'string'
+      when :flag
+        'boolean'
+      when :money
+        'decimal{10,2}' # {precision,scale} = total digits, decimal places
+      else
+        type
+      end
+
+      "#{name}:#{db_type}"
+    end
+
+    def test_value
+      if assignable_values
+        assignable_values.first
+
+      else
+        case type
+        when :string     then "#{name}-string"
+        when :email      then "#{name}@example.com"
+        when :url        then "#{name}.example.com"
+        when :text       then "#{name}-text"
+
+        # Deterministically generate a value from the attribute's name
+        when :integer    then Zlib.crc32(name).modulo(1000)
+        when :money      then Zlib.crc32(name).modulo(1000) / 100.0
+        when :datetime   then Time.at(Zlib.crc32(name))
+        end
+      end
+    end
+
+    private
+
+    def type_inquiry
+      @type.to_s.inquiry
+    end
+
+    def validate
+      TYPES.include?(type) or raise UnknownTypeError,
+        "Attribute type :#{type} is not supported. Use one of #{TYPES.inspect}."
+
+      if flag? and default.nil?
+        raise MissingOptionError,
+          "The :flag attribute '#{name}' requires a default (true or false)."
+      end
+    end
+
+  end
+end