base_editing_bootstrap 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f75c92251f46045d20902120b1796ad0804dbfd632b0ddd77669a6f4f7ab35c
-  data.tar.gz: 9e87df84d2fc30d8f981095cc3304479c1629b25cf0daa14746a78d83dba5245
+  metadata.gz: 5b1619def3100d40ea9c0af463dae74782d4a1a66b6b01fd823fb8a6fb4a7be0
+  data.tar.gz: 81fb33920d91b1273f7055f6522552de71c0cb0098bae8b9af2e896fcbd21695
 SHA512:
-  metadata.gz: 3ded9cc6fbff9ae4515f98530596a444f3b18760dc5677b0ae9f5c9b96056287d08500f5a691fb2bcf926709151e79d7af7d4da235dbcd129aa7db4d3d4f520d
-  data.tar.gz: 6d22f81c4ecf3db3a7413f0fa42ac35b01ffa1e36a570d9cbc412e5daa5a49c9abc3659f63613e7c194cac8b3a417b52de0e5dc2d243799b7faf9dfc5d255213
+  metadata.gz: a22d5a35dfc17ff26c47373ee4815d8706f53dcf164f6fb9701c5855bfaa83b99f20be9e9e62c94f6acbcb6df36076b38d53a2d6589e6837271a7a4169daae3a
+  data.tar.gz: dacc99dbc960c9e98170ce249238343036fdae23d7de23c4c439d3b0c80765168f6d0ad27a9de47b707663a130d865d5fd04100186f5440ca6573b3f28221aef

data/CHANGELOG.md

@@ -2,6 +2,34 @@
 All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
 - - -
+## 0.8.0 - 2024-06-12
+#### Documentation
+- Update Documentation - (1c7c723) - Marino Bonetti
+#### Features
+- Scaffolding - (34c203c) - Marino Bonetti
+#### Miscellaneous Chores
+- Remove useless configuration - (30f862d) - Marino Bonetti
+- Remove useless configuration - (985af64) - Marino Bonetti
+- Add Ruby 3.3 - (ed35587) - Marino Bonetti
+- Remove unused file - (eceaa88) - Marino Bonetti
+- Fix gemspec info - (73bb7e4) - Marino Bonetti
+#### Tests
+- Restore Test - (0053349) - Marino Bonetti
+
+- - -
+
+## 0.7.0 - 2024-05-30
+#### Bug Fixes
+- Generators with enum - (7f25cac) - Marino Bonetti
+#### Features
+- Add Generator for cell field - (ab0210b) - Marino Bonetti
+- Add generator for form field override - (118b998) - Marino Bonetti
+- Add distinguishable classes per field - (2e5e797) - Marino Bonetti
+#### Tests
+- Add Tests to generator - (cd3f40a) - Marino Bonetti
+
+- - -
+
 ## 0.6.0 - 2024-05-29
 #### Bug Fixes
 - Add dependency in generator - (b911b1a) - Marino Bonetti

data/README.md

@@ -41,15 +41,8 @@ La versione più semplice è attraverso: https://github.com/rails/cssbundling-ra
 Una volta installato basta lanciare bin/rails css:install:bootstrap come da
 documentazione e avrete la vostra versione di boostrap installata.
 
-Installare `gem "factory_bot_rails"`,  
-Optional configurarlo correttamente in application.rb
-```ruby
-config.generators do |g|
-  g.test_framework :rspec
-  g.fixture_replacement :factory_bot
-  g.factory_bot dir: 'spec/factories'
-end
-```
+Installare `gem "factory_bot_rails"`
+
 ### Initializers
 E' possibile configurare BaseEditingBootstrap con alcune impostazioni:
 ```ruby
@@ -100,40 +93,35 @@ Utilizzo per modello base, in questo esempio prendiamo come modello Post come es
   ```ruby
   class PostPolicy < BaseModelPolicy
   
-  def editable_attributes
-  [
-  :title,
-  :description
-  ]
-  end
-  
-  def permitted_attributes
-  [
-  :title,
-  :description
-  ]
-  end
+    def editable_attributes
+      [
+      :title,
+      :description
+      ]
+    end
+    
+    def permitted_attributes
+      [
+      :title,
+      :description
+      ]
+    end
+    
+    def search_result_fields
+      [:title]
+    end
   
-  def search_result_fields
-  [:title]
-  end
   end
 
   ```
-- [OPTIONAL] nel caso si volesse fare override dei campi della form:  
-  Per il campo che si vuole fare override creare un nuovo file nella cartella 
-  del modello `app/views/posts/post/form_field/_NOME_CAMPO.html.erb`  
-  al cui interno renderizzare il campo come si preferisce:
-  ```erbruby
-    <%# locals: (form:, field:) -%>
-    <%= form.text_field(field) %>
+- [OPTIONAL] nel caso si volesse fare override dei campi della form chiamare il generatore:
+  ```shell
+  rails g base_editing_bootstrap:field_override ModelName field1 field2:type
   ```
 - [OPTIONAL] la medesima cosa è possibile fare con il rendering dei campi
-  delle celle della tabella della pagina index.  
-  La cartella da generare in questo caso sarà: `app/views/posts/post/cell_field/_NOME_CAMPO.html.erb`
-  ```erbruby
-  <%# locals: (obj:,field:)  -%>
-  <td><%= obj.read_attribute(field) %></td>
+  delle celle della tabella
+  ```shell
+  rails g base_editing_bootstrap:cell_override ModelName field1 field2:type
   ```
 - [OPTIONAL] Base overrides:  
   E' possibile anche fare un override generico dei campi, sono previsti questi tipi di partial

data/app/helpers/utilities/search_helper.rb

@@ -60,33 +60,6 @@ module Utilities
       end
     end
 
-    def search_result_buttons(rec)
-      btns = ActiveSupport::SafeBuffer.new
-
-      if policy(rec).edit?
-        btns << link_to(icon("pencil-square"),
-                        edit_custom_polymorphic_path(rec),
-                        class: "btn btn-sm btn-primary me-1")
-      end
-
-      if policy(rec).show?
-        btns << link_to(icon(:eye),
-                        show_custom_polymorphic_path(rec),
-                        class: "btn btn-sm btn-primary me-1")
-      end
-
-      if policy(rec).destroy?
-        btns << link_to(icon(:trash),
-                        destroy_custom_polymorphic_path(rec),
-                        data: {
-                          turbo_method: :delete,
-                          turbo_confirm: t("are_you_sure")
-                        },
-                        class: "btn btn-sm btn-danger me-1")
-      end
-      btns
-    end
-
     ##
     # Possibile override dei parametri da passare a ransack nella form
     def search_form_for_params(ransack_instance)
@@ -100,11 +73,22 @@ Abbiamo migrato ad un sistema di rendering tramite views,
 è stato lasciato come memo per una migrazione semplificata
 nel caso si voglia renderizzare un determinato campo in modo differente dal normale dato del DB
 creare nalla path del modello la cartella cell_field e creare al suo interno il file con il nome
-del _campo.html.erb e quindi inserire li il rendering (ES modello User, campo :name):
+del _campo.html.erb e quindi inserire lì il rendering (ES modello User, campo :name):
 app/views/users/user/cell_field/_campo.html.erb
 ```
 <%# locals: (obj:,field:)  -%>
 <td><%= obj.name.upcase %></td>
 ```
+
+Altrimenti in modo semplificato basta lanciare il generatore:
+```
+rails g base_editing_bootstrap:cell_override ClasseModello nome_campo
+```
+MESSAGE
+)
+
+BaseEditingBootstrap.deprecator.deprecate_methods(Utilities::SearchHelper, search_result_buttons: <<-MESSAGE
+Come per il raw field, anche i bottoni sono stati spostati nelle viste.
+Sovrascrivi la vista _search_result_buttons.html.erb
 MESSAGE
 )

data/app/views/base_editing/_form_field.html.erb

@@ -1,5 +1,5 @@
-<%= form.label(form_field, class: "form-label") %>
-<div class="input-group mb-2 <%= form.object.validated? ? "has-validation" : "" %>">
+<%= form.label(form_field, class:  ["form-label","form-#{form_field}-label"]) %>
+<div class="input-group mb-2 <%= form.object.validated? ? "has-validation" : "" %><%= "form-#{form_field}-input-group" %>">
   <%= render partial: "editing_form_measure_unit", locals: {object: form.object, field: form_field} %>
   <%= form_print_field(form, form_field) %>
   <%= error_messages_for(form.object, form_field) %>

data/app/views/base_editing/_search_result_buttons.html.erb

@@ -0,0 +1,18 @@
+<%# locals: (obj:) -%>
+<%= link_to(icon("pencil-square"),
+            edit_custom_polymorphic_path(obj),
+            class: "btn btn-sm btn-primary me-1") if policy(obj).edit? %>
+
+
+<%= link_to(icon(:eye),
+            show_custom_polymorphic_path(obj),
+            class: "btn btn-sm btn-primary me-1") if policy(obj).show? %>
+
+
+<%= link_to(icon(:trash),
+            destroy_custom_polymorphic_path(obj),
+            data: {
+              turbo_method: :delete,
+              turbo_confirm: t("are_you_sure")
+            },
+            class: "btn btn-sm btn-danger me-1") if policy(obj).destroy? %>

data/app/views/base_editing/_search_result_row.html.erb

@@ -3,6 +3,6 @@
     <%= render_cell_field(obj, srf) %>
   <% end %>
   <td>
-    <%= search_result_buttons(obj) %>
+    <%= render partial: "search_result_buttons", locals: {obj:} %>
   </td>
 </tr>

data/base_editing_bootstrap.gemspec

@@ -11,8 +11,7 @@ Gem::Specification.new do |spec|
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.1"
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/oniram88/BaseEditingBootstrap"
+  spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "https://github.com/oniram88/BaseEditingBootstrap/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
@@ -48,7 +47,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rails-i18n', '~> 7.0' # For 7.0.0
   spec.add_development_dependency "i18n-debug", '~> 1.2'
   spec.add_development_dependency "cssbundling-rails", '~> 1.4'
-  spec.add_development_dependency "rspec-parameterized", ">= 1.0.0" # https://github.com/tomykaira/rspec-parameterized
+  spec.add_development_dependency "rspec-parameterized", "~> 1.0", ">= 1.0.0" # https://github.com/tomykaira/rspec-parameterized
   spec.add_development_dependency 'rspec-html-matchers', '~> 0.10' # https://github.com/kucaahbe/rspec-html-matchers
   spec.add_development_dependency 'rails-controller-testing', '~>1.0'
 

data/lib/base_editing_bootstrap/VERSION

@@ -1 +1 @@
-0.6.0
+0.8.0

data/lib/base_editing_bootstrap/engine.rb

@@ -1,12 +1,6 @@
 module BaseEditingBootstrap
   class Engine < ::Rails::Engine
 
-    config.generators do |g|
-      g.test_framework :rspec
-      g.fixture_replacement :factory_bot
-      g.factory_bot dir: 'spec/factories'
-    end
-
     initializer "base_editing_bootstrap.deprecator" do |app|
       app.deprecators[:base_editing_bootstrap] = BaseEditingBootstrap.deprecator
     end

data/lib/generators/base_editing_bootstrap/cell_override/cell_override_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BaseEditingBootstrap
+  module Generators
+    class CellOverrideGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views/base_editing", __dir__)
+      argument :name, type: :string, banner: "Post", required: true
+      argument :attributes, type: :array, default: [], banner: "field field:type"
+
+      TYPES = [:base,:timestamps].freeze
+
+      desc <<-DESCRIPTION.strip_heredoc
+             Description:   
+                Copy partial files for a defined cell, 
+                the possible types are #{TYPES}
+                Default to base
+      DESCRIPTION
+
+      def copy_form_partials
+        if attributes.empty?
+          say "Need one field"
+        else
+          singular_name = name.underscore.downcase.singularize
+          plural_name = singular_name.pluralize
+          attributes.each do |a|
+            attr_name, type = a.split(":")
+
+            type = :base if type.nil?
+            type = type.to_sym
+            raise "Type #{type} not found in #{TYPES}" unless TYPES.include?(type)
+            copy_file "cell_field/_#{type}.html.erb", File.join("app/views", plural_name, singular_name, 'cell_field', "_#{attr_name}.html.erb")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/base_editing_bootstrap/field_override/field_override_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BaseEditingBootstrap
+  module Generators
+    class FieldOverrideGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../../../app/views/base_editing", __dir__)
+      argument :name, type: :string, banner: "Post", required: true
+      argument :attributes, type: :array, default: [], banner: "field field:type"
+
+      TYPES = %i[base date datetime decimal integer enum]
+
+      desc <<-DESCRIPTION.strip_heredoc
+             Description:   
+                Copy partial files for a defined fields, 
+                the possible types are #{TYPES}
+                Default to base
+      DESCRIPTION
+
+      def copy_form_partials
+        if attributes.empty?
+          say "Need one field"
+        else
+          singular_name = name.underscore.downcase.singularize
+          plural_name = singular_name.pluralize
+          attributes.each do |a|
+            attr_name, type = a.split(":")
+
+            type = :base if type.nil?
+            type = type.to_sym
+            raise "Type #{type} not found in #{TYPES}" unless TYPES.include?(type)
+            copy_file "form_field/_#{type}.html.erb", File.join("app/views", plural_name, singular_name, 'form_field', "_#{attr_name}.html.erb")
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/generators/base_editing_bootstrap/install/install_generator.rb

@@ -18,14 +18,7 @@ module BaseEditingBootstrap
 
       def prepare_test_environment
         gem "factory_bot_rails", group: :test, version: '~> 6.4', comment: "Necessary for spec"
-        gem 'rails-controller-testing',group: :test,comment:"Required if used with controllers spec"
-        inject_into_class "config/application.rb", "Application", <<~RUBY
-          config.generators do |g|
-            g.test_framework :rspec
-            g.fixture_replacement :factory_bot
-            g.factory_bot dir: 'spec/factories'
-          end
-        RUBY
+        gem 'rails-controller-testing', group: :test, comment: "Required if used with controllers spec"
       end
     end
   end

data/lib/generators/base_editing_bootstrap/scaffold/scaffold_generator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module BaseEditingBootstrap
+  module Generators
+    class ScaffoldGenerator < ::Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path("templates", __dir__)
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      invoke :model
+
+      def add_base_model
+        inject_into_class "app/models/#{model_resource_name}.rb", class_name do
+          "  include BaseEditingBootstrap::BaseModel\n"
+        end
+
+        template "spec/model.rb", File.join("spec/models", "#{singular_name}_spec.rb")
+      end
+
+      def add_controller
+        opts = ["--no-helper", "--parent=BaseEditingController"]
+        opts << "--force" if options.force?
+        generate "controller", controller_class_name, *opts
+
+        route "resources :#{plural_name}"
+
+        template "spec/request.rb", File.join("spec/requests", "#{plural_file_name}_spec.rb")
+
+      end
+
+      def add_policy
+        @search_attrs = []
+        if yes? "Vuoi poter ricercare determinati campi con form di ricerca?"
+
+          say "Gli attributi che hai indicato sono: #{ attributes_names.join(",")}"
+          say <<~MESSAGE
+            La ricerca avviene tramite le logiche di ransack.
+            Puoi trovare la documentazione dei predicati di ricerca qua: 
+            https://activerecord-hackery.github.io/ransack/getting-started/search-matches/
+            Ecco alcuni esempi di possibili modi di ricercare:
+          MESSAGE
+
+          matchers = {
+            "_eq":"Equal",
+            "_not_eq":"Not equal",
+            "_i_cont":"Contains insensitive",
+          }
+
+          out =  [["",*matchers.values]]
+          attributes_names.each do |attr|
+            out << [attr, *matchers.keys.collect{|m| "#{attr}#{m}"  } ]
+          end
+
+          puts out.inspect
+
+          print_table(out,borders:true)
+          @search_attrs = ask("Inserisce un elenco diviso da virgola degli attributi da ricercare").split(",")
+
+        end
+
+        template "policy.rb", File.join("app/policies", "#{singular_name}_policy.rb")
+        template "spec/policy.rb", File.join("spec/policies", "#{singular_name}_policy_spec.rb")
+
+      end
+
+
+    end
+  end
+end

data/lib/generators/base_editing_bootstrap/scaffold/templates/policy.rb.tt

@@ -0,0 +1,11 @@
+class <%= class_name %>Policy < BaseModelPolicy
+
+  def editable_attributes = %w[<%= attributes_names.join(" ") %>]
+  def permitted_attributes = %w[<%= attributes_names.join(" ") %>]
+  def search_result_fields = %w[<%= attributes_names.join(" ") %>]
+<%- if @search_attrs.any? -%>
+  def search_fields
+    %i[<%= @search_attrs.join(" ") %>]
+  end
+<%- end -%>
+end

data/lib/generators/base_editing_bootstrap/scaffold/templates/spec/model.rb.tt

@@ -0,0 +1,6 @@
+require 'rails_helper'
+RSpec.describe <%= class_name %>, type: :model do
+  it_behaves_like "a base model",
+                  ransack_permitted_attributes: %w[<%= attributes_names.join(" ") %>],
+                  ransack_permitted_associations: []
+end

data/lib/generators/base_editing_bootstrap/scaffold/templates/spec/policy.rb.tt

@@ -0,0 +1,5 @@
+require 'rails_helper'
+RSpec.describe <%= class_name %>Policy, type: :policy do
+    it_behaves_like "a standard base model policy", :<%=singular_name %>
+
+end

data/lib/generators/base_editing_bootstrap/scaffold/templates/spec/request.rb.tt

@@ -0,0 +1,6 @@
+require 'rails_helper'
+RSpec.describe "<%= controller_class_name %>", type: :request do
+  it_behaves_like "as logged in user" do
+    it_behaves_like "base editing controller", factory: :<%= singular_name %>
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: base_editing_bootstrap
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Marino Bonetti
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -234,6 +234,9 @@ dependencies:
   name: rspec-parameterized
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -241,6 +244,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
@@ -320,6 +326,7 @@ files:
 - app/views/base_editing/_search_field.erb
 - app/views/base_editing/_search_footer.html.erb
 - app/views/base_editing/_search_result.html.erb
+- app/views/base_editing/_search_result_buttons.html.erb
 - app/views/base_editing/_search_result_row.html.erb
 - app/views/base_editing/_tabs.html.erb
 - app/views/base_editing/cell_field/_base.html.erb
@@ -354,9 +361,16 @@ files:
 - lib/base_editing_bootstrap/searches/base.rb
 - lib/base_editing_bootstrap/searches/field.rb
 - lib/base_editing_bootstrap/version.rb
+- lib/generators/base_editing_bootstrap/cell_override/cell_override_generator.rb
+- lib/generators/base_editing_bootstrap/field_override/field_override_generator.rb
 - lib/generators/base_editing_bootstrap/install/USAGE
 - lib/generators/base_editing_bootstrap/install/install_generator.rb
 - lib/generators/base_editing_bootstrap/install/templates/initializer.rb
+- lib/generators/base_editing_bootstrap/scaffold/scaffold_generator.rb
+- lib/generators/base_editing_bootstrap/scaffold/templates/policy.rb.tt
+- lib/generators/base_editing_bootstrap/scaffold/templates/spec/model.rb.tt
+- lib/generators/base_editing_bootstrap/scaffold/templates/spec/policy.rb.tt
+- lib/generators/base_editing_bootstrap/scaffold/templates/spec/request.rb.tt
 - lib/tasks/base_editing_bootstrap_tasks.rake
 - spec/support/external_shared/base_editing_controller_helpers.rb
 - spec/support/external_shared/base_model.rb
@@ -366,7 +380,6 @@ homepage: https://github.com/oniram88/BaseEditingBootstrap
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/oniram88/BaseEditingBootstrap
   source_code_uri: https://github.com/oniram88/BaseEditingBootstrap
   changelog_uri: https://github.com/oniram88/BaseEditingBootstrap/blob/main/CHANGELOG.md
 post_install_message: