upholsterer 0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3dd008b546feae2ddff4f38335af3f31d6c840d
+  data.tar.gz: f9ea4a88970b4c410317603bb52356926e8bfe3e
+SHA512:
+  metadata.gz: 41a567e2724c898933ae141d9b63fbaa875d37e3c7a0aadcab3e69914d9a46910750074a053df88adde0828c58d5c8117c44ddf393f537f0fd579f52a0c94561
+  data.tar.gz: 720f8af029261deb38042c76c951be4a82b92932c956a4b2fc01d084363e87eabcf54d81c56c4bc8577f36c65a594b97dd44226d207996250611c323c0126301

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+pkg
+tmp
+.tags
+.idea

data/.rspec

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

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    upholsterer (0.3.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.2.0)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    method_source (0.8.2)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-meta (0.0.5)
+      awesome_print
+      pry
+      pry-nav
+      pry-remote
+    pry-nav (0.2.3)
+      pry (~> 0.9.10)
+    pry-remote (0.1.7)
+      pry (~> 0.9)
+      slop (~> 3.0)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.6)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry-meta
+  rake
+  rspec
+  upholsterer!

data/README.rdoc

@@ -0,0 +1,88 @@
+= upholsterer
+
+Based on SimplePresenter (https://github.com/fnando/simple_presenter)
+
+== Installation
+
+  gem install upholsterer
+
+== Usage
+
+  class User < ActiveRecord::Base
+    # implements the following attributes: name, email, password_hash, password_salt
+  end
+
+  class UserPresenter < Upholsterer::Base
+    expose :name, :email
+  end
+
+  or
+
+  class UserPresenter < Upholsterer::Base
+    expose_all
+  end
+
+  user = UserPresenter.new(User.first)
+  users = UserPresenter.map(User.all)
+
+If you're using Upholsterer within Rails, presenters also have access to:
+
+* route helpers: just use the <tt>routes</tt> or <tt>r</tt> methods
+* view helpers: just use the <tt>helpers</tt> or <tt>h</tt> methods
+* I18n methods: just use the <tt>translate</tt>, <tt>t</tt>, <tt>localize</tt> or <tt>l</tt> methods
+
+If you want to to use <tt>*_url</tt> route methods, make sure you set the <tt>default_url_options</tt> option. You can use the <tt>config.upholsterer.default_url_options</tt> method, which defaults to <tt>config.action_mailer.default_url_options</tt>. You can add something like the following to your <tt>config/environments/development.rb</tt>, for instance:
+
+  config.upholsterer.default_url_options = {:host => "localhost:3000"}
+
+For additional usage, check the specs.
+
+== TO-DO
+
+* Recognize ActiveRecord objects and automatically expose attributes used by url and form helpers (like <tt>Model.model_name</tt>, <tt>Model#to_key</tt>, and <tt>Model#to_param</tt>).
+* Override <tt>respond_to?</tt> to reflect exposed attributes.
+
+== Troubleshooting
+
+If you're having problems because already have a class/module called Presenter that is conflicting with this gem, you can require the namespace and inherit from <tt>Upholsterer::Base</tt>.
+
+  require "upholsterer/namespace"
+
+  class UserPresenter < Upholsterer::Base
+  end
+
+If you're using Rails/Bundler or something like that, remember to override the <tt>:require</tt> option.
+
+  # Gemfile
+  source :rubygems
+
+  gem "upholsterer", :require => "upholsterer/namespace"
+
+== Maintainer
+
+* Nando Vieira (http://nandovieira.com.br)
+* Aleksandr Fomin (https://github.com/llxff)
+* Gleb Sinyavsky (http://github.com/zhulik)
+
+== License
+
+(The 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/Rakefile

@@ -0,0 +1,7 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/lib/upholsterer.rb

@@ -0,0 +1,2 @@
+require 'upholsterer/namespace'
+Presenter = Upholsterer::Base

data/lib/upholsterer/base.rb

@@ -0,0 +1,163 @@
+module Upholsterer
+  class Base
+    # Define how many subjects this presenter will receive.
+    # Each subject will create a private method with the same name.
+    #
+    # The first subject name will be used as default, thus isn't required as <tt>:with</tt>
+    # option on the Upholsterer::Base.expose method.
+    #
+    #   class CommentPresenter < Presenter
+    #     subjects :comment, :post
+    #     expose :body                  # will expose comment.body through CommentPresenter#body
+    #     expose :title, :with => :post # will expose post.title through CommentPresenter#post_title
+    #   end
+    #
+    # Subjects can be accessed by a private name with the same name.
+    # So the above subjects can be accessed internally by the methods +comment+ and +post+.
+    #
+    # If you're not setting any special name, then you can access it using the +subject+ method.
+    #
+    
+    attr_reader :subject
+    
+    def self.subjects(*names)
+      @subjects ||= [:subject]
+
+      unless names.empty?
+        @subjects = names
+        attr_reader *names
+      end
+
+      @subjects
+    end
+
+    class << self
+      alias_method :subject, :subjects
+    end
+
+    # Propagate inherited subjects and attributes.
+    #
+    def self.inherited(child)
+      child.subjects(*subjects)
+      attributes.each_value do |attr_name, options|
+        child.expose(attr_name, options)
+      end
+    end
+
+    # Store all attributes and options that have been exposed.
+    #
+    #   class UserPresenter < Presenter
+    #     expose :name
+    #     expose :street, with: "address"
+    #   end
+    #
+    #   UserPresenter.attributes
+    #   #=> {
+    #   #=>   name: [:name, {}],
+    #   #=>   address_street: [:street, {with: "address"}]
+    #   #=> }
+    #
+    def self.attributes
+      @attributes ||= {}
+    end
+
+    # This method will return a presenter for each item of collection.
+    #
+    #   users = UserPresenter.map(User.all)
+    #
+    # If your presenter accepts more than one subject, you can provided
+    # them as following parameters.
+    #
+    #   comments = CommentPresenter.map(post.comment.all, post)
+    #
+    def self.map(collection, *subjects)
+      collection.map {|item| new(item, *subjects)}
+    end
+
+    # The list of attributes that will be exposed.
+    #
+    #   class UserPresenter < Presenter
+    #     expose :name, :email
+    #   end
+    #
+    # You can also expose an attribute from a composition.
+    #
+    #   class CommentPresenter < Presenter
+    #     expose :body, :created_at
+    #     expose :name, :with => :user
+    #     expose :name, :as => :author
+    #   end
+    #
+    # The presenter above will expose the methods +body+, +created_at+, and +user_name+.
+    # Additionaly, it will create an alias called +author+ to the +name+ attribute.
+    #
+    def self.expose(*attrs)
+      options = attrs.pop if attrs.last.kind_of?(Hash)
+      options ||= {}
+
+      attrs.each do |attr_name|
+        subject = options.fetch(:with, nil)
+
+        method_name = [
+          subject,
+          options.fetch(:as, attr_name)
+        ].compact.join("_")
+
+        attributes[method_name.to_sym] = [attr_name, options]
+
+        class_eval <<-RUBY, __FILE__, __LINE__ + 1
+          def #{method_name}(&block)                                    # def user_name(&block)
+            proxy_message(#{subject.inspect}, "#{attr_name}", &block)   #   proxy_message("user", "name")
+          end                                                           # end
+        RUBY
+      end
+    end
+    
+    def self.expose_all
+      class_eval <<-RUBY, __FILE__, __LINE__ + 1
+	def method_missing(name, *params)
+	  @subject.send(name, *params)
+	end
+	
+	def respond_to?(name)
+	  super || @subject.respond_to?(name)
+	end
+      RUBY
+    end
+
+    # It assigns the subjects.
+    #
+    #   user = UserPresenter.new(User.first)
+    #
+    # You can assign several subjects if you want.
+    #
+    #   class CommentPresenter < Presenter
+    #     subject :comment, :post
+    #     expose :body
+    #     expose :title, :with => :post
+    #   end
+    #
+    #  comment = CommentPresenter.new(Comment.first, Post.first)
+    #
+    # If the :with option specified to one of the subjects, then the default subject is bypassed.
+    # Otherwise, it will be proxied to the default subject.
+    #
+    def initialize(*subjects)
+      self.class.subjects.each_with_index do |name, index|
+        instance_variable_set("@#{name}", subjects[index])
+      end
+    end
+    
+    def to_param(*params)
+      @subject.to_param(*params)
+    end
+
+    private
+    def proxy_message(subject_name, method, &block)
+      subject_name ||= self.class.subjects.first
+      subject = instance_variable_get("@#{subject_name}")
+      subject = instance_variable_get("@#{self.class.subjects.first}").__send__(subject_name) unless subject || self.class.subjects.include?(subject_name)
+      subject.respond_to?(method) ? subject.__send__(method, &block) : nil
+    end
+  end
+end

data/lib/upholsterer/namespace.rb

@@ -0,0 +1,6 @@
+module Upholsterer
+  require "upholsterer/base"
+  require "upholsterer/version"
+  require "upholsterer/url_methods"
+  require "upholsterer/rails" if defined?(Rails)
+end

data/lib/upholsterer/rails.rb

@@ -0,0 +1,30 @@
+module Upholsterer
+  class Railtie < Rails::Railtie
+    config.upholsterer = ActiveSupport::OrderedOptions.new
+  end
+
+  class Base
+    delegate :translate, :t, :localize, :l, :to => :helpers
+
+    def self.routes_module
+      @routes_module ||= Module.new do
+        include Rails.application.routes.url_helpers
+        include UrlMethods
+      end
+    end
+
+    def self.routes
+      @routes ||= Object.new.extend(routes_module)
+    end
+
+    def routes
+      self.class.routes
+    end
+    alias_method :r, :routes
+
+    def helpers
+      ApplicationController.helpers
+    end
+    alias_method :h, :helpers
+  end
+end

data/lib/upholsterer/url_methods.rb

@@ -0,0 +1,9 @@
+module Upholsterer
+  module UrlMethods
+    def default_url_options
+      Rails.configuration.upholsterer.default_url_options ||
+      Rails.configuration.action_mailer.default_url_options ||
+      {}
+    end
+  end
+end

data/lib/upholsterer/version.rb

@@ -0,0 +1,8 @@
+module Upholsterer
+  module Version
+    MAJOR = 0
+    MINOR = 3
+    PATCH = 1
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/simple_presenter.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'upholsterer/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'upholsterer'
+  s.version     = Upholsterer::Version::STRING
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Nando Vieira', 'Aleksandr Fomin', 'Gleb Sinyavsky']
+  s.email       = ['fnando.vieira@gmail.com', 'll.wg.bin@gmail.com']
+  s.homepage    = 'https://github.com/llxff/upholsterer'
+  s.summary     = 'A simple presenter/facade/decorator/whatever implementation.'
+  s.description = s.summary
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split($/).map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'pry-meta'
+end

data/spec/base_spec.rb

@@ -0,0 +1,171 @@
+require "spec_helper"
+
+describe Upholsterer::Base do
+  describe ".expose" do
+    context "not using :with option" do
+      subject { UserPresenter.new }
+
+      it { should respond_to(:name) }
+      it { should respond_to(:email) }
+      it { should_not respond_to(:password_hash) }
+      it { should_not respond_to(:password_salt) }
+    end
+
+    context "using :with option" do
+      subject { CommentPresenter.new }
+
+      it { should respond_to(:user_name) }
+    end
+
+    context "using :as option" do
+      let(:site) { OpenStruct.new(:site => "http://example.org") }
+      subject { AliasPresenter.new(site) }
+
+      it { should respond_to(:url) }
+      it { expect(subject.url).to eql("http://example.org") }
+    end
+
+    context "exposing iterators" do
+      subject { IteratorPresenter.new([1, 2, 3]) }
+
+      its(:each) { should be_a(Enumerator) }
+
+      it "uses provided block" do
+        numbers = []
+        subject.each {|n| numbers << n}
+        expect(numbers).to eql([1, 2, 3])
+      end
+    end
+  end
+
+  describe ".attributes" do
+    context "using defaults" do
+      let(:presenter) { UserPresenter }
+      subject { presenter.attributes }
+
+      it { should have(2).items }
+      its([:name]) { should eql([:name, {}]) }
+      its([:email]) { should eql([:email, {}]) }
+    end
+
+    context "using provided options" do
+      let(:presenter) { CommentPresenter }
+      subject { presenter.attributes }
+
+      it { should have(3).items }
+      its([:user_name]) { should eql([:name, {with: :user}]) }
+      its([:post_title]) { should eql([:title, {with: :post}]) }
+    end
+  end
+
+  describe ".subjects" do
+    it "is aliased as .subject" do
+      thing = double("Thing")
+      presenter_class = Class.new(Presenter)
+      presenter_class.subject :thing
+      presenter = presenter_class.new(thing)
+
+      expect(presenter.instance_variable_get("@thing")).to eql(thing)
+    end
+
+    context "using defaults" do
+      let(:user) { double :name => "John Doe", :email => "john@doe.com" }
+      subject { UserPresenter.new(user) }
+
+      its(:name) { should == "John Doe" }
+      its(:email) { should == "john@doe.com" }
+
+      it "responds to private subject method" do
+        expect(subject.public_methods).to include(:subject)
+      end
+
+      it "returns subject" do
+        expect(subject.send(:subject)).to eql(user)
+      end
+    end
+
+    context "specifying several subjects" do
+      let(:user) { double :name => "John Doe" }
+      let(:comment) { double :body => "Some comment", :user => user }
+      let(:post) { double :title => "Some post" }
+      subject { CommentPresenter.new(comment, post) }
+
+      its(:body) { should == "Some comment" }
+      its(:post_title) { should == "Some post" }
+      its(:user_name) { should == "John Doe" }
+
+      it "responds to private comment method" do
+        expect(subject.public_methods).to include(:comment)
+      end
+
+      it "responds to private post method" do
+        expect(subject.public_methods).to include(:post)
+      end
+
+      it "returns comment subject" do
+        expect(subject.send(:comment)).to eql(comment)
+      end
+
+      it "returns post subject" do
+        expect(subject.send(:post)).to eql(post)
+      end
+    end
+
+    context "when subjects are nil" do
+      let(:comment) { double :body => "Some comment" }
+      subject { CommentPresenter.new(comment, nil) }
+
+      its(:post_title) { should be_nil }
+    end
+  end
+
+  describe ".map" do
+    context "wraps a single subject" do
+      let(:user) { double :name => "John Doe" }
+      subject { UserPresenter.map([user])[0] }
+
+      it { should be_a(UserPresenter) }
+      its(:name) { should == "John Doe" }
+    end
+
+    context "wraps several subjects" do
+      let(:comment) { double :body => "Some comment" }
+      let(:post) { double :title => "Some post" }
+      let(:user) { double :name => "John Doe" }
+      subject { CommentPresenter.map([comment], post)[0] }
+
+      it { should be_a(CommentPresenter) }
+      its(:body) { should == "Some comment" }
+      its(:post_title) { should == "Some post" }
+    end
+  end
+
+  describe "#initialize" do
+    let(:user) { double }
+    subject { UserPresenter.new(user) }
+
+    it "assigns the subject" do
+      expect(subject.instance_variable_get("@subject")).to eql(user)
+    end
+  end
+
+  describe "inherited presenter" do
+    let(:presenter) { Class.new(CommentPresenter) }
+
+    context "subjects" do
+      subject { presenter.subjects }
+
+      specify { expect(subject).to have(2).items }
+      specify { expect(subject.first).to eql(:comment) }
+      specify { expect(subject.last).to eql(:post) }
+    end
+
+    context "attributes" do
+      subject { presenter.attributes }
+
+      it { should have(3).items }
+      its([:user_name]) { should eql([:name, {with: :user}]) }
+      its([:post_title]) { should eql([:title, {with: :post}]) }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require "bundler/setup"
+Bundler.require(:default, :development)
+
+require "upholsterer"
+require "ostruct"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each do |file|
+  require file
+end

data/spec/support/alias_presenter.rb

@@ -0,0 +1,4 @@
+class AliasPresenter < Presenter
+  expose :site
+  expose :site, :as => :url
+end

data/spec/support/comment.rb

@@ -0,0 +1,7 @@
+class Comment
+  attr_accessor :body, :created_at, :user
+
+  def initialize(attrs = {})
+    attrs.each {|name, value| __send__("#{name}=", value)}
+  end
+end

data/spec/support/comment_presenter.rb

@@ -0,0 +1,7 @@
+class CommentPresenter < Presenter
+  expose :body
+  expose :name, :with => :user
+  expose :title, :with => :post
+
+  subjects :comment, :post
+end

data/spec/support/iterator_presenter.rb

@@ -0,0 +1,3 @@
+class IteratorPresenter < Presenter
+  expose :each
+end

data/spec/support/user.rb

@@ -0,0 +1,7 @@
+class User
+  attr_accessor :name, :email, :password_salt, :password_hash
+
+  def initialize(attrs = {})
+    attrs.each {|name, value| __send__("#{name}=", value)}
+  end
+end

data/spec/support/user_presenter.rb

@@ -0,0 +1,3 @@
+class UserPresenter < Presenter
+  expose :name, :email
+end

data/spec/upholsterer_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Upholsterer do
+  it "assigns Upholsterer::Base" do
+    expect(::Presenter).to be(Upholsterer::Base)
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: upholsterer
+version: !ruby/object:Gem::Version
+  version: 0.3.1
+platform: ruby
+authors:
+- Nando Vieira
+- Aleksandr Fomin
+- Gleb Sinyavsky
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-05 00:00:00.000000000 Z
+dependencies:
+- !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: 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 presenter/facade/decorator/whatever implementation.
+email:
+- fnando.vieira@gmail.com
+- ll.wg.bin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/upholsterer.rb
+- lib/upholsterer/base.rb
+- lib/upholsterer/namespace.rb
+- lib/upholsterer/rails.rb
+- lib/upholsterer/url_methods.rb
+- lib/upholsterer/version.rb
+- simple_presenter.gemspec
+- spec/base_spec.rb
+- spec/spec_helper.rb
+- spec/support/alias_presenter.rb
+- spec/support/comment.rb
+- spec/support/comment_presenter.rb
+- spec/support/iterator_presenter.rb
+- spec/support/user.rb
+- spec/support/user_presenter.rb
+- spec/upholsterer_spec.rb
+homepage: https://github.com/llxff/upholsterer
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple presenter/facade/decorator/whatever implementation.
+test_files: []