highlighting 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 204053f1c717db58034721aa40f737528cddce61
-  data.tar.gz: efb1264e2ede9c2d098eb5a877871655c283401f
+  metadata.gz: 3a91cd326a58f0bf9c6fa2e02fd9da5ae3a07f13
+  data.tar.gz: b5db690c5a54d12385bbe12bc9d6b89576c9237a
 SHA512:
-  metadata.gz: 8903d486c0dc71dff282bd9e7417bdfcb823838bd06ce1d5e18a73a225728bd155ad102b8e859af33c1ee11935fb28bc7a8420fe9dc183dd396b9bfad0dd73ad
-  data.tar.gz: f0eb6f710a89a3c8d2e56789a81715e7d1c1ca0c7978313ba1c8dada4723f58c4e795019202e635b842b940ff02e894a97d2d7849847eeb27f74f9fb4d24ef07
+  metadata.gz: fcbfc9363c70920b181271852de51246b79551bfd1b8678021deed754d91ab62b59962ccd35a19858064d16aac0d6a61439ba7dd191d34e2811028dcaa1e2f54
+  data.tar.gz: 996c368f3e7f2c5d6044cfd1be83038ea7039bff1b0004fe5cbe5898f4343c18c6264aa14fb9a03db7b5fa7a98dc09870747393df4b140d388d2b02f62ca3f05

data/README.md

@@ -1,11 +1,9 @@
 # Highlighting
 
-Highlighting is based on [PrismJS](http://prismjs.com).
+Highlighting ships with [PrismJS](http://prismjs.com).
 
 > Prism is a lightweight, robust, elegant syntax highlighting library. It's a spin-off project from Dabblet.
 
-To use highlighting, please read this [stackoverflow post](http://stackoverflow.com/a/34373693/388280)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -26,17 +24,54 @@ Or install it yourself as:
 $ gem install highlighting
 ```
 
+At application.js, replace [language] with the name of language. For example: prism-ruby or prism-coffeescript
+```
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require prism
+//= require prism-[language]
+//= require prism-turbolinks #optional
+//= require_tree .
+```
+
+At application.css, add `*= require prism-[theme]` or use the default `*= require prism`
+
+```
+ *= require_tree .
+ *= require prism-[theme]
+ *= require_self
+```
+There are various other themes to choose from. For example `*= require prism-tomorrow`, `*= require prism-twilight`.
+
+
 ## Usage
+Use the alias in place of xxxx in `language-xxxx`. `language-xxxx` is a css rule here used by prismjs.
+
+For example: ruby, python, go, swift
 
 ```
-<pre>
-<code class="language-ruby">
-   <!-- type any ruby code you like -->
-</code>
-</pre>
+<%= code "language-ruby" %>
+  <!-- type any ruby code you like -->
+<% end %>
+```
+
+## Known Issues
 
+With turbolinks enabled, prismjs is not called at page load. For quick fix, add the `//= require prism-turbolinks` line at application.js
+
+```
+//= require jquery
+//= require jquery_ujs
+//= require turbolinks
+//= require prism
+//= require prism-ruby
+//= require prism-turbolinks
+//= require_tree .
 ```
 
+If you wish to add the code manually, read [prismjs not working with turbolinks](http://stackoverflow.com/questions/21278357/prism-js-not-working-with-rails-4-turbolinks/21355342#21355342)
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/app/helpers/syntax_helper.rb

@@ -1,2 +1,6 @@
 module SyntaxHelper
+  def code language, &block
+    content = capture(&block)
+    return "<pre><code class=\"#{language}\">#{content}</code></pre>".html_safe
+  end
 end

data/lib/highlighting/post_message.rb

@@ -0,0 +1,22 @@
+module Log
+  MESSAGE = "
+
+  ######################
+  ## HIGHLIGHTING
+  ######################
+
+  What's new in 0.1.2?
+  - SyntaxHelper <%= code "" %>
+  Usage:
+  <%= code \"language-ruby\" do %>
+    <!-- write any ruby code here !>
+    puts \"hello world\"
+  <% end %>
+
+  What's in 0.1.1?
+  - ship with PrismJS 1.4.1
+
+  Full Changelog -> https://github.com/ytbryan/highlighting/blob/master/changelog.md
+  Pull Request ->  https://github.com/ytbryan/highlighting/pulls
+  "
+end

data/lib/highlighting/version.rb

@@ -1,3 +1,3 @@
 module Highlighting
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/vendor/assets/javascripts/prism-turbolinks.js

@@ -0,0 +1,5 @@
+if (typeof Turbolinks !== "undefined") {
+  $(document).on('ready page:load', function() {
+     Prism.highlightAll()
+   });
+ }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: highlighting
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - bryan lim
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,10 +45,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
 - app/helpers/syntax_helper.rb
 - lib/highlighting.rb
+- lib/highlighting/post_message.rb
 - lib/highlighting/version.rb
 - vendor/assets/javascripts/prism-abap.js
 - vendor/assets/javascripts/prism-abap.min.js
@@ -260,6 +260,7 @@ files:
 - vendor/assets/javascripts/prism-tcl.min.js
 - vendor/assets/javascripts/prism-textile.js
 - vendor/assets/javascripts/prism-textile.min.js
+- vendor/assets/javascripts/prism-turbolinks.js
 - vendor/assets/javascripts/prism-twig.js
 - vendor/assets/javascripts/prism-twig.min.js
 - vendor/assets/javascripts/prism-typescript.js
@@ -283,11 +284,15 @@ files:
 - vendor/assets/stylesheets/prism-tomorrow.css
 - vendor/assets/stylesheets/prism-twilight.css
 - vendor/assets/stylesheets/prism.css
-homepage: http://github.com/ytbryan/highlighting.
+homepage: http://github.com/ytbryan/highlighting
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "\n\n  ######################\n  ## HIGHLIGHTING\n  ######################\n\n
+  \ What's new in 0.1.2?\n  - SyntaxHelper <%= code  %>\n  Usage:\n  <%= code \"language-ruby\"
+  do %>\n    <!-- write any ruby code here !>\n    puts \"hello world\"\n  <% end
+  %>\n\n  What's in 0.1.1?\n  - ship with PrismJS 1.4.1\n\n  Full Changelog -> https://github.com/ytbryan/highlighting/blob/master/changelog.md\n
+  \ Pull Request ->  https://github.com/ytbryan/highlighting/pulls\n  "
 rdoc_options: []
 require_paths:
 - lib

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 Bryan Lim
-
-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.