viu 0.0.0 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f214b4ad59e98f74c0fdb8f8417d407d6a6a0984836fe5707d7d65eef4273e0
-  data.tar.gz: c4b00a30be63eec767680ae34fe7c360ad35b37f570f45473e576753a69a8b18
+  metadata.gz: 17de95e5852c60464030292d611b3baa74bc9e5b72de1dab5cc6f820241b35cb
+  data.tar.gz: 1c04d6ee4f5ecb39bd846a7673bb542a2f1c34aacafa1acdf84cabeb799ffedb
 SHA512:
-  metadata.gz: b35fee48fbfdeb0396e85bdc230743c35df5580d604cd278e5710936111e1eb84f578536d73165ef079b143a47dc7e70738064f1d7953c22b697061979833e62
-  data.tar.gz: d5df5e9a68a80990a1b4d242067c15f39ecad3b42004767b5fc3488b8d6a0baf1928473a7a57ee73d7b9e892439b3830e0947fa31a674b3bd5484e9faa33df04
+  metadata.gz: c4a88a1afc091b1a1840bdc07bbc69d3c12b0ed2725875cc7d457bd12928188dd514c0aa27e538cee12d092eedff4346c15f76ee7ee47f00cc0880645165b48f
+  data.tar.gz: '099c2aa54ac9281b47a0cc777927b4076265bedbd873c39cc03b1c23a8adcfa1d714036976ee961b3a707d69565cdd3ba75e3b440c5faa46061228996d8ab802'

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/support/dummy/tmp
+/test/support/dummy/log
+*.gem
+
+/gemfiles/*.gemfile.lock

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2

data/Appraisals

@@ -0,0 +1,15 @@
+# appraise "rails-5-0" do
+#   gem "rails", "~> 5.0.0"
+# end
+
+# appraise "rails-5-1" do
+#   gem "rails", "~> 5.1.0"
+# end
+
+appraise "rails-5-2" do
+  gem "rails", "~> 5.2.0"
+end
+
+appraise "rails-6-0" do
+  gem "rails", "~> 6.0.0"
+end

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+## 0.0.5 2020-12-01
+
+- Added support for Rails 6.1.0.rc1
+- Fixed bug with views not having access to compiled template methods (using #compiled_method_container)
+
+## 0.0.4 2020-11-29
+
+- Added support for Rails ~> 6.0.0
+
+## 0.0.3 2020-09-02
+
+- Added Viu::Json
+- Added Viu::Xml
+- Allow Viu::Html template! to receive a proc
+
+## 0.0.2 2020-08-16
+
+### Added
+
+- Improve test helpers
+
+### Fixed
+
+- Viu::Html#controller should be public
+
+## 0.0.1 2020-08-10
+
+First public release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mrbongiolo@hey.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+gem "rails", github: "rails/rails"
+gem "oj"

data/Gemfile.lock

@@ -0,0 +1,177 @@
+GIT
+  remote: https://github.com/rails/rails
+  revision: 7503ef9490583f7b2c3a475edd2bb1b7de0afcac
+  specs:
+    actioncable (6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      activejob (= 6.1.0.rc1)
+      activerecord (= 6.1.0.rc1)
+      activestorage (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      actionview (= 6.1.0.rc1)
+      activejob (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.0.rc1)
+      actionview (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      activerecord (= 6.1.0.rc1)
+      activestorage (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+    activerecord (6.1.0.rc1)
+      activemodel (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+    activestorage (6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      activejob (= 6.1.0.rc1)
+      activerecord (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      marcel (~> 0.3.1)
+      mimemagic (~> 0.3.2)
+    activesupport (6.1.0.rc1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    rails (6.1.0.rc1)
+      actioncable (= 6.1.0.rc1)
+      actionmailbox (= 6.1.0.rc1)
+      actionmailer (= 6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      actiontext (= 6.1.0.rc1)
+      actionview (= 6.1.0.rc1)
+      activejob (= 6.1.0.rc1)
+      activemodel (= 6.1.0.rc1)
+      activerecord (= 6.1.0.rc1)
+      activestorage (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.0.rc1)
+      sprockets-rails (>= 2.0.0)
+    railties (6.1.0.rc1)
+      actionpack (= 6.1.0.rc1)
+      activesupport (= 6.1.0.rc1)
+      method_source
+      rake (>= 0.8.7)
+      thor (~> 1.0)
+
+PATH
+  remote: .
+  specs:
+    viu (0.0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    appraisal (2.3.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    bigdecimal (2.0.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    crass (1.0.6)
+    docile (1.3.2)
+    erubi (1.10.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    haml (5.1.2)
+      temple (>= 0.8.0)
+      tilt
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    loofah (2.8.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (1.0.0)
+    mimemagic (0.3.5)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nio4r (2.5.4)
+    nokogiri (1.10.10)
+      mini_portile2 (~> 2.4.0)
+    oj (3.10.12)
+      bigdecimal (>= 1.0, < 3)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rake (12.3.3)
+    simplecov (0.18.5)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.2)
+    slim (4.1.0)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    temple (0.8.2)
+    thor (1.0.1)
+    tilt (2.0.10)
+    tzinfo (2.0.3)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.3)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.3)
+  bundler (~> 1.17)
+  haml (~> 5)
+  minitest (~> 5.0)
+  oj
+  rails!
+  rake (~> 12.3)
+  simplecov (~> 0.18.0)
+  slim (~> 4)
+  viu!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ralf Schmitz Bongiolo
+
+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,402 @@
+# Viu
+
+Rails' missing View layer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "viu"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install viu
+```
+
+## Rails Setup
+
+Add this to your `config/application.rb` file:
+
+```ruby
+config.eager_load_paths << Rails.root.join("app/views")
+```
+
+This will add the `app/views` folder to the eager load paths, as it is not loaded there by default.
+
+## Viu::Html
+
+Probably the most common view type of the wild web lands.
+
+### Usage
+
+`app/views/awesome_view.rb`:
+```ruby
+class AwesomeView < Viu::Html
+
+  layout! Layouts::ApplicationLayout
+
+  def initialize(posts:)
+    @posts = posts
+  end
+
+  private
+
+  def power_level_class(power)
+    return "over-9000" if power > 9000
+
+    "not-awesome-enough"
+  end
+end
+```
+
+`app/views/awesome_view.html.erb`:
+```erb
+<h1>Awesomesauce</h1>
+<%- @posts.each do |post| %>
+  <article class="<%= power_level_class(post.awesomeness) %>">
+    <h1><%= link_to post.title, post, class: "awesome-title" %></h1>
+    <p><%= post.summary %></p>
+  </article>
+<%- end %>
+```
+
+`app/controllers/home_controller.rb`:
+```ruby
+# GET /awesome
+def awesome
+  posts = Post.order(awesomeness: :desc)
+  render_view AwesomeView.new(posts: posts)
+end
+```
+
+Unless a template is given directly (using the `template! "file"` option inside the view), a view will try to find a
+template with it's name.
+
+As seen in the example above a view's template has access to all instance variables, public and private methods defined
+in the view, as well as all `ActionView` helpers.
+
+Also, the view won't have access to any variables or instance variables defined in the controller, those have to be
+passed in directly, as shown in `AwesomeView.new(posts: posts)`.
+
+### ApplicationView
+
+Usually it's a common practice in rails projects to define an `ApplicationController` or `ApplicationRecord` base class
+that can be inherited from. The same can be done with views, an `ApplicationView` class is a good place to put some
+basic functionalities that should be available to all views.
+
+### Callable templates
+
+A view's template can be overridden with a `proc`. __Attention:__ currently using a callable template doesn't work with
+layouts, they will be ignored.
+
+```ruby
+# defining the view
+class HeaderView < ApplicationView
+
+  template! proc { tag.h1 @title }
+
+  def initialize(title:)
+    @title = title
+  end
+end
+
+# rendering the view
+render_view HeaderView.new(title: "Mas Gente!") # => "<h1>Mas Gente!</h1>"
+```
+
+### Layouts
+
+By default a view won't be rendered inside a layout. To use a layout, one has to be declared, either directly on the
+view or passed to the `render_view` method.
+
+#### Defining a layout template
+
+`app/views/my_view.rb`:
+```ruby
+class MyView < ApplicationView
+  # This will look for an application template inside app/views/layouts,
+  # it can be a html.erb or any other template language defined in your application.
+  layout! 'layouts/application'
+end
+```
+
+`app/views/layouts/application.html.erb`:
+```erb
+<html>
+  <head>
+    <title>A view view a Layout</title>
+    <%= stylesheet_link_tag "application" %>
+    <%= javascript_include_tag "application" %>
+  </head>
+  <body>
+    <header>Header from the layout</header>
+    <%= yield %>
+  </body>
+</html>
+```
+
+#### Defining a layout view
+
+A layout can also be a `Viu::Layout` class, in this case it will work pretty much like a `Viu::Html`.
+
+`app/views/my_view.rb`:
+```ruby
+class MyView < ApplicationView
+  layout! Layouts::ApplicationLayout
+end
+```
+
+`app/views/layouts/application_layout.rb`:
+```ruby
+module Layouts
+
+  # a layout needs to inherit from Viu::Layout
+  class ApplicationLayout < Viu::Layout
+
+    def header_text
+      "This is a Viu::Layout"
+    end
+  end
+end
+```
+
+`app/views/layouts/application_layout.html.erb`:
+```erb
+<html>
+  <head>
+    <title>A Viu::Layout</title>
+    <%= stylesheet_link_tag "application" %>
+    <%= javascript_include_tag "application" %>
+  </head>
+  <body>
+    <header><%= header_text %></header>
+    <%= yield %>
+  </body>
+</html>
+```
+
+Similar as the `Viu::Html` a layout will search for a template with it's name, if none is given directly.
+
+#### Defining a layout `proc`
+
+A layout can also be declared as a `proc`, this is useful when the view wants to override the layout parameters.
+The `proc` will be executed in the context of the view and the result must respond to `render_in`.
+
+`app/views/my_view.rb`:
+```ruby
+class MyView < ApplicationView
+
+  layout! proc { Layouts::ApplicationLayout.new(header_text: text) }
+
+  private
+
+  def text
+    "Text from the view"
+  end
+end
+```
+
+`app/views/layouts/application_layout.rb`:
+```ruby
+module Layouts
+  class ApplicationLayout < Viu::Layout
+
+    attr_reader :header_text
+
+    def initialize(header_text: 'The header text')
+      @header_text = header_text
+    end
+  end
+end
+```
+
+`app/views/layouts/application_layout.html.erb`:
+```erb
+<html>
+  <head>
+    <title>A Viu::Layout</title>
+    <%= stylesheet_link_tag "application" %>
+    <%= javascript_include_tag "application" %>
+  </head>
+  <body>
+    <header>
+      <!-- it will render "Text from the view" here -->
+      <%= header_text %>
+    </header>
+    <%= yield %>
+  </body>
+</html>
+```
+
+#### Overriding layout on `render_view`
+
+Usually a `layout` is defined directly in the view, as most of the times a view will be used in a single "context",
+but if needed it can be overridden on the `render_view` with the `layout:` option, like so:
+
+```ruby
+# it accepts a template
+render_view MyView.new, layout: 'layouts/admin'
+
+# a Viu::Layout
+render_view MyView.new, layout: Layouts::OtherLayout
+
+# or a proc
+render_view MyView.new, layout: proc { Layouts::OtherLayout.new(title: 'Dashboard') }
+```
+
+## Viu::Json
+
+This is a simple module that can be included in your views, it will add a `to_json` method, this is called by default
+when rendering in a Rails env. The value returned from `json_output` will be the output of the view.
+
+`app/views/api/posts/resource_view.rb`:
+```ruby
+module Api
+  module Posts
+    class ResourceView
+      include Viu::Json
+
+      def initialize(post:)
+        @post = post
+      end
+
+      private
+
+      def author
+        @author ||= @post.author
+      end
+
+      def json_output
+        {
+          title: @post.title,
+          published_on: @post.published_on.to_s(:iso8601),
+          author: {
+            name: author.name,
+            avatar: author.avatar.url
+          }
+        }
+      end
+    end
+  end
+end
+```
+
+`app/controllers/api/posts_controller.rb`:
+```ruby
+def show
+  post = Post.find(params[:id])
+  render json: Api::Posts::ResourceView.new(post: post)
+end
+```
+
+The default `JSON` encoder can be overridden like so:
+
+```ruby
+class MyJsonView
+  include Viu::Json
+
+  json_encoder ->(input) { Oj.dump(input) }
+
+end
+```
+
+## Viu::Xml
+
+Similar to `Viu::Json` this is a simple module that can be included in your views, it will add a `to_xml` method,
+this is called by default when rendering in a Rails env. The value returned from `xml_output` will be the output
+of the view.
+
+`app/views/api/posts/resource_view.rb`:
+```ruby
+module Api
+  module Posts
+    class ResourceView
+      include Viu::Xml
+
+      def initialize(post:)
+        @post = post
+      end
+
+      private
+
+      def author
+        @author ||= @post.author
+      end
+
+      def xml_output
+        {
+          title: @post.title,
+          published_on: @post.published_on.to_s(:iso8601),
+          author: {
+            name: author.name,
+            avatar: author.avatar.url
+          }
+        }
+      end
+    end
+  end
+end
+```
+
+`app/controllers/api/posts_controller.rb`:
+```ruby
+def show
+  post = Post.find(params[:id])
+  render xml Api::Posts::ResourceView.new(post: post)
+end
+```
+
+The default `XML` encoder can be overridden like so:
+
+```ruby
+class MyXmlView
+  include Viu::Xml
+
+  xml_encoder ->(input) { Ox.dump(input) }
+
+end
+```
+
+## Known Issues
+
+* A `Viu::Layout` doesn't work with `content_for` blocks, it's only available on a regular layout template for now;
+* Templates and partials require the "full" path, eg: `layouts/application` or `posts/index`;
+* Currently layout inheritance isn't working correctly.
+
+## About
+
+Inspired by `view_component`, `cells` and others, currently this is a POC (proof of concept) to create a View layer
+for Rails, it uses `ActionView` as the base for HTML views and it aims to work with the least amount of surprises on a
+Rails application, but with a few boundaries, like a View won't be able to automatically access `@ivars` defined
+in a controller, those have to explicitly be passed to them.
+
+The project is already been tested on a small scale in our production environment.
+
+## Development
+
+```ruby
+# install dependencies
+bin/setup install
+
+# running tests
+bundle exec rake test
+
+# running tests for all rails versions
+bundle exec appraisal rake test
+
+# releasing a new version:
+# update changelog
+# update VERSION on lib/viu/version.rb
+# run bundle exec rake release
+# create a Bump to version x.x.x commit
+# run bundle exec rake release
+```