formtastic_grouped_check_boxes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f3d955d833d5ceb811a388f7e00ce870f8fa53e8f8c703e49a7e549349f4fa4
+  data.tar.gz: 36bf37b3e215387547bd12adb674b13f3a819b42e1b7fd001e82e5967f096ec3
+SHA512:
+  metadata.gz: 8f72c14546ae640f567f3144737cc1cc2f54809eb9d20808022d9688f408bdfb6e1f622075b7cfa6f184287857c111ca869094eafd2aa562088a401845ba1681
+  data.tar.gz: ade6206ca2f57fad0ebaa83db7516a23fdb847a394720b9a1b8330a21b33e469ac021d116b36ab6248fec0d95827a08a1639282657c0a05d7f0a72857cfa0d1e

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec # Specify your gem's dependencies in .gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Sergey Pedan
+
+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,114 @@
+# Formtastic grouped checkboxes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "formtastic_grouped_check_boxes"
+```
+
+Import our Sass file “formtastic-grouped-check-boxes.css” in your CSS entrypoint that compiles CSS files:
+
+```sass
+// app/assets/stylesheets/application.sass
+
+// Your regular ActiveAdmin files
+@import ...
+@import ...
+
+// This gem’s files
+@import "formtastic-grouped-check-boxes"
+```
+
+## Use
+
+This gem adds a new input type `:grouped_check_boxes`.
+
+It also adds 3 new input options, 2 of which follow the Rails naming convention from `grouped_collection_select`:
+
+- `group_method` — The name of a method which, when called on a member of collection, returns an array of child objects. It can also be any object that responds to call, such as a proc, that will be called for each member of the collection to retrieve the value.
+- `group_label_method` — The name of a method which, when called on a member of collection, returns a string to be used as the label attribute for its <optgroup> tag. It can also be any object that responds to call, such as a proc, that will be called for each member of the collection to retrieve the label.
+- `group_label_parent` — Whether to prepend the fieldset label with the parent input title
+
+```ruby
+ActiveAdmin.register Project do
+  permit_params technology_ids: []
+
+  form do |f|
+    f.inputs "Technologies" do
+      f.input :technologies,
+              as: :grouped_check_boxes, \
+              collection: Technology.select(:id, :name, :area_id).includes(:area).order(:name), \
+              group_method: :area, \
+              group_label_method: :name, \
+              group_label_parent: true
+    end
+  end
+end
+```
+
+Providing that
+
+```ruby
+class Technology < ApplicationRecord
+  belongs_to :area, foreign_key: :area_id, class_name: "TechnologyArea", optional: true
+end
+```
+
+```ruby
+class TechnologyArea < ApplicationRecord
+  has_many :technologies
+end
+```
+
+Results in
+
+```html
+<fieldset class="inputs">
+  <legend><span>Technologies</span></legend>
+  <ol>
+    <li class="grouped_check_boxes check_boxes input optional" id="project_technologies_input">
+      <input type="hidden" name="project[technology_ids][]" id="project_technologies_none" value="" autocomplete="off">
+
+      <fieldset class="choices grouped_check_boxes__choices">
+        <legend class="label grouped_check_boxes__legend">
+          <label class="grouped_check_boxes__legend__label">Technologies / No subgroup</label>
+        </legend>
+
+        <ol class="choices-group grouped_check_boxes__choices-group">
+          <li class="choice grouped_check_boxes__choice">
+            <label for="project_technology_ids_46">
+              <input type="checkbox" name="project[technology_ids][]" id="project_technology_ids_46" value="46">BitBucket
+            </label>
+          </li>
+          <li class="choice grouped_check_boxes__choice">
+            <label for="project_technology_ids_138">
+              <input type="checkbox" name="project[technology_ids][]" id="project_technology_ids_138" value="138">BrainTree API (Ruby SDK)
+            </label>
+          </li>
+        </ol>
+      </fieldset>
+
+      <fieldset class="choices grouped_check_boxes__choices">
+        <legend class="label grouped_check_boxes__legend">
+          <label class="grouped_check_boxes__legend__label">Technologies / Marketing</label>
+        </legend>
+
+        <ol class="choices-group grouped_check_boxes__choices-group">
+          <li class="choice grouped_check_boxes__choice">
+            <label for="project_technology_ids_59">
+              <input type="checkbox" name="project[technology_ids][]" id="project_technology_ids_59" value="59">Direct sales
+            </label>
+          </li>
+          <li class="choice grouped_check_boxes__choice">
+            <label for="project_technology_ids_89">
+              <input type="checkbox" name="project[technology_ids][]" id="project_technology_ids_89" value="89">Google Analytics
+            </label>
+          </li>
+        </ol>
+      </fieldset>
+    </li>
+  </ol>
+</fieldset>
+```

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+
+# APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/app/assets/stylesheets/formtastic-grouped-check-boxes.sass

@@ -0,0 +1,19 @@
+.grouped_check_boxes
+	&__legend
+		margin-left: 0.75rem
+		width: max-content
+
+		&__label
+			float: none
+			width: 100%
+
+	&__choices
+		border: solid 1px hsla(0, 0%, 50%, 0.2)
+		padding-bottom: 1rem
+		padding-top: 0.5rem
+
+		& + &
+			margin-top: 1rem
+
+	&__choices-group
+		margin-bottom: 0

data/app/inputs/grouped_check_boxes_input.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+class GroupedCheckBoxesInput < Formtastic::Inputs::CheckBoxesInput
+
+	# => "<li class=\"grouped_check_boxes check_boxes input optional\" >...</li>"
+	# we want to reuse existing CSS from regular checkboxes
+	#
+	def as
+		super + " check_boxes"
+	end
+
+
+	# input_wrapping        # => "<li class=\"grouped_check_boxes input optional\" id=\"project_technologies_input\">\n\n</li>"
+	# hidden_field_for_all  # => "<input type=\"hidden\" name=\"project[technology_ids][]\" id=\"project_technologies_none\" value=\"\" autocomplete=\"off\" />"
+	#
+	def to_html
+		input_wrapping do
+			hidden_field_for_all << fieldsets_for_groups
+		end
+	end
+
+
+	# legend_html       # => "<legend class=\"label\"><label>Technologies</label></legend>"
+	# choices_wrapping  # => "<fieldset class=\"choices\"></fieldset>"
+	#
+	def fieldsets_for_groups
+		grouped_collection.
+		map { |group_method_call_return_value, group_records|
+			choices_wrapping do
+				legend_html(group_method_call_return_value) << lis_with_checkboxes(group_records)
+			end
+		}.join("\n").html_safe
+	end
+
+
+	def choices_wrapping_html_options
+		{ class: ["choices", "grouped_check_boxes__choices"] }
+	end
+
+
+	def legend_html(group_method_call_return_value)
+		template.content_tag :legend, label_html_options.merge(class: ["label", "grouped_check_boxes__legend"]) do
+			template.content_tag :label, class: "grouped_check_boxes__legend__label" do
+				acc = []
+				acc << (label_text + " / ") if input_options[:group_label_parent]
+				acc << group_name(group_method_call_return_value)
+				acc.join("\n").html_safe
+			end
+		end
+	end
+
+
+	# choices_group_wrapping  # => <ol class="choices-group">...</ol>
+	#
+	def lis_with_checkboxes(records)
+		choices_group_wrapping do
+			choices_group_contents(records)
+		end
+	end
+
+
+	def choices_group_wrapping_html_options
+		{ class: ["choices-group", "grouped_check_boxes__choices-group"] }
+	end
+
+
+	# @return [String] of concatenated <li>s
+	#
+	def choices_group_contents(group_choice_records)
+		normalized_collection(collection, group_choice_records).map { |choice|
+			choice_wrapping(choice_wrapping_html_options(choice)) { # <li class="choice">
+				choice_html(choice)                                   #   <label for="project_technology_ids_49">
+																															#     <input type="checkbox" name="project[technology_ids][]" id="project_technology_ids_49" value="49" />AWS Route53
+																															#   </label>
+			}                                                       # </li>
+		}.join("\n").html_safe
+	end
+
+
+	def choice_wrapping_html_options(choice)
+		classes = ["choice", "grouped_check_boxes__choice"]
+		classes << "#{sanitized_method_name.singularize}_#{choice_html_safe_value(choice)}" if value_as_class?
+
+		{ class: classes.join(" ") }
+	end
+
+
+	def grouped_collection
+		fail "You must provide a `:collection` input option" unless collection_from_options
+
+		case (predicat = input_options.fetch(:group_method))
+		when Proc   then collection_from_options.group_by { |record| predicat.call(record) }
+		when Symbol then collection_from_options.group_by { |record| record.public_send(predicat) }
+		else fail "You must provide either a Proc or a Symbol in the `:group_method` input option"
+		end
+	end
+
+
+	# `collection` is an Array of [label, value] Arrays, so `arr_el.second` will return the <option value="">
+	# `group_records` is an Array of ActiveRecord objects
+	# `value_method` is a Symbol of the method name called on each record to get what to insert into the <option value="">
+	#
+	def normalized_collection(collection, group_records)
+		collection.select do |arr_el|
+			group_records
+				.map(&value_method.to_sym)
+				.include?(arr_el.second)
+		end
+	end
+
+
+	def group_name(group_record_or_label)
+		return "No subgroup" unless group_record_or_label
+
+		if (label_method = input_options[:group_label_method].presence)
+			group_record_or_label.public_send(label_method)
+		else
+			group_record_or_label
+		end
+	end
+
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/formtastic_grouped_check_boxes.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# https://guides.rubygems.org/name-your-gem/
+# https://bundler.io/guides/creating_gem.html
+# https://guides.rubyonrails.org/engines.html
+# https://guides.rubyonrails.org/plugins.html
+
+require_relative "lib/formtastic_grouped_check_boxes/version"
+
+Gem::Specification.new do |spec|
+  spec.name             = "formtastic_grouped_check_boxes"
+  spec.version          =  FormtasticGroupedCheckBoxes::VERSION
+  spec.authors          = ["Sergey Pedan"]
+  spec.email            = ["sergey.pedan@gmail.com"]
+  spec.license          =  "MIT"
+
+  spec.summary          =  "..."
+  spec.description      = <<~HEREDOC
+                            #{spec.summary}. This gem:
+                          HEREDOC
+
+  spec.homepage         =  "https://github.com/sergeypedan/formtastic-grouped-checkboxes"
+  spec.extra_rdoc_files = ["README.md", "CHANGELOG.md"]
+  spec.rdoc_options     = ["--charset=UTF-8"]
+  spec.metadata         = { "changelog_uri"     => "#{spec.homepage}/blob/master/CHANGELOG.md",
+                            "documentation_uri" => "https://www.rubydoc.info/gems/#{spec.name}",
+                            "homepage_uri"      => spec.homepage,
+                            "source_code_uri"   => spec.homepage }
+
+  spec.require_paths    = ["app/inputs", "lib"]
+  spec.bindir           = "exe"
+  spec.executables      = []
+  spec.files            = Dir.chdir(File.expand_path(__dir__)) do
+                            `git ls-files`.split("\n")
+                              .reject { |f| %w[bin spec test].any? { |dir| f.start_with? dir } }
+                              .reject { |f| f.start_with? "." }
+                          end
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.add_dependency "formtastic", ">= 3", "< 5"
+  spec.add_dependency "rails",      ">= 4", "< 10"
+
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "yard",  ">= 0.9.20", "< 1"
+end

data/lib/formtastic_grouped_check_boxes/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module FormtasticGroupedCheckBoxes
+
+  # This is standard Rails way to autoload gem’s contents dynamically as an “engine”
+  # @see https://guides.rubyonrails.org/engines.html Rails guide on engines
+  #
+  class Engine < ::Rails::Engine
+  end
+
+end

data/lib/formtastic_grouped_check_boxes/version.rb

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

data/lib/formtastic_grouped_check_boxes.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "formtastic_grouped_check_boxes/version"
+require_relative "formtastic_grouped_check_boxes/engine"
+require_relative "../app/inputs/grouped_check_boxes_input"
+
+module FormtasticGroupedCheckBoxes
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: formtastic_grouped_check_boxes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Pedan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2023-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: formtastic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.20
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: ".... This gem:\n"
+email:
+- sergey.pedan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+files:
+- CHANGELOG.md
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/stylesheets/formtastic-grouped-check-boxes.sass
+- app/inputs/grouped_check_boxes_input.rb
+- config/routes.rb
+- formtastic_grouped_check_boxes.gemspec
+- lib/formtastic_grouped_check_boxes.rb
+- lib/formtastic_grouped_check_boxes/engine.rb
+- lib/formtastic_grouped_check_boxes/version.rb
+homepage: https://github.com/sergeypedan/formtastic-grouped-checkboxes
+licenses:
+- MIT
+metadata:
+  changelog_uri: https://github.com/sergeypedan/formtastic-grouped-checkboxes/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/formtastic_grouped_check_boxes
+  homepage_uri: https://github.com/sergeypedan/formtastic-grouped-checkboxes
+  source_code_uri: https://github.com/sergeypedan/formtastic-grouped-checkboxes
+post_install_message: 
+rdoc_options:
+- "--charset=UTF-8"
+require_paths:
+- app/inputs
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: "..."
+test_files: []