tech_radar 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12c5a51e4ba45174512792a3392836535cc46d2d
-  data.tar.gz: 827dd7cace04d49531c568cb16a9b17005d19b04
+  metadata.gz: 017f7f9db5644c8fef87cc38ec4b447b60277a8f
+  data.tar.gz: 15926f574b2fdddb449f128db0fe1be0cccf1557
 SHA512:
-  metadata.gz: 20905adc6a36a6f4091ba81b3549f253888bb666cfb21e5f14428b133fdfdeac86195f4f77ea7e65edb0d3a905e9f03afef2057acbdf8a97704347837d24232a
-  data.tar.gz: 72b927aa902313753ffa53b6b2c2fc6218d1ba21d23f0560d4a10bd4f385127132b6b74f71828264f40a1dceaa066383e25808eeca8956ea1928b8da89987e8d
+  metadata.gz: cec199461227239004563f3c70bd7c3ada6a29f1c63640b2846d1806349ebf41362cc48a2308db38ccf49372895fd4d4cc3f7c7cd72ed802cf6fd24c3f0a8152
+  data.tar.gz: 8e87e6566033cc82957d4eb42e776ba486874340450e9a5398731286f8de085ac206dbe3fee4d165f298e4e4a6365bfe84a1c03dfd7447c3fb54fdad787842cb

data/app/helpers/tech_radar/application_helper.rb

@@ -22,5 +22,9 @@ module TechRadar
       technology.ring != 'Adopt' && technology.ring != 'Trial'
     end
 
+    def render_summary(summary_text)
+      TechRadar::Rendering.renderer.render_text(summary_text)
+    end
+
   end
 end

data/app/models/tech_radar/rendering/Markdown.rb

@@ -0,0 +1,28 @@
+module TechRadar
+  module Rendering
+    class Markdown
+      def initialize
+        require 'redcarpet'
+        renderer = Redcarpet::Render::HTML.new(
+              filter_html: true,
+                no_styles: true,
+          safe_links_only: true
+        )
+        @markdown = Redcarpet::Markdown.new(renderer,
+                                            no_intra_emphasis: true,
+                                                       tables: true,
+                                           fenced_code_blocks: true,
+                                                     autolink: true,
+                                 disable_indented_code_blocks: true,
+                                                strikethrough: true,
+                                                  superscript: true)
+      rescue LoadError => ex
+        raise "Since you speecified markdown rendering, you must include the redcarpet gem in your app: #{ex.message}"
+      end
+
+      def render_text(text)
+        @markdown.render(text).html_safe
+      end
+    end
+  end
+end

data/app/models/tech_radar/rendering/Plaintext.rb

@@ -0,0 +1,9 @@
+module TechRadar
+  module Rendering
+    class Plaintext
+      def render_text(text)
+        text
+      end
+    end
+  end
+end

data/app/models/tech_radar/rendering.rb

@@ -0,0 +1,9 @@
+module TechRadar
+  module Rendering
+    def self.renderer
+      @renderers ||= {}
+      @renderers[TechRadar.summary_format] ||= "tech_radar/rendering/#{TechRadar.summary_format}".classify.constantize.new
+      @renderers[TechRadar.summary_format]
+    end
+  end
+end

data/app/views/tech_radar/technologies/show.html.erb

@@ -14,7 +14,7 @@
       </p>
     <% else %>
       <% if @technology.more_details_summary.present? %>
-        <p><%= @technology.more_details_summary %></p>
+        <p class="text-muted"><%= render_summary(@technology.more_details_summary) %></p>
       <% end %>
       <p>
         <%= link_to t("tech_radar.radar.technologies.more_details_url.link"), @technology.more_details_url, class: "btn btn-default" %>
@@ -26,7 +26,7 @@
     <% if @technology.why_summary.present? %>
       <p>
         <span class="text-muted">
-          <%= @technology.why_summary %>
+          <%= render_summary(@technology.why_summary) %>
         </span>
         <% if @technology.why_url.present? %>
           <%= link_to t("tech_radar.radar.technologies.why_summary.link"), @technology.why_url %>

data/lib/tech_radar/version.rb

@@ -1,3 +1,3 @@
 module TechRadar
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/tech_radar.rb

@@ -8,4 +8,8 @@ module TechRadar
   mattr_accessor :warn_on_missing_why_summary
 
   TechRadar.warn_on_missing_why_summary = Hash.new(true)
+
+  mattr_accessor :summary_format
+
+  TechRadar.summary_format = :plaintext
 end

data/test/controllers/tech_radar/technologies_controller_test.rb

@@ -4,6 +4,7 @@ module TechRadar
   class TechnologiesControllerTest < ActionController::TestCase
     setup do
       @routes = Engine.routes
+      TechRadar.summary_format = :markdown
     end
 
     test "index" do
@@ -46,7 +47,7 @@ module TechRadar
       assert_response :success
       assert response.body.include?("Ruby"),"Expected #{response.body} to include 'Ruby'"
       refute response.body.include?("Google"),"Expected #{response.body} NOT to include a link to a Google search"
-      assert response.body.include?("object-oriented"),"Expected #{response.body} to include Ruby's summary"
+      assert response.body.include?("<em>object-oriented</em>"),"Expected #{response.body} to include Ruby's summary, parsed as markdown"
     end
 
     test "show with more_details_url" do

data/test/dummy/config/tech-radar.yml

@@ -8,7 +8,6 @@
   "Trial":
     ElasticSearch:
       purpose: "Indexed Search"
-      more_details_url:
       why_summary: "Erch and CXE using"
     HumbleKit:
       purpose: "CSS Framework"
@@ -77,7 +76,7 @@
     Ruby:
       purpose: Middleware Programming
       more_details_url: https://www.ruby-lang.org/en/
-      more_details_summary: "Ruby is a dynamic, object-oriented programming language that combines ideas from Smalltalk, Perl, and others"
+      more_details_summary: "Ruby is a dynamic, _object-oriented_ programming language that combines ideas from Smalltalk, Perl, and others"
   "Trial":
     CoffeeScript:
       purpose: Browser Programming

data/test/models/tech_radar/radar_test.rb

@@ -45,7 +45,7 @@ module TechRadar
       technology = @radar.technology("Ruby")
       assert_equal "Ruby"                          , technology.name
       assert_equal "https://www.ruby-lang.org/en/" , technology.more_details_url
-      assert_equal "Ruby is a dynamic, object-oriented programming language that combines ideas from Smalltalk, Perl, and others",
+      assert_equal "Ruby is a dynamic, _object-oriented_ programming language that combines ideas from Smalltalk, Perl, and others",
                    technology.more_details_summary
       assert_equal nil                             , technology.why_url
       assert_equal nil                             , technology.why_summary

data/test/models/tech_radar/rendering_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module TechRadar
+  class RenderingTest < ActiveSupport::TestCase
+
+    test "plaintext" do
+      TechRadar.summary_format = :plaintext
+      renderer = Rendering.renderer
+
+      assert_equal TechRadar::Rendering::Plaintext,renderer.class
+    end
+
+    test "markdown" do
+      TechRadar.summary_format = :markdown
+      renderer = Rendering.renderer
+
+      assert_equal TechRadar::Rendering::Markdown,renderer.class
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -3,7 +3,6 @@ ENV["RAILS_ENV"] = "test"
 
 require File.expand_path("../../test/dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
-require "mocha/test_unit"
 
 # Filter out Minitest backtrace while allowing backtrace from other libraries
 # to be shown.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tech_radar
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Stitch Fix Engineering
@@ -54,7 +54,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,6 +87,9 @@ files:
 - app/helpers/tech_radar/application_helper.rb
 - app/models/tech_radar/quadrant.rb
 - app/models/tech_radar/radar.rb
+- app/models/tech_radar/rendering.rb
+- app/models/tech_radar/rendering/Markdown.rb
+- app/models/tech_radar/rendering/Plaintext.rb
 - app/models/tech_radar/ring.rb
 - app/models/tech_radar/technology.rb
 - app/views/layouts/tech_radar/application.html.erb
@@ -177,6 +180,7 @@ files:
 - test/dummy/tmp/cache/assets/test/sprockets/v3.0/wjc4fxI0T-E_AMREBsqAzcOoJVLQ2XmN8ybSXr2sA1c.cache
 - test/integration/navigation_test.rb
 - test/models/tech_radar/radar_test.rb
+- test/models/tech_radar/rendering_test.rb
 - test/test_helper.rb
 homepage: https://github.com/stitchfix/tech_radar
 licenses:
@@ -278,4 +282,5 @@ test_files:
 - test/dummy/tmp/cache/assets/test/sprockets/v3.0/ZWMSse5xwAn4lVdnOdzP7aamfJLIIJ3tgM_K6QgcID8.cache
 - test/integration/navigation_test.rb
 - test/models/tech_radar/radar_test.rb
+- test/models/tech_radar/rendering_test.rb
 - test/test_helper.rb