rows_controller 0.1.0

data/app/controllers/rows_controller/helpers.rb

@@ -0,0 +1,86 @@
+class RowsController < ApplicationController
+
+  def self.model_class(model_class = nil)
+    @model_class = model_class  unless model_class.nil?
+    @model_class
+  end
+
+  
+ protected
+  DATE_FORMAT = '%d.%m.%Y'
+
+  helper_method :resource, :resources, :columns,
+    :model_class, :model_name, :model_symbol, :model_symbol_plural,
+    :resources_format
+
+  def resource
+    return @_resource  if @_resource
+
+    self.resource = begin
+      name = model_symbol
+      if id = params["#{name}_id"] || params[:id]
+	model_class.find_by_id(id).tap do |r|
+	  r.attributes = params[name] unless request.get?
+	end
+      else
+	model_class.new(params[name])
+      end
+    end
+  end
+
+  def resource=(value)
+    @_resource = value
+    instance_variable_set("@#{model_symbol}", value)
+    value
+  end
+
+  def resources
+    return @_resources  if @_resources
+    self.resources = model_class.all
+  end
+
+  def resources=(value)
+    @_resources = value
+    instance_variable_set("@#{model_symbol_plural}", value)
+    value
+  end
+
+  def model_class
+    @model_class ||= self.class.model_class ||
+		     params[:controller].singularize.camelize.constantize
+  end
+
+  def model_name
+    @_model_name ||= model_class.name
+  end
+
+  def model_symbol
+    @_model_symbol ||= model_name.underscore
+  end
+
+  def model_symbol_plural
+    @_model_symbol_plural ||= model_name.pluralize.underscore
+  end
+
+  def columns
+    return model_class.column_headers  if model_class.respond_to?(:column_headers)
+    return ['to_s']  unless model_class.respond_to?(:content_columns)
+    ['id'] + model_class.content_columns.collect{|c| c.name }
+  end
+
+  def resources_format(x)
+    x = ''  if x.nil?
+    bool = x.class == Time || x.class == Date || x.class == DateTime ||
+	   x.class == ActiveSupport::TimeWithZone
+    return x.strftime(DATE_FORMAT)  if bool
+    return x.to_s                   if x.class == Fixnum
+    return 'X'                      if x.class == TrueClass
+    return '&ensp;'                 if x.class == FalseClass
+    return x.call                   if x.class == Proc
+    return '---'                    if x.empty?
+    str = x.to_s
+##    str = UTF8FY.iconv(x.to_s)  if APPLICATION_OPTIONS[:customization] == :dk
+    return str.gsub(/\r*\n/, '<br/>')
+  end
+
+end

data/app/views/rows/_form.html.erb

@@ -0,0 +1,3 @@
+<div style="color:red">
+  Rendering requires partial '<%= model_symbol %>/_form.html.erb'
+</div>

data/app/views/rows/_list.html.erb

@@ -0,0 +1,31 @@
+<%
+# Requires resources model_class columns
+# /home/dk/docu/app/views/restful/_list.html.erb
+
+  cnt = 0
+%>
+
+<table class="rows-list">
+  <tr>
+    <% columns.each do |column| %>
+      <th> <%= t("header.#{column}", :default => column) %> </th>
+    <% end %>
+  </tr>
+  <% resources.each do |resource|
+       url = "/#{controller_name}/#{resource.id}"
+       cnt += 1
+  %>
+    <tr id="row_<%= resource.id%>" class="<%= %w{odd even}.at(cnt % 2) %>" >
+      <% columns.each do |column| %>
+	<td> <%= resources_format(resource.send(column)) %> </td>
+      <% end %>
+      <td>
+	<%= link_to t('button.show', :default => 'Show'), url %>
+	<%= link_to t('button.edit', :default => 'Edit'), url + '/edit' %>
+	<%= link_to t('button.delete', :default => 'Delete'), url,
+		:remote => true,
+		:confirm => 'Are you sure?', :method => :delete %>
+      </td>
+    </tr>
+  <% end %>
+</table>

data/app/views/rows/_submit.html.erb

@@ -0,0 +1,22 @@
+<%
+  # submit links and/or buttons
+  # Requires
+  #   content_for(:submit_<left|right>)
+  #   left|right (links names)
+
+  # left|right must be used inside a form.
+  # The clean content_for variant may be used unbounded.
+
+  left ||= nil
+  right ||= nil
+%>
+<div class="rows_submit" style="width:100%">
+  <input style="display:none" type="submit" name="commit" value="OK" />
+  <p style="float:left">
+    <%= render '/rows/submit_part', :content => :submit_left, :names => left %>
+  </p>
+  <p style="float:right">
+    <%= render '/rows/submit_part', :content => :submit_right, :names => right %>
+  </p>
+  <div style="clear:both"> </div>
+</div>

data/app/views/rows/_submit_part.html.erb

@@ -0,0 +1,4 @@
+<%= content_for(content) %>
+<% (names || []).each do |name| %>
+  <input type="submit" name="commit" value="<%=name%>" />
+<% end %>

data/app/views/rows/destroy.js.erb

@@ -0,0 +1 @@
+$('#row_<%= resource.id %>').fadeOut(500, function() { $(this).remove(); });

data/app/views/rows/edit.html.erb

@@ -0,0 +1,22 @@
+<%
+ # Template for RowsController (edit)
+ # Requires resource model_name model_symbol
+ #   partial 'form' template
+
+  content_for(:submit_left) { link_to t('button.back', :default => 'Back'),
+			      "/#{controller_name}" }
+%>
+
+<%= render '/shared/error_explanation' %>
+
+<fieldset class="wide mask" id="<%= model_symbol %>">
+  <legend>
+    <%= t('ui.edit', :model => model_name,
+	  :default => 'Edit %{model}') %>
+  </legend>
+  <%= form_for resource do |f| %>
+    <%= render 'form', :f => f %>
+    <%= render '/rows/submit',
+	       :right => [t('ui.update', :default => 'Update')] %>
+  <% end %>
+</fieldset>

data/app/views/rows/index.html.erb

@@ -0,0 +1,20 @@
+<%
+# /home/dk/docu/app/views/restful/index.html.erb
+
+# Template for RestfulController (index)
+# Requires resources model_name
+
+  if resources.length > 0
+%>
+  <h1> <%= t('ui.listing', :model => model_name,
+	     :default => 'Listing %{model}') %></h1>
+  <%= render '/shared/error_explanation' %>
+  <%= render '/rows/list', :resources => resources %>
+<% else %>
+  <h1> <%= t('ui.empty_list', :model => model_name,
+	     :default => 'List %{model} is empty') %></h1>
+<% end %>
+
+<br/>
+<%= link_to t('ui.create', :default => 'Create'),
+	    url_for(:action => :new) %>

data/app/views/rows/new.html.erb

@@ -0,0 +1,22 @@
+<%
+ # Template for RowsController (new)
+ # Requires resource model_name model_symbol
+ #   partial 'form' template
+
+  content_for(:submit_left) { link_to t('button.back', :default => 'Back'),
+			      "/#{controller_name}" }
+%>
+
+<%= render '/shared/error_explanation' %>
+
+<fieldset class="wide mask" id="<%= model_symbol %>">
+  <legend>
+    <%= t('ui.new', :model => model_name,
+	  :default => 'New %{model}') %>
+  </legend>
+  <%= form_for resource do |f| %>
+    <%= render 'form', :f => f %>
+    <%= render '/rows/submit',
+	       :right => [t('ui.create', :default => 'Create')] %>
+  <% end %>
+</fieldset>

data/app/views/rows/show.html.erb

@@ -0,0 +1,25 @@
+<%
+# /home/dk/docu/app/views/restful/show.html.erb
+ # Template for RowsController (show)
+ # Requires resource model_name model_symbol
+ #   partial 'form' template
+
+  content_for(:submit_left) { link_to t('button.edit', :default => 'Edit'),
+			      url_for(:action => :edit) }
+  content_for(:submit_left) { ' | ' }
+  content_for(:submit_left) { link_to t('button.back', :default => 'Back'),
+			      url_for(:action => :index) }
+%>
+
+<%= render '/shared/error_explanation' %>
+
+<fieldset class="show wide mask" id="<%= model_symbol %>" >
+  <legend>
+    <%= t('ui.show', :model => model_name,
+	  :default => 'Show %{model}') %>
+  </legend>
+  <%= form_for resource do |f| %>
+    <%= render 'form', :f => f %>
+    <%= render '/rows/submit' %>
+  <% end %>
+</fieldset>

data/app/views/shared/_error_explanation.html.erb

@@ -0,0 +1,14 @@
+<%
+ # Requires resource
+%>
+<% if resource && resource.respond_to?(:errors) && resource.errors.any? %>
+  <div id="error_explanation">
+    <h2><%= pluralize(resource.errors.count, "error") %> prohibited this template from being saved:</h2>
+
+    <ul>
+    <% resource.errors.full_messages.each do |msg| %>
+      <li><%= msg %></li>
+    <% end %>
+    </ul>
+  </div>
+<% end %>

data/app/views/shared/_flash.html.erb

@@ -0,0 +1,9 @@
+<% if notice %>
+  <p class="notice"> <%= notice %> </p>
+  <script type="text/javascript">
+    $('.notice').fadeOut(5000, function() { $(this).remove(); });
+  </script>
+<% end %>
+<% if alert %>
+  <p class="alert"> <%= alert %> </p>
+<% end %>

data/lib/rows_controller.rb

@@ -0,0 +1,5 @@
+require 'rows_controller/engine.rb'
+
+require 'active_support/i18n'
+I18n.load_path << File.expand_path('../rows_controller/locales/en.yml', __FILE__)
+I18n.reload!

data/lib/rows_controller/engine.rb

@@ -0,0 +1,4 @@
+module Rows
+  class Engine < Rails::Engine
+  end
+end

data/lib/rows_controller/locales/en.yml

@@ -0,0 +1,33 @@
+en:
+  flash:
+    actions:
+      create:
+        notice: "%{resource_name} was successfully created."
+        alert: ""
+      update:
+        notice: "%{resource_name} was successfully updated."
+        alert: ""
+      destroy:
+        notice: "%{resource_name} was successfully destroyed."
+        alert: "%{resource_name} could not be destroyed."
+
+  ui:
+    created: '%{model} created.'
+    deleted: '%{model} deleted.'
+    empty_list: 'List %{model} is empty'
+    listing: 'Listing %{model}'
+    new: 'New %{model}'
+    show: 'Show %{model}'
+    updated: '%{model} updated.'
+
+    create: 'Create'
+    update: 'Update'
+
+  button:
+    back: 'Back'
+    edit: 'Edit'
+    delete: 'Delete'
+    show: 'Show'
+
+  header:
+#    to_s: 'Test'

data/lib/rows_controller/version.rb

@@ -0,0 +1,3 @@
+module Rows
+  VERSION = '0.1.0'
+end

data/rows_controller.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'rows_controller/version'
+
+Gem::Specification.new do |s|
+  s.name        = "rows_controller"
+  s.version     = Rows::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "Rows DRYs your controllers."
+  s.description = "YourController < RowsController ( < ApplicationController)."
+  s.authors     = ['Dittmar Krall']
+  s.email       = ['dittmar.krall@matique.de']
+  s.homepage    = 'http://matique.de'
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+
+  s.add_development_dependency "sqlite3"  # for testing
+  s.add_development_dependency "rspec-rails"
+  s.add_development_dependency "capybara"
+end

data/spec/controllers/orders_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper'
+
+describe OrdersController, ':' do
+  Order.delete_all
+  Order.create :name => 'name', :qty => 123
+  let(:order) {Order.all.first}
+
+  %w{index new}.each do |action|
+    describe "#{action}" do
+      it "renders the '#{action}' template" do
+	get action.to_sym
+	response.code.should eq('200')
+	response.should render_template("rows/#{action}")
+	response.body.should == ''
+      end
+    end
+  end
+
+  %w{edit show}.each do |action|
+    describe "#{action}" do
+      it "renders the '#{action}' template" do
+	get action.to_sym, :id => order.id
+	response.code.should eq('200')
+	response.should render_template("rows/#{action}")
+	response.body.should == ''
+      end
+    end
+  end
+
+  it 'checking resource' do
+    get :show, :id => order.id
+    subject.send(:resource).should == order
+    assigns(:order).should == order
+  end
+
+  it 'checking resources' do
+    get :index
+    subject.send(:resources).should be_a_kind_of(Array)
+    assigns(:orders).should be_a_kind_of(Array)
+    assigns(:orders).should == Order.all
+  end
+
+  it 'checking model_class' do
+    get :show, :id => order.id
+    subject.send(:model_class).should == Order
+    subject.send(:model_name).should == 'Order'
+    subject.send(:model_symbol).should == 'order'
+    subject.send(:model_symbol_plural).should == 'orders'
+  end
+end
+
+
+class CategoriesController < RowsController
+  model_class Order
+end
+
+describe CategoriesController do
+  it 'checking model_class' do
+    get :index
+    subject.send(:model_class).should == Order
+    subject.send(:model_name).should == 'Order'
+    subject.send(:model_symbol).should == 'order'
+    subject.send(:model_symbol_plural).should == 'orders'
+  end
+end

data/spec/controllers/rows_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe RowsController do
+  specify { should respond_to(:resource) }
+  specify { should respond_to(:resources) }
+  specify { should respond_to(:model_class) }
+  specify { should respond_to(:model_name) }
+  specify { should respond_to(:model_symbol) }
+  specify { should respond_to(:model_symbol_plural) }
+  specify { should respond_to(:resources_format) }
+
+  specify { should respond_to(:index) }
+  specify { should respond_to(:show) }
+  specify { should respond_to(:new) }
+  specify { should respond_to(:edit) }
+  specify { should respond_to(:create) }
+  specify { should respond_to(:update) }
+  specify { should respond_to(:destroy) }
+end