burgundy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4492561aeec77aab4e8a7e9883c8e24024ec3ee2
-  data.tar.gz: 251ce6169ef193498d4dfc8cc86285035c7d6ff8
+  metadata.gz: a912d242cbf7bad7a67bef01678a5964279965fc
+  data.tar.gz: 0633c91f18a8eee40f4f328a3d1a0181266dd73b
 SHA512:
-  metadata.gz: c1f6f341f9af90ac5e24f81ebb99570b3f0930333d8fc698fc01680ebb1f44c819a913c99891d5ba5024f1657f02dd8a252bd6da5107760e35db67e2fc3016da
-  data.tar.gz: e8c37a6417272229091967ded620ef8acaad072890fafbbba21e4eaaccc6e98cc337949cc51efc93aea237eb0d01107389c1b34e2183318916a48524a5279e6c
+  metadata.gz: d2f2258741ebac195140cde6d01af8114d304106d74f0c26f7bc8a3cb07401c8d00141dc899cf1cf62520c157f152ea2367b2b43306e5163bc29a9d6fe29903f
+  data.tar.gz: b4b6d4977c7b71b43499f8ea3c7590257a3882dfa1d14351db00fc1f8c037893bae9c09f5d2bcf94f92b39cd3fffefdc73de939db97ab66e34ccde639127c172

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - '2.1'
   - '2.2'

data/CHANGELOG.md

@@ -0,0 +1,41 @@
+## [0.2.0] - 2015-10-14
+
+### Added
+
+- `Burgundy::Collection` and `Burgundy::Item.wrap` now delegates additional arguments to `Burgundy::Item#initialize`.
+
+## [0.1.0] - 2015-02-20
+
+### Added
+
+- Add `Burgundy::Item#attributes`. Now is possible to easily collect attributes as a hash.
+
+### Changed
+
+- Required Ruby version is now 2.1+.
+
+## [0.0.4] - 2015-01-29
+
+### Added
+
+- `Burgundy::Collection` now includes `Enumerable`.
+
+## [0.0.3] - 2014-07-05
+
+### Changed
+
+- `Burgundy::Item.wrap` always return a `Burgundy::Collection` instance.
+
+## [0.0.2] - 2014-07-05 [YANKED]
+
+### Added
+
+- Add `Burgundy::Collection#empty?`.
+
+### Changed
+
+- `Burgundy::Collection#initialize` doesn't require a wrapping class anymore. This makes ActiveRecord collections easier to work.
+
+## [0.0.1] - 2013-10-24
+
+- Initial release.

data/README.md

@@ -9,15 +9,21 @@ A simple wrapper for objects (think of Burgundy as a decorator/presenter) in les
 
 Add this line to your application's Gemfile:
 
-    gem 'burgundy'
+```ruby
+gem 'burgundy'
+```
 
 And then execute:
 
-    $ bundle
+```console
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install burgundy
+```console
+$ gem install burgundy
+```
 
 ## Usage
 
@@ -61,7 +67,21 @@ end
 
 or just call `WorkshopPresenter.wrap(Workshop.sorted_by_name)`. Both ways return a `Burgundy::Collection` instance.
 
-The query will be performed only when needed, usually on the view. The collection is an enumerable object and can be passed directly to the `render` method. Each item will be wrapped by the provided class.
+You may need to provide additional arguments to the item class. On your collection, all additional arguments will be delegated to the item classe, like the following example:
+
+```ruby
+WorkshopPresenter.wrap(Workshop.all, current_user)
+Burgundy::Collection.new(Workshop.all, WorkshopPresenter, current_user)
+
+class WorkshopPresenter < Burgundy::Item
+  def initialize(workshop, current_user)
+    super(workshop)
+    @current_user = current_user
+  end
+end
+```
+
+The query will be performed only when needed, usually on the view (easier to cache). The collection is an enumerable object and can be passed directly to the `render` method. Each item will be wrapped by the provided class.
 
 ```erb
 <%= render @workshops %>

data/lib/burgundy/collection.rb

@@ -2,23 +2,20 @@ module Burgundy
   class Collection < SimpleDelegator
     include Enumerable
 
-    def initialize(items, wrapping_class = nil)
+    def initialize(items, wrapping_class = nil, *args)
       @items = items
       @wrapping_class = wrapping_class
+      @args = args
       __setobj__(@items)
     end
 
-    def empty?
-      !any?
-    end
-
     def each(&block)
       to_ary.each(&block)
     end
 
     def to_ary
       @cache ||=  if @wrapping_class
-                    @items.map {|item| @wrapping_class.new(item) }
+                    @items.map {|item| @wrapping_class.new(item, *@args) }
                   else
                     @items.to_a
                   end

data/lib/burgundy/item.rb

@@ -6,8 +6,8 @@ module Burgundy
       child.attributes(attributes)
     end
 
-    def self.wrap(collection)
-      Collection.new(collection, self)
+    def self.wrap(collection, *args)
+      Collection.new(collection, self, *args)
     end
 
     def self.map(collection)

data/lib/burgundy/version.rb

@@ -1,3 +1,3 @@
 module Burgundy
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/burgundy_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 
 describe Burgundy do
   let(:wrapper) { Class.new(Burgundy::Item) }
+  let(:wrapper_with_args) { ItemWithAdditionalArgs }
 
   it 'delegates everything' do
     item = wrapper.new('hello')
@@ -16,6 +17,15 @@ describe Burgundy do
     expect(items.first.to_i).to eql(1)
   end
 
+  it 'wraps items with additional arguments' do
+    items = wrapper_with_args.wrap([1], 2, 3)
+
+    expect(items.class).to eql(Burgundy::Collection)
+    expect(items.first).to be_a(wrapper_with_args)
+    expect(items.first.item).to eql(1)
+    expect(items.first.args).to eql([2, 3])
+  end
+
   it 'deprecates Burgundy::Item.map' do
     message = 'Burgundy::Item.map is deprecated; use Burgundy::Item.wrap instead.'
     expect(wrapper).to receive(:warn).with(message)
@@ -27,6 +37,13 @@ describe Burgundy do
     expect(collection.first).to eql(1)
   end
 
+  it 'wraps items with additional arguments' do
+    collection = Burgundy::Collection.new([1], wrapper_with_args, 2, 3)
+
+    expect(collection.first.item).to eq(1)
+    expect(collection.first.args).to eq([2, 3])
+  end
+
   it 'delegates collection calls' do
     collection = Burgundy::Collection.new([1,2,3], wrapper)
     expect(collection.size).to eql(3)

data/spec/spec_helper.rb

@@ -8,3 +8,12 @@ require 'rspec/rails'
 
 require 'burgundy'
 I18n.locale = :en
+
+class ItemWithAdditionalArgs < Burgundy::Item
+  attr_reader :args
+
+  def initialize(target, *args)
+    super(target)
+    @args = args
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burgundy
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A simple wrapper for objects (think of Burgundy as a decorator/presenter)