client_pages 0.0.2.alpha → 0.0.3.beta

data/spec/integration/client_pages_spec.rb

@@ -0,0 +1,274 @@
+require 'spec_helper'
+
+module ClientPages
+  describe 'MarkdownContent' do
+    subject { ClientPages::MarkdownContent::Renderer }
+
+    describe 'invalid path' do
+      before { ClientPages.config { |c| c.content_path = 'not_there' } }
+      it { expect(subject.render_content(:bar)).to eql('No such file or directory - bar') }
+    end
+
+    describe 'valid path' do
+      before { ClientPages.config { |c| c.content_path = 'spec/fixtures/foo' } }
+      it { expect(subject.render_content(:bar)).to eql("<h1>foo</h1>\n\n<p>bar</p>") }
+    end
+
+    it 'blends' do
+      expect(
+        subject.render_content(:test_content) do |c|
+          c.modify :h1, with: { class: 'mycss_class', 'data-foo' => 'bar' }, if: ->(m) { m.includes?('Content') }
+          c.modify :a, with: { class: 'fancy', title: 'woah' }, if: { href: 'http://somewhere.com' }
+          c.wrap :h1, :div, with: { id: 'my-id', class: 'foo' }
+          c.replace :p, :span, with: { class: 'bar', 'data-p' => 'no-more' }
+        end
+      ).to eql(
+        "<div id=\"my-id\" class=\"foo\"><h1 class=\"mycss_class\" data-foo=\"bar\">Content from "\
+        "<a href=\"http://somewhere.com\" class=\"fancy\" title=\"woah\">somewhere</a></h1></div>\n\n"\
+        "<span class=\"bar\" data-p=\"no-more\">Lorem do <em>incididunt</em> ut labore</span>\n\n"\
+        "<span class=\"bar\" data-p=\"no-more\">Pariatur: "\
+        "<a href=\"/bar.com\" title=\"baz\">Foo</a> culpa</span>\n"
+      )
+    end
+
+    describe 'Renderer' do
+      let(:markdown) { fixture('test_content') }
+
+      before do
+        ClientPages.config do |c|
+          c.remote = true
+          c.caching = false
+          c.remote_content_path = 'http://somewhere.com'
+        end
+        stub_request(:get, 'http://somewhere.com/test_content.md')
+          .to_return(body: markdown, status: 200)
+      end
+
+      context 'without a block' do
+        let(:rendered_content) { subject.render_content(:test_content) }
+
+        it 'renders HTML content for given markdown file from somewhere' do
+          expect(rendered_content).to include('<h1>Content from <a href="http://somewhere.com">somewhere</a></h1>')
+        end
+
+        describe 'raw markdown' do
+          before do
+            ClientPages.config { |c| c.raw_markdown = true }
+          end
+
+          it 'renders HTML content for given markdown' do
+            expect(subject.render_content('# *raw* markdown')).to eql('<h1><em>raw</em> markdown</h1>')
+          end
+        end
+      end
+
+      context 'with a block' do
+        let(:link_list) { fixture('link_list') }
+        let(:text_list) { fixture('text_list') }
+        before do
+          stub_request(:get, 'http://somewhere.com/link_list.md').to_return(body: link_list, status: 200)
+          stub_request(:get, 'http://somewhere.com/text_list.md').to_return(body: text_list, status: 200)
+        end
+
+        it 'returns a content builder' do
+          expect(
+            subject.render_content(:test_content) { |c| c }
+          ).to be_kind_of(MarkdownContent::ContentBuilder)
+        end
+
+        it 'modifies tags and html attributes' do
+          expect(
+            subject.render_content(:test_content) do |c|
+              c.modify :h1, with: { class: 'mycss_class', 'data-foo' => 'bar' }
+              c.modify :a, with: { class: 'fancy', title: 'woah' }
+            end
+          ).to include(
+            '<h1 class="mycss_class" data-foo="bar">'\
+              'Content from <a href="http://somewhere.com" class="fancy" title="woah">somewhere</a>'\
+            '</h1>'
+          )
+        end
+
+        it 'adds attributes conditionally' do
+          expect(
+            subject.render_content(:test_content) do |c|
+              c.modify :h1, with: { class: 'add_me cool' }, if: true
+              c.modify :a, with: { class: 'add_me_not' }, if: false
+            end
+          ).to include(
+            '<h1 class="add_me cool">Content from <a href="http://somewhere.com">somewhere</a></h1>'
+          )
+        end
+
+        it 'adds any attribute conditionally and selective' do
+          expect(
+            subject.render_content(:link_list) do |c|
+              c.modify :li, with: { class: 'yay' }, if: ->(m) { m.match_any?(:href, '/link1') }
+              c.modify :a, with: { class: 'active' }, if: { href: '/link2' }
+              c.modify :a, with: { class: 'important', 'data-foo' => 'bar' }, if: { title: 'i haz title' }
+            end
+          ).to include(
+            "<li class=\"yay\"><a href=\"/link1\">link1</a></li>\n"\
+            "<li><a href=\"/link2\" class=\"active\">link2</a></li>\n"\
+            "<li><a href=\"/link3\" title=\"i haz title\" class=\"important\" data-foo=\"bar\">link3</a></li>"
+          )
+        end
+
+        it 'wraps multiple tags with container' do
+          expect(
+            subject.render_content(:text_list) do |c|
+              c.wrap :ul, :div, with: { class: 'wrapper foo' }
+              c.wrap :em, :span, with: { class: 'special' }, if: ->(m) { m.includes?('Bar') }
+            end
+          ).to eql(
+            "<div class=\"wrapper foo\"><ul>\n"\
+              "<li>Foo <span class=\"special\"><em>Bar</em></span></li>\n"\
+              "<li>Baz</li>\n"\
+            "</ul></div>\n"
+          )
+        end
+
+        it 'wraps and modifies tags' do
+          expect(
+            subject.render_content(:text_list) do |c|
+              c.wrap :ul, :div, with: { class: 'container' }
+              c.modify :em, with: { style: 'color: #c0ffee' }
+            end
+          ).to eql(
+            "<div class=\"container\"><ul>\n"\
+              "<li>Foo <em style=\"color: #c0ffee\">Bar</em></li>\n"\
+              "<li>Baz</li>\n"\
+            "</ul></div>\n"
+          )
+        end
+
+        it 'replaces tags and adds class' do
+          expect(
+            subject.render_content(:test_content) do |c|
+              c.replace :p, :div, with: { class: 'byebye' }
+              c.replace :em, :span, with: { id: 'i-am', class: 'cool', 'data-u' => 'r-not' }
+            end
+          ).to eql(
+            "<h1>Content from <a href=\"http://somewhere.com\">somewhere</a></h1>\n\n"\
+            "<div class=\"byebye\">"\
+              "Lorem do <span id=\"i-am\" class=\"cool\" data-u=\"r-not\">incididunt</span> ut labore"\
+            "</div>\n\n"\
+            "<div class=\"byebye\">Pariatur: <a href=\"/bar.com\" title=\"baz\">Foo</a> culpa</div>\n"
+          )
+        end
+
+        it 'wraps and replaces conditionally' do
+          expect(
+            subject.render_content(:test_content) do |c|
+              c.wrap :a, :span, with: { class: 'btn' }, if: { href: 'http://somewhere.com' }
+              c.replace :p, :div, if: ->(m) { m.includes?('Lorem') }
+              c.replace :em, :span, with: { class: 'replaced' }, if: ->(m) { m.includes?('incididunt') }
+            end
+          ).to eql(
+            "<h1>Content from <span class=\"btn\"><a href=\"http://somewhere.com\">somewhere</a></span></h1>\n\n"\
+            "<div>Lorem do <span class=\"replaced\">incididunt</span> ut labore</div>\n\n"\
+            "<p>Pariatur: <a href=\"/bar.com\" title=\"baz\">Foo</a> culpa</p>\n"
+          )
+        end
+      end
+
+      describe 'with caching' do
+        before(:each) { ClientPages.cache.clear }
+        after { ClientPages.config { |c| c.caching = false } }
+
+        context 'enabled' do
+          before do
+            ClientPages.config do |c|
+              c.caching = true
+              c.remote = true
+              c.remote_content_path = 'http://c.ly'
+            end
+          end
+
+          it 'populates cache when empty' do
+            request = stub_request(:get, /\/caching.md/).to_return(body: '**cache me**')
+            expect { subject.render_content(:caching) }
+              .to change { ClientPages.cache }
+              .to eql('http://c.ly/caching.md' => '**cache me**')
+            expect(request).to have_been_made.times(1)
+          end
+
+          it 'makes request only once' do
+            request = stub_request(:get, /\/caching.md/).to_return(body: '**cache me**')
+            5.times { subject.render_content(:caching) }
+            expect { subject.render_content(:caching) }.to_not change { ClientPages.cache }
+            expect(request).to have_been_made.times(1)
+          end
+        end
+
+        context 'disabled' do
+          before do
+            ClientPages.config do |c|
+              c.caching = false
+              c.remote = true
+              c.remote_content_path = 'http://c.ly'
+            end
+          end
+
+          it 'will not cache' do
+            stub_request(:get, /\/no_caching.md/).to_return(body: '_u_no_cache_me_')
+            subject.render_content(:no_caching)
+            expect(ClientPages.cache).to be_empty
+          end
+
+          it 'makes a request per render_content call' do
+            request = stub_request(:get, /\/no_caching.md/).to_return(body: '_u_no_cache_me_')
+            5.times { subject.render_content(:no_caching) }
+            expect(request).to have_been_made.times(5)
+          end
+        end
+      end
+
+      describe 'default templates' do
+        before do
+          ClientPages.templates do |t|
+            t.set(:basic) do |c|
+              c.modify :h1, with: { class: 'headers' }
+              c.wrap :a, :span, with: { class: 'links' }, if: ->(m) { m.includes?('somewhere') }
+              c.replace :p, :div
+            end
+          end
+        end
+
+        it 'uses templates and accepts additional block' do
+          expect(
+            subject.render_content(:test_content, template: :basic) do |c|
+              c.modify :h1, with: { 'data-foo' => 'bar' }
+            end
+          ).to eql(
+            "<h1 class=\"headers\" data-foo=\"bar\">Content from <span class=\"links\">"\
+            "<a href=\"http://somewhere.com\">somewhere</a></span></h1>\n\n"\
+            "<div>Lorem do <em>incididunt</em> ut labore</div>\n\n<div>Pariatur: "\
+            "<a href=\"/bar.com\" title=\"baz\">Foo</a> culpa</div>\n"
+          )
+        end
+      end
+    end
+
+    describe 'configuration' do
+      subject { ClientPages }
+      before { subject.configuration = nil }
+
+      it 'is configurable with a block' do
+        expect {
+          subject.config do |c|
+            c.content_path = 'somewhere'
+            c.render_options = { foo: 'bar' }
+            c.markdown_extensions = { bam: true }
+          end
+        }.to change {
+          subject.config.to_hash
+        }.to eql(
+          content_path: 'somewhere',
+          render_options: { foo: 'bar' },
+          markdown_extensions: { bam: true }
+        )
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'client_pages'
 
 require 'webmock/rspec'
+require 'open-uri'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -22,9 +23,31 @@ RSpec.configure do |config|
   config.mock_with :rspec do |c|
     c.syntax = :expect
   end
+
+  config.before(:each) do
+    ClientPages.config do |c|
+      c.remote = false
+      c.caching = false
+      c.content_path = 'spec/fixtures/content'
+      c.remote_content_path = nil
+      c.raw_markdown = false
+      c.render_options = {
+        hard_wrap: true,
+        with_toc_data: false
+      }
+      c.markdown_extensions = {
+        tables: true,
+        autolink: true,
+        lax_spacing: true,
+        space_after_headers: true,
+        underline: false,
+        no_intra_emphasis: true
+      }
+    end
+  end
 end
 
 # helper for markdown fixture files
 def fixture(name)
-  File.open(File.expand_path("spec/fixtures/#{name}.md"), 'r')
+  open("#{ClientPages.config.content_path}/#{name}.md").read
 end

data/spec/unit/configuration_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+module ClientPages
+  describe Configuration do
+
+    it 'has default config' do
+      config = {
+        content_path: 'content',
+        render_options: {},
+        markdown_extensions: {}
+      }
+      expect(subject.to_hash).to eql(config)
+    end
+
+    it 'is configurable' do
+      config = {
+        content_path: 'somewhere',
+        render_options: { foo: 'bar' },
+        markdown_extensions: { bam: true }
+      }
+      expect {
+        subject.content_path = 'somewhere'
+        subject.render_options = { foo: 'bar' }
+        subject.markdown_extensions = { bam: true }
+      }.to change {
+        subject.to_hash
+      }.to eql(config)
+    end
+
+    describe 'overwritable config' do
+      before do
+        subject.render_options = { opt1: true }
+        subject.markdown_extensions = { ext1: true }
+      end
+
+      it 'overwrites config and keeps untouched config settings' do
+        config = {
+          content_path: 'here',
+          render_options: { opt1: false, opt2: true },
+          markdown_extensions: { ext1: true, ext2: false }
+        }
+        expect {
+          subject.content_path = 'here'
+          subject.render_options = { opt1: false, opt2: true }
+          subject.markdown_extensions = { ext2: false }
+        }.to change {
+          subject.to_hash
+        }.to eql(config)
+      end
+    end
+  end
+end

data/spec/unit/content_builder_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+module ClientPages
+  module MarkdownContent
+    describe ContentBuilder do
+    end
+  end
+end

data/spec/unit/matcher_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+module ClientPages
+  describe Matcher do
+    subject { described_class.new(:span, '<span>foo</span>') }
+    it { expect(subject.tag).to eql(:span) }
+    it { expect(subject.line).to eql('<span>foo</span>') }
+    it { expect(subject.includes?('foo')).to be_true }
+    it { expect(subject.match?(nil, 'foo')).to be_false }
+  end
+end

data/spec/unit/renderer_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+
+module ClientPages
+  module MarkdownContent
+    describe Renderer do
+    end
+  end
+end

data/spec/unit/template_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+module ClientPages
+  describe 'Template' do
+    let(:templates) { {} }
+
+    before do
+      expect(ClientPages).to receive(:template) { templates }
+      Template.new.set(:foo) { |args| 'foobar' + args }
+    end
+
+    it 'saves a referenceable block with arguments' do
+      expect(templates[:foo].call('bam')).to eql('foobarbam')
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: client_pages
 version: !ruby/object:Gem::Version
-  version: 0.0.2.alpha
+  version: 0.0.3.beta
 platform: ruby
 authors:
 - Marco Schaden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-01 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -108,6 +108,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.18.1
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -133,18 +147,30 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - client_pages.gemspec
 - lib/client_pages.rb
+- lib/client_pages/configuration.rb
+- lib/client_pages/markdown_content/content_builder.rb
+- lib/client_pages/markdown_content/renderer.rb
+- lib/client_pages/matcher.rb
+- lib/client_pages/template.rb
 - lib/client_pages/version.rb
-- spec/fixtures/link_list.md
-- spec/fixtures/test_content.md
-- spec/fixtures/text_list.md
+- spec/fixtures/content/link_list.md
+- spec/fixtures/content/test_content.md
+- spec/fixtures/content/text_list.md
+- spec/fixtures/foo/bar.md
+- spec/integration/client_pages_spec.rb
 - spec/spec_helper.rb
-- spec/unit/client_pages_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/content_builder_spec.rb
+- spec/unit/matcher_spec.rb
+- spec/unit/renderer_spec.rb
+- spec/unit/template_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -171,9 +197,15 @@ specification_version: 4
 summary: With client_pages you can separate your content from html markup and css
   styles
 test_files:
-- spec/fixtures/link_list.md
-- spec/fixtures/test_content.md
-- spec/fixtures/text_list.md
+- spec/fixtures/content/link_list.md
+- spec/fixtures/content/test_content.md
+- spec/fixtures/content/text_list.md
+- spec/fixtures/foo/bar.md
+- spec/integration/client_pages_spec.rb
 - spec/spec_helper.rb
-- spec/unit/client_pages_spec.rb
+- spec/unit/configuration_spec.rb
+- spec/unit/content_builder_spec.rb
+- spec/unit/matcher_spec.rb
+- spec/unit/renderer_spec.rb
+- spec/unit/template_spec.rb
 has_rdoc: