optimism 0.2.10

data/setup.md

@@ -0,0 +1,45 @@
+---
+description: Form validations in five minutes or it's free
+---
+
+# Setup
+
+Optimism has a relatively small number of dependencies, but it does assume that it's being run in a Rails project with ActionCable configured for the environments you intend to operate in. You can easily install Optimism to new and existing Rails projects.
+
+```bash
+bundle add optimism
+yarn add cable_ready
+rake optimism:install
+```
+
+The terminal commands above will ensure that Optimism is installed. It creates the client-side websocket channel infrastructure required to process the list of commands from the server. All of this is possible because it's built on the shoulders of the incredible [CableReady](https://cableready.stimulusreflex.com/) gem, which gives developers the ability to tweak many different aspects of the current page from the server.
+
+**Anyhow... that's it: you're ready to start integrating Optimism into your user interfaces**.
+
+![](.gitbook/assets/setup.svg)
+
+### Logging
+
+In the default _debug_ log level, ActionCable emits particularly verbose log messages. You can optionally discard everything but exceptions by switching to the _warn_ log level, as is common in development environments:
+
+{% code title="config/environments/development.rb" %}
+```ruby
+# :debug, :info, :warn, :error, :fatal, :unknown
+config.log_level = :warn
+```
+{% endcode %}
+
+### Troubleshooting
+
+{% hint style="info" %}
+If _something_ goes wrong, it's often because of the **spring** gem. You can test this by temporarily setting the `DISABLE_SPRING=1` environment variable and restarting your server.
+
+To remove **spring** forever, here is the process we recommend:
+
+1. `pkill -f spring`
+2. `bundle remove spring spring-watcher-listen --install`
+3. `bin/spring binstub -remove -all`
+{% endhint %}
+
+
+

data/typical-usage.md

@@ -0,0 +1,102 @@
+# Typical Usage
+
+Now that you have seen what Optimism can do, let's flex our muscles a bit and see how far this goes.
+
+{% tabs %}
+{% tab title="Vanilla Rails Scaffold" %}
+{% code title="app/views/posts/\_form.html.erb" %}
+```rust
+<%= form_with(model: post, id: "posts_form") do |form| %>
+  <%= form.container_for :name, class: "field" do %>
+    <%= form.label :name %>
+    <%= form.text_field :name %>
+    <%= form.error_for :name, class: "danger hide" %>
+  <% end %>
+
+  <%= form.container_for :body, class: "field" do %>
+    <%= form.label :body %>
+    <%= form.text_area :body %>
+    <%= form.error_for :body, class: "danger hide" %>
+  <% end %>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
+<% end %>
+```
+{% endcode %}
+{% endtab %}
+
+{% tab title="Bootstrap 4" %}
+{% code title="app/views/posts/\_form.html.erb" %}
+```rust
+<%= form_with(model: post, id: "posts_form") do |form| %>
+  <%= form.container_for :name, class: "form-group" do %>
+    <%= form.label :name %>
+    <%= form.text_field :name, class: "form-control" %>
+    <%= form.error_for :name, class: "small align-bottom text-danger d-none" %>
+  <% end %>
+
+  <%= form.container_for :body, class: "form-group" do %>
+    <%= form.label :body %>
+    <%= form.text_area :body, class: "form-control" %>
+    <%= form.error_for :body, class: "small align-bottom text-danger d-none" %>
+  <% end %>
+
+  <div class="actions">
+    <%= form.submit %>
+  </div>
+<% end %>
+```
+{% endcode %}
+{% endtab %}
+{% endtabs %}
+
+Here we introduce the `container_for` helper, which wraps a form element in a `div` that has an id similar to the `error_for` helper, except you're looking at _posts\_body\_container_. More importantly, the container receives a CSS class called _error_ that can be used to change the visual characteristics of the error message as well as the input element itself. **It is this interplay between cascading style and the order in which the styles are declared that makes this approach work.** Consider the following CSS:
+
+{% tabs %}
+{% tab title="Vanilla Rails Scaffold" %}
+```css
+.danger {
+  color: red;
+}
+
+.hide {
+  display: none;
+}
+
+.field.error > .hide {
+  display: block;
+}
+
+.field.error > input,
+.field.error > textarea {
+  background-color: rgba(255, 239, 213, 0.7);
+}
+```
+{% endtab %}
+
+{% tab title="Bootstrap 4" %}
+```css
+.form-group.error > .d-none {
+  display: inline !important;
+}
+
+.form-group.error > input,
+.form-group.error > textarea {
+  background-color: rgba(255, 239, 213, 0.7);
+}
+```
+{% endtab %}
+{% endtabs %}
+
+When there is a validation error on an input element, the error message is injected into the span and an _error_ CSS class is added to the container for that element. This results in a cascade where **the class responsible for hiding the error message is now flipped to display it instead**. In this example, we also show how we can change the visual characteristics of the input elements themselves, in this case making the background color a sickly and distressing translucent peach. It really helps sell the urgency.
+
+If you assign an id to the form itself that matches the expected format - in this case, `posts_form` - Optimism will also place an _invalid_ class on the form if there are _any_ errors at all. This gives the developer the flexibility to demonstrate an error state at the form level by tweaking how the form is displayed.
+
+{% hint style="info" %}
+Unfortunately, we can't automatically generate the id for the form during its own declaration. Luckily, the format is pretty easy: **resources\_form**.
+{% endhint %}
+
+![](.gitbook/assets/web_developer.svg)
+

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: optimism
+version: !ruby/object:Gem::Version
+  version: 0.2.10
+platform: ruby
+authors:
+- leastbad
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: cable_ready
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.9
+description: Realtime remote form input validations delivered via websockets
+email:
+- hello@leastbad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitbook/assets/alien_science.svg"
+- ".gitbook/assets/fill_forms.svg"
+- ".gitbook/assets/high_five.svg"
+- ".gitbook/assets/loading.svg"
+- ".gitbook/assets/master_plan.svg"
+- ".gitbook/assets/setup.svg"
+- ".gitbook/assets/special_event.svg"
+- ".gitbook/assets/success_factors.svg"
+- ".gitbook/assets/super_woman.svg"
+- ".gitbook/assets/web_developer.svg"
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- SUMMARY.md
+- advanced-usage.md
+- bin/console
+- bin/loc
+- bin/setup
+- bin/standardize
+- lib/optimism.rb
+- lib/optimism/railtie.rb
+- lib/optimism/rake.rb
+- lib/optimism/version.rb
+- lib/templates/optimism_channel.js
+- lib/templates/optimism_channel.rb
+- optimism.gemspec
+- quick-start.md
+- reference.md
+- setup.md
+- typical-usage.md
+homepage: https://github.com/leastbad/optimism
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Drop-in Rails form validations
+test_files: []