active_scaffold_duplicate 1.3.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 61dae587856c8ba3eae95a56fbad007fbd7eddd71c4450cb7f5b91d1ef6c41b0
-  data.tar.gz: cf3788edbd4d6bfbf6f530d785c548256a54109aadaaf8877e69b1903e96bb69
+  metadata.gz: f5f1c4cf45f2d3b19627b5455855e465444dda860be61435783d4bf0343bc370
+  data.tar.gz: 1d38a8e4e5e7a9463308c23f4c0f7327acc5264b8318211c84381fd48f78ed84
 SHA512:
-  metadata.gz: 2832dd014e7bd9c6c5730cdb1b27ae9ec174528a2c2d9400e3c921107574fce41ad34c60d9c25d1776e0bb9a4c75a4cf5c701fa9f0d35d2c567bee00fe1a4c6b
-  data.tar.gz: '09692d70f880ff18f0284f0b3aa6ab3caa523c5012219ffc4388bf45cc58d3c990587d7dc275ea5b7a2cfdd57e413840d6f2e98c2e4e79f7e244872baab9854a'
+  metadata.gz: de1f1f6928cc3e14d9582c3965f4d5494c683429a69e738c230ca8edd3684a68490c500f9df8219eab6a35eea864ac81f0a048c78d8c316611ec28b78c8510f9
+  data.tar.gz: '09bb16ccb13496eef1d29a5c035fb6f769f5ec4075283a9db5964df63be60713f5478a82441aeb6bf43d752f705c84ce2b9331477eb8e6d41a7b7aa979e22698'

data/README.md

@@ -0,0 +1,149 @@
+# Duplicate Action for ActiveScaffold
+
+Currently, this gem is compatible with ActiveScaffold >= 4.4.0.
+
+## Overview
+
+This gem adds an action to clone records. By default will only set attributes and belongs_to associations. You must override `initialize_dup` in your model or define a method to clone the record and set in `conf.duplicate.method`.
+
+Also, adds support to duplicate rows in a subform, setting the `:duplicate` setting in the column's options, or `form_ui_options`.
+
+## Installation
+
+You'll need ActiveScaffold 4.4.0 or newer.
+
+```bash
+gem install active_scaffold_duplicate
+```
+
+## Usage
+
+#### Step 1
+
+Override `initialize_dup` in the model to set some attributes or copy associations:
+
+```ruby
+# app/models/bill.rb
+class Bill < ActiveRecord::Base
+  belongs_to :customer
+  has_many :items
+  
+  def initialize_dup(other)
+    super
+    self.items = other.items.map(&:dup)
+  end
+end
+```
+
+#### Step 2
+
+Add duplicate action.
+
+```ruby
+class BillsController < ApplicationController
+  active_scaffold do |conf|
+    conf.actions << :duplicate
+  end
+end
+```
+
+#### Step 3
+
+Change method to `:get` in link if you want to display create form instead of cloning record. Set position to `:replace` or `:after` for inline display, or enable page rendering.
+
+```ruby
+class BillsController < ApplicationController
+  active_scaffold do |conf|
+    conf.duplicate.link.method = :get
+    conf.duplicate.link.position = :after
+    #conf.duplicate.link.page = true # for new page rendering
+  end
+end
+```
+
+Also you can change it globally.
+
+```ruby
+class ApplicationController < ActionController::Base
+  active_scaffold.set_defaults do |conf|
+    conf.duplicate.link.method = :get
+    conf.duplicate.link.position = :after
+    #conf.duplicate.link.page = true # for new page rendering
+  end
+end
+```
+
+You can access to record which is being duplicated in your form overrides with `@old_record` variable.
+
+If you use `:post` method, you can enable `refresh_list` to refresh the list instead of only adding new record at top, or set `action_after_clone` to open edit form for example:
+
+```ruby
+  conf.duplicate.refresh_list = true
+  conf.duplicate.action_after_clone = :edit
+```
+
+## Before/after controller methods
+
+It's possible to define some methods to add some custom code which require access to session or request params:
+
+* For `:post` method, `before_duplicate_save(record)` and `after_duplicate_save(record)` can be defined, which will be called before and after saving the record respectively.
+* For `:new` method, `before_duplicate_new(record)` can be defined, which will be called before rendering.
+
+## Duplicate record in subforms
+
+Set the `:duplicate` setting in the column's options, or `form_ui_options`.
+
+```ruby
+conf.columns[:lines].form_ui = nil, {duplicate: true} # set in the options for form_ui only, leaving UI as nil so subform is used
+conf.columns[:lines].options = {duplicate: true} # set in the column options, would be available to other UI (list, show, search), although won't affect probably
+```
+
+Cloning the record will send a request to `edit_associated` action in the parent controller, same as adding a new record.
+
+### UI adapter support
+
+The duplicate link rendered for a subform row exposes the
+`subform_record_duplicate` UI element. UI framework adapters can add or replace
+its HTML attributes without overriding the helper:
+
+```ruby
+ActiveScaffold.add_element_attributes :subform_record_duplicate,
+                                      class: 'btn btn-sm btn-secondary'
+```
+
+The plugin keeps the `dup` class used by its JavaScript and merges it with
+classes supplied by the adapter.
+
+If you want to make changes to the cloned record before added to the subform, you can override `duplicate_subform_record` method in your controller, call `super` to leave active_scaffold_duplicate to copy the submitted attributes, and then make your changes. You can check what subform was called for with `@column` variable:
+
+```ruby
+  def duplicate_subform_row(record, ...)
+    super
+    if @column == :travel_line_items
+      record.financial_month = nil # don't copy financial month
+      record.compute_totals
+    end
+  end
+```
+
+## Support
+
+If you have issues installing the gem, search / post to the [Active Scaffold](http://groups.google.com/group/activescaffold) forum or [Create an issue](http://github.com/activescaffold/active_scaffold_duplicate/issues)
+
+## Contributing
+
+Fork, hack, push, and request a pull:
+
+<http://github.com/activescaffold/active_scaffold_duplicate/>
+
+## License
+
+Released under the MIT license (included).
+
+## Author
+
+Contact me:
+
+```ruby
+  Sergio Cambra - irb(main):001:0> ( 'sergioATenpijama._see_s'.gsub('_see_', 'e').gsub('AT', '@') )
+```

data/app/assets/javascripts/active_scaffold_duplicate.js

@@ -0,0 +1,39 @@
+(function() {
+  jQuery(document).ready(function () {
+    jQuery(document).on('ajax:beforeSend', '.sub-form-record .actions .dup', function (e, xhr, settings) {
+      if (e.detail && !xhr) {
+        xhr = e.detail[0];
+        settings = e.detail[1];
+      }
+      var link = jQuery(e.target), row = link.closest('.sub-form-record'), subform = row.closest('.sub-form'),
+        url = subform.find('.as_create_another:last').attr('href');
+      if (url) {
+        var params = {};
+        row.find(':input[name]').serializeArray().forEach(function(item) {
+          var newName = item.name.replace(/^record\[/, 'dup[');
+          params[newName] = item.value;
+        });
+        var paramString = jQuery.param(params);
+        // If URL already has ?, append with & otherwise with ?
+        settings.url = url + (url.indexOf('?') !== -1 ? '&' : '?') + paramString;
+      } else {
+        e.preventDefault();
+        return false;
+      }
+    });
+
+    ActiveScaffold.setup_callbacks.push(function(container) {
+      var container = jQuery(container), new_row_subform;
+      if (container.is('.sub-form-record')) { // adding a new row to a subform
+        new_row_subform = container.closest('.sub-form');
+        if (!new_row_subform.is(':has(.as_create_another)')) return;
+      }
+      jQuery('.sub-form:has(.as_create_another)', container).add(new_row_subform).each(function () {
+        var subform = this;
+        jQuery('.sub-form-record .actions .dup', this).filter(function () {
+          return $(this).closest('.sub-form').is(subform);
+        }).show();
+      });
+    });
+  });
+})();

data/lib/active_scaffold/actions/duplicate.rb

@@ -27,6 +27,17 @@ module ActiveScaffold::Actions
     def duplicate_authorized?(record = nil)
       (record || self).authorized_for?(crud_type: :create, action: :duplicate, reason: true)
     end
+
+    def do_edit_associated
+      super
+      if params[:dup]
+        attributes = params.delete(:dup)
+        @scope&.slice(1..-2)&.split('][')&.each { |scope| attributes = attributes[scope] }
+        attributes = attributes[@column.name].values
+        cfg = active_scaffold_config_for(@record.class)
+        update_record_from_params(@record, cfg.subform.columns, attributes, true)
+      end
+    end
     
     def duplicate_respond_to_html
       if successful?

data/lib/active_scaffold/helpers/duplicate_helpers.rb

@@ -9,6 +9,30 @@ module ActiveScaffold
           columns
         end
       end
+
+      def active_scaffold_subform_record_actions(association_column, record, locked, scope)
+        actions = super
+        return actions if association_column.nil?
+        return actions unless association_column.association.collection?
+        return actions unless (association_column.form_ui_options || association_column.options)[:duplicate]
+
+        safe_join(
+          [
+            link_to(
+              as_(:duplicate),
+              '#',
+              as_element_attributes(
+                :subform_record_duplicate,
+                class: 'dup',
+                style: 'display: none;',
+                remote: true,
+                data: {scope: scope}
+              )
+            ),
+            actions
+          ]
+        )
+      end
     end
   end
 end

data/lib/active_scaffold_duplicate/engine.rb

@@ -10,5 +10,8 @@ module ActiveScaffoldDuplicate
         self::ACTIVE_SCAFFOLD_CORE_ROUTING[:member][:duplicate] = [:post, :get]
       end
     end
+    initializer 'active_scaffold_duplicate.extensions' do
+      ActiveScaffold::Actions::Subform.prepend ActiveScaffoldDuplicate::Subform
+    end
   end
 end

data/lib/active_scaffold_duplicate/subform.rb

@@ -0,0 +1,19 @@
+module ActiveScaffoldDuplicate
+  module Subform
+    protected
+    def do_edit_associated
+      super
+      if params[:dup]
+        attributes = params.delete(:dup)
+        @scope&.slice(1..-2)&.split('][')&.each { |scope| attributes = attributes[scope] }
+        attributes = attributes[@column.name].values[0]
+        duplicate_subform_row(@record, attributes)
+      end
+    end
+
+    def duplicate_subform_row(record, attributes, columns = nil)
+      cfg = active_scaffold_config_for(record.class) unless columns
+      update_record_from_params(record, columns || cfg.subform.columns, attributes, true)
+    end
+  end
+end

data/lib/active_scaffold_duplicate/version.rb

@@ -1,7 +1,7 @@
 module ActiveScaffoldDuplicate
   module Version
-    MAJOR = 1
-    MINOR = 3
+    MAJOR = 2
+    MINOR = 1
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')

data/lib/active_scaffold_duplicate.rb

@@ -4,6 +4,7 @@ module ActiveScaffoldDuplicate
   def self.root
     File.dirname(__FILE__) + "/.."
   end
+  autoload :Subform, 'active_scaffold_duplicate/subform'
 end
 
 module ActiveScaffold
@@ -19,3 +20,5 @@ module ActiveScaffold
     ActiveScaffold.autoload_subdir('helpers', self, File.dirname(__FILE__))
   end
 end
+
+ActiveScaffold.javascripts << 'active_scaffold_duplicate'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: active_scaffold_duplicate
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Sergio Cambra
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_scaffold
@@ -16,24 +15,25 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.4.0
 description: Clone records using a method from model in ActiveScaffold
 email: activescaffold@googlegroups.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.textile
+- README.md
 files:
 - LICENSE.txt
-- README.textile
+- README.md
+- app/assets/javascripts/active_scaffold_duplicate.js
 - app/views/active_scaffold_overrides/duplicate.js.erb
 - config/locales/en.yml
 - config/locales/es.yml
@@ -42,12 +42,12 @@ files:
 - lib/active_scaffold/helpers/duplicate_helpers.rb
 - lib/active_scaffold_duplicate.rb
 - lib/active_scaffold_duplicate/engine.rb
+- lib/active_scaffold_duplicate/subform.rb
 - lib/active_scaffold_duplicate/version.rb
 homepage: http://github.com/activescaffold/active_scaffold_duplicate
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,8 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Clone record gem for Activescaffold
 test_files: []

data/README.textile

@@ -1,111 +0,0 @@
-h1. Duplicate Action for ActiveScaffold
-
-Currently, this gem is compatible with ActiveScaffold >= 3.3.x gems and rails >= 4.0.
-Use 1.0.x for rails >= 3.x versions.
-
-h2. Overview
-
-This gem adds an action to clone records. By default will only set attributes and belongs_to associations. You must override initialize_dup in your model or define a method to clone the record and set in conf.duplicate.method.
-
-h2. Installation
-
-You'll need at least ActiveScaffold 3.3.x to use this, and rails 3.x
-
-
-<pre>
-gem install active_scaffold_duplicate
-</pre>
-
-h2. Usage
-
-h4. Step 1
-
-Override initialize_dup in the model to set some attributes or copy associations:
-
-<pre>
-# app/models/bill.rb
-class Bill < ActiveRecord::Base
-  belongs_to :customer
-  has_many :items
-  
-  def initialize_dup(other)
-    super
-    self.items = other.items.map(&:dup)
-  end
-end
-</pre>
-
-h4. Step 2
-
-Add duplicate action.
-
-<pre>
-class BillsController < ApplicationController
-  active_scaffold do |conf|
-    conf.actions << :duplicate
-  end
-end
-</pre>
-
-h4. Step 3
-
-Change method to :get in link if you want to display create form instead of cloning record. Set position to :replace or :after for inline display, or enable page rendering.
-
-<pre>
-class BillsController < ApplicationController
-  active_scaffold do |conf|
-    conf.duplicate.link.method = :get
-    conf.duplicate.link.position = :after
-    #conf.duplicate.link.page = true # for new page rendering
-  end
-end
-</pre>
-
-Also you can change it globally.
-
-<pre>
-class ApplicationController < ActionController::Base
-  active_scaffold.set_defaults do |conf|
-    conf.duplicate.link.method = :get
-    conf.duplicate.link.position = :after
-    #conf.duplicate.link.page = true # for new page rendering
-  end
-end
-</pre>
-
-You can access to record which is being duplicated in your form overrides with @old_record variable.
-
-If you use :post method, you can enable refresh_list to refresh the list instead of only adding new record at top, or set action_after_clone to open edit form for example:
-
-<pre>
-  conf.duplicate.refresh_list = true
-  conf.duplicate.action_after_clone = :edit
-</pre>
-
-h2. Before/after controller methods
-
-It's possible to define some methods to add some custom code which require access to session or request params:
-
-* For :post method, before_duplicate_save(record) and after_duplicate_save(record) can be defined, which will be called before and after saving the record respectively.
-* For :new method, before_duplicate_new(record) can be defined, which will be called before rendering.
-
-h2. Support
-
-If you have issues installing the gem, search / post to the "Active Scaffold":http://groups.google.com/group/activescaffold forum or "Create an issue":http://github.com/activescaffold/active_scaffold_duplicate/issues
-
-h2. Contributing
-
-Fork, hack, push, and request a pull:
-
-http://github.com/activescaffold/active_scaffold_duplicate/
-
-h2. License
-
-Released under the MIT license (included).
-
-h2. Author
-
-Contact me:
-<pre>
-  Sergio Cambra - irb(main):001:0> ( 'sergioATprogramatica._see_s'.gsub('_see_', 'e').gsub('AT', '@') )
-</pre>