common_core_js 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d0247921834b019942e6b3539e5f55f8575c0137ca6004cd730298591dfcea
-  data.tar.gz: 57003617eefa913a505f2f2435ba0b61c516d31e07831788f3c96b8907f768dc
+  metadata.gz: 944f8bb60dd7454749b17dfb671d4c4eee78dea8511674ee15c9f12aed759fd8
+  data.tar.gz: 412fa01b88bb1747100fb3a81ceb3f0aee9b19fa606168475d48738a8a8d879b
 SHA512:
-  metadata.gz: 737d442f6cfbdf272e7a2b6c5a5aa690df884994c93429f4fac14e739e0a39064b4b5ab5dbf378756314cab506adcd8fd1f38c689ad7f300ef58043c9ea1c7b3
-  data.tar.gz: e5c8cf0b226a216c735c001dfebedcebb457524dff18f21ee6b988d795ed73f787d92b7fdf864178a6fff3a3d35e3e1fe9393e82ddbb979d6b73e89ba7af3804
+  metadata.gz: 6f03ba9c9154c8cdaea309c2458ef24a9270a0533415fe0cc4a7ac0c69f45f87936e0e09a3277fd185e163f5cbba37ff15e54f496c80a3a29217fd8cb945dfc6
+  data.tar.gz: ae43c5c4c7c26791a259194dd4c93b8ca3cc65659114a39d2099285c36d3f3b849b654b029cffc60f743b07af1856d50a7dd1acec6ae92db0b62e7e093d0db62

data/.generators

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Reorder generators
+2. Remove generators
+3. Add installed generators
+To add new installed generators automatically delete this file and reload the project.
+--><GeneratorsGroup><Generator name="controller" /><Generator name="integration_test" /><Generator name="mailer" /><Generator name="migration" /><Generator name="model" /><Generator name="observer" /><Generator name="plugin" /><Generator name="resource" /><Generator name="scaffold" /><Generator name="session_migration" /></GeneratorsGroup></Settings>

data/.gitignore

@@ -0,0 +1,14 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/db/*.sqlite3-*
+test/dummy/log/*.log
+test/dummy/storage/
+test/dummy/tmp/
+.byebug_history
+
+.idea/
+*.gem
+.DS_Store

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Declare your gem's dependencies in common_core_js.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# 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 a debugger
+# gem 'byebug', group: [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,175 @@
+PATH
+  remote: .
+  specs:
+    common_core_js (0.1.1)
+      haml-rails
+      kaminari
+      rails
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      mail (>= 2.7.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      nokogiri (>= 1.8.5)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
+      globalid (>= 0.3.6)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      marcel (~> 0.3.1)
+    activesupport (6.0.3.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    erubis (2.7.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
+    haml-rails (2.0.1)
+      actionpack (>= 5.1)
+      activesupport (>= 5.1)
+      haml (>= 4.0.6, < 6.0)
+      html2haml (>= 1.0.1)
+      railties (>= 5.1)
+    html2haml (2.2.0)
+      erubis (~> 2.7.0)
+      haml (>= 4.0, < 6)
+      nokogiri (>= 1.6.0)
+      ruby_parser (~> 3.5)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    kaminari (1.2.1)
+      activesupport (>= 4.1.0)
+      kaminari-actionview (= 1.2.1)
+      kaminari-activerecord (= 1.2.1)
+      kaminari-core (= 1.2.1)
+    kaminari-actionview (1.2.1)
+      actionview
+      kaminari-core (= 1.2.1)
+    kaminari-activerecord (1.2.1)
+      activerecord
+      kaminari-core (= 1.2.1)
+    kaminari-core (1.2.1)
+    loofah (2.6.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.2)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      bundler (>= 1.3.0)
+      railties (= 6.0.3.2)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    ruby_parser (3.14.2)
+      sexp_processor (~> 4.9)
+    sexp_processor (4.15.0)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    temple (0.8.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    websocket-driver (0.7.2)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.3.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  common_core_js!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -8,10 +8,37 @@ Yes, it's opinionated. Yes, it's metaprogramming. A lot of metaprogramming. Ruby
 No, I would not use this to build an intricate app. Yes, it's a great tool for prototyping. Yes, I think prototyping is a lost art. 
 
 
+= THE SALES PITCH:
+* Build plug-and-play scaffolding mixing HAML with jQuery-based Javascript
+* Automatically Reads Your Models (make them before building your scaffolding!)
+* Excellent for CRUD, lists with pagination, searching, sorting.
+* Wonderful for prototyping.
+* Plays nicely with Devise, Kaminari, Haml-Rails, Rspec.
+* Create specs autoamatically along with the controllers.
+* Nest your routes model-by-model for built-in poor man's authentication
+* Throw the scaffolding away when your app is ready to graduate to its next phase.
+
+
+= HOW EASY?
+
+
 ```
 rails generate common_core:scaffold Thing 
 ```
 
+= TO INSTALL
+
+- Add common_core_js to your Gemfile
+
+- Install jQuery (required)
+
+- Install Bootstrap (optional)
+
+- Install Devise or implement your own authentication
+
+- Unless you want to bypass specs, you'll also want Rspec (rspec-rails), factory_bot_rails, and shoulda-matchers
+ 
+
 ## Options
 
 Note that the arguments are not preceeded by dashes and are followed by equal sign and the input you are giving.
@@ -22,54 +49,80 @@ Flags take two dashes (--) and do not take any value.
  
 TitleCase class name of the thing you want to build a scaffoling for.
 
-### namespace=
+### `namespace=`
 
 pass `namespace=` as a flag to denote a namespace to apply to the Rails path helpers
 
 
-`rails generate common_core:scaffold GetEmailsRule namespace=dashboard`
+`rails generate common_core:scaffold Thing namespace=dashboard`
+
+This produces several views at `app/views/dashboard/things/` and a controller at`app/controllers/dashboard/things_controller.rb`
+
+The controller looks like so:
 
-### nest=
+```
+class Dashboard::ThingsController < ApplicationController
+  before_action :authenticate_user!
+  before_action :load_thing, only: [:show, :edit, :update, :destroy]
+  def load_thing
+    @thing = current_user.things.find(params[:id])
+  end
+  ...
+end
+
+```
+
+
+### `nest=`
 
 pass `nest=` as a flag to denote a nested resources
 
 
-`rails generate common_core:scaffold Lineitem nest=invoice`
+`rails generate common_core:scaffold Line nest=invoice`
+
+In this example, it is presumed that the current user has_many :invoices, and that invoices have many :lines
+
 
 For multi-level nesting use slashes to separate your levels of nesting. Remember, you should match what you have in your routes.rb file.
 
+```
 resources :invoices do
     resources :lines do
-        resources :charges
+        resources :charge
     end    
 end
 
+```
+In this example, it is presumed that the current user has_many :invoices, and that invoices have many :lines, and that lines have many :charges
+
 
+To generate scaffold: 
  `rails generate common_core:scaffold Charge nest=invoice/line`
+
 The order of the nest should match the nested resources you have in your own app.  In particular, you auth root will be used as the starting point when loading the objects from the URL:
 
 In the example above, @invoice will be loaded from
 
-@invoice = current_user.invoices.find(params[:invoice_id])
+`@invoice = current_user.invoices.find(params[:invoice_id])`
 
 Then, @line will be loaded
 
-@line = @invoice.lines.find(params[:line_id])
+`@line = @invoice.lines.find(params[:line_id])`
 
-Then finally the @charge will be loaded
+Then, finally the @charge will be loaded
 
-@charge = @line.charges.find(params[:id])
+`@charge = @line.charges.find(params[:id])`
 
-It's called "poor man's auth" because if a user attempts to hack the URL by passing ids for objects they don't own--- which Rails makes relatively easy with its default URL pattern-- they will hit ActiveRecord not found errros because the objects will not be found in the assocaited relationships. 
+It's called "poor man's auth" because if a user attempts to hack the URL by passing ids for objects they don't own--- which Rails makes relatively easy with its default URL pattern-- they will hit ActiveRecord not found errors (the objects they don't own won't be found in the associated relationship). 
 
 It works, but it isn't granular. As well, it isn't appropriate for a large app with any level of intricacy to access control (that is, having roles). 
 
-Your customers can delete their own objects by default (may be a good idea or a bay idea for you). If you don't want that, you should strip out the delete actions off the controllers. 
+Your customers can delete their own objects by default (may be a good idea or a bad idea for you). If you don't want that, you should strip out the delete actions off the controllers. 
 
 
-### auth=
+### `auth=`
 
-By default, it will be assumed you have a `current_user` for your user authentication. This will be treated as the "authentication root" for what is fundamentally "poor man's auth."
+By default, it will be assumed you have a `current_user` for your user authentication. This will be treated as the "authentication root" for the "poor man's auth" explained above.
 
 The poor man's auth presumes that object graphs have only one natural way to traverse them (that is, one primary way to traverse them), and that all relationships infer that a set of things or their descendants are granted access to me for reading, writing, updating, and deleting. 
 
@@ -92,38 +145,74 @@ If you supply nesting (see below), your nest chain will automatically begin with
 
 
 
-### auth_identifier=
+### `auth_identifier=`
 
-Your controller will call a method authenticate_ (AUTH IDNETIFIER) bang, like:
+Your controller will call a method authenticate_ (AUTH IDENTIFIER) bang, like:
 
-authenticate_user!
+`authenticate_user!`
 
 Before all of the controller actions. If you leave this blank, it will default to using the variable name supplied by auth with "current_" stripped away. 
 (This is setup for devise.)
 
-Leave blank for default, which is to match the auth. 
+Be sure to implement the following method in your ApplicationController or some other method. Here's a quick example using Devise. You will note in the code below, user_signed_in? is implemented when you add Devise methods to your User table. 
+
+As well, the `after_sign_in_path_for(user)` here is a hook for Devise also that provides you with after login redirect to the page where the user first intended to go.
+
+```
+  def authenticate_user!
+    if ! user_signed_in?
+      session['user_return_to'] = request.path
+      redirect_to new_user_registration_path
+    end
+  end
+
+  def after_sign_in_path_for(user)
+    session['user_return_to'] || account_url(user)
+  end
+```
+
+
+The default (do not pass `auth_identifier=`) will match the `auth` (So if you use 'account' as the auth, `authenticate_account!` will get invoked from your generated controller; the default is always 'user', so you can leave both auth and auth_identifier off if you want 'user') 
+
 
  `rails generate common_core:scaffold Thing auth=current_account auth_identifier=login` 
- In this example, the controller produced with have:
+ In this example, the controller produced with:
+```
    before_action :authenticate_login!
+```
+However, the object graph anchors would continue to start from current_account. That is,
+```
+@thing = current_account.things.find(params[:id])
+```
 
-
-Use empty string to turn this method off:
+Use empty string to **turn this method off**:
  `rails generate common_core:scaffold Thing auth=current_account auth_identifier=''` 
 
+In this case a controller would be generated that would have NO before_action to authenticate the account, but it would still treat the current_account as the auth root for the purpose of loading the objects.
 
-### plural=
+Please note that this example would product non-functional code, so you would need to manually fix your controllers to make sure `current_account` is available to the controller.
+
+
+### `plural=`
 
 You don't need this if the pluralized version is just + "s" of the singular version. Only use for non-standard plurlizations, and be sure to pass it as TitleCase (as if  you pluralized the model name)
 
 
-### --god
+### `--god`
 
 Use this flag to create controllers with no root authentication. You can still use an auth_identifier, which can be useful for a meta-leval authentication to the controoler.
 
 For example, FOR ADMIN CONTROLLERS ONLY, supply a auth_identifier and use --god flag
 
-### --with-index
+In God mode, the objects are loaded directly from the base class (these controllers have full access)
+```
+def load_thing
+    @thing = Thing.find(params[:id])
+end
+
+```
+
+### `--with-index`
 
 By default no master index views get produced. Use this flag to produce an index view. 
 
@@ -131,38 +220,60 @@ The index views simply include the _list partial but pass them a query to use:
 
 `= render partial: "list", locals: {things: Thing.order("created_at DESC").page(1)}`
 
+You will note that unlike other scaffold you may have seen, the "all" view is found at
+```
+all.haml
+```
 
+Common core generate ONLY this top-level (non-partial) HAML file, relying on Rails partials to do the rest. This lets us get little fancy with reloading and re-rendering, and provides for a smooth consistent starting point for you to customize the views. 
 
+The intention is that you DO NOT generate any all.haml views, because you will probably be building a dashboard that composites several different tables into a single page.
 
+When you do that, load the list views from the build scaffolding to define the different sections of your page
 
+```
+= render partial: "dashboard/things/list", locals: {things: current_user.things.order("created_at DESC").page(1)}
+```
 
+Because it's rare that you actually want to build a page that is just a list of one table, the index views are not generate by default.
 
 
-# TROUBLESHOOTING
+### `--specs-only`
 
-## NoMethodError in HellosController#index undefined method `authenticate_user!' for #<HellosController:0x00007fcc2decf828> Did you mean? authenticate_with_http_digest
-    
-    
---> Install Devise
+Produces ONLY the controller spec file, nothing else.
 
 
+### `--no-specs`
+
+Produces all the files except the spec file.
 
-## Uncaught ReferenceError: $ is not defined
-     
---> Install Jquery. Here's a good link: https://www.botreetechnologies.com/blog/introducing-jquery-in-rails-6-using-webpacker
 
-Be sure to 1) add with Yark, 2) Modify environment.js, 3) Modify application.js
 
 
 
-## Nothing happens after you install jQuery
+# TROUBLESHOOTING
+
+## NoMethodError in HellosController#index undefined method `authenticate_user!' for #<HellosController:0x00007fcc2decf828> Did you mean? authenticate_with_http_digest
+        
+--> Install Devise or implement current_user method on your controller or use with auth= and/or auth_identifier= to specify how you want to authenticate your user. 
+
 
---> Install Rails UJS
+## Uncaught ReferenceError: $ is not defined
+     
+--> Install Jquery + Rails UJS
+`yarn add jquery`
 `yarn add  @rails/ujs`
 
+Add to application.js
+```
+require("jquery")
+```
+
 And add to config/webpack/environment.js
 
 ```
+const { environment } = require('@rails/webpacker')
+
 const webpack = require('webpack')
 environment.plugins.prepend('Provide',
   new webpack.ProvidePlugin({
@@ -171,5 +282,7 @@ environment.plugins.prepend('Provide',
     Rails: ['@rails/ujs']
   })
 )
+
 module.exports = environment
+
 ```