nice_generators 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+test/tmp

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - rbx-19mode
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in nice_generators.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Patricio Mac Adden <patriciomacadden@gmail.com>
+
+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.md

@@ -0,0 +1,86 @@
+# Nice Generators [![Build Status](https://travis-ci.org/patriciomacadden/nice_generators.png)](https://travis-ci.org/patriciomacadden/nice_generators) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/patriciomacadden/nice_generators)
+
+### Nice generators for rails 3.
+
+## Installation
+
+Add `nice_generators` to your `Gemfile`:
+
+```
+gem 'nice_generators'
+```
+
+Install it using `bundle install`
+
+Run the following command to install some templates and the translation file
+(`config/locales/nice.en.yml`):
+
+```
+rails generate nice:install
+```
+
+## Available generators
+
+* `install` generator
+
+```
+rails generate nice:install
+```
+
+This generator was already explained: it allows us to use `nice_generators`.
+
+* `layout` generator
+
+```
+rails generate nice:layout application
+```
+
+This generator creates a nice layout, similar to the default layout, but
+well-indented and displaying flashes. In addition, it generates a layout
+helper containing useful methods.
+
+* `scaffold` generator
+
+```
+rails generate nice:scaffold article title:string body:text
+```
+
+It's just like `rails generate scaffold article title:string body:text`, but with some *nice* features.
+
+* `scaffold_controller` generator
+
+```
+rails generate nice:scaffold_controller comment name:string body:text post_id:integer
+```
+
+It's just like `rails generate scaffold_controller article name:string body:text post_id:integer`, but with some *nice* features.
+
+## Features
+
+* Generated controllers are refactored
+* Generated controllers and views are fully i18n'ed
+* Generated controllers uses `respond_to` and `respond_with`
+* Generated views have titles (in rails default scaffold show view has no
+  title)
+* Generated layouts are well-indented
+* Generated layouts displays the flashes
+* Layout generator also generates a layout helper, which contains useful
+  methods for using in the layout
+* Generated views uses pretty page titles (See this [screencast](http://railscasts.com/episodes/30-pretty-page-title))
+
+## Integration with simple_form
+
+You can use nice_generators along with [simple_form](https://github.com/plataformatec/simple_form). Simply run `rails generate simple_form:install` after running `rails generate nice:install`.
+
+```
+rails generate nice:install
+rails generate simple_form:install
+```
+
+## Contributing
+
+1. Fork it
+2. Create a branch (`git checkout -b my_awesome_branch`)
+3. Commit your changes (`git commit -am "Added some magic"`)
+4. Push to the branch (`git push origin my_awesome_branch`)
+5. Send pull request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc 'Run tests'
+task :default => :test
+

data/lib/generators/nice/install/install_generator.rb

@@ -0,0 +1,22 @@
+module Nice
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copy scaffold templates into your rails application'
+      source_root File.expand_path '../templates', __FILE__
+
+      class_option :template_engine
+
+      def copy_templates
+        engine = options[:template_engine]
+
+        copy_file "#{engine}/_form.html.#{engine}", "lib/templates/#{engine}/scaffold/_form.html.#{engine}"
+        copy_file "#{engine}/edit.html.#{engine}", "lib/templates/#{engine}/scaffold/edit.html.#{engine}"
+        copy_file "#{engine}/index.html.#{engine}", "lib/templates/#{engine}/scaffold/index.html.#{engine}"
+        copy_file "#{engine}/new.html.#{engine}", "lib/templates/#{engine}/scaffold/new.html.#{engine}"
+        copy_file "#{engine}/show.html.#{engine}", "lib/templates/#{engine}/scaffold/show.html.#{engine}"
+
+        copy_file 'nice.en.yml', 'config/locales/nice.en.yml'
+      end
+    end
+  end
+end

data/lib/generators/nice/install/templates/erb/_form.html.erb

@@ -0,0 +1,23 @@
+<%%= form_for(@<%= singular_table_name %>) do |f| %>
+  <%% if @<%= singular_table_name %>.errors.any? %>
+    <div id="error_explanation">
+      <h2><%%=t 'views.<%= plural_table_name %>.errors', count_errors: pluralize(@<%= singular_table_name %>.errors.count, t('nice.error')), object: '<%= singular_table_name %>' %></h2>
+
+      <ul>
+      <%% @<%= singular_table_name %>.errors.full_messages.each do |msg| %>
+        <li><%%= msg %></li>
+      <%% end %>
+      </ul>
+    </div>
+  <%% end %>
+
+<% for attribute in attributes -%>
+  <div class="field">
+    <%%= f.label :<%= attribute.name %> %><br />
+    <%%= f.<%= attribute.field_type %> :<%= attribute.name %> %>
+  </div>
+<% end -%>
+  <div class="actions">
+    <%%= f.submit %>
+  </div>
+<%% end %>

data/lib/generators/nice/install/templates/erb/edit.html.erb

@@ -0,0 +1,6 @@
+<h1><%%= title t('views.<%= plural_table_name %>.edit') %></h1>
+
+<%%= render 'form' %>
+
+<%%= link_to t('nice.show'), @<%= singular_table_name %> %> |
+<%%= link_to t('nice.back'), <%= index_helper %>_path %>

data/lib/generators/nice/install/templates/erb/index.html.erb

@@ -0,0 +1,31 @@
+<h1><%%= title t('views.<%= plural_table_name %>.index') %></h1>
+
+<%% if @<%= plural_table_name %>.any? %>
+  <table>
+    <tr>
+<% for attribute in attributes -%>
+      <th><%%=t 'activerecord.attributes.<%= singular_table_name %>.<%= attribute.name %>' %></th>
+<% end -%>
+      <th></th>
+      <th></th>
+      <th></th>
+    </tr>
+
+  <%% @<%= plural_table_name %>.each do |<%= singular_table_name %>| %>
+    <tr>
+<% for attribute in attributes -%>
+      <td><%%= <%= singular_table_name %>.<%= attribute.name %> %></td>
+<% end -%>
+      <td><%%= link_to t('nice.show'), <%= singular_table_name %> %></td>
+      <td><%%= link_to t('nice.edit'), edit_<%= singular_table_name %>_path(<%= singular_table_name %>) %></td>
+      <td><%%= link_to t('nice.destroy'), <%= singular_table_name %>, confirm: t('nice.are_you_sure'), method: :delete %></td>
+    </tr>
+  <%% end %>
+  </table>
+<%% else %>
+  <%%=t 'views.<%= plural_table_name %>.empty' %>
+<%% end %>
+
+<br />
+
+<%%= link_to t('views.<%= plural_table_name %>.new'), new_<%= singular_table_name %>_path %>

data/lib/generators/nice/install/templates/erb/new.html.erb

@@ -0,0 +1,5 @@
+<h1><%%= title t('views.<%= plural_table_name %>.new') %></h1>
+
+<%%= render 'form' %>
+
+<%%= link_to t('nice.back'), <%= index_helper %>_path %>

data/lib/generators/nice/install/templates/erb/show.html.erb

@@ -0,0 +1,12 @@
+<h1><%%= title t('views.<%= plural_table_name %>.show') %></h1>
+
+<% for attribute in attributes -%>
+<p>
+  <b><%%=t 'activerecord.attributes.<%= singular_table_name %>.<%= attribute.name %>' %>:</b>
+  <%%= @<%= singular_table_name %>.<%= attribute.name %> %>
+</p>
+
+<% end -%>
+
+<%%= link_to t('nice.edit'), edit_<%= singular_table_name %>_path(@<%= singular_table_name %>) %> |
+<%%= link_to t('nice.back'), <%= index_helper %>_path %>

data/lib/generators/nice/install/templates/nice.en.yml

@@ -0,0 +1,12 @@
+en:
+  controllers:
+
+  nice:
+    are_you_sure: Are you sure?
+    back: Back
+    edit: Edit
+    error: error
+    destroy: Destroy
+    show: Show
+
+  views:

data/lib/generators/nice/layout/layout_generator.rb

@@ -0,0 +1,38 @@
+module Nice
+  module Generators
+    class LayoutGenerator < Rails::Generators::NamedBase
+      desc 'Creates a nice layout'
+      source_root File.expand_path '../templates', __FILE__
+
+      class_option :template_engine
+
+      def create_layout
+        engine = options[:template_engine]
+
+        template "#{engine}/application.html.#{engine}.tt", "app/views/layouts/#{file_name}.html.#{engine}"
+        template "layout_helper.rb.tt", "app/helpers/layout_helper.rb"
+      end
+
+      private
+
+      def app_name
+        @app_name ||= defined_app_const_base? ? defined_app_name : File.basename(destination_root)
+      end
+
+      def defined_app_name
+        defined_app_const_base.underscore
+      end
+
+      def defined_app_const_base
+        Rails.respond_to?(:application) && defined?(Rails::Application) &&
+          Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "")
+      end
+      alias :defined_app_const_base? :defined_app_const_base
+
+      def app_const_base
+        @app_const_base ||= defined_app_const_base || app_name.gsub(/\W/, '_').squeeze('_').camelize
+      end
+      alias :camelized :app_const_base      
+    end
+  end
+end

data/lib/generators/nice/layout/templates/erb/application.html.erb.tt

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%%= content_for?(:title) ? yield(:title) : default_title %></title>
+    <%%= stylesheet_link_tag 'application', media: 'all' %>
+    <%%= javascript_include_tag 'application' %>
+    <%%= csrf_meta_tags %>
+  </head>
+  <body>
+
+    <%% flash.each do |name, message| %>
+      <div id="<%%= name %>"><%%= message %></div>
+    <%% end %>
+
+    <%%= yield %>
+
+  </body>
+</html>

data/lib/generators/nice/layout/templates/layout_helper.rb.tt

@@ -0,0 +1,10 @@
+module LayoutHelper
+  def default_title
+    '<%= camelized %>'
+  end
+
+  def title(title)
+    content_for :title, title
+    title
+  end
+end

data/lib/generators/nice/scaffold/scaffold_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators/rails/scaffold/scaffold_generator'
+
+module Nice
+  module Generators
+    class ScaffoldGenerator < Rails::Generators::ScaffoldGenerator
+      remove_hook_for :scaffold_controller
+
+      hook_for :scaffold_controller do |scaffold_controller|
+        invoke 'nice:scaffold_controller', [name, attributes.collect { |a| "#{a.name}:#{a.type}" }]
+      end
+    end
+  end
+end

data/lib/generators/nice/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,9 @@
+require 'rails/generators/rails/scaffold_controller/scaffold_controller_generator'
+
+module Nice
+  module Generators
+    class ScaffoldControllerGenerator < Rails::Generators::ScaffoldControllerGenerator
+      source_root File.expand_path('../templates', __FILE__)
+    end
+  end
+end

data/lib/generators/nice/scaffold_controller/templates/controller.rb

@@ -0,0 +1,59 @@
+<% module_namespacing do -%>
+class <%= controller_class_name %>Controller < ApplicationController
+  before_filter :find_<%= singular_table_name %>!
+  respond_to :html, :json
+
+  # GET <%= route_url %>
+  # GET <%= route_url %>.json
+  def index
+    @<%= plural_table_name %> = <%= class_name %>.all
+    respond_with @<%= plural_table_name %>
+  end
+
+  # GET <%= route_url %>/1
+  # GET <%= route_url %>/1.json
+  def show
+    respond_with @<%= singular_table_name %>
+  end
+
+  # GET <%= route_url %>/new
+  # GET <%= route_url %>/new.json
+  def new
+    @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
+    respond_with @<%= singular_table_name %>
+  end
+
+  # GET <%= route_url %>/1/edit
+  def edit
+    respond_with @<%= singular_table_name %>
+  end
+
+  # POST <%= route_url %>
+  # POST <%= route_url %>.json
+  def create
+    @<%= singular_table_name %> = <%= orm_class.build(class_name, "params[:#{singular_table_name}]") %>
+    flash[:notice] = t('controllers.<%= plural_table_name %>.created') if @<%= orm_instance.save %>
+    respond_with @<%= singular_table_name %>
+  end
+
+  # PUT <%= route_url %>/1
+  # PUT <%= route_url %>/1.json
+  def update
+    flash[:notice] = t('controllers.<%= plural_table_name %>.updated') if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %>
+    respond_with @<%= singular_table_name %>
+  end
+
+  # DELETE <%= route_url %>/1
+  # DELETE <%= route_url %>/1.json
+  def destroy
+    @<%= orm_instance.destroy %>
+    respond_with @<%= singular_table_name %>
+  end
+
+  private
+
+  def find_<%= singular_table_name %>!
+    @<%= singular_table_name %> = <%= orm_class.find(class_name, 'params[:id]') %> if params[:id]
+  end
+end
+<% end -%>

data/lib/nice_generators.rb

@@ -0,0 +1,4 @@
+require 'nice_generators/version'
+
+module NiceGenerators
+end

data/lib/nice_generators/version.rb

@@ -0,0 +1,3 @@
+module NiceGenerators
+  VERSION = '0.0.2'
+end

data/nice_generators.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'nice_generators/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'nice_generators'
+  s.version     = NiceGenerators::VERSION
+  s.authors     = ['Patricio Mac Adden']
+  s.email       = ['patriciomacadden@gmail.com']
+  s.homepage    = 'https://github.com/patriciomacadden/nice_generators'
+  s.summary     = %q{Nice generators for rails 3.}
+  s.description = %q{Nice generators for rails 3.}
+
+  s.rubyforge_project = 'nice_generators'
+
+  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']
+
+  s.add_dependency 'railties'
+end

data/test/generators/install_generator_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests Nice::Generators::InstallGenerator
+  destination File.expand_path('../../tmp', __FILE__)
+  setup :prepare_destination
+
+  test 'should create all scaffold files and nice.en.yml file' do
+    run_generator
+
+    assert_file 'lib/templates/erb/scaffold/_form.html.erb'
+    assert_file 'lib/templates/erb/scaffold/edit.html.erb'
+    assert_file 'lib/templates/erb/scaffold/index.html.erb'
+    assert_file 'lib/templates/erb/scaffold/new.html.erb'
+    assert_file 'lib/templates/erb/scaffold/show.html.erb'
+    assert_file 'config/locales/nice.en.yml'
+  end
+end

data/test/generators/layout_generator_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+class LayoutGeneratorTest < Rails::Generators::TestCase
+  tests Nice::Generators::LayoutGenerator
+  destination File.expand_path('../../tmp', __FILE__)
+  setup :prepare_destination
+
+  test 'should create layout' do
+    run_generator %w(application)
+
+    assert_file 'app/views/layouts/application.html.erb'
+    assert_file 'app/helpers/layout_helper.rb'
+  end
+end

data/test/generators/scaffold_controller_generator_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class ScaffoldControllerGeneratorTest < Rails::Generators::TestCase
+  tests Nice::Generators::ScaffoldControllerGenerator
+  destination File.expand_path('../../tmp', __FILE__)
+  
+  setup do
+    prepare_destination
+    Dir.mkdir("#{destination_root}/config") unless File.exists?("#{destination_root}/config")
+    File.open("#{destination_root}/config/routes.rb", 'w') do |f|
+      f.puts "Rails.application.routes.draw do\n\nend"
+    end
+  end
+
+  test 'should create a scaffold controller' do
+    run_generator %w(person first_name last_name)
+
+    assert_file 'app/controllers/people_controller.rb'
+    # app/models/person.rb is created by activerecord
+    assert_file 'app/views/people/_form.html.erb'
+    assert_file 'app/views/people/edit.html.erb'
+    assert_file 'app/views/people/index.html.erb'
+    assert_file 'app/views/people/new.html.erb'
+    assert_file 'app/views/people/show.html.erb'
+  end
+end

data/test/generators/scaffold_generator_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class ScaffoldGeneratorTest < Rails::Generators::TestCase
+  tests Nice::Generators::ScaffoldGenerator
+  destination File.expand_path('../../tmp', __FILE__)
+  
+  setup do
+    prepare_destination
+    Dir.mkdir("#{destination_root}/config") unless File.exists?("#{destination_root}/config")
+    File.open("#{destination_root}/config/routes.rb", 'w') do |f|
+      f.puts "Rails.application.routes.draw do\n\nend"
+    end
+  end
+
+  test 'should create a scaffold' do
+    run_generator %w(person first_name last_name)
+
+    assert_file 'app/controllers/people_controller.rb'
+    # app/models/person.rb is created by activerecord
+    assert_file 'app/views/people/_form.html.erb'
+    assert_file 'app/views/people/edit.html.erb'
+    assert_file 'app/views/people/index.html.erb'
+    assert_file 'app/views/people/new.html.erb'
+    assert_file 'app/views/people/show.html.erb'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+# configure rails environment
+ENV['RAILS_ENV'] = 'test'
+
+require 'test/unit'
+require 'rails/generators'
+require 'rails/generators/test_case'
+
+# require nice generators
+require 'generators/nice/install/install_generator'
+require 'generators/nice/layout/layout_generator'
+require 'generators/nice/scaffold/scaffold_generator'
+require 'generators/nice/scaffold_controller/scaffold_controller_generator'
+
+# require nice generators tests
+require 'generators/install_generator_test'
+require 'generators/layout_generator_test'
+require 'generators/scaffold_generator_test'
+require 'generators/scaffold_controller_generator_test'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: nice_generators
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Patricio Mac Adden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: &70171389791300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70171389791300
+description: Nice generators for rails 3.
+email:
+- patriciomacadden@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/nice/install/install_generator.rb
+- lib/generators/nice/install/templates/erb/_form.html.erb
+- lib/generators/nice/install/templates/erb/edit.html.erb
+- lib/generators/nice/install/templates/erb/index.html.erb
+- lib/generators/nice/install/templates/erb/new.html.erb
+- lib/generators/nice/install/templates/erb/show.html.erb
+- lib/generators/nice/install/templates/nice.en.yml
+- lib/generators/nice/layout/layout_generator.rb
+- lib/generators/nice/layout/templates/erb/application.html.erb.tt
+- lib/generators/nice/layout/templates/layout_helper.rb.tt
+- lib/generators/nice/scaffold/scaffold_generator.rb
+- lib/generators/nice/scaffold_controller/scaffold_controller_generator.rb
+- lib/generators/nice/scaffold_controller/templates/controller.rb
+- lib/nice_generators.rb
+- lib/nice_generators/version.rb
+- nice_generators.gemspec
+- test/generators/install_generator_test.rb
+- test/generators/layout_generator_test.rb
+- test/generators/scaffold_controller_generator_test.rb
+- test/generators/scaffold_generator_test.rb
+- test/test_helper.rb
+homepage: https://github.com/patriciomacadden/nice_generators
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: nice_generators
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Nice generators for rails 3.
+test_files:
+- test/generators/install_generator_test.rb
+- test/generators/layout_generator_test.rb
+- test/generators/scaffold_controller_generator_test.rb
+- test/generators/scaffold_generator_test.rb
+- test/test_helper.rb