rondo_form 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab7c415b1a97a538742b84ffd41f05acb28e60dc6bb5721d059670c4b69e5e91
+  data.tar.gz: e953952e1955dd4a8194b96ea28aff09aa6e0990ce5113648f4d94f846f55335
+SHA512:
+  metadata.gz: 680cb74e9d615f9e1d3444363796a2cc8ec8d25dbc3caf2504bcee3188cb88c4001b911259cb256bb236d6bbaf6e0238edc71570fee7894996fd68ffc08cfe6b
+  data.tar.gz: 1331fec9838d555ba6742f28aa74259644acbe7a019716a99118413eecb069fd69926f31a21db89e78a9d710e080caa2a0a62f56cd570344ff1e0194c4dbc96c

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rondo_form.gemspec
+gemspec
+group :development, :test do
+  gem "rails", "~> 7.0"
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.0"
+end
+

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    rondo_form (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rondo_form!
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.3.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 hungle00
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# RondoForm
+
+Handle nested forms, same as Cocoon, but using StimulusJS
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rondo_form
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rondo_form
+
+Run the installation task:
+
+    $ rails g rondo_form:install
+
+## Usage
+
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hungle00/rondo_form.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/rondo_form/install_generator.rb

@@ -0,0 +1,18 @@
+module RondoForm
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+      desc "This generator installs the javascript needed for rondo_form"
+
+      def copy_the_javascript
+        copy_file "cocoon_controller.js", "app/javascript/controllers/cocoon_controller.js", force: true
+        if (Rails.root.join("app/javascript/controllers/index.js")).exist?
+          append_to_file "app/javascript/controllers/index.js", 
+            %(import CocoonController from "./cocoon_controller"\napplication.register("cocoon", CocoonController)\n)
+        else
+          say %(Couldn't find "app/javascript/controllers/index.js".), :red
+        end
+      end
+    end
+  end
+end

data/lib/generators/rondo_form/templates/cocoon_controller.js

@@ -0,0 +1,35 @@
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  static targets = ["template"]
+
+  addField(e) {
+    e.preventDefault()
+    let assoc = e.target.dataset.association
+    let newField = this.buildNewAssociation(assoc)
+    let insertionNode = this.templateTarget.parentElement
+    insertionNode.insertAdjacentHTML("beforebegin", newField)
+  }
+
+  removeField(e) {
+    e.preventDefault()
+    let closestField = e.target.closest(".nested-fields")
+    if(e.target.matches('.dynamic')) {
+      closestField.remove()
+    } else {
+      closestField.style.display = "none"
+    }
+  }
+
+  buildNewAssociation(assoc) {
+    let content  = this.templateTarget.innerHTML;
+    let regexp_braced = new RegExp('\\[new_' + assoc + '\\]', 'g');
+    let new_id  = new Date().getTime();
+    let new_content = content.replace(regexp_braced, '[' + new_id + ']');
+    if (new_content == content) {
+      regexp_braced = new RegExp('\\[new_' + assoc + 's\\]', 'g');
+      new_content = content.replace(regexp_braced, '[' + new_id + ']');
+    }
+    return new_content
+  }
+}

data/lib/rondo_form/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RondoForm
+  VERSION = "0.1.0"
+end

data/lib/rondo_form/view_helpers.rb

@@ -0,0 +1,72 @@
+module RondoForm
+  module ViewHelpers
+    # this will show a link to remove the current association. This should be placed inside the partial.
+    # either you give
+    # - *name* : the text of the link
+    # - *f* : the form this link should be placed in
+    # - *html_options*:  html options to be passed to link_to (see <tt>link_to</tt>)
+    #
+    # or you use the form without *name* with a *&block*
+    # - *f* : the form this link should be placed in
+    # - *html_options*:  html options to be passed to link_to (see <tt>link_to</tt>)
+    # - *&block*:        the output of the block will be show in the link, see <tt>link_to</tt>
+    
+    def link_to_remove_association(*args, &block)
+      if block_given?
+        f            = args.first
+        html_options = args.second || {}
+        name         = capture(&block)
+        link_to_remove_association(name, f, html_options)
+      else
+        name         = args[0]
+        f            = args[1]
+        html_options = args[2] || {}
+
+        is_dynamic = f.object.new_record?
+        html_options[:class] = [html_options[:class], "remove_fields #{is_dynamic ? 'dynamic' : 'existing'}"].compact.join(' ')
+        html_options[:'data-action'] = "click->cocoon#removeField"
+        f.hidden_field(:_destroy) + link_to(name, '', html_options)
+      end
+    end
+
+    # :nodoc:
+    def render_association(association, f, new_object)
+      f.fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
+        render(association.to_s.singularize + "_fields", :f => builder, :dynamic => true)
+      end
+    end
+
+    # shows a link that will allow to dynamically add a new associated object.
+    #
+    # - *name* :         the text to show in the link
+    # - *f* :            the form this should come in (the formtastic form)
+    # - *association* :  the associated objects, e.g. :tasks, this should be the name of the <tt>has_many</tt> relation.
+    # - *html_options*:  html options to be passed to <tt>link_to</tt> (see <tt>link_to</tt>)
+    # - *&block*:        see <tt>link_to</tt>
+
+    def link_to_add_association(*args, &block)
+      if block_given?
+        f            = args[0]
+        association  = args[1]
+        html_options = args[2] || {}
+        link_to_add_association(capture(&block), f, association, html_options)
+      else
+        name         = args[0]
+        f            = args[1]
+        association  = args[2]
+        html_options = args[3] || {}
+
+        html_options[:class] = [html_options[:class], "add_fields"].compact.join(' ')
+        html_options[:'data-association'] = association.to_s.singularize
+        html_options[:'data-action'] = "click->cocoon#addField"
+
+        new_object = f.object.class.reflect_on_association(association).klass.new
+        model_name = new_object.class.name.underscore
+        hidden_div = content_tag("template", id: "#{model_name}_fields_template", data: {cocoon_target: 'template'}) do
+          render_association(association, f, new_object)
+        end
+      end
+      hidden_div.html_safe + link_to(name, '', html_options )
+    end
+  end
+end

data/lib/rondo_form.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+require_relative "rondo_form/version"
+require_relative "rondo_form/view_helpers"
+
+module RondoForm
+  class Engine < ::Rails::Engine
+    # configure our plugin on boot
+    initializer "rondo_form.initialize" do |app|
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, RondoForm::ViewHelpers
+      end
+    end
+
+  end
+end

data/sig/rondo_form.rbs

@@ -0,0 +1,4 @@
+module RondoForm
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rondo_form
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hungle00
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '20.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '20.0'
+description: Handle nested forms using Stimulus JS
+email:
+- hungle2048@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rondo_form/install_generator.rb
+- lib/generators/rondo_form/templates/cocoon_controller.js
+- lib/rondo_form.rb
+- lib/rondo_form/version.rb
+- lib/rondo_form/view_helpers.rb
+- sig/rondo_form.rbs
+homepage: https://github.com/hungle00/rondo_form
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hungle00/rondo_form
+  source_code_uri: https://github.com/hungle00/rondo_form
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Cocoon, but with Stimulus JS
+test_files: []