disco-railties 0.5.0.rc1

data/lib/generators/disco/command/command_generator.rb

@@ -0,0 +1,69 @@
+require 'generators/disco/processor_name.rb'
+require 'generators/disco/event_name.rb'
+require 'generators/disco/domain.rb'
+
+module Disco
+  module Generators
+    class CommandGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attributes, type: :array, default: [], banner: 'attribute attribute'
+      class_option :skip_model, type: :boolean, default: false, desc: 'Skip active model from the command'
+      class_option :model_name, type: :string, desc: 'Name of the active model behind the command'
+      class_option :persisted, type: :boolean, default: false, desc: 'Does the command update an existing model'
+      include ProcessorName
+      include EventName
+      include Domain
+
+      def create_command_file
+        template 'command.rb.erb', File.join('app/commands', class_path, "#{file_name}_command.rb")
+      end
+
+      def create_related_event_file
+        return if skip_event?
+        raise 'do not use id as attribute, this is reserved for the event id itself' if attributes_names.include? 'id'
+        template 'event.rb.erb', File.join('app/events', event_class_path, "#{event_file_name}_event.rb")
+      end
+
+      hook_for :command_processor, require: true do |hook|
+        unless skip_processor?
+          invoke hook, [processor_file_path], %w(-s --skip-namespace)
+          add_to_command_processor
+        end
+      end
+
+      private
+
+      def add_to_command_processor
+        return if skip_processor? || (behavior == :revoke)
+        content = "
+
+    process #{class_name}Command do |command|
+      command.is_valid_do { event #{event_class_name}Event.new command.to_hash }
+    end"
+        file = File.join('domain/command_processors', processor_domain_class_path, "#{processor_file_name}_processor.rb")
+        inject_into_file file, content, after: /(\s)*include(\s)*ActiveDomain::CommandProcessor/
+      end
+
+      protected
+
+      def skip_model?
+        options[:skip_model]
+      end
+
+      def model_name
+        options[:model_name]
+      end
+
+      def persisted?
+        options[:persisted]
+      end
+
+      private
+
+      # allow this generator to be called multiple times
+      def invoke_command(command, *args) #:nodoc:
+        command.run(self, *args)
+      end
+    end
+  end
+end

data/lib/generators/disco/command/templates/command.rb.erb

@@ -0,0 +1,24 @@
+<% module_namespacing do -%>
+class <%= class_name %>Command
+  <%- unless skip_model? -%>
+  include ActiveModel::Model
+  <%- end -%>
+  include ActiveEvent::Command
+  attributes <%= (['id'] + attributes_names).map{|x| ":#{x}"}.join(', ') %>
+  <%- if !model_name.blank? && !skip_model? -%>
+
+  def self.model_name
+    @_model_name ||= begin
+      namespace = self.parents.detect do |n|
+        n.respond_to?(:use_relative_model_naming?) && n.use_relative_model_naming?
+      end
+      ActiveModel::Name.new(self, namespace, <%= model_name.inspect %>)
+    end
+  end
+  <%- end -%>
+  <%- if persisted? && ! skip_model? -%>
+
+  def persisted?; true end
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/disco/command/templates/event.rb.erb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= event_class_name %>Event
+  include ActiveEvent::EventType
+  attributes <%= (['id'] + attributes_names).map{|x| ":#{x}"}.join(', ') %>
+  <%- unless attributes_names.empty? -%>
+  def values
+    attributes_except :id
+  end
+  <%- end -%>
+end
+<% end -%>

data/lib/generators/disco/command_processor/USAGE

@@ -0,0 +1 @@
+Not intended for extern use!

data/lib/generators/disco/command_processor/command_processor_generator.rb

@@ -0,0 +1,22 @@
+require 'generators/disco/domain.rb'
+
+module Disco
+  module Generators
+    class CommandProcessorGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      include Domain
+      hide!
+
+      def create_command_processor_file
+        template 'command_processor.rb', File.join('domain/command_processors', domain_class_path, "#{file_name}_processor.rb")
+      end
+
+      private
+
+      # allow this generator to be called multiple times
+      def invoke_command(command, *args) #:nodoc:
+        command.run(self, *args)
+      end
+    end
+  end
+end

data/lib/generators/disco/command_processor/templates/command_processor.rb

@@ -0,0 +1,5 @@
+module <%= Rails::Generators.namespace.name if Rails::Generators.namespace.present? %>Domain
+  class <%= class_name %>Processor
+    include ActiveDomain::CommandProcessor
+  end
+end

data/lib/generators/disco/domain.rb

@@ -0,0 +1,19 @@
+require 'active_support/concern'
+
+module Disco
+  module Generators
+    module Domain
+      extend ActiveSupport::Concern
+
+      def domain_class_path
+        @domain_calss_path ||= class_path_domain class_path
+      end
+
+      protected
+
+      def class_path_domain(class_path)
+        (Array.new class_path).unshift 'domain'
+      end
+    end
+  end
+end

data/lib/generators/disco/event_name.rb

@@ -0,0 +1,52 @@
+require 'active_support/concern'
+
+module Disco
+  module Generators
+    module EventName
+      extend ActiveSupport::Concern
+
+      included do
+        class_option :event, type: :string, default: nil, desc: "name of the event (defaults to NAME)"
+        class_option :skip_event, type: :boolean, default: false, desc: "skip event generation"
+      end
+
+      def initialize(args, *options)
+        super
+        assign_event_name!(event_name)
+      end      
+
+      protected
+
+      attr_reader :event_file_name
+      attr_reader :event_class_path
+
+      def skip_event?
+        options[:skip_event]
+      end
+
+      def event_name
+        options[:event] || name
+      end
+
+      def event_class_name
+        (event_class_path + [event_file_name]).map!{ |m| m.camelize }.join('::')
+      end
+
+      def event_file_path
+        @event_file_path ||= (event_class_path + [event_file_name]).join('/')
+      end
+
+      def event_domain_class_path
+        @event_domain_class_path ||= class_path_domain event_class_path
+      end
+
+      private
+
+      def assign_event_name!(event_name)
+        @event_class_path = event_name.include?('/') ? event_name.split('/') : event_name.split('::')
+        @event_class_path.map! &:underscore
+        @event_file_name = @event_class_path.pop
+      end
+    end
+  end
+end

data/lib/generators/disco/migration/USAGE

@@ -0,0 +1,41 @@
+Description:
+    Stubs out a new database migration for ActiveRecord. Pass the migration name, either
+    CamelCased or under_scored, and an optional list of attribute pairs as arguments.
+
+    A migration class is generated in db/migrate prefixed by a timestamp of the current date and time.
+
+    You can name your migration in either of these formats to generate add/remove
+    column lines from supplied attributes: AddColumnsToTable or RemoveColumnsFromTable
+
+Example:
+    `disco generate migration AddSslFlag`
+
+    If the current date is May 14, 2008 and the current time 09:09:12, this creates the AddSslFlag migration
+    db/migrate/20080514090912_add_ssl_flag.rb
+
+    `disco generate migration AddSslFlag --domain`
+
+    Under the same conditions as above, this creates the AddSslFlag migration
+    db/migrate_domain/20080514090912_add_ssl_flag.rb
+
+    `disco generate migration AddTitleBodyToPost title:string body:text published:boolean`
+
+    This will create the AddTitleBodyToPost in db/migrate/20080514090912_add_title_body_to_post.rb with this in the Change migration:
+
+      add_column :posts, :title, :string
+      add_column :posts, :body, :text
+      add_column :posts, :published, :boolean
+
+Migration names containing JoinTable will generate join tables for use with
+has_and_belongs_to_many associations.
+
+Example:
+    `disco g migration CreateMediaJoinTable artists musics:uniq`
+
+    will create the migration
+
+    create_join_table :artists, :musics do |t|
+      # t.index [:artist_id, :music_id]
+      t.index [:music_id, :artist_id], unique: true
+    end
+

data/lib/generators/disco/migration/migration_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/active_record/migration/migration_generator'
+require 'generators/disco/use_domain_option.rb'
+
+module Disco
+  module Generators
+    class MigrationGenerator < ActiveRecord::Generators::MigrationGenerator
+      source_root File.expand_path('../templates', __FILE__)
+      include UseDomainOption
+
+      def create_migration_file
+        set_local_assigns!
+        validate_file_name!
+        migration_template @migration_template, "db/#{migration_dir}/#{file_name}.rb"
+      end
+
+      private
+
+      def migration_dir
+        if use_domain?
+          'migrate_domain'
+        else
+          'migrate'
+        end
+      end
+    end
+  end
+end

data/lib/generators/disco/migration/templates/create_table_migration.rb

@@ -0,0 +1,19 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def change
+    create_table :<%= table_name %> do |t|
+<% attributes.each do |attribute| -%>
+<%   if attribute.password_digest? -%>
+      t.string :password_digest<%= attribute.inject_options %>
+<%   else -%>
+      t.<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<%   end -%>
+<% end -%>
+<% if options[:timestamps] %>
+      t.timestamps
+<% end -%>
+    end
+<% attributes_with_index.each do |attribute| -%>
+    add_index :<%= table_name %>, :<%= attribute.index_name %><%= attribute.inject_index_options %>
+<% end -%>
+  end
+end

data/lib/generators/disco/model/USAGE

@@ -0,0 +1,17 @@
+Description:
+    Generates a Model and a Projection for it.
+
+Example:
+    disco generate model Thing [attr1:type, attr2:type]
+
+    This will create:
+        app/projection/thing_projection.rb
+        app/models/thing.rb
+        db/migrate/create_thing.rb
+
+    disco generate model Thing [attr1:type, attr2:type] --domain
+
+    This will create:
+        domain/projections/domain/thing_projection.rb
+        domain/models/domain/thing.rb
+        db/migrate_domain/create_thing.rb

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

@@ -0,0 +1,29 @@
+require 'generators/disco/use_domain_option.rb'
+
+module Disco
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attributes, type: :array, default: [], banner: 'field[:type] field[:type]'
+      include UseDomainOption
+
+      hook_for :projection, require: true do |hook|
+        invoke hook, [name]
+      end
+
+      def create_model_file
+        template use_domain('model.rb'), use_domain_class_file_path('models', "#{file_name}.rb")
+      end
+
+      hook_for :migration, require: true do |hook|
+        invoke hook, ["create_#{table_name}", *attributes]
+      end
+
+      private
+
+      # do not parse - keep attributes for forwarding to migration
+      def parse_attributes!
+      end
+    end
+  end
+end

data/lib/generators/disco/model/templates/domain_model.rb

@@ -0,0 +1,5 @@
+module <%= Rails::Generators.namespace.name if Rails::Generators.namespace.present? %>Domain
+  class <%= class_name %> < ActiveRecord::Base
+    self.table_name = '<%=table_name %>'
+  end
+end

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

@@ -0,0 +1,5 @@
+<% module_namespacing do -%>
+class <%= class_name %> < ActiveRecord::Base
+  self.table_name = '<%=table_name %>'
+end
+<% end -%>

data/lib/generators/disco/processor_name.rb

@@ -0,0 +1,48 @@
+require 'active_support/concern'
+
+module Disco
+  module Generators
+    module ProcessorName
+      extend ActiveSupport::Concern
+
+      included do
+        class_option :processor, type: :string, default: nil, desc: "class_name of the command processor (defaults to NAME)"
+        class_option :skip_processor, type: :boolean, default: false, desc: "Skip command processor generation"
+      end
+
+      def initialize(args, *options)
+        super
+        assign_processor_names!(processor_name)
+      end      
+
+      protected
+
+      attr_reader :processor_file_name
+      attr_reader :processor_class_path
+
+      def skip_processor?
+        options[:skip_processor]
+      end
+
+      def processor_name
+        options[:processor] || name
+      end
+
+      def processor_file_path
+        @processor_file_path ||= (processor_class_path + [processor_file_name]).join('/')
+      end
+
+      def processor_domain_class_path
+        @processor_domain_class_path ||= class_path_domain processor_class_path
+      end
+
+      private
+
+      def assign_processor_names!(processor_name)
+        @processor_class_path = processor_name.include?('/') ? processor_name.split('/') : processor_name.split('::')
+        @processor_class_path.map! &:underscore
+        @processor_file_name = @processor_class_path.pop
+      end
+    end
+  end
+end

data/lib/generators/disco/projection/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a projection with handlers for the given events.
+
+Example:
+    disco generate projection Thing [event event]
+
+    This will create:
+        app/projection/thing_projection.rb
+
+    disco generate projection Thing [event event] --domain
+
+    This will create:
+        domain/projections/domain/thing_projection.rb

data/lib/generators/disco/projection/projection_generator.rb

@@ -0,0 +1,19 @@
+require 'generators/disco/use_domain_option.rb'
+
+module Disco
+  module Generators
+    class ProjectionGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      argument :events, type: :array, default: [], banner: 'event event'
+      include UseDomainOption
+
+      def create_projection_file
+        template use_domain('projection.rb'), use_domain_class_file_path('projections', "#{plural_file_name}_projection.rb")
+      end
+
+      def create_test_files
+        template use_domain('projection_test.rb'), File.join('test/projections', use_domain_class_path, "#{plural_file_name}_projection_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/disco/projection/templates/domain_projection.rb

@@ -0,0 +1,9 @@
+module <%= Rails::Generators.namespace.name if Rails::Generators.namespace.present? %>Domain
+  class <%= class_name %>Projection
+    include ActiveDomain::Projection
+    <% events.each do |event| %>
+    def <%= event.underscore.split('/') * '__' %>(event)
+    end
+    <% end %>
+  end
+end

data/lib/generators/disco/projection/templates/domain_projection_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+module <%= Rails::Generators.namespace.name if Rails::Generators.namespace.present? %>Domain
+  class <%= plural_name.camelcase %>ProjectionTest < ActiveSupport::TestCase
+  end
+end

data/lib/generators/disco/projection/templates/projection.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+class <%= class_name %>Projection
+  include ActiveProjection::ProjectionType
+  <% events.each do |event| %>
+  def <%= event.underscore.split('/') * '__' %>(event)
+  end
+  <% end %>
+end
+<% end -%>

data/lib/generators/disco/projection/templates/projection_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+<% module_namespacing do -%>
+class <%= plural_name.camelcase %>ProjectionTest < ActiveSupport::TestCase
+end
+<% end -%>

data/lib/generators/disco/scaffold/USAGE

@@ -0,0 +1,27 @@
+Description:
+    Scaffolds a complete resource with models, migration, projections, controller, views
+    commands, events and command_processor.
+
+Example:
+    disco generate scaffold Thing [attr1:type, attr2:type]
+
+    This will create:
+        app/controllers/things_controller
+        app/commands/create_thing_command.rb
+        app/commands/update_thing_command.rb
+        app/commands/delete_thing_command.rb
+        domain/command_processors/thing_processor.rb
+        app/events/created_thing_event.rb
+        app/events/updated_thing_event.rb
+        app/events/deleted_thing_event.rb
+        app/projections/things_projection.rb
+        db/migrate/create_things.rb
+        app/models/thing.rb
+        app/helpers/things_helper.rb
+        app/views/things/_eventstream.js.erb
+        app/views/things/_form.html.erb
+        app/views/things/edit.html.erb
+        app/views/things/index.html.erb
+        app/views/things/new.html.erb
+        app/views/things/show.html.erb
+        a resource route

data/lib/generators/disco/scaffold/scaffold_generator.rb

@@ -0,0 +1,91 @@
+require 'generators/disco/processor_name.rb'
+require 'generators/disco/domain.rb'
+
+module Disco
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attributes, type: :array, default: [], banner: 'field[:type] field[:type]'
+      include ProcessorName
+      include Domain
+
+      hook_for :model, in: :disco, require: true
+
+      hook_for :command, in: :disco, require: true do |hook|
+        %w(create update delete).each do |action|
+          args = [(class_path + ["#{action}_#{file_name}"]) * '/']
+          args += attributes_names unless action == 'delete'
+          opts = ["--event=#{(class_path + ["#{action}d_#{file_name}"]) * '/'}"]
+          opts << "--processor=#{processor_name}" unless skip_processor?
+          opts << '--skip_model' if action == 'delete'
+          opts << "--model_name=#{class_name}"
+          opts << '--persisted' if action == 'update'
+          invoke hook, args, opts
+          add_to_projections(action)
+        end
+        add_to_command_processor
+      end
+
+      def add_routes
+        routing_code = ''
+        class_path.each_with_index do |namespace, index|
+          add_line_with_indent routing_code, (index + 1), "namespace :#{namespace} do"
+        end
+        add_line_with_indent routing_code, (class_path.length + 1), "resources :#{plural_name}"
+        class_path.each_with_index do |_, index|
+          add_line_with_indent routing_code, (class_path.length - index), 'end'
+        end
+        route routing_code[2..-1]
+      end
+
+      hook_for :scaffold_controller, in: :disco, require: true do |hook|
+        invoke hook
+        add_event_stream_to_views
+      end
+
+      def copy_event_stream_client
+        # ensure if app was created before this was default
+        copy_file '_eventstream.js.erb', 'app/views/application/eventstream/_eventstream.js.erb', verbose: false, skip: true
+      end
+
+      protected
+
+      def add_event_stream_to_views
+        return if behavior == :revoke
+        include_text = '<%= javascript_tag render partial: \'application/eventstream/eventstream\', formats: [:js], locals: {event_id: @event_id} %>'
+        prepend_to_file File.join('app/views', class_path, plural_file_name, 'index.html.erb'), include_text
+        prepend_to_file File.join('app/views', class_path, plural_file_name, 'show.html.erb'), include_text
+      end
+
+      def add_to_command_processor
+        return if behavior == :revoke
+        content = "\n       command.id = ActiveDomain::UniqueCommandIdRepository.new_for command.class.name"
+        insert_into_file File.join('domain/command_processors', domain_class_path, "#{processor_file_name}_processor.rb"), content, after: /(\s)*process(\s)*(.)*CreateCommand(.)*/
+      end
+
+      def add_to_projections(action)
+        return if behavior == :revoke
+        event_func = (class_path + ["#{action}d_#{file_name}_event"]) * '__'
+        content = "
+
+  def #{event_func}(event)
+    #{method_bodies[action.to_sym]}
+  end"
+        indent(content) if namespaced?
+        inject_into_file File.join('app/projections', class_path, "#{plural_file_name}_projection.rb"), content, after: /(\s)*include(\s)*ActiveProjection::ProjectionType/
+      end
+
+      def method_bodies
+        @method_bodies ||= {
+            create: "#{class_name}.create! event.values.merge(id: event.id)",
+            update: "#{class_name}.find(event.id).update! event.values",
+            delete: "#{class_name}.find(event.id).destroy!",
+        }
+      end
+
+      def add_line_with_indent(target, indent, str)
+        target << "#{'  ' * indent}#{str}\n"
+      end
+    end
+  end
+end

data/lib/generators/disco/scaffold/templates/_eventstream.js.erb

@@ -0,0 +1,16 @@
+<% if event_id.present? %>
+    $(document).ready(function () {
+        setTimeout(function () {
+            var source = new EventSource('/event_stream');
+            source.addEventListener('refresh', function (e) {
+                var event = JSON.parse(e.data);
+                if (<%= event_id %> == event.id){
+                    window.location.reload();
+                }else if (<%= event_id %> < event.id){
+                    source.removeEventListener('refresh');
+                    source.close();
+                }
+            });
+        }, 1);
+    });
+<% end %>

data/lib/generators/disco/scaffold_controller/USAGE

@@ -0,0 +1 @@
+Not intended for extern use!

data/lib/generators/disco/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+module Disco
+  module Generators
+    class ScaffoldControllerGenerator < Rails::Generators::ScaffoldControllerGenerator
+      source_root File.expand_path('../templates', __FILE__)
+      hide!
+
+      # the normal test_framework will not cover our usecase
+      remove_hook_for :test_framework
+      def create_test_files
+        template 'controller_test.rb', File.join('test/controllers', controller_class_path, "#{controller_file_name}_controller_test.rb")
+      end
+
+      protected
+
+      def command_class_name(command)
+        (class_path + ["#{command}_#{file_name}"]).map(&:camelize) * '::'
+      end
+
+      private
+      
+      def params_string
+        attributes.map { |x| "#{x.name}: params[:#{singular_table_name}][:#{x.name}]" }.join(', ')
+      end
+    end
+  end
+end