view_component-juice 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 00afc7e9a0144a77ce02acf6a17638c332196f3a20976c8484a77a1dc43b4f2d
+  data.tar.gz: 39fbeaca7fb7a65e9d3512953d397e190c11899f21b067d27f58961abdd53feb
+SHA512:
+  metadata.gz: beb2ca28cce4494224f21627752188632409e37fd2645481187434364a3fbb111a795cf145e42c04c82631a4b9a41871198da54324fd938ffa2452793881d869
+  data.tar.gz: 4a1a8fea4df64e2902324234e88a8e6e5778f04568719934dcb550b48ace54aec67714c5afc365b088af4b53a1c028ec6d94db452c988d900f82088444518d89

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in view_component-juice.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Caleb Owens
+
+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,37 @@
+# ViewComponent::Juice
+
+The goal of this gem is to enable writing of interactive view components by levereging the power of turbo, removing the need to write JS.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_component-juice'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install view_component-juice
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/calebowens/view_component-juice.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/view_component/juice/juice_controller.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class ViewComponent::Juice::JuiceController < ApplicationController
+  def handle_update
+    component = juice_params[:component].constantize
+
+    authenticables = {}
+
+    if component.authenticate?
+      component::AUTHENTICATE.each do |model|
+        send "authenticate_#{model}!".to_sym
+        
+        name = "current_#{model}".to_sym
+
+        authenticables[name] = send(name)
+      end
+    end
+
+    component_instance = component.new(context: JSON.parse(juice_params[:context]), **authenticables)
+
+    component_instance._update(juice_params[:message].to_sym)
+
+    render component_instance, layout: nil
+  end
+
+  private
+
+  def juice_params
+    params.permit(
+      :message,
+      :component,
+      :context
+    )
+  end
+end

data/lib/view_component/juice/juicy.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module ViewComponent::Juice::Juicy
+  extend ActiveSupport::Concern
+
+  include Turbo::StreamsHelper
+  include Turbo::FramesHelper
+
+  attr_reader :context
+
+  class_methods do
+    def render(options = {})
+      instance = self.new(**options.slice(:context, *authenticate_attributes))
+
+      instance.setup **options.except(:context, *authenticate_attributes)
+
+      instance.context['__uuid'] = SecureRandom.uuid
+
+      instance
+    end
+
+    def messages?
+      self.const_defined?(:MESSAGES)
+    end
+
+    def authenticate?
+      self.const_defined?(:AUTHENTICATE)
+    end
+
+    def authenticate_attributes
+      if authenticate?
+        self::AUTHENTICATE.map do |model|
+          "current_#{model}".to_sym
+        end
+      else
+        []
+      end
+    end
+  end
+
+  included do
+    def initialize(options)
+      @context = options[:context] || {}
+
+      self.class.authenticate_attributes.each do |attribute|
+        self.class.send(:define_method, attribute) { options[attribute] }
+      end
+    end
+
+    def frame(&block)
+      turbo_frame_tag context['__uuid'], &block
+    end
+
+    def send_message(message)
+      if self.class.messages?
+        raise "#{message} is not a valid message" unless self.class::MESSAGES.include?(message)
+      end
+
+      Rails.application.routes.url_helpers.juice_path({
+        message: message,
+        context: JSON.generate(context),
+        component: self.class.name
+      })
+    end
+
+    def _update(message)
+      update(message) if respond_to?(:update)
+    end
+  end
+end

data/lib/view_component/juice/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Juice
+    VERSION = "0.1.0"
+  end
+end

data/lib/view_component/juice.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative 'juice/juice_controller'
+require_relative 'juice/version'
+
+module ViewComponent
+  module Juice
+  end
+end

data/sig/view_component/juice.rbs

@@ -0,0 +1,6 @@
+module ViewComponent
+  module Juice
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/view_component-juice.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "lib/view_component/juice/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "view_component-juice"
+  spec.version = ViewComponent::Juice::VERSION
+  spec.authors = ["Caleb Owens"]
+  spec.email = ["hello@calebowens.com"]
+
+  spec.summary = "Adding an Elm inspired turbo interface into view components"
+  spec.homepage = "https://github.com/calebowens/view_compoent-juice"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/calebowens/view_compoent-juice"
+  spec.metadata["changelog_uri"] = "https://github.com/calebowens/view_compoent-juice"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.add_runtime_dependency "turbo-rails", "~> 1.0"
+  spec.add_runtime_dependency "view_component", "~> 2.0"
+  spec.add_runtime_dependency "activesupport", [">= 5.0.0", "< 8.0"]
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: view_component-juice
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Caleb Owens
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+description:
+email:
+- hello@calebowens.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/view_component/juice.rb
+- lib/view_component/juice/juice_controller.rb
+- lib/view_component/juice/juicy.rb
+- lib/view_component/juice/version.rb
+- sig/view_component/juice.rbs
+- view_component-juice.gemspec
+homepage: https://github.com/calebowens/view_compoent-juice
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/calebowens/view_compoent-juice
+  source_code_uri: https://github.com/calebowens/view_compoent-juice
+  changelog_uri: https://github.com/calebowens/view_compoent-juice
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Adding an Elm inspired turbo interface into view components
+test_files: []