bourgeois 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c11f36f9736527cc188110608030455134cddba8
+  data.tar.gz: 4c7538b7646ba25cb9bd2507471f3a7c245e25a1
+SHA512:
+  metadata.gz: 0a5733b31c578036c402e2faf15f80c1c8d3e25e3c97d1974cddd525e86024f0e39b32fd05f779113973b0b235a83e7be38ab38d4a3431c9ca65b0dcab07d7c9
+  data.tar.gz: 47ccaa03c683e442c3c43e23ae0d7bf8aa2024d67db9cdc016fca205e41fa1707cbf0c5a50731cb7190f9b49fa6d83e27d6719df0edf7bc72fc3c7f1aad68827

data/README.md

@@ -1,10 +1,18 @@
-# Bourgeois
-
-[![Gem Version](https://badge.fury.io/rb/bourgeois.png)](https://rubygems.org/gems/bourgeois)
-[![Code Climate](https://codeclimate.com/github/mirego/bourgeois.png)](https://codeclimate.com/github/mirego/bourgeois)
-[![Build Status](https://travis-ci.org/mirego/bourgeois.png?branch=master)](https://travis-ci.org/mirego/bourgeois)
-
-Bourgeois is a Ruby library that makes using presenters a very simple thing.
+<p align="center">
+  <a href="https://github.com/mirego/bourgeois">
+    <img src="http://i.imgur.com/Z8ja8Wz.png" alt="Bourgeois" />
+  </a>
+  <br />
+  Bourgeois is a Ruby library that makes using presenters a very simple thing.
+  <br /><br />
+  <a href="https://rubygems.org/gems/bourgeois"><img src="https://badge.fury.io/rb/bourgeois.png" /></a>
+  <a href="https://codeclimate.com/github/mirego/bourgeois"><img src="https://codeclimate.com/github/mirego/bourgeois.png" /></a>
+  <a href='https://coveralls.io/r/mirego/bourgeois?branch=master'><img src='https://coveralls.io/repos/mirego/bourgeois/badge.png?branch=master' /></a>
+  <a href='https://gemnasium.com/mirego/bourgeois'><img src="https://gemnasium.com/mirego/bourgeois.png" /></a>
+  <a href="https://travis-ci.org/mirego/bourgeois"><img src="https://travis-ci.org/mirego/bourgeois.png?branch=master" /></a>
+</p>
+
+---
 
 ## Installation
 
@@ -55,6 +63,31 @@ class UserPresenter < Bourgeois::Presenter
 end
 ```
 
+### Custom block helpers
+
+You can use the simple `helper` DSL to define block helpers that will be executed if certain
+conditions are matched.
+
+```ruby
+class UserPresenter < Bourgeois::Presenter
+  helper :with_profile, if: -> { profile.present? && profile.public? }
+end
+
+User.first.new = Profile.create(public: true, title: 'Foo', description: 'Bar')
+```
+
+```erb
+<% present User.first do |user| %>
+  <h1><%= user.full_name %></h1>
+  <% user.with_profile do %>
+    <div class="profile">
+      <h2><%= user.profile.title %></h2>
+      <%= simple_format(user.profile.description) %>
+    </div>
+  <% end %>
+<% end %>
+```
+
 ## Inspiration
 
 Bourgeois was inspired by some code [@rafBM](https://twitter.com/rafBM) wrote for [his OpenCode talk](https://github.com/rafBM/opencode12-rails) on May 28th, 2013.

data/bourgeois.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 2.13'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'coveralls'
 end

data/lib/bourgeois/presenter.rb

@@ -26,6 +26,34 @@ module Bourgeois
       klass.human_attribute_name(*args)
     end
 
+    # Declare a new block helper method
+    #
+    # @example
+    #   class UserPresenter < Bourgeois::Presenter
+    #     helper :with_profile, if: -> { profile.present? }
+    #   end
+    #
+    #   presenter = UserPresenter.new(User.new(profile: 'Foo'))
+    #   presenter.with_profile do
+    #     puts 'User has a profile:'
+    #     puts presenter.profile
+    #   end
+    def self.helper(name, opts = {})
+      define_method(name) do |&block|
+        execute = true
+
+        if opts[:if]
+          execute = execute && self.instance_exec(&opts[:if])
+        end
+
+        if opts[:unless]
+          execute = execute && !self.instance_exec(&opts[:unless])
+        end
+
+        block.call if execute
+      end
+    end
+
   private
 
     # Return the view from where the presenter was created

data/lib/bourgeois/version.rb

@@ -1,3 +1,3 @@
 module Bourgeois
-  VERSION = "0.1.2"
+  VERSION = '0.1.3'
 end

data/spec/bourgeois/presenter_spec.rb

@@ -101,6 +101,132 @@ describe Bourgeois::Presenter do
   end
 
   describe :ClassMethods do
+    describe :helper do
+      before do
+        class UserPresenter < Bourgeois::Presenter
+          # We need a method to test that our block is executed
+          attr_reader :foo
+        end
+      end
+
+      let(:call_it!) do
+        presenter.send(helper) do
+          presenter.foo
+        end
+      end
+
+      context 'with helper using only a if condition' do
+        before do
+          class UserPresenter
+            helper :with_profile, if: -> { profile.present? }
+          end
+        end
+
+        context 'with matching if condition' do
+          let(:user) { User.new profile: 'Je suis Patrick.' }
+          let(:helper) { :with_profile }
+
+          specify do
+            presenter.should_receive(:foo).once
+            call_it!
+          end
+        end
+
+        context 'with non-matching if condition' do
+          let(:user) { User.new profile: nil }
+          let(:helper) { :with_profile }
+
+          specify do
+            presenter.should_receive(:foo).never
+            call_it!
+          end
+        end
+      end
+
+      context 'with helper using only an unless condition' do
+        let(:helper) { :without_name }
+        before do
+          class UserPresenter
+            helper :without_name, unless: -> { full_name.present? }
+          end
+        end
+
+        context 'with matching unless condition' do
+          let(:user) { User.new full_name: nil }
+
+          specify do
+            presenter.should_receive(:foo).once
+            call_it!
+          end
+        end
+
+        context 'with non-matching unless condition' do
+          let(:user) { User.new full_name: 'Patrick Bourgeois' }
+
+          specify do
+            presenter.should_receive(:foo).never
+            call_it!
+          end
+        end
+      end
+
+      context 'with helper without if nor unless' do
+        let(:user) { User.new }
+        let(:helper) { :with_something }
+        before do
+          class UserPresenter
+            helper :with_something
+          end
+        end
+
+        specify do
+          presenter.should_receive(:foo).once
+          call_it!
+        end
+      end
+
+      context 'with helper using both matching and unless conditions' do
+        let(:helper) { :sometimes }
+        before do
+          class UserPresenter
+            helper :sometimes, if: -> { profile.present? }, unless: -> { full_name.present? }
+          end
+        end
+
+        context 'with matching if and non-matching unless condition' do
+          let(:user) { User.new(profile: true, full_name: 'Patrick Bourgeois') }
+          specify do
+            presenter.should_receive(:foo).never
+            call_it!
+          end
+        end
+
+        context 'with non-matching if and non-matching unless condition' do
+          let(:user) { User.new(profile: false, full_name: 'Patrick Bourgeois') }
+          specify do
+            presenter.should_receive(:foo).never
+            call_it!
+          end
+        end
+
+        context 'with matching if and matching unless condition' do
+          let(:user) { User.new(profile: true, full_name: nil) }
+          specify do
+            presenter.should_receive(:foo).once
+            call_it!
+          end
+        end
+
+        context 'with non-matching if and matching unless condition' do
+          let(:user) { User.new(profile: false, full_name: 'Patrick Bourgeois') }
+          specify do
+            presenter.should_receive(:foo).never
+            call_it!
+          end
+        end
+      end
+    end
+
     describe :kind_of? do
       before do
         class UserPresenter < Bourgeois::Presenter; end

data/spec/spec_helper.rb

@@ -1,5 +1,8 @@
 $:.unshift File.expand_path('../../lib', __FILE__)
 
+require 'coveralls'
+Coveralls.wear!
+
 require 'ostruct'
 require 'rspec'
 require 'bourgeois'

metadata

@@ -1,52 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: bourgeois
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Rémi Prévost
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-14 00:00:00.000000000 Z
+date: 2013-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,17 +69,29 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
 description: Bourgeois is a Ruby library that makes using presenters a very simple
@@ -121,33 +124,26 @@ files:
 homepage: https://github.com/mirego/bourgeois
 licenses:
 - BSD 3-Clause
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1321347131962644702
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1321347131962644702
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.1.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Bourgeois is a Ruby library that makes using presenters a very simple thing.
 test_files:
 - spec/bourgeois/presenter_spec.rb