imperator-ext 0.2.0

data/imperator-ext.gemspec

@@ -0,0 +1,90 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "imperator-ext"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Kristian Mandrup"]
+  s.date = "2012-08-14"
+  s.description = "Factories, Macros, REST helpers and Mongoid integration"
+  s.email = "kmandrup@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "docs/Design.md",
+    "imperator-ext.gemspec",
+    "lib/imperator-ext.rb",
+    "lib/imperator/command-ext.rb",
+    "lib/imperator/command/class_factory.rb",
+    "lib/imperator/command/macros.rb",
+    "lib/imperator/command/method_factory.rb",
+    "lib/imperator/command/rest.rb",
+    "lib/imperator/command/rest_helper.rb",
+    "lib/imperator/factory.rb",
+    "lib/imperator/mongoid.rb",
+    "lib/imperator/mongoid/attribute_helper.rb",
+    "lib/imperator/mongoid/command.rb",
+    "lib/imperator/mongoid/command/rest.rb",
+    "spec/imperator-ext/command/class_factory_spec.rb",
+    "spec/imperator-ext/command/macros_spec.rb",
+    "spec/imperator-ext/command/method_factory_spec.rb",
+    "spec/imperator-ext/command/rest_helper_spec.rb",
+    "spec/imperator-ext/command/rest_spec.rb",
+    "spec/imperator-ext/mongoid/command_spec.rb",
+    "spec/imperator-ext/mongoid/rest_command_spec.rb",
+    "spec/imperator-ext/shared_ex/attribute_helper_ex.rb",
+    "spec/imperator-ext/shared_ex/command_ex.rb",
+    "spec/imperator-ext/shared_ex/rest_helper_ex.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/kristianmandrup/imperator-ext"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Various extensions for Imperator"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<virtus>, [">= 0"])
+      s.add_runtime_dependency(%q<imperator>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_development_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0.5"])
+    else
+      s.add_dependency(%q<virtus>, [">= 0"])
+      s.add_dependency(%q<imperator>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 2.8.0"])
+      s.add_dependency(%q<rdoc>, [">= 3.12"])
+      s.add_dependency(%q<bundler>, [">= 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+      s.add_dependency(%q<simplecov>, [">= 0.5"])
+    end
+  else
+    s.add_dependency(%q<virtus>, [">= 0"])
+    s.add_dependency(%q<imperator>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 2.8.0"])
+    s.add_dependency(%q<rdoc>, [">= 3.12"])
+    s.add_dependency(%q<bundler>, [">= 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    s.add_dependency(%q<simplecov>, [">= 0.5"])
+  end
+end
+

data/lib/imperator/command/class_factory.rb

@@ -0,0 +1,121 @@
+require 'imperator/command/rest_helper'
+require 'imperator/command/rest'
+
+class Imperator::Command
+  # http://johnragan.wordpress.com/2010/02/18/ruby-metaprogramming-dynamically-defining-classes-and-methods/
+  class ClassFactory
+    class << self
+      def use &block
+        yield self
+      end
+
+      def default_parent clazz
+        @default_parent ||= clazz
+      end
+
+      def get_default_parent
+        @default_parent ||= ::Imperator::Command
+      end
+
+      # Usage:
+      # Imperator::Command::ClassFactory.create :update, Post, parent: Imperator::Mongoid::Command do
+      #   ..
+      # end
+      def build_command action, model, options = {}, &block
+        clazz_name = "#{action.to_s.camelize}#{model.to_s.camelize}Command"
+        parent = options[:parent] || get_default_parent
+        clazz = parent ? Class.new(parent) : Class.new
+        Object.const_set clazz_name, clazz
+        clazz = self.const_get(clazz_name)
+        if options[:auto_attributes]
+          clazz.instance_eval do
+            if respond_to? :attributes_for
+              attributes_for(model, :except => options[:except], :only => options[:only]) 
+            end
+          end
+        end
+        if block_given?
+          clazz.instance_eval &block      
+        end
+        clazz
+      end
+
+      # Usage:
+      # Imperator::Command::ClassFactory.create_rest :all, Post, parent: Imperator::Mongoid::Command do
+      #   ..
+      # end
+      def rest_command action, model, options = {}, &block
+        options.reverse_merge! default_options
+        options[:parent] ||= get_default_rest_class(model)
+        rest_commands_for(model, options, &block) and return if action.to_sym == :all
+        if rest_actions.include? action.to_sym        
+          action_name = "#{action}_command_for"
+          send action_name, model, options, &block
+        else
+          raise ArgumentError, "Not a supported REST action. Must be one of #{rest_actions}, was #{action}"
+        end
+      end
+
+      attr_writer :default_rest_class
+
+      def get_default_rest_class model
+        model.ancestors.include?(Mongoid::Document) ? default_mongoid_rest_class : default_rest_class
+      end
+
+      def default_rest_class
+        @default_rest_class ||= Imperator::Command::Rest
+      end
+
+      def default_mongoid_rest_class
+        @default_mongoid_rest_class ||= Imperator::Mongoid::Command::Rest
+      end
+
+      def reset_rest_class
+        @default_rest_class = Imperator::Command::Rest
+      end
+
+      attr_writer :default_options
+
+      def default_options
+        @default_options ||= {}
+      end
+
+
+      protected
+
+      def rest_actions
+        [:create, :update, :delete]
+      end
+
+      def create_command_for model, options = {}, &block
+        options[:parent] ||= default_rest_class
+        c = build_command :create, model, options do
+          create_action
+        end
+        c.class_eval &block if block_given?
+      end
+
+      def update_command_for model, options = {}, &block
+        options[:parent] ||= default_rest_class
+        c = build_command :update, model, options do          
+          update_action          
+        end
+        c.class_eval &block if block_given?
+      end
+
+      def delete_command_for model, options = {}, &block
+        options[:parent] ||= default_rest_class
+        c = build_command :delete, model, options do          
+          delete_action
+        end
+        c.class_eval &block if block_given?
+      end
+
+      def rest_commands_for model, options = {}, &block
+        rest_actions.each do |action| 
+          send "#{action}_command_for", model, options, &block
+        end
+      end
+    end
+  end
+end

data/lib/imperator/command/macros.rb

@@ -0,0 +1,13 @@
+# Global macro methods
+
+def imperator_class_factory
+  Imperator::Command::ClassFactory
+end
+
+def build_command action, model, options = {}, &block
+  imperator_class_factory.build_command action, model, options = {}, &block
+end
+
+def build_rest_command action, model, options = {}, &block
+  imperator_class_factory.rest_command action, model, options = {}, &block
+end

data/lib/imperator/command/method_factory.rb

@@ -0,0 +1,17 @@
+class Imperator::Command
+  module MethodFactory
+    def command_method command, options = {}
+      namespace = (options[:ns] || '').to_s
+      namespace.sub! /Controller$/, ''
+      define_method "#{command}_command" do
+        instance_var = "@#{command}_command"
+        unless instance_variable_get(instance_var)
+          clazz = [namespace, "#{command.to_s.camelize}Command"].join('::').constantize
+          instance_variable_set instance_var, clazz.new(options.merge initiator: self)
+        end
+      end
+    end
+
+    extend self
+  end
+end

data/lib/imperator/command/rest.rb

@@ -0,0 +1,7 @@
+require 'imperator/command/rest_helper'
+
+class Imperator::Command
+  class Rest < Imperator::Command
+    include Imperator::Command::RestHelper
+  end
+end

data/lib/imperator/command/rest_helper.rb

@@ -0,0 +1,78 @@
+class Imperator::ResourceNotFoundError < StandardError; end
+
+class Imperator::Command
+  module RestHelper
+    extend ActiveSupport::Concern
+
+    included do
+      attr_writer :object_class
+    end      
+
+    module ClassMethods
+      def create_action &block
+        action do    
+          object_class.create attribute_set if object_class
+          instance_eval &block if block_given?
+        end    
+      end
+
+      def update_action &block
+        action do
+          begin  
+            find_object.update_attributes attribute_set if find_object
+            instance_eval &block if block_given?
+          rescue Imperator::ResourceNotFoundError => e
+            on_error e
+          end
+        end    
+      end
+
+      def delete_action &block
+        action do    
+          find_object.delete
+          instance_eval &block if block_given?
+        end    
+      end
+
+      def on_error &block
+        define_method(:on_error, &block)
+      end
+
+      def for_class clazz
+        @object_class = clazz
+      end
+
+      def object_class
+        @object_class ||= filtered_class_name
+      end
+
+      protected
+
+      # convert to underscore format, fx UpdatePostCommand becomes update_post_command
+      # remove 'create', 'update' or 'delete' in the front of name: _post_command
+      # then remove command at the back: _post_
+      # then remove any '_': post
+      def filtered_class_name
+        self.class.name.underscore.sub(/^(create|update|delete)/, '').sub(/command$/, '').sub(/_/, '')
+      end
+    end
+
+    def object_class
+      self.class.object_class
+    end
+
+    def on_error exception
+      raise Imperator::InvalidCommandError, "The Command #{self} caused an error: #{exception}"
+    end
+
+    def find_object
+      object ||= object_class.find(self.id)
+    rescue
+      find_object_error
+    end
+
+    def find_object_error
+      raise Imperator::ResourceNotFoundError, "The resource #{self.id} could not be found" 
+    end
+  end
+end

data/lib/imperator/command-ext.rb

@@ -0,0 +1,14 @@
+class Imperator::Command
+  # the main object this command works on
+  attribute :object, Object
+
+  # object that initiated the command. 
+  # Can be used for method delegation etc
+  attribute :initiator, Object 
+
+  def to_s
+    str = "Command: #{id}"
+    str << " - #{object}" if object
+    str
+  end
+end  

data/lib/imperator/factory.rb

@@ -0,0 +1,3 @@
+require 'imperator/command/class_factory'
+require 'imperator/command/method_factory'
+

data/lib/imperator/mongoid/attribute_helper.rb

@@ -0,0 +1,29 @@
+module Imperator
+  module Mongoid
+    module AttributeHelper
+      extend ActiveSupport::Concern
+
+      module ClassMethods        
+        def attributes_for clazz, options = {}
+          use_attributes = clazz.attribute_names
+
+          unless options[:except].blank?
+            use_attributes = use_attributes - [options[:except]].flatten.map(&:to_s)
+          end
+          unless options[:only].blank?
+            use_attributes = use_attributes & [options[:only]].flatten.map(&:to_s) # intersection
+          end
+
+          clazz.fields.each do |key, field|
+            name = key
+            type = field.type
+            # skip if this field is excluded for use in command
+            next unless use_attributes.include? name.to_s
+            
+            attribute field.name, field.type, :default => field.default_val
+          end
+        end
+      end
+    end
+  end
+end

data/lib/imperator/mongoid/command/rest.rb

@@ -0,0 +1,9 @@
+require 'imperator/mongoid/command'
+
+module Imperator::Mongoid
+  class Command < Imperator::Command
+    class Rest < Command
+      include Imperator::Command::RestHelper
+    end
+  end
+end

data/lib/imperator/mongoid/command.rb

@@ -0,0 +1,21 @@
+require 'imperator/mongoid/attribute_helper'
+
+# Usage
+
+# class UpdatePostCommand < Imperator::Mongoid::Command
+#   attributes_for Post, except: [:state]
+#   attributes :title, :author
+
+#   validates_presence_of :object
+
+#   action do
+#     object = SomeObject.find(id)
+#     object.authored_by(author)
+#   end
+# end
+
+module Imperator::Mongoid
+  class Command < Imperator::Command
+    include Imperator::Mongoid::AttributeHelper
+  end
+end

data/lib/imperator/mongoid.rb

@@ -0,0 +1,6 @@
+module Imperator
+  module Mongoid
+  end
+end
+
+require 'imperator/mongoid/command/rest'

data/lib/imperator-ext.rb

@@ -0,0 +1,5 @@
+require 'imperator'
+require 'imperator/factory'
+require 'imperator/command-ext'
+
+require 'imperator/mongoid' if defined?(Mongoid)

data/spec/imperator-ext/command/class_factory_spec.rb

@@ -0,0 +1,186 @@
+require 'spec_helper'
+
+class UpdateRestCommand < Imperator::Command::Rest
+end
+class CreateRestCommand < Imperator::Command::Rest
+end
+class DeleteRestCommand < Imperator::Command::Rest
+end
+
+class Post
+end
+
+class Article
+end
+
+class Account
+end
+
+class User
+end
+
+class Foo
+end
+
+class Payment
+end
+
+describe Imperator::Command::ClassFactory do
+  subject { Imperator::Command::ClassFactory }
+
+  describe '.rest_command' do
+    context 'update' do
+      before :all do
+        subject.default_rest_class = Imperator::Command::Rest
+        subject.rest_command :update, Article, :parent => UpdateRestCommand, :auto_attributes => true do
+          def hello
+            "hello"
+          end
+        end
+      end
+
+      context 'UpdateArticleCommand created' do
+        let(:command) { UpdateArticleCommand.new }
+
+        specify { UpdateArticleCommand.superclass.should == UpdateRestCommand }
+        specify { command.hello.should == "hello" }
+      end
+    end 
+
+    context 'create' do
+      before :all do
+        subject.default_rest_class = Imperator::Command::Rest
+        subject.rest_command :create, Article, :parent => CreateRestCommand, :auto_attributes => true do
+          def hello
+            "hello"
+          end
+        end
+      end
+
+      context 'CreateArticleCommand created' do
+        let(:command) { CreateArticleCommand.new }
+
+        specify { CreateArticleCommand.superclass.should == CreateRestCommand }
+        specify { command.hello.should == "hello" }
+      end
+    end 
+
+    context 'delete' do
+      before :all do
+        subject.default_rest_class = Imperator::Command::Rest
+        subject.rest_command :delete, Article, :parent => DeleteRestCommand, :auto_attributes => true do
+          def hello
+            "hello"
+          end
+        end
+      end
+
+      context 'DeleteArticleCommand created' do
+        let(:command) { DeleteArticleCommand.new }
+
+        specify { DeleteArticleCommand.superclass.should == DeleteRestCommand }
+        specify { command.hello.should == "hello" }
+      end
+    end 
+  end
+end
+
+describe Imperator::Command::ClassFactory do
+
+  subject { Imperator::Command::ClassFactory }
+
+  describe '.build_command' do
+    before :all do
+      subject.build_command :show, Post
+    end    
+
+    its(:get_default_parent) { should == Imperator::Command }
+    specify { ShowPostCommand.superclass.should == Imperator::Command }
+  end
+
+  describe '.rest_command' do
+    before :all do
+      subject.rest_command :update, Payment
+    end
+
+    specify { UpdatePaymentCommand.superclass.should == Imperator::Command::Rest }
+
+    describe ':all' do
+      before :all do
+        subject.rest_command :all, Foo
+      end
+
+      specify { CreateFooCommand.superclass.should == Imperator::Command::Rest }
+      specify { UpdateFooCommand.superclass.should == Imperator::Command::Rest }
+      specify { DeleteFooCommand.superclass.should == Imperator::Command::Rest }
+    end
+  end
+
+  describe '.default_rest_class' do
+    describe 'default class' do
+      its(:default_rest_class) { should == Imperator::Command::Rest }
+    end
+
+    describe 'set default_rest_class to UpdateRestCommand' do
+      before :all do
+        subject.default_rest_class = UpdateRestCommand
+      end
+
+      its(:default_rest_class) { should == UpdateRestCommand }     
+    end
+  end
+
+  describe '.default_options' do
+    before do
+      subject.default_options = {hi: 'hello' }
+    end
+
+    its(:default_options) { should == {hi: 'hello' } }
+  end
+end
+
+describe 'private methods' do
+  describe Imperator::Command::ClassFactory do
+    subject { Imperator::Command::ClassFactory }
+
+    describe 'rest command builders' do
+      describe '.create_command_for' do
+        before do
+          subject.reset_rest_class
+          subject.send :create_command_for, Post
+        end
+
+        specify { CreatePostCommand.superclass.should == Imperator::Command::Rest }
+      end      
+
+      describe '.update_command_for' do
+        before do
+          subject.default_rest_class = UpdateRestCommand
+          subject.send :update_command_for, Account
+        end
+
+        specify { UpdateAccountCommand.superclass.should == UpdateRestCommand }
+      end      
+
+      describe '.delete_command_for' do
+        before do
+          subject.reset_rest_class
+          subject.send :delete_command_for, Account
+        end
+
+        specify { DeleteAccountCommand.superclass.should == Imperator::Command::Rest }
+      end      
+
+      describe '.rest_commands_for' do
+        before :all do
+          subject.send :rest_commands_for, User
+        end
+
+        specify { CreateUserCommand.superclass.should == Imperator::Command::Rest }
+        specify { UpdateUserCommand.superclass.should == Imperator::Command::Rest }
+        specify { DeleteUserCommand.superclass.should == Imperator::Command::Rest }
+      end      
+    end
+  end
+end
+

data/spec/imperator-ext/command/macros_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'imperator/command/macros'
+
+class Message
+end
+
+
+describe 'Imperator command macros' do  
+  describe '.imperator_class_factory' do
+    specify { imperator_class_factory.should == Imperator::Command::ClassFactory }
+  end
+
+  describe '.build_command' do
+    before do
+      build_command :update, Message 
+    end
+
+    specify do
+      UpdateMessageCommand.superclass.should == Imperator::Command
+    end
+  end
+
+  describe '.build_rest_command' do
+    before do
+      build_rest_command :delete, Message
+    end
+
+    specify do
+      DeleteMessageCommand.superclass.should == Imperator::Command::Rest
+    end
+  end
+end