cookbook 0.1.2 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e5ddf2c7e8f42e08fdfe0efa01b04db1692f1a3b7bcaf22bb5b280894b517e6
-  data.tar.gz: 714e544111f74044a07b4a8185937a00ac334f06e886140c0dbe7fca361f014c
+  metadata.gz: 2959709e5e50fec64984caac992b47de183442c12ce5388b37d476434e1155dc
+  data.tar.gz: 0b8861cf190ec4da06ac43dc6dee23ccc360c2251a427e4a7fcfc9369b32283f
 SHA512:
-  metadata.gz: c8bda17026410a17d057aa27d74a275976848a6be03e85bf34d6edc86e900ca360ad24ba36515f3f6b23e5cbfc4e715c4a6682bd339793c7a28d4a7b650a082c
-  data.tar.gz: f486ba4c50eb39296f6518e5804ebbc6d86f20e5b86eeae42b8c644e5181ce2166b4d2bb991bc17b0d9067fb96edff07dcdb94364bb4740675fc948dd9fb3b28
+  metadata.gz: dc961bc7d3a9396de7265eeb271b17ff4c500b6c4c40f5187bfa721702017c7fdf0c70ca453951d792cf5fbf1ea1ada3753548bfedce74e517331be5cb8d13be
+  data.tar.gz: 41ceed87fb03aa183e10f4e1ddab2e2de7e147343d7af48a0dc225dcfd38878aca4ecc727e223986ed6aa146a8469c799f61745c2d938c9c1c9c7099bba64a62

data/Gemfile

@@ -5,7 +5,7 @@ source 'https://rubygems.org'
 gem 'rails', '>= 6', '< 7'
 
 gem 'haml-rails', '>= 2.0', '< 3'
-gem 'sass-rails', '>= 6', '< 7'
+gem 'sass-rails', '>= 5', '< 7'
 
 gem 'cancancan', '>= 3.3', '< 4'
 

data/Gemfile.lock

@@ -155,18 +155,6 @@ GEM
       rdoc
       semver
     jwt (2.2.3)
-    kaminari (1.2.1)
-      activesupport (>= 4.1.0)
-      kaminari-actionview (= 1.2.1)
-      kaminari-activerecord (= 1.2.1)
-      kaminari-core (= 1.2.1)
-    kaminari-actionview (1.2.1)
-      actionview
-      kaminari-core (= 1.2.1)
-    kaminari-activerecord (1.2.1)
-      activerecord
-      kaminari-core (= 1.2.1)
-    kaminari-core (1.2.1)
     loofah (2.12.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -347,7 +335,6 @@ DEPENDENCIES
   faker
   haml-rails (>= 2.0, < 3)
   juwelier (~> 2.1.0)
-  kaminari (>= 1.2.1, < 2)
   puma (>= 4.3, < 5)
   rails (>= 6, < 7)
   rspec-html-matchers
@@ -355,7 +342,7 @@ DEPENDENCIES
   rubocop
   rubocop-rails
   rubocop-rspec
-  sass-rails (>= 6, < 7)
+  sass-rails (>= 5, < 7)
   shoulda
   shoulda-matchers (>= 4.3, < 5)
   simple_form (>= 5.1, < 6)

data/README.md

@@ -3,8 +3,6 @@ Works Cited allows you to add a list of the works cited in ActiveRecord objects,
 
 Works Cited can be configured to use CanCanCan to authorize the editing of citations. This makes it easy for you to control access.
 
-Works Cited does not require, but is compatible with Rails Admin.
-
 ## Installation
 Add this line to your application's Gemfile:
 

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.6

data/app/assets/javascript/cookbook/addFields.js

@@ -0,0 +1,41 @@
+class addFields {
+  // This executes when the function is instantiated.
+  constructor() {
+    this.links = document.querySelectorAll('.add_fields')
+    this.iterateLinks()
+  }
+
+  iterateLinks() {
+    // If there are no links on the page, stop the function from executing.
+    if (this.links.length === 0) return
+    // Loop over each link on the page. A page could have multiple nested forms.
+    this.links.forEach(link => {
+      link.addEventListener('click', e => {
+        this.handleClick(link, e)
+      })
+    })
+  }
+
+  handleClick(link, e) {
+    // Stop the function from executing if a link or event were not passed into the function.
+    if (!link || !e) return
+    // Prevent the browser from following the URL.
+    e.preventDefault()
+    // Save a unique timestamp to ensure the key of the associated array is unique.
+    let time = new Date().getTime()
+    // Save the data id attribute into a variable. This corresponds to `new_object.object_id`.
+    let linkId = link.dataset.id
+    // Create a new regular expression needed to find any instance of the `new_object.object_id` used in the fields data attribute if there's a value in `linkId`.
+    let regexp = linkId ? new RegExp(linkId, 'g') : null
+    // Replace all instances of the `new_object.object_id` with `time`, and save markup into a variable if there's a value in `regexp`.
+    let newFields = regexp ? link.dataset.fields.replace(regexp, time) : null
+    // Add the new markup to the form if there are fields to add.
+    newFields ? link.insertAdjacentHTML('beforebegin', newFields) : null
+    // Tell it new fields are there
+    const event = new Event('cookbook:add_fields')
+    window.dispatchEvent(event);
+  }
+}
+
+// Wait for turbolinks to load, otherwise `document.querySelectorAll()` won't work
+window.addEventListener('load', () => new addFields())

data/app/assets/javascript/cookbook/application.js

@@ -0,0 +1,2 @@
+//= require cookbook/addFields
+//= require cookbook/removeFields

data/app/assets/javascript/cookbook/removeFields.js

@@ -0,0 +1,36 @@
+class removeFields {
+  // This executes when the function is instantiated.
+  constructor() {
+    this.iterateLinks()
+  }
+
+  iterateLinks() {
+    document.querySelectorAll('.remove_fields').forEach(link => {
+      link.addEventListener('click', e => {
+        this.handleClick(link, e)
+      })
+    })
+  }
+
+  handleClick(link, e) {
+    // Stop the function from executing if a link or event were not passed into the function.
+    if (!link || !e) return
+    // Prevent the browser from following the URL.
+    e.preventDefault()
+    // Find the parent wrapper for the set of nested fields.
+    let fieldParent = link.closest('.nested-fields')
+    // If there is a parent wrapper, find the hidden delete field.
+    let deleteField = fieldParent
+      ? fieldParent.querySelector('input[type="hidden"]')
+      : null
+    // If there is a delete field, update the value to `1` and hide the corresponding nested fields.
+    if (deleteField) {
+      deleteField.value = 1
+      fieldParent.style.display = 'none'
+    }
+  }
+}
+
+// Wait for turbolinks to load, otherwise `document.querySelectorAll()` won't work
+window.addEventListener('load', () => new removeFields())
+window.addEventListener('cookbook:add_fields', () => new removeFields())

data/app/helpers/cookbook/application_helper.rb

@@ -15,6 +15,45 @@ module Cookbook
       render 'cookbook/fields', form: form, usables: build_usables(form.object)
     end
 
+    # This method creates a link with `data-id` `data-fields` attributes. These attributes are used to create new instances of the nested fields through Javascript.
+    def cookbook_link_to_add_fields(name, f, association, partial = nil)
+
+      # Takes an object (@person) and creates a new instance of its associated model (:addresses)
+      # To better understand, run the following in your terminal:
+      # rails c --sandbox
+      # @person = Person.new
+      # new_object = @person.send(:addresses).klass.new
+      new_object = f.object.send(association).klass.new
+
+      # Saves the unique ID of the object into a variable.
+      # This is needed to ensure the key of the associated array is unique. This is makes parsing the content in the `data-fields` attribute easier through Javascript.
+      # We could use another method to achive this.
+      id = new_object.object_id
+
+      # https://api.rubyonrails.org/ fields_for(record_name, record_object = nil, fields_options = {}, &block)
+      # record_name = :addresses
+      # record_object = new_object
+      # fields_options = { child_index: id }
+      # child_index` is used to ensure the key of the associated array is unique, and that it matched the value in the `data-id` attribute.
+      # `person[addresses_attributes][child_index_value][_destroy]`
+      fields = f.fields_for(association, new_object, child_index: id) do |builder|
+
+        # `association.to_s.singularize + "_fields"` ends up evaluating to `address_fields`
+        # The render function will then look for `views/people/_address_fields.html.erb`
+        # The render function also needs to be passed the value of 'builder', because `views/people/_address_fields.html.erb` needs this to render the form tags.
+        partial.nil? ? render(association.to_s.singularize + "_fields", f: builder) : render(partial, f: builder)
+      end
+
+      # This renders a simple link, but passes information into `data` attributes.
+      # This info can be named anything we want, but in this case we chose `data-id:` and `data-fields:`.
+      # The `id:` is from `new_object.object_id`.
+      # The `fields:` are rendered from the `fields` blocks.
+      # We use `gsub("\n", "")` to remove anywhite space from the rendered partial.
+      # The `id:` value needs to match the value used in `child_index: id`.
+      link_to(name, '#', class: "add_fields button button-action", data: {id: id, fields: fields.gsub("\n", "")})
+
+    end
+
     private
 
     def build_usables(object)

data/app/models/cookbook/use.rb

@@ -1,11 +1,28 @@
 # frozen_string_literal: true
+require 'pp'
 
 module Cookbook
   # Cookbook::Use is basically a linking table with extra information.
   class Use < ApplicationRecord
+    attr_accessor(:used_in_tables)
+
     # Relationships
-    belongs_to :use_in, polymorphic: true
-    belongs_to :use_of, polymorphic: true
+    belongs_to :use_in, polymorphic: true, inverse_of: :uses
+    belongs_to :use_of, polymorphic: true, inverse_of: :uses
+
+    class << self
+      def add_use_of(table_sym)
+        singular = table_sym.to_s.singularize
+        model_name = singular.classify.constantize.to_s
+        belongs_to singular.to_sym, class_name: model_name, foreign_key: :use_of_id, inverse_of: :uses, optional: true
+      end
+
+      def add_use_in(table_sym)
+        singular = table_sym.to_s.singularize
+        model_name = singular.classify.constantize.to_s
+        belongs_to singular.to_sym, class_name: model_name, foreign_key: :use_in_id, inverse_of: :uses, optional: true
+      end
+    end
 
     # Methods
     def object_label
@@ -32,9 +49,6 @@ module Cookbook
         object_label_method { :object_label }
         edit do
           include_all_fields
-          field :use_in do
-            visible false
-          end
         end
       end
     end

data/app/views/cookbook/_fields.html.haml

@@ -1,11 +1,11 @@
-= javascript_include_tag 'vanilla_nested'
+= javascript_include_tag 'cookbook/application'
 - if Cookbook.configuration.include_cookbook_css == true
   = stylesheet_link_tag 'cookbook/application'
 - usables.each do |usable|
   %fieldset.used_in{class: usable.plural_class}
     %legend
       %h3= usable.title
-    = link_to_add_nested form, usable.uses_sym, "##{usable.plural_class}", partial: 'cookbook/uses/fields', link_text: "Add #{usable.singular_title}", link_classes: 'button button-action'
     %div{id: usable.plural_class}
       = form.fields_for usable.uses_sym do |g|
-        = render 'cookbook/uses/fields', form: g, usable: usable
+        = render 'cookbook/use_fields', f: g, usable: usable
+    = cookbook_link_to_add_fields "Add #{usable.singular_title}", form, usable.uses_sym, 'cookbook/use_fields'

data/app/views/cookbook/_use_fields.html.haml

@@ -0,0 +1,22 @@
+%fieldset.nested-fields
+  :ruby
+    table_sym = f.object_name.gsub(/[^\[]+\[([^\]]+)_uses_attributes\].*/, "\\1").pluralize
+    model = table_sym.to_s.classify.constantize
+    collection = if Cookbook.configuration.authorize_with == :cancancan
+                   model.accessible_by(current_ability, :select)
+                 else
+                   model.all
+                 end
+  %legend
+    %h4
+      = model.model_name.human
+  = f.hidden_field :_destroy
+  = f.hidden_field :use_of_type, value: model.model_name.to_s
+  = f.input :use_of_id, collection: collection, as: :select, label_method: model.label_method, value_method: :id, selected: f.object.use_of_id, include_blank: "Select #{model.model_name.human}"
+  = f.input :quantity_minimum
+  = f.input :quantity_maximum
+  = f.input :unit
+  = f.input :sort
+  = f.input :preparation, hint: 'like "crushed" or "greased"'
+  = f.input :note, hint: 'like "to taste"'
+  = link_to "Remove", '#', class: 'remove_fields button button-danger'

data/cookbook.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: cookbook 0.1.2 ruby lib
+# stub: cookbook 0.1.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "cookbook".freeze
-  s.version = "0.1.2"
+  s.version = "0.1.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.metadata = { "source_code_uri" => "http://github.com/gemvein/cookbook" } if s.respond_to? :metadata=
   s.require_paths = ["lib".freeze]
   s.authors = ["Loren Lundgren".freeze]
-  s.date = "2021-09-13"
+  s.date = "2021-09-21"
   s.description = "Cookbook allows you to associate instructions with components in a cross referenced way. Good for cooking recipes or an instruction manual for DIY projects.".freeze
   s.email = "loren.lundgren@gmail.com".freeze
   s.executables = ["rails".freeze]
@@ -30,14 +30,17 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "app/assets/javascript/cookbook/addFields.js",
+    "app/assets/javascript/cookbook/application.js",
+    "app/assets/javascript/cookbook/removeFields.js",
     "app/assets/stylesheets/cookbook/application.scss",
     "app/controllers/concerns/cookbook/params.rb",
     "app/helpers/cookbook/application_helper.rb",
     "app/models/cookbook/use.rb",
     "app/views/cookbook/_fields.html.haml",
+    "app/views/cookbook/_use_fields.html.haml",
     "app/views/cookbook/_used_in.html.haml",
     "app/views/cookbook/_uses_of.html.haml",
-    "app/views/cookbook/uses/_fields.html.haml",
     "bin/rails",
     "config/initializers/simple_form.rb",
     "config/locales/simple_form.en.yml",
@@ -192,7 +195,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rails>.freeze, [">= 6", "< 7"])
       s.add_runtime_dependency(%q<haml-rails>.freeze, [">= 2.0", "< 3"])
-      s.add_runtime_dependency(%q<sass-rails>.freeze, [">= 6", "< 7"])
+      s.add_runtime_dependency(%q<sass-rails>.freeze, [">= 5", "< 7"])
       s.add_runtime_dependency(%q<cancancan>.freeze, [">= 3.3", "< 4"])
       s.add_runtime_dependency(%q<simple_form>.freeze, [">= 5.1", "< 6"])
       s.add_runtime_dependency(%q<vanilla_nested>.freeze, [">= 1.3", "< 2"])
@@ -210,7 +213,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<rails>.freeze, [">= 6", "< 7"])
       s.add_dependency(%q<haml-rails>.freeze, [">= 2.0", "< 3"])
-      s.add_dependency(%q<sass-rails>.freeze, [">= 6", "< 7"])
+      s.add_dependency(%q<sass-rails>.freeze, [">= 5", "< 7"])
       s.add_dependency(%q<cancancan>.freeze, [">= 3.3", "< 4"])
       s.add_dependency(%q<simple_form>.freeze, [">= 5.1", "< 6"])
       s.add_dependency(%q<vanilla_nested>.freeze, [">= 1.3", "< 2"])
@@ -229,7 +232,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<rails>.freeze, [">= 6", "< 7"])
     s.add_dependency(%q<haml-rails>.freeze, [">= 2.0", "< 3"])
-    s.add_dependency(%q<sass-rails>.freeze, [">= 6", "< 7"])
+    s.add_dependency(%q<sass-rails>.freeze, [">= 5", "< 7"])
     s.add_dependency(%q<cancancan>.freeze, [">= 3.3", "< 4"])
     s.add_dependency(%q<simple_form>.freeze, [">= 5.1", "< 6"])
     s.add_dependency(%q<vanilla_nested>.freeze, [">= 1.3", "< 2"])

data/lib/cookbook/mixins/acts_as_use_of.rb

@@ -11,10 +11,28 @@ module Cookbook
         include InstanceMethods
 
         self.used_in = model_symbols
+        Cookbook::Use.add_use_in(table_name.to_sym)
 
         # Relationships
-        has_many :uses, as: :use_in, class_name: 'Cookbook::Use'
+        has_many :uses, as: :use_in, class_name: 'Cookbook::Use', inverse_of: :use_in
+        # Used only as a setter, not a getter
+        accepts_nested_attributes_for :uses, reject_if: :all_blank, allow_destroy: true
         associate_used_in
+
+        used_in.each do |table_sym|
+          singular = table_sym.to_s.singularize
+          model = singular.classify.constantize
+          equals_method_symbol = "#{singular}_uses_attributes=".to_sym
+          define_method(equals_method_symbol) do |values|
+            items = []
+            values.each_pair do |key, value|
+              value['use_in'] = self
+              value['use_of'] = model.find_by(id: value['use_of_id'])
+              items << value
+            end
+            self.uses_attributes = items
+          end
+        end
       end
 
       # Extended by has_cookbook mixin
@@ -27,20 +45,31 @@ module Cookbook
             model = table_sym.to_s.classify.constantize
             name = model.model_name.to_s
             uses_symbol = "#{model.model_name.param_key}_uses".to_sym
+            singular_symbol = table_sym.to_s.singularize.to_sym
 
             has_many uses_symbol, lambda {
               where(use_of_type: name)
-            }, as: :use_in, class_name: 'Cookbook::Use'
+            }, as: :use_in, class_name: 'Cookbook::Use', inverse_of: singular_symbol
+
+            # Used only as a getter, not a setter
             accepts_nested_attributes_for uses_symbol, reject_if: :all_blank, allow_destroy: true
 
-            has_many table_sym, through: :uses, source: :use_of, source_type: name
+            has_many table_sym, through: uses_symbol, source: :use_of, source_type: name
 
             if defined?(RailsAdmin)
               rails_admin do
+                include_all_fields
                 field :uses do
                   visible false
                 end
                 tables.each do |table_sym|
+                  singular = table_sym.to_s.singularize
+                  uses_symbol = "#{singular}_uses".to_sym
+                  field uses_symbol do # Show only on reload
+                    visible do
+                      !bindings[:object].new_record?
+                    end
+                  end
                   field table_sym do # We don't want these associations to show
                     visible false
                   end

data/lib/cookbook/mixins/acts_as_used_in.rb

@@ -10,20 +10,38 @@ module Cookbook
         extend ClassMethods
         include InstanceMethods
 
-        self.uses_of = model_symbols
+        self.use_of = model_symbols
         self.label_method = :name
+        Cookbook::Use.add_use_of(table_name.to_sym)
 
         # Relationships
-        has_many :uses, as: :use_of, class_name: 'Cookbook::Use'
+        has_many :uses, as: :use_of, class_name: 'Cookbook::Use', inverse_of: :use_of
         associate_uses_of
+
+        if defined?(RailsAdmin)
+          rails_admin do
+            field :uses do
+              visible false
+            end
+            self.use_of.each do |table_sym| # We don't want these associations to show
+              table_uses_sym = "#{table_sym.to_s.singularize}_uses".to_sym
+              field table_uses_sym do
+                visible false
+              end
+              field table_sym do
+                visible false
+              end
+            end
+          end
+        end
       end
 
       # Extended by acts_as_used_in mixin
       module ClassMethods
-        attr_accessor :uses_of, :label_method
+        attr_accessor :label_method, :use_of
 
         def associate_uses_of
-          uses_of.each do |table_sym|
+          self.use_of.each do |table_sym|
             model = table_sym.to_s.classify.constantize
             name = model.model_name.to_s
 

data/lib/cookbook.rb

@@ -19,7 +19,6 @@ module Cookbook
   require 'haml-rails'
   require 'sass-rails'
   require 'simple_form'
-  require 'vanilla_nested'
   require 'cancancan' if Cookbook.configuration.authorize_with == :cancancan
 end
 

data/spec/dummy/app/javascript/packs/application.js

@@ -13,4 +13,5 @@
 //= require rails-ujs
 //= require activestorage
 //= require cookbook
+//= require ../../../../../app/assets/javascripts/cookbook
 //= require_tree .