sir-trevor-rails 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b058dcb42f6b583ce26ba45ca37c3ff7b2ae2761
-  data.tar.gz: a8240fe8db02aa3c1eff15f78cd5fdc868b3848b
+  metadata.gz: 3d0668026fc08c29b2dcd100108e308f951d3cf2
+  data.tar.gz: fd580f1cb8dd62d6b2c5e51892ec2e7a22c51713
 SHA512:
-  metadata.gz: 9b8ce310cdd90b0e28e4570484636a786f8a8c6f6314127d77d67d3e200dc21fadb1ae163364f89b9ab64dc3fce84d6c45880ddb080ef30d74d4454e96ab38c6
-  data.tar.gz: 7aa991e742093fbad9db304acacbf3894cb3380a422664efa150ceb759bc17225cced8a104d721e529c9ede8c40df5817c975e7e79e474cc7a986b9607d6dc23
+  metadata.gz: fc6c224901a0f95b6cd9aa56fd5cc401f8b88c4d3ae4237f7aba6faed8efbde517c125b0be48bfd1cc1bf82d8710da03b82eaa6dfc4857a11bbc8cd6b337fde5
+  data.tar.gz: 01081da708b0e90c55b29bffd08715fb07af2e4cf9652117e3c26287fe22b7057f188a45be7ab81bc208b347646d2ca44469425d622220806274d0bc90119556

data/Gemfile.lock

@@ -1,9 +1,11 @@
 PATH
   remote: .
   specs:
-    sir-trevor-rails (0.2.2)
+    sir-trevor-rails (0.4.0)
+      activemodel
       activesupport (>= 3.0.7)
       jquery-rails
+      multi_json
       rails (>= 3.0.7)
       redcarpet (~> 2.0.1)
       twitter-text (~> 1.4)
@@ -11,84 +13,78 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    actionmailer (3.2.13)
-      actionpack (= 3.2.13)
+    actionmailer (4.0.0)
+      actionpack (= 4.0.0)
       mail (~> 2.5.3)
-    actionpack (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-      builder (~> 3.0.0)
+    actionpack (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
       erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.5)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.2.1)
-    activemodel (3.2.13)
-      activesupport (= 3.2.13)
-      builder (~> 3.0.0)
-    activerecord (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.4)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.0)
+      activesupport (= 4.0.0)
+      builder (~> 3.1.0)
+    activerecord (4.0.0)
+      activemodel (= 4.0.0)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.0)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    arel (4.0.0)
+    atomic (1.1.13)
+    builder (3.1.4)
     erubis (2.7.0)
-    hike (1.2.2)
-    i18n (0.6.1)
-    journey (1.0.4)
-    jquery-rails (2.2.1)
+    hike (1.2.3)
+    i18n (0.6.5)
+    jquery-rails (3.0.4)
       railties (>= 3.0, < 5.0)
       thor (>= 0.14, < 2.0)
-    json (1.7.7)
-    mail (2.5.3)
-      i18n (>= 0.4.0)
+    mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.23)
-    multi_json (1.7.2)
+    mime-types (1.25)
+    minitest (4.7.5)
+    multi_json (1.7.9)
     polyglot (0.3.3)
-    rack (1.4.5)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.3)
-      rack
+    rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.13)
-      actionmailer (= 3.2.13)
-      actionpack (= 3.2.13)
-      activerecord (= 3.2.13)
-      activeresource (= 3.2.13)
-      activesupport (= 3.2.13)
-      bundler (~> 1.0)
-      railties (= 3.2.13)
-    railties (3.2.13)
-      actionpack (= 3.2.13)
-      activesupport (= 3.2.13)
-      rack-ssl (~> 1.3.2)
+    rails (4.0.0)
+      actionmailer (= 4.0.0)
+      actionpack (= 4.0.0)
+      activerecord (= 4.0.0)
+      activesupport (= 4.0.0)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.0)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.0)
+      actionpack (= 4.0.0)
+      activesupport (= 4.0.0)
       rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (10.0.4)
-    rdoc (3.12.2)
-      json (~> 1.4)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.1.0)
     redcarpet (2.0.1)
-    sprockets (2.2.2)
+    sprockets (2.10.0)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
     thor (0.18.1)
-    tilt (1.3.7)
-    treetop (1.4.12)
+    thread_safe (0.1.2)
+      atomic
+    tilt (1.4.1)
+    treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
     twitter-text (1.6.1)

data/README.md

@@ -1,73 +1,18 @@
 # Sir Trevor Rails
 
-A Rails gem for integrating the Sir Trevor JS into your Rails 3.x application. 
+A set of Rails Helpers for Sir Trevor JS.
 
 # Usage
 
-Add Sir Trevor to your Gemfile 
+REWRITE REQUIRED.
 
-```ruby
-gem 'sir-trevor-rails'
-```
-
-```bash
-bundle install 
-```
-
-Require SirTrevor in your `application_controller.rb`
-
-```ruby
-require 'sir-trevor-rails'
-```
-
-Include Sir Trevor in your `application.css` file
-
-```css
-*= require sir-trevor
-```
-
-Include Sir Trevor in your `application.js` file
-
-```js
-//= require sir-trevor
-```
-
-In your view file for your editable content (must be a 'text' field as we store the JSON here) here we have a field called 'content'
-
-```ruby
-f.sir_trevor_text_area :content
-```
-
-And instantiate a new `SirTrevor.Editor` instance in your Javascript. 
-
-```javascript
-$(function(){
-  var editor = new SirTrevor.Editor({ el: $('.sir-trevor-area') });
-});
-```
-
-Or for multiple instances:
-
-```javascript
-$(function(){
-  var instances = $('.sir-trevor-area'),
-      l = instances.length, instance;
-  
-  while (l--) {
-    instance = $(instances[l]);
-    new SirTrevor.Editor({ el: instance });
-  }
-  
-});
-```
-
-To render your content (in your view file)
-
-```ruby
-<%= render_sir_trevor(post.content) %>
-```
+# Requirements
 
-There's an example Rails 3.2.7 project with all of this already done in the [Sir Trevor JS repository](https://github.com/madebymany/sir-trevor-js/tree/master/examples/rails/sir-trevor-example).
+- Rails 3.x
+- jQuery
+- (Eventable)[https://github.com/madebymany/eventable]
+- (Underscore)[https://github.com/jashkenas/underscore]
+- (Sir Trevor JS)[https://github.com/madebymany/sir-trevor-js]
 
 # Generators
 
@@ -83,13 +28,13 @@ This will copy all of the SirTrevor block partials into `app/views/sir-trevor/bl
 
 # Handling image uploads
 
-We don't provide a default image uploader out of the box, because everyone will have different requirements. Until we provide a full example project, have a look at [this gist](https://gist.github.com/cjbell88/7091537) which allows uploads using CarrierWave and Fog (for S3). 
+We don't provide a default image uploader out of the box, because everyone will have different requirements. Until we provide a full example project, have a look at [this gist](https://gist.github.com/cjbell/7091537) which allows uploads using CarrierWave and Fog (for S3). 
 
 # Helper methods
 
 **`render_sir_trevor`**
 
-Parses the blocks JSON content, loops through each piece of block content and render the appropriate partial for the block. 
+Parses the blocks JSON content, loops through each piece of block content and render the appropriate partial for the block.
 
 **`render_sir_trevor_image`**
 
@@ -99,19 +44,13 @@ Returns the first available SirTrevor image from the supplied JSON.
 
 Returns an image tag from a SirTrevor Image block
 
-**`pluck_sir_trevor_type` (Private)**
+**`pluck_sir_trevor_type`**
 
 Get the first instance of a specified SirTrevor block type from the supplied JSON
 
-# Requirements
-
-- Rails 3.x  
-- jQuery
-- Underscore.js (bundled)
-
 # To do
 
-- Add tests 
+- Add tests
 
 # Licence
 

data/app/views/sir-trevor/blocks/_list_block.html.erb

@@ -0,0 +1,3 @@
+<div class="content-block ul-block">
+  <%= sir_trevor_markdown block[:text] %>
+</div>

data/app/views/sir-trevor/blocks/_quote_block.html.erb

@@ -1,4 +1,4 @@
 <div class="content-block quote-block">
-	<%= sir_trevor_markdown block["text"] %>
-	<%= "<cite class=\"quote\">&ndash; #{block["cite"]}</cite>".html_safe unless block["cite"].nil? %>
-</div>
+  <%= sir_trevor_markdown block[:text] %>
+  <%= content_tag(:cite, sanitize("&ndash; #{block[:cite]}", tags: %w{a}), class: "quote") unless block[:cite].nil? %>
+</div>

data/app/views/sir-trevor/blocks/_text_block.html.erb

@@ -1,3 +1,3 @@
 <div class="content-block text-block">
-	<%= sir_trevor_markdown block["text"] %>
-</div>
+  <%= sir_trevor_markdown block[:text] %>
+</div>

data/app/views/sir-trevor/blocks/_tweet_block.html.erb

@@ -1,6 +1,6 @@
 <div class="content-block tweet-block">
-  <%= link_to image_tag("//twitter.com/api/users/profile_image/#{ block['user']['screen_name'] }?size=bigger", :class => 'img'), "http://twitter.com/#{ block['user']['screen_name'] }" %>
-  <p><%= auto_link(block['text']).html_safe %></p>
-  <cite>From <%= link_to "@#{ block['user']['screen_name'] }", "http://twitter.com/#{ block['user']['screen_name'] }" %> on Twitter:</cite>
-  <time datetime="<%= block['created_at'] %>">(<%= link_to Time.parse(block['created_at']), "http://twitter.com/#{block['user']['screen_name']}/status/#{block['id_str']}" %>)</time>
+  <%= link_to image_tag("//twitter.com/api/users/profile_image/#{ block[:user][:screen_name] }?size=bigger", :class => 'img'), "http://twitter.com/#{ block[:user][:screen_name] }" %>
+  <p><%= sanitize Twitter::Autolink.auto_link(block[:text], url_entities: (block[:entities].values_at(:urls, :media).flatten.compact.uniq rescue nil)), tags: %w{a}, attributes: %w{href rel target} %></p>
+  <cite>From <%= link_to "@#{ block[:user][:screen_name] }", "http://twitter.com/#{ block[:user][:screen_name] }" %> on Twitter:</cite>
+  <time datetime="<%= block[:created_at] %>">(<%= link_to Time.parse(block[:created_at]), "http://twitter.com/#{block[:user][:screen_name]}/status/#{block[:id_str]}" %>)</time>
 </div>

data/app/views/sir-trevor/blocks/_video_block.html.erb

@@ -1,7 +1,7 @@
 <div class="content-block video-block">
-	<% if block['source'] == 'vimeo' %>
-	  <iframe src="//player.vimeo.com/video/<%= block['remote_id'] %>?title=1&amp;byline=1&amp;portrait=1&amp;autoplay=0" width="600" height="400" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>
-	<% elsif block['source'] == 'youtube' %>
-	  <iframe width="600" height="400" src="//www.youtube.com/embed/<%= block['remote_id'] %>" frameborder="0" allowfullscreen></iframe>
-	<% end %>
+  <% if block[:source] == 'vimeo' %>
+    <iframe src="//player.vimeo.com/video/<%= block[:remote_id] %>?title=1&amp;byline=1&amp;portrait=1&amp;autoplay=0" width="600" height="400" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowFullScreen></iframe>
+  <% elsif block[:source] == 'youtube' %>
+    <iframe width="600" height="400" src="//www.youtube.com/embed/<%= block[:remote_id] %>" frameborder="0" allowfullscreen></iframe>
+  <% end %>
 </div>

data/config/initializers/validators.rb

@@ -1,10 +1,12 @@
+require 'active_model/validator'
+
 class IsJsonValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
-    @json = JSON.parse(value)
+    @json = SirTrevor.parse_json(value)
     record.errors.add(attribute, "is empty") if @json.empty?
   rescue TypeError => e
     record.errors.add(attribute, "is not valid JSON: #{e.message}")
   rescue JSON::JSONError => e
     record.errors.add(attribute, "is not valid JSON: #{e.message}")
   end
-end
+end

data/lib/generators/sir_trevor/block/templates/_block.html.erb

@@ -1,3 +1,3 @@
 <div class="content-block -block">
-	<%= block.inspect %>
-</div>
+  <%= block.inspect %>
+</div>

data/lib/sir-trevor-rails.rb

@@ -2,7 +2,7 @@ require "active_support/dependencies"
 
 module SirTrevor
 
-	mattr_accessor :app_root
+  mattr_accessor :app_root
 
   module Helpers
     autoload :ViewHelper, 'sir-trevor/helpers/view_helper'
@@ -11,9 +11,13 @@ module SirTrevor
   end
 
   def self.setup
-  	yield self
+    yield self
+  end
+
+  def self.parse_json(json)
+    MultiJson.load(json, symbolize_keys: true)
   end
 
 end
 
-require "sir-trevor/engine"
+require "sir-trevor/engine"

data/lib/sir-trevor/helpers/form_builder.rb

@@ -4,8 +4,8 @@ module SirTrevor
       extend ActiveSupport::Concern
       
       def sir_trevor_text_area(method, options = {})
-        @template.send("sir_trevor_text_area", @object_name, method, objectify_options(options))
+        @template.send(:sir_trevor_text_area, @object_name, method, objectify_options(options))
       end
     end
   end
-end
+end

data/lib/sir-trevor/helpers/form_helper.rb

@@ -11,14 +11,20 @@ module SirTrevor
 
         options = { :language => I18n.locale.to_s }.merge(options)
         input_html = (options.delete(:input_html) || {})
-        input_html['class'] = "sir-trevor-area visuallyhidden"
+        input_html[:class] = "sir-trevor-area visuallyhidden"
         hash = input_html.stringify_keys
 
-        instance_tag = ActionView::Base::InstanceTag.new(object_name, method, self, options.delete(:object))
-        instance_tag.send(:add_default_name_and_id, hash)
-        
         output_buffer = ActiveSupport::SafeBuffer.new
-        output_buffer << instance_tag.to_text_area_tag(input_html)
+        # support both Rails 3 & 4
+	if defined? ActionView::Base::InstanceTag
+          instance_tag = ActionView::Base::InstanceTag.new(object_name, method, self, options.delete(:object))
+          instance_tag.send(:add_default_name_and_id, hash)
+          output_buffer << instance_tag.to_text_area_tag(input_html)
+	else
+	  instance_tag = ActionView::Helpers::Tags::TextArea.new(object_name, method, self, input_html)
+	  instance_tag.send(:add_default_name_and_id, hash)
+	  output_buffer << instance_tag.render
+	end
         
         output_buffer
 
@@ -26,4 +32,4 @@ module SirTrevor
 
     end
   end
-end
+end

data/lib/sir-trevor/helpers/view_helper.rb

@@ -3,77 +3,78 @@ module SirTrevor
     module ViewHelper
 
       extend ActiveSupport::Concern
-      include Twitter::Autolink
-  
-      def render_sir_trevor(json, image_type = 'large')
+      
+      def render_sir_trevor(json, image_type = :large)
         if hash = parse_sir_trevor(json)
-          hash.map { |object|
+          safe_join hash.map { |object|
             render_sir_trevor_block(object, image_type)
-          }.compact.join.html_safe
+          }.compact
         else
           ''
         end
       end
 
-      def render_sir_trevor_block(object, image_type = 'large')
-        view_name = "sir-trevor/blocks/#{object['type'].to_s.downcase}_block"
+      def render_sir_trevor_block(object, image_type = :large)
+        view_name = "sir-trevor/blocks/#{object[:type].to_s.downcase}_block"
 
         render(view_name,
-               :block => object['data'],
-               :image_type => image_type) if object.has_key?("data")
+               :block => object[:data],
+               :image_type => image_type) if object.has_key?(:data)
       end
 
-      def render_sir_trevor_image(json, image_type = "large")
-        image = pluck_sir_trevor_type(json, "image")
-    
-        unless image.nil? 
-          render(:partial => "sir-trevor/blocks/image_block", :locals => {:block => image['data'], :image_type => image_type, :protocol => request.protocol}) if image.has_key?("data")
+      def render_sir_trevor_image(json, image_type = :large)
+        image = pluck_sir_trevor_type(json, :image)
+
+        unless image.nil?
+          render(:partial => "sir-trevor/blocks/image_block",
+                 :locals => { :block => image[:data], :image_type => image_type,
+                              :protocol => request.protocol }) if image.has_key?(:data)
         end
       end
-      
-      def sir_trevor_image_tag(block, image_type) 
+
+      def sir_trevor_image_tag(block, image_type)
         # Does the image type exist on the block?
-        if(block['file'].present? && block['file'][image_type].present?)
-        
-          image = block['file'][image_type]
-        
-          image_url = image['url']
-          width = image['width'] if image['width'].present?
-          height = image['height'] if image['height'].present?
-          
+        if(block[:file].present? && block[:file][image_type].present?)
+
+          image = block[:file][image_type]
+
+          image_url = image[:url]
+          width = image[:width] if image[:width].present?
+          height = image[:height] if image[:height].present?
+
           options = {
             :class => "sir-trevor-image #{image_type}",
-            :alt => block['description'] 
+            :alt => block[:description]
           }
-          
+
           options.merge!({ :width => width }) unless width.nil?
           options.merge!({ :height => height }) unless height.nil?
-          
+
           image_tag(image_url, options) unless image_url.nil?
         end
       end
 
       def sir_trevor_markdown(text)
-        options = {:hard_wrap => true, :filter_html => true, :autolink => true, :no_intraemphasis => true, :fenced_code => true}
-        renderer = Redcarpet::Render::HTML.new(options)
-        markdown = Redcarpet::Markdown.new(CustomMarkdownFormatter)
+        renderer = CustomMarkdownFormatter.new(:hard_wrap => true, :filter_html => true,
+                                               :autolink => true, :no_intraemphasis => true,
+                                               :fenced_code => true)
+        markdown = Redcarpet::Markdown.new(renderer)
         markdown.render(text).html_safe
       end
 
       def parse_sir_trevor(json)
-        hash = JSON.parse(json)
-
-        return false unless hash.has_key?("data")
-        hash["data"]
+        hash = (json.is_a?(String) ? SirTrevor.parse_json(json) : json)
+        return false unless hash.has_key?(:data)
+        hash[:data]
       end
 
       private
         # Get's the first instance of a type from the specified JSON
-        def pluck_sir_trevor_type(json, type) 
-          hash = JSON.parse(json)
-          if hash.has_key?("data")
-            item = hash["data"].select { |item| item["type"] == type }
-            item.first
+        def pluck_sir_trevor_type(json, type)
+          hash = SirTrevor.parse_json(json)
+          if hash.has_key?(:data)
+            item = hash[:data].select { |item| item[:type] == type }
+            item.first[:text] if item.any?
           end
         end
     end
@@ -84,7 +85,7 @@ class CustomMarkdownFormatter < Redcarpet::Render::HTML
   def block_code(code, language)
     "<p>" << code << "</p>"
   end
-  
+
   def codespan(code)
     code
   end