renderful 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 838224d26adb2fc0cdd709b1bda084a4d0c0ee5c091207791587f3c0a8e176be
+  data.tar.gz: d23fc8b35ddeddbaa23acad085e8b945f6a5983c737cea1e90c1d46bd7e88da9
+SHA512:
+  metadata.gz: 35427988e04a3197a4dac2080d410d9708ebd3fa12aec1f509a2bd9838f303825733a0e7214578d0c7aca97aba067811d537a461719a0d0d83b2ed2c2f3f1600
+  data.tar.gz: e1a364c1e599c1d0df64015175d5dd9e41b969448e0a58679b66de16d9d0fe196a5acfba841efe46f344d775ae0fe0def75f7f6cff12ef1cffff90137b616e1d

data/.circleci/config.yml

@@ -0,0 +1,32 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/ruby:2.6.2
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            - renderful-v1-{{ checksum "Gemfile.lock" }}
+            - renderful-v1-
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+      - save_cache:
+          key: renderful-v1-{{ checksum "Gemfile.lock" }}
+          paths:
+            - vendor/bundle
+      - run:
+          name: Run rspec in parallel
+          command: |
+            bundle exec rspec --profile 10 \
+              --format RspecJunitFormatter \
+              --out test_results/rspec.xml \
+              --format progress \
+              $(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
+      - store_test_results:
+          path: test_results

data/.gitignore

@@ -0,0 +1 @@
+.rspec_status

data/.hound.yml

@@ -0,0 +1,5 @@
+fail_on_violations: true
+
+rubocop:
+  config_file: .rubocop.yml
+  version: 0.64.0

data/.rubocop-https---relaxed-ruby-style-rubocop-yml

@@ -0,0 +1,166 @@
+# Relaxed.Ruby.Style
+## Version 2.2
+
+Style/Alias:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylealias
+
+Style/AsciiComments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleasciicomments
+
+Style/BeginBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylebeginblock
+
+Style/BlockDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleblockdelimiters
+
+Style/CommentAnnotation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylecommentannotation
+
+Style/Documentation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledocumentation
+
+Layout/DotPosition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutdotposition
+
+Style/DoubleNegation:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styledoublenegation
+
+Style/EndBlock:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleendblock
+
+Style/FormatString:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleformatstring
+
+Style/IfUnlessModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleifunlessmodifier
+
+Style/Lambda:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylelambda
+
+Style/ModuleFunction:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemodulefunction
+
+Style/MultilineBlockChain:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylemultilineblockchain
+
+Style/NegatedIf:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedif
+
+Style/NegatedWhile:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylenegatedwhile
+
+Style/ParallelAssignment:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleparallelassignment
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylepercentliteraldelimiters
+
+Style/PerlBackrefs:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styleperlbackrefs
+
+Style/Semicolon:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesemicolon
+
+Style/SignalException:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesignalexception
+
+Style/SingleLineBlockParams:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelineblockparams
+
+Style/SingleLineMethods:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylesinglelinemethods
+
+Layout/SpaceBeforeBlockBraces:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspacebeforeblockbraces
+
+Layout/SpaceInsideParens:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#layoutspaceinsideparens
+
+Style/SpecialGlobalVars:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylespecialglobalvars
+
+Style/StringLiterals:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylestringliterals
+
+Style/TrailingCommaInArguments:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarguments
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainarrayliteral
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#styletrailingcommainhashliteral
+
+Style/WhileUntilModifier:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewhileuntilmodifier
+
+Style/WordArray:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#stylewordarray
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintambiguousregexpliteral
+
+Lint/AssignmentInCondition:
+  Enabled: false
+  StyleGuide: https://relaxed.ruby.style/#lintassignmentincondition
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockNesting:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+

data/.rubocop.yml

@@ -0,0 +1,22 @@
+inherit_from:
+  - https://relaxed.ruby.style/rubocop.yml
+
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  Enabled: false
+
+Layout/IndentHash:
+  EnforcedStyle: consistent
+
+RSpec/ExampleLength:
+  Enabled: false
+
+Layout/ClosingParenthesisIndentation:
+  Enabled: false
+
+Layout/FirstParameterIndentation:
+  EnforcedStyle: consistent
+
+RSpec/NestedGroups:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project
+adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/nebulab/renderful

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in renderful.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,190 @@
+PATH
+  remote: .
+  specs:
+    renderful (0.1.0)
+      contentful (~> 2.11)
+      rails (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    contentful (2.12.0)
+      http (> 0.8, < 4.0)
+      multi_json (~> 1)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    domain_name (0.5.20180417)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    http (3.3.0)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    loofah (2.2.3)
+      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 (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    multi_json (1.13.1)
+    nio4r (2.3.1)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
+    public_suffix (3.0.3)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    redis (4.1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (0.64.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    unicode-display_width (1.4.1)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  redis (~> 4.1)
+  renderful!
+  rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.4.1)
+  rubocop (= 0.64.0)
+  rubocop-rspec (= 1.32.0)
+
+BUNDLED WITH
+   1.17.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Nebulab Srls
+
+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,279 @@
+# Renderful
+
+[![CircleCI](https://circleci.com/gh/bestmadeco/renderful.svg?style=svg)](https://circleci.com/gh/bestmadeco/renderful)
+
+Welcome! Renderful is a rendering engine for [Contentful](https://www.contentful.com) spaces. It
+allows you to map your content types to Ruby objects that take care of rendering your content.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'renderful'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install renderful
+```
+
+Once you have installed the gem, you can configure it like this:
+
+```ruby
+contentful = Contentful::Client.new(
+  space: 'CONTENTFUL_SPACE_ID',
+  access_token: 'CONTENTFUL_ACCESS_TOKEN',
+)
+
+renderful = Renderful.new(
+  contentful: contentful,
+  renderers: {
+    'jumbotron' => JumbotronRenderer,
+  }
+)
+``` 
+
+## Usage
+
+Suppose you have the `jumbotron` content type in your Contentful space. This content type has the
+`title` and `content` fields, both strings.
+
+Let's create the `app/renderers/jumbotron_renderer.rb` file:
+
+```ruby
+class JumbotronRenderer < Renderful::Renderer
+  def render
+    <<~HTML
+      <div class="jumbotron">
+        <h1 class="display-4"><%= entry.title %></h1>
+        <p class="lead"><%= entry.content %></p>
+      </div>
+    HTML
+  end
+end
+```
+
+You can now render this component by retrieving it from Contentful and rendering it with Renderful:
+
+```ruby
+entry = contentful.entry('jumbotron_entry_id')
+renderful.render(entry)
+```
+
+### Rich text rendering
+
+If you have rich-text fields, you can leverage Contentful's [rich_text_renderer](https://github.com/contentful/rich-text-renderer.rb)
+along with a custom local variable:
+
+```ruby
+class TextBlockRenderer < Renderful::Renderer::Rails
+  def html_body
+    RichTextRenderer::Renderer.new.render(entry.body)
+  end
+
+  def locals
+    { html_body: html_body }
+  end
+end
+```
+
+Then, just reference the `html_body` variable as usual:
+
+```erb
+<%# app/views/renderful/_text_block.html.erb %>
+<%= raw html_body %>
+```
+
+### Nested components
+
+What if you want to have a `Grid` component that can contain references to other components? It's
+actually quite simple! Simply create a _References_ field for your content, then recursively render
+all of the content entries contained in that field:
+
+```ruby
+# app/components/grid.rb
+class Grid < Renderful::Renderer
+  # This will define a `resolved_blocks` method that reads external references 
+  # from the `blocks` fields and turns them into Contentful::Entry instances
+  resolve :blocks
+
+  def render
+    entries = blocks.map do |block|
+      # `client` can be used to access the Renderful::Client instance
+      <<~HTML
+        <div class="grid-entry">
+          #{client.render(block)}
+        </div>
+      HTML
+    end
+
+    <<~HTML
+      <div class="grid">#{entries}</div>
+    HTML
+  end
+end
+```
+
+### Caching
+
+You can easily cache the output of your renderers by passing a `cache` key when instantiating the
+client. The value of this key should be an object that responds to the following methods:
+ 
+- `#read(key)`
+- `#write(key, value)`
+- `#delete(key)`
+- `#exist?(key)`
+
+A Redis cache implementation is included out of the box. Here's an example:
+
+```ruby
+renderful = Renderful.new(
+  contentful: contentful,
+  cache: Renderful::Cache::Redis.new(Redis.new(url: 'redis://localhost:6379')),
+  renderers: {
+    'jumbotron' => JumbotronRenderer
+  }
+)
+``` 
+
+If you are using Rails and want to use the Rails cache store for Renderful, you can simply pass
+`Rails.cache`, which responds to the expected interface:
+
+```ruby
+renderful = Renderful.new(
+  contentful: contentful,
+  cache: Rails.cache,
+  renderers: {
+    'jumbotron' => JumbotronRenderer
+  }
+)
+``` 
+
+#### Cache invalidation
+
+The best way to invalidate the cache is through [Contentful webhooks](https://www.contentful.com/developers/docs/concepts/webhooks/).
+
+Renderful ships with a framework-agnostic webhook processor you can use to automatically invalidate
+the cache for all updated content:
+
+```ruby
+Renderful::CacheInvalidator.new(renderful).process_webhook(json_body)
+```
+
+This is how you could use it in a Rails controller:
+
+```ruby
+class ContentfulWebhooksController < ApplicationController
+  def create
+    Renderful::CacheInvalidator.new(RenderfulClient).process_webhook(request.raw_post)
+    head :no_content
+  end
+end
+```
+
+### Rails integration
+
+If you are using Ruby on Rails and you want to use ERB instead of including HTML in your renderers,
+you can inherit from the Rails renderer:
+
+```ruby
+class JumbotronRenderer < Renderful::Renderer::Rails
+end
+```
+
+Then, create an `app/views/renderful/_jumbotron.html.erb` partial:
+
+```erb
+<div class="jumbotron">
+  <h1 class="display-4"><%= entry.title %></h1>
+  <p class="lead"><%= entry.content %></p>
+</div>
+```
+
+As you can see, you can access the Contentful entry via the `entry` local variable.
+
+#### Custom renderer
+
+The Rails renderer uses `ActionController::Base.renderer` by default, but this prevents you from
+using your own helpers in components. If you want to use a different renderer instead, you can
+override the `renderer` method:
+
+```ruby
+class JumbotronRenderer < Renderful::Renderer::Rails
+  def renderer
+    ApplicationController.renderer
+  end
+end
+``` 
+
+#### Custom locals
+
+If you want, you can also add your own locals:
+
+```ruby
+class JumbotronRenderer < Renderful::Renderer::Rails
+  def locals
+    italian_title = entry.title.gsub(/hello/, 'ciao')
+    { italian_title: italian_title }
+  end
+end
+```
+
+You would then access them like regular locals:
+
+```erb
+<div class="jumbotron">
+  <h1 class="display-4">
+    <%= entry.title %>
+    (<%= italian_title %>) 
+  </h1>
+  <p class="lead"><%= entry.content %></p>
+</div>
+```
+
+#### Resolution in ERB views
+
+If you need to render resolved fields (as in our `Grid` example), you can use `renderer` and
+`client` to access the `Renderful::Renderer` and `Renderful::Client` objects:
+
+```erb
+<%# app/views/renderful/_grid.html.erb %>
+<div class="grid">
+  <% renderer.blocks.each do |block| %>
+    <div class="grid-entry">
+      <%= client.render(block) %>
+    </div>
+  <% end %>
+</div>
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 tags, 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/bestmadeco/renderful.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Credits
+
+Renderful is sponsored and maintained by [Bolt Threads Inc.](https://www.boltthreads.com).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "renderful"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/renderful/cache/redis.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Renderful
+  class Cache
+    class Redis < Cache
+      attr_reader :redis
+
+      def initialize(redis)
+        @redis = redis
+      end
+
+      def exist?(key)
+        redis.exists(key)
+      end
+
+      def read(key)
+        redis.get(key)
+      end
+
+      def write(key, value)
+        redis.set(key, value)
+      end
+
+      def delete(key)
+        redis.del(key)
+      end
+    end
+  end
+end

data/lib/renderful/cache.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Renderful
+  class Cache
+    def exist?(_key)
+      raise NotImplementedError
+    end
+
+    def read(_key)
+      raise NotImplementedError
+    end
+
+    def write(_key, _value)
+      raise NotImplementedError
+    end
+
+    def delete(_key)
+      raise NotImplementedError
+    end
+  end
+end

data/lib/renderful/cache_invalidator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Renderful
+  class CacheInvalidator
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def process_webhook(body)
+      return unless client.cache
+
+      params = body.is_a?(String) ? JSON.parse(body) : body
+
+      client.cache.delete(client.cache_key_for(
+        content_type_id: params['sys']['contentType']['sys']['id'],
+        entry_id: params['sys']['id'],
+      ))
+    end
+  end
+end

data/lib/renderful/client.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Renderful
+  class Client
+    attr_reader :contentful, :renderers, :cache
+
+    def initialize(contentful:, renderers:, cache: nil)
+      @contentful = contentful
+      @renderers = renderers
+      @cache = cache
+    end
+
+    def render(entry)
+      renderer = renderers[entry.content_type.id]
+      fail(NoRendererError, entry) unless renderer
+
+      return cache.read(cache_key_for(entry)) if cache&.exist?(cache_key_for(entry))
+
+      renderer.new(entry, client: self).render.tap do |output|
+        cache&.write(cache_key_for(entry), output)
+      end
+    end
+
+    def cache_key_for(entry)
+      if entry.respond_to?(:content_type)
+        cache_key_for(
+          content_type_id: entry.content_type.id,
+          entry_id: entry.id,
+        )
+      else
+        "contentful/#{entry.fetch(:content_type_id)}/#{entry.fetch(:entry_id)}"
+      end
+    end
+  end
+end

data/lib/renderful/no_renderer_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Renderful
+  class NoRendererError < StandardError
+    attr_reader :entry
+
+    def initialize(entry, *args)
+      @entry = entry
+
+      super "Cannot find renderer for content type #{entry.content_type.id}", *args
+    end
+  end
+end

data/lib/renderful/renderer/rails.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Renderful
+  class Renderer
+    class Rails < Renderer
+      def render
+        renderer.render(partial: view, locals: locals.merge(default_locals))
+      end
+
+      private
+
+      def renderer
+        ActionController::Base.renderer
+      end
+
+      def locals
+        {}
+      end
+
+      def view
+        "renderful/#{entry.content_type.id.demodulize.underscore}"
+      end
+
+      def default_locals
+        { entry: entry, client: client, renderer: self }
+      end
+    end
+  end
+end

data/lib/renderful/renderer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Renderful
+  class Renderer
+    attr_reader :entry, :client
+
+    class << self
+      def resolve(field)
+        define_method(field) do
+          resolve(entry.send(field))
+        end
+      end
+    end
+
+    def initialize(entry, client:)
+      @entry = entry
+      @client = client
+    end
+
+    def render
+      raise NotImplementedError
+    end
+
+    private
+
+    def resolve(reference)
+      if reference.is_a?(Enumerable)
+        reference.map(&method(:resolve))
+      elsif reference.is_a?(Contentful::Link)
+        reference.resolve(client.contentful)
+      else
+        reference
+      end
+    end
+  end
+end

data/lib/renderful/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Renderful
+  VERSION = "0.1.0"
+end

data/lib/renderful.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'contentful'
+
+require 'renderful/no_renderer_error'
+require 'renderful/cache'
+require 'renderful/cache/redis'
+require 'renderful/cache_invalidator'
+require 'renderful/client'
+require 'renderful/renderer'
+require 'renderful/renderer/rails'
+require 'renderful/version'
+
+module Renderful
+end

data/renderful.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'renderful/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'renderful'
+  spec.version       = Renderful::VERSION
+  spec.authors       = ['Alessandro Desantis']
+  spec.email         = ['desa.alessandro@gmail.com']
+
+  spec.summary       = 'Render your Contentful space!'
+  spec.homepage      = 'https://github.com/nebulab/renderful'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/nebulab/renderful'
+  spec.metadata['changelog_uri'] = 'https://github.com/nebulab/renderful/blob/master/README.md'
+
+  # 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 { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'contentful', '~> 2.11'
+  spec.add_dependency 'rails', '~> 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'redis', '~> 4.1'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
+  # These are locked because we need to use Hound's versions
+  spec.add_development_dependency 'rubocop', '0.64.0'
+  spec.add_development_dependency 'rubocop-rspec', '1.32.0'
+end

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: renderful
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: contentful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.64.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.32.0
+description: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".hound.yml"
+- ".rubocop-https---relaxed-ruby-style-rubocop-yml"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/renderful.rb
+- lib/renderful/cache.rb
+- lib/renderful/cache/redis.rb
+- lib/renderful/cache_invalidator.rb
+- lib/renderful/client.rb
+- lib/renderful/no_renderer_error.rb
+- lib/renderful/renderer.rb
+- lib/renderful/renderer/rails.rb
+- lib/renderful/version.rb
+- renderful.gemspec
+homepage: https://github.com/nebulab/renderful
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nebulab/renderful
+  source_code_uri: https://github.com/nebulab/renderful
+  changelog_uri: https://github.com/nebulab/renderful/blob/master/README.md
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Render your Contentful space!
+test_files: []