riveter 0.0.1

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

@@ -0,0 +1,55 @@
+module Riveter
+  module Generators
+    class CommandGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'Command'
+
+      argument :command_attributes,
+               :type => :array,
+               :default => [],
+               :banner => "[name[:type[:required]] name[:type[:required]]]"
+
+      class_option :command_controller, :type => :boolean, :default => true
+      hook_for :command_controller, :type => :boolean
+
+      def initialize(args, *options)
+        super
+        parse_command_attributes!
+      end
+
+      def create_command_file
+        template 'command.rb', File.join('app/commands', class_path, "#{file_name}_command.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/commands', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      def create_locale_file
+        template 'commands.en.yml', File.join('config/locales', 'commands.en.yml') unless locale_file_exists?
+      end
+
+      hook_for :test_framework, :as => :command
+
+    protected
+
+      def parse_command_attributes!
+        self.command_attributes = (command_attributes || []).map do |attribute|
+          # expected in the form "name", "name:type" or "name:type:required"
+          parts = attribute.split(':')
+          OpenStruct.new(
+            :name => parts.first.underscore,
+            :type => ((parts.length > 1) ? parts[1] : 'string'),
+            :inject_options => ((parts.length == 3 && parts[2] == 'required') ? ', :required => true' : '')
+          )
+        end
+      end
+
+      def locale_file_exists?
+        File.exists?(File.join(destination_root, 'config', 'locales', 'commands.en.yml'))
+      end
+    end
+  end
+end

data/lib/generators/riveter/command/templates/command.rb

@@ -0,0 +1,40 @@
+<% module_namespacing do -%>
+class <%= class_name %>Command < Riveter::Command::Base
+<% if command_attributes.any? %>
+<% command_attributes.each do |attribute| -%>
+  attr_<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% else -%>
+
+  #
+  # define command attributes
+  #
+  # E.g.
+  #
+  #   attr_string :name[, options]
+  #
+  #   options include:
+  #    :required => true|false  # default is false
+  #    :default => 'a value'    # default is nil
+  #    :validate => true|false  # default is true
+  #
+  #  supported attributes:
+  #
+  #   attr_string
+  #   attr_text
+  #   attr_integer
+  #   attr_decimal
+  #   attr_date
+  #   attr_time
+  #   attr_boolean
+  #   attr_enum
+  #   attr_array
+  #   attr_hash
+  #   attr_model
+  #
+<% end -%>
+
+  # optionally, define additional validations
+
+end
+<% end -%>

data/lib/generators/riveter/command/templates/commands.en.yml

@@ -0,0 +1,57 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+
+  # shared attribute translations (NB: across all objects!)
+  attributes:
+
+    #
+    # E.g. shared "name" attribute
+    #
+
+    name: Name
+
+  # translations for commands
+  commands:
+
+    models:
+
+      #
+      # E.g. for ExampleCommand as follows
+      #
+      example: Example Command Name
+
+    attributes:
+
+      #
+      # E.g. for attributes of the ExampleCommand as follows
+      #
+      example:
+        active_only: Active items only?
+
+    notices:
+
+      #
+      # E.g. for success notices of the ExampleCommand as follows
+      #
+      example:
+        success: Successfully executed example.

data/lib/generators/riveter/command/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

data/lib/generators/riveter/command_controller/command_controller_generator.rb

@@ -0,0 +1,40 @@
+module Riveter
+  module Generators
+    class CommandControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'CommandController'
+
+      argument :new_action,
+               :type => :string,
+               :default => 'new',
+               :banner => 'new_action'
+
+      argument :create_action,
+               :type => :string,
+               :default => 'create',
+               :banner => 'create_action'
+
+      def create_command_controller_file
+        template 'command_controller.rb', File.join('app/controllers', class_path, "#{file_name}_command_controller.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/controllers', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      def add_command_route
+        route "command :#{class_name.underscore}#{additional_args}"
+      end
+
+      hook_for :template_engine
+      hook_for :test_framework, :as => :command_controller
+
+      def additional_args
+        ((new_action == 'new') ? '' : ", :new_action => :#{new_action}") +
+        ((create_action == 'create') ? '' : ", :create_action => :#{create_action}")
+      end
+    end
+  end
+end

data/lib/generators/riveter/command_controller/templates/command_controller.rb

@@ -0,0 +1,18 @@
+<% module_namespacing do -%>
+class <%= class_name %>CommandController < ApplicationController
+  include Riveter::CommandController
+
+  # register as controller for specified command
+  command_controller_for <%= class_name %>Command<%= additional_args %>
+
+  def on_success(command, result)
+    # TODO: provide path for redirect
+    respond_to do |format|
+      format.html { redirect_to '/', :notice => <%= class_name %>Command.success_notice }
+      format.json { render :status => :completed }
+      format.js
+    end
+  end
+
+end
+<% end -%>

data/lib/generators/riveter/command_controller/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

data/lib/generators/riveter/enquiry/enquiry_generator.rb

@@ -0,0 +1,29 @@
+module Riveter
+  module Generators
+    class EnquiryGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :enquiry_controller, :type => :boolean, :default => true
+      hook_for :enquiry_controller, :type => :boolean
+
+      class_option :query, :type => :boolean, :default => true
+      hook_for :query, :type => :boolean
+
+      class_option :query_filter, :type => :boolean, :default => true
+      hook_for :query_filter, :type => :boolean
+
+      check_class_collision :suffix => 'Enquiry'
+
+      def create_enquiry_file
+        template 'enquiry.rb', File.join('app/enquiries', class_path, "#{file_name}_enquiry.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/enquiries', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      hook_for :test_framework, :as => :enquiry
+    end
+  end
+end

data/lib/generators/riveter/enquiry/templates/enquiry.rb

@@ -0,0 +1,11 @@
+<% module_namespacing do -%>
+class <%= class_name %>Enquiry < Riveter::Enquiry::Base
+
+  # define filter to use
+  filter_with <%= class_name %>QueryFilter
+
+  # define query to use
+  query_with <%= class_name %>Query
+
+end
+<% end -%>

data/lib/generators/riveter/enquiry/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

data/lib/generators/riveter/enquiry_controller/enquiry_controller_generator.rb

@@ -0,0 +1,34 @@
+module Riveter
+  module Generators
+    class EnquiryControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'EnquiryController'
+
+      argument :action_name,
+               :type => :string,
+               :default => 'index',
+               :banner => 'action_name'
+
+      def create_enquiry_controller_file
+        template 'enquiry_controller.rb', File.join('app/controllers', class_path, "#{file_name}_enquiry_controller.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/controllers', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      def add_enquiry_route
+        route "enquiry :#{class_name.underscore}#{additional_args}"
+      end
+
+      hook_for :template_engine
+      hook_for :test_framework, :as => :enquiry_controller
+
+      def additional_args
+        (action_name == 'index') ? '' : ", :action => :#{action_name}"
+      end
+    end
+  end
+end

data/lib/generators/riveter/enquiry_controller/templates/enquiry_controller.rb

@@ -0,0 +1,9 @@
+<% module_namespacing do -%>
+class <%= class_name %>EnquiryController < ApplicationController
+  include Riveter::EnquiryController
+
+  # register as controller for specified enquiry
+  enquiry_controller_for <%= class_name %>Enquiry<%= additional_args %>
+
+end
+<% end -%>

data/lib/generators/riveter/enquiry_controller/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

data/lib/generators/riveter/enum/USAGE

@@ -0,0 +1,41 @@
+Description:
+  Stubs out a enumeration module. Pass the enumeration name, either CamelCased or
+  under_scored, and an optional list of member value pairs as arguments.
+  "Enum" will be appended to the name of the module.
+
+  Member pairs are member:value arguments specifying the members and optionally their values.
+  If the value part is omitted, an integer value will be assigned, based on the members position
+  in the list of member arguments
+
+  You don't have to think up every member up front, but it helps to
+  sketch out a few so you can start working with the enumeration immediately.
+
+  This generator invokes your configured test framework which defaults to TestUnit
+
+  If you pass a namespaced enumeration name (e.g. admin/account_type or Admin::AccountType)
+  then the generator will create a module (e.g. admin_account_type)
+
+Examples:
+  `rails generate riveter:enum account_type`
+
+    Creates an enumeration module
+
+      Enum: app/enums/account_type_enum.rb
+
+  `rails generate riveter:enum admin/account_type`
+
+    Creates an enumeration module within the admin namespace
+
+      Enum: app/enums/admin/account_type_enum.rb
+
+  `rails generate riveter:enum account_type local foreign`
+
+    Creates an enumeration module, with "Local" and "Foreign" as members with default integer values
+
+      Enum: app/enums/account_type_enum.rb
+
+  `rails generate riveter:enum account_type local:1 foreign:2`
+
+    Creates an enumeration module, with "Local" and "Foreign" as members with the values 1 and 2 respectively
+
+      Enum: app/enums/account_type_enum.rb

data/lib/generators/riveter/enum/enum_generator.rb

@@ -0,0 +1,51 @@
+module Riveter
+  module Generators
+    class EnumGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'Enum'
+
+      argument :enum_members,
+               :type => :array,
+               :default => [],
+               :banner => "[name[:value] name[:value]]"
+
+      def initialize(args, *options)
+        super
+        parse_enum_members!
+      end
+
+      def create_enum_file
+        template 'enum.rb', File.join('app/enums', class_path, "#{file_name}.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/enums', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      def create_locale_file
+        template 'enums.en.yml', File.join('config/locales', 'enums.en.yml') unless locale_file_exists?
+      end
+
+      hook_for :test_framework, :as => :enum
+
+    protected
+
+      def parse_enum_members!
+        self.enum_members = (enum_members || []).map do |member|
+          # expected in the form "name:value" or "name"
+          parts = member.split(':')
+          OpenStruct.new(
+            :name => parts.first.titleize,
+            :value => (parts.length > 1 ? parts.last : nil)
+          )
+        end
+      end
+
+      def locale_file_exists?
+        File.exists?(File.join(destination_root, 'config', 'locales', 'enums.en.yml'))
+      end
+    end
+  end
+end

data/lib/generators/riveter/enum/templates/enum.rb

@@ -0,0 +1,17 @@
+<% module_namespacing do -%>
+module <%= class_name %>Enum
+<% if enum_members.any? -%>
+<% enum_members.each_with_index do |member, index| -%>
+  <%= member.name %> = <%= member.value || ((index + 1) * 10) %>
+<% end -%>
+<% else -%>
+  # TODO: define constants for each member of the enumeration
+<% end -%>
+
+  # include the enumerated module
+  include Riveter::Enumerated
+
+  # NOTE: any constants defined here onwards will be ignored
+
+end
+<% end -%>

data/lib/generators/riveter/enum/templates/enums.en.yml

@@ -0,0 +1,35 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+
+  # translations for enums
+  enums:
+
+    # shared members can be defined here
+
+    #
+    # e.g. for the display name and members ExampleEnum::Member1 and ExampleEnum::Member2 as follows
+    #
+    example:
+      human: An Example Enumeration
+      member1: Member 1
+      member2: Member 2

data/lib/generators/riveter/enum/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

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

@@ -0,0 +1,14 @@
+module Riveter
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      # TODO
+
+      # insert require into the spec helper file
+      # auto_load paths for concerns
+      # copy locale files
+
+    end
+  end
+end

data/lib/generators/riveter/presenter/presenter_generator.rb

@@ -0,0 +1,20 @@
+module Riveter
+  module Generators
+    class PresenterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'Presenter'
+
+      def create_presenter_file
+        template 'presenter.rb', File.join('app/presenters', class_path, "#{file_name}_presenter.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/presenters', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      hook_for :test_framework, :as => :presenter
+    end
+  end
+end

data/lib/generators/riveter/presenter/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

data/lib/generators/riveter/presenter/templates/presenter.rb

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+class <%= class_name %>Presenter < Riveter::Presenter::Base
+
+  # TODO
+
+end
+<% end -%>

data/lib/generators/riveter/query/USAGE

@@ -0,0 +1,22 @@
+Description:
+  Stubs out a new query. Pass the model name, either CamelCased or
+  under_scored as the model to base the query on.
+  "Query" will be appended to the name of the query class.
+
+  This generator invokes your configured test framework which defaults to TestUnit
+
+  If you pass a namespaced model name (e.g. admin/account or Admin::Account)
+  then the generator will create a module (e.g. admin_account)
+
+Examples:
+  `rails generate riveter:query portfolio`
+
+    Creates a query class based off of the Portfolio model
+
+      Query: app/queries/portfolio_query.rb
+
+  `rails generate riveter:query admin/account`
+
+    Creates a query class based off of the Admin::Account model
+
+      Query: app/queries/admin/account_query.rb

data/lib/generators/riveter/query/query_generator.rb

@@ -0,0 +1,20 @@
+module Riveter
+  module Generators
+    class QueryGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'Query'
+
+      def create_query_file
+        template 'query.rb', File.join('app/queries', class_path, "#{file_name}_query.rb")
+      end
+
+      def create_module_file
+        return if regular_class_path.empty?
+        template 'module.rb', File.join('app/queries', "#{class_path.join('/')}.rb") if behavior == :invoke
+      end
+
+      hook_for :test_framework, :as => :query
+    end
+  end
+end

data/lib/generators/riveter/query/templates/module.rb

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+module <%= class_path.map(&:camelize).join('::') %>
+end
+<% end -%>

data/lib/generators/riveter/query/templates/query.rb

@@ -0,0 +1,31 @@
+<% module_namespacing do -%>
+class <%= class_name %>Query < Riveter::Query::Base
+
+  # TODO: optionally provide methods here for additional
+  # results such as summaries, aggregated data or other
+  # associated data
+
+protected
+
+  def build_relation(filter)
+    # start with a relation
+    relation = <%= class_name %>.all
+
+    #
+    # TODO: apply conditions etc to the query using the filter
+    #
+    # E.g.
+    #
+    # :.name filter
+    #
+    # relation = relation.where?(filter.name_like.present?, 'name LIKE ?', filter.name_like)
+    #
+    # :. page filter
+    # relation.page(filter.page)
+    #
+
+    relation
+  end
+
+end
+<% end -%>