common_core_js 0.3.7 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bd570ce32ada5b0551a77526d1b25e82f9b10a4ce9199e9abc60c3256a0c824
-  data.tar.gz: 39d7097d4e3daa434959ec9c72d93f83bee971d715f7ccde0fcb791332b8f490
+  metadata.gz: e57dda2081a4472872145ebd8cdd9fdf28be5014488ee5080224d15c51f6e14f
+  data.tar.gz: 18440eefe37cb6eae705870efc0c37fba1caefdb9e2fef30e72575238dafcfd8
 SHA512:
-  metadata.gz: 344db104a6bcca04942313947217d71f786698f6656590b5f49f03974046a557e8de438c3ba9146c1f2041996926341942f84ef3ff2b947883386e6c7ab2e9c0
-  data.tar.gz: 5c51d14d8d1055b3652ce5e2351582951a60b0d5cb78b1b91153cbf60aab5e141579f177c4de169dd5de3d9cc059c4795c6b45d3024c9d720dcd361ae37814b9
+  metadata.gz: cae68e3566b0546c0d03f9a4061a9a357c33f925fc87957525ac94fe0f62fb3882227f824f2031260b7e23a827140d3f13bf7341926ff96a169c175783b68fdb
+  data.tar.gz: 258050b8e32b576e2ec0ad8b60ce01809a59f9107897ab7f92e160a4ab1073f7212784180954437728c54a9a1cefde2834d9a5f6973f0644d084801f76da9abe

data/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: [jasonfb]
+custom: ["https://jfb.teachable.com"]

data/FUNDING.yml

@@ -0,0 +1,4 @@
+# repo:     your_github_handle/foobar
+# filename: FUNDING.YML
+
+github: [jasonfb]

data/LICENSE

@@ -1,8 +1,11 @@
 Permission is hereby granted 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:
 
-Any users of this software agree to work to dismantle systemic racism, seek justice for black, brown, transgender people, women, and LTBQIAA+ representation and inclusion.
+Any users of this software agree to work to
+1) dismantle systemic racism;
+2) seek justice for black, brown, transgender people, women, and
+3) work towards LGBTQIAA+ representation and inclusion.
 
-Organizations using this software agree to center the narratives of black, brown, and transgender people people.
+Organizations using this software agree to center the narratives of black, brown, transgender, and non-advantaged people in the world.
 
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 

data/README.md

@@ -8,25 +8,32 @@ 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:
+## 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.
+* 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.
+* Create specs automatically 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.
 
+## THE BLOG POST
 
-= HOW EASY?
+It's really easy to get started by following along with this blog post that creates three simple tables (User, Event, and Format).
+
+Feel free to build your own tables when you get to the sections for building the 'Event' scaffold:
+
+https://blog.jasonfleetwoodboldt.com/common-core-js
+
+## HOW EASY?
 
 
 ```
 rails generate common_core:scaffold Thing 
 ```
 
-= TO INSTALL
+## TO INSTALL
 
 - Add common_core_js to your Gemfile
 
@@ -43,7 +50,7 @@ rails generate common_core:scaffold Thing
 
 Note that the arguments are not preceeded by dashes and are followed by equal sign and the input you are giving.
 
-Flags take two dashes (--) and do not take any value. 
+Flags take two dashes (--) and do not take any value. Always pass options first, followed by the flags (or else your options won't work!)
 
 ### First Argument
  
@@ -51,7 +58,7 @@ TitleCase class name of the thing you want to build a scaffoling for.
 
 ### `namespace=`
 
-pass `namespace=` as a flag to denote a namespace to apply to the Rails path helpers
+pass `namespace=` as an option to denote a namespace to apply to the Rails path helpers
 
 
 `rails generate common_core:scaffold Thing namespace=dashboard`
@@ -75,7 +82,7 @@ end
 
 ### `nest=`
 
-pass `nest=` as a flag to denote a nested resources
+pass `nest=` to denote a nested resources
 
 
 `rails generate common_core:scaffold Line nest=invoice`
@@ -132,7 +139,7 @@ When you display anything built with the scaffolding, we assume the `current_use
 
 If you use Devise, you probably already have a `current_user` method available in your controllers. If you don't use Devise, you can implement it in your ApplicationController.
 
-If you use a different object other than "User" for authentication, override using the `auth` flag. 
+If you use a different object other than "User" for authentication, override using the `auth` option. 
 
  `rails generate common_core:scaffold Thing auth=current_account`
 
@@ -202,7 +209,7 @@ You don't need this if the pluralized version is just + "s" of the singular vers
 
 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
+For example, FOR ADMIN CONTROLLERS ONLY, supply a auth_identifier and use `--god` flag
 
 In God mode, the objects are loaded directly from the base class (these controllers have full access)
 ```
@@ -286,3 +293,10 @@ environment.plugins.prepend('Provide',
 module.exports = environment
 
 ```
+
+
+# ACKNOWLEDGEMENTS
+
+### "POOR MAN"
+
+I hope one day I will leave this Earth a poor man (like my code) owning only the most simple structure for the simple form of my existence. Thanks for having educated me in this wisdom goes to my former mentor [@trak3r](https://github.com/trak3r)! 

data/app/helpers/common_core_helper.rb

@@ -7,7 +7,6 @@ module CommonCoreHelper
 
 
     def datetime_field_localized(form_object, field_name, value, label, timezone = nil )
-
       res = form_object.label(label,
                               field_name,
                               class: 'small form-text text-muted')
@@ -22,6 +21,7 @@ module CommonCoreHelper
 
 
     def date_field_localized(form_object, field_name, value, label, timezone = nil )
+
       res = form_object.label(label,
                               field_name,
                               class: 'small form-text text-muted')
@@ -51,7 +51,7 @@ module CommonCoreHelper
         controller.current_timezone
       elsif defined?(current_user)
         if current_user.try(:timezone)
-          Time.now.in_time_zone(current_user.timezone).strftime("%z").to_i/100
+          Time.now.in_time_zone(current_user.timezone.to_i).strftime("%z").to_i/100
         else
           Time.now.strftime("%z").to_i/100
         end
@@ -62,7 +62,6 @@ module CommonCoreHelper
 
 
     def date_to_current_timezone(date, timezone = nil)
-
       # if the timezone is nil, use the server date'
       if timezone.nil?
         timezone = Time.now.strftime("%z").to_i/100

data/common_core_js.gemspec

@@ -8,12 +8,15 @@ Gem::Specification.new do |spec|
   spec.name        = "common_core_js"
   spec.version     = CommonCoreJs::VERSION
   spec.license     = 'MIT'
-  spec.date        = '2020-06-28'
+  spec.date        = '2020-10-29'
   spec.summary     = "A gem build scaffolding."
   spec.description = "Simple, plug & play Rails scaffolding with really simple Javascript"
   spec.authors     = ["Jason Fleetwood-Boldt"]
   spec.email       = 'jason.fb@datatravels.com'
 
+  spec.homepage    = 'https://blog.jasonfleetwoodboldt.com/common-core-js/'
+  spec.metadata    = { "source_code_uri" => "https://github.com/jasonfb/common_core_js",
+                    "course_material_uri" => "https://jfb.teachable.com/p/jason-s-open-source-work/"}
 
 
 

data/lib/common_core_js/version.rb

@@ -1,3 +1,3 @@
 module CommonCoreJs
-  VERSION = '0.3.7'
+  VERSION = '0.4.2'
 end

data/lib/generators/common_core/scaffold_generator.rb

@@ -68,6 +68,7 @@ module CommonCore
 
       args[1..-1].each do |a|
         var_name, var_value = a.split("=")
+        puts var_name
         case (var_name)
 
         when "plural"
@@ -83,21 +84,10 @@ module CommonCore
         end
       end
 
-
-
       auth_assoc = @auth.gsub("current_","")
-      auth_assoc_field = auth_assoc + "_id"
-
-
 
-      exclude_fields = [auth_assoc_field.to_sym, :id, :created_at, :updated_at, :encrypted_password, :reset_password_token,
-                        :reset_password_sent_at, :remember_created_at]
-      begin
-        @columns = object.columns.map(&:name).map(&:to_sym).reject{|field| exclude_fields.include?(field) }
-      rescue StandardError => e
-        puts "Ooops... it looks like is an object for #{class_name}. Please create the database table with fields first. "
-        exit
-      end
+      @no_delete = false
+      @no_create = false
 
       flags = meta_args[1]
       flags.each do |f|
@@ -110,6 +100,10 @@ module CommonCore
           @specs_only = true
         when "--no-specs"
           @no_specs = true
+        when "--no-delete"
+          @no_delete = true
+        when "--no-create"
+          @no_create = true
         end
       end
 
@@ -118,23 +112,74 @@ module CommonCore
         exit
       end
 
+
+      # only used for the before_action
       if @auth_identifier.nil? && !@auth.nil?
         @auth_identifier = @auth.gsub("current_", "")
       end
 
-
-      if auth_identifier == @singular
+      # when in self auth, the object is the same as the authenticated object
+      if @auth && auth_identifier == @singular
         @self_auth = true
       end
 
       if !@nest.nil?
         @nested_args = @nest.split("/")
-
         @nested_args_plural = {}
         @nested_args.each do |a|
           @nested_args_plural[a] = a + "s"
         end
       end
+
+      # the @object_owner will always be object that will 'own' the object
+      # for new and create
+
+      if @auth && ! @self_auth && @nested_args.none?
+         @object_owner_sym = @auth.gsub("current_", "").to_sym
+         @object_owner_eval = @auth
+      else
+
+        if @nested_args.any?
+          @object_owner_sym = @nested_args.last.to_sym
+          @object_owner_eval = "@#{@nested_args.last}"
+        else
+          @object_owner_sym = ""
+          @object_owner_eval = ""
+        end
+      end
+
+
+
+      # create the columns
+      if !@object_owner_sym.empty?
+        auth_assoc_field = auth_assoc + "_id"
+        assoc = eval("#{singular_class}.reflect_on_association(:#{@object_owner_sym})")
+        if assoc
+          ownership_field = assoc.name.to_s + "_id"
+        else
+          puts "Ooops... it looks like is no association for #{@object_owner_sym} on #{singular_class} "
+          exit
+        end
+      end
+
+
+      exclude_fields = [ :id, :created_at, :updated_at, :encrypted_password, :reset_password_token,
+                        :reset_password_sent_at, :remember_created_at, :confirmation_token, :confirmed_at,
+                        :confirmation_sent_at, :unconfirmed_email]
+
+      exclude_fields << auth_assoc_field.to_sym if !auth_assoc_field.nil?
+      exclude_fields <<  ownership_field.to_sym if !ownership_field.nil?
+
+
+      begin
+        @columns = object.columns.map(&:name).map(&:to_sym).reject{|field| exclude_fields.include?(field) }
+      rescue StandardError => e
+        puts "Ooops... it looks like is an object for #{class_name}. Please create the database table with fields first. "
+        exit
+      end
+
+
+
     end
 
     def formats
@@ -150,7 +195,7 @@ module CommonCore
 
       unless @specs_only
         template "controller.rb", File.join("app/controllers#{namespace_with_dash}", "#{plural}_controller.rb")
-        if @namespace
+        if @namespace &&  defined?(controller_descends_from) == nil
           template "base_controller.rb", File.join("app/controllers#{namespace_with_dash}", "base_controller.rb")
         end
       end
@@ -235,6 +280,14 @@ module CommonCore
     end
 
 
+    def path_helper_full
+      "#{@namespace+"_" if @namespace}#{(@nested_args.join("_") + "_" if @nested_args.any?)}#{singular}_path"
+    end
+
+    def path_helper_args
+      [(@nested_args if @nested_args.any? || []).collect{|a| "@#{a}"} , singular].join(",")
+    end
+
     def path_helper_singular
       "#{@namespace+"_" if @namespace}#{(@nested_args.join("_") + "_" if @nested_args.any?)}#{singular}_path"
     end
@@ -264,7 +317,7 @@ module CommonCore
     end
 
     def nested_arity_for_path
-      @nested_args.join(", ") #metaprgramming into arity for the Rails path helper
+      [@nested_args[0..-1].collect{|a| "@#{a}"}].join(", ") #metaprgramming into arity for the Rails path helper
     end
 
     def object_scope
@@ -299,8 +352,12 @@ module CommonCore
     end
 
     def all_objects_variable
+
       # needs the authenticated root user
-      "#{@auth}.#{ @nested_args.map{|a| "#{@nested_args_plural[a]}.find(@#{a})"}.join('.') + "." if @nested_args.any?}#{plural}"
+      # "#{@auth}.#{ @nested_args.map{|a| "#{@nested_args_plural[a]}.find(@#{a})"}.join('.') + "." if @nested_args.any?}#{plural}"
+
+      all_objects_root + ".page(params[:page])"
+
     end
 
     def auth_object
@@ -358,15 +415,6 @@ module CommonCore
       :erb
     end
 
-
-    def create_merge_params
-      if @auth && ! @self_auth
-        "#{@auth_identifier}: #{@auth}"
-      else
-        ""
-      end
-    end
-
     def model_has_strings?
       false
     end
@@ -397,6 +445,7 @@ module CommonCore
               puts "*** Oops. on the #{singular_class} object, there doesn't seem to be an association called '#{assoc_name}'"
               exit
             end
+            assoc_class_name = eval("#{singular_class}.reflect_on_association(:#{assoc_name})").class_name
 
             if assoc.active_record.column_names.include?("name")
               display_column = "name"
@@ -412,9 +461,10 @@ module CommonCore
               puts "Can't find a display_column on {singular_class} object"
             end
 
+
             ".row
   %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{assoc_name.to_s})}\"}
-    = f.collection_select(:#{col.to_s}, #{assoc_name.titleize}.all, :id, :#{display_column}, {prompt: true, selected: @#{singular}.#{col.to_s} }, class: 'form-control')
+    = f.collection_select(:#{col.to_s}, #{assoc_class_name}.all, :id, :#{display_column}, {prompt: true, selected: @#{singular}.#{col.to_s} }, class: 'form-control')
     %label.small.form-text.text-muted
       #{col.to_s.humanize}"
 
@@ -444,16 +494,27 @@ module CommonCore
         when :datetime
           ".row
   %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
-    = datetime_field_localized(f, :#{col.to_s}, @#{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth ? @auth+'.timezone' : 'nil'})"
+    = datetime_field_localized(f, :#{col.to_s}, #{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth ? @auth+'.timezone' : 'nil'})"
         when :date
         ".row
   %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
-    = date_field_localized(f, :#{col.to_s}, @#{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth ? @auth+'.timezone' : 'nil'})"
+    = date_field_localized(f, :#{col.to_s}, #{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth ? @auth+'.timezone' : 'nil'})"
         when :time
           ".row
   %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
-    = time_field_localized(f, :#{col.to_s}, @#{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth ? @auth+'.timezone' : 'nil'})"
+    = time_field_localized(f, :#{col.to_s}, #{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth ? @auth+'.timezone' : 'nil'})"
+        when :boolean
+          ".row
+  %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
+    %span
+      #{col.to_s.humanize}
+    = f.radio_button(:#{col.to_s},  '0', checked: #{singular}.#{col.to_s}  ? '' : 'checked')
+    = f.label(:#{col.to_s}, value: 'No', for: '#{singular}_#{col.to_s}_0')
+
+    = f.radio_button(:#{col.to_s}, '1',  checked: #{singular}.#{col.to_s}  ? 'checked' : '')
+    = f.label(:#{col.to_s}, value: 'Yes', for: '#{singular}_#{col.to_s}_1')
 
+      "
       end
 
     }.join("\n")
@@ -499,7 +560,7 @@ module CommonCore
             end
 
             "  %td
-    = #{singular}.#{assoc.name.to_s}.#{display_column}"
+    = #{singular}.#{assoc.name.to_s}.try(:#{display_column}) || '<span class=\"content alert-danger\">MISSING</span>'.html_safe"
 
           else
             "  %td
@@ -536,7 +597,16 @@ module CommonCore
       %span.alert-danger
         MISSING
 "
-
+        when :boolean
+          "  %td
+    - if #{singular}.#{col}.nil?
+      %span.alert-danger
+        MISSING
+    - elsif #{singular}.#{col}
+      YES
+    - else
+      NO
+"
         end
       }.join("\n")
       return res
@@ -554,12 +624,12 @@ module CommonCore
 
     def destroy_action
       return false if @self_auth
-      return true
+      return !@no_delete
     end
 
     def create_action
       return false if @self_auth
-      return true
+      return !@no_create
     end
 
 

data/lib/generators/common_core/templates/_line.haml

@@ -1,7 +1,7 @@
 <%= all_line_fields %>
   %td
     <% if destroy_action %>
-    = link_to "Delete <i class='fa fa-1x fa-remove'></i>".html_safe, <%= path_helper_singular %>(<%= singular %>), remote: true ,method: :delete,  disable_with: "Loading...", class: "delete-<%= singular %>-button btn btn-primary "
+    = link_to "Delete <i class='fa fa-1x fa-remove'></i>".html_safe, <%= path_helper_full %>(<%= path_helper_args %>), remote: true, method: :delete, data: {confirm: 'Are you sure?'},  disable_with: "Loading...", class: "delete-<%= singular %>-button btn btn-primary "
     <% end %>
     &nbsp;
-    = link_to "Edit <i class='fa fa-1x fa-list-alt'></i>".html_safe, edit_<%= path_helper_singular %>(<%= singular %>), remote: true , disable_with: "Loading...", class: "edit-<%= singular %>-button btn btn-primary "
+    = link_to "Edit <i class='fa fa-1x fa-list-alt'></i>".html_safe, edit_<%= path_helper_full %>(<%= path_helper_args %>), remote: true , disable_with: "Loading...", class: "edit-<%= singular %>-button btn btn-primary "

data/lib/generators/common_core/templates/controller.rb

@@ -1,5 +1,5 @@
 class <%= controller_class_name %> < <%= controller_descends_from %>
-<% unless @auth_identifier.nil? %>
+<% unless @auth_identifier == '' %>
   before_action :authenticate_<%= auth_identifier %>!
 
 <% end %>
@@ -43,14 +43,14 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
   end
 
 <% if create_action %>  def new
-    @<%= singular_name %> = <%= class_name  %>.new(<%= create_merge_params %>)
+    @<%= singular_name %> = <%= class_name  %>.new(<%= @object_owner_sym %>: <%= @object_owner_eval %>)
     respond_to do |format|
       format.js
     end
   end
 
   def create
-    modified_params = modify_date_inputs_on_params(<%=singular_name %>_params.dup<% if !create_merge_params.empty? %>.merge!(<%= create_merge_params %>)<%end%> , <%= @auth ? @auth : "nil" %>)
+    modified_params = modify_date_inputs_on_params(<%=singular_name %>_params.dup<% if !@object_owner_sym.empty? %>.merge!(<%= @object_owner_sym %>: <%= @object_owner_eval %> )<% end %>, <%= @auth %>)
     @<%=singular_name %> = <%=class_name %>.create(modified_params)
     respond_to do |format|
       if @<%= singular_name %>.save
@@ -75,7 +75,7 @@ class <%= controller_class_name %> < <%= controller_descends_from %>
 
   def update
     respond_to do |format|
-      if !@<%=singular_name %>.update(modify_date_inputs_on_params(<%= singular %>_params, <%= @auth ? @auth : "nil" %>  ))
+      if !@<%=singular_name %>.update(modify_date_inputs_on_params(<%= singular %>_params, <%= @auth %>  ))
         flash[:alert] = "<%=singular_name.titlecase %> could not be saved"
       end
       format.js {}

data/lib/generators/common_core/templates/controller_spec.rb

@@ -10,7 +10,7 @@ describe <%= controller_class_name %> do
   before(:each) do
     @request.env["devise.mapping"] = Devise.mappings[:account]
 
-    sign_in <%= @auth %>, scope: :<%= @auth_identifier %>
+    sign_in <%= @auth %>, scope: :<%= @auth %>
   end
 
   describe "index" do

data/lib/generators/common_core/templates/create.js.erb

@@ -1 +1 @@
-<%%= render partial: 'common/common_create', locals: {object: @<%= singular %>, singular: "<%= singular %>", plural: "<%= plural %>"} %>
+<%%= render partial: 'common/common_create', locals: {object: @<%= singular %>, singular: "<%= singular %>", plural: "<%= plural %>"<%= ", " + nested_assignments if nested_assignments %>} %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: common_core_js
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.2
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-28 00:00:00.000000000 Z
+date: 2020-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -129,8 +129,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".generators"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".rakeTasks"
+- FUNDING.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -228,8 +230,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: A gem build scaffolding.
 test_files: []