showcase 0.1.7 → 0.2.0.beta

data/lib/showcase/traits/share.rb

@@ -0,0 +1,61 @@
+require 'showcase/helpers/config_object'
+require 'active_support/core_ext/object/to_query'
+
+module Showcase
+  module Traits
+    module Share
+      extend ActiveSupport::Concern
+      include LinkTo
+
+      PROVIDERS = {
+        twitter: {
+          url: "https://twitter.com/intent/tweet",
+          params: { url: :url, text: :text },
+          label: 'Tweet it!'
+        },
+        gplus: {
+          url: "https://plus.google.com/share",
+          params: { url: :url },
+          label: 'Share it on Google Plus!'
+        },
+        facebook: {
+          url: "http://www.facebook.com/sharer/sharer.php",
+          params: { u: :url },
+          label: 'Share it on Facebook!'
+        },
+        linkedin: {
+          url: "http://www.linkedin.com/shareArticle",
+          params: { url: :url, title: :text },
+          label: 'Share it on LinkedIn!'
+        },
+        pinterest: {
+          url: "http://www.pinterest.com/pin/create/button/",
+          params: { url: :url, media: :image_url, title: :text },
+          label: 'Pin it!'
+        }
+      }
+
+      module ClassMethods
+        def share(name = nil, &block)
+          PROVIDERS.each do |social, settings|
+            link_name = [ name, social, "share" ].map(&:presence).compact.join("_")
+
+            link_to link_name do |c|
+              meta = Helpers::ConfigObject.new(self, &block).to_struct
+              params = Hash[
+                settings[:params].map do |param, meta_key|
+                  [ param, meta.send(meta_key) ]
+                end
+              ]
+              c.url "#{settings[:url]}?#{params.to_query}"
+              c.label settings[:label]
+              c.html_options = { target: :blank }
+            end
+          end
+        end
+      end
+
+    end
+  end
+end
+

data/lib/showcase/traits.rb

@@ -0,0 +1,11 @@
+require 'showcase/traits/base'
+require 'showcase/traits/record'
+require 'showcase/traits/seo'
+require 'showcase/traits/link_to'
+require 'showcase/traits/share'
+
+module Showcase
+  module Traits
+  end
+end
+

data/lib/showcase/version.rb

@@ -1,4 +1,4 @@
 module Showcase
-  VERSION = "0.1.7"
+  VERSION = "0.2.0.beta"
 end
 

data/lib/showcase.rb

@@ -1,5 +1,7 @@
 require 'showcase/version'
 require 'showcase/presenter'
+require 'showcase/railtie' if defined?(Rails)
 
 module Showcase
 end
+

data/showcase.gemspec

@@ -18,7 +18,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
 
   gem.add_dependency 'activesupport'
+
   gem.add_development_dependency 'rspec'
   gem.add_development_dependency 'coveralls'
+  gem.add_development_dependency 'rails'
+  gem.add_development_dependency 'rspec-html-matchers'
 end
 

data/spec/fixtures.rb

@@ -1,3 +1,19 @@
+class RailsViewContext < ActionView::Base
+  include ActionView::Helpers::TagHelper
+
+  def capture(*args, &block)
+    block.call(*args)
+  end
+end
+
+class Model
+  extend ActiveModel::Naming
+
+  def to_key
+    Array('1')
+  end
+end
+
 class Person < Struct.new(:name)
 end
 

data/spec/helpers/config_object_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+module Showcase::Helpers
+  describe ConfigObject do
+
+    let(:context_class) {
+      Class.new do
+        def foo
+          'foo'
+        end
+
+        def bar
+          'bar'
+        end
+      end
+    }
+    let(:context) { context_class.new }
+
+    describe 'to_hash' do
+      it 'accepts attr=() notation' do
+        result = ConfigObject.new(context) do |c|
+          c.first = foo
+          c.second = bar
+          c.third = '3rd'
+        end.to_hash
+
+        hash = { first: 'foo', second: 'bar', third: '3rd' }
+        expect(result).to eq hash
+      end
+
+      it 'accepts attr() notation' do
+        result = ConfigObject.new(context) do |c|
+          c.first foo
+          c.second bar
+          c.third '3rd'
+        end.to_hash
+
+        hash = { first: 'foo', second: 'bar', third: '3rd' }
+        expect(result).to eq hash
+      end
+    end
+
+  end
+end
+

data/spec/helpers/seo_meta_builder_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+module Showcase::Helpers
+  describe SeoMetaBuilder do
+
+    let(:view) { RailsViewContext.new }
+    let(:builder) { double('SeoMetaBuilder') }
+
+    subject { SeoMetaBuilder.new(view) }
+
+    describe '#title' do
+      it 'produces a <title/> tag' do
+        expect(subject.title('foo')).to have_tag(:title, text: 'foo')
+      end
+
+      it 'produces a og:title meta tag' do
+        expect(subject.title('foo')).to have_tag(:meta, with: { property: 'og:title', content: 'foo' })
+      end
+
+      it 'produces a twitter:title meta tag' do
+        expect(subject.title('foo')).to have_tag(:meta, with: { name: 'twitter:title', content: 'foo' })
+      end
+
+      context 'with multiple values' do
+        it 'uses the first non-blank' do
+          expect(subject.title(['', nil, 'foo'])).to have_tag(:title, text: 'foo')
+        end
+      end
+
+      context 'with a :title_suffix option' do
+        it 'produces a <title/> tag with the suffix' do
+          expect(subject.title('foo', title_suffix: ' - bar')).to have_tag(:title, text: 'foo - bar')
+        end
+        it 'does not suffix meta tags' do
+          expect(subject.title('foo')).to have_tag(:meta, with: { property: 'og:title', content: 'foo' })
+          expect(subject.title('foo')).to have_tag(:meta, with: { name: 'twitter:title', content: 'foo' })
+        end
+      end
+    end
+
+    describe '#description' do
+      it 'produces a description meta tag' do
+        expect(subject.description('foo')).to have_tag(:meta, with: { name: 'description', content: 'foo' })
+      end
+
+      it 'produces a og:description meta tag' do
+        expect(subject.description('foo')).to have_tag(:meta, with: { property: 'og:description', content: 'foo' })
+      end
+
+      it 'produces a twitter:description meta tag' do
+        expect(subject.description('foo')).to have_tag(:meta, with: { name: 'twitter:description', content: 'foo' })
+      end
+
+      context 'with multiple values' do
+        it 'uses the first non-blank' do
+          expect(subject.description(['', nil, 'foo'])).to have_tag(:meta, with: { name: 'description', content: 'foo' })
+        end
+      end
+    end
+
+    describe '#image_url' do
+      it 'produces a og:image meta tag' do
+        expect(subject.image_url('foo')).to have_tag(:meta, with: { property: 'og:image', content: 'foo' })
+      end
+
+      it 'produces a twitter:image meta tag' do
+        expect(subject.image_url('foo')).to have_tag(:meta, with: { name: 'twitter:image', content: 'foo' })
+      end
+
+      context 'with multiple values' do
+        it 'uses the first non-blank' do
+          expect(subject.image_url(['', nil, 'foo'])).to have_tag(:meta, with: { property: 'og:image', content: 'foo' })
+        end
+      end
+    end
+
+    describe '#canonical_url' do
+      it 'produces a og:url meta tag' do
+        expect(subject.canonical_url('foo')).to have_tag(:meta, with: { property: 'og:url', content: 'foo' })
+      end
+
+      it 'produces a canonical link tag' do
+        expect(subject.canonical_url('foo')).to have_tag(:link, with: { rel: 'canonical', href: 'foo' })
+      end
+
+      context 'with multiple values' do
+        it 'uses the first non-blank' do
+          expect(subject.canonical_url(['', nil, 'foo'])).to have_tag(:meta, with: { property: 'og:url', content: 'foo' })
+        end
+      end
+    end
+
+  end
+end
+

data/spec/helpers_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Showcase::Helpers do
+  let(:object) { Person.new('Steve Ballmer') }
+  let(:context) { Context.new }
+
+  describe '.present' do
+    it 'instanciate a new presenter, inferring the class' do
+      PersonPresenter.stub(:new).with(object, context).and_return 'Presenter'
+      context.present(object, PersonPresenter).should == 'Presenter'
+    end
+    it 'the presenter class to use can be specified as the second parameter' do
+      ProjectPresenter.stub(:new).with(object, context).and_return 'Presenter'
+      context.present(object, ProjectPresenter).should == 'Presenter'
+    end
+    it 'the context to use can be specified as third parameter' do
+      different_context = double
+      context.present(object, ProjectPresenter, different_context).view_context.should == different_context
+    end
+  end
+
+  describe '.present_collection' do
+    it 'returns a presenter for each object in the collection' do
+      collection = [ Person.new('Mark'), Person.new('Luke') ]
+
+      PersonPresenter.stub(:new).with(collection[0], context).and_return 'foo'
+      PersonPresenter.stub(:new).with(collection[1], context).and_return 'bar'
+
+      presented_collection = context.present_collection(collection)
+      presented_collection.should == [ 'foo', 'bar' ]
+    end
+  end
+end
+

data/spec/{showcase_spec.rb → presenter_spec.rb}

@@ -1,8 +1,4 @@
-require 'coveralls'
-Coveralls.wear!
-
-require 'showcase'
-require_relative './fixtures'
+require 'spec_helper'
 
 describe Showcase::Presenter do
   let(:context) { Context.new }
@@ -73,35 +69,3 @@ describe Showcase::Presenter do
   end
 end
 
-describe Showcase::Helpers do
-  let(:object) { Person.new('Steve Ballmer') }
-  let(:context) { Context.new }
-
-  describe '.present' do
-    it 'instanciate a new presenter, inferring the class' do
-      PersonPresenter.stub(:new).with(object, context).and_return 'Presenter'
-      context.present(object, PersonPresenter).should == 'Presenter'
-    end
-    it 'the presenter class to use can be specified as the second parameter' do
-      ProjectPresenter.stub(:new).with(object, context).and_return 'Presenter'
-      context.present(object, ProjectPresenter).should == 'Presenter'
-    end
-    it 'the context to use can be specified as third parameter' do
-      different_context = double
-      context.present(object, ProjectPresenter, different_context).view_context.should == different_context
-    end
-  end
-
-  describe '.present_collection' do
-    it 'returns a presenter for each object in the collection' do
-      collection = [ Person.new('Mark'), Person.new('Luke') ]
-
-      PersonPresenter.stub(:new).with(collection[0], context).and_return 'foo'
-      PersonPresenter.stub(:new).with(collection[1], context).and_return 'bar'
-
-      presented_collection = context.present_collection(collection)
-      presented_collection.should == [ 'foo', 'bar' ]
-    end
-  end
-end
-

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'rspec-html-matchers'
+
+require 'rails'
+require 'showcase'
+require 'active_model'
+require 'action_view'
+
+require_relative './fixtures'
+

data/spec/traits/base_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+module Showcase::Traits
+  describe Base do
+    describe '.define_method?' do
+
+      it 'defines an instance method' do
+        klass = Class.new do
+          include Base
+          define_method? :foo do
+            true
+          end
+        end
+
+        expect(klass.new.foo).to be_true
+      end
+
+      context 'if the method is already present' do
+        it 'no-ops ' do
+          klass = Class.new do
+            include Base
+            def foo; false; end
+          end
+
+          expect(klass.new.foo).to be_false
+        end
+      end
+
+      context 'if method name is an array of chunks' do
+        it 'joins them in snake case' do
+          klass = Class.new do
+            include Base
+            define_method? [:foo, :bar] do
+              true
+            end
+          end
+
+          expect(klass.new.foo_bar).to be_true
+        end
+
+        it 'ignores blank chunks' do
+          klass = Class.new do
+            include Base
+            define_method? ["", :bar] do
+              true
+            end
+          end
+
+          expect(klass.new.bar).to be_true
+        end
+      end
+
+    end
+  end
+end
+

data/spec/traits/link_to_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+module Showcase::Traits
+  describe LinkTo do
+
+    let(:view) { RailsViewContext.new }
+    let(:record) { Model.new }
+    subject { presenter.new(record, view) }
+
+    let(:active) { false }
+    before do
+      record.stub(:active).and_return(active)
+    end
+
+    let(:presenter) {
+      Class.new(Showcase::Presenter) do
+        include LinkTo
+
+        link_to do |c|
+          c.url = url
+          c.label = 'Label'
+          c.active = active
+          c.html_options role: 'label'
+        end
+
+        link_to :foo do |c|
+          c.url = '#foo'
+          c.active_class = 'current'
+          c.active = active
+        end
+
+        def url
+          '#bar'
+        end
+      end
+    }
+
+    describe '#link_to' do
+
+      context 'defines a link method' do
+        it 'pointing to the specified url' do
+          expect(subject.link).to have_tag(:a, with: { href: '#bar' })
+        end
+
+        it 'with the specified label' do
+          expect(subject.link).to have_tag(:a, text: 'Label')
+        end
+
+        it 'with the specified html attributes' do
+          expect(subject.link).to have_tag(:a, with: { role: 'label' })
+        end
+
+        context 'with a different label as parameter' do
+          it 'uses it' do
+            expect(subject.link('Foo')).to have_tag(:a, text: 'Foo')
+          end
+        end
+
+        context 'with additional options' do
+          it 'uses them as html options' do
+          end
+        end
+
+        context 'with a block' do
+          it 'uses it instead of the label' do
+            result = subject.link { 'Foo' }
+            expect(result).to have_tag(:a, text: 'Foo')
+          end
+        end
+
+        context 'if active' do
+          let(:active) { true }
+
+          it 'adds an active class to the link' do
+            expect(subject.link('label')).to have_tag(:a, with: { class: 'active' })
+          end
+
+          context 'with additional classes' do
+            it 'it sums them' do
+              expect(subject.link('label', class: 'extra')).to have_tag(:a, with: { class: 'extra active' })
+            end
+          end
+
+          context 'if a different CSS class was specified' do
+            it 'adds it to the link' do
+              expect(subject.foo_link('label')).to have_tag(:a, with: { class: 'current' })
+            end
+          end
+        end
+      end
+
+      context 'defines an link_active? method' do
+        let(:active) { double }
+
+        it 'returns the active flag' do
+          expect(subject.link_active?).to eq active
+        end
+      end
+
+      context 'defines an url method' do
+        it 'returns the url' do
+          expect(subject.url).to eq '#bar'
+        end
+      end
+
+      context 'with prefix' do
+        it 'prefixes link method' do
+          expect(subject).to respond_to :foo_link
+        end
+
+        it 'prefixes link_active? method' do
+          expect(subject).to respond_to :foo_link_active?
+        end
+
+        it 'prefixes url method' do
+          expect(subject).to respond_to :foo_url
+        end
+      end
+    end
+
+  end
+end
+

data/spec/traits/record_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+module Showcase::Traits
+  describe Record do
+
+    let(:view) { RailsViewContext.new }
+    let(:record) { Model.new }
+    let(:presenter) {
+      Class.new(Showcase::Presenter) do
+        include Record
+
+        box do |c|
+          c.html_options role: 'actor', class: 'first'
+        end
+      end
+    }
+    subject { presenter.new(record, view) }
+
+    describe '#dom_id' do
+      it 'returns a CSS ID for the model' do
+        expect(subject.dom_id).to eq 'model_1'
+      end
+    end
+
+    describe '#dom_class' do
+      it 'returns a CSS class for model' do
+        expect(subject.dom_class).to eq 'model'
+      end
+    end
+
+    describe '#box' do
+      it 'wraps content inside an element that uniquely identifies the record' do
+        result = subject.box { "foo" }
+        expect(result).to have_tag(:div, with: { class: 'model', id: 'model_1' })
+      end
+
+      it 'adds attributes specified within box block' do
+        result = subject.box { "foo" }
+        expect(result).to have_tag(:div, with: { role: 'actor', class: 'first' })
+      end
+
+      context 'with a specified tag' do
+        it 'uses it' do
+          result = subject.box(:span) { "foo" }
+          expect(result).to have_tag(:span)
+        end
+      end
+
+      context 'with some class' do
+        it 'uses it' do
+          result = subject.box(class: 'bar') { "foo" }
+          expect(result).to have_tag(:div, with: { class: 'model bar'})
+        end
+      end
+    end
+
+  end
+end
+

data/spec/traits/seo_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+module Showcase::Traits
+  describe Seo do
+
+    let(:view) { RailsViewContext.new }
+    let(:record) { Model.new }
+    let(:builder) { double('SeoMetaBuilder') }
+    subject { presenter.new(record, view) }
+
+    let(:presenter) {
+      Class.new(Showcase::Presenter) do
+        include Seo
+
+        seo do |c|
+          c.title = 'foo'
+          c.description 'bar'
+        end
+      end
+    }
+
+    describe '#seo' do
+      let(:options) { double('options') }
+      before do
+        Showcase::Helpers::SeoMetaBuilder.stub(:new).with(view).and_return(builder)
+        builder.stub(:title).with('foo', options).and_return('<title>')
+        builder.stub(:description).with('bar', options).and_return('<description>')
+      end
+
+      it 'defines a seo_tags method that ouputs seo meta tags' do
+        expect(subject.seo_tags(options)).to eq '<title><description>'
+      end
+    end
+
+  end
+end
+

data/spec/traits/share_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+module Showcase::Traits
+  describe Share do
+
+    let(:view) { RailsViewContext.new }
+    let(:record) { Model.new }
+    subject { presenter.new(record, view) }
+
+    let(:presenter) {
+      Class.new(Showcase::Presenter) do
+        include Share
+
+        share do |c|
+          c.url = 'url'
+          c.text = 'text'
+          c.image_url = 'image'
+        end
+
+        share :foo do |c|
+          c.url = 'url'
+          c.text = 'text'
+          c.image_url = 'image'
+        end
+
+      end
+    }
+
+    describe '#social_share' do
+      expected_urls = {
+        twitter: "https://twitter.com/intent/tweet?text=text&url=url",
+        facebook: "http://www.facebook.com/sharer/sharer.php?u=url",
+        gplus: "https://plus.google.com/share?url=url",
+        pinterest: "http://www.pinterest.com/pin/create/button/?media=image&title=text&url=url",
+        linkedin: "http://www.linkedin.com/shareArticle?title=text&url=url",
+      }
+
+      expected_urls.each do |provider, url|
+        it "produces a #{provider} share link" do
+          expect(subject.send("#{provider}_share_link")).to have_tag(:a)
+        end
+        it "produces a #{provider} share url" do
+          expect(subject.send("#{provider}_share_url")).to eq url
+        end
+
+        context 'with prefix' do
+          it 'prefixes link method' do
+            expect(subject).to respond_to "foo_#{provider}_share_link"
+          end
+
+          it 'prefixes link_active? method' do
+            expect(subject).to respond_to "foo_#{provider}_share_url"
+          end
+        end
+      end
+    end
+
+  end
+end
+