cruddler 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1016297865fd98aad79facd7151455c2f5f3c0da
+  data.tar.gz: 488775e99382a07ac3d7113ff786855c7232069d
+SHA512:
+  metadata.gz: 86597b3b0dfbc054d667352f1be1b88b68d4459ea05fb27ead46538517d73f682ffd804dd32d2dce8898820ac1f32f77adef4c562cb1c59f680c0b3b60d6f7a9
+  data.tar.gz: 37470a87d451f526a7ed632ca45ad075c69d46b0cea795062c1fab535916e94f6dabac87835118cac63d67b32f4bb1aa7e3d84be63446f6a76bbc1c8f1f85e07

data/.gitignore

@@ -0,0 +1,8 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache
+.DS_Store

data/Gemfile

@@ -0,0 +1,29 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in cruddler.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+gem "tabulatr"
+gem "sqlite3"
+gem "simple_form"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+gem 'debugger'
+
+group :test do
+  gem 'factory_girl_rails'
+  gem 'database_cleaner'
+  gem 'capybara'
+  gem 'capybara-webkit'
+  gem 'chromedriver-helper'
+  gem 'launchy'
+end

data/Gemfile.lock

@@ -0,0 +1,141 @@
+PATH
+  remote: .
+  specs:
+    cruddler (4.0.0a)
+      rails (>= 4.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
+      mail (~> 2.5.3)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    addressable (2.3.5)
+    arel (4.0.0)
+    atomic (1.1.10)
+    builder (3.1.4)
+    capybara (2.1.0)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    capybara-webkit (1.0.0)
+      capybara (~> 2.0, >= 2.0.2)
+      json
+    chromedriver-helper (0.0.5)
+      nokogiri
+    columnize (0.3.6)
+    database_cleaner (1.0.1)
+    debugger (1.6.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
+    debugger-linecache (1.2.0)
+    debugger-ruby_core_source (1.2.3)
+    erubis (2.7.0)
+    factory_girl (4.2.0)
+      activesupport (>= 3.0.0)
+    factory_girl_rails (4.2.1)
+      factory_girl (~> 4.2.0)
+      railties (>= 3.0.0)
+    hike (1.2.3)
+    i18n (0.6.4)
+    id_stuffer (0.0.1)
+    jquery-rails (3.0.4)
+      railties (>= 3.0, < 5.0)
+      thor (>= 0.14, < 2.0)
+    json (1.8.0)
+    launchy (2.3.0)
+      addressable (~> 2.3)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.23)
+    mini_portile (0.5.1)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    polyglot (0.3.3)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
+    simple_form (1.4.1)
+    sprockets (2.10.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    sqlite3 (1.3.7)
+    tabulatr (0.4.2)
+      id_stuffer (>= 0.0.1)
+      rails (>= 3.0.0)
+      whiny_hash (>= 0.0.2)
+    thor (0.18.1)
+    thread_safe (0.1.2)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.14)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+    whiny_hash (0.0.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  capybara-webkit
+  chromedriver-helper
+  cruddler!
+  database_cleaner
+  debugger
+  factory_girl_rails
+  jquery-rails
+  launchy
+  simple_form
+  sqlite3
+  tabulatr

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.textile

@@ -0,0 +1,173 @@
+h1. Cruddler - CRUD admin controllers for lazy programmers
+
+NOTE: This is currently in in-house-testing-and-developing state. Feel free to use, but don't complain if it doesn't fit your needs. Feedback is welcome, though.
+
+h2. Mission Objective
+
+I was sick of implementing edit, show, index, ... actions over and over again, and wasn't too enthusiastic about resource_controller and the like for they are way to overengineered.
+
+The same annoyance I found in implementing the corresponding view.
+
+And now, Rails 3.1 is there with view inheritance.
+
+h2. Installaton
+
+add to your Gemfile:
+
+<pre>
+  gem 'cruddler'
+</pre>
+
+and install the view-inheritance views:
+
+<pre>
+  rails g cruddler:install
+</pre>
+
+This installs the index, show, new, edit files to <tt>app/views/admin/application/</tt>, if you want to use them elsewhere, just move them around as you like :)
+
+It also installs a <tt>cruddler.yml</tt> locale file as described below in i18n.
+
+h2. Controller
+
+just write
+
+<pre>
+  cruddler :all
+</pre>
+
+into your controller, or replace <tt>:all</tt> with a list of the actions you want to generate.
+
+h3. Options
+
+* <tt>:klass =&gt; </tt> the resource class, if it can't be guessed from the controller name
+* <tt>:parameter_name =&gt; </tt> the name of the <tt>params</tt> entry, also used as the name of the instance variable generated
+* <tt>:nested =&gt; </tt> if the current resource is nested, either give the name of the nesting model, an array of the names of nesting models, or a hash <tt>{:model1 => Model1, :model2 => Model2, ...}</tt> if the name/model connection can't be guessed.
+* <tt>:nested_as =&gt; </tt> the name of the current resource inside the nesting model, if it can't be guessed. Usually necessary for polymorphic nestings
+* <tt>:path_components =&gt; </tt> an array of path components like <tt>[:admin, :catalog]</tt> if they can't be guessed from the controller name
+* <tt>:authorize =&gt; </tt> <tt>true</tt> if <a href="https://github.com/ryanb/cancan">cancan</a> <tt>authorize!</tt> is to be called for the current resource
+* <tt>:index_path =&gt; </tt> either a string, a symbol (<tt>:index, :show, :edit, :new</tt>) or a <tt>proc</tt> to declare the <tt>index</tt> path for redirects
+* <tt>:after_update_path =&gt; </tt> either a string, a symbol (<tt>:index, :show, :edit, :new</tt>) or a <tt>proc</tt> to declare where to redirect after updates
+* <tt>:after_create_path =&gt; </tt> either a string, a symbol (<tt>:index, :show, :edit, :new</tt>) or a <tt>proc</tt> to declare where to redirect after create
+* <tt>:after_destroy_path =&gt; </tt> either a string, a symbol (<tt>:index, :show, :edit, :new</tt>) or a <tt>proc</tt> to declare where to redirect after destroy
+* <tt>:stateful_index =&gt; </tt> if tabulatr is available, the <tt>find_for_table</tt> call geht the <tt>:stateful =&gt; session</tt> option.
+
+We intentionally don't offer any callbacks or the like, for typical CRUD actions are sufficiently simple to just implement them if they are non-standard. So -- It you're not happy with what cruddler generated, just implement your action 'by hand'.
+
+BTW: If <a href="http://github.com/metaminded/tabulatr">tabulatr</a> is available, the generated <tt>index</tt> action uses <tt>find_for_table</tt> instead of <tt>find</tt>.
+
+h3. Strong Parameters
+
+To use strong parameters in rails 4, you have the following options:
+
+Give block to generate house_parameters method
+
+<pre>
+  class HousesController < ApplicationController
+    cruddler :all do
+      params.required(:house).permit(:name, :number)
+    end
+  end
+</pre>
+
+Give <tt>permit_params</tt> option to implicitly define <tt>cat_params</tt> method:
+
+<tt>params.required(:cat).permit(:name)</tt>
+
+<pre>
+  class CatsController < ApplicationController
+    cruddler :all,
+      nested: 'house',
+      index_path: ->(){ house_cats_path(@house) },
+      permit_params: [:name]
+  end
+</pre>
+
+Give <tt>permit_params: :all</tt> option to implicitly define <tt>cat_params</tt> method:
+
+<tt>params.required(:parasite).permit!</tt>
+
+<pre>
+  class ParasitesController < ApplicationController
+    cruddler :all,
+      nested: ['house', 'cat'],
+      index_path: ->(){ house_cat_parasites_path(@house, @cat) },
+      permit_params: :all
+  end
+</pre>
+
+Give <tt>permit_params: ->(){ closure }</tt> option to implicitly define dynamic <tt>cat_params</tt> method:
+
+<tt>params.required(:dog).permit(&lt;evaluation of closure&gt;)</tt>
+
+<pre>
+  class DogsController < ApplicationController
+    cruddler :all,
+      nested: 'house',
+      nested_as: 'ref',
+      permit_params: ->(){ @house.id == 2 ? :name : [] }
+  end
+</pre>
+
+h3. Dealing with non-standard queries
+
+In the standard case, cruddler uses the plain <tt>FooBar</tt> model in the <tt>FooBarController</tt>.
+If you want to change this behavior, override <tt>cruddler_find_on</tt> in your controller.
+The example below uses the unscoped model:
+
+<pre>
+def cruddler_find_on
+  FooBar.unscoped
+end
+</pre>
+
+h2. Views
+
+Just implement <tt>_model_name</tt>, and <tt>_listing</tt> partials, the rest is done magically. If your edit or new actions need to be more specific, you can override with <tt>_edit_model_name</tt> or <tt>_new_model_name</tt>.
+
+As with the controllers, we don't offer fancy customization options. If you don't like the views, go to the cruddler gem, copy the views into your project, and customize them to your needs.
+
+h2. I18n
+
+In the views and flash-messages, we use i18n, here's an example, you get the idea:
+
+<pre>
+  en:
+    cruddler:
+      abort: "Abort"
+      admin: # path elements if necessary
+        product:
+          edit: "Edit product '%{name}'"
+          index: "All our Products"
+          create: "Create new Product"
+          new: "Create new Product"
+          update_success: "Product updated"
+          update_problem: "Product can't be saved"
+          create_success: "Product created"
+          create_problem: "Product can't be created"
+</pre>
+
+h3. Bugs
+
+There may be lots of bugs in cruddler, although we do some testing (see <tt>spec/</tt>). So if you hunt them, please let me know using the <a href="https://github.com/metaminded/cruddler/issues">GitHub Bugtracker</a>.
+
+h2. Contributing to cruddler
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the <a href="https://github.com/metaminded/cruddler/issues">issue tracker</a> to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Feel free to send a pull request if you think others (me, for example) would like to have your change incorporated into future versions of cruddler.
+
+h2. License
+
+Copyright (c) 2010-2012 Peter Horn, <a href="http://www.metaminded.com" target="_blank">metaminded UG</a>
+
+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/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cruddler'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/cruddler.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "cruddler/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cruddler"
+  s.version     = Cruddler::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.summary     = "CRUD Actions for Lazy Coders"
+  s.email       = "open-source@metaminded.com"
+  s.homepage    = "http://github.com/metaminded/cruddler"
+  s.description = "CRUD Actions for Lazy Coders, with just the correct amount of cifugurability."
+  s.authors     = ['Peter Horn', 'Rene Sprotte']
+  s.licenses    = ['MIT']
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+  s.rdoc_options  = ['--charset=UTF-8']
+
+
+  s.add_runtime_dependency('rails', '~> 4.0', '>= 4.0.0')
+end