controller_scaffolding 0.0.52

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 86b332872eea33fdd28316b626d3d31cbb7aac3a
+  data.tar.gz: 301ab35b6841d8977a693216949307dc01aa0f7f
+SHA512:
+  metadata.gz: 94c624469193929bbba55002ba240c963cdf569187e40102ecd907870909b6fca2db322836f8ea3fe896f8e8a830f3d3f2636f21667af432eba2386e04d383b7
+  data.tar.gz: b9d684512bb3078b9b860b7cd3c0d52631fe94c9cc94af28f6c3d309fa6db83c10aad0ff0fc7eec21f865d3be8d90050c1c7d15e60f06a687a01a196fb9b6205

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 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.rdoc

@@ -0,0 +1,3 @@
+= ControllerScaffolding
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ControllerScaffolding'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+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/lib/controller_scaffolding.rb

@@ -0,0 +1,7 @@
+module ControllerScaffolding
+	require "haml-rails"
+	require "will_paginate"
+	require 'jquery-rails'
+	require "factory_girl_rails" if Rails.env == 'test'
+	require 'controller_scaffolding/add_generator' if defined?(Rails)
+end

data/lib/controller_scaffolding/add_generator.rb

@@ -0,0 +1,8 @@
+module ControllerScaffolding
+  class AddGenerator < Rails::Railtie
+  	generators do
+	    require "generators/controller/controller_scaffolding_generator"
+	    require "generators/haml/controller/controller_scaffolding_generator"
+	  end
+  end
+end

data/lib/controller_scaffolding/version.rb

@@ -0,0 +1,3 @@
+module ControllerScaffolding
+  VERSION = "0.0.52"
+end

data/lib/generators/assets/javascripts/ext_index_nav.js

@@ -0,0 +1,14 @@
+function set_per_page(sel) {
+    url = updateQueryStringParameter($(location).attr('href'), "per_page", $(sel).val())
+    window.location = updateQueryStringParameter(url, "page", "1")
+  }
+function updateQueryStringParameter(uri, key, value) {
+  var re = new RegExp("([?&])" + key + "=.*?(&|$)", "i");
+  var separator = uri.indexOf('?') !== -1 ? "&" : "?";
+  if (uri.match(re)) {
+    return uri.replace(re, '$1' + key + "=" + value + '$2');
+  }
+  else {
+    return uri + separator + key + "=" + value;
+  }
+}

data/lib/generators/assets/stylesheets/controller_scaffolding.css.scss

@@ -0,0 +1,131 @@
+
+$gray-lighter: lighten(#000, 80%);
+$gray-light: lighten(#000, 46.7%);
+$table-bg-color: white;
+$border-color: #CBE6E6;
+$link-color: #704942;
+
+/*Mixins*/
+@mixin tblbasic {
+	width: 750px;
+	background-color: $table-bg-color;
+	border-radius: 5px;
+	border: solid 2px $border-color;
+	border-collapse: inherit;
+	border-spacing: 0px;
+}
+
+/*for forms*/
+table.outer { 
+	@include tblbasic;
+	padding: 20px;
+	background-color: $gray-lighter;
+	td {	padding: 5px; }
+}
+
+/*for lists*/
+table.outer-list {
+	@include tblbasic;
+	margin:  15px;
+	tr:nth-child(even) {
+		background-color: $gray-lighter;
+	}
+	thead { 
+		tr {
+			background-color: $gray-light;
+			th { 
+				padding: 5px 0px 5px 5px;  /*top right bottom left*/	
+				border-bottom: solid 2px $border-color;
+				} 
+		}
+		
+	}
+	td {	padding: 5px; }
+}
+
+table.page-top {
+	padding: 20px;
+	width: 800px;
+	border-radius: 5px;
+	td {	padding: 5px; }
+}
+
+.center-align {	text-align: center; }
+
+.link_col { width: 30px; }
+
+a {
+	color: $link-color;
+	text-decoration: none;
+}
+
+/*body style borrowed from bootsrap*/
+body {
+	font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
+	font-size: 14px;
+	line-height: 1.428571429;
+	color: #333333;
+	background-color: white;	
+}
+
+/*alert styles borrowed from bootstrap*/
+.alert {
+  padding: 8px 35px 8px 14px;
+  margin-bottom: 20px;
+  text-shadow: 0 1px 0 rgba(255, 255, 255, 0.5);
+  background-color: #fcf8e3;
+  border: 1px solid #fbeed5;
+  -webkit-border-radius: 4px;
+  -moz-border-radius: 4px;
+  border-radius: 4px;
+}
+.alert,
+.alert h4 {
+  color: #c09853;
+}
+.alert h4 {
+  margin: 0;
+}
+.alert .close {
+  position: relative;
+  top: -2px;
+  right: -21px;
+  line-height: 20px;
+}
+.alert-success {
+  background-color: #dff0d8;
+  border-color: #d6e9c6;
+  color: #468847;
+}
+.alert-success h4 {
+  color: #468847;
+}
+.alert-danger,
+.alert-error {
+  background-color: #f2dede;
+  border-color: #eed3d7;
+  color: #b94a48;
+}
+.alert-danger h4,
+.alert-error h4 {
+  color: #b94a48;
+}
+.alert-info {
+  background-color: #d9edf7;
+  border-color: #bce8f1;
+  color: #3a87ad;
+}
+.alert-info h4 {
+  color: #3a87ad;
+}
+.alert-block {
+  padding-top: 14px;
+  padding-bottom: 14px;
+}
+.alert-block > p,
+.alert-block > ul {
+  margin-bottom: 0;
+}
+.alert-block p + p {
+  margin-top: 5px;
+}

data/lib/generators/controller/concerns/ext_form_submit.rb

@@ -0,0 +1,17 @@
+module ExtFormSubmit
+	def redir_url()
+    if params[:btn_reload]
+      :back
+    else
+      eval("#{params[:controller]}_url")
+    end
+  end
+
+  def flash_alert(obj)
+    err_str = view_context.render_for_controller("validation_errors", {:obj => obj})
+    msg = ("Unable to #{action_name} #{obj.class} for the following" + 
+      " " + view_context.pluralize(obj.errors.full_messages.length, "reason") + 
+      ":#{err_str}") unless obj.errors.messages.size < 1
+    flash.now[:error] = msg.html_safe
+  end
+end

data/lib/generators/controller/concerns/ext_index_nav.rb

@@ -0,0 +1,19 @@
+module ExtIndexNav
+  
+  def setup_pagination(obj_class=controller_name.classify.constantize)
+  	@page = params[:page] || 1
+  	
+  	case params[:per_page]
+  	when nil
+  		@per_page = 15
+  	when "All"
+  		@per_page = obj_class.count
+  		@selected_val = "All"
+  	else
+  		@per_page = params[:per_page]
+  	end
+  end
+
+  
+
+end

data/lib/generators/controller/controller_scaffolding_generator.rb

@@ -0,0 +1,121 @@
+#CONTROLLER GENERATOR
+
+require 'rails/generators/generated_attribute'
+
+module Rails
+  module Generators
+    #####################  Generators module methods  #####################
+    RAILS_ADDED_COLS = %w(id created_at updated_at)
+    
+    #TODO...There has GOT to be a better way to do this (column name gets listed first if it contains the word "name")
+    ATTR_SORT_PROC = 
+      proc do |a, b|
+        if a =~ /name/
+          1
+        elsif b =~ /name/
+          -1
+        elsif a =~ /email/
+          1
+        elsif b =~ /email/
+          -1
+        else
+          0
+        end
+      end
+    
+    def attr_cols(table_name)
+      #return an array of the columns we are interested in allowing the user to change...
+      # as GeneratedAttribute objects
+      acs = table_name.classify.constantize.columns
+        .reject{ |col| RAILS_ADDED_COLS.include?(col.name) }
+        .sort(&ATTR_SORT_PROC)
+        .map { |ac| GeneratedAttribute.new(ac.name, ac.type)}
+    end
+    
+    module_function :attr_cols
+    #######################################################################
+
+    class ControllerScaffoldingGenerator < NamedBase
+      argument :actions, type: :array, default: [], banner: "action action"
+      class_option :ext_index_nav, :type => :boolean, :default => true, :desc => "Include extended index page features."
+      class_option :ext_form_submit, :type => :boolean, :default => true, :desc => "Include extended form submission features."      
+      check_class_collision suffix: "Controller"
+      
+      #Note: This needs to be set Outside of any methods
+      source_paths << [File.expand_path('../../../templates/rails/controller', __FILE__)]
+
+      def check_for_model
+        begin
+        table_name.classify.constantize #throws runtime if model doesn't exist
+        rescue
+          raise Thor::Error, 
+            "Cannot run controller scaffold for model (#{table_name}) that doesn't yet exist."
+        end
+      end
+
+      def create_controller_file
+        template 'controller.rb', File.join('app/controllers', class_path, "#{file_name}_controller.rb")
+      end
+
+      def add_routes
+        #TODO Handle nested resources here (look at namespace_ladder in scaffold generators)
+        route "resources :#{plural_table_name.to_sym}"
+      end
+
+      hook_for :template_engine, :assets, :test_framework, :helper, 
+#================================ P R I V A T E =================================
+      private
+        def generate_action_code(action, ext_index=true, ext_form_submit=true)
+          case action
+            when "index"
+              if ext_index
+                %Q`setup_pagination
+                @#{plural_table_name} = #{class_name.singularize}.all
+                  .paginate(per_page: @per_page, page: @page)`
+              else
+                %Q`@#{plural_table_name} = #{class_name.singularize}.all`
+              end
+            when "edit"
+              %Q`@#{table_name.singularize} = #{class_name.singularize}.find(params[:id])`
+            when "new"
+              %Q`@#{table_name.singularize} = #{class_name.singularize}.new`
+            when "update"
+              redir_call = ext_form_submit ? "redir_url" : "edit_#{table_name.singularize}_url(@#{table_name.singularize})"
+              %Q`@#{table_name.singularize} = #{class_name.singularize}.find(params[:id])
+    if @#{table_name.singularize}.update_attributes(#{table_name.singularize}_params)
+      flash[:success] = "Updated #{table_name.singularize.humanize} successfully"
+      redirect_to #{redir_call}
+    else
+      flash_alert(@#{table_name.singularize})
+      render :edit
+    end`
+            when "create"
+              redir_call = ext_form_submit ? "redir_url" : "new_#{table_name.singularize}_url(@#{table_name.singularize})"
+              %Q`@#{table_name.singularize} = #{class_name.singularize}.new(#{table_name.singularize}_params)
+    if @#{table_name.singularize}.save
+      flash[:success] = "Created #{table_name.singularize.humanize} successfully"
+      redirect_to #{redir_call}
+    else
+      flash_alert(@#{table_name.singularize})
+      render :new
+    end`
+            when "destroy"
+              %Q`@#{table_name.singularize} = #{class_name.singularize}.find(params[:id])
+    if @#{table_name.singularize}.destroy
+      flash[:success] = "Deleted #{table_name.singularize.humanize} successfully"
+    else
+      flash[:error] = "Unable to delete #{table_name.singularize.humanize}"
+    end
+    redirect_to #{table_name.pluralize}_url`
+          end
+        end
+
+        def generate_strong_params_def
+          %Q`def #{table_name.singularize}_params
+    params.required(:#{table_name.singularize}).permit(#{Rails::Generators::attr_cols(table_name).map { |col| col.name.to_sym}})
+  end`
+        end
+    end
+  end
+
+end

data/lib/generators/haml/controller/controller_scaffolding_generator.rb

@@ -0,0 +1,166 @@
+#TEMPLATE GENERATOR & FILE COPIER
+
+require 'rails/generators/erb/controller/controller_generator'
+require 'rails/generators/erb/scaffold/scaffold_generator'
+
+module Haml
+  module Generators
+  	class ControllerScaffoldingGenerator < Erb::Generators::ControllerGenerator
+      argument :actions, type: :array, default: [], banner: "action action"
+      class_option :ext_index_nav, :type => :boolean, :default => true, :desc => "Include extended index page features."
+      class_option :ext_form_submit, :type => :boolean, :default => true, :desc => "Include extended form submission features."      
+      
+      source_paths << File.expand_path('../../../../templates/haml/controller', __FILE__)
+      def copy_view_files #do NOT change the name of this method 
+                          # it must be overriding an existing one in a parent class
+        base_path = File.join("app/views", class_path, file_name)
+        empty_directory base_path
+        @attr_cols = ::Rails::Generators::attr_cols(table_name)
+        (actions - %w(create update destroy)).each do |action|
+          @action = action
+          formats.each do |format|
+            @path = File.join(base_path, filename_with_extensions(action, format))
+            set_template(@action, @path)
+          end
+        end
+      end
+
+      def gen_form_partial
+        #Create _form partial?
+        base_path = File.join("app/views", class_path, file_name)
+        unless (actions & %w(edit new)).empty? #Remember that "&" is Array#intersect
+          @path = File.join(base_path, filename_with_extensions("_form", format))
+          set_template("_form", @path) 
+        end
+      end
+
+      #TODO: Couldn't get the tests to work with relative paths being passed to the 
+      # inject_into_file calls...it wants to make them relative to the test's destination directory
+
+      def handle_ext_index
+        #Extended index functionality?
+        if options.ext_index_nav?
+          copy_controller_concern("ext_index_nav.rb")
+          inject_into_file "#{::Rails.root.to_s}/app/controllers/application_controller.rb", 
+                after: "class ApplicationController < ActionController::Base\n" do
+                  "\ninclude ExtIndexNav\n\n"
+                end
+          copy_partial("_pagination")
+          add_pagination_to_locale_file
+          copy_ext_index_js
+          inject_into_file "#{::Rails.root.to_s}/app/assets/javascripts/application.js",
+            before: "\n//= require_tree ." do
+              "\n//= require jquery\n//= require jquery_ujs"
+            end
+        end
+      end
+        
+      def handle_ext_form
+        #extended form submission functionality?
+        if options.ext_form_submit?
+          copy_controller_concern("ext_form_submit.rb")
+
+          inject_into_file "#{::Rails.root.to_s}/app/controllers/application_controller.rb", 
+                after: "class ApplicationController < ActionController::Base\n" do
+                  "\ninclude ExtFormSubmit\n\n"
+                end
+          copy_partial("_flash_messages")
+          inject_into_file "#{::Rails.root.to_s}/app/views/layouts/application.html.erb", 
+                before: "<%= yield %>\n" do
+                  "\n<%= render 'flash_messages' %>\n"
+                end
+          copy_partial("_validation_errors")
+          inject_into_file "#{::Rails.root.to_s}/app/helpers/application_helper.rb",
+                after: "module ApplicationHelper\n" do
+                  "\ndef render_for_controller(partial, local_vars)
+        render(:partial => partial, :locals => local_vars).html_safe
+      end\n"
+                end
+        end
+      end
+        
+      def copy_stylesheet
+        if options.ext_form_submit? || options.ext_index_nav?
+          source_paths << File.expand_path('../../../../generators/assets/stylesheets', __FILE__)
+          base_path = "app/assets/stylesheets"
+          path = File.join(base_path, 'controller_scaffolding.css.scss')
+          copy_file('controller_scaffolding.css.scss', path) if file_action(path)
+        end
+      end
+
+      
+#================================= P R O T E C T E D =================================
+      protected
+			def handler
+        :haml
+      end
+#================================= P R I V A T E =====================================
+      private
+
+      def set_template(action, path)
+      	template filename_with_extensions(action.to_sym, format), path
+      	rescue Thor::Error => e 
+          say("Falling back to the 'view.html.haml' template because #{action}.html.haml doesn't exist", 
+              :magenta) unless options.quiet?
+      		template filename_with_extensions(:view, format), @path
+      end
+
+      def copy_partial(file)
+        source_paths << File.expand_path('../partials', __FILE__)
+        base_path = "app/views/application"
+        path = File.join(base_path, filename_with_extensions( file, format))
+        copy_file(filename_with_extensions(file, format), path) if file_action(path)
+      end
+
+      def copy_controller_concern(file_w_ext)
+        source_paths << File.expand_path('../../../../generators/controller/concerns', __FILE__)
+        base_path = "app/controllers/concerns"
+        path = File.join(base_path, file_w_ext)
+        copy_file(file_w_ext, path) if file_action(path)
+      end
+
+      def copy_ext_index_js
+        source_paths << File.expand_path('../../../../generators/assets/javascripts', __FILE__)
+        base_path = "app/assets/javascripts"
+        path = File.join(base_path, 'ext_index_nav.js')
+        copy_file('ext_index_nav.js', path) if file_action(path)
+      end
+
+      def add_pagination_to_locale_file
+        inject_into_file "#{::Rails.root.to_s}/config/locales/en.yml", 
+          after: "\nen:\n" do
+%Q{\n
+  will_paginate:
+    models:
+      people:
+        zero:  People
+        one:   Person
+        other: People
+    page_entries_info:
+      multi_page_html: "Displaying <b>%{from}&nbsp;-&nbsp;%{to}</b> of <b>%{count}</b> %{model}"
+      single_page_html:
+        zero:  "No %{model} found"
+        one:   "Displaying <b>1</b> %{model}"
+        other: "Displaying <b>all&nbsp;%{count}</b> %{model}"
+}
+          end
+      end
+
+      def file_action(path)
+        return true if options.force?
+        if behavior == :revoke
+          verb = "Remove"
+        elsif File.exists?(path)
+          verb = "Overwrite existing"  
+        else
+          return true
+        end
+        return yes?("#{verb} shared file #{path}? (y or n)", :yellow)
+      end
+
+      def inc_link?(name)
+        actions.include?(name)
+      end
+    end
+  end
+end