effective_developer 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 928a57aff71b27e895d035bdc80c13f5d27f3b27
-  data.tar.gz: 1bc206677f022f78df6dfd28c8b87210dc8ef232
+  metadata.gz: c0bc78241a7312115a37e3ea85a1e91fe356fdc5
+  data.tar.gz: e15e7239d99c756268644a9a897388c37319f956
 SHA512:
-  metadata.gz: c5a5ddf11e47a7f9ed27287e49c890bd35ad9009d2fdb3043424304f7df8ec631e401df78fc8a3675d8a7e004b2286e703a5d92dc116869519f1f913afc5e8d3
-  data.tar.gz: 557cf3af3b565c4aa7e87ff9ebf9136e80f6c4b7d806ff9654fd4967b827f17946990566ded2c2c17e24d49b45f4e3b8fb68301f7dddbf8a62235481bf240aab
+  metadata.gz: f19e58ab88d396f8a03e6e05fedcf93b994ab1969f3a0cedfc17949edf1ac77fef4af3309d1e78ac1eae7c66ec3817b6847e709c0404744ad3ee7287664ead0e
+  data.tar.gz: c546bacc1dd23d075566de969a10246cfddaa0f618b25c8a01ad2b1271035b2053d2344094064010b4fd1badb19448c51534cad970975ec5fb274590549ef1c4

data/README.md

@@ -52,6 +52,18 @@ To release a new gem version:
 > gem_release 1.0.0
 ```
 
+## gitreset
+
+Careful, this command will delete all your un committed changes.
+
+A command line script to call `git reset --hard` and also delete any newly created files.
+
+It truly resets you back to a fresh working copy.  Perfect for tweaking scaffold and code generation tools.
+
+```console
+> gitreset
+```
+
 ## gitsweep
 
 A command line script to delete any git branch that has already been merged into master & develop
@@ -208,36 +220,94 @@ end
 
 Override `before_import()` or `after_import()` to run code before or after the import.
 
-# Scaffolding
+# Code Generation
+
+The goal of the `effective_developer` code generation project is to minimize the amount of hand coding required to build a rails website.
+
+Only the rails model file should be written by a human.
 
-Scaffolding is the fastest way to build a rails app. The effective scaffolds try to improve on the rails built in ones.
+All database migrations, controllers, forms and views should be generated.
 
-To generate an entire resource (4 different examples):
+Creating a new working in-place CRUD feature should be a 1-liner.
+
+A huge head start to the interesting part of the code.
+
+## effective scaffolds
+
+Scaffolding is the fastest way to build a CRUD rails app.
+
+The effective scaffolds generally follow the same pattern as the (rails generate)[http://guides.rubyonrails.org/command_line.html#rails-generate] commands.
+
+To create an entire CRUD resource from the command line:
 
 ```ruby
 rails generate effective:scaffold thing name:string description:text
-
+rails generate effective:scaffold thing name:string description:text --actions index show mark_as_paid
 rails generate effective:scaffold admin/thing name:string description:text
+rails generate effective:scaffold admin/thing name:string description:text --actions crud-show
 
-rails generate effective:scaffold thing name:string description:text --actions crud archive
-
-rails generate effective:scaffold admin/thing name:string description:text --actions crud-show unarchive
 ```
 
-Or, read from the existing model, and just generate the controller, route, ability, menu, datatable, views, form (2 different examples):
+Or to skip the model & migration:
 
 ```ruby
 rails generate effective:scaffold_controller thing
+rails generate effective:scaffold_controller thing index show
+rails generate effective:scaffold_controller admin/thing crud mark_as_paid
+rails generate effective:scaffold_controller admin/thing crud-show
+```
+
+### model file
 
-rails generate effective:scaffold_controller admin/thing --actions crud-show
+If there is a regular rails model file present, all attributes, belong_tos, scopes and has_many accepts_nested_attributes
+will be considered when generating the scaffold.
+
+Make a model file like this (or generate it with `rails generate effective:model post name:string body:text` and tweak from there):
+
+```ruby
+class Post < ApplicationRecord
+  belongs_to :user
+  belongs_to :category
+
+  # Attributes
+  # name         :string
+  # body         :text
+  # published_at :datetime
+
+  validates :name, presence: true
+  validates :description, presence: true
+
+  has_many :comments
+  accepts_nested_attributes_for :comments
+
+  scope :published, -> { where.not(published_at: nil) }
+
+  def to_s
+    name || 'New Post'
+  end
+end
+```
+
+and then run
+
+```console
+rails generate scaffold post
+rails generate scaffold_controller admin/post
 ```
 
-Or call each scaffold one at a time:
+Tweak from here
+
+### all scaffolds
+
+You can call scaffolds one at a time:
 
 ```ruby
+# These two accept attributes on the command line. like effective:scaffold
 rails generate effective:model thing name:string description:text
 rails generate effective:migration thing name:string description:text
-rails generate effective:controller thing # or admin/thing
+
+# Thes accept actions on the command line. with --attributes. like effective:scaffold_controller
+rails generate effective:controller thing  # /admin/thing
 rails generate effective:route thing
 rails generate effective:ability thing # CanCanCan
 rails generate effective:menu thing  # If app/views/*namespaces/_navbar.html.haml is present
@@ -246,8 +316,6 @@ rails generate effective:views thing
 rails generate effective:form thing
 ```
 
-These scaffold generators are still an ongoing work in progress.  There is a lot more inspect the model and do the right thing type functionality to be implemented "soon".
-
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

data/lib/effective_developer/version.rb

@@ -1,3 +1,3 @@
 module EffectiveDeveloper
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.2'.freeze
 end

data/lib/generators/effective/ability_generator.rb

@@ -58,8 +58,8 @@ module Effective
             abilities += (crud_actions & invoked_actions)
           end
 
-          if (invoked_actions - crud_actions).present?
-            abilities += (invoked_actions - crud_actions)
+          if non_crud_actions.present?
+            abilities += non_crud_actions
           end
 
           abilities = ['manage'] if abilities.blank? || abilities == (crud_actions - ['show'])

data/lib/generators/effective/helpers.rb

@@ -12,6 +12,10 @@ module Effective
         %w(index new create show edit update destroy)
       end
 
+      def non_crud_actions
+        invoked_actions - crud_actions
+      end
+
       # --actions crud another
       # --actions crud-show another
       def invoked_actions
@@ -50,10 +54,10 @@ module Effective
         klass_attributes = resource.klass_attributes
 
         if klass_attributes.blank?
-          pending = ActiveRecord::Migrator.new(:up, ActiveRecord::Migrator.migrations(ActiveRecord::Migrator.migrations_paths)).pending_migrations.present?
-
-          migrate = ask("Unable to read the attributes of #{resource.klass}. There are pending migrations. Run db:migrate now? [y/n]")
-          system('bundle exec rake db:migrate') if migrate.to_s.include?('y')
+          if ActiveRecord::Migrator.new(:up, ActiveRecord::Migrator.migrations(ActiveRecord::Migrator.migrations_paths)).pending_migrations.present?
+            migrate = ask("Unable to read the attributes of #{resource.klass || resource.name}. There are pending migrations. Run db:migrate now? [y/n]")
+            system('bundle exec rake db:migrate') if migrate.to_s.include?('y')
+          end
 
           klass_attributes = resource.klass_attributes
         end

data/lib/generators/effective/menu_generator.rb

@@ -70,7 +70,7 @@ module Effective
       end
 
       def effective_menus_content
-        "item '#{resource.plural_name.titleize}', :#{resource.plural_name}_path"
+        "item '#{resource.plural_name.titleize}', :#{resource.index_path}"
       end
 
     end

data/lib/generators/effective/route_generator.rb

@@ -64,8 +64,8 @@ module Effective
             resources << ']'
           end
 
-          if (invoked_actions - crud_actions).present?
-            [resources + ' do'] + (invoked_actions - crud_actions).map { |action| "get :#{action}, on: :member" } + ['end']
+          if non_crud_actions.present?
+            [resources + ' do'] + non_crud_actions.map { |action| "get :#{action}, on: :member" } + ['end']
           else
             resources
           end

data/lib/generators/effective/scaffold_generator.rb

@@ -18,11 +18,15 @@ module Effective
       class_option :actions, type: :array, default: ['crud'], desc: 'Included actions', banner: 'index show'
 
       def invoke_model
-        Rails::Generators.invoke('effective:model', [name] + invoked_attributes)
+        if File.exists?(resource.model_file)
+          say_status(:skipped, :model, :yellow) and return
+        end
+
+        Rails::Generators.invoke('effective:model', [name] + invokable(invoked_attributes))
       end
 
       def invoke_migration
-        Rails::Generators.invoke('effective:migration', [name] + invoked_attributes)
+        Rails::Generators.invoke('effective:migration', [name] + invokable(invoked_attributes))
       end
 
       def invoke_controller
@@ -58,7 +62,7 @@ module Effective
           say_status(:skipped, :form, :yellow) and return
         end
 
-        Rails::Generators.invoke('effective:form', [name] + invoked_attributes)
+        Rails::Generators.invoke('effective:form', [name] + invokable(invoked_attributes))
       end
 
     end

data/lib/generators/effective/views_generator.rb

@@ -30,7 +30,9 @@ module Effective
           template "views/#{action}.html.haml", resource.view_file(action)
         end
 
-        template 'views/_resource.html.haml', resource.view_file(resource.name, partial: true)
+        if invoked_actions.include?('show') || non_crud_actions.present?
+          template 'views/_resource.html.haml', resource.view_file(resource.name, partial: true)
+        end
       end
 
       private

data/lib/scaffolds/controllers/controller.rb

@@ -1,4 +1,4 @@
-class <%= resource.namespaced_class_name %>Controller < <%= [resource.namespace.try(:classify).presence, ApplicationController].compact.join('::') %>
+class <%= resource.namespaced_class_name.pluralize %>Controller < <%= [resource.namespace.try(:classify).presence, ApplicationController].compact.join('::') %>
   before_action :authenticate_user! # Devise enforce user is present
 
 <% if defined?(EffectiveResources) -%>
@@ -10,7 +10,7 @@ class <%= resource.namespaced_class_name %>Controller < <%= [resource.namespace.
     @page_title = '<%= resource.plural_name.titleize %>'
     authorize! :index, <%= resource.class_name %>
 
-    @datatable = <%= resource.namespaced_class_name %>Datatable.new(params[:scopes])
+    @datatable = <%= resource.namespaced_class_name.pluralize %>Datatable.new(params[:scopes])
   end
 
 <% end -%>
@@ -127,7 +127,7 @@ class <%= resource.namespaced_class_name %>Controller < <%= [resource.namespace.
     )
   end
 
-<% if defined?(EffectiveResources) -%>
+<% if !defined?(EffectiveResources) -%>
   def redirect_path
     case params[:commit].to_s
     when 'Save'

data/lib/scaffolds/datatables/datatable.rb

@@ -1,4 +1,4 @@
-class <%= resource.namespaced_class_name %>Datatable < Effective::Datatable
+class <%= resource.namespaced_class_name.pluralize %>Datatable < Effective::Datatable
 <% if resource.scopes.present? -%>
   scopes do<% ([:all] + resource.scopes).uniq.each_with_index do |scope, index| %>
     scope :<%= scope -%><%= ', default: true' if index == 0 -%>
@@ -17,9 +17,9 @@ class <%= resource.namespaced_class_name %>Datatable < Effective::Datatable
     table_column :<%= attribute.name %>
 <% end -%>
 
-<% if (invoked_actions - crud_actions).present? -%>
+<% if non_crud_actions.present? -%>
     actions_column do |<%= singular_name %>|
-<% (invoked_actions - crud_actions).each_with_index do |action, index| -%>
+<% non_crud_actions.each_with_index do |action, index| -%>
       glyphicon_to('ok', <%= resource.action_path_helper(action, at: false) %>, title: '<%= action.titleize %>')<%= ' +' if (index+1) < (invoked_actions - crud_actions).length %>
 <% end -%>
     end

data/lib/scaffolds/views/edit.html.haml

@@ -1,12 +1,12 @@
 %h1= @page_title
 
-<% if (invoked_actions - crud_actions).present? -%>
+<% if non_crud_actions.present? -%>
 %p.text-right
-<% (invoked_actions - crud_actions).each do |action| -%>
+<% non_crud_actions.each do |action| -%>
   - if can?(:<%= action.to_s %>, @<%= resource.name %>)
     = link_to '<%= action.titleize %>', <%= resource.action_path_helper(action, at: true) %>, class: 'btn btn-primary',
       data: { confirm: 'Really <%= action.to_s.titleize %>?' }
 
 <% end -%>
 <% end -%>
-= render 'form', <%= singular_name %>: @<%= singular_name %>
+= render 'form', <%= resource.name %>: @<%= resource.name %>

data/lib/scaffolds/views/show.html.haml

@@ -1,8 +1,8 @@
 %h1= @page_title
 
-<% if (invoked_actions - crud_actions).present? -%>
+<% if non_crud_actions.present? -%>
 %p.text-right
-<% (invoked_actions - crud_actions).each do |action| -%>
+<% non_crud_actions.each do |action| -%>
   - if can?(:<%= action.to_s %>, @<%= resource.name %>)
     = link_to '<%= action.titleize %>', <%= resource.action_path_helper(action, at: true) %>, class: 'btn btn-default',
       data: { confirm: 'Really <%= action.to_s.titleize %>?' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_developer
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-24 00:00:00.000000000 Z
+date: 2017-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails