abyme 0.5.1 → 0.6.0

data/lib/abyme/version.rb

@@ -2,8 +2,8 @@
 module Abyme
   module VERSION
     MAJOR = 0
-    MINOR = 5
-    PATCH = 1
+    MINOR = 6
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/abyme/view_helpers.rb

@@ -2,7 +2,6 @@ require_relative "abyme_builder"
 
 module Abyme
   module ViewHelpers
-
     # ABYME_FOR
 
     # this helper will generate the top level wrapper markup
@@ -23,7 +22,7 @@ module Abyme
     # set the default number of blank fields to display
 
     # - partial (String)
-    # to customize the partial path by default #abyme_for will expect 
+    # to customize the partial path by default #abyme_for will expect
     # a partial to bbe present in views/abyme
 
     # - Exemple
@@ -39,22 +38,24 @@ module Abyme
     # </div>
 
     def abyme_for(association, form, options = {}, &block)
-      content_tag(:div, data: { controller: 'abyme', limit: options[:limit], min_count: options[:min_count] }, id: "abyme--#{association}") do
-        if block_given?
-          yield(Abyme::AbymeBuilder.new(
-            association: association, form: form, context: self, partial: options[:partial]
+      content_tag(:div, data: {controller: "abyme", limit: options[:limit], min_count: options[:min_count]}, id: "abyme--#{association}") do
+        if block
+          yield(
+            Abyme::AbymeBuilder.new(
+              association: association, form: form, context: self, partial: options[:partial]
             )
           )
         else
-          model = association.to_s.singularize.classify.constantize
+          # model = association.to_s.singularize.classify.constantize
+          model = association.to_s.singularize
           concat(persisted_records_for(association, form, options))
-          concat(new_records_for(association, form, options)) 
+          concat(new_records_for(association, form, options))
           concat(add_associated_record(content: options[:button_text] || "Add #{model}"))
         end
       end
     end
 
-    alias :abymize :abyme_for
+    alias_method :abymize, :abyme_for
 
     # NEW_RECORDS_FOR
 
@@ -72,9 +73,9 @@ module Abyme
     # will output this html
 
     # <div data-target="abyme.associations" data-association="tasks" data-abyme-position="end">
-    #    <template class="abyme--task_template" data-target="abyme.template"> 
+    #    <template class="abyme--task_template" data-target="abyme.template">
     #       <div data-target="abyme.fields abyme.newFields" class="abyme--fields task-fields">
-    #         ... partial html goes here 
+    #         ... partial html goes here
     #       </div>
     #    </template>
     #    ... new rendered fields goes here
@@ -82,41 +83,41 @@ module Abyme
 
     # == Options
     # - position (:start, :end)
-    # allows you to specify whether new fields added dynamically 
-    # should go at the top or at the bottom 
+    # allows you to specify whether new fields added dynamically
+    # should go at the top or at the bottom
     # :end is the default value
 
     # - partial (String)
-    # to customize the partial path by default #abyme_for will expect 
+    # to customize the partial path by default #abyme_for will expect
     # a partial to bbe present in views/abyme
 
     # - fields_html (Hash)
     # allows you to pass any html attributes to each fields wrapper
 
     # - wrapper_html (Hash)
-    # allows you to pass any html attributes to the the html element 
+    # allows you to pass any html attributes to the the html element
     # wrapping all the fields
 
     def new_records_for(association, form, options = {}, &block)
       options[:wrapper_html] ||= {}
 
-      wrapper_default = { 
-        data: { 
-          abyme_target: 'associations', 
-          association: association, 
-          abyme_position: options[:position] || :end 
-        } 
+      wrapper_default = {
+        data: {
+          abyme_target: "associations",
+          association: association,
+          abyme_position: options[:position] || :end
+        }
       }
 
-      fields_default = { data: { target: 'abyme.fields abyme.newFields' } }
+      fields_default = {data: {target: "abyme.fields abyme.newFields"}}
 
       content_tag(:div, build_attributes(wrapper_default, options[:wrapper_html])) do
-        content_tag(:template, class: "abyme--#{association.to_s.singularize}_template", data: { abyme_target: 'template' }) do
-          form.fields_for association, association.to_s.classify.constantize.new, child_index: 'NEW_RECORD' do |f|
+        content_tag(:template, class: "abyme--#{association.to_s.singularize}_template", data: {abyme_target: "template"}) do
+          form.fields_for association, association.to_s.classify.constantize.new, child_index: "NEW_RECORD" do |f|
             content_tag(:div, build_attributes(fields_default, basic_fields_markup(options[:fields_html], association))) do
               # Here, if a block is passed, we're passing the association fields to it, rather than the form itself
               # block_given? ? yield(f) : render(options[:partial] || "abyme/#{association.to_s.singularize}_fields", f: f)
-              block_given? ? yield(f) : render_association_partial(association, f, options[:partial])
+              block ? yield(f) : render_association_partial(association, f, options[:partial])
             end
           end
         end
@@ -154,21 +155,23 @@ module Abyme
     # ex: order: { created_at: :desc }
 
     # - partial (String)
-    # to customize the partial path by default #abyme_for will expect 
+    # to customize the partial path by default #abyme_for will expect
     # a partial to bbe present in views/abyme
 
     # - fields_html (Hash)
     # allows you to pass any html attributes to each fields wrapper
 
     # - wrapper_html (Hash)
-    # allows you to pass any html attributes to the the html element 
+    # allows you to pass any html attributes to the the html element
     # wrapping all the fields
-  
+
     def persisted_records_for(association, form, options = {})
       records = options[:collection] || form.object.send(association)
+      # return if records.empty?
+
       options[:wrapper_html] ||= {}
-      fields_default = { data: { abyme_target: 'fields' } }
-      
+      fields_default = {data: {abyme_target: "fields"}}
+
       if options[:order].present?
         records = records.order(options[:order])
         # by calling the order method on the AR collection
@@ -176,8 +179,8 @@ module Abyme
         # so we have to get them back with the 2 lines below
         invalids = form.object.send(association).reject(&:persisted?)
         records = records.to_a.concat(invalids) if invalids.any?
-      end 
-      
+      end
+
       content_tag(:div, options[:wrapper_html]) do
         form.fields_for(association, records) do |f|
           content_tag(:div, build_attributes(fields_default, basic_fields_markup(options[:fields_html], association))) do
@@ -189,24 +192,24 @@ module Abyme
 
     # ADD & REMOVE ASSOCIATION
 
-    # these helpers will call the #create_button method 
+    # these helpers will call the #create_button method
     # to generate the buttons for add and remove associations
     # with the right action and a default content text for each button
-  
+
     def add_associated_record(options = {}, &block)
-      action = 'click->abyme#add_association'
-      options[:content] ||= 'Add Association'
+      action = "click->abyme#add_association"
+      options[:content] ||= "Add Association"
       create_button(action, options, &block)
     end
-  
+
     def remove_associated_record(options = {}, &block)
-      action = 'click->abyme#remove_association'
-      options[:content] ||= 'Remove Association'
+      action = "click->abyme#remove_association"
+      options[:content] ||= "Remove Association"
       create_button(action, options, &block)
     end
 
-    alias :add_association    :add_associated_record 
-    alias :remove_association :remove_associated_record
+    alias_method :add_association, :add_associated_record
+    alias_method :remove_association, :remove_associated_record
 
     private
 
@@ -225,17 +228,17 @@ module Abyme
 
     # - html (Hash)
     # to pass any html attributes you want.
-  
+
     def create_button(action, options, &block)
       options[:html] ||= {}
       options[:tag] ||= :button
-  
-      if block_given?
-        content_tag(options[:tag], { data: { action: action } }.merge(options[:html])) do
+
+      if block
+        content_tag(options[:tag], {data: {action: action}}.merge(options[:html])) do
           capture(&block)
         end
       else
-        content_tag(options[:tag], options[:content], { data: { action: action } }.merge(options[:html]))
+        content_tag(options[:tag], options[:content], {data: {action: action}}.merge(options[:html]))
       end
     end
 
@@ -246,7 +249,7 @@ module Abyme
 
     def basic_fields_markup(html, association = nil)
       if html && html[:class]
-        html[:class] = "abyme--fields #{association.to_s.singularize}-fields #{html[:class]}" 
+        html[:class] = "abyme--fields #{association.to_s.singularize}-fields #{html[:class]}"
       else
         html ||= {}
         html[:class] = "abyme--fields #{association.to_s.singularize}-fields"
@@ -274,13 +277,12 @@ module Abyme
 
     # RENDER PARTIAL
 
-    # renders a partial based on the passed path, or will expect a partial to be found in the views/abyme directory. 
+    # renders a partial based on the passed path, or will expect a partial to be found in the views/abyme directory.
 
     def render_association_partial(association, form, partial = nil, context = nil)
-      partial_path = partial ||"abyme/#{association.to_s.singularize}_fields"
+      partial_path = partial || "abyme/#{association.to_s.singularize}_fields"
       context ||= self
       context.render(partial: partial_path, locals: {f: form})
     end
-
   end
-end
+end

data/lib/generators/abyme/controller/USAGE

@@ -0,0 +1,16 @@
+Description:
+    Injects the call to the `abyme_attributes` in the strong params definition of the targeted controller.
+    Also works with namespaced controllers.
+
+Example:
+    Before :
+    def project_params
+        params.require(:project).permit(:title, :description)
+    end
+
+    rails generate abyme:controller Projects
+
+    After:
+    def project_params
+        params.require(:project).permit(abyme_attributes, :title, :description)
+    end

data/lib/generators/abyme/controller/controller_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators'
+
+module Abyme
+  module Generators
+    class ControllerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def insert_abyme_attributes_in_strong_params
+        return unless File.exists? controller_file_path
+
+        insert_into_file(
+          controller_file_path,
+          "abyme_attributes, ",
+          after: /^(\w|\s)*params\s*(.*)permit\(\s*/
+        )
+      end
+
+      private
+
+      def controller_file_path
+        Rails.root.join('app', 'controllers', "#{name.downcase.pluralize}_controller.rb")
+      end
+    end
+  end
+end

data/lib/generators/abyme/model/USAGE

@@ -0,0 +1,21 @@
+Description:
+	Generates configuration for the model part :
+	✅ Adds the `includes Abyme::Model` at the top
+	✅ Will add the call to `abymize` below the targeted association, including the optional permitted attributes
+	
+	💡 Works with namespaced models
+
+Example:
+	rails generate abyme:model project tasks description title
+	rails generate abyme:model project participants all
+
+	In project.rb, you will find :
+	class Project < ApplicationRecord
+			include Abyme::Model
+
+			has_many :tasks
+			abymize :tasks, permit: [:description, :title]
+
+			has_many :participants
+			abymize :participants, permit: :all_attributes
+	end

data/lib/generators/abyme/model/model_generator.rb

@@ -0,0 +1,70 @@
+require 'rails/generators'
+
+module Abyme
+  module Generators
+    class ModelGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :association, type: :string, required: true, banner: "association association"
+      argument :attributes, type: :array, default: [], banner: "field field"
+
+      def insert_abyme_config_in_model
+        insert_abyme_configuration unless model_configured?
+        insert_abymized_association
+      end
+
+      private
+
+      def insert_abymized_association
+        insert_into_file(model_file_path, after: /(^\s*(has_many|has_one|belongs_to)\s*:#{Regexp.quote(association)}.*$)/ ) do
+          "\n#{insert_indentation}abymize :#{association}#{inject_abyme_attributes}\n"
+        end
+      end
+
+      def insert_abyme_configuration
+        if namespaced_model
+          model = namespaced_model[2]
+          namespace = namespaced_model[1]
+          insert_into_file(model_file_path, after: /(^\s*class.*#{Regexp.quote(model)}.*$)/) do
+            "\n    include Abyme::Model\n"
+          end
+        else
+          inject_into_class(model_file_path, class_name, "  include Abyme::Model\n\n")
+        end
+      end
+
+      def assign_names!(name)
+        # Remove abyme namespace
+        name.gsub!(/abyme_/, "")
+        super
+      end
+
+      def namespaced_model
+        class_name.match(/(.*)[\/::](.*)/)
+      end
+
+      def model_file_path
+        Rails.root.join('app', 'models', "#{name}.rb")
+      end
+
+      def inject_abyme_attributes
+        return '' if attributes.empty?
+        return ", permit: :all_attributes" if attributes.map(&:name).include?('all_attributes')
+
+        ", permit: [#{symbolized_attributes.join(', ')}]"  
+      end
+      
+      def symbolized_attributes
+        attributes.map {|attr| ":#{attr.name.downcase}" }
+      end
+
+      def model_configured?
+        File.read(model_file_path).match?(/Abyme::Model/)
+      end
+
+      def insert_indentation
+        namespaced_model ? "    " : "  "
+      end
+    end
+  end
+end

data/lib/generators/abyme/resource/USAGE

@@ -0,0 +1,10 @@
+Description:
+	Generates configuration for the model and controller, as well as views templates (see each individual usage pages)
+
+Example:
+  # Generate files and configuration, not handling attributes
+	rails generate abyme:model project tasks 
+  # Generate files and configuration, permitting specified attributes
+	rails generate abyme:model project tasks description title
+  # Generate files and configuration, permitting all attributes
+	rails generate abyme:model project tasks all_attributes

data/lib/generators/abyme/resource/resource_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+
+module Abyme
+  module Generators
+    class ResourceGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      argument :association, type: :string, required: true, banner: "association association"
+      argument :attributes, type: :array, default: [], banner: "field field"
+
+      def call_generators
+        Rails::Generators.invoke "abyme:model", [name, association, *attributes.map(&:name)]
+        Rails::Generators.invoke "abyme:controller", [name]
+        Rails::Generators.invoke "abyme:view", [association, *attributes.map(&:name)]
+      end
+    end
+  end
+end

data/lib/generators/abyme/stimulus/USAGE

@@ -0,0 +1,5 @@
+Description:
+	Registers the Abyme stimulus controller into the javascript/controllers/index.js
+
+Example:
+	rails generate abyme:stimulus

data/lib/generators/abyme/stimulus/stimulus_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+
+module Abyme
+  module Generators
+    class StimulusGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def add_to_stimulus
+        insert_into_file(stimulus_file_path, "\nimport { AbymeController } from 'abyme';\n")
+        insert_into_file(stimulus_file_path, "application.register('abyme', AbymeController);")
+      end
+
+      private
+
+      def stimulus_file_path
+        Rails.root.join('app', 'javascript', 'controllers', 'index.js')
+      end
+
+    end
+  end
+end