nitro_rails 0.1.0 → 0.1.2

data/app/models/nitro_rails/default_broadcasts.rb

@@ -0,0 +1,149 @@
+module NitroRails
+  module DefaultBroadcasts 
+
+    # ------------------ #
+    # Generic Broadcasts #
+    # ------------------ #
+
+    def refresh_page
+      broadcast_to_user_or_public_later(:refresh) {}
+    end
+
+    # ------------------- #
+    # Creation Broadcasts #
+    # ------------------- #
+
+    def refresh_affiliatied_lists 
+      affiliations.each do |affiliation|
+        # broadcast_to_user_or_public_later(:refresh) do |broadcast|
+        #   broadcast.targets affiliation.nitro_data_id(collection_tag)
+        # end
+
+        broadcast_to_user_or_public_later(:refresh_frame) do |broadcast|
+          broadcast.targets affiliation.nitro_data_id(collection_tag)
+        end
+      end
+    end
+
+    def append_to_affiliated_lists
+      affiliations.each do |affiliation|
+        broadcast_to_user_or_public_later(:append) do |broadcast|
+          broadcast_attribute_tag = affiliation.nitro_data_id(collection_tag)
+          broadcast.targets broadcast_attribute_tag
+          broadcast.template(**partial_path)
+          broadcast.attributes(focus: true)
+        end
+      end
+    end
+
+    def insert_into_affiliated_lists
+      affiliations.each do |affiliation|
+        broadcast_to_user_or_public_later(:insert) do |broadcast|
+          broadcast.targets affiliation.nitro_data_id(collection_tag)
+          broadcast.template(**partial_path)
+          broadcast.attributes(position: 0)
+        end
+      end
+    end
+
+    def focus_on_new_resource
+      broadcast_to_user_or_public_later(:focus) do |broadcast|
+        broadcast.target nitro_data_id
+      end
+    end
+
+    # -------------------- #
+    # Attribute Broadcasts #
+    # -------------------- #
+    
+    def update_associated_attributes
+      saved_changes.each do |attribute, (old_value, new_value)|
+        next if skipped_attributes.include?(attribute.to_sym)
+        broadcast_attribute(attribute)
+      end
+    end
+
+    def broadcast_attribute(attribute)
+      new_value = send(attribute)
+      replace_attribute_content(attribute, new_value)
+
+      self.class.attribute_broadcasts[attribute.to_sym].to_a.each do |attribute_broadcast| 
+        send(*[attribute_broadcast, attribute, new_value][0..method(attribute_broadcast).arity])
+      end
+    end
+
+    def replace_attribute_content(attribute, value)
+      broadcast_to_user_or_public_later(:update) do |broadcast|
+        broadcast.targets nitro_data_id(attribute)
+        broadcast.template(inline: value.to_s)
+      end
+    end
+
+    def toggle_checkbox(attribute, value)
+      broadcast_to_user_or_public_later(:toggle_checkbox) do |broadcast|
+        broadcast.targets nitro_data_id(attribute)
+        broadcast.attributes(status: value.to_s)
+      end
+    end
+
+    def toggle_resource_attribute_class(attribute, value)
+      broadcast_to_user_or_public_later(:toggle_class) do |broadcast|
+        broadcast.targets nitro_data_id
+        broadcast.attributes(class: attribute, status: value)
+      end
+
+      broadcast_to_user_or_public_later(:toggle_class) do |broadcast|
+        broadcast.targets nitro_data_id
+        broadcast.attributes(class: "not-#{attribute}", status: !value)
+      end
+    end
+
+    # ------------------- #
+    # Deletion Broadcasts #
+    # ------------------- #
+    
+    def remove_everywhere
+      broadcast_to_user_or_public_later(:remove) do |broadcast|
+        broadcast.targets nitro_data_id
+      end
+    end
+
+    # Should we just redirect back?
+    def redirect_to_index 
+      broadcast_to_user_or_public_later(:redirect) do |broadcast| 
+        broadcast.attributes(on: path_for_record, to: "/")
+      end
+    end
+
+    # ------- #
+    # Helpers #
+    # ------- #
+
+    def broadcast_to_user_later(action, &block)
+      Broadcast.build(self, action, &block).perform_later
+    end
+
+    def broadcast_to_user_or_public_later(action, &block)
+      if defined?(User) && self.is_a?(User)
+        user = self
+      elsif self.respond_to?(:user)
+        user = self.user
+      else
+        user = :public
+      end
+
+      Broadcast.build(user, action, &block).perform_later
+    end
+
+    def nitro_data_id(*attributes)
+      "[data-nitro-id='#{nitro_id(*attributes)}']"
+    end
+
+    def partial_path 
+      { 
+        partial: "#{collection_tag}/#{type}", 
+        locals: { "#{type}": self, tag: :li, focus: true }
+      }
+    end
+  end
+end

data/app/models/nitro_rails/record.rb

@@ -0,0 +1,50 @@
+module NitroRails
+  class Record < ActiveRecord::Base
+    include Rails.application.routes.url_helpers
+
+    self.abstract_class = true
+
+    extend NitroRails::BroadcastableModel
+    include NitroRails::BroadcastableRecord
+
+    after_create :broadcast_create
+    after_update :broadcast_update  
+    after_destroy :broadcast_delete
+
+    def self.route_to(action)
+      @route ||= "/#{action.to_s.pluralize}"
+    end
+
+    def self.route
+      @route
+    end
+
+    def route 
+      self.class.route || polymorphic_path(self) 
+    end
+
+
+    # def self.organizable_by(methods) 
+    #   sortable_by(methods)
+    #   filterable_by(methods)
+    # end
+
+    # def self.sortable_by(methods)
+    #   @sortable_methods ||= self.column_names
+    #   @sortable_methods += methods 
+    # end
+
+    # def self.filterable_by(methods) 
+    #   @filterable_methods ||= self.column_names
+    #   @filterable_methods += methods
+    # end
+
+    # def self.sort_methods
+    #   @sortable_methods ||= self.column_names
+    # end
+
+    # def self.filter_methods
+    #   @filterable_methods ||= self.column_names
+    # end
+  end
+end

data/app/pseudocode/nitro.html.erb

@@ -0,0 +1,18 @@
+<%= nitro_resource(@project) do %>
+  <%= nitro_attribute(:title) %>
+
+  <%= nitro_collection(@project, :tasks) do |task| %>
+    <%= nitro_resource(task) do %>
+      <%= nitro_checkbox(:completed) %>
+      <%= nitro_editable_text(:description) %>
+      <%= nitro_panel_link("...") do %>
+        <%= list do %>
+          <%= nitro_destroy_button(task, "Delete Task") %>
+          <%= nitro_update_button("Archive Task", task, params: { status: "Archive" }) %>
+        <% end %>
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <%= nitro_create_button("New Task", [@project, :task]) %>
+<% end %>

data/app/view_components/nitro_rails/nitro_collection/batch_selectable.rb

@@ -0,0 +1,24 @@
+class NitroRails::NitroCollection
+  module BatchSelectable
+    def selection_panel(**options, &block)
+      nitro_options(options) do |options|
+        options.concat(:class, "hidden")
+        options.concat(:data, :nitro_collection_target, "selections")
+      end
+
+      nitro_tag(:div, **options, &block)
+    end
+
+    def selection_count
+      content_tag(:span, id: "selection-count") do
+        "0"
+      end
+    end
+
+    def selection_list 
+      content_tag(:div, id: "selection-list") do
+        ""
+      end
+    end
+  end
+end

data/app/view_components/nitro_rails/nitro_collection.rb

@@ -0,0 +1,66 @@
+class NitroRails::NitroCollection < NitroRails::ViewComponent
+  include NitroRails::NitroCollection::BatchSelectable
+
+  def initialize(resources, view:, **options)
+    @resources = resources
+    @view = view
+    @options = options
+  end
+
+  def render_content(&block)
+    container_tag(**@options) do 
+      concat(capture(self, &block)) if block_given?
+      concat(render_items) unless @resources_rendered
+    end
+  end
+
+  def container_tag(**options, &block)
+    nitro_options(options) do |options|
+      options.concat(:data, :controller, "nitro-collection")
+      options.concat(:data, :nitro_collection_target, "container")
+      options.concat(:data, :nitro_collection_id, nitro_id)
+    end
+    # TODO: Probably shouldn't have to use except here
+    nitro_tag(:div, **options.except(:class), &block)
+  end
+
+  def render_items(partial = nil, **options, &block)
+    @resources_rendered = true
+
+    nitro_collection_tag(:ul, parent, resource_method, data: { nitro_collection_target: :collection }, class: @options.delete(:class), **options) do
+      @resources.each do |resource|
+        concat(render_item(resource, partial, &block))
+      end
+    end
+  end
+
+  def render_item(resource, partial, &block)
+    if block_given? 
+      capture(resource, &block)
+    else 
+      if partial.present?
+        render(partial, "#{resource.type}": resource)
+      else 
+        render resource
+      end
+    end
+  end
+
+  private
+
+  def parent 
+    @parent ||= association&.owner
+  end
+
+  def resource_method
+    @resource_method ||= association&.reflection&.name
+  end
+
+  def nitro_id 
+    @nitro_id ||= "#{parent&.nitro_id}:#{resource_method}"
+  end
+
+  def association 
+    @association ||= @resources&.proxy_association
+  end
+end

data/app/view_components/nitro_rails/view_component.rb

@@ -0,0 +1,9 @@
+module NitroRails
+  class ViewComponent
+    delegate :content_tag, :concat, :capture, :form_tag, :hidden_field_tag, :render, :submit_tag, :turbo_stream_from, :request, :link_to, :url_for, :nitro_tag, :nitro_collection_tag, :nitro_options, to: :@view
+
+    def initialize(view:)
+      @view = view
+    end
+  end
+end

data/app/views/layouts/nitro_rails/application.html.erb

@@ -1,15 +1,13 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Nitro rails</title>
+  <title>Nitro Rails</title>
   <%= csrf_meta_tags %>
   <%= csp_meta_tag %>
 
-  <%= stylesheet_link_tag    "nitro_rails/application", media: "all" %>
+  <%= stylesheet_link_tag "nitro_rails/application", media: "all" %>
 </head>
 <body>
-
-<%= yield %>
-
+  <%= yield %>
 </body>
 </html>

data/app/views/nitro_rails/_editable_text.html.erb

@@ -0,0 +1,32 @@
+<div class="editable-text-container <%= attribute_classes(resource, attribute) %>" data-controller="editable-text">
+  <%# <turbo-frame> %>
+    <%= form_with(
+      model: resource_path, 
+      data: { 
+        editable_text_target: "form", 
+        editable_text_attribute_value: attribute,
+        turbo: true 
+      }
+    ) do |form| %>
+      <%= form.hidden_field(attribute, data: { editable_text_target: "input" }) %>
+      <%= hidden_field_tag(:context, context) %>
+    <% end %>
+    <div class="editable-text-content">
+      <%= error_badge(resource, attribute) %>
+      <%= content_tag(tag, resource.send(attribute),
+              contenteditable: true,
+              class: "editable-text", 
+              onfocus: "this.value = this.value;", 
+              autofocus: focus,
+              placeholder: placeholder || "Enter #{resource.class.name.downcase} #{attribute.to_s.humanize.downcase} here...", 
+              data: { 
+                nitro_id: resource.nitro_id(attribute), 
+                editable_text_target: "editor", 
+                focal_point: true, 
+                action: "blur->editable-text#blur focus->editable-text#focus keydown->editable-text#handleKeyDown" 
+              })
+      %>
+      <%= error_message(resource, attribute) %>
+    </div>
+  <%# </turbo-frame> %>
+</div>

data/app/views/nitro_rails/_nitro_checkbox.html.erb

@@ -0,0 +1,5 @@
+<%= form_with(model: record, **options) do |form| %>
+  <label class="nitro-checkbox">
+    <%= form.check_box(attribute, data: { nitro_form_target: "field", nitro_effects: record.attribute_effects_string(attribute), nitro_attribute: attribute, action: "change->nitro-form#submit", nitro_id: record.nitro_id(attribute) } ) %>
+  </label>
+<% end %>

data/app/views/nitro_rails/_nitro_form.html.erb

@@ -0,0 +1,10 @@
+<%= nitro_form(model: record, **options) do |form| %>
+  <%= form.generate_hidden_attribute_fields %>
+  <%# params.each do |key, value| %>
+    <%# form.hidden_attribute_field(key, value) %>
+  <%# end %>
+
+  <%= form.submit_div do %>
+    <% yield %>
+  <% end %>
+<% end %>

data/app/views/nitro_rails/_panel_frame_tag.html.erb

@@ -0,0 +1,8 @@
+<%= turbo_frame_tag("main", target: "_top", class: "main-content-frame") do %>
+  <%= turbo_frame_tag("source", target: "_top") do %>
+    <div class="content" style="background-color: <%= content_for?(:background_color) ? yield(:background_color) : 'initial' %>;">
+      <%# render "aros/panel_header" if in_panel? %>
+      <%= yield if block_given? %>
+    </div>
+  <% end %>
+<% end %>

data/app/views/nitro_rails/_panel_template.html.erb

@@ -0,0 +1,40 @@
+<div class="panel-template hidden">
+  <div 
+    class="panel hidden" 
+    data-controller="panel" 
+    data-action="visit->panel#visit"
+    data-panel-manager-target="panelTemplate" 
+  >
+    <div class="panel-background" data-action="click->panel-manager#closeAllPanels touchend->panel-manager#closeAllPanels">
+      <div class="panel-display">
+        <%# <div class="panel-options">
+          <button 
+            data-action="panel#close" 
+            class="panel-button close-button"
+          >
+            <i class="fas fa-times"></i>
+          </button>
+        </div> %>
+      
+        <div class="panel-frame-container">
+          <%= turbo_frame_tag("source", 
+            target: "self", 
+            loading: "lazy",
+            refresh: "morph",
+            prefetch: false,
+            data: { 
+              "panel-target": "turboFrame", 
+              action: "turbo:before-fetch-request->panel#beforeVisit",
+              class: "source",
+              turbo: false
+            }
+          ) do %> 
+            <p class="load-screen"> 
+              Loading...
+            </p>
+          <% end %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/app/views/nitro_rails/_togglable_checkbox.html.erb

@@ -0,0 +1,16 @@
+<%# CHANGE TO MATCH EDITABLE TEXT %>
+
+<turbo-frame>
+  <%= form_with(model: resource_path, data: { controller: "togglable-checkbox", togglable_checkbox_target: "form" }) do |form| %>
+    <%= form.label(:completed, class: "checkbox", for: "task_#{resource.id}_completed") do %>
+      <%= form.check_box(attribute, id: "task_#{resource.id}_completed",
+        data: { 
+          nitro_id: resource.nitro_id(attribute),
+          togglable_checkbox_target: "checkbox",
+          action: "change->togglable-checkbox#submit"
+        }
+      ) %>
+    <% end %>
+    <%= hidden_field_tag(:context, context) %>
+  <% end %>
+</turbo-frame>

data/config/importmap.rb

@@ -0,0 +1 @@
+pin "nitro_rails/application", preload: true

data/config/initializers/date_formatters.rb

@@ -0,0 +1,9 @@
+# TODO: Move to NitroRails Engine
+Time::DATE_FORMATS[:meridiem_time] = "%-l:%M %p"
+DateTime::DATE_FORMATS[:weekday] = "%A"
+DateTime::DATE_FORMATS[:shortened_weekday] = "%a"
+Date::DATE_FORMATS[:day] = "%-d"
+Date::DATE_FORMATS[:month_and_day] = "%B %-d"
+Date::DATE_FORMATS[:month_day_and_year] = "%B %-d, %Y"
+Date::DATE_FORMATS[:weekday_month_day_and_year] = "%A, %B %-d, %Y"
+Date::DATE_FORMATS[:weekday_month_and_day] = "%A, %B %-d"

data/lib/nitro_rails/engine.rb

@@ -1,5 +1,30 @@
+require 'importmap-rails'
+require 'normalize-rails'
+require 'stimulus-rails'
+require 'turbo-rails'
+require 'font-awesome-rails'
+
+
 module NitroRails
   class Engine < ::Rails::Engine
+    require "normalize-rails"
     isolate_namespace NitroRails
+
+    config.to_prepare do
+      helper_files = Dir.entries(NitroRails::Engine.root.join('app/helpers/nitro_rails')).each do |file|
+        if file =~ /_helper.rb$/
+          ::ApplicationController.helper("nitro_rails/#{file.gsub('.rb', '')}".camelize.constantize)
+        end
+      end
+    end
+
+    initializer "nitro_rails.importmap", before: "importmap" do |app|
+      app.config.importmap.paths << root.join("config/importmap.rb")
+      app.config.importmap.cache_sweepers << root.join("app/assets/javascripts")
+    end
+
+    initializer "nitro_rails.assets" do |app|
+      app.config.assets.precompile += %w[nitro_rails_manifest]
+    end
   end
 end

data/lib/nitro_rails/version.rb

@@ -1,3 +1,3 @@
 module NitroRails
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end