burgundy 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b54a032f0c4d79e05ae0dd1b1fbb5155b2025b9f
-  data.tar.gz: ce63a137e7d1e7838e09360fbf2e7fc246b8cae4
+  metadata.gz: 4295b2c824c87c0092cbb3e80951774e4569e2a5
+  data.tar.gz: b76378908e014558208eb0d0bfd1f38341718f73
 SHA512:
-  metadata.gz: e9a475b0e0e410eb4ab66762849166fbb611e7cac091523ef15e9356c35059577c5efb9d8cf3f251db0791b90f3a2371e99e4373e509d5152f4443cff8edaeb7
-  data.tar.gz: 5329e76c0ff9b44bd28233bb536957aa2edf9f1f7772a957663f4bb2591b835b49914672f6bce55386e41c6475464f5cf64e14a40bd2fa6b78883b2c6f173995
+  metadata.gz: cc96e010f0b3a4f3537a8f026b9040b39d200c5a9ee42d2a32344b62ab72fc7d3216872ed08781dcf4eae9f701d9c83c286efbcd10bcfaf3ece8233c46884c9f
+  data.tar.gz: 7a764ee903dfbdbb6c292e481f70ea3a7c4746757172df42ee8988f9164376f7dcf84111c141e9065b860bf836867a4e959ed6258cc967fa3c3513702cce261c

data/.rspec

@@ -1,2 +1 @@
---format documentation
 --color

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
 rvm:
   - 2.0.0
+  - 2.1.0

data/README.md

@@ -56,6 +56,8 @@ class WorkshopsController < ApplicationController
 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.
 
 ```erb

data/burgundy.gemspec

@@ -1,23 +1,24 @@
-require "./lib/burgundy/version"
+require './lib/burgundy/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "burgundy"
+  spec.name          = 'burgundy'
   spec.version       = Burgundy::VERSION
-  spec.authors       = ["Nando Vieira"]
-  spec.email         = ["fnando.vieira@gmail.com"]
-  spec.description   = "A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 100 lines."
+  spec.authors       = ['Nando Vieira']
+  spec.email         = ['fnando.vieira@gmail.com']
+  spec.description   = 'A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 100 lines.'
   spec.summary       = spec.description
-  spec.homepage      = "http://github.com/fnando/burgundy"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/fnando/burgundy'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rails'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'pry-meta'
 end

data/lib/burgundy.rb

@@ -1,5 +1,5 @@
-require "delegate"
-require "burgundy/version"
-require "burgundy/item"
-require "burgundy/collection"
-require "burgundy/rails" if defined?(Rails)
+require 'delegate'
+require 'burgundy/version'
+require 'burgundy/item'
+require 'burgundy/collection'
+require 'burgundy/rails' if defined?(Rails)

data/lib/burgundy/collection.rb

@@ -2,17 +2,25 @@ module Burgundy
   class Collection
     include Enumerable
 
-    def initialize(items, wrapping_class)
+    def initialize(items, wrapping_class = nil)
       @items = items
       @wrapping_class = wrapping_class
     end
 
+    def empty?
+      !any?
+    end
+
     def each(&block)
       to_ary.each(&block)
     end
 
     def to_ary
-      @cache ||= @wrapping_class.map(@items.to_a)
+      @cache ||=  if @wrapping_class
+                    @items.map {|item| @wrapping_class.new(item) }
+                  else
+                    @items.to_a
+                  end
     end
     alias_method :to_a, :to_ary
   end

data/lib/burgundy/item.rb

@@ -2,8 +2,13 @@ module Burgundy
   class Item < SimpleDelegator
     attr_reader :item
 
+    def self.wrap(collection)
+      Collection.new(collection, self)
+    end
+
     def self.map(collection)
-      collection.map {|item| new(item) }
+      warn 'Burgundy::Item.map is deprecated; use Burgundy::Item.wrap instead.'
+      wrap(collection)
     end
 
     def initialize(item)

data/lib/burgundy/version.rb

@@ -1,3 +1,3 @@
 module Burgundy
-  VERSION = "0.0.1"
+  VERSION = '0.0.3'
 end

data/spec/burgundy_spec.rb

@@ -1,45 +1,60 @@
-require "spec_helper"
+require 'spec_helper'
 
 describe Burgundy do
   let(:wrapper) { Class.new(Burgundy::Item) }
 
-  it "delegates everything" do
-    item = wrapper.new("hello")
-    expect(item.upcase).to eql("HELLO")
+  it 'delegates everything' do
+    item = wrapper.new('hello')
+    expect(item.upcase).to eql('HELLO')
   end
 
-  it "wraps items" do
-    items = wrapper.map([1,2,3])
+  it 'wraps items' do
+    items = wrapper.wrap([1,2,3])
 
+    expect(items.class).to eql(Burgundy::Collection)
     expect(items.first).to be_a(wrapper)
     expect(items.first.to_i).to eql(1)
   end
 
-  it "wraps items in collection" do
+  it 'deprecates Burgundy::Item.map' do
+    message = 'Burgundy::Item.map is deprecated; use Burgundy::Item.wrap instead.'
+    expect(wrapper).to receive(:warn).with(message)
+    wrapper.map([1,2,3])
+  end
+
+  it 'wraps items in collection' do
     collection = Burgundy::Collection.new([1,2,3], wrapper)
     expect(collection.first).to eql(1)
   end
 
-  it "includes Enumerable" do
+  it 'includes Enumerable' do
     expect(Burgundy::Collection).to include(Enumerable)
   end
 
-  it "responds to the routes method" do
-    item = wrapper.new("hello")
+  it 'implements #empty?' do
+    collection = Burgundy::Collection.new([1,2,3])
+    expect(collection).not_to be_empty
+
+    collection = Burgundy::Collection.new([])
+    expect(collection).to be_empty
+  end
+
+  it 'responds to the routes method' do
+    item = wrapper.new('hello')
 
     expect(item.respond_to?(:routes, true)).to be
     expect(item.respond_to?(:r, true)).to be
   end
 
-  it "responds to the helpers method" do
-    item = wrapper.new("hello")
+  it 'responds to the helpers method' do
+    item = wrapper.new('hello')
 
     expect(item.respond_to?(:helpers, true)).to be
     expect(item.respond_to?(:h, true)).to be
   end
 
-  it "responds to the I18n methods" do
-    item = wrapper.new("hello")
+  it 'responds to the I18n methods' do
+    item = wrapper.new('hello')
 
     expect(item.respond_to?(:translate, true)).to be
     expect(item.respond_to?(:t, true)).to be
@@ -47,25 +62,25 @@ describe Burgundy do
     expect(item.respond_to?(:l, true)).to be
   end
 
-  it "returns route using action mailer options" do
+  it 'returns route using action mailer options' do
     wrapper = Class.new(Burgundy::Item) do
       def profile_url; routes.profile_url(username) end
     end
 
-    Rails.configuration.action_mailer.default_url_options = {host: "example.org"}
-    item = wrapper.new OpenStruct.new(username: "johndoe")
+    Rails.configuration.action_mailer.default_url_options = {host: 'example.org'}
+    item = wrapper.new OpenStruct.new(username: 'johndoe')
 
-    expect(item.profile_url).to eql("http://example.org/johndoe")
+    expect(item.profile_url).to eql('http://example.org/johndoe')
   end
 
-  it "returns route using action controller options" do
+  it 'returns route using action controller options' do
     wrapper = Class.new(Burgundy::Item) do
       def profile_url; routes.profile_url(username) end
     end
 
-    Rails.application.routes.default_url_options = {host: "example.org"}
-    item = wrapper.new OpenStruct.new(username: "johndoe")
+    Rails.application.routes.default_url_options = {host: 'example.org'}
+    item = wrapper.new OpenStruct.new(username: 'johndoe')
 
-    expect(item.profile_url).to eql("http://example.org/johndoe")
+    expect(item.profile_url).to eql('http://example.org/johndoe')
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,12 @@
-require "bundler/setup"
+require 'bundler/setup'
 Bundler.setup
 
-ENV["RAILS_ENV"] = "test"
+ENV['RAILS_ENV'] = 'test'
 
-require File.expand_path("../dummy/config/environment.rb",  __FILE__)
-require "rspec/rails"
-require "rspec/autorun"
+require File.expand_path('../dummy/config/environment.rb',  __FILE__)
+require 'rspec/rails'
 
-require "burgundy"
+require 'burgundy'
 I18n.locale = :en
 
 RSpec.configure do |config|

metadata

@@ -1,83 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: burgundy
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-24 00:00:00.000000000 Z
+date: 2014-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   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'
 - !ruby/object:Gem::Dependency
   name: rails
   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'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   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'
+- !ruby/object:Gem::Dependency
+  name: pry-meta
+  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: A simple wrapper for objects (think of Burgundy as a decorator/presenter)
@@ -88,9 +102,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -153,17 +167,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A simple wrapper for objects (think of Burgundy as a decorator/presenter)
@@ -211,3 +225,4 @@ test_files:
 - spec/dummy/public/500.html
 - spec/dummy/public/favicon.ico
 - spec/spec_helper.rb
+has_rdoc: