common_core_js 0.3.3 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7e5ec56e4fffb8aab8840c9cc1aff9377d1291bd9b82fd91fe57841089d8b9e
-  data.tar.gz: c688ccfbca5218fdc210ee199b87e5b61f32405179f41268d2776b086e22e58a
+  metadata.gz: 69b48d2b11f7087d3a842266d1c08df9da022bc7191dbc71f286431ac02112f0
+  data.tar.gz: cdc77c41c2dff7e393837fb1954fc0bd599083c2ce305e98416c097866d6c4a8
 SHA512:
-  metadata.gz: 69bdb23d11a350e5f31b160840dc1f96abf8706a3716df9250e992e1e8cacbfd4b7d10d17be2103fc3f38c1064b178eec7cd2a445ead0c1c5e7269a59188560d
-  data.tar.gz: 29d5aea167e7cfaba9861758a72c8ecc16883ec1b70d11294e45e4ef89377d5654c12a0dcfbcac4c0d3a1b8abdace463e68fc9ca39f9aedfccbc20b18e470f0a
+  metadata.gz: bceefae2fd396020f7225df73e9f74a4f6ea7d06b94250880c872e68c921b43ac1eb0b0f34805098fbab5ca877fe26d54dc152230d2990a9b58428ccf9f6e6ea
+  data.tar.gz: d40870c3538adc2a9d687d583e7b3821544eff497425bf00f712d6426945477d7ac0bc191072ef5befbe0f38b9b0eb1b28b81298719d6eec38a427c458299509

data/FUNDING.yml

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

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
 

data/app/helpers/{common_core_js/application_helper.rb → common_core_helper.rb}

@@ -1,5 +1,10 @@
-module CommonCoreJs
-  module ApplicationHelper
+module CommonCoreHelper
+
+    def timezonize(tz)
+      tz = tz.to_i
+      (tz >= 0 ? "+" : "-") + sprintf('%02d',tz.abs) + ":00"
+    end
+
 
     def datetime_field_localized(form_object, field_name, value, label, timezone = nil )
       res = form_object.label(label,
@@ -10,19 +15,20 @@ module CommonCoreJs
                                     type: 'datetime-local',
                                     value: date_to_current_timezone(value, timezone))
 
-      res << human_timezone(Time.now, timezone)
+      res << timezonize(timezone)
       res
     end
 
 
     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')
 
       res << form_object.text_field(field_name, class: 'form-control',
                                     type: 'date',
-                                    value: date_to_current_timezone(value, timezone))
+                                    value: value )
 
       res
     end
@@ -36,31 +42,24 @@ module CommonCoreJs
                                     type: 'time',
                                     value: date_to_current_timezone(value, timezone))
 
-      res << human_timezone(Time.now, timezone)
+      res << timezonize(tz)
       res
     end
 
     def current_timezone
-      if method(:current_user)
+      if controller.try(:current_timezone)
+        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
       else
-        raise "no method current_user is available or it does not implement timezone; please implement/override the method current_timezone"
+        raise "no method current_user is available or it does not implement timezone; please implement/override the method current_timezone IN YOUR CONTROLLER"
       end
     end
 
-    def human_timezone(time_string, timezone)
-      time = time_string.in_time_zone(timezone)
-
-      if time.zone.match?(/^\w/)
-        time.zone
-      else
-        time.formatted_offset
-      end
-    end
 
     def date_to_current_timezone(date, timezone = nil)
       # if the timezone is nil, use the server date'
@@ -76,5 +75,4 @@ module CommonCoreJs
         return nil
       end
     end
-  end
 end

data/app/helpers/common_core_js/controller_helper.rb

@@ -0,0 +1,21 @@
+module CommonCoreJs
+  module ControllerHelper
+    def modify_date_inputs_on_params(modified_params)
+      use_timezone = current_account.timezone || Time.now.strftime("%z")
+
+      modified_params = modified_params.tap do |params|
+        params.keys.each{|k|
+          if k.ends_with?("_at") || k.ends_with?("_date")
+
+            begin
+              params[k] = DateTime.strptime("#{params[k]} #{use_timezone}", '%Y-%m-%dT%H:%M %z')
+            rescue StandardError
+
+            end
+          end
+        }
+      end
+      modified_params
+    end
+  end
+end

data/app/views/common/_common_edit_form.haml

@@ -1,4 +1,8 @@
 %td{style: "position: relative;", colspan: controller.default_colspan}
+  - if object.errors.any?
+    = render(partial: "#{controller.namespace}errors", locals: {resource: object})
+
+
   Editing
   - if object.try(:to_label)
     = object.to_label

data/app/views/common/_common_update.js.erb

@@ -1,6 +1,7 @@
 <% if object.errors.any? %>
 <% pass_through_locals ||= {} %>
-$(".<%= singular %>-table tr[data-id=<%= object.id %>][data-edit='true']").html("<%= j render(partial: '#{controller.namespace}errors', locals: {resource: object}) %><%= j render partial: 'edit', locals: {singular.to_sym => object, url: url, colspan: controller.default_colspan}.merge(pass_through_locals || {}) %>")
+$(".<%= singular %>-table tr[data-id=<%= object.id %>][data-edit='true']").html("<%= j render partial: 'edit', locals: {singular.to_sym => object, url: url, colspan: controller.default_colspan}.merge(pass_through_locals || {}) %>")
+
 $(".flash-notices").html("<%= j render 'layouts/flash_notices' %>");
 <% else %>
 $(".<%= singular %>-table tr[data-id=<%= object.id %>]:not([data-edit='true'])").replaceWith("<%= j render partial: 'line', locals: {singular.to_sym => object } %>").fadeIn()

data/lib/common_core_js/version.rb

@@ -1,3 +1,3 @@
 module CommonCoreJs
-  VERSION = '0.3.3'
+  VERSION = '0.3.8'
 end

data/lib/generators/common_core/scaffold_generator.rb

@@ -13,7 +13,7 @@ module CommonCore
       end
 
       ".row
-  .form-group.col-md-4
+  %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
     = f.text_area :#{col.to_s}, class: 'form-control', cols: 40, rows: '#{lines}'
     %label.form-text
       #{col.to_s.humanize}\n"
@@ -23,7 +23,7 @@ module CommonCore
 
     def field_output(col, type = nil, width)
       ".row
-  .form-group.col-md-4
+  %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
     = f.text_field :#{col.to_s}, value: @#{singular}.#{col.to_s}, size: #{width}, class: 'form-control', type: '#{type}'
     %label.form-text
       #{col.to_s.humanize}\n"
@@ -86,15 +86,19 @@ module CommonCore
       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, :confirmation_token, :confirmed_at,
+                        :confirmation_sent_at, :unconfirmed_email]
       begin
-        @columns = object.columns.map(&:name).map(&:to_sym).reject{|field| field==:updated_at ||
-            field==:created_at || field==:id ||  field == auth_assoc_field.to_sym }
+        @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|
         case (f)
@@ -106,6 +110,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,6 +126,11 @@ module CommonCore
         @auth_identifier = @auth.gsub("current_", "")
       end
 
+
+      if @auth && auth_identifier == @singular
+        @self_auth = true
+      end
+
       if !@nest.nil?
         @nested_args = @nest.split("/")
 
@@ -141,6 +154,9 @@ module CommonCore
 
       unless @specs_only
         template "controller.rb", File.join("app/controllers#{namespace_with_dash}", "#{plural}_controller.rb")
+        if @namespace &&  defined?(controller_descends_from) == nil
+          template "base_controller.rb", File.join("app/controllers#{namespace_with_dash}", "base_controller.rb")
+        end
       end
 
       unless @no_specs
@@ -270,7 +286,9 @@ module CommonCore
 
     def all_objects_root
       if @auth
-        if @nested_args.none?
+        if @self_auth
+          @singular_class + ".where(id: #{@auth}.id)"
+        elsif @nested_args.none?
           @auth + ".#{plural}"
         else
           "@" + @nested_args.last + ".#{plural}"
@@ -285,8 +303,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
@@ -346,7 +368,7 @@ module CommonCore
 
 
     def create_merge_params
-      if @auth
+      if @auth && ! @self_auth
         "#{@auth_identifier}: #{@auth}"
       else
         ""
@@ -394,32 +416,34 @@ module CommonCore
               display_column = "display_name"
             elsif assoc.active_record.column_names.include?("email")
               display_column = "email"
+            else
+              puts "Can't find a display_column on {singular_class} object"
             end
 
             ".row
-  .form-group.col-md-4
+  %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')
     %label.small.form-text.text-muted
       #{col.to_s.humanize}"
 
           else
             ".row
-  .form-group.col-md-4
+  %div{class: \"form-group col-md-4 \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
     = f.text_field :#{col.to_s}, value: @#{singular}.#{col.to_s}, class: 'form-control', size: 4, type: 'number'
     %label.form-text
       #{col.to_s.humanize}\n"
           end
         when :string
-          limit ||= 40
-          if limit < 50
+          limit ||= 256
+          if limit <= 256
             field_output(col, nil, limit)
           else
             text_area_output(col, limit)
           end
 
         when :text
-          limit ||= 40
-          if limit < 50
+          limit ||= 256
+          if limit <= 256
             field_output(col, nil, limit)
           else
             text_area_output(col, limit)
@@ -427,16 +451,16 @@ module CommonCore
 
         when :datetime
           ".row
-  .form-group.col-md-4
-    = datetime_field_localized(f, :#{col.to_s}, @#{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth}.timezone)"
+  %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'})"
         when :date
         ".row
-  .form-group.col-md-4
-    = date_field_localized(f, :#{col.to_s}, @#{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth}.timezone)"
+  %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'})"
         when :time
           ".row
-  .form-group.col-md-4
-    = time_field_localized(f, :#{col.to_s}, @#{singular}.#{col.to_s}, '#{col.to_s.humanize}', #{@auth}.timezone)"
+  %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'})"
 
       end
 
@@ -499,7 +523,7 @@ module CommonCore
         when :datetime
           "  %td
     - unless #{singular}.#{col}.nil?
-      = #{singular}.#{col}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ') + human_timezone(Time.now, current_timezone)
+      = #{singular}.#{col}.in_time_zone(current_timezone).strftime('%m/%d/%Y @ %l:%M %p ') + timezonize(current_timezone)
     - else
       %span.alert-danger
         MISSING
@@ -510,13 +534,15 @@ module CommonCore
       = #{singular}.#{col}
     - else
       %span.alert-danger
+        MISSING
 "
         when :time
           "  %td
     - unless #{singular}.#{col}.nil?
-      = #{singular}.#{col}.in_time_zone(current_timezone).strftime('%l:%M %p ') + human_timezone(Time.now, current_timezone)
+      = #{singular}.#{col}.in_time_zone(current_timezone).strftime('%l:%M %p ') + timezonize(current_timezone)
     - else
       %span.alert-danger
+        MISSING
 "
 
         end
@@ -525,6 +551,25 @@ module CommonCore
     end
 
 
+    def controller_descends_from
+      if defined?(@namespace.titlecase + "::BaseController")
+        @namespace.titlecase + "::BaseController"
+      else
+        "ApplicationController"
+      end
+    end
+
+
+    def destroy_action
+      return false if @self_auth
+      return !@no_delete
+    end
+
+    def create_action
+      return false if @self_auth
+      return !@no_create
+    end
+
 
     private # thor does something fancy like sending the class all of its own methods during some strange run sequence
     # does not like public methods

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

@@ -1,3 +1,7 @@
 <%= all_line_fields %>
   %td
-    = 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 pull-right "
+    <% if destroy_action %>
+    = link_to "Delete <i class='fa fa-1x fa-remove'></i>".html_safe, <%= path_helper_singular %>(<%= singular %>), 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 "

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

@@ -1,9 +1,9 @@
 
+<% if create_action %>
 = link_to "New <%= singular.gsub('_',' ') %>", new_<%= path_helper_singular %>(<%= nested_arity_for_path %>), disable_with: "Loading...", remote: true, class: "new-<%= singular %>-button btn btn-primary pull-right"
-
 .clearfix
 .new-<%= singular %>-form{style: "display: none; position: relative;"}
-
+<% end %>
 
 
 %table.table.table-striped.<%= singular %>-table

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

@@ -1,4 +1,5 @@
 .container-fluid
   .row
     .col-md-12
-      = render partial: "<%= namespace_with_trailing_dash %><%= plural %>/list", locals: {<%= plural %>: <%= all_objects_root %>.order("created_at DESC").page(1)}
+      .<%= singular %>-list
+        = render partial: "<%= namespace_with_trailing_dash %><%= plural %>/list", locals: {<%= plural %>: <%= all_objects_root %>.order("created_at DESC").page(1)}

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

@@ -0,0 +1,3 @@
+class <%= controller_descends_from %> < ApplicationController
+end
+

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

@@ -1,9 +1,9 @@
 
 require("jquery")
-console.log("loading common core...")
+// console.log("loading common core...")
 
-require("jstimezonedetect/dist/jstz.min")
-var JSTZ = require('jstimezonedetect');
+// require("jstimezonedetect/dist/jstz.min")
+// var JSTZ = require('jstimezonedetect');
 
 
 

data/lib/generators/common_core/templates/common_core.scss

@@ -0,0 +1,5 @@
+[data-role='close-button'] {
+  position: absolute;
+  top: 0;
+  right: 0;
+}

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

@@ -1,4 +1,4 @@
-class <%= controller_class_name %> < ApplicationController
+class <%= controller_class_name %> < <%= controller_descends_from %>
 <% unless @auth_identifier.nil? %>
   before_action :authenticate_<%= auth_identifier %>!
 
@@ -6,7 +6,8 @@ class <%= controller_class_name %> < ApplicationController
 <% if any_nested? %> <% @nested_args.each do |arg| %>
   before_action :load_<%= arg %><% end %> <% end %>
   before_action :load_<%= singular_name %>, only: [:show, :edit, :update, :destroy]
-
+  helper :common_core
+  include CommonCoreJs::ControllerHelpers
 
   <% if any_nested? %><% nest_chain = [] %> <% @nested_args.each do |arg| %>
       <% if nest_chain.empty?
@@ -19,21 +20,29 @@ class <%= controller_class_name %> < ApplicationController
     @<%= arg %> = <%= this_scope %>.find(params[:<%= arg %>_id])
   end<% end %> <% end %>
 
+
+<% if !@self_auth %>
   def load_<%= singular_name %>
     @<%= singular_name %> = <%= object_scope %>.find(params[:id])
   end
-  include CommonCoreJs::ControllerHelpers
+  <% else %>
+  def load_<%= singular_name %>
+    @<%= singular_name %> = <%= auth_object %>
+  end<% end %>
 
   def index
+<% if !@self_auth %>
     @<%= plural_name %> = <%= object_scope %><% if model_has_strings? %>.where(<%=class_name %>.arel_table[:email].matches("%#{@__general_string}%"))<% end %>.page(params[:page])
-
+    <% else %>
+    @<%= plural_name %> = [<%= auth_object %>]
+    <% end %>
     respond_to do |format|
       format.js<% if @with_index %>
       format.html {render 'all.haml'}<% end %>
     end
   end
 
-  def new
+<% if create_action %>  def new
     @<%= singular_name %> = <%= class_name  %>.new(<%= create_merge_params %>)
     respond_to do |format|
       format.js
@@ -41,7 +50,7 @@ class <%= controller_class_name %> < ApplicationController
   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%>)
+    modified_params = modify_date_inputs_on_params(<%=singular_name %>_params.dup<% if !create_merge_params.empty? %>.merge!(<%= create_merge_params %>)<% end %> <%= @auth ? ",#{@auth}" : "" %>)
     @<%=singular_name %> = <%=class_name %>.create(modified_params)
     respond_to do |format|
       if @<%= singular_name %>.save
@@ -50,7 +59,7 @@ class <%= controller_class_name %> < ApplicationController
       end
       format.js
     end
-  end
+  end<% end %>
 
   def show
     respond_to do |format|
@@ -66,14 +75,14 @@ class <%= controller_class_name %> < ApplicationController
 
   def update
     respond_to do |format|
-      if !@<%=singular_name %>.update(modify_date_inputs_on_params(<%= singular %>_params, <%=@auth%> ))
+      if !@<%=singular_name %>.update(modify_date_inputs_on_params(<%= singular %>_params, <%= @auth ? @auth : "nil" %>  ))
         flash[:alert] = "<%=singular_name.titlecase %> could not be saved"
       end
       format.js {}
     end
   end
 
-  def destroy
+<% if destroy_action %>def destroy
     respond_to do |format|
       begin
         @<%=singular_name%>.destroy
@@ -82,7 +91,7 @@ class <%= controller_class_name %> < ApplicationController
       end
       format.js {}
     end
-  end
+  end<% end %>
 
   def <%=singular_name%>_params
     params.require(:<%=singular_name%>).permit( <%= @columns %> )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: common_core_js
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.8
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
@@ -131,6 +131,7 @@ files:
 - ".generators"
 - ".gitignore"
 - ".rakeTasks"
+- FUNDING.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -142,7 +143,8 @@ files:
 - app/assets/stylesheets/common_core_js/application.css
 - app/assets/stylesheets/common_core_js/common_core.scss
 - app/controllers/common_core_js/application_controller.rb
-- app/helpers/common_core_js/application_helper.rb
+- app/helpers/common_core_helper.rb
+- app/helpers/common_core_js/controller_helper.rb
 - app/jobs/common_core_js/application_job.rb
 - app/mailers/common_core_js/application_mailer.rb
 - app/models/common_core_js/application_record.rb
@@ -176,6 +178,7 @@ files:
 - lib/generators/common_core/templates/_list.haml
 - lib/generators/common_core/templates/_new.haml
 - lib/generators/common_core/templates/all.haml
+- lib/generators/common_core/templates/base_controller.rb
 - lib/generators/common_core/templates/common_core.js
 - lib/generators/common_core/templates/common_core.scss
 - lib/generators/common_core/templates/controller.rb