inline_view_component 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4191985d37626a7ea9b3c078e5a835b06e97daa492c6c551ab644a75d5484979
+  data.tar.gz: 695f380d66ca4787e11a94bd3ec332d50db249b4483a8e1ab5fb4209d85fabae
+SHA512:
+  metadata.gz: 1cc417a3e79d1012b62691e2778b63f247b57a1dbcb108769074e086acb0d349dc94bb6fd3b8dca03ad41ac182361eefc77394321d6c2915c429419a5fadd0f4
+  data.tar.gz: b1a185ed8a3e752b97e120dc0083561c9cf22ef812e1fb185ea5491b0300d327ba993380ee1991bdde4121a77c94d209780c9c4b749a89902ffbb6c1dfca54a1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Rafe Rosen
+
+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,78 @@
+# InlineViewComponent
+This gem allows your ViewComponents to define template strings within the class definition.  ERB and HAML are supported.  Syntax highlighting for Sublime Text is provided.
+
+## Usage
+Include the `InlineViewComponent` mixin and then specify your template string with `template(string)`.  Be sure to delete your component's external template file or ViewComponent will raise an error.
+
+#### Examples
+```ruby
+class ErbComponent < ViewComponent::Base
+  include InlineViewComponent
+
+  def message
+    "Such inline. Much convenient."
+  end
+
+  template <<~ERB
+    <p> <%= message %> </p>
+  ERB
+end
+```
+
+```ruby
+class HamlComponent < ViewComponent::Base
+  include InlineViewComponent
+
+  def message
+    "Very HAML. Many terse."
+  end
+
+  self.inline_template_format = :haml
+  template <<~Haml
+    %p= message
+  Haml
+end
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'inline_view_component'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install inline_view_component
+```
+
+## Syntax Highlighting
+
+Syntax highlighting for Sublime Text is available.  Download (this file)[/editor/Ruby.sublime-syntax] and add it to your Sublime User package.  Then open your ruby files in the `Ruby (Custom)` syntax (or choose `View -> Syntax -> Open All with current extention as...` to use it automatically).
+
+To get syntax highlighting to work use `ERB` or `HAML` as the delimiter for your heredoc string e.g.
+
+```
+template <<~HAML
+  %h1 A really great template
+HAML
+```
+
+## TODO
+
+This is an early release.  Contributions are welcome!
+
+- [ ] better error reporting (all the info is there, but it could be clearer)
+- [ ] add syntax highlighting for more editors (VS Code, vim, ...)
+- [ ] add support for other templating languages (slim, ...)
+
+## Contributing
+Send a pull request.
+
+## 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,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'InlineViewComponent'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/inline_view_component.rb

@@ -0,0 +1,48 @@
+require "active_support/concern"
+require "tilt"
+require "active_support/core_ext/string/output_safety"
+
+module InlineViewComponent
+  extend ActiveSupport::Concern
+
+  FORMATS = [:erb, :haml].freeze
+
+  included do
+    class << self
+      attr_reader :inline_template, :inline_template_format
+    end
+
+    # set the template format for this component
+    def self.inline_template_format=(format)
+      unless InlineViewComponent::FORMATS.include? format
+        raise "unsupported format #{format}.  Valid choices are: #{InlineViewComponent::FORMATS}"
+      end
+
+      @inline_template_format = format.to_sym
+    end
+
+    # set the template for this component
+    def self.template(template_string)
+      format = inline_template_format || :erb
+
+      @inline_template = InlineViewComponent::Compiler.compile_template(format, template_string)
+
+      define_method :call do
+        raw self.class.inline_template.render(self)
+      end
+    end
+  end
+
+  module Compiler
+    def compile_template(format, template_string)
+      raise "unsupported format #{format}" unless InlineViewComponent::FORMATS.include?(format)
+
+      case format.to_sym
+      when :erb then Tilt::ErubiTemplate.new(nil, escape_html: true, escapefunc: "::ERB::Util::h") { template_string }
+      when :haml then Tilt["haml"].new(nil, 1, escape_html: true) { template_string }
+      end
+    end
+
+    module_function :compile_template
+  end
+end

data/lib/inline_view_component/version.rb

@@ -0,0 +1,3 @@
+module InlineViewComponent
+  VERSION = "0.1.0"
+end

data/lib/tasks/inline_view_component_tasks.rake

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

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: inline_view_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafe Rosen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: tilt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: haml-rails
+  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: standard
+  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'
+description: 
+email:
+- rafe@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/inline_view_component.rb
+- lib/inline_view_component/version.rb
+- lib/tasks/inline_view_component_tasks.rake
+homepage: http://github.com/existentialmutt/inline_view_component
+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.1.2
+signing_key: 
+specification_version: 4
+summary: Include template strings in Rails ViewComponent class definitions
+test_files: []