sir_trevor_rails 0.5.0b1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0440542cac7ceda76800ef5d839ce166aea6a96
+  data.tar.gz: 63bfbecf7f48260f978fd284bf773ec1cc8287c2
+SHA512:
+  metadata.gz: 41c835b01d6f5fd0bf4540ba2a3c65d3fcf70c43de7586ab3048fae21025bd05045c70c4afca5a9671dbbfe3a774e8e9f7a97dd9c3b97ff1840d7bf281135a3f
+  data.tar.gz: 7621bdbeae052096553e9af079169a8f600aef8e8733acfdf02e0b3f91618455c8a44b3bcec27a0eb382fbb55fd52b1cfc0d32c9cd6e3f4d3cdf3c19821b9013

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.DS_Store
+Gemfile.lock
+spec/internal/db/combustion_test.sqlite

data/CHANGELOG

@@ -0,0 +1,13 @@
+v0.4.0:
+	date: 2014-05-20
+	changes:
+		- Renamed gem sir_trevor_rails (used to be sir-trevor-rails)
+		- Removed sir trevor JS and all its dependencies (should install files manually or from bower from now on)
+		- Removed all the view helpers appart from sir_trevor_markdown (render_sir_trevor, render_sir_trevor_block, render_sir_trevor_image, sir_trevor_image_tag, parse_sir_trevor are all gone)
+		- Removed the form helper (no more sir_trevor_text_area)
+		- Added has_sir_trevor_content.rb as a concern for models with ST content 
+		- Remove jQuery rails dependency
+		- Use view resolvers and to_partial_path to render ST content (instead of the view helper)
+		- Add block array class
+		- Add block classes
+		- Add lookup methods on the block array

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sir_trevor_rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-2014 by ITV plc - http://www.itv.com 
+
+MIT License
+
+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,126 @@
+# Sir Trevor Rails
+
+A Rails gem for integrating Sir Trevor JS into your Rails 3/4 application.
+
+## Upgrade guide from v0.4.0-rc.1
+
+Version 0.4.0 represents a major refactor and contains significant API changes.
+
+* The SirTrevor gem has been renamed from ``sir-trevor-rails`` to ``sir_trevor_rails`` you will need to update your Gemfile.
+* There are no more form helpers or view helpers so relace ``f.sir_trevor_text_area :content`` with ``f.text_area :content``.
+* SirTrevor JS and it's dependencies are no longer bundled with the gem and need to be downloaded and installed manually or with bower. [See the SirTrevor JS repo for more](https://github.com/madebymany/sir-trevor-js#plain-js).
+* In your model, register your SirTrevor content like this ``sir_trevor_content :content`` where ``:content`` is the name of the field on your where you store SirTrevor content.
+* In your views, you no longer need to use the ``render_sir_trevor`` helper. Instead, simply render your content like this ``<%= render @item.content %>``
+
+## Usage
+
+Add Sir Trevor to your Gemfile
+
+```ruby
+gem 'sir_trevor_rails'
+```
+
+```bash
+bundle install
+```
+
+Include Sir Trevor JS in your project following the instructions set out [here](http://madebymany.github.io/sir-trevor-js/docs.html)
+
+## Generators: Views
+
+Grab all of the default block type partials by running the following generator command:
+
+```bash
+rails g sir_trevor_rails:views
+```
+
+This will copy all of the SirTrevor block partials into `app/views/sir_trevor/blocks/`
+
+## Rendering
+
+In your models pass the attribute name of your Sir Trevor content to `sir_trevor_content`
+
+```ruby
+sir_trevor_content :content
+```
+
+In your view files, call render to display the Sir Trevor content
+
+```ruby
+<%= render @item.content %>
+```
+
+## Handling image uploads
+
+We don't provide a default image uploader out of the box, because everyone will have different requirements. To see an example of an image uploader, please refer to our Rails examples in the [Sir Trevor JS repository](https://github.com/madebymany/sir-trevor-js/tree/master/examples/rails/image-uploader).
+
+## Handling markdown
+
+Use the ``sir_trevor_markdown`` method in your custom block partials to correctly parse the markdown in a block
+
+## Querying the block content
+
+Use the following methods to query the Sir Trevor content
+
+```ruby
+@item.content.has_block_of_type?(:image)
+```
+
+Does this content have an image block?
+
+```ruby
+@item.content.first_block_of_type(:video)
+```
+
+Return the first video block in the content
+
+## Add custom methods for block content
+
+Create an initializer ``config/initializers/sir_trevor_rails.rb``
+
+Write your method in the initializer:
+
+```ruby
+class SirTrevorRails::BlockArray
+  def your_custom_method_here
+    # some code
+  end
+end
+```
+
+Call your method on the ST content
+
+```ruby
+@item.content.your_custom_method
+```
+
+## Generators: Blocks
+
+Run the blocks generator to create templates for your custom blocks
+
+```bash
+rails g sir_trevor_rails:block my_custom_block
+```
+
+This will generate an html file for rendering the block, a javascript file for the editor and a ruby block class.
+
+## Block Classes
+
+Ruby block classes can be used like decorators for the block content. See the [tweet block class](https://github.com/madebymany/sir-trevor-rails/blob/redesign-gem/lib/sir_trevor_rails/blocks/tweet_block.rb) for an example
+
+## Requirements
+
+
+- Rails 3.x/4.x
+
+## To do
+
+- Add tests
+
+## Licence
+
+Sir Trevor Rails is released under the [MIT Licence](MIT-LICENSE)
+
+## Changelog
+
+See the [CHANGELOG](CHANGELOG)

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/app/views/sir_trevor/_sir_trevor_block_array.html.erb

@@ -0,0 +1 @@
+<%= render sir_trevor_block_array.to_a %>

data/app/views/sir_trevor/blocks/_heading_block.html.erb

@@ -0,0 +1 @@
+<h2><%= heading_block.text %></h2>

data/app/views/sir_trevor/blocks/_image_block.html.erb

@@ -0,0 +1,5 @@
+<% if image_block.file && image_block.file[:url] -%>
+  <figure class="st__content-block st__content-block--image">
+    <%= image_tag image_block.file[:url] %>
+  </figure>
+<% end -%>

data/app/views/sir_trevor/blocks/_list_block.html.erb

@@ -0,0 +1,3 @@
+<div class="st__content-block st__content-block--list">
+	<%= sir_trevor_markdown list_block.text %>
+</div>

data/app/views/sir_trevor/blocks/_quote_block.html.erb

@@ -0,0 +1,13 @@
+<div class="st__content-block st__content-block--quote">
+  <div class="quote">
+    <div class="quote__content">
+    	<%= sir_trevor_markdown quote_block.text %>
+    </div>
+
+    <% if quote_block.cite.present? %>
+      <div class="quote__cite">
+        <cite class="quote__cite-text">&ndash; <%= quote_block.cite %></cite>
+      </div>
+    <% end %>
+  </div>
+</div>

data/app/views/sir_trevor/blocks/_text_block.html.erb

@@ -0,0 +1,3 @@
+<div class="st__content-block st__content-block--text">
+	<%= sir_trevor_markdown text_block.text %>
+</div>

data/app/views/sir_trevor/blocks/_tweet_block.html.erb

@@ -0,0 +1,9 @@
+<div class="st__content-block st__content-block--tweet">
+  <%= link_to image_tag(tweet_block.profile_image_url, class: 'img'), tweet_block.screen_name %>
+  <p>
+    <%= tweet_block.render_tweet_body %>
+  </p>
+  <cite>From <%= link_to tweet_block.at_name, tweet_block.screen_name %> on Twitter:</cite>
+  <time datetime="<%= tweet_block.created_at %>">(<%= link_to Time.parse(tweet_block.created_at), tweet_block.status_url %>)</time>
+</div>
+

data/app/views/sir_trevor/blocks/videos/_vimeo.html.erb

@@ -0,0 +1,4 @@
+<div class="st__content-block st__content-block--video">
+  <iframe src="//player.vimeo.com/video/<%= vimeo.remote_id %>?title=1&amp;byline=1&amp;portrait=1&amp;autoplay=0"
+          width="640" height="360" frameborder="0" allowfullscreen></iframe>
+</div>

data/app/views/sir_trevor/blocks/videos/_youtube.html.erb

@@ -0,0 +1,4 @@
+<div class="st__content-block st__content-block--video">
+  <iframe src="//www.youtube.com/embed/<%= youtube.remote_id %>?wmode=transparent"
+          width="640" height="360" frameborder="0" allowfullscreen></iframe>
+</div>

data/config/initializers/validators.rb

@@ -0,0 +1,12 @@
+require 'active_model/validator'
+
+class IsJsonValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    @json = MultiJson.load(value, symbolize_keys: true)
+    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

data/config.ru

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/lib/generators/sir_trevor_rails/block/block_generator.rb

@@ -0,0 +1,33 @@
+require 'rails/generators'
+
+module SirTrevorRails
+  module Generators
+    class BlockGenerator < Rails::Generators::NamedBase
+
+      def self.source_root
+        @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+      end
+
+      def create_block
+
+        # Copy the JS
+        copy_file "_block.js", "app/assets/javascripts/sir_trevor/blocks/#{name}.js"
+
+        gsub_file "app/assets/javascripts/sir_trevor/blocks/#{name}.js", /SirTrevor\.Blocks\.Example/, "SirTrevor.Blocks.#{name.capitalize}"
+        gsub_file "app/assets/javascripts/sir_trevor/blocks/#{name}.js", /return "Example"/, "return: '#{name.capitalize}'"
+        gsub_file "app/assets/javascripts/sir_trevor/blocks/#{name}.js", /type: 'example'/, "type: '#{name.downcase}'"
+
+        # Copy the HTML
+        copy_file "_block.html.erb", "app/views/sir_trevor/blocks/_#{name}_block.html.erb"
+        gsub_file "app/views/sir_trevor/blocks/_#{name}_block.html.erb", /\s(-block)/, " #{name}-block"
+        gsub_file "app/views/sir_trevor/blocks/_#{name}_block.html.erb", /\s(_block)/, " #{name}_block"
+
+        # Copy the BlockDecorator
+        copy_file "_block.rb", "app/sir_trevor_blocks/#{name}_block.rb"
+        gsub_file "app/sir_trevor_blocks/#{name}_block.rb", /ExampleBlock/, " #{name}Block"
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,3 @@
+<div class="content-block example-block">
+  <%= example_block %>
+</div>

data/lib/generators/sir_trevor_rails/block/templates/_block.js

@@ -0,0 +1,203 @@
+/*
+  An example of a SirTrevor.Block
+  --
+  Author: C J Bell @ madebymany
+*/
+
+SirTrevor.Blocks.Example = (function(){
+
+  return SirTrevor.Block.extend({
+
+    // String; Names the block
+    // Note – please use underscores when naming
+    // Eg example_block should be ExampleBlock
+    type: 'example',
+
+    // Function; the title displayed in the toolbar
+    // Can return a translated string (if required)
+    title: function() {
+      // return i18n.t('blocks:example:title');
+      return "Example";
+    },
+
+    // Boolean; show this blockType of the toolbar
+    toolbarEnabled: true,
+
+    // Block Mixins
+    // Allow different UI components / methods to be mixed into the block
+
+    // Enable drop functionality on the block
+    droppable: false,
+
+    // Enable paste functionality (to paste URLS etc)
+    pastable: false,
+
+    // Enable an upload button to be added
+    // Mixins Ajaxable automatically
+    // Exposes an uploader method
+    // Usage: this.uploader(file, success, failure)
+    uploadable: false,
+
+    // Enable queued remote fetching
+    // Exposes a small wrapper around the $.ajax method
+    // Usage: this.fetch(ajaxOptions, success, failure)
+    fetchable: false,
+
+    // Add an ajax queue to the block
+    // Added to uploadable & fetchable automatically
+    ajaxable: false,
+
+    // Overwritable mixin options:
+    // --
+    drop_options: {
+      // String; (can use underscore template tags)
+      // Defines the HTML for the dropzone template
+      html: "<div class='st-block__dropzone'></div>",
+      // Boolean;
+      // On re-order, should we re-render this item.
+      // Useful for when re-ordering iframes (like Twitter)
+      re_render_on_reorder: false
+    },
+
+    paste_options: {
+      // String; (can use underscore template tags)
+      // Defines the HTML for the paste template
+      html: "<input type=\"text\" class=\"st-paste-block\">"
+    },
+
+    upload_options: {
+      // String; (can use underscore template tags)
+      // Defines the HTML for the upload template
+      html: "<input type=\"file\" type=\"st-file-upload\">"
+    },
+
+    formattable: true,
+
+    // String or Function; The HTML for the inner portion of the editor block
+    // In this example, the editorHTML is an editable input div (like we use for a TextBlock)
+
+    // Classes:
+    // st-required   – indicates this input must be present to pass validation
+    // st-text-block – gives the block the ability to use the formatting controls
+
+    editorHTML: function() {
+      return "<div class='st-text-block' contenteditable='true'></div>";
+    },
+
+    // Element shorthands
+    // --
+    // this.$el
+    // this.el
+    // this.$inner                  (the inner container for the block)
+    // this.$editor                 (contains all the UI inputs for the block)
+    // this.$inputs                 (contains all the UI inputs for blocks that are uploadable / droppable / pastable)
+    // this.getTextBlock()          (shorthand for this.$el.find('.st-text-block'))
+    // this.$(selector)             (shorthand for this.$el.find(selector))
+
+    // Validations
+    // --
+    // Required fields (with .st-required class) always get validted
+    // Called using the validateField method
+    // Set a data-st-name="Field Name" on your required inputs to use it in the validation fail message
+
+    // Array; defines custom validator methods to call
+    validations: ['myCustomValidator'],
+
+    // Example custom validator
+    myCustomValidator: function() {
+      var field = this.$('.a-field');
+
+      if (field.val() === 'herp derp') {
+        this.setError(field, "A validation fail message");
+      }
+    },
+
+    // Function; Executed on render of the block if some data is provided.
+    // LoadData gives us a means to convert JSON data into the editor dom
+    // In this example we convert the text from markdown to HTML and show it inside the element
+    loadData: function(data){
+      this.getTextBlock().html(SirTrevor.toHTML(data.text, this.type));
+    },
+
+    // Function; Executed on save of the block, once the block is validated
+    // toData expects a way for the block to be transformed from inputs into structured data
+    // The default toData function provides a pretty comprehensive way of turning data into JSON
+    // In this example we take the text data and save it to the data object on the block
+    toData: function(){
+      var dataObj = {};
+
+      var content = this.getTextBlock().html();
+      if (content.length > 0) {
+        dataObj.text = SirTrevor.toMarkdown(content, this.type);
+      }
+
+      this.setData(dataObj);
+    },
+
+    // Function; Returns true or false whether there is data in the block
+    isEmpty: function() {
+      return _.isEmpty(this.saveAndGetData()); // Default implementation
+    },
+
+    // Other data functions
+    // --
+    // getData            – returns the data in the store
+    // save               - Invokes the toData method
+    // saveAndReturnData  - Saves and returns the entire store
+    // saveAndGetData     - Save and only return the data part of the store
+
+
+    // Function; Hook executed at the end of the block rendering method.
+    // Useful for initialising extra pieces of UI or binding extra events.
+    // In this example we add an extra button, just because.
+    onBlockRender: function() {
+      this.$editor.append($('<button>', {
+        click: function() {
+          alert('Yo dawg, you clicked my button');
+        }
+      }));
+    },
+
+    // Function; Optional hook method executed before the rendering of a block
+    // Beware, $el and any shorthand element variables won't be setup here.
+    beforeBlockRender: function() {},
+
+    // Function; Executed once content has been dropped onto the dropzone of this block
+    // Only required if you have enabled dropping and have provided a dropzone for this block
+    // Always is passed the ev.transferData object from the drop
+    // Please see the image block (https://github.com/madebymany/sir-trevor-js/blob/master/src/blocks/image.js) for an example
+    onDrop: function(transferData) {},
+
+    // Function; executed once content has been pasted into a pastable block
+    // See the tweet block as an example (https://github.com/madebymany/sir-trevor-js/blob/master/src/blocks/tweet.js)
+    onContentPasted: function(event) {},
+
+    // Block level messages
+    // --
+    // addMessage(msg, additionalClass)
+    // Adds a new message onto the block
+
+    // resetMessages()
+    // Clears all existing messages
+
+    // Helper methods
+    // --
+    // loading()
+    // ready()
+    // hasTextBlock()
+    // remove()
+
+    // Function; Any extra markdown parsing can be defined in here.
+    // Returns; String (Required)
+    toMarkdown: function(markdown) {
+      return markdown.replace(/^(.+)$/mg,"> $1");
+    },
+
+    // Function; Any extra HTML parsing can be defined in here.
+    // Returns; String (Required)
+    toHTML: function(html) {
+      return html;
+    }
+  });
+
+})();

data/lib/generators/sir_trevor_rails/block/templates/_block.rb

@@ -0,0 +1,2 @@
+class ExampleBlock < SirTrevorRails::Block
+end

data/lib/generators/sir_trevor_rails/views/views_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module SirTrevorRails
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+
+      def self.source_root
+        @source_root ||= SirTrevorRails::Engine.root
+      end
+
+      def views
+        directory "app/views/sir_trevor"
+      end
+
+    end
+  end
+end

data/lib/sir_trevor_rails/block.rb

@@ -0,0 +1,63 @@
+require 'ostruct'
+
+module SirTrevorRails
+  class Block < OpenStruct
+
+    def self.from_hash(hash, parent)
+      hash = hash.deep_dup
+      self.type_klass(hash).new(hash, parent)
+    end
+
+    def initialize(hash, parent)
+      @as_json = hash
+      @parent  = parent
+      @type    = hash[:type].to_sym
+
+      super(hash[:data])
+    end
+
+    attr_reader :parent, :type, :as_json
+
+    def to_partial_path
+      "sir_trevor/blocks/" << self.class.name.demodulize.underscore
+    end
+
+    private
+
+    # Infers the block class.
+    # Safe lookup that tries to identify user created block class.
+    #
+    # @param [Symbol] type
+    def self.block_class(type)
+      block_name = "#{type.to_s.camelize}Block"
+      begin
+        block_name.constantize
+      rescue NameError
+        block_class!(block_name)
+      end
+    end
+
+    # Infers the block class.
+    # Failover from block_class.
+    # Safe lookup against the SirTevor::Blocks namespace
+    # If no block is found, create one with given name and inherit from Block class
+    #
+    # @param [Constant] block_name
+    def self.block_class!(block_name)
+      begin
+        SirTrevorRails::Blocks.const_get(block_name)
+      rescue NameError
+        SirTrevorRails::Blocks.const_set(block_name, Class.new(Block))
+      end
+    end
+
+    def self.type_klass(hash)
+      if self == Block
+        block_class(hash[:type].to_sym)
+      else
+        self
+      end
+    end
+
+  end
+end

data/lib/sir_trevor_rails/block_array.rb

@@ -0,0 +1,21 @@
+module SirTrevorRails
+  class BlockArray < Array
+
+    def self.from_json(str, parent = nil)
+      blocks = MultiJson.load(str, symbolize_keys: true)
+      blocks = blocks[:data] if blocks.is_a?(Hash)
+      blocks.map! { |block_obj| SirTrevorRails::Block.from_hash(block_obj, parent) }
+      new blocks
+    end
+
+    def has_block_of_type?(type)
+      klass = Block.block_class(type)
+      any? { |b| b.is_a? klass }
+    end
+
+    def first_block_of_type(type)
+      klass = Block.block_class(type)
+      detect { |b| b.is_a? klass }
+    end
+  end
+end

data/lib/sir_trevor_rails/blocks/tweet_block.rb

@@ -0,0 +1,35 @@
+require 'twitter-text'
+
+module SirTrevorRails
+  module Blocks
+    class TweetBlock < SirTrevorRails::Block
+
+      include ActionView::Helpers::SanitizeHelper
+
+      def render_tweet_body
+        sanitize Twitter::Autolink.auto_link(
+              self.text,
+              url_entities: (self.entities.values_at(:urls, :media).flatten.compact.uniq rescue nil)
+            ), tags: %w{a span}, attributes: %w{class href rel target}
+      end
+
+      def profile_url
+        "//twitter.com/" << self.user[:screen_name]
+      end
+
+      def screen_name
+        self.user[:screen_name]
+      end
+
+      def at_name
+        "@" << screen_name
+      end
+
+      def profile_image_url(size="bigger")
+        "//twitter.com/api/users/profile_image/" << self.user[:screen_name] <<
+          "?size=" << size
+      end
+
+    end
+  end
+end

data/lib/sir_trevor_rails/blocks/video_block.rb

@@ -0,0 +1,9 @@
+module SirTrevorRails
+  module Blocks
+    class VideoBlock < SirTrevorRails::Block
+      def to_partial_path
+        "sir_trevor/blocks/videos/" << self.source
+      end
+    end
+  end
+end