polutan 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 922efa48e9d130348c44b65161804fc2c9ec71a395e3544e37d3c7b9e96ad454
+  data.tar.gz: bb022c4abae1408f652ed500e6b2e73c98712bf08c3bf32fdc57f134d20c1c13
+SHA512:
+  metadata.gz: 3af8fc24dc11ffd2d1a0847b0dd0c52f7789a7dfc91d139bd8d47c5b43cca8a944d204a7242b90ed297e179bf92fcbe1b7d6ad25e2be2a2cbbac6240d663ff3a
+  data.tar.gz: 69e309e2f7ceb22b2180d972d508a419a6396be4b2eca398a44b017dc243930d89bb55a47d6c4f0f2e61b70717b5c38e04d5b5f230b9c077904d97f3ef31bddc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    polutan (1.0.0)
+      activeentity (~> 6.1)
+      kredis (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activeentity (6.3.0)
+      activemodel (>= 6.0, < 8)
+      activesupport (>= 6.0, < 8)
+    activemodel (7.0.2.2)
+      activesupport (= 7.0.2.2)
+    activesupport (7.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    kredis (0.4.0)
+      activesupport (>= 6.0.0)
+      redis (~> 4.2)
+    magic_frozen_string_literal (1.2.0)
+    method_source (0.9.2)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-nav (0.3.0)
+      pry (>= 0.9.10, < 0.13.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    redis (4.6.0)
+    regexp_parser (2.2.1)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.2)
+      parser (>= 3.0.1.1)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.7.2)
+      rubocop (= 1.25.1)
+      rubocop-performance (= 1.13.2)
+    standardrb (1.0.1)
+      standard
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  magic_frozen_string_literal (~> 1.2.0)
+  polutan!
+  pry (~> 0.12)
+  pry-nav (~> 0.3)
+  rake (~> 13.0, >= 13.0.3)
+  standardrb (~> 1.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Nervive Studio
+
+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,113 @@
+# Polutan
+
+The [polutan](https://github.com/nervive/polutan) gem offers Rails developers a way to **gather attributes** on an unsaved model **across multiple requests**. It's perfect for [StimulusReflex](https://docs.stimulusreflex.com/) users that are building faceted search interfaces, as well as [Optimism](https://optimism.nervive.studio/) users looking to implement real-time, per-attribute validation schemes.
+
+Try a demo, here: 👉 [Under Line StimulusReflex](https://underline.nervive.studio/) 👈
+
+[![GitHub stars](https://img.shields.io/github/stars/nervive/polutan?style=social)](https://github.com/nervive/polutan) [![GitHub forks](https://img.shields.io/github/forks/nervive/polutan?style=social)](https://github.com/nervive/polutan)
+
+## Why use Polutan?
+
+Many reactive UI concepts are a pain in the ass to implement using the classic Rails request/response pattern, which was created at a time before developers started using Ajax to update portions of a page. ActionController is designed to mutate state in response to form submissions, leading to abuse of the session object and awkward hacks to validate and persist models across multiple requests.
+
+Polutan presents a flexible and lightweight mechanism to refine a model that persists its attributes across multiple updates, and even multiple servers.
+
+## Is Polutan for you?
+
+Do you ever find yourself:
+
+* building complex search interfaces
+* creating multi-stage data entry processes
+* frustrated by the limitations of classic form submission
+* wanting to save data even if the model is currently invalid
+* reinventing the wheel every time you need field validation
+
+If you answered yes to any of the above... you are every Rails developer, and you're not crazy. This functionality has been a blind-spot in the framework for a long time.
+
+Yes, Polutan is for **you**.
+
+## Key features and advantages
+
+* A natural fit with [StimulusReflex](https://docs.stimulusreflex.com/) and [Stimulus](https://stimulus.hotwire.dev/)
+* No reliance on sessions, so it works across servers
+* Easy to learn, quick to implement
+* Supports model attributes with defaults, arrays and dirty checking
+* Model validations and errors
+* No need to mess around with temporary records
+
+## How does Polutan work?
+
+First, set up an Polutan class that defines some [attributes](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html#method-i-attribute). Your class will inherit from `Possibility`, which is aptly-named.
+
+```ruby
+class ExampleModel < Possibility
+  attribute :name, :string
+  attribute :age, :integer, default: 21
+end
+```
+
+Then create an instance and assign it to an instance variable in the controller responsible for your initial page load:
+
+```ruby
+class ExampleController < ApplicationController
+  def index
+    @af = ExampleModel.new
+  end
+end
+```
+
+Emit the instance id as a data attribute on every element which can update your model:
+
+```text
+Name: <input type="text" data-af="<%= @af.id %>" data-reflex="input->Example#name" /><br/>
+Age: <input type="text" data-af="<%= @af.id %>" data-reflex="input->Example#age" placeholder="<%= @id.age %>" />
+```
+
+Since all attributes are gathered and sent to the server during a Reflex operation, it's easy to retrieve the instance id from the Reflex element accessor and use it to call up the correct Polutan object and make changes to it:
+
+```ruby
+class ExampleReflex < ApplicationReflex
+  def name
+    model = ExampleModel.find(element.dataset.af)
+    model[:name] = element.value
+  end
+  
+  def age
+    model = ExampleModel.find(element.dataset.af)
+    model[:age] = element.value
+  end
+end
+```
+
+The current state of the attributes is persisted every time you set the value of an attribute using bracket notation. You can use standard setter assignments, but the model state will not be persisted until you manually call `save`:
+
+```ruby
+model[:name] = "Helen" # saved
+model.name = "Helen" # not saved
+model.save # saved
+```
+
+{% hint style="warning" %}
+Polutan class attributes are persisted in Redis via the excellent [Kredis](https://github.com/rails/kredis) gem, which must be set up and running in your project before you can use Polutan.
+{% endhint %}
+
+Polutan is based on [Active Entity](https://github.com/jasl/activeentity). It is similar to using [ActiveModel::Model](https://api.rubyonrails.org/classes/ActiveModel/Model.html), except that it has full support for [Attributes](https://api.rubyonrails.org/classes/ActiveRecord/Attributes/ClassMethods.html#method-i-attribute), including arrays and nested attributes. Polutan classes behave like ActiveModel classes, so you can inspect `valid?` and the `errors` accessor.
+
+```ruby
+class ExampleModel < Possibility
+  attribute :name, :string
+  validates :name, presence: true
+end
+
+model = ExampleModel.new
+model.valid? # false
+model.errors # @errors=[#<ActiveModel::Error attribute=name, type=blank, options={}>]
+```
+
+{% hint style="info" %}
+Unlike an ActiveRecord model, Polutan instances can persist their attributes even if the attributes are currently invalid. This design allows you to resolve any errors present, even if it takes several distinct operations to do so.
+{% endhint %}
+
+{% hint style="success" %}
+Once the state of your attributes is valid, you can pass the `attributes` from your Polutan model right into the constructor of a real ActiveRecord model. It should work perfectly.
+{% endhint %}

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "pry"

data/SUMMARY.md

@@ -0,0 +1,5 @@
+# Table of contents
+
+* [Polutan](README.md)
+* [Setup](setup.md)
+* [Usage](usage.md)

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "polutan"
+require "pry"
+
+Pry.start

data/bin/loc

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+cloc --exclude-dir=node_modules,test --include-ext=rb,js .

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/standardize

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+bundle exec magic_frozen_string_literal
+bundle exec standardrb --fix

data/lib/polutan/config.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Polutan
+  class Config
+    # Not implemented yet due to there being no configuration
+
+    # include Singleton
+    # attr_accessor :tomorrow
+
+    # def initialize
+    #   @tomorrow = Infinity
+    # end
+  end
+end

data/lib/polutan/possibility.rb

@@ -0,0 +1,28 @@
+class Possibility < ActiveEntity::Base
+  attr_accessor :id
+
+  def initialize(attributes={})
+    super
+    unless @id
+      @id = SecureRandom.uuid
+      save
+    end
+  end
+
+  def []=(attr_name, value)
+    super
+    save
+  end
+
+  def save
+    Kredis.json("#{self.class.name}:#{@id}").value = self.attributes.to_json
+    changes_applied
+  end
+
+  def self.find(id)
+    raise ArgumentError unless id
+    json = Kredis.json("#{name}:#{id}").value
+    raise ActiveRecord::RecordNotFound unless json
+    new json.merge(id: id)
+  end
+end

data/lib/polutan/version.rb

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

data/lib/polutan.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# require "rails/engine"
+# require "singleton"
+# require "active_support/all"
+
+require "active_entity/railtie"
+require "polutan/version"
+require "polutan/possibility"
+
+module Polutan
+  # class Engine < Rails::Engine
+  # end
+
+  # def self.config
+  #   Polutan::Config.instance
+  # end
+
+  # def self.configure
+  #   yield config
+  # end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: polutan
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nervive
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: kredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: activeentity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: magic_frozen_string_literal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.3
+- !ruby/object:Gem::Dependency
+  name: standardrb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: 
+email:
+- hello@nervive.studio
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- SUMMARY.md
+- bin/console
+- bin/loc
+- bin/setup
+- bin/standardize
+- lib/polutan.rb
+- lib/polutan/config.rb
+- lib/polutan/possibility.rb
+- lib/polutan/version.rb
+homepage: https://polutan.nervive.studio/
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/nervive/polutan
+  documentation_uri: https://polutan.nervive.studio/
+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.1.6
+signing_key: 
+specification_version: 4
+summary: A Redis-backed virtual ActiveModel, full of possibilities.
+test_files: []