sir_trevor_rails 0.5.0b1

data/lib/sir_trevor_rails/engine.rb

@@ -0,0 +1,34 @@
+module SirTrevorRails
+  class Engine < Rails::Engine
+
+    require 'redcarpet'
+
+    config.after_initialize do |app|
+      app.config.paths.add 'app/sir_trevor_blocks', eager_load: true
+    end
+
+    initializer "sir_trevor_rails.load_app_instance_data" do |app|
+      SirTrevorRails.setup do |config|
+        config.app_root = app.root
+      end
+    end
+
+    initializer "sir_trevor_rails.helpers" do
+      ActiveSupport.on_load :action_view do
+        ActionView::Base.send :include, SirTrevorRails::Helpers::ViewHelper
+      end
+    end
+
+    initializer "sir_trevor_rails.view_resolver" do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :append_view_path, SirTrevorRails::ViewResolver.new
+      end
+    end
+
+    initializer "sir_trevor_rails.has_sir_trevor_content" do
+      ActiveSupport.on_load :active_record do
+        ActiveRecord::Base.send :include, SirTrevorRails::HasSirTrevorContent
+      end
+    end
+  end
+end

data/lib/sir_trevor_rails/has_sir_trevor_content.rb

@@ -0,0 +1,27 @@
+require 'sir_trevor_rails/block_array'
+require 'sir_trevor_rails/block'
+
+module SirTrevorRails
+  module HasSirTrevorContent
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def sir_trevor_content(*attributes)
+        attributes.each do |attribute|
+          #next unless name.constantize.column_names.include? attribute.to_s
+          define_attribute_reader(attribute)
+        end
+      end
+
+      private
+      def define_attribute_reader(attribute)
+        define_method attribute do
+          content = read_attribute(attribute)
+          return SirTrevorRails::BlockArray.new if content.blank?
+          instance_variable_get("@#{attribute}") ||
+            instance_variable_set("@#{attribute}", SirTrevorRails::BlockArray.from_json(content, self))
+        end
+      end
+    end
+  end
+end

data/lib/sir_trevor_rails/helpers/view_helper.rb

@@ -0,0 +1,26 @@
+module SirTrevorRails
+  module Helpers
+    module ViewHelper
+      extend ActiveSupport::Concern
+
+      def sir_trevor_markdown(text)
+        Redcarpet::Render::HTML.new(hard_wrap: true, filter_html: true,
+                                    autolink: true, no_intraemphasis: true,
+                                    fenced_code: true)
+
+        markdown = Redcarpet::Markdown.new(CustomMarkdownFormatter)
+        markdown.render(text).html_safe
+      end
+    end
+  end
+end
+
+class CustomMarkdownFormatter < Redcarpet::Render::HTML
+  def block_code(code, language)
+    "<p>" << code << "</p>"
+  end
+
+  def codespan(code)
+    code
+  end
+end

data/lib/sir_trevor_rails/version.rb

@@ -0,0 +1,3 @@
+module SirTrevorRails
+  VERSION = "0.5.0b1"
+end

data/lib/sir_trevor_rails/view_resolver.rb

@@ -0,0 +1,13 @@
+module SirTrevorRails
+  class ViewResolver < ::ActionView::FileSystemResolver
+
+    def initialize
+      super("app/views")
+    end
+
+    def find_templates(name, prefix, partial, details)
+      super(name, prefix.gsub(/^(.)+(sir_trevor)/, '\2'), partial, details)
+    end
+
+  end
+end

data/lib/sir_trevor_rails.rb

@@ -0,0 +1,30 @@
+# Require things from Rails
+require 'rails/engine'
+require 'action_view'
+require 'action_view/template/resolver'
+
+require 'multi_json'
+
+require 'sir_trevor_rails/version'
+require 'sir_trevor_rails/engine'
+require 'sir_trevor_rails/has_sir_trevor_content'
+require 'sir_trevor_rails/view_resolver'
+
+module SirTrevorRails
+
+  mattr_accessor :app_root
+
+  module Helpers
+    autoload :ViewHelper, 'sir_trevor_rails/helpers/view_helper'
+  end
+
+  module Blocks
+    autoload :TweetBlock, 'sir_trevor_rails/blocks/tweet_block'
+    autoload :VideoBlock, 'sir_trevor_rails/blocks/video_block'
+  end
+
+  def self.setup
+    yield self
+  end
+
+end

data/sir_trevor_rails.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sir_trevor_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sir_trevor_rails"
+  spec.version       = SirTrevorRails::VERSION
+  spec.email         = ["andrew@madebymany.co.uk",
+                        "chris@madebymany.co.uk",
+                        "andy@madebymany.co.uk",
+                        "lukasz@madebymany.co.uk"]
+  spec.authors       = ["Andrew Sprinz",
+                        "Chris Bell",
+                        "Andrew Walker",
+                        "Lukasz Sagol"]
+  spec.summary       = %q{A ruby wrapper for sir trevor content}
+  spec.homepage      = "http://madebymany.github.io/sir-trevor-js/"
+  spec.license       = "MIT"
+  spec.homepage      = "https://github.com/madebymany/sir-trevor-rails"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.4"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.3"
+  spec.add_development_dependency "wrong"
+  spec.add_development_dependency "pry-rails"
+  spec.add_development_dependency "combustion"
+  spec.add_development_dependency "sqlite3"
+
+  spec.add_dependency "rails"
+  spec.add_dependency "redcarpet", ">= 2.0.1", "< 4"
+  spec.add_dependency "twitter-text", "~> 1.4"
+
+end

data/spec/internal/app/models/custom_block.rb

@@ -0,0 +1,5 @@
+class CustomBlock < SirTrevorRails::Block
+  def upcase_title
+    title.upcase
+  end
+end

data/spec/internal/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/spec/internal/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter:  sqlite3
+  database: db/combustion_test.sqlite

data/spec/internal/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  #
+end

data/spec/internal/db/schema.rb

@@ -0,0 +1,7 @@
+ActiveRecord::Schema.define do
+  create_table(:posts, force: true) do |t|
+    t.string :title
+    t.text :body
+    t.timestamps null: false
+  end
+end

data/spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'sir_trevor_rails'
+require 'combustion'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/pride'
+require 'wrong/adapters/minitest'
+require 'pry'
+
+Combustion.initialize! :active_record, :action_view
+
+Wrong.config.alias_assert :expect, override: true
+
+MiniTest::Spec.class_eval do
+  include Wrong::Assert
+  include Wrong::Helpers
+end

data/spec/unit/block_array_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module SirTrevorRails
+  describe BlockArray do
+    describe 'intialization' do
+      subject { BlockArray }
+      let(:text_block) { {type: 'text', data: {text: 'Lorem ipsum'}} }
+      let(:heading_block) { {type: 'heading', data: {text: 'Heading 1'}} }
+
+      it 'can be initialized with an empty JSON array' do
+        array = subject.from_json('[]')
+        expect { array.is_a? BlockArray }
+      end
+
+      it 'can be initialized with multiple block hashes' do
+        json = [text_block, heading_block].to_json
+        array = subject.from_json(json)
+
+        expect { array.is_a? BlockArray }
+        expect { array.size == 2 }
+      end
+    end
+
+    describe 'instance methods' do
+      let(:text_block) { {type: 'text', data: {text: 'First text block'}} }
+      let(:other_text_block) { {type: 'text', data: {text: 'Other text block'}} }
+      let(:image_block) { {type: 'image', data: {file: {url: 'http://example.com'}}} }
+      let(:heading_block) { {type: 'heading', data: {text: 'Heading 1'}} }
+      let(:json) { [image_block, text_block, heading_block, other_text_block].to_json }
+
+      subject { BlockArray.from_json(json) }
+
+      describe 'has_block_of_type?' do
+        it 'can be called with nonexistent block type' do
+          subject.has_block_of_type? :nonexistent
+        end
+
+        it 'returns true if block exists in the array' do
+          assert { subject.has_block_of_type?(:text) }
+        end
+
+        it 'returns false if block doesn\'t exist in the array' do
+          deny { subject.has_block_of_type?(:tweet) }
+        end
+      end
+
+      describe 'first_block_of_type' do
+        it 'returns first block of given type in the array' do
+          block = subject.first_block_of_type(:text)
+          assert { block.text == 'First text block' }
+        end
+
+        it 'returns nil if called with block type not in the array' do
+          assert { subject.first_block_of_type(:nonexistent).nil? }
+        end
+      end
+
+      describe 'to_a' do
+        it 'returns array with same number of elements' do
+          assert { subject.to_a.class == Array }
+          assert { subject.to_a.size == subject.size }
+        end
+      end
+    end
+  end
+end

data/spec/unit/block_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+module SirTrevorRails
+  describe Block do
+    describe '.block_class' do
+      subject { Block }
+
+      describe 'for known type' do
+        let(:klass) { subject.block_class('tweet') }
+
+        it 'returns class' do
+          expect { klass == Blocks::TweetBlock }
+        end
+
+        it 'returned class is the one defined in file' do
+          expect { klass.method_defined? :at_name }
+        end
+      end
+
+      describe 'for unknown type' do
+        let(:klass) { subject.block_class('unknown') }
+
+        it 'defines and returns class' do
+          expect { klass == Blocks::UnknownBlock }
+        end
+
+        it 'defines class that inherits from Block' do
+          expect { klass.superclass == Block }
+        end
+      end
+    end
+
+    describe '.from_hash' do
+      let(:source_hash) { { type: 'test', data: {} } }
+      let(:block) { Block.from_hash(source_hash, nil) }
+
+      it 'initializes new block based on type field' do
+        expect { block.is_a? Blocks::TestBlock }
+      end
+
+      it 'creates accessors for all fields defined in data field' do
+        source_hash[:data].merge!(width: '100')
+
+        expect { block.width == '100' }
+      end
+    end
+
+    describe 'JSON representation' do
+      let(:source_hash) { { type: 'test', data: {} } }
+      let(:block) { Block.from_hash(source_hash, nil) }
+
+      it 'returns source hash when #as_json is called' do
+        expect { block.as_json == source_hash }
+      end
+    end
+
+    describe 'partial view lookup' do
+      let(:source_hash) { { type: 'test', data: {} } }
+      let(:block) { Block.from_hash(source_hash, nil) }
+
+      it 'uses block type to find view paritals' do
+        expect { block.to_partial_path == 'sir_trevor/blocks/test_block' }
+      end
+    end
+  end
+end

data/spec/unit/custom_block_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+# The block that is being tested here is defined in
+# `spec/internal/app/models/custom_block.rb`, just like it would in real 
+# Rails app.
+
+describe CustomBlock do
+  describe "SirTrevorRails::Block" do
+    let(:custom_block_hash) { {type: 'custom', data: {text: 'Body', title: 'name'}} }
+
+    it 'initialises class defined in the file' do
+      block = SirTrevorRails::Block.from_hash(custom_block_hash, nil)
+
+      assert { block.is_a? CustomBlock }
+      assert { block.respond_to? :upcase_title }
+      assert { block.upcase_title == "NAME" }
+    end
+  end
+end

data/spec/unit/has_sir_trevor_content_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module SirTrevorRails
+  describe 'HasSirTrevorContent' do
+    describe 'initialized for body field' do
+      before do
+        Post.send(:include, HasSirTrevorContent)
+        Post.send(:sir_trevor_content, :body)
+      end
+
+      let(:post) { Post.new }
+      let(:text_block) { {type: 'text', data: {text: 'Lorem ipsum'}} }
+
+      it 'returns BlockArray for initialised field' do
+        assert { post.body.is_a? BlockArray }
+      end
+
+      it 'returns empty BlockArray if field is null' do
+        post.body = nil
+
+        assert { post.body.empty? }
+      end
+
+      it 'returns empty BlockArray if field is empty JSON array' do
+        post.body = [].to_json
+
+        assert { post.body.empty? }
+      end
+
+      it 'returns blocks if field is SirTrevor JSON' do
+        post.body = [text_block].to_json
+
+        assert { post.body.size == 1 }
+        assert { post.body.first.is_a? Block }
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,254 @@
+--- !ruby/object:Gem::Specification
+name: sir_trevor_rails
+version: !ruby/object:Gem::Version
+  version: 0.5.0b1
+platform: ruby
+authors:
+- Andrew Sprinz
+- Chris Bell
+- Andrew Walker
+- Lukasz Sagol
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: twitter-text
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- andrew@madebymany.co.uk
+- chris@madebymany.co.uk
+- andy@madebymany.co.uk
+- lukasz@madebymany.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/views/sir_trevor/_sir_trevor_block_array.html.erb
+- app/views/sir_trevor/blocks/_heading_block.html.erb
+- app/views/sir_trevor/blocks/_image_block.html.erb
+- app/views/sir_trevor/blocks/_list_block.html.erb
+- app/views/sir_trevor/blocks/_quote_block.html.erb
+- app/views/sir_trevor/blocks/_text_block.html.erb
+- app/views/sir_trevor/blocks/_tweet_block.html.erb
+- app/views/sir_trevor/blocks/videos/_vimeo.html.erb
+- app/views/sir_trevor/blocks/videos/_youtube.html.erb
+- config.ru
+- config/initializers/validators.rb
+- lib/generators/sir_trevor_rails/block/block_generator.rb
+- lib/generators/sir_trevor_rails/block/templates/_block.html.erb
+- lib/generators/sir_trevor_rails/block/templates/_block.js
+- lib/generators/sir_trevor_rails/block/templates/_block.rb
+- lib/generators/sir_trevor_rails/views/views_generator.rb
+- lib/sir_trevor_rails.rb
+- lib/sir_trevor_rails/block.rb
+- lib/sir_trevor_rails/block_array.rb
+- lib/sir_trevor_rails/blocks/tweet_block.rb
+- lib/sir_trevor_rails/blocks/video_block.rb
+- lib/sir_trevor_rails/engine.rb
+- lib/sir_trevor_rails/has_sir_trevor_content.rb
+- lib/sir_trevor_rails/helpers/view_helper.rb
+- lib/sir_trevor_rails/version.rb
+- lib/sir_trevor_rails/view_resolver.rb
+- sir_trevor_rails.gemspec
+- spec/internal/app/models/custom_block.rb
+- spec/internal/app/models/post.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+- spec/unit/block_array_spec.rb
+- spec/unit/block_spec.rb
+- spec/unit/custom_block_spec.rb
+- spec/unit/has_sir_trevor_content_spec.rb
+homepage: https://github.com/madebymany/sir-trevor-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A ruby wrapper for sir trevor content
+test_files:
+- spec/internal/app/models/custom_block.rb
+- spec/internal/app/models/post.rb
+- spec/internal/config/database.yml
+- spec/internal/config/routes.rb
+- spec/internal/db/schema.rb
+- spec/internal/log/.gitignore
+- spec/internal/public/favicon.ico
+- spec/spec_helper.rb
+- spec/unit/block_array_spec.rb
+- spec/unit/block_spec.rb
+- spec/unit/custom_block_spec.rb
+- spec/unit/has_sir_trevor_content_spec.rb
+has_rdoc: