qm-acts-as-generic-controller 0.0.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+All portions Copyright (c) 2007 Tim Harper
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+=QUI: tabs
+
+Gem for rails to create nice tabs with a few lines o code.
+
+See: {http://qui.saepia.net}[http://qui.saepia.net] for details.
+
+Copyright (c) 2010 [Marcin Lewandowski], released under the MIT license.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "qm-acts-as-generic-controller"
+    gemspec.summary = "qM: generates generic controller actions and views"
+    gemspec.description = "qM: generates generic controller actions and views"
+    gemspec.email = "marcin@saepia.net"
+    gemspec.homepage = "http://q.saepia.net"
+    gemspec.authors = ["Marcin Lewandowski"]
+    gemspec.version = "0.0.4"
+    gemspec.files = Rake::FileList.new [ "MIT-LICENSE", "Rakefile", "lib/*", "app/views/generic_controller/*" ]
+    gemspec.add_dependency "qui-common-helpers", ">= 0.0.3"
+    gemspec.add_dependency "rfc822"
+    gemspec.add_dependency "sort_alphabetical"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end

data/app/views/generic_controller/_data.erb

@@ -0,0 +1,26 @@
+<%- if field.is_a? Hash -%>
+  <%- attribute_name = field.keys.first.to_sym -%>
+<%- else -%>
+  <%- attribute_name = field.to_sym -%>
+<%- end -%>
+
+<%- data = record.send attribute_name -%>
+    
+<%- if data.is_a?(ActiveRecord::Base) -%>
+  <%= link_to_object record.send(field) %>
+
+<%- elsif data.is_a?(Array) and data.first.is_a?(ActiveRecord::Base) -%>
+  <%= data.collect{ |x| link_to_object(x) }.sort_alphabetical.join(", ") %>
+
+<%- elsif field.is_a?(Hash) and field.values.first == :link_to_show -%>
+  <%= link_to_object record, data %>
+
+<%- elsif field.is_a?(Hash) and field.values.first == :enum -%>
+  <%= h record.enum_human_value attribute_name  %>
+
+<%- elsif data.is_a?(String) and data =~ RFC822::EMAIL_REGEXP_WHOLE -%>
+  <%= link_to data, "mailto:#{data}" %>
+  
+<%- else -%>
+  <%= h data %>
+<%- end -%>

data/app/views/generic_controller/form.erb

@@ -0,0 +1,56 @@
+<%- if defined?(section) -%>
+  <%- form_for_param = [ section, instance_variable_get("@#{@controller.class.to_s.demodulize.gsub("Controller", "").tableize.singularize}") ] -%>
+<%- else -%>
+  <%- form_for_param = instance_variable_get("@#{@controller.class.to_s.demodulize.gsub("Controller", "").tableize.singularize}") -%>
+<%- end -%>
+
+<%- klass = @controller.class.to_s.demodulize.gsub("Controller", "").singularize.constantize -%>
+<%- table_name = "#{@controller.class.to_s.demodulize.gsub("Controller", "").tableize.singularize}" -%>
+<%- form_for form_for_param do |f| -%>
+  <%- unless klass.generic_form_fieldsets -%>
+    <fieldset>
+  <%- end -%>
+    
+  <ol>
+  
+  <%- klass.generic_fields.each do |field| -%>
+    <%- if field.is_a? Hash -%>
+      <%- attribute_name = field.keys.first.to_sym -%>
+    <%- else -%>
+      <%- attribute_name = field.to_sym -%>
+    <%- end -%>
+
+    <li>
+      <%= f.label attribute_name %>
+      
+      <%- if field.is_a?(Hash) and field.values.first == :enum -%>
+        <%= f.select attribute_name, t("activerecord.enums.#{table_name}.#{attribute_name}").collect{|k,v| [v, k.to_s] }.sort{|x,y| x.last.to_i <=> y.last.to_i }, { :selected => params[table_name] ? params[table_name][attribute_name].to_s : f.object.send(attribute_name).to_s }  %>
+        
+      <%- elsif klass.generic_field_associations[attribute_name] -%>
+        <%- if klass.generic_field_associations[attribute_name][:kind] == :belongs_to -%>
+          <%= f.select attribute_name, options_from_collection_for_select(klass.generic_field_associations[attribute_name][:class_name].all, :id, :link_default_description, params[table_name] && params[table_name][attribute_name].to_i), {}, { :name => "#{table_name}[#{klass.generic_field_associations[attribute_name][:foreign_key]}]" } %>
+        <%- else -%>
+        
+        <%- end -%>
+        
+      <%- else -%>
+        <%= f.text_field attribute_name %>
+      <%- end -%>
+    </li>
+  <%- end -%>
+
+  </ol>
+
+  <%- unless klass.generic_form_fieldsets -%>
+    </fieldset>
+  <%- end -%>
+
+
+
+  <%- if defined?(nice_submit_tag) -%>
+    <%= nice_submit_tag f, :cancel => :index %>  
+  <%- else -%>
+    <%= f.submit %>
+  <%- end -%>
+<%- end -%>
+

data/app/views/generic_controller/index.erb

@@ -0,0 +1,30 @@
+<%- if defined?(QUI::Toolbar) -%>
+  <%- toolbar do |t| -%>
+    <%= t.create %>
+  <%- end -%>
+<%- end -%>
+
+<%- if defined?(QUI::IndexTable) -%>
+  <%- klass = @controller.class.to_s.demodulize.gsub("Controller", "").singularize.constantize -%>
+  <%- headers = klass.generic_fields.collect{|x| x.is_a?(Hash) ? ".#{x.keys.first}".to_sym : ".#{x}".to_sym} -%>
+  <%- has_edit = ActionController::Routing::Routes.routes.collect{|x| x if x.matches_controller_and_action?(@controller.class.to_s.gsub("Controller", "").tableize, "edit") }.compact.size > 0 %>
+  <%- has_destroy = ActionController::Routing::Routes.routes.collect{|x| x if x.matches_controller_and_action?(@controller.class.to_s.gsub("Controller", "").tableize, "destroy") }.compact.size > 0 %>
+
+  <%- headers << :oneicon if has_edit %>
+  <%- headers << :oneicon if has_destroy %>
+  
+  <%- index_table instance_variable_get("@#{@controller.class.to_s.demodulize.gsub("Controller", "").tableize}"), :headers => headers, :class_name => klass do |r| %>
+    <%- klass.generic_fields.each do |field| -%>
+      <%- if field.is_a? Hash -%>
+        <%- attribute_name = field.keys.first.to_sym -%>
+      <%- else -%>
+        <%- attribute_name = field.to_sym -%>
+      <%- end -%>
+
+      <td><%= render :partial => "generic_controller/data", :locals => { :record => r, :field => field } %></td>
+    <%- end -%>
+    
+    <td><%= link_to_edit r   if has_edit %></td>
+    <td><%= link_to_delete r if has_destroy %></td>
+  <%- end -%>
+<%- end -%>

data/app/views/generic_controller/show.erb

@@ -0,0 +1,16 @@
+<%- klass = @controller.class.to_s.demodulize.gsub("Controller", "").singularize.constantize -%>
+<%- table_name = "#{@controller.class.to_s.demodulize.gsub("Controller", "").tableize.singularize}" -%>
+<%- record = instance_variable_get("@#{@controller.class.to_s.demodulize.gsub("Controller", "").tableize.singularize}") -%>
+<dl>
+  <%- klass.generic_fields.each do |field| -%>
+    <%- if field.is_a? Hash -%>
+      <%- attribute_name = field.keys.first.to_sym -%>
+    <%- else -%>
+      <%- attribute_name = field.to_sym -%>
+    <%- end -%>
+
+    <dt><%= h klass.human_attribute_name attribute_name %></dt>
+
+    <dd><%= render :partial => "generic_controller/data", :locals => { :record => record, :field => field } %></dd>
+  <%- end -%>
+</dl>

data/lib/qm-acts-as-generic-controller-controller.rb

@@ -0,0 +1,135 @@
+module QM
+  module ActsAsGenericController
+    module ControllerIncludes
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_generic_controller
+          include InstanceMethods
+
+          class_eval <<-END
+          rescue_from ActionView::MissingTemplate do |exception|
+            case params[:action].to_sym
+              when :index
+                render :template => "generic_controller/index"
+              
+              when :new, :edit
+                render :template => "generic_controller/form"
+
+              when :show
+                render :template => "generic_controller/show"
+              
+            else
+              raise exception
+            end
+          end
+          END
+
+        end
+      end
+
+      module InstanceMethods
+        def index
+          instance_variable_set(plural_variable, model.all) unless instance_variable_defined?(plural_variable)
+          
+          respond_to do |format|
+            format.html
+            format.xml { render :xml => instance_variable_get(plural_variable) }
+          end
+        end
+
+        def show
+          instance_variable_set(singular_variable, model.find(params[:id])) unless instance_variable_defined?(singular_variable)
+
+          respond_to do |format|
+            format.html
+            format.xml { render :xml => instance_variable_get(singular_variable) }
+          end
+        end
+
+        def edit
+          instance_variable_set(singular_variable, model.find(params[:id])) unless instance_variable_defined?(singular_variable)
+        end
+        
+        def new
+          instance_variable_set singular_variable, model.new unless instance_variable_defined?(singular_variable)
+
+          respond_to do |format|
+            format.html
+            format.xml { render :xml => instance_variable_get(singular_variable) }
+          end
+        end
+
+        def create
+          instance_variable_set(singular_variable, model.new) unless instance_variable_defined?(singular_variable)
+          instance_variable_get(singular_variable).update_attributes params[singular_variable(true)]
+
+          respond_to do |format|
+            if instance_variable_get(singular_variable).save
+              flash[:notice] = :savedAsFlash
+              if defined?(:section)
+                format.html { redirect_to [ section, instance_variable_get(singular_variable) ] }
+                format.xml  { render :xml => instance_variable_get(singular_variable), :status => :created, :location => [ section, instance_variable_get(singular_variable) ] }
+              else
+                format.html { redirect_to instance_variable_get(singular_variable) }
+                format.xml  { render :xml => instance_variable_get(singular_variable), :status => :created, :location => instance_variable_get(singular_variable) }
+              end
+            else
+              format.html { render :template => "generic_controller/form" }
+              format.xml  { render :xml => instance_variable_get(singular_variable), :status => :unprocessable_entity }
+            end
+          end
+        end
+        
+        def update
+          instance_variable_set(singular_variable, model.find(params[:id])) unless instance_variable_defined?(singular_variable)
+          instance_variable_get(singular_variable).update_attributes params[singular_variable(true)]
+
+          respond_to do |format|
+            if instance_variable_get(singular_variable).save
+              flash[:notice] = :savedAsFlash
+              if defined?(:section)
+                format.html { redirect_to [ section, instance_variable_get(singular_variable) ] }
+                format.xml  { head :ok }
+              else
+                format.html { redirect_to instance_variable_get(singular_variable) }
+                format.xml  { head :ok }
+              end
+            else
+              format.html { render :template => "generic_controller/form" }
+              format.xml  { render :xml => instance_variable_get(singular_variable), :status => :unprocessable_entity }
+            end
+          end
+        end
+
+        def destroy
+          instance_variable_set(singular_variable, model.find(params[:id])) unless instance_variable_defined?(singular_variable)
+          instance_variable_get(singular_variable).destroy
+
+          flash[:notice] = :destroyedAsFlash
+
+          respond_to do |format|
+            format.html { redirect_to :action => "index" }
+            format.xml  { head :ok }
+          end
+        end
+        
+        protected
+          def model
+            self.class.to_s.demodulize.gsub("Controller", "").singularize.constantize          
+          end
+          
+          def plural_variable(local = false)
+            :"#{(local ? "" : "@")}#{self.class.to_s.demodulize.gsub("Controller", "").tableize}"
+          end
+          
+          def singular_variable(local = false)
+            :"#{(local ? "" : "@")}#{self.class.to_s.demodulize.gsub("Controller", "").tableize.singularize}"
+          end
+
+      end
+    end
+  end
+end

data/lib/qm-acts-as-generic-controller-model.rb

@@ -0,0 +1,56 @@
+module QM
+  module ActsAsGenericController
+    module ModelIncludes
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+
+      end
+
+      module ClassMethods
+        def generic_field_associations
+          @generic_field_associations  
+        end
+        
+        def has_many(association_id, options = {}, &extension)
+          @generic_field_associations ||= {}
+          @generic_field_associations[association_id.to_sym] = { :kind => :has_many, :class_name => ( options[:class_name] ? options[:class_name].constantize : association_id.to_s.classify.constantize ) }
+          
+          super association_id, options, &extension
+        end  
+
+        def has_and_belongs_to_many(association_id, options = {}, &extension)
+          @generic_field_associations ||= {}
+          @generic_field_associations[association_id.to_sym] = { :kind => :has_and_belongs_to_many, :class_name => ( options[:class_name] ? options[:class_name].constantize : association_id.to_s.classify.constantize ) }
+          
+          super association_id, options, &extension
+        end  
+
+        def belongs_to(association_id, options = {})
+          @generic_field_associations ||= {}
+          klass  = ( options[:class_name].constantize ? options[:class_name].constantize : association_id.to_s.classify.constantize )
+          @generic_field_associations[association_id.to_sym] = { :kind => :belongs_to, :class_name => klass, :foreign_key => options[:foreign_key] || klass.to_s.tableize }
+
+          super association_id, options  
+        end      
+      
+      
+      
+        def generic_fields
+          @generic_fields
+        end
+
+        def generic_form_fieldsets
+          @generic_form_fieldsets
+        end
+        
+        def has_generic_fields(*fields)
+          @generic_fields = fields.flatten
+        end
+
+        def has_generic_form_fieldsets(*fieldsets)
+          @generic_form_fieldsets = fieldsets.flatten
+        end
+      end
+    end
+  end
+end

data/lib/qm-acts-as-generic-controller.rb

@@ -0,0 +1,5 @@
+require 'qm-acts-as-generic-controller-controller.rb'
+require 'qm-acts-as-generic-controller-model.rb'
+
+ActiveRecord::Base.send :include, QM::ActsAsGenericController::ModelIncludes
+ActionController::Base.send :include, QM::ActsAsGenericController::ControllerIncludes

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: qm-acts-as-generic-controller
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 4
+  version: 0.0.4
+platform: ruby
+authors: 
+- Marcin Lewandowski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: qui-common-helpers
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 0
+        - 3
+        version: 0.0.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rfc822
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sort_alphabetical
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+description: "qM: generates generic controller actions and views"
+email: marcin@saepia.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- Rakefile
+- app/views/generic_controller/_data.erb
+- app/views/generic_controller/form.erb
+- app/views/generic_controller/index.erb
+- app/views/generic_controller/show.erb
+- lib/qm-acts-as-generic-controller-controller.rb
+- lib/qm-acts-as-generic-controller-model.rb
+- lib/qm-acts-as-generic-controller.rb
+- README.rdoc
+has_rdoc: true
+homepage: http://q.saepia.net
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "qM: generates generic controller actions and views"
+test_files: []
+