hot-glue 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d747beed420f47b73a42783e6ae92edd8f4508b13c471a7ae7747a1a7eddfe58
-  data.tar.gz: 9feb6afe2493e46d7e4eef0db0c836f3d140e33c20555c5f07e7fbc896fef366
+  metadata.gz: ae1088aa0a809a10fb6332fa7ca062e1af6aa39a1c8541dabdf4d8451c5ba04d
+  data.tar.gz: a3ff6d5d8a171e1d1d361df692f6255f855720609e692c21573d6311fbeb41e2
 SHA512:
-  metadata.gz: cf3dcb49cf4a37919269ff3812d00668e2739830c6f01b1f3cc86a01abc78c3278214bb27e3c3935cf60e640460482c8b79bc1127263790e349bf82f3ea4b443
-  data.tar.gz: 7b9576bb6ee658ffb2c05cc7a5f0c77383e70964c174e361d993c5f6f4162b94be69452fceed1fdd1988d8876b43c14c7f16b95d564136b9167604e75ee3a287
+  metadata.gz: f65f042a47123cb7a7f69222ddf6618ca085f8cb38bf372179f3bb3da6e47fb07cb383ecba4e0c22642d775db004c0ab111fc99667f575fde62869f7d4c4efba
+  data.tar.gz: e6c36f5bb8a516ee2e74250000174eede61f39c38c46fb74ac963cfa958ac2c5ba2bd3323832b1359ef452e532b7e01b24e04ff68bb67b28df781ccf04e958a4

data/README.md

@@ -35,11 +35,15 @@ rails generate hot_glue:scaffold Thing
 
 ## TO INSTALL
 
-- Add Turbo-Rails to your Gemfile & bundle install, then install it with `rails turbo:install`
+- Add Turbo-Rails to your Gemfile & bundle install 
+  
+- Then install it with `rails turbo:install`
 
 - The Turbo install has switched your action cable settings from 'async' to Redis, so be sure to start a redis server
   
-- Add hot_glue to your Gemfile & bundle install, then install it with `rails generate hot_glue:install`
+- Add `hot_glue` to your Gemfile & `bundle install`
+  
+- Then install it with `rails generate hot_glue:install`
 
 - Add to your `application.html.erb`
 ```
@@ -67,6 +71,7 @@ Bootstrap with Sprockets:
 
 - Install Devise or implement your own authentication
 
+- Also recommended: font-awesome-sass
 
 
 ### First Argument
@@ -225,7 +230,7 @@ Please note that this example would product non-functional code, so you would ne
 
 ### `--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)
+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 which is non-standard for Rails)
 
 
 ### `--exclude=`
@@ -249,13 +254,22 @@ You may not specify both include and exclude. If you specify an include list, it
 `rails generate hot_glue:scaffold Account --include=first_name,last_name,company_name,created_at,kyc_verified_at`
 
 
+### `--show-only=`
+(separate field names by COMMA)
+
+Any fields only the 'show-only' list will appear as non-editable on the generate form. (visible only)
+
+IMPORTANT: By default, all fields that begin with an underscore (`_`) are automatically show-only.
+
+I would recommend this for fields you want globally non-editable by users in your app. For example, a counter cache or other field set only by a backend mechanism.
+
 ### `--god` or `--gd`
 
 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 controller.
 
 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)
+In Gd mode, the objects are loaded directly from the base class (these controllers have full access)
 ```
 def load_thing
     @thing = Thing.find(params[:id])
@@ -295,8 +309,12 @@ If you do not want inline editing of your list items but instead to fall back to
 
 
 
+
+
 # VERSION HISTORY
 
+#### 2021-03-21 - v0.0.8 - show only flag; more specific spec coverage in generator spec
+
 #### 2021-03-20 - v0.0.7 - adds lots of spec coverage; cleans up generated cruft code on each run;  adds no-delete, no-create; a working --big-edit with basic data-turbo false to disable inline editing
 
 #### 2021-03-06 - v0.0.6 - internal specs test the error catches and cover basic code generation (dummy testing only)

data/lib/generators/hot_glue/scaffold_generator.rb

@@ -61,6 +61,7 @@ module HotGlue
     class_option :no_create, type: :boolean, default: false
     class_option :no_paginate, type: :boolean, default: false
     class_option :big_edit, type: :boolean, default: false
+    class_option :show_only, type: :string, default: ""
 
     def initialize(*meta_args) #:nodoc:
       super
@@ -88,10 +89,17 @@ module HotGlue
       @exclude_fields = []
       @exclude_fields += options['exclude'].split(",").collect(&:to_sym)
 
-      if options['include']
+      if !options['include'].empty?
         @include_fields = []
         @include_fields += options['include'].split(",").collect(&:to_sym)
       end
+
+
+      @show_only = []
+      if !options['show_only'].empty?
+        @show_only += options['show_only'].split(",").collect(&:to_sym)
+      end
+
       auth_assoc = @auth.gsub("current_","")
 
       @god = options['god'] || options['gd'] || false
@@ -155,7 +163,6 @@ module HotGlue
         end
       end
 
-
       if !@include_fields
         @exclude_fields.push :id, :created_at, :updated_at, :encrypted_password,
                              :reset_password_token,
@@ -174,9 +181,11 @@ module HotGlue
 
       end
 
-
-
       @columns.each do |col|
+        if col.to_s.starts_with?("_")
+          @show_only << col
+        end
+
         if object.columns_hash[col.to_s].type == :integer
           if col.to_s.ends_with?("_id")
             # guess the association name label
@@ -199,15 +208,15 @@ module HotGlue
             end
 
             assoc_class = eval(assoc.class_name)
-            if assoc_class.column_names.include?("name")
+            if assoc_class.respond_to?(:name)
               # display_column = "name"
-            elsif assoc_class.column_names.include?("to_label")
+            elsif assoc_class.respond_to?(:to_label)
               # display_column = "to_label"
-            elsif assoc_class.column_names.include?("full_name")
+            elsif assoc_class.respond_to?(:full_name)
               # display_column = "full_name"
-            elsif assoc_class.column_names.include?("display_name")
+            elsif assoc_class.respond_to?(:display_name)
               # display_column = "display_name"
-            elsif assoc_class.column_names.include?("email")
+            elsif assoc_class.respond_to?(:email)
               # display_column = "email"
             else
               exit_message= "*** Oops: Can't find any column to use as the display label for the #{assoc.name.to_s} association on the #{singular_class} model . TODO: Please implement just one of: 1) name, 2) to_label, 3) full_name, 4) display_name, or 5) email directly on your #{assoc.class_name} model (either as database field or model methods), then RERUN THIS GENERATOR. (If more than one is implemented, the field to use will be chosen based on the rank here, e.g., if name is present it will be used; if not, I will look for a to_label, etc)"
@@ -504,6 +513,16 @@ module HotGlue
       col_spaces_prepend = "    "
 
       res = @columns.map { |col|
+
+        if @show_only.include?(col)
+
+          "#{col_identifier}{class: \"form-group \#{'alert-danger' if #{singular}.errors.details.keys.include?(:#{col.to_s})}\"}
+    = @#{singular}.#{col.to_s}
+    %label.form-text
+      #{col.to_s.humanize}\n"
+        else
+
+
         type = eval("#{singular_class}.columns_hash['#{col}']").type
         limit = eval("#{singular_class}.columns_hash['#{col}']").limit
         sql_type = eval("#{singular_class}.columns_hash['#{col}']").sql_type
@@ -512,28 +531,25 @@ module HotGlue
         when :integer
           # look for a belongs_to on this object
           if col.to_s.ends_with?("_id")
-            # # guess the association name label
-            #
-            #
-            # assoc_name = col.to_s.gsub("_id","")
-            # assoc = eval("#{singular_class}.reflect_on_association(:#{assoc_name})")
-            # if assoc.nil?
-            #   exit_message= "*** Oops. on the #{singular_class} object, there doesn't seem to be an association called '#{assoc_name}'"
-            #   exit
-            # end
+            assoc_name = col.to_s.gsub("_id","")
+            assoc = eval("#{singular_class}.reflect_on_association(:#{assoc_name})")
+            if assoc.nil?
+              exit_message= "*** Oops. on the #{singular_class} object, there doesn't seem to be an association called '#{assoc_name}'"
+              exit
+            end
 
 
             assoc_class = eval(assoc.class_name)
 
-            if assoc_class.column_names.include?("name")
+            if assoc_class.respond_to?("name")
               display_column = "name"
-            elsif assoc_class.column_names.include?("to_label")
+            elsif assoc_class.respond_to?("to_label")
               display_column = "to_label"
-            elsif assoc_class.column_names.include?("full_name")
+            elsif assoc_class.respond_to?("full_name")
               display_column = "full_name"
-            elsif assoc_class.column_names.include?("display_name")
+            elsif assoc_class.respond_to?("display_name")
               display_column = "display_name"
-            elsif assoc_class.column_names.include?("email")
+            elsif assoc_class.respond_to?("email")
               display_column = "email"
             else
               raise("this should have been caught by the checker in the initializer")
@@ -591,7 +607,7 @@ module HotGlue
 #{col_spaces_prepend}= f.label(:#{col.to_s}, value: 'Yes', for: '#{singular}_#{col.to_s}_1')
       "
         end
-
+        end
       }.join("\n")
       return res
     end
@@ -624,17 +640,17 @@ module HotGlue
             
             assoc_class = eval(assoc.class_name)
 
-            if assoc_class.column_names.include?("name")
+            if assoc_class.respond_to?("name")
               display_column = "name"
-            elsif assoc_class.column_names.include?("to_label")
+            elsif assoc_class.respond_to?("to_label")
               display_column = "to_label"
-            elsif assoc_class.column_names.include?("full_name")
+            elsif assoc_class.respond_to?("full_name")
               display_column = "full_name"
-            elsif assoc_class.column_names.include?("display_name")
+            elsif assoc_class.respond_to?("display_name")
               display_column = "display_name"
-            elsif assoc_class.column_names.include?("email")
+            elsif assoc_class.respond_to?("email")
               display_column = "email"
-            elsif assoc_class.column_names.include?("number")
+            elsif assoc_class.respond_to?("number")
               display_column = "number"
 
             else

data/lib/hotglue/version.rb

@@ -1,3 +1,3 @@
 module HotGlue
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hot-glue
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Jason Fleetwood-Boldt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-20 00:00:00.000000000 Z
+date: 2021-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails