motr-cargo 0.0.1 → 0.0.2

data/Rakefile

@@ -6,8 +6,6 @@ rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
 
-require 'bundler'
-Bundler.setup
 Bundler::GemHelper.install_tasks
 
 
@@ -23,7 +21,7 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-task :default => :test
+#task :default => :test
 
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'

data/app/controllers/motr/cargo_contexts_controller.rb

@@ -0,0 +1,12 @@
+class Motr::CargoContextsController < ApplicationController
+  
+  include Motr::Cargo::Delivery::Helpers
+  
+  before_filter :authenticate_for_cargo!
+  respond_to :js, :json
+  
+  def index
+    
+  end
+  
+end

data/app/controllers/motr/cargo_controller.rb

@@ -0,0 +1,8 @@
+class Motr::CargoController < ApplicationController  
+  
+  def self.inherited(base)
+    super
+    base.send(:delivers_cargo)
+  end
+  
+end

data/lib/motr-cargo.rb

@@ -1,19 +1,20 @@
 require 'motr'
-require 'motr/modding'
+require 'motr/modding' 
+require 'motr/cargo/package'
+require 'motr/cargo/context'
+require 'motr/cargo/delivery'
 
 module Motr
   module Cargo
-    VERSION = '0.0.1'
-    
-    module Package
-      autoload :Mongoid, 'motr/cargo/package/mongoid'
-    end
-    
-    module Context
-      autoload :Mongoid, 'motr/cargo/context/mongoid'
-    end
+    VERSION = '0.0.2'
+  end
     
+  module Controller
+    autoload :CargoHelpers, 'motr/controller/cargo_helpers'
   end
 end
 
-Motr.add_mod(:cargo, :autoload => true)
+Motr.add_mod(:cargo, :autoload => true)
+Motr.apply_helpers(Motr::Controller::CargoHelpers)
+
+require 'motr/rails/cargo_routing'

data/lib/motr/cargo/context.rb

@@ -0,0 +1,72 @@
+module Motr
+  module Cargo
+    ##
+    # Defines base functionality for contexts
+    # When applied a package will accept_nested_attributes_for :context_name, and each context
+    # will ensure that, when created, it sets its position to the end of the context list.
+    # 
+    module Context
+      
+      autoload :Mongoid, 'motr/cargo/context/mongoid'
+      
+      extend ActiveSupport::Concern
+      
+      included do
+        class_attribute(:cargo_packages, :instance_writer => false) unless self.respond_to?(:cargo_packages)
+        self.cargo_packages ||= []
+        
+        mod_opts  = cargo_mod_options
+        cname     = self.name.to_s.pluralize.underscore
+        orm_const = self.motr_orm_type.to_s.classify
+        packs     = [mod_opts[:for]].flatten.compact
+        
+        create_mod_attribute!(:name, String)
+        create_mod_attribute!(:body, String)
+        create_mod_attribute!(:meta, Hash)
+        
+        raise   Motr::Errors::InvalidOptions.new("Missing :for option when defining a Motr::Cargo context") if packs.empty?
+        include Motr::Cargo::Context.const_get(orm_const)
+        
+        packs.each do |cargo|          
+          send :cargo_context_belongs_to, :"#{cargo}"           
+          cargo_class = cargo.to_s.classify.constantize
+          cargo_class.class_eval do            
+            
+            ## Ensure the package module has been initialized 
+            self.send(:modded_with, :cargo) unless self.motr_mods.include?(:cargo)
+            self.cargo_contexts << cname
+            
+            ## Packages shuold always accept nested contexts
+            send :accepts_nested_attributes_for, :"#{cname}", :allow_delete => true
+            send :cargo_context_has_many, :"#{cname}"
+            
+          end
+          
+        end
+        
+        self.cargo_packages |= packs        
+        before_create :ensure_context_position_value
+        
+      end
+      
+      ##
+      # Ensure new contexts are added to the end of the context list.
+      # 
+      def ensure_context_position_value
+        return true unless self.position.nil?
+        self.position = _parent.send(:"#{self.class.name.pluralize.underscore}").count + 1
+      end
+      
+      ##
+      # Defines a name to represent the context. When the name attribute is set, it is used, if not
+      # the class name is used.
+      # 
+      def context_name
+        (self.name.blank? ? self.class.name : self.name)
+      end
+      
+    end
+    
+  end
+end
+

data/lib/motr/cargo/context/mongoid.rb

@@ -1,33 +1,13 @@
 module Motr
   module Cargo::Context
-          
-    module Mongoid
+    # @private      
+    module Mongoid #:nodoc:
       extend ActiveSupport::Concern
   
-      included do
-        mod_opts = cargo_mod_options
-    
-        field :name, :type => String
-        field :body, :type => String
-        field :meta, :type => Hash
-    
-        cname = self.name.to_s.pluralize.underscore
-        packs = [mod_opts[:for]].flatten.compact
-        if packs.empty?
-          raise Motr::Errors::InvalidOptions.new("Missing :for option when defining a Motr::Cargo context")
-        end
-        # Define relationships on each cargo object
-        # 
-        packs.flatten.compact.each do |cargo|
-          send(:embedded_in, :"#{cargo.to_s}")
-          cargo.to_s.classify.constantize.class_eval do
-            send(:embeds_many, :"#{cname}")
-          end
-        end
-    
+      included do        
       end
   
-    end
+    end # end mod
 
   end
 end

data/lib/motr/cargo/delivery.rb

@@ -0,0 +1,28 @@
+module Motr
+  module Cargo
+    module Delivery
+      extend ActiveSupport::Concern
+      
+      autoload :Helpers,    'motr/cargo/delivery/helpers'    
+      autoload :Templating, 'motr/cargo/delivery/templating'
+      autoload :Actions,   'motr/cargo/delivery/actions'
+      
+      included do
+        include Motr::Cargo::Delivery::Templating
+        include Motr::Cargo::Delivery::Helpers
+        include Motr::Cargo::Delivery::Actions
+        before_filter :authenticate_for_cargo!, :except => [:index, :show]
+        respond_to :html if self.mimes_for_respond_to.empty?
+      end
+      
+      ##
+      # Actions for creating/updating/deleting content are more than likely protected.
+      # Overriding this method allows authentication checking to be performed.
+      # 
+      def authenticate_for_cargo!
+        true
+      end
+   
+    end
+  end
+end

data/lib/motr/cargo/delivery/actions.rb

@@ -0,0 +1,39 @@
+module Motr::Cargo
+  module Delivery
+    
+    module Actions
+    
+      def index
+        resource = scope_class.all
+        set_instance_var(resource)
+        respond_with(get_instance_var)
+      end
+      
+      def show
+        
+      end
+      
+      def new
+        
+      end
+      
+      def create
+        
+      end
+      
+      def edit
+        
+      end
+      
+      def update
+        
+      end
+      
+      def destroy
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/cargo/delivery/helpers.rb

@@ -0,0 +1,57 @@
+module Motr::Cargo
+  module Delivery
+    # @private
+    module Helpers #:nodoc:
+      extend ActiveSupport::Concern
+      
+      included do
+        helper_method :cargo_context_path, :cargo_contexts_path, :cargo_context_url, :cargo_contexts_url,
+                      :edit_cargo_context_path, :edit_cargo_context_url, :scope_name, :scope_class
+      end
+    
+      def cargo_context_path(pack, context, options = {})
+        motr_cargo_context_path(pack.class.name.to_s, pack.id, context.id, options)
+      end
+      
+      def cargo_context_url(pack, context, options = {})
+        motr_cargo_context_url(pack.class.name.to_s, pack.id, context.id, options)
+      end
+      
+      def cargo_contexts_path(pack, options = {})
+        motr_cargo_contexts_path(pack.scope_type, pack.id, options)
+      end
+      
+      def cargo_contexts_url(pack, options = {})
+        motr_cargo_contexts_url(pack.scope_type, pack.id, options)
+      end
+      
+      def edit_cargo_context_path(pack, context, options = {})
+        edit_motr_cargo_context_path(pack.class.name.to_s, pack.id, context.id, options)
+      end
+
+      def edit_cargo_context_url(pack, context, options = {})
+        edit_motr_cargo_context_url(pack.class.name.to_s, pack.id, context.id, options)
+      end
+      
+      def scope_name
+        (action_name.to_s === 'index' ? scope_class.to_s.pluralize : scope_class.to_s).underscore
+      end
+      
+      def scope_class
+        (params[:scope_name] || self.class.to_s.split("::").first.gsub(/controller/i, '').singularize).constantize
+      end
+      
+      private
+      
+      def get_instance_var
+        instance_variable_get("@#{scope_name}")
+      end
+      
+      def set_instance_var(obj)
+        instance_variable_set("@#{scope_name}", obj)
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/cargo/delivery/templating.rb

@@ -0,0 +1,6 @@
+module Motr::Cargo
+  module Delivery
+    module Templating
+    end
+  end
+end

data/lib/motr/cargo/package.rb

@@ -0,0 +1,37 @@
+module Motr
+  module Cargo
+    
+    module Package
+      
+      autoload :Mongoid, 'motr/cargo/package/mongoid'
+      
+      extend ActiveSupport::Concern
+      
+      included do
+        class_attribute(:cargo_contexts, :instance_writer => false) unless self.respond_to?(:cargo_contexts)
+        self.cargo_contexts ||= []
+        orm_const = self.motr_orm_type.to_s.classify 
+        send(:include, Motr::Cargo::Package.const_get(orm_const))
+        create_mod_attribute!(:title, String)
+        create_mod_attribute!(:post_date, Date)
+        create_mod_attribute!(:published, Boolean)      
+        attr_accessor :cargo
+      end
+      
+      ##
+      # The cargo method handles "rendering" the particular package. 
+      # This data should be defined in the cargo "show" action.
+      # 
+      def cargo=(cargo_data)
+        @cargo
+      end
+      
+      def cargo
+        @cargo
+      end
+      
+    end
+    
+  end
+end
+

data/lib/motr/cargo/package/mongoid.rb

@@ -1,15 +1,12 @@
 module Motr
   module Cargo::Package
-      
-    module Mongoid
+    # @private  
+    module Mongoid #:nodoc:
       extend ActiveSupport::Concern
   
       included do
-        field :title,     :type => String
-        field :post_date, :type => Time
-        field :published, :type => Boolean  
-        field :uid,       :type => Integer
-
+        include ::Mongoid::MultiParameterAttributes
+        field :uid, :type => Integer        
         before_save :generate_cargo_uid
       end
   

data/lib/motr/controller/cargo_helpers.rb

@@ -0,0 +1,45 @@
+module Motr
+  module Controller
+    
+    module CargoHelpers
+      extend ActiveSupport::Concern
+      
+      included do
+        class_attribute :motr_cargo_classes, :instance_writer => false
+        self.motr_cargo_classes ||= []
+      end
+      
+      module ClassMethods
+        ##
+        # Configures models a particular controller "delivers".
+        # By default cargo considers the controller name to be the resource name 
+        # that it is to serve. Calling delivers_cargo_for allows the controller to 
+        # find objects based on object_id parameters.
+        # 
+        # @param [Symbol,Array] *resources The resources/models this controller delivers
+        # 
+        # @example Configure a Posts controller to deliver resources for Blog and Article
+        #   class PostsController < Motr::CargosController
+        #     delivers_cargo_for :blog, :article
+        #   end
+        # 
+        def delivers_cargo_for(*resources)
+          options = resources.extract_options!
+          self.motr_cargo_classes |= resources          
+        end
+        
+        ##
+        # Normally you would have your controllers extend Motr::CargoController,
+        # in the event this isn't possible, calling delivers_cargo will ensure 
+        # the proper functionality exists.
+        # 
+        def delivers_cargo
+          include Motr::Cargo::Delivery
+        end
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/motr/mods/cargo.rb

@@ -38,13 +38,26 @@ module Motr
       
       options(:for, :as)
       
-      configure(:mongoid) do
+      configure do
         mod_opts = cargo_mod_options
-        unless mod_opts.key?(:as) && mod_opts[:as].to_s.match(/context/i)          
-          self.send(:include, Motr::Cargo::Package::Mongoid)
+        unless mod_opts.key?(:as) && mod_opts[:as].to_s.match(/context/i)
+          include Motr::Cargo::Package
         else
-          puts 'called context'
-          self.send(:include, Motr::Cargo::Context::Mongoid)
+          include Motr::Cargo::Context
+        end 
+      end
+      
+      configure(:mongoid) do
+        class << self
+          alias :cargo_context_belongs_to :embedded_in
+          alias :cargo_context_has_many :embeds_many
+        end
+      end
+      
+      configure(:active_record) do
+        class << self
+          alias :cargo_context_belongs_to :belongs_to
+          alias :cargo_context_has_many :has_many
         end
       end
       

data/lib/motr/rails/cargo_routing.rb

@@ -0,0 +1,33 @@
+module ActionDispatch::Routing
+  class Mapper
+    attr_accessor :cargo_context_routes_set
+    ##
+    # Calling deliver_cargo_for within routes sets up routing for each 
+    # cargo model. By default all passed models are routed with:
+    #   :controller => 'motr/cargo
+    #   :scope_name => 'ModelName'
+    # 
+    # Override these options when configuring if you would prefer a different controller/scope name
+    # 
+    def deliver_cargo_for(*models)
+      
+      options = models.extract_options!      
+      models.map!(&:to_sym).each do |mod|
+        sing   = ActiveSupport::Inflector.singularize(mod.to_s)
+        plural = ActiveSupport::Inflector.pluralize(mod.to_s)
+        resources *[plural, options.reverse_merge(:controller => 'motr/cargo', :scope_name => "#{sing.classify}")]
+      end
+      
+      unless @cargo_context_routes_set
+        scope :controller => 'motr/cargo_contexts' do
+          get 'motr/cargo/:scope_name/:scope_id/contexts', :action => :index, :as => :motr_cargo_contexts
+          get 'motr/cargo/:scope_name/:scope_id/contexts/:id/edit', :action => :edit, :as => :edit_motr_cargo_context
+          put 'motr/cargo/:scope_name/:scope_id/contexts/:id', :action => :update, :as => :motr_cargo_context
+          delete 'motr/cargo/:scope_name/:scope_id/contexts/:id', :action => :destroy, :as => :motr_cargo_context
+        end
+        @cargo_context_routes_set = true
+      end
+    end
+    
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: motr-cargo
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Brent Kirby
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 -04:00
+date: 2011-05-24 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -144,9 +144,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- app/controllers/motr/cargo_contexts_controller.rb
+- app/controllers/motr/cargo_controller.rb
 - lib/motr/cargo/context/mongoid.rb
+- lib/motr/cargo/context.rb
+- lib/motr/cargo/delivery/actions.rb
+- lib/motr/cargo/delivery/helpers.rb
+- lib/motr/cargo/delivery/templating.rb
+- lib/motr/cargo/delivery.rb
 - lib/motr/cargo/package/mongoid.rb
+- lib/motr/cargo/package.rb
+- lib/motr/controller/cargo_helpers.rb
 - lib/motr/mods/cargo.rb
+- lib/motr/rails/cargo_routing.rb
 - lib/motr-cargo.rb
 - MIT-LICENSE
 - Rakefile
@@ -166,7 +176,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1531469132394986629
+      hash: 2143364796700752731
       segments: 
       - 0
       version: "0"
@@ -175,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1531469132394986629
+      hash: 2143364796700752731
       segments: 
       - 0
       version: "0"