inherited_views 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Greg Bell (www.gregbell.ca)
+
+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,41 @@
+= Inherited Views
+
+NOTE: THIS IS UNDER HEAVY DEV AND IS NOT READY TO BE USED YET
+
+Inherited Views is a thin addition to the Inherited Resources project adding default html views which can be later customized on a per controller basis or globally for your rails app.
+
+== Dependencies
+
+* InheritedResources
+* Formtastic
+* WillPaginate
+
+== The Views
+
+Inherited Views gives you a default set of templates which you can override in your implementation, or modify to create application specific defaults.
+
+The following templates exist:
+
+  index.html.erb      Renders a paginate listing of the collection
+    _table.html.erb   Does the actual work of generating the table
+  show.html.erb       Shows the resource
+  new.html.erb        Renders the _form template for a new resource
+  edit.html.erb       Renders the _form template for a resource to edit
+  _form.html.erb      HTML for the actual form
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Greg Bell (www.gregbell.ca)
+
+See LICENSE for details.

data/lib/inherited_views/base.rb

@@ -0,0 +1,110 @@
+require 'inherited_resources'
+
+module InheritedViews
+  class Base < InheritedResources::Base
+    
+    
+    # Set the name of the folder of the default views to use
+    # within the view path.
+    # 
+    # For example, if I want to set the default views for my
+    # application to app/views/my_defaults/*.html.erb I would
+    # 
+    #   InheritedViews::Base.default_views = 'my_defaults'
+    # 
+    # You can also override for one specific controller from
+    # within it:
+    # 
+    #   class UsersController < InheritedViews::Base
+    #     self.default_views = "my_default_admin_views"
+    #   end
+    # 
+    # which would then use app/views/my_default_admin_views
+    # 
+    class_inheritable_accessor :default_views
+    self.default_views = 'inherited_views_default'
+    
+    # Add our default views to the base path
+    ActionController::Base.append_view_path File.expand_path('../default_views', __FILE__)
+    
+    include TableBuilder
+    
+    # 
+    #  Actions
+    # 
+    
+    def index
+      super do |format|
+        format.html { render_or_default 'index' }
+      end
+    end
+    
+    def new
+      super do |format|
+        format.html { render_or_default 'new' }
+      end
+    end
+    
+    def create
+      create! do |success, failure|
+        failure.html { render_or_default 'new' }
+      end
+    end
+    
+    def show
+      super do |format|
+        format.html { render_or_default 'show' }
+      end
+    end
+    
+    def edit
+      super do |format|
+        format.html { render_or_default 'edit' }
+      end
+    end
+    
+    def update
+      update! do |success, failure|
+        failure.html { render_or_default 'edit' }
+      end
+    end
+    
+    
+    protected
+    
+    # Overriding so that we have pagination by default
+    def collection
+      get_collection_ivar || set_collection_ivar(end_of_association_chain.paginate(:page => params[:page]))
+    end
+    
+
+    def show_view_columns
+      resource_class.columns.collect{|column| column.name.to_sym  }
+    end
+    helper_method :show_view_columns
+    
+    def resource_name
+      resource_class.human_name
+    end
+    helper_method :resource_name
+    
+    def resources_name
+      resource_name.pluralize
+    end
+    helper_method :resources_name
+    
+    private
+
+    # All the magic lives here :)
+    # 
+    # This method tries to render the view you pass it, otherwise it
+    # renders the view from the default view folder
+    # 
+    def render_or_default(name, args = {})
+      render name, args
+    rescue ActionView::MissingTemplate
+      render args.merge(:template => "#{self.class.default_views}/#{name}", :prefix => '')
+    end
+    
+  end
+end

data/lib/inherited_views/default_views/inherited_views_default/_form.html.erb

@@ -0,0 +1,4 @@
+<% semantic_form_for resource do |f| %>
+  <%= f.inputs %>
+  <%= f.buttons %>
+<% end %>

data/lib/inherited_views/default_views/inherited_views_default/_table.html.erb

@@ -0,0 +1,18 @@
+<table id="<%= resource_class.name.underscore.pluralize %>_index_table" class="index_table">
+  <tr>
+    <% index_table_columns.each do |column| %>
+      <th><%= column.to_s.titlecase %></th>
+    <% end %>
+  </tr>
+  <% collection.each do |resource| %>
+    <tr class="<%= cycle 'odd', 'even' %>">
+      <% index_table_columns.each do |column| %>
+        <td><%= resource.send(column.to_sym) %></td>
+      <% end %>
+      <td>
+        <%= link_to "Edit", edit_resource_path(resource) %> | 
+        <%= link_to "Delete", resource_path(resource), :method => :delete, :confirm => "Are you sure you want to delete this?" %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/lib/inherited_views/default_views/inherited_views_default/edit.html.erb

@@ -0,0 +1,2 @@
+<h2>Edit <%= resource_name %></h2>
+<%= render_partial_or_default 'form' %>

data/lib/inherited_views/default_views/inherited_views_default/index.html.erb

@@ -0,0 +1,5 @@
+<h2><%= resources_name %></h2>
+
+<%= render_partial_or_default 'table' %>
+
+<%= will_paginate collection %>

data/lib/inherited_views/default_views/inherited_views_default/new.html.erb

@@ -0,0 +1,2 @@
+<h2>Create <%= resource_name %></h2>
+<%= render_partial_or_default 'form' %>

data/lib/inherited_views/default_views/inherited_views_default/show.html.erb

@@ -0,0 +1,8 @@
+<h2><%= resource_name %> #<%= resource.id %></h2>
+
+<dl id="<%= resource_class.name.underscore.pluralize %>_resource_attributes" class="resource_attributes">
+  <% show_view_columns.each do |column| %>
+    <dt><%= column.to_s.titlecase %></dt>
+    <dd><%= resource.send(column) %></dd>
+  <% end %>
+</dl>

data/lib/inherited_views/helpers.rb

@@ -0,0 +1,24 @@
+module InheritedViews
+  module Helpers
+    
+    
+    # Tries to render the partial, if it doesn't exist, we will
+    # try to find the partial in the default views folder for this
+    # controller.
+    # 
+    # Example:
+    # 
+    # in app/views/users/index.html.erb
+    # <%= render_partial_or_default 'item', :collection => @items %>
+    # 
+    # First it will try to reder 'app/views/users/_item.html.erb'. If 
+    # this file doesn't exist, it will lookup _item.html.erb in the
+    # default views folder.    
+    def render_partial_or_default(name, options = {})
+      render options.merge(:partial => name)
+    rescue ActionView::MissingTemplate
+      render options.merge(:partial => "#{controller.class.default_views}/#{name}")
+    end
+    
+  end
+end

data/lib/inherited_views/table_builder.rb

@@ -0,0 +1,62 @@
+module InheritedViews
+  module TableBuilder
+    
+    def self.included(base)
+      base.extend ClassMethods
+      base.class_inheritable_accessor :table_config
+      base.table_config = {}
+      base.send :helper_method, :index_table_columns
+    end
+    
+    def table_config
+      self.class.table_config
+    end
+        
+    def index_table_columns
+      table_config[:columns] || self.class.default_table_columns
+    end
+    
+    module ClassMethods
+      
+      def default_table_columns
+        resource_class.content_columns.collect{|column| column.name.to_sym  }
+      end
+      
+      
+      # Sets the columns to be displayed when the index table is rendered
+      # for this resource.
+      # 
+      # Simple usage:
+      # 
+      # Pass in a list of the methods to call on your resource in the order
+      # you wish to see them in the table
+      # 
+      # class UsersController < InheritedViews::Base
+      #   table :first_name, :last_name
+      # end
+      # 
+      # 
+      # Except:
+      # 
+      # You can also use the default content columns from your ActiveRecord
+      # object and only exclude certain columns.
+      # 
+      # class UsersController < InheritedViews::Base
+      #   table :except => :first_name
+      # end
+      # 
+      def table(*columns)
+        options = columns.extract_options!        
+        
+        if options[:except]
+          options[:except] = options[:except].is_a?(Array) ? options[:except] : [options[:except]]
+          columns = default_table_columns
+          options[:except].each{|c| columns.delete(c) }
+        end
+        
+        self.table_config = options.merge(:columns => columns)
+      end
+      
+    end
+  end
+end

data/lib/inherited_views/version.rb

@@ -0,0 +1,3 @@
+module InheritedViews
+  VERSION = '0.0.1'
+end

data/lib/inherited_views.rb

@@ -0,0 +1,14 @@
+require 'formtastic'
+require 'will_paginate'
+
+module InheritedViews
+  
+  autoload :Base,         'inherited_views/base'
+  autoload :Helpers,      'inherited_views/helpers'
+  autoload :TableBuilder, 'inherited_views/table_builder'
+  
+end
+
+
+ActionView::Base.send :include, InheritedViews::Helpers
+ActionView::Base.send :include, Formtastic::SemanticFormHelper

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: inherited_views
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Greg Bell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-14 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: inherited_resources
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 6
+        version: 1.0.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: formtastic
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: will_paginate
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 12
+        version: 2.3.12
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: InheritedViews brings the DRY principle to the controller and view layers within Rails applications
+email: 
+- gregdbell@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/inherited_views/base.rb
+- lib/inherited_views/default_views/inherited_views_default/_form.html.erb
+- lib/inherited_views/default_views/inherited_views_default/_table.html.erb
+- lib/inherited_views/default_views/inherited_views_default/edit.html.erb
+- lib/inherited_views/default_views/inherited_views_default/index.html.erb
+- lib/inherited_views/default_views/inherited_views_default/new.html.erb
+- lib/inherited_views/default_views/inherited_views_default/show.html.erb
+- lib/inherited_views/helpers.rb
+- lib/inherited_views/table_builder.rb
+- lib/inherited_views/version.rb
+- lib/inherited_views.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/gregbell/inherited_views
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: The simplest way to implement REST controllers and views in rails applications
+test_files: []
+