burgundy 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7c3874c398cc2ab2ef4400629e242daead00ec7
-  data.tar.gz: 64871202971ab0a7570437edb627692d23a0743d
+  metadata.gz: 4492561aeec77aab4e8a7e9883c8e24024ec3ee2
+  data.tar.gz: 251ce6169ef193498d4dfc8cc86285035c7d6ff8
 SHA512:
-  metadata.gz: 9c9c17ab637cb9ebf6702778821f7498f313beffedfb92231d80c29af8df4e8338dcf75f7772f8880ba077adcadf5d79c2f4733673bf78534c833c30eb3eae21
-  data.tar.gz: c4da20444705bc989ce27efb8cfa2f692963460a8470968ad16932b0b709a9f3c0a39cbd5b5ec54710e7205cec02b11edda29fbbdc8bf05393ccdf58606c0817
+  metadata.gz: c1f6f341f9af90ac5e24f81ebb99570b3f0930333d8fc698fc01680ebb1f44c819a913c99891d5ba5024f1657f02dd8a252bd6da5107760e35db67e2fc3016da
+  data.tar.gz: e8c37a6417272229091967ded620ef8acaad072890fafbbba21e4eaaccc6e98cc337949cc51efc93aea237eb0d01107389c1b34e2183318916a48524a5279e6c

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
-  - '2.0'
   - '2.1'
   - '2.2'

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/fnando/burgundy.svg)](https://travis-ci.org/fnando/burgundy)
 [![Code Climate](https://codeclimate.com/github/fnando/burgundy/badges/gpa.svg)](https://codeclimate.com/github/fnando/burgundy)
 
-A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 100 lines.
+A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 150 lines.
 
 ## Installation
 
@@ -80,6 +80,42 @@ config.action_controller.default_url_options = {
 }
 ```
 
+You can map attributes into a hash; I use this strategy for using presenters on API responses (so I can skip adding yet another dependency to my project).
+
+```ruby
+class UserPresenter < Burgundy::Item
+  attributes :username, :name, :email
+
+  def profile_url
+    routes.profile_url(item.username)
+  end
+end
+
+UserPresenter.new(User.first).attributes
+#=> {:username=>'johndoe', :name=>'John Doe', :email=>'john@example.org'}
+
+UserPresenter.new(User.first).to_hash
+#=> {:username=>'johndoe', :name=>'John Doe', :email=>'john@example.org'}
+
+UserPresenter.new(User.first).to_h
+#=> {:username=>'johndoe', :name=>'John Doe', :email=>'john@example.org'}
+```
+
+If you want to remap an attribute, provide a hash.
+
+```ruby
+class UserPresenter < Burgundy::Item
+  attributes :name, :email, :username => :login
+
+  def profile_url
+    routes.profile_url(item.username)
+  end
+end
+
+UserPresenter.new(User.first).attributes
+#=> {:login=>'johndoe', :name=>'John Doe', :email=>'john@example.org'}
+```
+
 ## Contributing
 
 1. Fork it

data/burgundy.gemspec

@@ -1,6 +1,7 @@
 require './lib/burgundy/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 2.1.0'
   spec.name          = 'burgundy'
   spec.version       = Burgundy::VERSION
   spec.authors       = ['Nando Vieira']

data/lib/burgundy/item.rb

@@ -2,6 +2,10 @@ module Burgundy
   class Item < SimpleDelegator
     attr_reader :item
 
+    def self.inherited(child)
+      child.attributes(attributes)
+    end
+
     def self.wrap(collection)
       Collection.new(collection, self)
     end
@@ -11,9 +15,30 @@ module Burgundy
       wrap(collection)
     end
 
+    def self.attributes(*args)
+      @attributes ||= {}
+
+      if args.any?
+        @attributes = {}
+        @attributes = args.pop if args.last.kind_of?(Hash)
+        @attributes.merge!(args.zip(args).to_h)
+      end
+
+      @attributes
+    end
+
     def initialize(item)
       @item = item
       __setobj__(item)
     end
+
+    def attributes
+      self.class.attributes.each_with_object({}) do |(from, to), target|
+        target[to] = send(from)
+      end
+    end
+
+    alias_method :to_hash, :attributes
+    alias_method :to_h, :attributes
   end
 end

data/lib/burgundy/version.rb

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

data/spec/burgundy_spec.rb

@@ -88,4 +88,50 @@ describe Burgundy do
 
     expect(item.profile_url).to eql('http://example.org/johndoe')
   end
+
+  it 'returns attributes' do
+    wrapper = Class.new(Burgundy::Item) do
+      attributes :name, :email
+    end
+
+    object = OpenStruct.new(name: 'John Doe', email: 'john@example.org', username: 'johndoe')
+    item = wrapper.new(object)
+
+    expect(item.attributes).to eq(name: 'John Doe', email: 'john@example.org')
+  end
+
+  it 'returns remaps attribute' do
+    wrapper = Class.new(Burgundy::Item) do
+      attributes :name, :username => :login
+    end
+
+    object = OpenStruct.new(name: 'John Doe', username: 'johndoe')
+    item = wrapper.new(object)
+
+    expect(item.attributes).to eq(name: 'John Doe', login: 'johndoe')
+  end
+
+  it 'implements to_hash/to_h protocol' do
+    wrapper = Class.new(Burgundy::Item) do
+      attributes :name, :email
+    end
+
+    object = OpenStruct.new(name: 'John Doe', email: 'john@example.org', username: 'johndoe')
+    item = wrapper.new(object)
+
+    expect(item.attributes).to eq(item.to_hash)
+    expect(item.attributes).to eq(item.to_h)
+  end
+
+  it 'inherits attributes' do
+    parent_wrapper = Class.new(Burgundy::Item) do
+      attributes :name, :username
+    end
+
+    wrapper = Class.new(parent_wrapper)
+    object = OpenStruct.new(name: 'John Doe', username: 'johndoe')
+    item = wrapper.new(object)
+
+    expect(item.attributes).to eq(name: 'John Doe', username: 'johndoe')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: burgundy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,7 +169,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="