riveter 0.0.1

data/lib/generators/riveter/query_filter/query_filter_generator.rb

@@ -0,0 +1,52 @@
+module Riveter
+  module Generators
+    class QueryFilterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'QueryFilter'
+
+      argument :filter_attributes,
+               :type => :array,
+               :default => [],
+               :banner => "[attribute[:type[:required]] attribute[:type[:required]]]"
+
+      def initialize(args, *options)
+        super
+        parse_filter_attributes!
+      end
+
+      def create_query_filter_file
+        template 'query_filter.rb', File.join('app/query_filters', class_path, "#{file_name}_query_filter.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 'query_filters.en.yml', File.join('config/locales', 'query_filters.en.yml') unless locale_file_exists?
+      end
+
+      hook_for :test_framework, :as => :query_filter
+
+    protected
+
+      def parse_filter_attributes!
+        self.filter_attributes = (filter_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', 'query_filters.en.yml'))
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,40 @@
+<% module_namespacing do -%>
+class <%= class_name %>QueryFilter < Riveter::QueryFilter::Base
+<% if filter_attributes.any? %>
+<% filter_attributes.each do |attribute| -%>
+  attr_<%= attribute.type %> :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% else -%>
+
+  #
+  # define filter 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
+  #
+
+  # optionally, define additional validations
+<% end -%>
+
+end
+<% end -%>

data/lib/generators/riveter/query_filter/templates/query_filters.en.yml

@@ -0,0 +1,49 @@
+# 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 query_filters
+  query_filters:
+
+    models:
+
+      #
+      # E.g. for ExampleQueryFilter as follows
+      #
+      example: Example Query Filter Name
+
+    attributes:
+
+      #
+      # E.g. for attributes of the ExampleQueryFilter as follows
+      #
+      example:
+        active_only: Active items only?

data/lib/generators/riveter/service/service_generator.rb

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

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

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

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

@@ -0,0 +1,12 @@
+<% module_namespacing do -%>
+class <%= class_name %>Service < Riveter::Service::Base
+
+  # associate this handler with the respective command
+  register_as_handler_for <%= class_name %>Command
+
+  def perform(command)
+    # TODO: provide implementation
+  end
+
+end
+<% end -%>

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

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

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

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

data/lib/generators/riveter/worker/worker_generator.rb

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

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

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class CommandGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_command_spec
+        template 'command_spec.rb', File.join('spec/commands', class_path, "#{file_name}_command_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/command/templates/command_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Command do
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

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

@@ -0,0 +1,21 @@
+module Rspec
+  module Generators
+    class CommandControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :new_action,
+               :type => :string,
+               :default => 'new',
+               :banner => 'new_action'
+
+      argument :create_action,
+               :type => :string,
+               :default => 'create',
+               :banner => 'create_action'
+
+      def create_command_controller_spec
+        template 'command_controller_spec.rb', File.join('spec/controllers', class_path, "#{file_name}_command_controller_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/command_controller/templates/command_controller_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>CommandController do
+  render_views
+
+  # This should return the minimal set of attributes required to create a valid
+  # <%= class_name %>Command. As you add validations to <%= class_name %>Command, be sure to
+  # adjust the attributes here as well.
+  let(:valid_attributes) { {} }
+
+  # This should return the minimal set of values that should be in the session
+  # in order to pass any filters (e.g. authentication) defined in
+  # <%= class_name %>CommandController. Be sure to keep this updated too.
+  let(:valid_session) { {} }
+
+  describe "GET '<%= new_action %>'" do
+    it "assigns the command" do
+      get :<%= new_action %>, {}, valid_session
+      assigns(:command).should eq(<%= class_name %>Command.new())
+    end
+
+    it "renders the '<%= new_action %>' template" do
+      get :<%= new_action %>, {}, valid_session
+      response.should render_template(:<%= new_action %>)
+    end
+  end
+
+  describe "POST '<%= create_action %>'" do
+    describe "with valid params" do
+      it "assigns the command" do
+        post :<%= create_action %>, {:<%= file_name %> => valid_attributes}, valid_session
+        assigns(:command).should eq(<%= class_name %>Command.new())
+      end
+
+      it "invokes the associated service object" do
+        post :<%= create_action %>, {:<%= file_name %> => valid_attributes}, valid_session
+
+        pending
+      end
+
+      it "invokes the on_success callback" do
+        post :<%= create_action %>, {:<%= file_name %> => valid_attributes}, valid_session
+        pending
+      end
+
+      # TODO: complete specification for on success logic
+      it "on_success (redirects to ...)" do
+        post :<%= create_action %>, {:<%= file_name %> => valid_attributes}, valid_session
+        # response.should redirect_to(...)
+        pending
+      end
+    end
+
+    describe "with invalid params" do
+      it "assigns the command" do
+        allow_any_instance_of(<%= class_name %>Command).to receive(:valid?) { false }
+        post :<%= create_action %>, {:<%= file_name %> => {}}, valid_session
+        assigns(:command).should eq(<%= class_name %>Command.new())
+      end
+
+      it "re-renders the 'new' template" do
+        allow_any_instance_of(<%= class_name %>Command).to receive(:valid?) { false }
+        post :<%= create_action %>, {:<%= file_name %> => {}}, valid_session
+        response.should render_template(:<%= new_action %>)
+      end
+    end
+  end
+
+end

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

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class EnquiryGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_enquiry_spec
+        template 'enquiry_spec.rb', File.join('spec/enquiries', class_path, "#{file_name}_enquiry_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/enquiry/templates/enquiry_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Enquiry do
+
+  before do
+    # TODO: setup data required to exercise the enquiry
+  end
+
+  # This should return the minimal set of attributes required to create a valid <%= class_name %>QueryFilter.
+  let(:valid_query_filter_attributes) { {} }
+
+  #
+  # NOTE: If this spec fails, then all the following ones will fail too!!!
+  #
+  it "is configured correctly" do
+    expect {
+      <%= class_name %>Enquiry.new()
+    }.to_not raise_error
+  end
+
+  describe "#submit" do
+    it "succeeds with valid attributes" do
+      subject.submit(valid_query_filter_attributes).should be_true
+    end
+
+    it "fails with invalid attributes" do
+      allow(subject).to receive(:create_query_filter) { Mock::InvalidQueryFilter.new() }
+      subject.submit().should be_false
+    end
+  end
+
+  describe "#has_data?" do
+    it "succeeds with valid attributes" do
+      subject.submit(valid_query_filter_attributes)
+      subject.has_data?.should be_true
+    end
+
+    it "fails with invalid attributes" do
+      allow(subject).to receive(:create_query_filter) { Mock::InvalidQueryFilter.new() }
+      subject.submit()
+      subject.has_data?.should be_false
+    end
+  end
+
+  describe "#query_results" do
+    it "succeeds with valid attributes" do
+      subject.submit(valid_query_filter_attributes)
+      subject.query_results.should_not be_nil
+    end
+
+    it "can be iterated" do
+      block = Mock::Block.new()
+      expect(block).to receive(:call).any_number_of_times
+
+      subject.submit(valid_query_filter_attributes)
+      subject.query_results.each &block
+    end
+
+    it "fails with invalid attributes" do
+      allow(subject).to receive(:create_query_filter) { Mock::InvalidQueryFilter.new() }
+      subject.submit()
+      subject.query_results.should be_nil
+    end
+  end
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

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

@@ -0,0 +1,16 @@
+module Rspec
+  module Generators
+    class EnquiryControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      argument :action_name,
+               :type => :string,
+               :default => 'index',
+               :banner => 'action_name'
+
+      def create_enquiry_controller_spec
+        template 'enquiry_controller_spec.rb', File.join('spec/controllers', class_path, "#{file_name}_enquiry_controller_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/enquiry_controller/templates/enquiry_controller_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>EnquiryController do
+  render_views
+
+  # This should return the minimal set of attributes required to create a valid <%= class_name %>QueryFilter.
+  let(:valid_query_filter_attributes) { {} }
+
+  # This should return the minimal set of values that should be in the session
+  # in order to pass any filters (e.g. authentication) defined in
+  # <%= class_name %>EnquiryController. Be sure to keep this updated.
+  let(:valid_session) { {} }
+
+  describe "GET '<%= action_name %>'" do
+    it "assigns the enquiry" do
+      get :<%= action_name %>, {}, valid_session
+      assigns(:enquiry).should eq(<%= class_name %>Enquiry.new())
+    end
+
+
+
+  end
+
+  describe "POST '<%= action_name %>'" do
+
+
+  end
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

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

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class EnumGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_enum_spec
+        template 'enum_spec.rb', File.join('spec/enums', class_path, "#{file_name}_enum_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/enum/templates/enum_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Enum do
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

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

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class PresenterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_presenter_spec
+        template 'presenter_spec.rb', File.join('spec/presenters', class_path, "#{file_name}_presenter_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/presenter/templates/presenter_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Presenter do
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

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

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class QueryGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_query_spec
+        template 'query_spec.rb', File.join('spec/queries', class_path, "#{file_name}_query_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/query/templates/query_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Query do
+
+  context "with data" do
+    before do
+      # TODO: create fixture data
+      FactoryGirl.create_list :<%= class_name.underscore %>, 10
+    end
+
+    let(:filter) { OpenStruct.new() }
+    subject { <%= class_name %>Query.new(filter) }
+
+    it { subject.relation.should_not be_nil }
+    it { subject.has_data?.should be_true }
+    it {
+      block = Mock::Block.new
+      expect(block).to receive(:call).at_least(:once)
+      subject.find_each &block
+    }
+
+  end
+
+  context "without data" do
+    let(:filter) { OpenStruct.new() }
+    subject { <%= class_name %>Query.new(filter) }
+
+    it { subject.relation.should_not be_nil }
+    it { subject.has_data?.should be_false }
+    it {
+      block = Mock::Block.new
+      expect(block).to_not receive(:call)
+      subject.find_each &block
+    }
+
+  end
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

data/lib/generators/rspec/query_filter/query_filter_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class QueryFilterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_query_filter_spec
+        template 'query_filter_spec.rb', File.join('spec/query_filters', class_path, "#{file_name}_query_filter_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/query_filter/templates/query_filter_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>QueryFilter do
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

data/lib/generators/rspec/service/service_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class ServiceGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_service_spec
+        template 'service_spec.rb', File.join('spec/services', class_path, "#{file_name}_service_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/service/templates/service_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Service do
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end

data/lib/generators/rspec/worker/templates/worker_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'riveter/spec_helper'
+
+describe <%= class_name %>Worker do
+
+  pending "add some examples to (or delete) #{__FILE__}"
+
+end