excalibur 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b949e8ce1e9848ef126f58c9250c16ed82f862f8
-  data.tar.gz: 221b7b12fafb7bc6c74edc91315630b0a3891944
+  metadata.gz: 4e73905a05488d0f31f7bee41eef8755cfd72010
+  data.tar.gz: 9d8eb4c51d7996a0faff11fcc93977773b83257e
 SHA512:
-  metadata.gz: e41843c3cb31b43956310993bb536692b56f1002bef3b43a1731b4708b7018da08187d7f3ca562ab87802cd15599bed8e82332fa81d803c1e2e3fc58d834a1eb
-  data.tar.gz: f3c106e9a5ea7a1828b0c4229d25967cfd52d485052ff93c021ca20dd860a2577bd9fb42fc6b0aeffdef95c7283804e3bb425e5330105f5ba8127c128ba1f89e
+  metadata.gz: 631f7546330c3bbefeafb82e8ccf2cd0cc6b7c89b990c6f5c60bcdcb967ea3f9865adcf320bbb5dc9a13d689ed9a04ebdcaa8a9ace15dfd4c951e9946c65ab3c
+  data.tar.gz: 9d81f8a6b01e62e92dfe7a982696e7193bfb4655785521ff8173b61e4d2245dd4bb506103791266490f4d5517174ca244360e6f6922be4d1c1f4c0eaff3a2f6b

data/README.md

@@ -1,14 +1,26 @@
 # Excalibur
 
+[![Gem Version](https://badge.fury.io/rb/excalibur.svg)](http://badge.fury.io/rb/excalibur)
 [![Build Status](https://travis-ci.org/yopefonic/excalibur.svg)](https://travis-ci.org/yopefonic/excalibur)
 [![Code Climate](https://codeclimate.com/github/yopefonic/excalibur/badges/gpa.svg)](https://codeclimate.com/github/yopefonic/excalibur)
 
-Excalibur is a SEO gem for [Ruby on Rails](rubyonrails.org) and helps you to
-set the title and meta tags for you site overall and per page. Unlike other
-options like [meta-tags](https://github.com/kpumuk/meta-tags) and
-[meta_magic](https://github.com/lassebunk/metamagic) Excalibur focusses on
-providing an object based DSL to turn the objects you are presenting on the
-page into SEO related tags in the head.
+Excalibur is a SEO related gem for [Ruby on Rails](rubyonrails.org) that helps
+you to set the title and meta tags for your site overall and per page in a
+nicely structured and with separated concerns.
+
+Setting titles and meta tags for pages can become a hassle when dealing with
+more complex SEO requirements. When adding [OpenGraph](http://ogp.me/),
+[Twitter Cards](https://dev.twitter.com/cards/overview) or
+[schema.org](http://schema.org/docs/gs.html) for Google+ there are a host of
+options that differ from object to object. You could add methods to the object
+model to create these meta tags but that would put rendering concerns into
+model's class. Not an ideal situation. Other option could be to create helper
+methods but as you need to present more than 3 different object they can
+become cluttered, long and unyielding.
+
+In comes Excalibur; object presentors that have all the logic per object type,
+convenient helper methods to print them on the page and an application wide
+default configuration.
 
 ## Installation
 
@@ -78,6 +90,24 @@ context.
 entitle @your_object, config: @custom_config
 ```
 
+### Views without an object
+
+In some cases you might not have an object to present. Like when on a
+collection page or when dealing with a static page. There is a helper method
+that allows you to set some custom values. ```quick_set``` takes a couple of
+arguments to set the values of titles, descriptions and meta_tags.
+
+These are some examples of what you can set:
+
+```erb
+<%
+  quick_set :title, :content, :body, 'custom quick set title body'
+  quick_set :description, :option, :length, 42
+  quick_set :title, :combinator, proc { |obj| custom_code }
+  quick_set :meta_tag, :name, :description, 'custom quick set meta tag'
+%>
+```
+
 ### Decorators
 
 The decorators are what turns your object into data that can be used for the

data/excalibur.gemspec

@@ -8,8 +8,12 @@ Gem::Specification.new do |spec|
   spec.version       = Excalibur::VERSION
   spec.authors       = ['Joost Elfering']
   spec.email         = ['yopefonic@gmail.com']
-  spec.summary       = %q{helper gem to set page title and meta tags in a rails app}
-  spec.description   = %q{helper gem for rails apps to set the title and meta tags for a page. The helper can take custom input per page, objects that use decorator to determine the tags or an application wide configurable default.}
+  spec.summary       = %q{helper gem to set page title and meta tags in a
+                        rails app}
+  spec.description   = %q{Excalibur is a SEO related gem for Ruby on Rails
+                        that helps you to set the title and meta tags for your
+                        site overall and per page in a nicely structured and
+                        with separated concerns.}
   spec.homepage      = 'https://github.com/yopefonic/excalibur'
   spec.license       = 'MIT'
 

data/lib/excalibur/decorator.rb

@@ -21,6 +21,10 @@ module Excalibur
         @configuration ||= ::Excalibur.configuration.dup
       end
 
+      # methods:
+      # excalibur_set_title_content, excalibur_set_title_option,
+      # excalibur_set_title_combinator, excalibur_set_description_content,
+      # excalibur_set_description_option, excalibur_set_description_combinator
       def method_missing(meth, *args)
         if meth.to_s =~ /^excalibur_set_(title|description+)_(content|option|combinator+)$/
           configuration.send($1).send("update_#{$2}", *args)
@@ -48,8 +52,18 @@ module Excalibur
       configuration.merge!(config)
     end
 
-    def render_title(obj = self)
-      configuration.title.to_s(obj) if configuration.title.present?
+    # methods: render_title, render_description
+    def method_missing(meth, *args)
+      if meth.to_s =~ /^render_(title|description+)$/
+        obj = args.first || self
+        subject = configuration.send($1)
+
+        if subject.present?
+          subject.to_s(obj)
+        end
+      else
+        super
+      end
     end
   end
 end

data/lib/excalibur/version.rb

@@ -1,4 +1,4 @@
 # setting version number for the Excalibur gem
 module Excalibur
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/lib/excalibur/view_helpers.rb

@@ -6,6 +6,19 @@ module Excalibur
       @excalibur_subject = excalibur_decorate_subject(object, options)
     end
 
+    def quick_set(type, *args)
+      case type
+        when :title, :description
+          section = args.shift
+          excalibur_subject.configuration.send(type).send(
+              "update_#{section}",
+              *args
+          )
+        when :meta_tag
+          excalibur_subject.configuration.set_meta_tag(*args)
+      end
+    end
+
     def render_title_tag
       content_tag :title, excalibur_subject.render_title
     end
@@ -24,7 +37,7 @@ module Excalibur
                 :meta,
                 type_name => type_value,
                 content: content
-            )
+            ) unless content.nil?
           end
         end
       end

data/lib/excalibur.rb

@@ -80,9 +80,7 @@ module Excalibur
     def new_default_meta_tags
       ::HashWithIndifferentAccess.new(
           name: ::HashWithIndifferentAccess.new(
-              description: proc do |obj|
-                obj.configuration.description.to_s(obj)
-              end,
+              description: proc { |obj| obj.render_description },
               viewport: 'width=device-width, initial-scale=1'
           )
       )

data/lib/generators/templates/decorator.rb

@@ -71,5 +71,6 @@ class Excalibur::<%= class_name %>Decorator < Excalibur::Decorator
   # responsibility. The decorator becomes easier to test and it is also a lot
   # cleaner.
   #
-  # TODO: An article about how to do it properly will come soon!
+  # read more about how to use decorators with procs properly:
+  # https://github.com/yopefonic/excalibur/wiki/Advised-usage-of-proc%27s
 end

data/spec/lib/excalibur/decorator_spec.rb

@@ -220,5 +220,19 @@ module Excalibur
         end
       end
     end
+
+    describe '#render_description' do
+      let(:obj) { DummyDecorator.decorate(Dummy.new) }
+
+      context 'when using the default settings' do
+        it { expect(obj.render_description).to eq('Excalibur; a worthy title for a gem about titles.') }
+
+        it 'should call to_s in the title' do
+          expect(obj.configuration.description).to receive(:to_s)
+
+          obj.render_description
+        end
+      end
+    end
   end
 end

data/spec/lib/excalibur/view_helper_spec.rb

@@ -31,6 +31,42 @@ module Excalibur
       end
     end
 
+    describe '#quick_set' do
+      it 'should be able to set a meta tag' do
+        expect_any_instance_of(Configuration).to receive(:set_meta_tag).with(:name, :description, 'quick set value')
+
+        helpers.quick_set(:meta_tag, :name, :description, 'quick set value')
+
+        expect(helpers.instance_variable_get(:@excalibur_subject)).to be_instance_of Decorator
+      end
+
+      [:title, :description].each do |type|
+        it "should be able to set #{type} content" do
+          expect_any_instance_of(TruncateableContent).to receive(:update_content).with(:body, 'quick set value')
+
+          helpers.quick_set(type, :content, :body, 'quick set value')
+
+          expect(helpers.instance_variable_get(:@excalibur_subject)).to be_instance_of Decorator
+        end
+
+        it "should be able to set #{type} options" do
+          expect_any_instance_of(TruncateableContent).to receive(:update_option).with(:length, 42)
+
+          helpers.quick_set(type, :option, :length, 42)
+
+          expect(helpers.instance_variable_get(:@excalibur_subject)).to be_instance_of Decorator
+        end
+
+        it "should be able to set #{type} combinator" do
+          expect_any_instance_of(TruncateableContent).to receive(:update_combinator).with('foobar')
+
+          helpers.quick_set(type, :combinator, 'foobar')
+
+          expect(helpers.instance_variable_get(:@excalibur_subject)).to be_instance_of Decorator
+        end
+      end
+    end
+
     describe '#render_title_tag' do
       context 'when the configuration is standard' do
         it 'should return a title tag with the default content' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: excalibur
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Joost Elfering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -152,9 +152,11 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.10.1
-description: helper gem for rails apps to set the title and meta tags for a page.
-  The helper can take custom input per page, objects that use decorator to determine
-  the tags or an application wide configurable default.
+description: |-
+  Excalibur is a SEO related gem for Ruby on Rails
+                          that helps you to set the title and meta tags for your
+                          site overall and per page in a nicely structured and
+                          with separated concerns.
 email:
 - yopefonic@gmail.com
 executables: []