dyny 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac39f6b0676a5fbe97a7c27892edc4566add5abd2a7c60afecb26aec8dc1feae
+  data.tar.gz: e6e05b5303feb4fb7a28d3d22f08108319b7e0169317b220dba6bcbe6a08cfe6
+SHA512:
+  metadata.gz: 6b8d79ae31f52706869df25ed7a7010746c7edfbee827a194a553304089e5731b49710577c71fd3176dc11cc9ed09ce85e9010d2b2c9ef40b7968aa3201d9d6b
+  data.tar.gz: a67634f5e1ef2a798d897af6c9ae42d996880897b6ee18fc50e81d7d3d65d2193230cfba4e17016b995861e8bb6aa51c1c7a0059c840700bcd69f06bd5096796

data/.gitignore

@@ -0,0 +1 @@
+.rubocop.yml

data/.ruby-version

@@ -0,0 +1 @@
+3.0.4

data/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,134 @@
+# Introducing Dyny
+
+Dyny is a tiny framework for writing dynamic Rails views directly in Ruby.
+Typically, Rails views, are written in
+[ERB](https://guides.rubyonrails.org/layouts_and_rendering.html),
+[HAML](https://haml.info/) or [Slim](https://github.com/slim-template/slim).
+However there are situations where you'd prefer to write regular ruby code
+without having to cope with [Tag
+Helpers](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html)
+at every call. This is where Dyny comes in.
+
+A quick and trivial example: Having `MessagesController` and an action
+`hello_world`, you can write a file `app/views/messages/hello_world.html.dyny`
+with the contents:
+
+```ruby
+h1 'Hello world'
+div class: 'card mb-3' do
+  div class: 'card-body' do
+    para "I'm inside a Bootstrap card."
+  end
+end
+```
+
+- Use directory structures similar to ERB views
+- The file extension is `.html.dyny`
+- Call HTML elements as methods and nest them using blocks. There are three special cases:
+  - Since the method name `p` is already taken, use `para` to generate a `<p>` tag.
+  - Since the method names `label` and `select` are taken by Rails, use
+    `tag.label` and `tag.select` instead.
+- Arguments given to Dyny HTML helper methods are passed to the [Rails `tag`
+  helper](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHelper.html#method-i-tag),
+  for instance `class` in the example above.
+- If you don't want a HTML tag, but output plain text, use `concat`. See examples below.
+
+**Dyny was tested with Rails 7.**
+
+# But dynamic views are bad?
+
+Rails views are meant to merely display data that was already pre-processed
+elsewhere, such as helpers or controller actions. However, as your application
+gets very complex, there may be situations where adhering to that principle
+leads to code scattered all over your application. Also, for rapid prototyping,
+you might wanna start writing your first proof-of-concept code directly into the
+view. This is where dyny jumps in to fill the gap and lets you write views
+directly in Ruby.
+
+Dyny does not prevent you from writing most of your views in ERB or HAML. The
+file name ending of the view decides which processor is used. If your file ends
+with `.html.erb`, you write ERB HTML; if it ends with `.html.dyny`, you can
+write plain Ruby with the help of Dyny.
+
+# Installation
+
+1. Add the gem to your Gemfile: `gem 'dyny'`
+2. Run `bundle` to install it.
+
+# Usage
+
+## In a template
+
+Simply have the file name of your view end with `.html.dyny` and write plain
+ruby in it, as shown in the example above.
+
+## In `render` or `render_to_string`
+
+You may speficy `type: :dyny` in your render call to have Rails process your string with Dyny. Using `inline`, you may supply a string containing ruby.
+
+As an example: in your controller, you may call:
+
+```ruby
+render_to_string(
+  type:   :dyny,
+  locals: { foo: :bar },
+  inline: <<~RUBY
+    h1 'Hello world'
+  RUBY
+)
+```
+
+# Examples
+
+## A trivial index page
+
+```ruby
+h1 'All users'
+ul do
+  @users.each do |current_user|
+    li current_user.name
+  end
+end
+```
+
+## Working with simple_form and bootstrap
+
+This illustrates working with Bootstrap and the popular
+`[SimpleForm](https://github.com/heartcombo/simple_form)` gem. For a better
+overview, we first save the HTML generated by `simple_form_for` into the local
+variable `form_html` and use `concat` to output it later.
+
+```ruby
+div class: 'card card-body' do
+  form_html = simple_form_for :test do |f|
+    concat(f.input(:fun))
+    div(f.input(:stuff), class: 'mb-3')
+    concat f.submit
+  end
+  concat form_html
+end
+```
+
+The result is a form with two fields and a submit button.
+
+# Differences to the Arbre gem
+
+This project aims to replace [Arbre](https://github.com/activeadmin/arbre) which
+has similar intentions. The key differences to Arbre are:
+
+- Dyny is much smaller and simpler than Arbre but achieves the same features.
+- Dyny supports using controller instance variable in views while Arbre does not
+- Dyny properly uses the `ActionView` buffer, supporting calls to `concat` or
+  `capture`. This means that Dyny fully supports gems making use of these
+  features, such as [SimpleForm](https://github.com/heartcombo/simple_form),
+  while Arbre breaks such gems because it uses its own buffer.
+- Where Arbre uses `text_node`, Dyny lets you use the native Rails method
+  `concat` to output raw text.
+- Arbre has its own `Context` concept while Dyny does not. To have Dyny
+  generated HTML saved to a string variable, use Rails' `render_to_string`
+  method instead, see example above.
+
+# Contributing
+
+You are welcome to contribute to this project via the regular fork and pull
+request procedure.

data/Rakefile

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require_relative 'lib/dyny/version'
+
+task :gemspec do
+  specification = Gem::Specification.new do |s|
+    s.name = 'dyny'
+    s.version = Dyny::Version::LABEL
+    s.author = ['Sandro Kalbermatter']
+    s.summary = 'A tiny framework for writing dynamic Rails views directly in Ruby'
+    s.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+    s.executables   = []
+    s.require_paths = ['lib']
+    s.required_ruby_version = '>= 3.0.0'
+    s.license = 'LGPL-3.0-or-later'
+    s.homepage = 'https://github.com/kalsan/dyny'
+    s.metadata = {
+      'source_code_uri'   => 'https://github.com/kalsan/dyny',
+      'documentation_uri' => 'https://github.com/kalsan/dyny'
+
+    }
+
+    # Dependencies
+    s.add_runtime_dependency 'rails' # Tested with Rails 7, but olders may work. TBD.
+  end
+
+  File.open('dyny.gemspec', 'w') do |f|
+    f.puts('# DO NOT EDIT')
+    f.puts("# This file is auto-generated via: 'rake gemspec'.\n\n")
+    f.write(specification.to_ruby.strip)
+  end
+end

data/dyny.gemspec

@@ -0,0 +1,32 @@
+# DO NOT EDIT
+# This file is auto-generated via: 'rake gemspec'.
+
+# -*- encoding: utf-8 -*-
+# stub: dyny 0.0.3 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "dyny".freeze
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.metadata = { "documentation_uri" => "https://github.com/kalsan/dyny", "source_code_uri" => "https://github.com/kalsan/dyny" } if s.respond_to? :metadata=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["Sandro Kalbermatter".freeze]
+  s.date = "2022-12-07"
+  s.files = [".gitignore".freeze, ".ruby-version".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "dyny.gemspec".freeze, "lib/dyny.rb".freeze, "lib/dyny/helper.rb".freeze, "lib/dyny/railtie.rb".freeze, "lib/dyny/template_handler.rb".freeze, "lib/dyny/version.rb".freeze]
+  s.homepage = "https://github.com/kalsan/dyny".freeze
+  s.licenses = ["LGPL-3.0-or-later".freeze]
+  s.required_ruby_version = Gem::Requirement.new(">= 3.0.0".freeze)
+  s.rubygems_version = "3.2.33".freeze
+  s.summary = "A tiny framework for writing dynamic Rails views directly in Ruby".freeze
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_runtime_dependency(%q<rails>.freeze, [">= 0"])
+  else
+    s.add_dependency(%q<rails>.freeze, [">= 0"])
+  end
+end

data/lib/dyny/helper.rb

@@ -0,0 +1,129 @@
+module Dyny
+  # This module is injected into every code that runs in Dyny.
+  module Helper
+    # Intial HTML Tag set was extracted from https://github.dev/activeadmin/arbre
+    # The tags `label` and `select` were removed because they collide with Rails helpers and are rarely used in practice. Use `concat tag.label` instead.
+    HTML_TAGS = %i[a
+                   abbr
+                   address
+                   area
+                   article
+                   aside
+                   audio
+                   b
+                   base
+                   bdo
+                   blockquote
+                   body
+                   br
+                   button
+                   canvas
+                   caption
+                   cite
+                   code
+                   col
+                   colgroup
+                   command
+                   datalist
+                   dd
+                   del
+                   details
+                   dfn
+                   div
+                   dl
+                   dt
+                   em
+                   embed
+                   fieldset
+                   figcaption
+                   figure
+                   footer
+                   form
+                   h1 h2 h3 h4 h5 h6
+                   head
+                   header
+                   hgroup
+                   hr
+                   html
+                   i
+                   iframe
+                   img
+                   input
+                   ins
+                   keygen
+                   kbd
+                   legend
+                   li
+                   link
+                   main
+                   map
+                   mark
+                   menu
+                   menuitem
+                   meta
+                   meter
+                   nav
+                   noscript
+                   object
+                   ol
+                   optgroup
+                   option
+                   output
+                   param
+                   pre
+                   progress
+                   q
+                   s
+                   samp
+                   script
+                   section
+                   small
+                   source
+                   span
+                   strong
+                   style
+                   sub
+                   summary
+                   sup
+                   svg
+                   table
+                   tbody
+                   td
+                   textarea
+                   tfoot
+                   th
+                   thead
+                   time
+                   title
+                   tr
+                   track
+                   ul
+                   var
+                   video
+                   wbr].freeze
+
+    # Uncomment the following lines to search for method name collisions.
+    # HTML_TAGS.each do |tag|
+    #   begin
+    #     send tag.to_sym
+    #     puts "Clash! #{tag.inspect}"
+    #   rescue ArgumentError
+    #     puts "Clash! #{tag.inspect}"
+    #   rescue NoMethodError
+    #   end
+    # end
+
+    HTML_TAGS.each do |tag|
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def #{tag}(...)           # def form(...)
+        concat tag.#{tag}(...)  #   concat tag.form(...)
+      end                       # end
+      RUBY
+    end
+
+    # method name :p is already taken for printing purposes, therefore we make `para` generate <p> tags.
+    def para(...)
+      concat tag.p(...)
+    end
+  end
+end

data/lib/dyny/railtie.rb

@@ -0,0 +1,9 @@
+module Dyny
+  class Railtie < Rails::Railtie
+    initializer 'dyny.define_helpers' do
+      ActiveSupport.on_load :action_view do
+        include Dyny::Helper
+      end
+    end
+  end
+end

data/lib/dyny/template_handler.rb

@@ -0,0 +1,13 @@
+module Dyny
+  # This plugs into Rails and allows to handle app/views/foo/bar.html.rb templates
+  class TemplateHandler
+    def call(_template, source_code = nil)
+      return <<~RUBY
+        #{source_code}
+        return output_buffer
+      RUBY
+    end
+  end
+end
+
+ActionView::Template.register_template_handler(:dyny, Dyny::TemplateHandler.new)

data/lib/dyny/version.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Dyny
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 3
+
+    EDGE = false
+
+    LABEL = [MAJOR, MINOR, PATCH, EDGE ? 'edge' : nil].compact.join('.')
+  end
+end

data/lib/dyny.rb

@@ -0,0 +1,6 @@
+module Dyny; end
+
+require 'dyny/railtie'
+require 'dyny/version'
+require 'dyny/helper'
+require 'dyny/template_handler'

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: dyny
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Sandro Kalbermatter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  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'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- LICENSE
+- README.md
+- Rakefile
+- dyny.gemspec
+- lib/dyny.rb
+- lib/dyny/helper.rb
+- lib/dyny/railtie.rb
+- lib/dyny/template_handler.rb
+- lib/dyny/version.rb
+homepage: https://github.com/kalsan/dyny
+licenses:
+- LGPL-3.0-or-later
+metadata:
+  documentation_uri: https://github.com/kalsan/dyny
+  source_code_uri: https://github.com/kalsan/dyny
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key: 
+specification_version: 4
+summary: A tiny framework for writing dynamic Rails views directly in Ruby
+test_files: []