rows_controller 1.1.9 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93f715b348e2399eaa011180ec14a6243cd763df
-  data.tar.gz: 98dbeaa2ff0af947ca08bd4e4a65ffdd0921055d
+  metadata.gz: afd501f680af68257cdd2a7f5df5874862667259
+  data.tar.gz: ec22cd6d7a4f72057d1712065c1310313d9bb1f9
 SHA512:
-  metadata.gz: 960b5fe48bea5173276f620aaf5edf071b951ca2317e10681613d9f20859f0b48d4dfdce40f24fce362fdc1ad1f85c2928e9973b18c578143024fbdade3a67f7
-  data.tar.gz: 69fb060f123c9bc6f12b34c4b82269aacd83d5e6e11165ab491afc902d8289aa83c0e641b94685535af5e8b808ec30cacce433de3a7b5ae2745cf6485ef3d061
+  metadata.gz: 757d0fb0008aa4f1115203f554e18a57fcb76ac0159871754766fc0d6f92bbd3c3415dcc1090cebe76d823dc3d26c2bda2002c114e2f01a02bf5c0974b7525b5
+  data.tar.gz: f310dc6c707b4a8d4aea2ecb005c9d02baa167f3dbc0d08748c1224f42b52bb976582c917ed1c5519d44361621dc453a4a9da4eba58585a0347a04222d1a1e71

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+sudo: false
+rvm:
+#  - 2.0.0   # OK for Rails 4.2.4
+#  - 2.2.0
+  - 2.2.3
+
+gemfile:
+  - gemfiles/rails_4.2.4.gemfile
+
+matrix:
+  include:
+# fails due to test/dummy/config/environments/test.rb
+#    - rvm: 1.9.3 # or 2.0.0
+#      gemfile: gemfiles/rails-3.2.16.gemfile
+  exclude:
+
+notifications:
+  email: false

data/.watchr

@@ -0,0 +1,55 @@
+HH = '#' * 22  unless defined?(HH)
+H = '#' * 5    unless defined?(H)
+
+def usage
+  puts <<-EOS
+  Ctrl-\\ or ctrl-4   Running all tests
+  Ctrl-C             Exit
+  EOS
+end
+
+def run(cmd)
+  puts "#{HH} #{Time.now} #{HH}"
+  puts "#{H} #{cmd}"
+  system "/usr/bin/time --format '#{HH} Elapsed time %E' #{cmd}"
+end
+
+def run_it(type, file)
+  case type
+  when 'test';  run %Q{ruby -I"lib:test" -rubygems #{file}}
+  when 'spec';  run %Q{rspec -X #{file}}
+  else;         puts "#{H} unknown type: #{type}, file: #{file}"
+  end
+end
+
+def run_all_tests
+  puts "\n#{HH} Running all tests #{HH}\n"
+  %w{test spec}.each { |dir| run "rake #{dir} RAILS_ENV=test"  if  File.exists?(dir) }
+end
+
+def run_matching_files(base)
+  base = base.split('_').first
+  %w{test spec}.each { |type|
+    files = Dir["#{type}/**/*.rb"].select { |file| file =~ /#{base}_.*\.rb/ }
+    run_it type, files.join(' ')  unless files.empty?
+  }
+end
+
+%w{test spec}.each { |type|
+  watch("#{type}/#{type}_helper\.rb") { run_all_tests }
+  watch("#{type}/.*/*_#{type}\.rb")   { |match| run_it type, match[0] }
+}
+#%w{rb erb haml slim}.each { |type|
+#  watch("app/.*/.*\.#{type}") { |m|
+#    run_matching_files("#{m[0].split('/').at(2).split('.').first}")
+#  }
+#}
+Dir['**/*.rb'].find_all{ |x| !(x =~ /_test\.rb$/) }.each { |name|
+  watch(name)  { run_all_tests }
+}
+
+# Ctrl-\ or ctrl-4
+    Signal.trap('QUIT') { run_all_tests }
+# Ctrl-C
+    Signal.trap('INT')  { abort("Interrupted\n") }
+usage

data/Appraisals

@@ -0,0 +1,7 @@
+#appraise "rails-3.2" do
+#  gem "rails", "3.2.16"
+#end
+
+appraise "rails-4.2.4" do
+  gem "rails", "4.2.4"
+end

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2009-2013 Dittmar Krall - http://matique.de
+Copyright 2009-2015 Dittmar Krall http://matique.de
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,6 @@
 RowsController
 ==============
-[![Gem Version](https://badge.fury.io/rb/rows_controller.png)](http://badge.fury.io/rb/rows_controller)
+[![Gem Version](https://badge.fury.io/rb/rows_controller.svg)](https://badge.fury.io/rb/rows_controller)
 [![Build Status](https://travis-ci.org/matique/rows_controller.png?branch=master)](https://travis-ci.org/matique/rows_controller)
 
 DRYs Rails controllers. Imagine replacing that @order by 'resource' in the
@@ -8,35 +8,48 @@ controllers/views and, imho, an area for DRYing appears.
 Instead of:
 
     class OrdersController < ApplicationController
-      ...
+     .....
+     private
+      def order_params
+       params.require(:order).permit(:name)
+      end
+    end
 
 use:
 
     class OrdersController < RowsController  # < ApplicationController
+     private
+      def resource_whitelist
+       %i{ name }
+      end
+    end
 
+I.e. RowsController defines all the usual methods (index, show, edit,...).
 
-The OrdersController may end there as RowsController has all the usual
-methods (index, show, edit,...).
-
-The methods may be redefined in OrdersController overwritting the
+The methods may be redefined in OrdersController overwriting the
 methods from RowsController.
 
 Low level methods like 'resources' may be redefined as well.
 An example:
 
     def resources
-      @_resources ||= model_class.paginate(:page => params[:page])
+      @_resources ||= model_class.paginate(page: params[:page])
     end
 
 RowsController inherites from ApplicationController, i.e. all the helpers
 defined there will be available.
 
 
-Customization of views
-----------------------
+Customizing of views
+--------------------
+
+RowsController initializes some instance variables used in the views
+(e.g. @order, @orders; legacy @row & @rows are still supported).
+Furthermore, the helpers resource, resources, set_resource and
+set_resources are available. You guess their usage.
 
 Providing e.g. an "#{Rails.root}/app/views/order/index.html.erb"
-overwrites the default Rows view as Rails will first look
+overwrites the default RowsController view as Rails will first look
 into the directory "#{Rails.root}/app/views" before looking
 into the RowsController.
 
@@ -52,20 +65,21 @@ be changed by e.g.:
 
     class OrdersController < RowsController
       model_class Booking
+      ...
 
-The model class can be retrieved with model_class.
+The model class can be retrieved with the helper model_class.
 
 
 Rails 4
 -------
 
 This gem is intended for Rails 4.
-For older Rails versions feel free to switch to "gem 'rows_controller', '= 0.4.4'".
+Older Rails versions may use "gem 'rows_controller', '= 1.1.9'".
 
 Rails 4 introduced strong parameters.
 To support them a private method 'resource_whitelist' is required
 in the controllers.
-Alternatively you may define a private method 'resource_params'
+Alternatively you may define the private method 'resource_params'
 in the controller to filter params.
 
 
@@ -81,7 +95,7 @@ The "id" of the cloned resource is set to nil.
 Usage of "copy" requires a defining in config/routes.rb. An example:
 
     resources :orders
-      get 'copy', :on => :member
+      get 'copy', on: :member
     end
 
 ### columns
@@ -111,5 +125,4 @@ Look for:
 - inherited_resources
 - decent_exposure
 
-
-Copyright (c) 2009-2014 [Dittmar Krall], released under the MIT license
+Copyright (c) 2009-2015 [Dittmar Krall], released under the MIT license.

data/Rakefile

@@ -1,17 +1,26 @@
-require File.expand_path('../test/dummy/config/application', __FILE__)
+require "rubygems"
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
 
-Rails.application.load_tasks
 Bundler::GemHelper.install_tasks
 
-desc "Clean automatically generated files"
-task :clean do
-  FileUtils.rm_rf "pkg"
-end
+require 'rake/testtask'
 
-desc "Check syntax"
-task :syntax do
-  Dir["**/*.rb"].each do |file|
-    print "#{file}: "
-    system("ruby -c #{file}")
-  end
+Rake::TestTask.new(:test) do |t|
+  puts "Ruby version: #{RUBY_VERSION}"
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
 end
+
+task default: :test

data/app/controllers/rows_controller.rb

@@ -1,17 +1,31 @@
-RAILS4 = Rails.version.to_i == 4
-
+require 'rows_controller/resources'
+require 'rows_controller/model'
+require 'rows_controller/utils'
 
 class RowsController < ApplicationController
-  require_dependency 'rows_controller/helpers'
+  before_action :set_resource, only: [:show, :edit, :update, :destroy]
+
+  helper_method :set_resource, :set_resources, :resource, :resources
+  helper_method :resource_columns, :resource_format
+  helper_method :model_class, :model_name
+  helper_method :model_symbol, :model_symbol_plural
+
+  include Rows::Model
+  include Rows::Resources
+  include Rows::Utils
+
+  def self.model_class(model_class = nil)
+    @_model_class = model_class  unless model_class.nil?
+    @_model_class
+  end
 
   # GET /:resources[.json]
   def index
     set_resources
   end
 
-  # GET /:resource/1[.json]
+  # GET /:resource/:id[.json]
   def show
-    set_resource
   end
 
   # GET /:resource/new
@@ -19,81 +33,52 @@ class RowsController < ApplicationController
     resource_new
   end
 
-  # GET /:resource/1/edit
+  # GET /:resource/:id/edit
   def edit
-    set_resource
   end
 
-  # POST /:resources.json
+  # POST /:resources[.json]
   def create
-    respond_to do |format|
-      if resource_create
-	flash[:notice] = t('ui.created', model: model_name,
-		      default: "%{model} created.").html_safe
-	format.html {
-	  if params[:commit] == 'OK'
-	    redirect_to_index
-	  else
-	    redirect_to action: 'edit', id: resource.id
-	  end
-	}
-	format.json { render action: 'show', status: :created, location: resource }
-      else
-        format.html { render action: 'new' }
-	format.json { render json: resource.errors, status: :unprocessable_entity }
-      end
-    end
+    create_update(:resource_create, 'created')
   end
 
-  # PATCH/PUT /:resources/1[.json]
+  # PATCH/PUT /:resources/:id[.json]
   def update
-    set_resource
-    respond_to do |format|
-      if resource_update
-	flash[:notice] = t('ui.updated', model: model_name).html_safe
-	format.html {
-	  if params[:commit] == 'OK'
-	    redirect_to_index
-	  else
-	    redirect_to action: 'edit'
-	  end
-	}
-        format.json { head :no_content }
-      else
-        format.html { render action: 'edit' }
-	format.json { render json: resource.errors, status: :unprocessable_entity }
-      end
-    end
+    create_update(:resource_update, 'updated')
   end
 
-  # DELETE /:resources/1[.json]
+  # DELETE /:resources/:id[.json]
   def destroy
-    set_resource
     resource_destroy
     flash[:notice] = t('ui.destroyed', model: model_name).html_safe  unless request.xhr?
     respond_to do |format|
-      format.html { redirect_to_index }
-      format.js   { render template: 'rows/destroy', layout: false }
+      format.html { redirect_to action: :index }
+      format.js   { render template: 'rows_controller/destroy', layout: false }
       format.json { head :no_content }
     end
   end
 
-
  private
-  # Never trust parameters from the scary internet, only allow the white list through.
-  def resource_params
-    permits = resource_whitelist
-    if RAILS4
-      params.require(model_symbol).permit(permits)
-    else
-      pars = params[model_symbol] || {}
-      pars.keys.each { |x|
-	unless permits.include?(x) || permits.include?({x.to_sym => []})
-	  pars.delete(x)
-	  p "** WARNING: model <#{model_name}> dropping params <#{x}>"
-	end
-      }
-      pars
+  def create_update(which, msg)
+    respond_to do |format|
+      if self.send(which)
+	format.html {
+	  flash[:notice] = t(msg, scope: :ui, model: model_name,
+		  default: "%{model} was successfully #{msg}.").html_safe
+	  if params[:commit] == 'OK'
+	    redirect_to action: :index
+	  else
+	    redirect_to action: 'edit', id: resource.id
+	  end
+	}
+	format.json { render action: 'show',
+			status: msg == 'created' ? :created : :ok,
+			location: resource }
+      else  ## failed
+	format.html { render action: msg == 'created' ? :new : :edit }
+	format.json { render json: resource.errors,
+			     status: :unprocessable_entity }
+      end
     end
   end
 

data/lib/rows_controller/locales/de.yml

@@ -8,10 +8,10 @@ de:
 
     editing:   'Editiere %{model}'
     listing:   'Liste %{model}'
-    new:       'Neu %{model}'
+    new:       'Neue(r/s) %{model}'
     showing:   'Zeige %{model}'
 
-    empty_list: 'Liste %{model} is leer.'
+    empty_list: 'Liste %{model} ist leer.'
 
   button:
     back:      "Zurück"

data/lib/rows_controller/model.rb

@@ -0,0 +1,20 @@
+module Rows::Model
+
+  def model_class
+    @_model_class  ||= self.class.model_class ||
+		       params[:controller].singularize.camelize.constantize
+  end
+
+  def model_name
+    @_model_name   ||= model_class.model_name.name
+  end
+
+  def model_symbol
+    @_model_symbol ||= model_class.model_name.singular
+  end
+
+  def model_symbol_plural
+    @_model_symbol_plural ||= model_class.model_name.plural
+  end
+
+end

data/lib/rows_controller/resources.rb

@@ -0,0 +1,78 @@
+module Rows::Resources
+
+  def set_resources(rows = nil)
+    rows ||= model_class.all
+    instance_variable_set("@#{model_symbol_plural}", rows)
+    @rows = rows
+  end
+
+  def set_resource(row = nil)
+    row ||= model_class.find_by_id(params[:id].to_i)
+    instance_variable_set("@#{model_symbol}", row)
+    @row = row
+  end
+
+  def resources
+    @rows || set_resources
+  end
+
+  def resource
+    @row || set_resource
+  end
+
+ private
+# low level resource methods
+# can be monkey patched
+  def resource_new
+    if params[model_symbol]
+      set_resource model_class.new(resource_params)
+    else
+      set_resource model_class.new
+    end
+  end
+
+  def resource_create
+    resource_new
+    resource.save
+  end
+
+  def resource_update
+    if Rails::VERSION::MAJOR >= 4
+      resource.update(resource_params)
+    else
+      resource.update_attributes(resource_params)
+    end
+  end
+
+  def resource_destroy
+    resource.destroy
+  end
+
+  def resource_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 resource_whitelist
+    raise "RowsController requires private method 'resource_whitelist' in controller <#{params[:controller]}>"
+  end
+
+  # Never trust parameters from the scary internet, only allow the white list through.
+  def resource_params
+    permits = resource_whitelist
+    if params.respond_to?(:require)
+      params.require(model_symbol).permit(permits)
+    else
+      pars = params[model_symbol] || {}
+      pars.keys.each { |x|
+	unless permits.include?(x) || permits.include?({x.to_sym => []})
+	  pars.delete(x)
+	  p "** WARNING: model <#{model_name}> dropping params <#{x}>"
+	end
+      }
+      pars
+    end
+  end
+
+end

data/lib/rows_controller/utils.rb

@@ -0,0 +1,19 @@
+module Rows::Utils
+
+# formatting
+  def resource_format(x)
+    return '--'.html_safe  if x.nil?
+    bool = x.class == Time || x.class == Date || x.class == DateTime ||
+	   x.class == ActiveSupport::TimeWithZone
+    return x.strftime('%d.%m.%Y').html_safe  if bool
+#    return I18n.l(x)                if bool
+    return x.to_s.html_safe         if x.class == Fixnum
+    return 'X'.html_safe            if x.class == TrueClass
+    return ' '.html_safe       if x.class == FalseClass
+    return x.call                   if x.class == Proc
+    return '---'.html_safe          if x.empty?
+    str = x.to_s
+    return str.gsub(/\r*\n/, '<br/>')
+  end
+
+end

data/lib/rows_controller/version.rb

@@ -1,3 +1,3 @@
 module Rows
-  VERSION = "1.1.9"
+  VERSION = "2.0.3"
 end

data/lib/rows_controller.rb

@@ -1,6 +1,8 @@
-require 'rows_controller/engine.rb'
+require 'rows_controller/engine'
+
+module Rows
+end
 
-require 'active_support/i18n'
 I18n.load_path << File.expand_path('../rows_controller/locales/en.yml', __FILE__)
 I18n.load_path << File.expand_path('../rows_controller/locales/de.yml', __FILE__)
 I18n.reload!

data/test/controllers/order/items_controller_test.rb

@@ -0,0 +1,53 @@
+# mostly generated by Rails
+
+require 'test_helper'
+
+class Order::ItemsControllerTest < ActionController::TestCase
+  setup do
+    @order_item = order_items(:one)
+  end
+
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:order_items)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create order_item" do
+    assert_difference('Order::Item.count') do
+      post :create, order_item: { price: @order_item.price }
+    end
+
+##    assert_redirected_to order_item_path(assigns(:order_item))
+    assert_redirected_to edit_order_item_path(assigns(:order_item))
+  end
+
+  test "should show order_item" do
+    get :show, id: @order_item
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, id: @order_item
+    assert_response :success
+  end
+
+  test "should update order_item" do
+    patch :update, id: @order_item, order_item: { price: @order_item.price }
+##    assert_redirected_to order_item_path(assigns(:order_item))
+    assert_redirected_to edit_order_item_path(assigns(:order_item))
+  end
+
+  test "should destroy order_item" do
+    assert_difference('Order::Item.count', -1) do
+      delete :destroy, id: @order_item
+    end
+
+    assert_redirected_to order_items_path
+  end
+end

data/test/controllers/orders_controller_test.rb

@@ -0,0 +1,53 @@
+# mostly generated by Rails
+
+require 'test_helper'
+
+class OrdersControllerTest < ActionController::TestCase
+  setup do
+    @order = orders(:one)
+  end
+
+  test "should get index" do
+    get :index
+    assert_response :success
+    assert_not_nil assigns(:orders)
+  end
+
+  test "should get new" do
+    get :new
+    assert_response :success
+  end
+
+  test "should create order" do
+    assert_difference('Order.count') do
+      post :create, order: { name: @order.name }
+    end
+
+##    assert_redirected_to order_path(assigns(:order))
+    assert_redirected_to edit_order_path(assigns(:order))
+  end
+
+  test "should show order" do
+    get :show, id: @order
+    assert_response :success
+  end
+
+  test "should get edit" do
+    get :edit, id: @order
+    assert_response :success
+  end
+
+  test "should update order" do
+    patch :update, id: @order, order: { name: @order.name }
+##    assert_redirected_to order_path(assigns(:order))
+    assert_redirected_to edit_order_path(assigns(:order))
+  end
+
+  test "should destroy order" do
+    assert_difference('Order.count', -1) do
+      delete :destroy, id: @order
+    end
+
+    assert_redirected_to orders_path
+  end
+end