mastalk 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fa34d35ace0d3aa881d8ff4e4e4616a2fff443bf
-  data.tar.gz: 89fd413fad2876c3bcb93bd63dacffdc7954b589
+  metadata.gz: e21f308f7ad9aa85a951dcab033dc1b5254d9c07
+  data.tar.gz: f43c759e6857c4ea1ece6e3384ce690b4091a5d5
 SHA512:
-  metadata.gz: 3aaf295a8584b5b0a45138f0aaf2c114895c6555571625674537c70f40447ae3e292bd9e6f0e03b41385ab63cff4fffe6cd86be34c4dabdb1c622b75a255afaf
-  data.tar.gz: a1482d6c08c6ca90915861bc532d05cb6b869dc066353a83da93b1be2e2a0cc8c858b4587e5e1bcd25b86d1c55f3e893ce59178be5409b99e157498c68887f3f
+  metadata.gz: c2bb96d094ff5fd0c8bb338a19654c02028f09ce1dbce0cb6c657afd8069f7851c9ce57bdf39aa943a648c6645ef367b219ed82694eec5c51e5e4f319747bdf0
+  data.tar.gz: b225defd922444371958bda7e155d9121e4552f9e0c3bcc4ed5d882de4058ec656240ffcef7f8300cb2fc2f1bee8cb609c861290cffa38608c70a8af635189a5

data/.gitignore

@@ -1,2 +1,3 @@
 *.DS_Store
 Gemfile.lock
+profiling_results/mastalk_profiling*

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
   - 2.1.2
-  - 1.9.3
 before_install:
   - gem install bundler

data/Gemfile

@@ -1,3 +1,10 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :profile do
+  gem 'bluecloth'
+  gem 'pry-byebug'
+  gem 'rdiscount'
+  gem 'ruby-prof', require: false
+end

data/README.md

@@ -364,3 +364,25 @@ Outputs:
 ```
 
 `$bl_c` `$bl_m` positioning can be swapped around to switch element positions.
+
+### Profiling Mastalk
+
+Inside of the project you can run:
+
+```
+ruby -Ilib ./bin/mastalk-profiling
+```
+
+This command will generate different types of graphs and the ruby stack
+for you investigate possible bottlenecks on performance.
+
+### Benchmarking Mastalk
+
+Inside of the project you can run:
+
+```
+ruby -Ilib ./bin/mastalk-benchmarking
+```
+
+This command will print different benchmarking for Mastalk when parsing
+10, 100, 200 and 500 documents.

data/bin/markdown-libraries-benchmark

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+Bundler.require(:profile)
+
+%w(benchmark kramdown bluecloth rdiscount).each do |lib|
+  require lib
+end
+
+require 'mastalk'
+
+n  = 1000
+mastalk = Mastalk::Document.new(File.read(File.join('spec', 'fixtures', 'cms_page_content')))
+markdown = mastalk.send(:preprocess, mastalk.source)
+
+def parse_markdown(parser, markdown)
+  parser.new(markdown).to_html
+end
+
+Benchmark.bm 15 do |x|
+  x.report('Kramdown') do
+    n.times { parse_markdown Kramdown::Document, markdown }
+  end
+
+  x.report('Bluecloth') do
+    n.times { parse_markdown BlueCloth, markdown }
+  end
+
+  x.report('RDiscount') do
+    n.times { parse_markdown RDiscount, markdown }
+  end
+end

data/bin/mastalk-benchmark

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+require 'mastalk'
+require 'ruby-prof'
+require 'benchmark'
+
+class MastalkBenchmark
+  def initialize(documents:)
+    @documents_size = documents
+    @cms_page_content = File.read(File.join('spec', 'fixtures', 'cms_page_content'))
+  end
+
+  def to_html
+    @documents_size.times do
+      Mastalk::Document.new(@cms_page_content).to_html
+    end
+  end
+end
+
+Benchmark.bm do |x|
+  x.report('Parsing 10 documents') do
+    MastalkBenchmark.new(documents: 10).to_html
+  end
+
+  x.report('Parsing 100 documents') do
+    MastalkBenchmark.new(documents: 100).to_html
+  end
+
+  x.report('Parsing 200 documents') do
+    MastalkBenchmark.new(documents: 200).to_html
+  end
+
+  x.report('Parsing 500 documents') do
+    MastalkBenchmark.new(documents: 500).to_html
+  end
+
+  x.report('Parsing 1000 documents') do
+    MastalkBenchmark.new(documents: 1000).to_html
+  end
+end

data/bin/mastalk-profiling

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'mastalk'
+require 'ruby-prof'
+
+cms_page_content = File.read(File.join('spec', 'fixtures', 'cms_page_content'))
+
+PAGES_SIZE = 500
+
+puts '*' * 80
+puts "Profiling: parsing #{PAGES_SIZE} pages."
+puts '*' * 80
+
+result = RubyProf.profile do
+  PAGES_SIZE.times do
+    Mastalk::Document.new(cms_page_content).to_html
+  end
+end
+
+printer = RubyProf::MultiPrinter.new(result)
+printer.print(path: 'profiling_results', profile: 'mastalk_profiling')

data/lib/mastalk/document.rb

@@ -0,0 +1,38 @@
+require 'kramdown'
+require 'htmlentities'
+require 'mastalk/extensions'
+
+module Mastalk
+  # Document class to preprocess
+  # mastalk specific syntax
+  class Document
+    include Mastalk::Extensions
+
+    attr_reader :source
+
+    def initialize(source)
+      @source = source.dup
+    end
+
+    def to_html(options = {})
+      auto_ids = options[:auto_id].nil? ? true : options[:auto_ids]
+      kramdown = Kramdown::Document.new(
+        preprocess(source),
+        auto_ids: auto_ids
+      )
+      html, _ = Kramdown::Converter::Html.convert(kramdown.root, kramdown.options)
+      ::HTMLEntities.new.decode(html)
+    end
+
+    private
+
+    def preprocess(source)
+      extensions.each do |regex, block|
+        while source.match(regex)
+          source.sub!(regex, block.call(Regexp.last_match.captures.first).strip)
+        end
+      end
+      source
+    end
+  end
+end

data/lib/mastalk/extensions.rb

@@ -26,9 +26,10 @@ module Mastalk
         next if file == '.' || file == '..'
         content = File.read(File.join(SNIPPETS_FOLDER, file))
         start, stop = args(content)
+        erb = ERB.new(remove_syntax_from(content))
         extension(start, stop) do |body|
           body_lines = body.strip.gsub(/(\n|\r)+/, "\n").split(/\n/)
-          ERB.new(remove_syntax_from(content)).result(binding)
+          erb.result(binding)
         end
       end
 

data/lib/mastalk/snippets/callout.html.erb

@@ -2,5 +2,5 @@
 
 <div class='callout callout--tip'>
   <span class="callout__icon" aria-hidden="true">?</span>
-  <%= Mastalk::Document.new(body.strip).to_html(:auto_id => false) %>
+  <%= Mastalk::Document.new(body.strip).to_html(auto_id: false) %>
 </div>

data/lib/mastalk/snippets/callout_tool.html.erb

@@ -6,5 +6,5 @@
       <use xlink:href="#svg-icon--tool"></use>
     </svg>
   </span>
-  <%= Mastalk::Document.new(body.strip).to_html(:auto_id => false) %>
+  <%= Mastalk::Document.new(body.strip).to_html(auto_id: false) %>
 </div>

data/lib/mastalk.rb

@@ -1,39 +1 @@
-require 'kramdown'
-require 'htmlentities'
-require_relative 'mastalk/extensions'
-
-module Mastalk
-  # Document class to preprocess
-  # mastalk specific syntax
-  class Document
-    include Mastalk::Extensions
-
-    attr_reader :source
-
-    def initialize(source)
-      @source = source.dup
-    end
-
-    def to_html(options = {})
-      options[:auto_id] = options[:auto_id].nil? ? true : options[:auto_id]
-      ::HTMLEntities.new.decode( kramdown(options).to_html() )
-    end
-
-    private
-
-    def kramdown(options = {})
-      options[:auto_id] = options[:auto_id].nil? ? true : options[:auto_id]
-      Kramdown::Document.new(preprocess(source), :auto_ids => options[:auto_id])
-    end
-
-    def preprocess(source)
-      extensions.map do |regex, block|
-        if source.match(regex)
-          source.sub!(regex, block.call(Regexp.last_match.captures.first).strip)
-        end
-      end
-      preprocess(source) if extensions.any? {|regex, _| source.match(regex)}
-      source
-    end
-  end
-end
+require 'mastalk/document'

data/mastalk.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = 'mastalk'
-  s.version     = '0.8.1'
+  s.version     = '0.9.0'
   s.summary     = 'mastalk'
   s.description = 'Mastalk markdown extension language'
   s.authors     = ['Douglas Roper', 'Justin Perry']
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/moneyadviceservice/mastalk'
   s.license       = 'MIT'
 
-  s.add_runtime_dependency 'kramdown', '~> 1.5.0', '>= 1.5.0'
+  s.add_runtime_dependency 'kramdown', '~> 1.13', '>= 1.13'
   s.add_runtime_dependency 'htmlentities', '~> 4.3.2', '>= 4.3.2'
   s.add_development_dependency 'rspec', '~> 3.1.0', '>= 3.1.0'
   s.add_development_dependency 'rake', '~> 10.3.2', '>= 10.3.2'

data/spec/fixtures/cms_page_content

@@ -0,0 +1,149 @@
+This guide to choosing the right bank account is for you if you’re trying to decide what type of account best fits your needs or you want to know which features of an account you should compare. It can also help if you’re thinking of switching your bank account.
+
+Choose the type of account that suits your needs
+Decide what charges and features you want to compare
+Decide how you want to deal with your bank
+Compare different accounts using comparison sites
+Is it worth switching your bank account?
+If you’re claiming Universal Credit
+Watch our video – How to open a bank account
+Choose the type of account that suits your needs
+
+Current accounts
+
+Most people use a current account with a bank or building society to manage their day-to-day money. It allows you to:
+
+Pay bills by Direct Debit or standing order
+Receive automated payments such as salary, wages or benefits
+Pay for things with a debit card and withdraw money from cashpoint machines
+Access to an overdraft, although this will need to be authorised by the bank
+^Read more about current accounts.^
+
+Packaged accounts
+
+$~callout
+
+If you’re thinking about opening a packaged account, be sure to check out how many of the additional benefits you would actually use and whether you can get them cheaper elsewhere.
+
+~$
+
+Some current accounts offer extra features for which they charge a fee (often between £10 and £15 a month). These are known as packaged accounts. Extras include:
+
+Special offers (eg preferential interest rates on overdrafts)
+Car breakdown cover
+Insurance cover (eg travel or mobile phone insurance)
+Extra services
+^Read more about packaged accounts.^
+
+Fee-free Basic bank accounts
+
+These are often used as a stepping stone to a current account. A basic bank account doesn’t normally have an overdraft facility but does allow you to:
+
+Pay bills by Direct Debit or standing order
+Receive payments such as salary, wages or benefits
+A fee-free basic bank account may be right for you if:
+
+You have a poor credit record or you’re on a low income
+You don’t need the extra things that a current account offers, for example an overdraft facility
+^Want to find out more about fee-free basic bank accounts? We’ve pulled together a collection of guides, tips and handy links to make sure you get the best deal.^
+
+Jam jar accounts
+
+These accounts are sometimes called budgeting accounts or rent accounts and are designed to help you budget. They let you divide your money into different 'pots' or 'jars'. You decide how much money goes into each pot by working out how much you need for your bills and how much is left over for spending or saving.
+
+They also allow you to:
+
+Pay bills by Direct Debit or standing order
+Receive payments such as salary, wages or benefits.
+One disadvantage of these accounts is that they charge a monthly fee
+
+A jam jar account might be right for you if:
+
+You want an account that helps you to budget
+You want to avoid charges for refused Direct Debits
+You rent a council or housing association property – in which case your landlord might pay the monthly fee for you
+^Read more about jam jar accounts.^
+
+Bank accounts for students and graduates
+
+Most banks will offer a specific student account usually with an interest-free overdraft up to an agreed amount.
+
+Banks often also offer attractive accounts to graduates to attempt to secure them as long-term customers.
+
+^Find out more about bank accounts for students and graduates.^
+
+Decide what charges and features you want to compare
+
+Fees, charges and overdraft costs
+
+Fees can vary a lot between banks and between accounts, with one of the highest fees being charged for going over your agreed overdraft limit (if you have one).
+
+If you regularly spend more than you have in your account, choose one which will give you an overdraft up to an agreed limit without charging fees and/ or with a low interest rate.
+
+Interest rates on credit balances
+
+If you’re careful about your spending and never go overdrawn, have a look at the accounts that pay interest on your credit balance. However, if your earnings are on the low side and you do sometimes use your overdraft, don’t pay too much attention to the credit interest – focus more on the charges instead.
+
+Incentives
+
+Many banks offer deals to attract new customers, but be sure to check if there are strings attached. Look beyond any short-term offer and make sure that, when it ends, the account will still be the best for you. Deals include:
+
+A cash incentive
+Higher interest for a period
+A monthly credit of usually around £5.
+Decide how you want to deal with your bank
+
+Do you like dealing with a person in a branch or would you prefer the convenience of telephone or Internet banking?
+
+Not all banks provide phone, Internet, mobile banking, postal and branch services so make sure you will be able to bank how you want to.
+
+If you like going into a branch, choosing a bank you can easily get to will be the most important factor.
+
+Make sure there’s a cashpoint machine that you can use free of charge near where you live or work. Otherwise you might be charged between 75p and £10 for withdrawing money.
+
+Compare different accounts using comparison sites
+
+Comparison websites are a good starting point for anyone trying to find a current account tailored to their needs.
+
+We recommend the following websites for comparing current accounts:
+
+Go Compare{:target="_blank"} – This also allows you to use the government-backed Midata tool to securely upload your past transactions for customised current account recommendations.
+Moneyfacts{:target="_blank"}
+Money Saving Expert{:target="_blank"}
+Money Supermarket{:target="_blank"}
+Remember:
+
+Comparison websites won’t all give you the same results, so make sure you use more than one site before making a decision.
+It is also important to do some research into the type of product and features you need before making a purchase or changing supplier.
+^Find out more in our guide to comparison sites.^
+
+Is it worth switching your bank account?
+
+If you’re unhappy with the service you are getting from your current bank then it’s easy to change. Your new bank will do the work for you and there is no need to deal with your old bank.
+
+It’s worth checking every year that your bank is offering everything you need. If not, think about switching.
+
+It takes just seven working days to switch your account under the Current Account Switch Service. You choose the date you want to switch, and agree this with your new bank. They will arrange for all your incoming and outgoing payments to be moved to your new account.
+
+^Find everything you need to know about switching bank account on the Current Account Switch Service website{:target="_blank"}.^
+
+The government is working with the banks on plans to give customers their account data in a simple, standardised format that can be used in comparison sites.
+
+This will make it much easier for you to do quick and easy comparisons of current accounts, including the fees, charges and benefits, and make informed decisions on whether there are better accounts for you to switch to.
+
+If you’re claiming Universal Credit
+
+If you’re getting ready for the introduction of Universal Credit, follow the link below to find out what your account options are and the pros and cons of each one.
+
+^Read more about Choosing a bank account for your Universal Credit payment.^
+
+Watch our video – How to open a bank account
+
+$~youtube_video
+
+XZoc2Cv3BAE?
+
+Video - How to open a bank account
+~$
+
+Read a transcript of this video (DOC 26.5KB)

data/spec/fixtures/duplicated_snippets

@@ -0,0 +1,55 @@
+
+$~youtube_video
+
+XZoc2Cv3BAE?
+
+Video 1
+~$
+
+$~youtube_video
+
+qv8RpXmXrh0?
+
+Universal Credit - Online Budgeting Support
+~$
+
+$~youtube_video
+
+2eVfzMFU9X4?
+
+Top Tips To Save Hundreds On Your Food Bill
+~$
+
+$~youtube_video
+
+U9Vkn_u-W1M?
+
+How To Sell Online And Make Cash Quick
+~$
+
+$~youtube_video
+
+Q1tVzEs9zoM?
+
+How To Sell Online And Make Cash Quick 2
+~$
+
+$~callout
+
+If you’re thinking about opening a packaged account, be sure to check out how many of the additional benefits you would actually use and whether you can get them cheaper elsewhere.
+
+~$
+
+$~callout
+
+If you’re thinking about opening a packaged account, be sure to check out how many of the additional benefits you would actually use and whether you can get them cheaper elsewhere.
+
+~$
+
+$~callout
+
+If you’re buying a home with someone else, you can both take advantage of
+separate Lifetime ISAs.
+
+~$
+

data/spec/fixtures/expected_conversion_duplicated_snippets

@@ -0,0 +1,35 @@
+
+<iframe frameborder="0" height="413" width="680" src="https://www.youtube.com/embed/XZoc2Cv3BAE??rel=0" title="Video 1">
+</iframe>
+
+<iframe frameborder="0" height="413" width="680" src="https://www.youtube.com/embed/qv8RpXmXrh0??rel=0" title="Universal Credit - Online Budgeting Support">
+</iframe>
+
+<iframe frameborder="0" height="413" width="680" src="https://www.youtube.com/embed/2eVfzMFU9X4??rel=0" title="Top Tips To Save Hundreds On Your Food Bill">
+</iframe>
+
+<iframe frameborder="0" height="413" width="680" src="https://www.youtube.com/embed/U9Vkn_u-W1M??rel=0" title="How To Sell Online And Make Cash Quick">
+</iframe>
+
+<iframe frameborder="0" height="413" width="680" src="https://www.youtube.com/embed/Q1tVzEs9zoM??rel=0" title="How To Sell Online And Make Cash Quick 2">
+</iframe>
+
+<div class="callout callout--tip">
+  <span class="callout__icon" aria-hidden="true">?</span>
+  <p>If you’re thinking about opening a packaged account, be sure to check out how many of the additional benefits you would actually use and whether you can get them cheaper elsewhere.</p>
+
+</div>
+
+<div class="callout callout--tip">
+  <span class="callout__icon" aria-hidden="true">?</span>
+  <p>If you’re thinking about opening a packaged account, be sure to check out how many of the additional benefits you would actually use and whether you can get them cheaper elsewhere.</p>
+
+</div>
+
+<div class="callout callout--tip">
+  <span class="callout__icon" aria-hidden="true">?</span>
+  <p>If you’re buying a home with someone else, you can both take advantage of
+separate Lifetime ISAs.</p>
+
+</div>
+

data/spec/integration/conversion_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+RSpec.describe 'Integration Tests' do
+  subject(:document) { Mastalk::Document.new(content) }
+
+  context 'when parsing duplicated snippets' do
+    let(:content) do
+      File.read(File.join('spec', 'fixtures', 'duplicated_snippets'))
+    end
+
+    let(:expected_result) do
+      File.read(
+        File.join('spec', 'fixtures', 'expected_conversion_duplicated_snippets')
+      )
+    end
+
+    it 'converts to html using the snippets' do
+      expect(document.to_html).to eq(expected_result)
+    end
+  end
+end

data/spec/{mastalk_spec.rb → mastalk/document_spec.rb}

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Mastalk::Document do
-
   context 'Without mastalk syntax' do
     let(:context) { "###test\nwith markdown" }
     let(:expected) { "<h3 id=\"test\">test</h3>\n<p>with markdown</p>\n" }
@@ -284,5 +283,4 @@ describe Mastalk::Document do
       expect(subject.to_html).to eq(expected)
     end
   end
-
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mastalk
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Douglas Roper
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: kramdown
@@ -17,20 +17,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.13'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '1.13'
 - !ruby/object:Gem::Dependency
   name: htmlentities
   requirement: !ruby/object:Gem::Requirement
@@ -105,7 +105,11 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/markdown-libraries-benchmark
+- bin/mastalk-benchmark
+- bin/mastalk-profiling
 - lib/mastalk.rb
+- lib/mastalk/document.rb
 - lib/mastalk/extensions.rb
 - lib/mastalk/snippets/action_item.html.erb
 - lib/mastalk/snippets/add_action.html.erb
@@ -130,7 +134,12 @@ files:
 - lib/mastalk/snippets/youtube_video.html.erb
 - lib/mastalk/snippets/youtube_video_legacy.html.erb
 - mastalk.gemspec
-- spec/mastalk_spec.rb
+- profiling_results/.gitkeep
+- spec/fixtures/cms_page_content
+- spec/fixtures/duplicated_snippets
+- spec/fixtures/expected_conversion_duplicated_snippets
+- spec/integration/conversion_spec.rb
+- spec/mastalk/document_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/moneyadviceservice/mastalk
 licenses: