burgundy 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b54a032f0c4d79e05ae0dd1b1fbb5155b2025b9f
+  data.tar.gz: ce63a137e7d1e7838e09360fbf2e7fc246b8cae4
+SHA512:
+  metadata.gz: e9a475b0e0e410eb4ab66762849166fbb611e7cac091523ef15e9356c35059577c5efb9d8cf3f251db0791b90f3a2371e99e4373e509d5152f4443cff8edaeb7
+  data.tar.gz: 5329e76c0ff9b44bd28233bb536957aa2edf9f1f7772a957663f4bb2591b835b49914672f6bce55386e41c6475464f5cf64e14a40bd2fa6b78883b2c6f173995

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in burgundy.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nando Vieira
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,84 @@
+# Burgundy
+
+A simple wrapper for objects (think of Burgundy as a decorator/presenter) in less than 100 lines.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'burgundy'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install burgundy
+
+## Usage
+
+First, define your wrapping class.
+
+```ruby
+class UserPresenter < Burgundy::Item
+end
+```
+
+Then you can instantiate it:
+
+```ruby
+user = UserPresenter.new(User.first)
+```
+
+The `Burgundy::Item` has access to helper and route methods. Notice that the wrapper item is accessible through the `Burgundy::Item#item` method.
+
+```ruby
+class UserPresenter < Burgundy::Item
+  def profile_url
+    routes.profile_url(item.username)
+  end
+end
+```
+
+You don't have to expose attributes; everything is delegated to the wrapped item.
+
+To wrap an entire collection, just use the `Burgundy::Collection` class.
+
+```ruby
+class WorkshopsController < ApplicationController
+  def index
+    @workshops = Burgundy::Collection.new(
+      Workshop.sorted_by_name,
+      WorkshopPresenter
+    )
+  end
+end
+```
+
+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
+<%= render @workshops %>
+```
+
+Route URLs may require the default url options. Burgundy try to get them from the following objects:
+
+* `Rails.configuration.action_mailer.default_url_options`
+* `Rails.application.routes.default_url_options`
+
+So you can just put this on your environment file
+
+```ruby
+config.action_controller.default_url_options = {
+  host: "example.org"
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/burgundy.gemspec

@@ -0,0 +1,23 @@
+require "./lib/burgundy/version"
+
+Gem::Specification.new do |spec|
+  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.summary       = spec.description
+  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.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"
+end

data/lib/burgundy.rb

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

data/lib/burgundy/collection.rb

@@ -0,0 +1,19 @@
+module Burgundy
+  class Collection
+    include Enumerable
+
+    def initialize(items, wrapping_class)
+      @items = items
+      @wrapping_class = wrapping_class
+    end
+
+    def each(&block)
+      to_ary.each(&block)
+    end
+
+    def to_ary
+      @cache ||= @wrapping_class.map(@items.to_a)
+    end
+    alias_method :to_a, :to_ary
+  end
+end

data/lib/burgundy/item.rb

@@ -0,0 +1,14 @@
+module Burgundy
+  class Item < SimpleDelegator
+    attr_reader :item
+
+    def self.map(collection)
+      collection.map {|item| new(item) }
+    end
+
+    def initialize(item)
+      @item = item
+      __setobj__(item)
+    end
+  end
+end

data/lib/burgundy/rails.rb

@@ -0,0 +1,60 @@
+module Burgundy
+  module UrlMethods
+    def default_url_options
+      action_mailer_default_url_options ||
+      Rails.application.routes.default_url_options
+    end
+
+    def action_mailer_default_url_options
+      Rails.configuration.action_mailer.default_url_options if Rails.configuration.respond_to?(:action_mailer)
+    end
+  end
+
+  module Helpers
+    extend ActiveSupport::Concern
+
+    included do
+      delegate :translate, :t, :localize, :l, to: :helpers
+    end
+
+    def helpers
+      ApplicationController.helpers
+    end
+    alias_method :h, :helpers
+  end
+
+  module RouteHelpers
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def routes_module
+        @routes_module ||= Module.new do
+          include Rails.application.routes.url_helpers
+          include UrlMethods
+        end
+      end
+
+      def routes
+        @routes ||= Object.new.extend(routes_module)
+      end
+    end
+
+    def to_param
+      item.to_param
+    end
+
+    def eql?(obj)
+      obj == self || item.eql?(obj)
+    end
+
+    def routes
+      self.class.routes
+    end
+    alias_method :r, :routes
+  end
+
+  class Item
+    include Helpers
+    include RouteHelpers
+  end
+end

data/lib/burgundy/version.rb

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

data/spec/burgundy_spec.rb

@@ -0,0 +1,71 @@
+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")
+  end
+
+  it "wraps items" do
+    items = wrapper.map([1,2,3])
+
+    expect(items.first).to be_a(wrapper)
+    expect(items.first.to_i).to eql(1)
+  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
+    expect(Burgundy::Collection).to include(Enumerable)
+  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")
+
+    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")
+
+    expect(item.respond_to?(:translate, true)).to be
+    expect(item.respond_to?(:t, true)).to be
+    expect(item.respond_to?(:localize, true)).to be
+    expect(item.respond_to?(:l, true)).to be
+  end
+
+  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")
+
+    expect(item.profile_url).to eql("http://example.org/johndoe")
+  end
+
+  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")
+
+    expect(item.profile_url).to eql("http://example.org/johndoe")
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end