formtastic_tristate_radio 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 654200d81e8ba934c905356fa626b6089419edc8a81021bed298793c283c6c7b
-  data.tar.gz: 5d3230415c94b4d2d054a25f1a4bbd339554f77bddd878798e9c5c4686ab140f
+  metadata.gz: 8fdf4d000b01b98679b7b2e4eb9bbb8ac43e2bdec9dfe79aba6e07ed580f0cbf
+  data.tar.gz: 7734d39327b809b599b058362e091df2e6153749ff6cfad5a7cb7ac91756e1a2
 SHA512:
-  metadata.gz: 9d88136b057f6cc2c17e890c73851c20e29dea4b107671d28f2936beac64da1b7dda13fa9ff07dee076ec512bfd698b3669b38ce28f534bbdeeb0e925c84802b
-  data.tar.gz: dc1a06b004aca154a1b728d4bcb14c798bc1eb998fff614c675128c5a36c2a9f860abdd17ee90763c98d59da23e34acef57236e8ef56e443ae96d423625c9e66
+  metadata.gz: e67a6dfe2440683e483d9d2bb677b66a87d335625a1ca7622888e641b3b0c36d8602ef502708d2098e78b4d3f15985ca59b6105d17f661adb4e72ea5661f07a1
+  data.tar.gz: 9fcd6fe99ddfba81237d17305abcc6e1de6febcc05765c442c265bdb5293adaea88bd9364affac0c374929a4ebc1113cba8c98ad7eb82dd11440cde462fa7606

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,162 @@
+PATH
+  remote: .
+  specs:
+    formtastic_tristate_radio (0.2.3)
+      formtastic (>= 3, < 5)
+      rails (>= 4, < 7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    formtastic (4.0.0)
+      actionpack (>= 5.2.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.5-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    yard (0.9.26)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-darwin-17
+
+DEPENDENCIES
+  formtastic_tristate_radio!
+  rspec (~> 3)
+  yard (>= 0.9.20, < 1)
+
+BUNDLED WITH
+   2.2.27

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 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

@@ -27,8 +27,7 @@ Some may consider this practice questionable — I don’t think so. In real
 For a Boolean column with 3 possible states:
 
 ```ruby
-f.input :am_i_awake,      as: :tristate_radio
-f.input :is_this_a_dream, as: :tristate_radio, null: "Reality is a persistent hallucination"
+f.input :am_i_awake, as: :tristate_radio
 ```
 
 You get (HTML is simplified, actually there are more classes etc.):
@@ -40,13 +39,6 @@ You get (HTML is simplified, actually there are more classes etc.):
   <input name="am_i_awake" type="radio" value="false"> <label>No</label>
   <input name="am_i_awake" type="radio" value="null">  <label>Unset</label>
 </fieldset>
-
-<fieldset>
-  <legend>Is this a dream?</legend>
-  <input name="is_this_a_dream" type="radio" value="true">  <label>Yes</label>
-  <input name="is_this_a_dream" type="radio" value="false"> <label>No</label>
-  <input name="is_this_a_dream" type="radio" value="null">  <label>Reality is a persistent hallucination</label>
-</fieldset>
 ```
 
 
@@ -106,15 +98,17 @@ end
 which will result in:
 
 ```html
-<input name="am_i_awake" type="radio" value="__unset"> <label>Unset</label>
+<input type="radio" name="am_i_awake" value="true">
+<input type="radio" name="am_i_awake" value="false">
+<input type="radio" name="am_i_awake" value="__unset">
 ```
 
-Mind that for that to work, you also need to configure `ActiveModel` to recognize that value as `nil`. Currently that is done [like so](https://github.com/sergeypedan/formtastic-tristate-radio/blob/master/config/initializers/activemodel_type_boolean.rb#L9).
+Mind that for your custom value to work, you also need to configure `ActiveModel` to recognize that value as `nil`. Currently that is done [like so](https://github.com/sergeypedan/formtastic-tristate-radio/blob/master/config/initializers/activemodel_type_boolean.rb#L9).
 
 
 ## Documentation
 
-Low-level methods are properly documented in RubyDoc [here](https://www.rubydoc.info/gems/formtastic_tristate_radio/).
+Low-level methods are properly documented in RubyDoc [here](https://www.rubydoc.info/gems/formtastic_tristate_radio/TristateRadioInput).
 
 
 ## Dependencies
@@ -136,7 +130,7 @@ In Ruby any String is cast to `true`:
 
 Web form params are passed as plain text and are interpreted as String by Rack.
 
-So how Boolean values are transfered as strings if a `"no"` or `"0"` and even `""` is truthy in Ruby?
+So how are Boolean values transfered as strings if a `"no"` or `"0"` and even `""` is truthy in Ruby?
 
 Frameworks just have a list of string values to be recognized and mapped to Boolean values:
 
@@ -193,6 +187,7 @@ ActiveModel::Type::Boolean.new.cast(:nil)   #=> nil
 
 ## Roadmap
 
+- [ ] Remove `require_relative "../app/models/active_record/base"` from main file
 - [x] Make the gem configurable
 - [x] Pull the key used for “unset” choice value into configuration
 - [ ] Load translations from gem

data/config/locales/active_admin.yml

@@ -0,0 +1,60 @@
+---
+ca:
+  active_admin:
+    status_tag:
+      :null: No establert
+---
+de:
+  active_admin:
+    status_tag:
+      :null: Nicht eingestellt
+---
+fr:
+  active_admin:
+    status_tag:
+      :null: Pas défini
+---
+it:
+  active_admin:
+    status_tag:
+      :null: Sconosciuto
+---
+ja:
+  active_admin:
+    status_tag:
+      :null: 不明
+---
+en:
+  active_admin:
+    status_tag:
+      :null: Unset
+---
+es:
+  active_admin:
+    status_tag:
+      :null: No establecido
+---
+pl:
+  active_admin:
+    status_tag:
+      :null: Nie ustawiony
+---
+pt-BR:
+  active_admin:
+    status_tag:
+      :null: Não configurado
+---
+pt:
+  active_admin:
+    status_tag:
+      :null: Não configurado
+---
+ru:
+  active_admin:
+    status_tag:
+      :null: Неизвестно
+---
+tr:
+  active_admin:
+    status_tag:
+      :null: Ayarlanmadı

data/config/locales/formtastic.yml

@@ -0,0 +1,48 @@
+---
+ca:
+  formtastic:
+    :null: No establert
+---
+de:
+  formtastic:
+    :null: Nicht eingestellt
+---
+fr:
+  formtastic:
+    :null: Pas défini
+---
+it:
+  formtastic:
+    :null: Sconosciuto
+---
+ja:
+  formtastic:
+    :null: 不明
+---
+en:
+  formtastic:
+    :null: Unset
+---
+es:
+  formtastic:
+    :null: No establecido
+---
+pl:
+  formtastic:
+    :null: Nie ustawiony
+---
+pt-BR:
+  formtastic:
+    :null: Não configurado
+---
+pt:
+  formtastic:
+    :null: Não configurado
+---
+ru:
+  formtastic:
+    :null: Неизвестно
+---
+tr:
+  formtastic:
+    :null: Ayarlanmadı

data/formtastic_tristate_radio.gemspec

@@ -0,0 +1,60 @@
+# 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_tristate_radio/version"
+
+Gem::Specification.new do |spec|
+  spec.name             = "formtastic_tristate_radio"
+  spec.version          =  FormtasticTristateRadio::VERSION
+  spec.authors          = ["Sergey Pedan"]
+  spec.email            = ["sergey.pedan@gmail.com"]
+  spec.license          =  "MIT"
+
+  spec.summary          =  "Have 3-state radiobuttons instead of a 2-state checkbox for your Boolean columns which can store NULL"
+  spec.description      = <<~HEREDOC
+                            #{spec.summary}.
+
+                            What the gem does?
+
+                            1. Provides a custom Formtastic input type `:tristate_radio` which renders 3 radios (“Yes”, “No”, “Unset”) instead of a checkbox (only where you put it).
+                            1. Teaches Rails recognize `"null"` and `"nil"` param values as `nil`. See “[How it works](#how-it-works)” ☟ section for technical details on this.
+                            1. Encourages you to add translations for ActiveAdmin “status tag” so that `nil` be correctly translated as “Unset” instead of “False”.
+
+                            Does not change controls, you need to turn it on via `as: :tristate_radio` option.
+
+                            By defenition Boolean values have 2 states: True & False.
+
+                            However, if you store a Boolean value in a database column with no `NOT NULL` restriction, it aquires a 3<sup>d</sup> possible state: `null`.
+
+                            Some may consider this practice questionable — I don’t think so. In real life you always have a case when the answer to your question may be only “yes” or “no”, but you don’t know the answer yet. Using a string type column, storing there `"yes"`, `"no"` and `"unset"` + using a state machine + validations — feels overkill to me.
+                          HEREDOC
+
+  spec.homepage         =  "https://github.com/sergeypedan/formtastic-tristate-radio"
+  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", "app/models/active_record", "config/initializers", "config/locales", "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", "< 7"
+
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "yard",  ">= 0.9.20", "< 1"
+end

data/lib/formtastic_tristate_radio/missing_translation_error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module FormtasticTristateRadio
-  class MissingTranslationError < StandardError
+  class MissingTranslationError < I18n::MissingTranslationData
   end
 end

data/lib/formtastic_tristate_radio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FormtasticTristateRadio
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formtastic_tristate_radio
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Sergey Pedan
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-04 00:00:00.000000000 Z
+date: 2021-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: formtastic
@@ -70,7 +70,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.20
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
@@ -80,13 +80,26 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.20
     - - "<"
       - !ruby/object:Gem::Version
         version: '1'
-description: 'Have 3-state radiobuttons instead of a 2-state checkbox for your Boolean
-  columns which can store NULL. Does not change controls, you need to turn it on via
-  `as: :tristate_radio` option.'
+description: |
+  Have 3-state radiobuttons instead of a 2-state checkbox for your Boolean columns which can store NULL.
+
+  What the gem does?
+
+  1. Provides a custom Formtastic input type `:tristate_radio` which renders 3 radios (“Yes”, “No”, “Unset”) instead of a checkbox (only where you put it).
+  1. Teaches Rails recognize `"null"` and `"nil"` param values as `nil`. See “[How it works](#how-it-works)” ☟ section for technical details on this.
+  1. Encourages you to add translations for ActiveAdmin “status tag” so that `nil` be correctly translated as “Unset” instead of “False”.
+
+  Does not change controls, you need to turn it on via `as: :tristate_radio` option.
+
+  By defenition Boolean values have 2 states: True & False.
+
+  However, if you store a Boolean value in a database column with no `NOT NULL` restriction, it aquires a 3<sup>d</sup> possible state: `null`.
+
+  Some may consider this practice questionable — I don’t think so. In real life you always have a case when the answer to your question may be only “yes” or “no”, but you don’t know the answer yet. Using a string type column, storing there `"yes"`, `"no"` and `"unset"` + using a state machine + validations — feels overkill to me.
 email:
 - sergey.pedan@gmail.com
 executables: []
@@ -96,22 +109,23 @@ extra_rdoc_files:
 - CHANGELOG.md
 files:
 - CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
 - README.md
 - Rakefile
 - app/inputs/tristate_radio_input.rb
 - app/models/active_record/base.rb
 - config/initializers/activemodel_type_boolean.rb
-- config/locales/active_admin.en.yml
-- config/locales/active_admin.ru.yml
-- config/locales/formtastic.en.yml
-- config/locales/formtastic.ru.yml
+- config/locales/active_admin.yml
+- config/locales/formtastic.yml
 - config/routes.rb
+- formtastic_tristate_radio.gemspec
 - lib/formtastic_tristate_radio.rb
 - lib/formtastic_tristate_radio/configuration.rb
 - lib/formtastic_tristate_radio/engine.rb
 - lib/formtastic_tristate_radio/missing_translation_error.rb
 - lib/formtastic_tristate_radio/version.rb
-- lib/tasks/formtastic_tristate_radio_tasks.rake
 homepage: https://github.com/sergeypedan/formtastic-tristate-radio
 licenses:
 - MIT
@@ -124,11 +138,11 @@ post_install_message:
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
-- lib
 - app/inputs
 - app/models/active_record
 - config/initializers
 - config/locales
+- lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/config/locales/active_admin.en.yml

@@ -1,5 +0,0 @@
----
-en:
-  active_admin:
-    status_tag:
-      unset: Unset

data/config/locales/active_admin.ru.yml

@@ -1,7 +0,0 @@
----
-ru:
-  active_admin:
-    status_tag:
-      :no: Нет
-      :yes: Да
-      unset: Неизвестно

data/config/locales/formtastic.en.yml

@@ -1,4 +0,0 @@
----
-en:
-  formtastic:
-    :null: Unset

data/config/locales/formtastic.ru.yml

@@ -1,6 +0,0 @@
----
-ru:
-  formtastic:
-    :no: Нет
-    :null: Неизвестно
-    :yes: Да

data/lib/tasks/formtastic_tristate_radio_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :formtastic_tristate_radio do
-#   # Task goes here
-# end